EntityManager - stingray.EntityManager ネームスペース リファレンス - Stingray Lua API リファレンス

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

説明

エンティティの作成と破壊のためのマネージャです。

EntityManager は、ゲーム内のすべてのライブ エンティティを追跡し、エンティティの作成および破壊に使用できます。

EntityManager はシングルトン(1 つのみの EntityManager が存在する)であるため、これを関数に渡す必要はありません。すべての関数は、EntityManager シングルトンに対して動作します。

関数

パラメータ

world :

stingray.World

アクター コンポーネントを返す対象のワールドです。

戻り値

stingray.ActorComponent

ワールドのアクター コンポーネントです。

アクター コンポーネントを使用して、エンティティに物理アクターを追加できます。

パラメータ

entity :

stingray.Entity

確認するエンティティです。

戻り値

boolean

エンティティが存在している場合は true を返します。

パラメータ

world :

stingray.World

コンポーネントを返す対象のワールドです。

戻り値

stingray.AnimationBlenderComponent

ワールドのアニメーション ブレンダ コンポーネントです。

アニメーション ブレンダ コンポーネントは、エンティティのアニメーションのブレンドを処理します。

パラメータ

world :

stingray.World

コンポーネントを返す対象のワールドです。

戻り値

stingray.AnimationStateMachineComponent

ワールドのアニメーション ステート マシン コンポーネントです。

アニメーション ステート マシン コンポーネントは、エンティティのアニメーション ステート マシンを処理します。

パラメータ

world :

stingray.World?

そのエンティティを所有するワールドです。

? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。
戻り値

stingray.Entity

新しく作成されたエンティティです。

World が指定されている場合、エンティティはそのワールドによって所有されます。 ワールドが破壊されると、エンティティは自動的に破壊されます。

ワールドが指定されていない場合、エンティティは destroy を呼び出すことによって明示的に破壊されるまで存続します。

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

stingray.DataComponent

グローバル データ コンポーネントです。

このデータ コンポーネントは、エンティティの動的データのブロブを格納できます。

パラメータ

entity :

stingray.Entity

名前を確認する対象のエンティティです。

戻り値

string

エンティティのデバッグ名、または名前が設定されていない場合は "" になります。

名前を設定するには、set_debug_name を使用します。

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

stingray.DebugNameComponent

グローバルなデバッグ名コンポーネントです。

デバッグ名コンポーネントは、各エンティティのデバッグ名を格納します。

パラメータ

entity :

stingray.Entity

破壊するエンティティです。

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

エンティティを破壊すると、そのエンティティによって所有されているすべてのコンポーネントも破壊されます。

パラメータ

world :

stingray.World

フロー コンポーネントを返す対象のワールドです。

戻り値

stingray.FlowComponent

ワールドのフロー コンポーネントです。

フロー コンポーネントを使用して、エンティティに対するフローの割り当て、トリガ、操作を実行できます。

パラメータ

world :

stingray.World

メッシュ コンポーネントを返す対象のワールドです。

戻り値

stingray.MeshComponent

ワールドのメッシュ コンポーネントです。

メッシュ コンポーネントを使用すると、エンティティにグラフィックス メッシュを追加できます。

パラメータ

world :

stingray.World

コンポーネントを返す対象のワールドです。

戻り値

stingray.RenderDataComponent

ワールドのタグ コンポーネントです。

このレンダー データ コンポーネントは、エンティティをレンダリングするための動的データのブロブを格納できます。

パラメータ

world :

stingray.World

アクター コンポーネントを返す対象のワールドです。

戻り値

stingray.SceneGraphComponent

ワールドのシーン グラフ コンポーネントです。

シーン グラフ コンポーネントは、エンティティのシーン グラフを処理します。

パラメータ

world :

stingray.World

コンポーネントを返す対象のワールドです。

戻り値

stingray.ScriptComponent

ワールドのスクリプト コンポーネントです。

このスクリプト コンポーネントは、エンティティをスクリプトにリンクします。

パラメータ

entity :

stingray.Entity

名前を変更する対象のエンティティです。

name :

string

エンティティに設定する名前です。

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

エンティティ名が 31 文字を超えることはできません。名前を取得するには debug_name を使用します。

パラメータ

world :

stingray.World

エンティティがスポーンされるワールドです。

entity_resource :

string

エンティティのリソースの名前です(例: "entities/trees/pine")。

position :

stingray.Vector3

エンティティがスポーンされる位置です。

orientation :

stingray.Quaternion?

スポーンされたエンティティの方向です。指定しない場合は、識別方向が使用されます。

? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。
戻り値

stingray.Entity

新しくスポーンされたエンティティです。

パラメータ

world :

stingray.World

エンティティがスポーンされるワールドです。

entity_resource :

string

エンティティのリソースの名前です(例: "entities/trees/pine")。

pose :

stingray.Matrix4x4

スポーンされたエンティティのポーズです。

戻り値

stingray.Entity

新しくスポーンされたエンティティです。

パラメータ

world :

stingray.World

コンポーネントを返す対象のワールドです。

戻り値

stingray.TagComponent

ワールドのタグ コンポーネントです。

タグ コンポーネントは、エンティティのタグを処理します。

パラメータ

world :

stingray.World

トランスフォーム コンポーネントを返す対象のワールドです。

戻り値

stingray.TransformComponent

ワールドのトランスフォーム コンポーネントです。

変換コンポーネントを使用すると、エンティティに変換を追加できます。

パラメータ

world :

stingray.World

コンポーネントを返す対象のワールドです。

戻り値

stingray.UnitComponent

ワールドのユニット コンポーネントです。

このユニット コンポーネントは、ユニットをエンティティにリンクします。