Script - stingray.Script ネームスペース リファレンス - Stingray Lua API リファレンス
説明
Script インタフェースには、スクリプトを操作するためのヘルパー関数が含まれています。
関連サンプル コード 
その他の関連リファレンス項目
この参照ページは、次の概要トピックと関連付けられています
関数
 |
callstack ( ) : string 現在のスクリプト呼び出しスタックを返します。
|
| この関数はパラメータを受け入れません。 |
string |
現在のスクリプト呼び出しスタックです。 |
| |
configure_garbage_collection ( parameters )ガベージ コレクタを設定します。
|
parameters : | any(string, number)+ | Garbage Collection Flags の下にリストされる 1 つ以上のオプションです。それぞれの後に 1 つまたは複数の値が続きます。 + 表記は、指定されたタイプのインスタンスが 1 つまたは複数存在することを示しています。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。 |
| この関数は値を返しません。 |
たとえば、次のようになります。
stingray.Script.configure_garbage_collection(stingray.Script.MINIMUM_COLLECT_TIME_MS, 0.2, stingray.Script.MAXIMUM_GARBAGE, 0.4)
その他の関連リファレンス項目
| |
deserialize ( string_rep ) : any(string, number, boolean, table, stingray.Vector3, stingray.Vector3Box, stingray.Matrix4x4, stingray.Matrix4x4Box, stingray.IdString32, stingray.IdString32Box, stingray.IdString64, stingray.IdString64Box)Lua オブジェクトの不透明な文字列の表現をシリアル化解除します。
|
string_rep : | string | 文字列をオブジェクトにシリアル化解除します。 |
any(string, number, boolean, table, stingray.Vector3, stingray.Vector3Box, stingray.Matrix4x4, stingray.Matrix4x4Box, stingray.IdString32, stingray.IdString32Box, stingray.IdString64, stingray.IdString64Box) |
シリアル化解除された Lua オブジェクトです。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。 |
注: 文字列は、serialize() への呼び出しによって作成されている必要があります。そうでない場合、エラーが表示されます。
| |
exists ( resource ) : boolean現在ロードされているパッケージ内にスクリプトが存在するかどうかを確認します。
|
resource : | string | 必要な Lua スクリプトのリソース名です。 |
boolean |
ロードされたリソース内にスクリプトが存在する場合は、true を返します。 |
関連サンプル コード
| |
index_offset ( ) : integerオフセットは、0 ベースのインデックスには 0、または 1 ベースのインデックス(既定)には 1 です。
|
| この関数はパラメータを受け入れません。 |
integer |
Lua インデックスのオフセットです。 |
| |
load ( resource ) : fun(nil:any*)?標準の Lua 関数 loadstring() に類似していますが、代わりに Lua スクリプト リソースをスクリプトからロードする必要があります。
|
resource : | string | ロードする Lua スクリプトのリソース名です。 |
fun(nil:any*)? |
スクリプトを動作させる匿名の Lua 関数。 fun(...)表記は、これが、コロン : の左側に示されている型のパラメータを受け入れ、コロンの右側に示されている型を返す関数であることを示しています。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
| |
serialize ( data ) : string不透明な文字列表現をへと Lua データをシリアル化解除します。
|
data : | any(string, number, boolean, table, stingray.Vector3, stingray.Vector3Box, stingray.Matrix4x4, stingray.Matrix4x4Box, stingray.IdString32, stingray.IdString32Box, stingray.IdString64, stingray.IdString64Box) | シリアル化解除する Lua オブジェクトです。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。 |
string |
データ オブジェクトの文字列表現です。 |
その他の関連リファレンス項目
| |
set_index_offset ( offset )オフセットを、0 ベースのインデックスには 0、または 1 ベースのインデックス(既定)には 1 と設定します。
|
offset : | integer | Lua インデックスのオフセットです。 |
| この関数は値を返しません。 |
| |
set_temp_byte_count ( s )エンジンが使用中であるとみなされ、作成され、保管される一時オブジェクトのバッファの量を設定します。
|
s : | integer | 一時オブジェクト バッファのメモリ サイズです。 |
| この関数は値を返しません。 |
多くの一時オブジェクトを使用する関数がある場合、この呼び出しを使用して一時バッファをリセットし、それらのオブジェクトのすべてを解放できます。この関数は、これらのオブジェクトのいずれも、関数呼び出しの長さを超えて有効な変数に書き出すことはありません。これらの変数は、システムによって「解放された」とみなされるため、新しい値に割り当てられる可能性があります。
関連サンプル コード
| |
set_temp_count ( s )廃止予定: 代わりに set_temp_byte_count を使用してください。
|
s : | integer | 一時オブジェクト バッファのメモリ サイズです。 |
| この関数は値を返しません。 |
エンジンが使用中であるとみなされ、作成され、保管される一時オブジェクトのバッファの量を設定します。
多くの一時オブジェクトを使用する関数がある場合、この呼び出しを使用して一時バッファをリセットし、それらのオブジェクトのすべてを解放できます。この関数は、これらのオブジェクトのいずれも、関数呼び出しの長さを超えて有効な変数に書き出すことはありません。これらの変数は、システムによって「解放された」とみなされるため、新しい値に割り当てられる可能性があります。
| |
temp_byte_count ( ) : integer一時オブジェクトを含むメモリ バッファ内で現在使用されているサイズを返します。
|
| この関数はパラメータを受け入れません。 |
integer |
一時オブジェクト バッファのメモリ サイズです。 |
関連サンプル コード
| |
temp_count ( ) : integer廃止予定: 代わりに temp_byte_count()を使用してください。
|
| この関数はパラメータを受け入れません。 |
integer |
一時オブジェクト バッファのメモリ サイズです。 |
一時オブジェクトを含むメモリ バッファ内で現在使用されているサイズを返します。
| |
type_name ( obj ) : string指定されたオブジェクトのタイプ名を取得します。
|
obj : | any | タイプを取得するオブジェクトです。 |
string |
オブジェクトのタイプ名です。 |
Garbage Collection Flags
このグループに記載されている定数は、引数として stingray.Script.configure_garbage_collection() に渡すことができます。
| |
ACCEPTABLE_GARBAGE : integer ガベージに費やすことができる利用可能なメモリの許容できるパーセンテージを指定します。これは 0 ～ 1 の数値です。
|
値 0.1 は 10% になります。そのため、Lua が 20 MB のメモリを使用している場合、2 MB のガベージが許容されることになります。ここで値を高くすると、メモリの使用率が増えますが、ガベージ コレクションに要する時間が短縮されます。
既定値は 0.1 です。
| |
FORCE_FULL_COLLECT_GARBAGE_LEVEL : integerこの量の使用可能なメモリがガベージによって占有されている場合、ガベージ コレクションの完全停止を強制することができます。
|
これは、ゲームを中断させます。したがって、通常は避けたいものですが、ガベージを生成する暴走プロセスがある場合は、これによってクラッシュを避けることができます。既定値は 1.0 です。
| |
MAXIMUM_COLLECT_TIME_MS : integer最大のガベージ値に到達したときに、ガベージ コレクションに費やす時間(ミリ秒)です。
|
既定値は 10 です。
| |
MAXIMUM_GARBAGE : integerガベージに費やすことができる利用可能なメモリの最大パーセンテージを指定します。これは 0 ～ 1 の数値です。
|
ガベージの量がこの値に近づくに従って、各フレームでコレクションが行われる時間が増加します(最大コレクションの時間まで)。
既定値は 0.5 です。
その他の関連リファレンス項目
| |
MINIMUM_COLLECT_TIME_MS : integer各フレームでガベージ コレクションに費やされる最小時間(ミリ秒)です(ガベージ圧力が低い場合)。
|
既定値は 0.5 です。
その他の関連リファレンス項目