Skip to content

インターフェイス ISceneManagementEx

Namespace: GameCanvas

csharp
public interface ISceneManagementEx : ISceneManagement

継承元

メソッド

AddActor(GcActor)

継承元: ISceneManagement

csharp
void AddActor(in GcActor actor)

指定したアクターをシーンに登録します

パラメーター

  • actor — 登録するアクター

ChangeScene<T>(object?)

csharp
void ChangeScene<T>(object? state = null) where T : GcScene

シーンを切り替えます

備考

  • これまで有効だったシーンは、現在のフレームの最後に終了処理が実行されます
  • これから有効になるシーンは、次のフレームの最初に開始処理が実行されます

型パラメーター

  • T — 開始するシーンの型

パラメーター

  • state — シーンの開始処理 (IScene.EnterScene) に引数として渡す任意の値

CreateActor<T>()

継承元: ISceneManagement

csharp
T CreateActor<T>() where T : GcActor, new()

指定したアクターを生成し、シーンに登録します

型パラメーター

  • T — 生成・登録するアクターの型

戻り値

登録したアクター

GetActor()

csharp
GcActor? GetActor()

シーンに登録されているアクターのうち、1つだけ取得します

戻り値

取得できたアクター

GetActor<T>()

csharp
T? GetActor<T>() where T : GcActor

シーンに登録されているアクターのうち、指定した型のものを1つだけ取得します

型パラメーター

  • T — 取得するアクターの型

戻り値

取得できたアクター

GetActorCount()

継承元: ISceneManagement

csharp
int GetActorCount()

シーンに登録されているアクターの総数を取得します

戻り値

アクターの数

GetActorCount<T>()

継承元: ISceneManagement

csharp
int GetActorCount<T>() where T : GcActor

シーンに登録されているアクターのうち、指定した型のものが幾つあるか取得します

型パラメーター

  • T — 取得するアクターの型

戻り値

アクターの数

GetActorList<T>()

csharp
ReadOnlyActorList<T> GetActorList<T>() where T : GcActor

シーンに登録されているアクターのうち、指定した型のものを取得します

型パラメーター

  • T — 取得するアクターの型

戻り値

取得したアクターのリスト

RegisterScene(GcScene)

csharp
void RegisterScene(in GcScene scene)

新たなシーンを登録します

備考

登録したシーンは ChangeScene を呼び出すことで有効になります

パラメーター

  • scene — 登録するシーン

RegisterScene<T>()

csharp
void RegisterScene<T>() where T : GcScene, new()

新たなシーンを登録します

備考

登録したシーンは ChangeScene を呼び出すことで有効になります

型パラメーター

  • T — 登録するシーンの型

RemoveActorAll()

継承元: ISceneManagement

csharp
void RemoveActorAll()

シーンに登録されているすべてのアクターを登録解除します

TryGetActor(int, GcActor?)

継承元: ISceneManagement

csharp
bool TryGetActor(in int i, [NotNullWhen(true)] out GcActor? actor)

シーンに登録されているアクターを 1つだけ取得します

型パラメーター

  • T — 取得するアクターの型

パラメーター

  • i — 取得するアクターのインデックス(0以上GetActorCount未満)
  • actor — 取得できたアクター

戻り値

取得できたかどうか

TryGetActor<T>(int, T?)

継承元: ISceneManagement

csharp
bool TryGetActor<T>(in int i, [NotNullWhen(true)] out T? actor) where T : GcActor

シーンに登録されているアクターを 1つだけ取得します

型パラメーター

  • T — 取得するアクターの型

パラメーター

  • i — 取得するアクターのインデックス(0以上GetActorCount{T}未満)
  • actor — 取得できたアクター

戻り値

取得できたかどうか

TryGetActorAll<T>(System.ReadOnlySpan<T>)

継承元: ISceneManagement

csharp
bool TryGetActorAll<T>(out System.ReadOnlySpan<T> actors) where T : GcActor

シーンに登録されているアクターのうち、指定した型のものを取得します

型パラメーター

  • T — 取得するアクターの型

パラメーター

  • actors — 取得したアクターの一覧

戻り値

1つ以上 取得できたかどうか

TryRemoveActor(GcActor)

継承元: ISceneManagement

csharp
bool TryRemoveActor(in GcActor actor)

指定したアクターをシーンから登録解除します

パラメーター

  • actor — 登録解除するアクター

戻り値

登録解除できたかどうか

UnregisterScene(GcScene)

csharp
void UnregisterScene(in GcScene scene)

指定したシーンをシーン一覧から削除します

備考

もし指定したシーンが現在有効なシーンだった場合、フレームの最後にシーンの離脱処理が走ります

パラメーター

  • scene — 削除するシーン

UnregisterScene<T>()

csharp
void UnregisterScene<T>() where T : GcScene

指定したシーンをシーン一覧から削除します

備考

もし指定したシーンが現在有効なシーンだった場合、フレームの最後にシーンの離脱処理が走ります

型パラメーター

  • T — 削除するシーンの型

Released under the MIT License.