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

説明

mod システムにアクセスするためのインタフェースです。

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

Utilities

関数

info ( mod ) : string mod についての情報ファイルを返します。

パラメータ

mod :

integer

詳細を取得する mod のインデックスです。

戻り値

string

mod についての情報ファイルです。

これは、通常はサンドボックス環境で実行される Lua ファイルです。

is_scanning ( ) : boolean システムが現在 mod をスキャンしているかどうかを示します。

パラメータ

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

戻り値

boolean

mod スキャンが進行中の場合は true、それ以外の場合は false を返します。

mods ( ) : integer[] すべての利用可能な mod を識別するインデックスのリストを返します。

パラメータ

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

戻り値

integer[]

すべての利用可能な mod の整数のインデックスのリストです。 []表記は、この型が配列(メンバーのキーは連番、各要素の値は示されている型のインスタンス)であることを示します。

release_resource_package ( rp ) stingray.Mod.resource_package() を使用して割り当てられたリソース パッケージを解放します。

パラメータ

rp :

stingray.ResourcePackage

解放するリソース パッケージです。

戻り値

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

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

stingray.Mod.resource_package()

resource_package ( mod, name ) : stingray.ResourcePackage mod から指定された名前を使用してリソース パッケージを返します。

パラメータ

mod :	integer	リソース パッケージを取得する mod のインデックスです。
name :	string	mod 内のリソース パッケージの名前です。

戻り値

stingray.ResourcePackage

mod から指定された名前を使用してリソース パッケージを返します。

その他のリソース パッケージをロードするために使用するものと同じ関数を使用してパッケージをロードすることができます。ただし、Mod.resource_package() によって返されるリソース パッケージは、stingray.Mod.release_resource_package()·によって解放される必要があります。

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

stingray.Mod.release_resource_package()

set_security_options ( options ) エンジンのセキュリティ オプションを設定します。

パラメータ

options :

any(integer, string, boolean)+

Set Security Options グループは、1 つ以上のセキュリティ オプションの定数によって構成され、それぞれの後にオプションのために設定された 1 つまたは複数の値が続きます。 + 表記は、指定されたタイプのインスタンスが 1 つまたは複数存在することを示しています。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。

戻り値

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

これは、信頼できないデータ(mod)を実行するときに便利です。

たとえば、次のようになります。

set_security_options(stingray.Mod.FLOW_SCRIPT_NODES_ENABLED, true, stingray.Mod.FLOW_CUSTOM_SCRIPT_TABLES, "FlowCallbacksLevel1", "FlowCallbacksLevel2")

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

セキュリティ オプションの設定

start_scan ( ) : boolean mod のスキャンを開始します。

パラメータ

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

戻り値

boolean

スキャンが既に実行されている場合は、false を返し、それ以外の場合は、true を返します。複数のスキャンを同時に実行することはできません。

mod をスキャンしないと、mod システムを使用することはできません。後から再スキャンして、mod に加えられた変更または新しくインストールされたばかりの新しい mod を見つけることができます。

注: mod パッケージのロード中は再スキャンを実行しないでください。

セキュリティ オプションの設定

このグループに記載されているセキュリティ オプションは、引数として stingray.Mod.set_security_options() に渡すことができます。

FLOW_CUSTOM_SCRIPT_TABLES : integer カスタム スクリプト ノードによって使用できるグローバル テーブルの名前を指定します。

たとえば、「FlowCallbacks」です。名前が付けられたテーブルの外部の関数を、カスタム スクリプト フロー ノードによって呼び出すことはできません。空のリスト(既定)を使用すると、カスタム スクリプト フロー ノードはどのような関数も呼び出すことができます。このオプションに設定する値は、1 つ以上の文字列である必要があります。

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

stingray.Mod.set_security_options()

FLOW_SCRIPT_NODES_ENABLED : integer ユーザが任意の関数を呼び出すことができるフロー ノード(Script Do String、Script Call Global)を有効にするか無効にするかを制御します。

無効になっている場合でも、カスタム スクリプト ノードは使用できます。このオプションにはブール値を設定する必要があります。

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

stingray.Mod.set_security_options()