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

説明

ゲーム ワールドを表します。

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

stingray.Application.flow_callback_context_world() stingray.Application.main_world() stingray.Application.new_world() stingray.Application.worlds() stingray.Level.world() stingray.Unit.level()

関連サンプル コード

Appkit: /app.lua Appkit: /debug_menu.lua Appkit: /debug_scrollbox.lua Appkit: /level_wrapper.lua Appkit: /loading_screen.lua Appkit: /simple_project.lua Appkit: /unit_link.lua Appkit: /world_wrapper.lua 基本テンプレート: /player.lua キャラクタ テンプレート: /player.lua 車両テンプレート: /player.lua Oculus VR テンプレート: /player.lua Oculus VR テンプレート: /project_utils.lua Steam VR テンプレート: /player.lua Steam VR テンプレート: /project_utils.lua 最小テンプレート: /boot.lua

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

	stingray.Replay stingray.WwiseWorld
	stingray.Application.create_viewport() stingray.Application.destroy_viewport() stingray.Application.main_world() stingray.Application.new_world() stingray.Application.release_world() stingray.Application.render_world() stingray.Application.worlds() stingray.EntityManager.actor_component() stingray.EntityManager.animation_blender_component() stingray.EntityManager.animation_state_machine_component() stingray.EntityManager.create() stingray.EntityManager.flow_component() stingray.EntityManager.mesh_component() stingray.EntityManager.render_data_component() stingray.EntityManager.scene_graph_component() stingray.EntityManager.script_component() stingray.EntityManager.spawn() stingray.EntityManager.spawn() stingray.EntityManager.tag_component() stingray.EntityManager.transform_component() stingray.EntityManager.unit_component() stingray.GearVR.link_node_to_tracker() stingray.GoogleVR.link_node_to_eye() stingray.Hololens.attach_entity() stingray.Hololens.initialize() stingray.Hololens.spatial_map_setup() stingray.Level.pose() stingray.Level.world() stingray.LineObject.dispatch() stingray.NavigationMesh.destroy() stingray.NavigationMesh.merge() stingray.Oculus.initialize() stingray.Oculus.link_node_to_tracker() stingray.Oculus.set_camera() stingray.SteamVR.initialize() stingray.SteamVR.link_node_to_tracker() stingray.SteamVR.set_camera() stingray.TerrainDecoration.create_observer() stingray.TerrainDecoration.destroy_observer() stingray.TerrainDecoration.move_observer() stingray.Unit.level() stingray.UnitSynchronizer.set_world() stingray.Wwise.wwise_world()
	Core

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

	「ライティングとレンダリング > ライティング > 光源 > 光源を作成する」
	「ライティングとレンダリング > ライティング > 光源 > 光源のプロパティを変更する」
	「ライティングとレンダリング > シェーディング > マテリアルをデカールとして投影する」
	「ライティングとレンダリング > シェーディング環境とポスト エフェクト > シェーディング環境のプロパティを変更する」
	「ゲームプレイを作成する > Lua でスクリプトを作成する > テンプレートから Lua を開始する: Appkit を使用する > Appkit を使用してワールド、レベル、カメラを管理する」
	「ゲームプレイを作成する > Lua でスクリプトを作成する > Lua をゼロから開始する: カスタム ブート スクリプトを使用する」
	「ゲームプレイを作成する > Lua でスクリプトを作成する > Lua をゼロから開始する: カスタム ブート スクリプトを使用する > ブート スクリプトのサンプル」
	「ゲームプレイを作成する > Lua でスクリプトを作成する > Lua API を使用する > オブジェクトのライフタイムとユーザデータのバインド」
	「ゲームプレイを作成する > 物理特性 > ベクトル フィールド(風)のエフェクトを設定する」
	「プロジェクトでエンティティを使用する > ゲームプレイ中にエンティティを操作する」

関数

delta_time ( self ) : number 最後のワールドのアップデート中に使用されたデルタ時間値を取得します。

パラメータ

self :

stingray.World

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

戻り値

number

デルタ時間値です。

entities ( self ) : stingray.Entity[] ワールドのすべてのエンティティが含まれているテーブルを返します。

パラメータ

self :

stingray.World

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

戻り値

stingray.Entity[]

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

replay ( self ) : stingray.Replay? Replay オブジェクトを返します。これはワールドのイベントの再生に使用できます。

パラメータ

self :

stingray.World

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

戻り値

stingray.Replay?

ワールドが所有する Replay オブジェクト、または再生システムがワールドに対して有効にされていなかった場合は nil を返します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

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

stingray.Replay

scatter_system ( self ) : stingray.ScatterSystem ワールドが所有する散乱ブラシ システムを返します。

パラメータ

self :

stingray.World

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

戻り値

stingray.ScatterSystem

ワールドが所有する散乱システムです。

ブラシ システムは、質量単位スポーン操作に使用されます。

関連サンプル コード

Appkit: /camera_wrapper.lua

storyteller ( self ) : stingray.StoryTeller ワールドに対して、ストーリーまたはカットシーンを再生できる StoryTeller を返します。

パラメータ

self :

stingray.World

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

戻り値

stingray.StoryTeller

ワールドが所有する Storyteller です。

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

stingray.StoryTeller

time ( self ) : number ワールドの現在時間を取得します。つまり、ワールドの作成以降の、すべての更新のすべてのデルタ時間の合計です。

パラメータ

self :

stingray.World

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

戻り値

number

ワールドの現在の時間です。

関連サンプル コード

基本テンプレート: /main_menu.lua キャラクタ テンプレート: /main_menu.lua 車両テンプレート: /main_menu.lua Oculus VR テンプレート: /main_menu.lua

update ( self, delta_time ) ワールドのエンジンの表現を更新します。

パラメータ

self :	stingray.World	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
delta_time :	number?	更新時にワールドが使用する必要がある時間ステップです。(オプション) 指定しない場合は、アプリケーションのグローバル時間ステップが使用されます。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

戻り値

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

通常は、Lua ブート スクリプトのエンジンに提供する update () コールバックの実装で、この関数を呼び出す必要があります。

update() を呼び出す代わりに、まず update_animations() を呼び出し、それから update_scene() を呼び出すことができます。これによりブート スクリプトは、アニメーションの更新とシーンの更新の更新の間にいくらかの処理を実行できます。

update_animations ( self, delta_time ) ワールドのアニメーションを更新します。

パラメータ

self :	stingray.World	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
delta_time :	number?	更新時にワールドが使用する必要がある時間ステップです。(オプション) 指定しない場合は、アプリケーションのグローバル時間ステップが使用されます。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

戻り値

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

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

stingray.World.update() stingray.World.update_animations_with_callback()

update_animations_with_callback ( self, delta_time, callback ) update_animations () と同じですが、アニメーション プレイヤーの更新時に提供したコールバック関数を呼び出します。

パラメータ

self :	stingray.World	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
delta_time :	number	更新時にワールドが使用する必要がある時間ステップです。
callback :	fun(nil:nil)	呼び出されるコールバック関数です。 fun(...)表記は、これが、コロン : の左側に示されている型のパラメータを受け入れ、コロンの右側に示されている型を返す関数であることを示しています。

戻り値

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

アニメーション プレイヤーの更新が SPU 上で完全に実行され、PPU を他の処理ができるように解放するので、これは PlayStation 3 で役立つ場合があります。したがって、Lua 更新の一部をコールバック関数に入れて、コードを並行実行できるので、貴重な時間をミリ秒単位で節約できます。アニメーション プレイヤーの更新を妨げることになるため、コールバックでアニメーションを作成または破壊してはなりません。

update_scene ( self, delta_time ) ワールド内の物理およびシーンのグラフを更新します。

パラメータ

self :	stingray.World	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
delta_time :	number?	更新時にワールドが使用する必要がある時間ステップです。(オプション) 指定しない場合は、アプリケーションのグローバル時間ステップが使用されます。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

戻り値

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

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

stingray.World.update()

スクリプト データ

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

パラメータ

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

戻り値

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

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

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

stingray.World.set_data()

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

パラメータ

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

戻り値

boolean

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

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

set_data ( self, indices, indices, indices, value ) set_data ( self, indices, indices, value ) set_data ( self, indices, value ) 指定されたインデックスによって決定された位置で、ワールドのスクリプト データ オブジェクトに、指定の値を保管します。

パラメータ

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

戻り値

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

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

デバッグ

clear_permanent_lines ( self ) ワールドに描画されているすべての永続的なデバッグ ラインをクリアします。

パラメータ

self :

stingray.World

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

戻り値

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

create_line_object ( self, disable_depth_test ) : stingray.LineObject デバッグ描画に使用する新しい線分オブジェクトを作成します。

パラメータ

self :	stingray.World	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
disable_depth_test :	boolean?	true の場合、線分は深度テストなしで描画されます。(オプション) 既定値は false です。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

戻り値

stingray.LineObject

新しく作成された線分オブジェクトです。

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

	stingray.LineObject
	stingray.World.destroy_line_object()

debug_camera_pose ( self ) : stingray.Matrix4x4 ワールドのレンダリングに使用された最終カメラの位置と方向を返します。

パラメータ

self :

stingray.World

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

戻り値

stingray.Matrix4x4

カメラの位置と方向です。

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

stingray.Actor.debug_draw()

destroy_line_object ( self, line ) create_line_object() の呼び出しにより以前に作成された線分オブジェクトを破壊します。

パラメータ

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

戻り値

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

開発のみ

このグループの要素は、開発ビルドでのみ使用可能です。

最終的なビルドでは使用しないでください。

num_particles ( self, effect_id, cloud_index ) : integer ワールド、パーティクル エフェクト、またはクラウド内のアクティブなパーティクルの数を返します。

パラメータ

self :	stingray.World	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
effect_id :	integer?	パーティクル エフェクトの ID です。(オプション) 指定した場合、戻り値は、指定されたパーティクル エフェクトのパーティクル数のみが返されます。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。
cloud_index :	integer?	パーティクル クラウドのインデックスです。(オプション) 指定した場合、戻り値は、指定されたクラウドのパーティクル数のみが返されます。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

戻り値

integer

アクティブなパーティクルの数です。

set_frustum_inspector_camera ( self, camera ) カメラをこの関数に渡すと、すべてのカリングが実行された後に、Application.render_world() に渡された通常のカメラをオーバーライドします。

パラメータ

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

戻り値

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

これは、カリングに関連する問題をデバッグするのに非常に役立つ場合があります。

GUI

create_screen_gui ( self, x, y, params ) : stingray.Gui ピクセル座標 (x、y) で新しい画面スペース新しい画面スペース GUI を作成します。

パラメータ

self :	stingray.World	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
x :	number?	スクリーン空間の X 座標です。オプション。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。
y :	number?	スクリーン空間の Y 座標です。x が指定されている場合に限り必要です。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。
params :	any(string, number)*	GUI の設定です。有効な値は次のとおりです。 "scale": GUI で座標をスケールする量を指定します。このパラメータを指定すると、それぞれ幅と高さのスケーリング係数を指定する、さらに 2 つの追加の数値を指定する必要があります。スケールに 2 を指定すると、GUI のサイズが 100 ピクセルのオブジェクトは、画面に 200 ピクセルで描画されます。 "immediate": 指定した場合、GUI はイミディエート モードで実行します。これは、GUI に配置するすべての要素を 1 フレームにのみ描くことを意味します。すべてのフレームで表示するオブジェクトは、再度描く必要があります。イミディエイト モードでない場合、オブジェクトは明示的に除去されるまで残ります。 "dock_right": ウィンドウのサイズが変更されたときに、GUI が右側の余白にドッキングすることを指定します。 "dock_top": ウィンドウのサイズが変更されたときに、GUI が上部にドッキングすることを指定します。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。 * の注記は、指定されたタイプのゼロ以上のインスタンスがある場合があることを示します。

戻り値

stingray.Gui

新しく作成される GUI です。

(0,0) は、画面の左下コーナーです。

画面のサイズを確認するには、Application.back_buffer_size() を呼び出すことができます。

関連サンプル コード

Appkit: /debug_scrollbox.lua Appkit: /world_wrapper.lua

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

	stingray.Gui
	stingray.World.destroy_gui()

create_video_player ( self, resource, loop ) : stingray.VideoPlayer 指定された .IVF リソースを再生する新しい VideoPlayer を作成します。

パラメータ

self :	stingray.World	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
resource :	string	再生するビデオ リソースです。
loop :	boolean?	ビデオをループするかどうかを決定します。true の場合にはビデオは終わりに達すると先頭に戻って再生を続行し、そうでない場合には最終フレームでフリーズします。(オプション) 既定値は true です。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

戻り値

stingray.VideoPlayer

新しく作成されたビデオ プレイヤー。

ビデオ プレイヤーは、GUI ビデオ オブジェクトとともに使用できます。

この関数は、ビデオ プレーヤーがサポートされていない場合は、トリガ スクリプトエラーを返します。ビデオ プレーヤーがサポートされているかどうかをテストするには、[has_video_player()] を使用します。

注: このビデオ再生インタフェースは開発中です。これは一時的なものとみなすべきであり、現在は Windows プラットフォーム上でのみ動作します。

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

	stingray.VideoPlayer
	stingray.World.destroy_video_player()

create_world_gui ( self, pose, width, height, params ) : stingray.Gui 3D ワールドに存在する新しい GUI を作成します。

パラメータ

self :	stingray.World	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
pose :	stingray.Matrix4x4	3D 空間内の GUI の位置および方向です。
width :	number	GUI の描画プレーンの X 軸に沿って GUI ユニットとワールド空間ユニットとの間の比率を設定します。この値を大きくすると、GUI で描画されたシェイプはワールド空間ではそれより小さく表示され、値を小さくするとその逆になります。
height :	number	GUI の描画プレーンの Y 軸に沿って GUI ユニットとワールド空間ユニットとの間の比率を設定します。この値を大きくすると、GUI で描画されたシェイプはワールド空間ではそれより小さく表示され、値を小さくするとその逆になります。
params :	string*	GUI の設定です。有効な値は次のとおりです。 "shadow_caster": GUI 内のオブジェクトがシャドウをキャストすることを指定します。これを機能させるには、ベース シェーダなど、影付けをサポートするシェーダでオブジェクトを描く必要があります。 "immediate": 指定した場合、GUI はイミディエート モードで実行します。これは、GUI に配置するすべての要素を 1 フレームにのみ描くことを意味します。すべてのフレームで表示するオブジェクトは、再度描く必要があります。イミディエイト モードでない場合、オブジェクトは明示的に除去されるまで残ります。 * の注記は、指定されたタイプのゼロ以上のインスタンスがある場合があることを示します。

戻り値

stingray.Gui

新しく作成される GUI です。

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

	stingray.Gui
	stingray.World.destroy_gui()

destroy_gui ( self, gui ) create_screen_gui() または create_world_gui() で作成された GUI を破壊します。

パラメータ

self :	stingray.World	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
gui :	stingray.Gui	ワールドから除去する GUI です。

戻り値

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

destroy_video_player ( self, video_player ) create_video_player() によって作成されたビデオ プレイヤーを破壊します。

パラメータ

self :	stingray.World	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
video_player :	stingray.VideoPlayer	除去するビデオ プレイヤーです。

戻り値

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

ビデオ プレイヤーは大量のリソースを消費するため、使用を終えたらすぐに破壊する必要があります。

get_gui_by_id ( self, id ) : stingray.Gui ワールド内でこの ID を持つ GUI を返します。

パラメータ

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

戻り値

stingray.Gui

この ID を持つ GUI です。

レベル

destroy_level ( self, level ) 指定されたレベルと、ロード時にそのレベルでスポーンされた全ユニット(またはレベル エディタに配置されたユニット)を破壊します。

パラメータ

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

戻り値

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

Lua (または Level Flow Editor)でスポーンされたユニットは、レベルのロード解除時に破壊されないため、注意してクリーンアップしてください。すべてのレベルは、ワールドの終了時に破壊されるため、この関数を呼び出す必要はありません。ネストされたレベルは、この関数を使用して破壊することはできません。

levels ( self ) : stingray.Level[] ワールド内のすべてのレベルを返します。

パラメータ

self :

stingray.World

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

戻り値

stingray.Level[]

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

この関数から返されるテーブルにはネスト レベルが含まれていません。アクセスするには、Level.nested_levels() を使用してください。

load_level ( self, name, position, rotation, scale ) : stingray.Level 名前の付いたレベルをワールドに、指定した位置、回転、および軸ごとのスケールの各係数でロードします。

パラメータ

self :	stingray.World	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
name :	string	ロードするレベルの名前です。
position :	stingray.Vector3?	(オプション) レベルの位置です。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。
rotation :	stingray.Quaternion?	(オプション) レベルの回転です。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。
scale :	stingray.Vector3?	(オプション) レベルの軸ごとのスケール係数です。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

戻り値

stingray.Level

ワールドでのロード レベルです。

position、rotation、scale が指定されていない場合、レベルは既定の回転とスケールが指定されたワールド原点でロードされます。

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

stingray.World.load_level_with_object_sets()

load_level_with_object_sets ( self, name, obj_set_names, ignored_obj_set_names, position, rotation, scale ) : stingray.Level load_level() と同じですが、明示的に実行を指示しない限り、オブジェクト セットのメンバーであるどのオブジェクトもスポーンされません。

パラメータ

self :	stingray.World	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
name :	string	ロードするレベルの名前です。
obj_set_names :	string[]	スポーンするオブジェクト セットの名前が含まれているテーブルです。 []表記は、この型が配列(メンバーのキーは連番、各要素の値は示されている型のインスタンス)であることを示します。
ignored_obj_set_names :	string[]	無視されるオブジェクト セット名を含むテーブルです。 []表記は、この型が配列(メンバーのキーは連番、各要素の値は示されている型のインスタンス)であることを示します。
position :	stingray.Vector3?	(オプション) レベルの位置です。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。
rotation :	stingray.Quaternion?	(オプション) レベルの回転です。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。
scale :	stingray.Vector3?	(オプション) レベルの軸ごとのスケール係数です。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

戻り値

stingray.Level

ワールドでのロード レベルです。

ユニット、パーティクル エフェクト、サウンド、トリガー、プロトタイプ、ボリュームは、レベル エディタを使用してオブジェクト セットに追加できます。オブジェクトは、複数のオブジェクト セットに属することができます。以下のいずれかの条件が true の場合、オブジェクトがスポーンされます。

• いずれかの名前付きオブジェクト セットのメンバーである。
• どのオブジェクト セットのメンバーでもない。
• メンバーであるすべてのオブジェクト セットが、ignored_object_set_names パラメータの一覧に示されている。

パフォーマンス上の理由から、プロトタイプとボリュームは、ignored_object_set_names パラメータを考慮しません。これらは、名前の付いたオブジェクト セットのメンバーであり、どのオブジェクト セットにも属していない場合にのみ、スポーンされます。これによりエンジンは、プロトタイプとボリューム ジオメトリをさらに大きなバッチに合成できます。

LevelResource.object_set_names() 関数を呼び出して、レベル リソース内のすべてのオブジェクト セット名のリストを取得できます。

num_level ( self ) : integer ワールドのレベル数を返します。

パラメータ

self :

stingray.World

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

戻り値

integer

ワールドのレベルの総数です。

パーティクル

are_particles_playing ( self, effect_id ) : boolean 指定された ID を持つパーティクル エフェクトが、パーティクルを現在スポーンしているかどうかを示します。

パラメータ

self :	stingray.World	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
effect_id :	integer	テストするパーティクル エフェクトの整数 ID です。

戻り値

boolean

パーティクル エフェクトがパーティクルをスポーンしている場合は true、そうでない場合は false です。

create_particles ( self, effect_name, position, rotation, scale ) : integer 指定された位置で、指定された回転と軸ごとのスケール係数により、指定された名前を持つ新しいパーティクル エフェクトを作成します。

パラメータ

self :	stingray.World	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
effect_name :	string	作成するパーティクル エフェクトの名前です。
position :	stingray.Vector3	パーティクル エフェクトの位置です。
rotation :	stingray.Quaternion?	パーティクル エフェクトの方向です。オプション。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。
scale :	stingray.Vector3?	パーティクル エフェクトのスケーリング係数です。オプション。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

戻り値

integer

新しく作成されるパーティクル エフェクトの整数 ID です。

destroy_particles ( self, effect_id ) 指定された ID を持つパーティクル エフェクトを破壊します。

パラメータ

self :	stingray.World	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
effect_id :	integer	破壊されるパーティクル エフェクトの整数 ID です。

戻り値

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

find_particles_variable ( self, effect_name, variable_name ) : integer 指定された名前で、パーティクル エフェクト変数のインデックスを検索します。

パラメータ

self :	stingray.World	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
effect_name :	string	インデックスがチェックされるパーティクル エフェクトの名前です。
variable_name :	string	パーティクル エフェクト内で検索する変数の名前です。

戻り値

integer

パーティクル エフェクト内の指定された変数のインデックスです。

link_particles ( self, effect_id, unit, object, pose, orphaned_policy ) 指定された ID を持つパーティクル エフェクトを、指定されたユニットとリンクします。

パラメータ

self :	stingray.World	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
effect_id :	integer	リンクするパーティクル エフェクトの整数 ID です。
unit :	stingray.Unit	パーティクル エフェクトがリンクされるユニットです。
object :	integer	ユニットのシーン グラフ内のターゲット ノードのインデックスです。
pose :	stingray.Matrix4x4	オブジェクトと関連するパーティクル システムの新しいローカル座標です。
orphaned_policy :	string	ユニットが破壊された場合のパーティクル エフェクトの処理を決定します。以下の値があります。 "destroy": ユニットの破壊時にエフェクトは自動的に破壊されます。 "stop": エフェクトはパーティクルのスポーンを停止しますが、エフェクトそのものはその場に残ります。 "unlink": エフェクトは破壊されたユニットからリンク解除されますが、その現在の位置に残って、パーティクルのスポーンを続行します。

戻り値

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

エフェクトは、ユニットのシーン グラフ内の指定されたオブジェクトにリンクします。その新しい座標は、親オブジェクトのローカル座標系で表す必要がある、pose 引数によって決定されます。

move_particles ( self, effect_id, position, rotation, scale ) 指定された ID を持つパーティクル エフェクトのスポーン ポイントを、指定された軸ごとのスケール係数によって、特定の位置と回転に移動させます。

パラメータ

self :	stingray.World	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
effect_id :	integer	移動するパーティクル エフェクトの整数 ID です。
position :	stingray.Vector3	パーティクル エフェクトの新しい位置です。
rotation :	stingray.Quaternion?	パーティクル エフェクトの新しい方向です。オプション。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。
scale :	stingray.Vector3?	パーティクル エフェクトの新しいスケール係数です。オプション。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

戻り値

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

既存のパーティクルは影響を受けないことに注意してください。

set_particles_collision_filter ( self, collision_filter ) パーティクル衝突に使用する衝突フィルタを設定します。

パラメータ

self :	stingray.World	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
collision_filter :	string	設定する衝突フィルタです。

戻り値

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

effect_id が指定されている場合、衝突フィルタはそのエフェクトのみに対して設定されます。それ以外の場合は、すべてのパーティクルのエフェクトに使用される既定の collision_filter が設定されます。

set_particles_variable ( self, effect_id, variable_index, value ) パーティクル エフェクト内の指定された変数の値を設定します。

パラメータ

self :	stingray.World	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
effect_id :	integer	パーティクル エフェクトの ID です。
variable_index :	integer	値を設定する変数のインデックスです。
value :	stingray.Vector3	パーティクル エフェクト内の指定された変数に設定される値です。

戻り値

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

stop_spawning_particles ( self, effect_id ) 指定された ID を持つパーティクル エフェクトのスポーンを停止します。

パラメータ

self :	stingray.World	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
effect_id :	integer	停止するパーティクル エフェクトの整数 ID です。

戻り値

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

エフェクトは、すべてのパーティクルが再生されると破壊されます。

物理

physics_world ( self ) : stingray.PhysicsWorld 指定されたゲーム ワールドで保持されている物理ワールドを取得します。

パラメータ

self :

stingray.World

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

戻り値

stingray.PhysicsWorld

物理ワールドです。

関連サンプル コード

マウスを使ってユニットを選択する

vector_field ( self, name ) : stingray.VectorField ワールド内の指定された名前を持つベクトル フィールドを取得します。

パラメータ

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

戻り値

stingray.VectorField

取得されたベクトル フィールドです。

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

stingray.VectorField

シェーディング環境

create_shading_environment ( self, name ) : stingray.ShadingEnvironment 指定された名前で、新しい ShadingEnvironment オブジェクトを作成します。

パラメータ

self :	stingray.World	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
name :	string	作成するシェーディング環境の名前です。

戻り値

stingray.ShadingEnvironment

新しく作成されたシェーディング環境です。

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

stingray.World.destroy_shading_environment()

destroy_shading_environment ( self, environment ) create_shading_environment() への呼び出しによって以前に作成されたシェーディング環境を破壊します。

パラメータ

self :	stingray.World	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
environment :	stingray.ShadingEnvironment	破壊するシェーディング環境です。

戻り値

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

set_shading_environment ( self, environment, name ) ShadingEnvironment インスタンスを、指定された名前を持つシェーディング環境データを指すように変更します。

パラメータ

self :	stingray.World	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
environment :	stingray.ShadingEnvironment	変更するシェーディング環境です。
name :	string	環境が使用する新しいシェーディング環境データの名前です。

戻り値

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

ユニット

destroy_unit ( self, unit ) spawn_unit() への呼び出しによって以前に作成されたゲーム ユニットを破壊します。

パラメータ

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

戻り値

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

link_unit ( self, child, child_node_index, parent, parent_node_index ) link_unit ( self, child, parent, parent_node_index ) あるユニット内のノードを別のユニット内のノードにリンクし、親子のリレーションシップを作成します。

パラメータ

self :	stingray.World	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
child :	stingray.Unit	子となるユニットです。
child_node_index :	integer	親にリンクする子のノードのインデックスです。(オプション) 省略した場合、子のルート ノードが使用されます。
parent :	stingray.Unit	親になるユニットです。
parent_node_index :	integer?	子にリンクする親のノードのインデックスです。(オプション) 省略した場合、親のルート ノードが使用されます。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

戻り値

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

これを呼び出すと、子オブジェクトは親オブジェクトのスレーブになります。親ユニットの位置と回転に対して行った変更は、すべて子にも適用されます。

この関数を呼び出すと、子ノードのローカル トランスフォームが自動的にリセットされるため、子ノードは同じ回転と同じスケールの、親ノードと正確に同じ位置に配置されます。子をオフセットする場合は、そのローカル位置、回転、スケールを、link_unit() への呼び出し後に設定する必要があります。

子ユニット内のさまざまなノードを親ユニット内のさまざまなノードにリンクするために、この関数は複数回呼び出すことができます。これを使用して、たとえば、衣服を着るキャラクタの複数の骨格に合わせて衣服を着せ替えることができます。

異なる親ユニット内の複数のノードに 1 つの子ユニットをリンクすることはできません。ユニットは単一の適切に定義された親ユニットを持つ必要があります。ユニットが事前に親とリンクしている場合は、別の親ユニットにリンクする前に、unlink_unit() を呼び出してまずリンク解除する必要があります。

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

stingray.World.update_unit()

num_units ( self ) : integer 指定されたワールド内に作成済みのユニットの数を示します。

パラメータ

self :

stingray.World

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

戻り値

integer

ワールド内のユニット数です。

これには、エディタでレベルに配置され、レベルのロード時にスポーンされたユニットと、動的に即座にスポーンされたユニットが含まれています。

spawn_unit ( self, unit_name, transform ) : stingray.Unit 指定された位置でゲーム ユニットの新しいインスタンスをスポーンします。

パラメータ

self :	stingray.World	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
unit_name :	string	スポーンするユニットの名前です。
transform :	stingray.Matrix4x4?	オプション。新しいユニットの開始位置と方向です。これを省略した場合、ユニットは既定の回転を使用して、既定の位置(3D 座標系の原点)でスポーンされます。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

戻り値

stingray.Unit

新しく作成されるユニット オブジェクトです。

spawn_unit ( self, unit_name, position, orientation ) : stingray.Unit 指定された位置でゲーム ユニットの新しいインスタンスをスポーンします。

パラメータ

self :	stingray.World	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
unit_name :	string	スポーンするユニットの名前です。
position :	stingray.Vector3?	オプション。新しいユニットの開始位置です。これを省略した場合、ユニットは既定の位置 (3D 座標系の原点) でスポーンされます。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。
orientation :	stingray.Quaternion?	新しいユニットの開始方向です。これを省略した場合、ユニットは既定の回転でスポーンされます。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

戻り値

stingray.Unit

新しく作成されるユニット オブジェクトです。

関連サンプル コード

手続きに従ってメッシュを作成する

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

stingray.Unit.name_hash() stingray.World.destroy_unit()

units ( self ) : stingray.Unit[] 指定されたワールド内の全ユニットを取得します。

パラメータ

self :

stingray.World

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

戻り値

stingray.Unit[]

ワールド内に存在するすべての Unit オブジェクトが含まれるテーブルです。 []表記は、この型が配列(メンバーのキーは連番、各要素の値は示されている型のインスタンス)であることを示します。

これには、エディタでレベルに配置され、レベルのロード時にスポーンされたユニットと、動的に即座にスポーンされたユニットが含まれています。

units_by_resource ( self, resource_name ) : stingray.Unit[] ワールド内の指定されたリソースの全ユニット インスタンスを取得します。

パラメータ

self :	stingray.World	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
resource_name :	string	検索するユニットのリソース名です。

戻り値

stingray.Unit[]

ワールド内に存在し、指定されたリソース タイプに一致するすべての Unit オブジェクトが含まれるテーブルです。 []表記は、この型が配列(メンバーのキーは連番、各要素の値は示されている型のインスタンス)であることを示します。

関連サンプル コード

Oculus VR テンプレート: /project.lua Steam VR テンプレート: /project.lua

unit_by_id ( self, id ) : stingray.Unit? ID id (レベル エディタで定義) を持つユニットを検索し、それを返します。

パラメータ

self :	stingray.World	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
id :	string	検索するユニットの ID です。

戻り値

stingray.Unit?

指定された ID を持つユニット、またはその ID を持つユニットが存在しない場合は nil を返します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

そのようなユニットが存在しない場合は、nil が返されます。

unit_by_name ( self, name ) : stingray.Unit? 名前 name (レベル エディタで定義) を持つユニットを検索し、それを返します。

パラメータ

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

戻り値

stingray.Unit?

指定された名前を持つユニット、またはその名前を持つユニットが存在しない場合は nil を返します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

そのようなユニットが存在しない場合は、nil が返されます。同じ名前を持つ複数のユニットがある場合、そのうちの 1 つがランダムに返されます。

unlink_unit ( self, child ) 親があれば、指定されたユニットをその親からリンク解除します。

パラメータ

self :	stingray.World	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
child :	stingray.Unit	親からリンク解除するユニットです。

戻り値

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

子のリンクされたすべてのノードはリンク解除され、そのローカルの位置は現在のワールドの位置と一致するようにリセットされます。したがって、リンク解除されているオブジェクトは、リンク解除後に移動させない限り、現在の場所に残ります。

ルート ノード以外のオブジェクトにリンクした場合、ユニットのリンクを解除しても、オブジェクトはユニットのシーン グラフ内の以前の親に再びリンクすることはありません。これを行うには、Unit.scene_graph_link() を明示的に呼び出す必要があります。

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

stingray.World.link_unit()

update_unit ( self, unit ) メインのワールドの更新が実行されたら、ユニットのシーン グラフの更新を強制的に実行します。

パラメータ

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

戻り値

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

これを使用すると、link_unit() への呼び出しによりユニットをリンクするだけでは表現できない、複雑な方法で他のユニットの位置に依存しているユニットを実装できます。

このアプローチは慎重に使用することをお勧めします。

update_unit() は、リンクした子ユニットを自動的に更新することはありません。子ユニットの位置が親の新しい位置を反映するように更新する場合は、update_unit() をそれぞれの子ユニットで手動により呼び出す必要があります。

関連サンプル コード

車両テンプレート: /vehicle_follow_cam.lua 車両テンプレート: /vehicle_unit_controller.lua