Interface SceneParameterObject

Scene のコンストラクタに渡すことができるパラメータ。 説明のない各メンバの詳細は Scene の同名メンバの説明を参照すること。

interface SceneParameterObject {
    assetIds?: (string | DynamicAssetConfiguration)[];
    assetPaths?: string[];
    game: Game;
    local?: boolean | LocalTickModeString;
    name?: string;
    seethrough?: boolean;
    tickGenerationMode?: TickGenerationModeString;
}

Hierarchy (View Summary)

Properties

assetIds?: (string | DynamicAssetConfiguration)[]

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

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

undefined
assetPaths?: string[]

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

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

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

undefined
game: Game

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

local?: boolean | LocalTickModeString

このシーンのローカルティック消化ポリシー。

  • "full-local" が与えられた場合、このシーンはローカルシーンと呼ばれる。 ローカルシーンでは、他プレイヤーと独立な時間進行処理(ローカルティックの消化)が行われる。
  • "non-local" が与えられた場合、このシーンは非ローカルシーンと呼ばれる。 非ローカルシーンでは、他プレイヤーと共通の時間進行処理((非ローカル)ティックの消化)が行われる(onUpdateがfireされる)。 ローカルティックを消化することはない。
  • "interpolate-local" が与えられた場合、このシーンはローカルティック補間シーンと呼ばれる。 ローカルティック補間シーンでは、非ローカルシーン同様にティックを消化するが、 消化すべき非ローカルティックがない場合にローカルティックが補間され消化される。

ローカルシーンに属するエンティティは、すべてローカルである(強制的にローカルエンティティとして生成される)。 ローカルシーンは特にアセットロード中のような、他プレイヤーと同期すべきでないシーンのために存在する機能である。

LocalTickModeString の代わりに boolean を与えることもできる。 偽は "non-local" 、 真は "full-local" と解釈される。

"non-local"
name?: string

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

undefined
seethrough?: boolean

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

false
tickGenerationMode?: TickGenerationModeString

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

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