stingray.Cloud ネームスペース リファレンス

説明

Windows プラットフォームのロードおよび保存機能に対するインタフェースです。

オブジェクトはシングルトンである(1 つの Cloud のみが存在する)ため、関数に Cloud オブジェクトを渡す必要はありません。すべての関数は、Cloud シングルトンに対して動作します。

クラウドは、ゲームに対して使いやすくて透過的なリモート ファイル ストレージを提供します。ファイルは、ゲームの実行中にディスクに書き込まれ、ゲーム終了後に Steam バックエンドに複製されます。ユーザがコンピュータを変更すると、ゲーム開始前に新しいコンピュータにファイルがダウンロードされます。

ファイル名のネームスペースはフラットであるため、使用または作成されるフォルダはありません。フォルダ構造が必要な場合は、ファイル名にプリフィックスを付けることにより解決できます。すべてのファイル名において大文字と小文字は区別されません。

非同期操作は、操作中の進行状況を取得するために使用されるトークン オブジェクトを返します。ロードまたは保存操作中に使用される情報を解放するために、このオブジェクトを閉じる必要があります。そうしないと、ゲームは最終的にメモリ不足になります。

次のデータ型を保存することができます。

• string
• number
• boolean
• table
• Vector3
• Vector3Box
• Matrix4x4
• Matrix4x4Box

その他の関連リファレンス項目

	stingray.CloudToken
	steam_cloud_progress
	Steam

関数

auto_load ( filename ) : stingray.CloudToken 以前にクラウド上の指定されたファイルに保存されたデータをロードし、進行状況と結果のクエリーに使用できるトークンを返します。

パラメータ

filename :

string

ロードするファイルの名前です。

戻り値

stingray.CloudToken

progress() を呼び出すことによってクエリーできるトークンです。

メモリを解放するために、返されたトークンに対して stingray.Cloud.close()を呼び出す必要があります(操作の進行状況を確認した後)。これを行わないとメモリ リークが発生します。

auto_save ( filename, data ) : stingray.CloudToken クラウド上の指定されたファイルに指定されたデータを保存し、進行状況のクエリーに使用できるトークンを返します。

パラメータ

filename :	string	データを格納するファイルの名前です。
data :	any	格納するデータです。

戻り値

stingray.CloudToken

progress() を呼び出すことによってクエリーできるトークンです。

メモリを解放するために、返されたトークンに対して stingray.Cloud.close()を呼び出す必要があります(操作の進行状況を確認した後)。これを行わないとメモリ リークが発生します。

close ( token ) 指定されたトークンに対応するクラウド操作要求をモニタするためにエンジンによって使用されているメモリを解放します。

パラメータ

token :

stingray.CloudToken

閉じるトークンです。

戻り値

この関数は値を返しません。

その他の関連リファレンス項目

stingray.Cloud.auto_load() stingray.Cloud.auto_save()

delete ( filename ) : stingray.CloudToken 指定した filename をクラウドから削除します。

パラメータ

filename :

string

削除するファイルの名前です。

戻り値

stingray.CloudToken

progress() を呼び出すことによってクエリーできるトークンです。

ユーザがアプリケーションのインタフェース内のファイルを明示的に削除するときは、delete()を使用します。

enabled ( ) : boolean Steam クラウドがゲームで有効かどうかを示します。

パラメータ

この関数はパラメータを受け入れません。

戻り値

boolean

Steam クラウドがゲームで有効な場合は、true を返します。

これは、Steamworks の Game Admin ページで設定できます。

注: Cloud が有効になっていない場合、ロード操作と保存操作は動作しません。

forget ( filename ) : stingray.CloudToken 指定した filename を消去します。

パラメータ

filename :

string

消去するファイルの名前です。

戻り値

stingray.CloudToken

progress() を呼び出すことによってクエリーできるトークンです。

クラウド サービスのメモリを解放するために古いファイルを自動的に削除するときは、 forget() を使用します。ユーザがファイルを明示的に削除するときは、forget() を使用しないでください。

progress ( token ) : table 指定されたトークンで識別される保存操作またはロード操作の現在の状態に関する情報を取得します。

パラメータ

token :

stingray.CloudToken

非同期操作のステータスにアクセスできるようにするクラウド トークンです。

戻り値

table

保存操作またはロード操作に関する情報が含まれているテーブルです。

その他の関連リファレンス項目

	stingray.CloudToken
	steam_cloud_progress
	stingray.Cloud.auto_load() stingray.Cloud.auto_save() stingray.Cloud.delete() stingray.Cloud.forget()