Tus - stingray.Tus ネームスペース リファレンス - Stingray Lua API リファレンス
説明
PlayStation 4 のタイトル ユーザ ストレージ(TUS)機能にアクセスするためのインタフェースです。
オブジェクトはシングルトン(Tus 1 つのみ)なので、Tus オブジェクトを関数に渡す必要はありません。すべての関数は、Tus シングルトン上で動作します。
非同期操作では、操作の進行状況を取得するために status() の呼び出しで渡すことができる ID が返されます。操作が完了したら、free () を呼び出すことによってこのオブジェクトに使用されているメモリを解放する必要があります。そうしないと、ゲームは最終的にメモリ不足になります。
その他の関連リファレンス項目 
関数
 |
delete ( target, options ) : integer ターゲットの一覧表示されたスロットを削除します。
|
target : | any | 削除するターゲットのスロット。 |
options : | integer[] | 削除するスロットです。 []表記は、この型が配列(メンバーのキーは連番、各要素の値は示されている型のインスタンス)であることを示します。 |
integer |
操作の ID。この ID を stingray.Tus.status() に渡して、操作の進行状況を追跡することができます。 |
たとえば、次のようになります。
stingray.Tus.delete(target, slot_1, slot_2, ...)
| |
delete_data ( target, options ) : integerターゲットのリストされたデータ スロットを削除します。
|
target : | any | 削除するターゲットのデータ スロットです。 |
options : | integer[] | 削除するスロットです。 []表記は、この型が配列(メンバーのキーは連番、各要素の値は示されている型のインスタンス)であることを示します。 |
integer |
操作の ID。この ID を stingray.Tus.status() に渡して、操作の進行状況を追跡することができます。 |
たとえば、次のようになります。
stingray.Tus.delete_data(target, slot_1, slot_2, ...)
| |
free ( id )指定された ID を持つ操作を追跡するためにシステムが保持しているすべてのデータを解放します。
|
id : | integer | メモリを解放する操作の ID です。 |
| この関数は値を返しません。 |
取得しなおすすべての ID について free() を呼び出す必要があります。これは、操作が正常に完了したかどうかに関わりません。そうしないと、TUS システムが最終的にメモリ不足になります。
| |
get ( target, options ) : integerターゲットの指定されたスロットに格納された値を取得します。
|
target : | any | 値を取得するターゲットです。 |
options : | integer* | 格納された値を取得するスロットです。 * の注記は、指定されたタイプのゼロ以上のインスタンスがある場合があることを示します。 |
integer |
操作の ID を返します。この ID を stingray.Tus.status() に渡して、操作の進行状況を追跡することができます。 |
操作が完了したら、stingray.Tus.has_get_result() と stingray.Tus.get_result() を使用して、操作の結果を取得することができます。たとえば、次のようになります。
stingray.Tus.get(target, slot_1, slot_2, ...)
その他の関連リファレンス項目
| |
get_data ( target, slot ) : integerターゲットの指定されたスロットに格納されたデータを取得します。
|
target : | any | 操作のターゲットです。 |
slot : | integer | データを取得するスロットです。 |
integer |
操作の ID。この ID を stingray.Tus.status() に渡して、操作の進行状況を追跡することができます。 |
その他の関連リファレンス項目
| |
get_data_result ( id ) : ps4_tus_slot_datastingray.Tus.get_data() 操作の結果を返します。
|
id : | integer | stingray.Tus.get_data() 操作の ID |
|
指定されたスロット用に取得されたデータを含むテーブル。 |
これは、stingray.Tus.has_get_data_result() が true を返す場合にのみ呼び出します。
その他の関連リファレンス項目
| |
get_info ( target, options ) : integer実際のデータを取得せずに、複数のデータ スロットに関する情報を取得します。
|
target : | any | 操作のターゲットです。 |
options : | integer[] | 情報を取得する必要があるスロットです。 []表記は、この型が配列(メンバーのキーは連番、各要素の値は示されている型のインスタンス)であることを示します。 |
integer |
操作の ID。この ID を stingray.Tus.status() に渡して、操作の進行状況を追跡することができます。 |
たとえば、次のようになります。
stingray.Tus.get_info(target, slot_1, slot_2, ....)
その他の関連リファレンス項目
| |
get_info_result ( id ) : ps4_tus_slot_datastingray.Tus.get_info() 操作の結果を返します。
|
id : | integer | stingray.Tus.get_info() 操作の ID |
|
stingray.Tus.get_info() の呼び出しで要求される各スロットのエントリがあるテーブルです。各エントリには、stingray.Tus.get_data_result() によって返されるテーブル ps4_tus_slot_data と同じフィールドがありますが、data フィールドはありません。 |
これは、stingray.Tus.has_get_info_result() が true を返す場合にのみ呼び出します。
| |
get_result ( id, format ) : ps4_tus_slot_data[]指定された ID を持つ stingray.Tus.get() 操作の結果を返します。
|
id : | integer | stingray.Tus.get() 操作の ID です。 |
format : | integer | Tus.DETAILS 形式を指定すると、この関数は、それぞれが指定されたスロットの結果を提供するテーブルのリストを返します。 |
|
各スロットのエントリがあるテーブルのリストです。 []表記は、この型が配列(メンバーのキーは連番、各要素の値は示されている型のインスタンス)であることを示します。 |
これは、stingray.Tus.has_get_result() が true を返す場合にのみ呼び出します。
| |
get_result ( id, format ) : number*指定された ID を持つ stingray.Tus.get() 操作の結果を返します。
|
id : | integer | stingray.Tus.get() 操作の ID です。 |
format : | integer | Tus.JUST_VALUES 形式を指定すると、この関数はスロットの値を Lua スタックに直接返します。 |
number* |
スロットの値を Lua スタックに直接返します。スロットの値がない場合は、nil がそのスロットに返されます。 * の注記は、指定されたタイプのゼロ以上のインスタンスがある場合があることを示します。 |
これは、stingray.Tus.has_get_result() が true を返す場合にのみ呼び出します。
その他の関連リファレンス項目
| |
has_get_data_result ( id ) : boolean指定された ID を持つ stingray.Tus.get_data() 操作に使用可能な結果がある場合は true を返します。
|
id : | integer | stingray.Tus.get_data() 操作の ID |
boolean |
指定された ID を持つ stingray.Tus.get_data() 操作に使用可能な結果がある場合は true を返します。 |
stingray.Tus.get_data_result() を呼び出して、結果を取得することができます。
その他の関連リファレンス項目
| |
has_get_info_result ( id ) : booleanstingray.Tus.get_info() 操作に使用可能な結果がある場合は true を返します。
|
id : | integer | stingray.Tus.get_info() 操作の ID |
boolean |
指定された ID を持つ stingray.Tus.get_info() 操作に使用可能な結果がある場合は true を返します。 |
その他の関連リファレンス項目
| |
has_get_result ( id ) : boolean指定された ID を持つ stingray.Tus.get() 操作に使用可能な結果があるかどうかを示します。
|
id : | integer | stingray.Tus.get() 操作の ID です。 |
boolean |
stingray.Tus.get() 操作に使用可能な結果がある場合は true を返します。 |
stingray.Tus.get_result() を呼び出して、結果を取得することができます。
その他の関連リファレンス項目
| |
set ( target, options ) : integerターゲットの指定されたスロットに格納する値を設定します。
|
target : | string? | 値を設定するターゲットです。これは nil (最初にログインしたユーザーを使用する場合)、ユーザに値を設定する SceNpId、または仮想ユーザの値を設定する SceNpTusVirtualUserId のいずれかにすることができます。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
options : | any(integer, number)* | スロットの後にその値が続きます。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。 * の注記は、指定されたタイプのゼロ以上のインスタンスがある場合があることを示します。 |
integer |
操作の ID を返します。この ID を stingray.Tus.status() に渡して、操作の進行状況を追跡することができます。 |
たとえば、次のようになります。
stingray.Tus.set(target, slot_1, value_1, slot_2, value_2, ...)
| |
set_data ( target, slot, data, info ) : integer指定されたスロットのデータと情報を設定します。
|
target : | any | 操作のターゲットです。 |
slot : | integer | データと情報を設定するためのスロットです。 |
data : | string | 設定するデータです。 |
info : | string? | オプション。設定する情報です。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
integer |
操作の ID。この ID を stingray.Tus.status() に渡して、操作の進行状況を追跡することができます。 |
| |
status ( id ) : integer指定した ID を使用して操作のステータスを返します。
|
結果の形式の定数
スロットに関して取得する情報の詳細レベルを指定するため、呼び出しごとにこれらの値のいずれか 1 つを [get_results()] に渡します。
| |
DETAILS : integer 各スロットに関する詳細情報が含まれているテーブルのリストを返すよう、[get_results()] に指示します。
|
その他の関連リファレンス項目 
| |
JUST_VALUES : integer各スロットの現在の値を返すように [get_results()] に指示します。
|
その他の関連リファレンス項目
ステータス コード
status()への呼び出しで返されます。
 |
COMPLETED : integer操作が正常に完了しました。
|
| |
ERROR : integer操作中にエラーが発生しました。
|
| |
STARTED : integer操作は開始されていますが、まだ完了していません。
|
| |
UNKNOWN : integerID が作成されたことがないか、または既に解放されています。
|