stingray.Level オブジェクト リファレンス

説明

ランタイム ゲーム ワールド内にロードされているレベルを表します。

コンストラクタとアクセサ

stingray.Application.flow_callback_context_level() stingray.Level.nested_levels() stingray.Unit.level() stingray.World.levels() stingray.World.load_level() stingray.World.load_level_with_object_sets()

関連サンプル コード

Appkit: /app.lua Appkit: /camera_wrapper.lua Appkit: /level_wrapper.lua 基本テンプレート: /player.lua Oculus VR テンプレート: /player.lua Steam VR テンプレート: /player.lua 最小テンプレート: /boot.lua

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

	stingray.StoryTeller.play_level_story() stingray.Unit.level() stingray.World.destroy_level()
	Core

この参照ページは、次の概要トピックと関連付けられています

	「構築レベル > ゲーム オブジェクトを作成する > スプラインを作成する」
	「ゲームプレイを作成する > Flow を使用したビジュアル プログラミング > サンプル ワークフロー: ドアのオープンをトリガする」
	「ゲームプレイを作成する > Lua でスクリプトを作成する > テンプレートから Lua を開始する: Appkit を使用する > SimpleProject を使用する」
	「ゲームプレイを作成する > Flow と Lua の間で通信する」
	「コンテンツとリソースを管理する > ランタイムでコンテンツをロードおよびロード解除する > 例: レベルごとの 1 つのリソース パッケージのロードおよびロード解除」
	「プロジェクトでエンティティを使用する > ゲームプレイ中にエンティティを操作する」

関数

entities ( self ) : stingray.Entity[] レベル内のすべてのエンティティを含むテーブルを返します。

パラメータ

self :

stingray.Level

この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

戻り値

stingray.Entity[]

レベル内のすべてのエンティティを含むテーブルです。 []表記は、この型が配列(メンバーのキーは連番、各要素の値は示されている型のインスタンス)であることを示します。

flow_variable ( self, name ) : any レベル フロー内の指定された名前を持つ外部出力フロー変数の値を返します。

パラメータ

self :	stingray.Level	この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
name :	string	取得する外部フロー変数の名前です。

戻り値

any	フロー変数の値です。 この値のタイプは、指定した名前と一致する外部出力変数のタイプによって異なります。

この関数は、**External > Output** カテゴリの下にある外部変数フロー ノードを使用することに注意してください。これは、フロー グラフでしか設定および取得できない Variables カテゴリ下のノードとは関係ありません。

注: エディタに "My Unit" として表示される変数には、実際の名前 "my_unit" があります。

get_data ( self, indices ) : any レベルのスクリプト データ オブジェクト内の指定したインデックスでデータ セットを取得します。

パラメータ

self :	stingray.Level	この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
indices :	any(integer, string)+	整数または文字列のデータの 1 つまたは複数のインデックスです。 + 表記は、指定されたタイプのインスタンスが 1 つまたは複数存在することを示しています。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。

戻り値

any	指定されたインデックスのシーケンスで以前に保存したデータです。

Unit.get_data() に似ています。

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

	stingray.DynamicData
	stingray.Level.set_data() stingray.LevelResource.data()

has_data ( self, indices ) : boolean レベルのスクリプト データ オブジェクト内に指定されたインデックスで保存されているデータがあるかどうかを示します。

パラメータ

self :	stingray.Level	この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
indices :	any(integer, string)+	整数または文字列のデータの 1 つまたは複数のインデックスです。 + 表記は、指定されたタイプのインスタンスが 1 つまたは複数存在することを示しています。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。

戻り値

boolean

データ値が指定されたインデックスのシーケンスで格納されている場合は true を返し、それ以外の場合は false を返します。

Unit.has_data() に似ています。

has_volume ( self, volume_name ) : boolean レベルに指定された名前を持つボリュームがあるかどうかを示します。

パラメータ

self :	stingray.Level	この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
volume_name :	string	ボリュームの名前です。

戻り値

boolean

レベルに指定されたボリュームがある場合は true、それ以外の場合は false を返します。

is_point_inside_volume ( self, volume_name, point ) : boolean ポイントがレベル内の指定したボリュームの内側にあるかどうかを示します。

パラメータ

self :	stingray.Level	この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
volume_name :	string	ボリュームの名前です。
point :	stingray.Vector3	テストされるポイントです。

戻り値

boolean

ポイントが指定したボリュームの内側にある場合は true、それ以外の場合は false を返します。

navigation_mesh ( self ) : stingray.NavigationMesh レベルのナビゲーション メッシュを返します。

パラメータ

self :

stingray.Level

この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

戻り値

stingray.NavigationMesh

レベルのナビゲーション メッシュです。

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

stingray.LevelResource.destroy_navigation_mesh()

nested_levels ( self ) : stingray.Level[] 指定したレベルの直下にネストされているレベルのリストを返します。

パラメータ

self :

stingray.Level

この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

戻り値

stingray.Level[]

ネストされたレベル []表記は、この型が配列(メンバーのキーは連番、各要素の値は示されている型のインスタンス)であることを示します。

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

stingray.World.levels()

next_random_point_inside_volume ( self, volume_name, seed ) : integer, stingray.Vector3 純乱数ポイント関数です。

パラメータ

self :	stingray.Level	この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
volume_name :	string	ボリュームの名前です。
seed :	integer	シード パラメータ

戻り値

integer	生成された新しいシード
stingray.Vector3	指定したボリューム内部の乱数ポイント

random_point_inside_volume() と似ていますが、シード パラメータを取り、乱数ポイントとともに新しいシードを返します。通常、next_random_point_inside_volume() は、ボリューム内の乱数ポイントの再現可能なシーケンスをクエリーする場合に使用します。

num_nested_levels ( self ) : integer レベル内のネストされたレベルの数を返します。

パラメータ

self :

stingray.Level

この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

戻り値

integer

ネストされたレベルの総数です。

num_splines ( self ) : integer レベル内のスプラインの数を返します。

パラメータ

self :

stingray.Level

この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

戻り値

integer

スプラインの総数です。

pose ( self ) : stingray.Matrix4x4 ワールド内にレベルを配置した Matrix4x4 を返します。

パラメータ

self :

stingray.Level

この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

戻り値

stingray.Matrix4x4

ワールドからレベルをスポーンするときに使用されるトランスフォームです。

random_point_inside_volume ( self, volume_name ) : stingray.Vector3 指定されたボリューム内部の乱数ポイントのワールド空間の位置を返します。

パラメータ

self :	stingray.Level	この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
volume_name :	string	ボリュームの名前です。

戻り値

stingray.Vector3

指定したボリューム内部の乱数ポイントです。

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

stingray.Level.next_random_point_inside_volume()

set_data ( self, indices, indices, indices, value ) set_data ( self, indices, indices, value ) set_data ( self, indices, value ) グローバル スクリプト データ オブジェクト内の指定されたインデックスで決定される位置に、指定された値を格納します。

パラメータ

self :	stingray.Level	この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
indices :	any(integer, string)	整数または文字列のデータの 1 つまたは複数のインデックスです。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。
value :	any	格納する値です。

戻り値

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

get_data()の呼び出しで同じインデックスを渡すことにより、後でそのデータを取得できます。Unit.set_data() に似ています。

set_flow_variable ( self, name, value ) レベル フロー内の指定された名前を持つ外部入力フロー変数の値を設定します。

パラメータ

self :	stingray.Level	この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
name :	string	設定する外部フロー変数の名前です。
value :	any	フロー変数に格納する新しい値を指定します。 この値のタイプは、指定した名前と一致する外部入力変数のタイプによって異なります。

戻り値

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

この関数は、**External > Input** カテゴリの下にある外部変数フロー ノードを使用することに注意してください。これは、フロー グラフでしか設定および取得できない Variables カテゴリ下のノードとは関係ありません。

spawn_background ( self ) レベル内のすべての背景要素をスポーンします。

パラメータ

self :

stingray.Level

この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

戻り値

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

通常、ルート レベルをスポーンする際には、シーンに追加するスカイボックス ユニットやその他の要素がありますが、ネストされたレベルやサブレベルをスポーンする際にはありません。この関数を呼び出さない場合、背景オブジェクトがレベル エディタで見えるようになるため、通常、いくつかのレンダリング アーティファクトがある黒い空になります。

spline ( self, name ) : stingray.Vector3[] 指定した名前を持つベジェ スプラインのコントロール ポイントを返します。

パラメータ

self :	stingray.Level	この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
name :	string	スプラインの名前です。

戻り値

stingray.Vector3[]

スプラインのコントロール ポイントを含むテーブル、または指定した名前を持つスプラインがない場合は空のテーブルです。 []表記は、この型が配列(メンバーのキーは連番、各要素の値は示されている型のインスタンス)であることを示します。

spline_by_index ( self, index ) : stingray.Vector3[] 指定したインデックスを持つベジェ スプラインのコントロール ポイントを返します。

パラメータ

self :	stingray.Level	この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
index :	integer	レベル内のスプラインのインデックス

戻り値

stingray.Vector3[]

スプラインのコントロール ポイントを含むテーブル、または指定したインデックスを持つスプラインがない場合は空のテーブルです。 []表記は、この型が配列(メンバーのキーは連番、各要素の値は示されている型のインスタンス)であることを示します。

trigger_event ( self, event ) レベル フロー スクリプトで外部イベントをトリガします。

パラメータ

self :	stingray.Level	この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
event :	string	トリガする外部イベントの名前です。

戻り値

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

trigger_level_loaded ( self ) レベルのフロー グラフ内の "level loaded" イベントをトリガします。

パラメータ

self :

stingray.Level

この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

戻り値

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

trigger_level_shutdown ( self ) レベルのフロー グラフ内の "level shutdown" イベントをトリガします。

パラメータ

self :

stingray.Level

この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

戻り値

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

trigger_level_update ( self ) レベルのフロー グラフ内の "level updated" イベントをトリガします。

パラメータ

self :

stingray.Level

この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

戻り値

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

units ( self ) : stingray.Unit[] エディタでレベル内に配置され、レベルがロードされてからまだスポーン解除されていないすべてのユニットのリストを返します。

パラメータ

self :

stingray.Level

この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

戻り値

stingray.Unit[]

レベルがロードされたときにスポーンされた残りのユニットのリストです。 []表記は、この型が配列(メンバーのキーは連番、各要素の値は示されている型のインスタンス)であることを示します。

リストが取得された後に 1 つ以上のユニットが破壊されると、リストに無効な参照が含まれるため、複数のフレームにわたってこのリストを保しないでください。有効な参照の新しいリストを取得するには、このメソッドを呼び出します。

unit_by_index ( self, index ) : stingray.Unit レベル内の指定したインデックスを持つユニットを取得します。

パラメータ

self :	stingray.Level	この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
index :	integer	ユニットのインデックスです。

戻り値

stingray.Unit

インデックスに対応するユニット、または指定したインデックスを持つユニットが見つからない場合は nil です。

インデックスは通常、unit_index() から取得されます。

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

stingray.Level.unit_index()

unit_index ( self, unit ) : integer? レベル内のユニットのインデックスを返します。

パラメータ

self :	stingray.Level	この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
unit :	stingray.Unit	レベル内のユニットです。

戻り値

integer?

指定したユニットのインデックス、または一致するユニットが見つからない場合は nil です。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

unit_by_index() を呼び出すことで、インデックスをユニットに戻すことができます。これを使用して、たとえばユニット ID をネットワークを介して他のプレイヤーに送信することができます。

注: この関数を使用できるのは、レベル内で静的にスポーンされたユニットのみで、スクリプトまたはフロー ノードによってスポーンされたユニットでは使用できません。

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

stingray.Level.unit_by_index()

world ( self ) : stingray.World レベルがスポーンされているワールドを返します。

パラメータ

self :

stingray.Level

この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

戻り値

stingray.World

レベルがスポーンされるワールドです。

関連サンプル コード

Appkit: /unit_link.lua