Interface SceneParameters<Command, ActionData>

interface SceneParameters<Command, ActionData> {
    assetIds?: (string | DynamicAssetConfiguration)[];
    assetPaths?: string[];
    controller: BaseController<Command, ActionData>;
    game: Game;
    local?: "non-local" | "interpolate-local";
    name?: string;
    seethrough?: boolean;
    tickGenerationMode?: TickGenerationModeString;
}

Type Parameters

  • Command
  • ActionData

Hierarchy

  • SceneParameterObject
    • SceneParameters

Properties

assetIds?: (string | DynamicAssetConfiguration)[]

このシーンで用いるアセットIDの配列。

アセットIDとは、 game.jsonのassetsオブジェクトの各プロパティのキー文字列である。 アセットIDでなくパスで指定したい場合は assetPaths を利用できる。両方指定してもよい。

Default

undefined
assetPaths?: string[]

このシーンで用いるアセットのファイルパスの配列。

各要素は / から始まる絶対パスでなければならない。 ここでルートディレクトリ / はgame.json のあるディレクトリを指す。 ただしオーディオアセットに限り、拡張子を含まないパスであること。 (e.g. /image/character01.png, /audio/bgm01)

パスでなくアセットIDで指定したい場合は assetIds を利用できる。両方指定してもよい。 game.jsonのassetsに定義がないアセット(ダイナミックアセット)は指定できない。

Default

undefined
game: Game

このシーンの属するゲーム。

local?: "non-local" | "interpolate-local"
name?: string

このシーンの識別用の名前。

Default

undefined
seethrough?: boolean

シーンスタック上のこのシーンが描画される時、それに先んじてこのシーンの直下のシーンを描画するかどうか。 このシーン自体は seethrough の値に関わらず常に描画されることに注意。 ただし seethrough が true の時でもこのシーン以外の onUpdate は実行されない。そのため下のシーンの描画内容も更新されない。この挙動は実験的なものであり、将来的に変更されうる。

Default

false
tickGenerationMode?: TickGenerationModeString

時間経過の契機(ティック)をどのように生成するか。

省略された場合、 "by-clock"Manual を指定した場合、 Game#raiseTick() を呼び出さない限りティックが生成されない(時間経過しない)。 ただしローカルティック(ローカルシーンの間などの「各プレイヤー間で独立な時間経過処理」)はこの値の影響を受けない。 またこのシーンへの遷移直後、一度だけこの値に関わらずティックが生成される。

Generated using TypeDoc