MGL(Win32)
読み取り中…
検索中…
一致する文字列を見つけられません
関数
mgl_savedata.h ファイル

MGL セーブデータ [詳解]

#include <mgl/savedata/mgl_savedata_chunk_register.h>
#include <mgl/savedata/mgl_savedata_server.h>

[ソースコード]

関数

template<class DelegateClass , class... Args>
int32_t MGL::Savedata::CreateServer (Args... args) noexcept
 セーブデータサーバの生成
 
Server * MGL::Savedata::GetServer () noexcept
 セーブデータサーバの取得
 
bool MGL::Savedata::SaveRequests (const STL::vector< RequestInfo > &requests, bool haltOnError) noexcept
 セーブ要求
 
bool MGL::Savedata::SaveRequests (DataIdentifier identifier, uint32_t index) noexcept
 セーブ要求
 
bool MGL::Savedata::LoadRequests (const STL::vector< RequestInfo > &requests, bool haltOnError, bool errorOnFileNotExist) noexcept
 ロード要求
 
bool MGL::Savedata::LoadRequests (DataIdentifier identifier, uint32_t index, bool errorOnFileNotExist) noexcept
 ロード要求
 
bool MGL::Savedata::SaveSynchronously (const STL::vector< RequestInfo > &requests, bool haltOnError) noexcept
 同期セーブ
 
bool MGL::Savedata::SaveSynchronously (DataIdentifier identifier, uint32_t index) noexcept
 同期セーブ
 
bool MGL::Savedata::LoadSynchronously (const STL::vector< RequestInfo > &requests, bool haltOnError, bool errorOnFileNotExist) noexcept
 同期ロード
 
bool MGL::Savedata::LoadSynchronously (DataIdentifier identifier, uint32_t index, bool errorOnFileNotExist) noexcept
 同期ロード
 
bool MGL::Savedata::IsLoading () noexcept
 ロード中かを取得
 
bool MGL::Savedata::IsSaving () noexcept
 セーブ中かを取得
 
bool MGL::Savedata::IsReady () noexcept
 セーブ・ロードが可能な状態かを取得
 
bool MGL::Savedata::IsProcessing () noexcept
 処理中かを取得
 
bool MGL::Savedata::IsSucceeded () noexcept
 前回の処理に成功したかを取得
 
STL::vector< Result > MGL::Savedata::GetLastResults () noexcept
 最後に発生した処理結果を取得
 
bool MGL::Savedata::Wait () noexcept
 実行中の処理が完了するまで待機
 

詳解

MGL セーブデータ

日付
Since: August 11, 2021. 10:17:30 JST.
著者
Acerola

関数詳解

◆ CreateServer()

template<class DelegateClass , class... Args>
int32_t MGL::Savedata::CreateServer ( Args... args)
inlinenoexcept

セーブデータサーバの生成

戻り値
0成功
0以外の正数デリゲートの初期化エラー（意味はデリゲート側で定義）
負数サーバ側の要因によるエラー（現状は-1のみ，他は予約）

◆ GetLastResults()

STL::vector< Result > MGL::Savedata::GetLastResults ( )
nodiscardnoexcept

最後に発生した処理結果を取得

戻り値
処理結果

◆ GetServer()

Server * MGL::Savedata::GetServer ( )
inlinenodiscardnoexcept

セーブデータサーバの取得

戻り値
セーブデータサーバ．存在しない場合はnullptr

◆ IsLoading()

bool MGL::Savedata::IsLoading ( )
nodiscardnoexcept

ロード中かを取得

戻り値
trueロード中
falseロード中でない

◆ IsProcessing()

bool MGL::Savedata::IsProcessing ( )
nodiscardnoexcept

処理中かを取得

戻り値
true処理中
false処理中でない

◆ IsReady()

bool MGL::Savedata::IsReady ( )
nodiscardnoexcept

セーブ・ロードが可能な状態かを取得

戻り値
true可能
false不可能（処理中 or 未初期化）

◆ IsSaving()

bool MGL::Savedata::IsSaving ( )
nodiscardnoexcept

セーブ中かを取得

戻り値
trueセーブ中
falseセーブ中でない

◆ IsSucceeded()

bool MGL::Savedata::IsSucceeded ( )
nodiscardnoexcept

前回の処理に成功したかを取得

戻り値
true成功
false失敗 or 処理中

◆ LoadRequests() [1/2]

bool MGL::Savedata::LoadRequests ( const STL::vector< RequestInfo > & requests,
bool haltOnError,
bool errorOnFileNotExist )
noexcept

ロード要求

引数
[in]requests要求するデータの配列
[in]haltOnErrortrueを指定した場合，エラー発生時点で処理を中断する
[in]errorOnFileNotExisttrueを指定した場合，ファイルが存在しない場合をエラーとして扱う
戻り値
true成功
false失敗

◆ LoadRequests() [2/2]

bool MGL::Savedata::LoadRequests ( DataIdentifier identifier,
uint32_t index,
bool errorOnFileNotExist )
noexcept

ロード要求

引数
[in]identifier要求するデータの識別子
[in]index要求するデータのインデックス
[in]errorOnFileNotExisttrueを指定した場合，ファイルが存在しない場合をエラーとして扱う
戻り値
true成功
false失敗

◆ LoadSynchronously() [1/2]

bool MGL::Savedata::LoadSynchronously ( const STL::vector< RequestInfo > & requests,
bool haltOnError,
bool errorOnFileNotExist )
noexcept

同期ロード

引数
[in]requests要求するデータの配列
[in]haltOnErrortrueを指定した場合，エラー発生時点で処理を中断する
[in]errorOnFileNotExisttrueを指定した場合，ファイルが存在しない場合をエラーとして扱う
戻り値
true成功
false失敗

◆ LoadSynchronously() [2/2]

bool MGL::Savedata::LoadSynchronously ( DataIdentifier identifier,
uint32_t index,
bool errorOnFileNotExist )
noexcept

同期ロード

引数
[in]identifier要求するデータの識別子
[in]index要求するデータのインデックス
[in]errorOnFileNotExisttrueを指定した場合，ファイルが存在しない場合をエラーとして扱う
戻り値
true成功
false失敗

◆ SaveRequests() [1/2]

bool MGL::Savedata::SaveRequests ( const STL::vector< RequestInfo > & requests,
bool haltOnError )
noexcept

セーブ要求

引数
[in]requests要求するデータの配列
[in]haltOnErrortrueを指定した場合，エラー発生時点で処理を中断する
戻り値
true成功
false失敗

◆ SaveRequests() [2/2]

bool MGL::Savedata::SaveRequests ( DataIdentifier identifier,
uint32_t index )
noexcept

セーブ要求

引数
[in]identifier要求するデータの識別子
[in]index要求するデータのインデックス
戻り値
true成功
false失敗

◆ SaveSynchronously() [1/2]

bool MGL::Savedata::SaveSynchronously ( const STL::vector< RequestInfo > & requests,
bool haltOnError )
noexcept

同期セーブ

引数
[in]requests要求するデータの配列
[in]haltOnErrortrueを指定した場合，エラー発生時点で処理を中断する
戻り値
true成功
false失敗

◆ SaveSynchronously() [2/2]

bool MGL::Savedata::SaveSynchronously ( DataIdentifier identifier,
uint32_t index )
noexcept

同期セーブ

引数
[in]identifier要求するデータの識別子
[in]index要求するデータのインデックス
戻り値
true成功
false失敗

◆ Wait()

bool MGL::Savedata::Wait ( )
noexcept

実行中の処理が完了するまで待機

戻り値
true処理に成功
false処理に失敗
構築: doxygen 1.12.0