コンテンツにスキップ

SceneLoader

シーンの読み込み

Extends

Constructors

new SceneLoader()

new SceneLoader(scene, resource, options): SceneLoader

url で指定したシーンデータの読み込みを開始し、scene にエンティティを構築する。 読み込みが終了したとき options.onLoad を呼び出す。

Parameters

Parameter Type Description
scene Scene 読み込み先のシーン
resource string | Resource シーンリソース
options Option オプション集合

Returns

SceneLoader

Overrides

Loader.constructor

Properties

_onEntity

protected _onEntity: EntityCallback

Inherited from

Loader._onEntity


_resource

protected _resource: Resource

Inherited from

Loader._resource


_scene

protected _scene: Scene

Inherited from

Loader._scene

Accessors

resource

get resource(): Resource

シーンリソース

Returns

Resource


scene

get scene(): Scene

読み込み先のシーン

Returns

Scene


status

get status(): Status

ローダー読み込みの状態

Returns

Status

Methods

_cancel()

protected _cancel(): void

キャンセル時に行う処理。継承クラスによって実装される。

Returns

void

Inherited from

Loader._cancel


_check_cancel()

protected _check_cancel(): void

取り消し状態のとき例外を投げる

Returns

void

Inherited from

Loader._check_cancel


_load()

protected _load(): Promise<void>

読み込み

Returns

Promise<void>

Overrides

Loader._load


cancel()

cancel(): void

読み込みの取り消し

終了コールバック関数は isSuccess == false で呼び出される。

Returns

void

Inherited from

Loader.cancel


getReference()

getReference(id): null | ModelContainer | Entity<EventMap>

オブジェクト参照を取得

注意: シーンの読み込みが終了したことを確認してからこのメソッドを呼び出すこと。

Parameters

Parameter Type Description
id string 識別子

Returns

null | ModelContainer | Entity<EventMap>

オブジェクト


load()

load(): Promise<void>

読み込みを実行します。

Returns

Promise<void>

Inherited from

Loader.load