Class Scene

Hierarchy

Asset
- Scene

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Scene(): Scene

Overrides UniqueObject.constructor
- Defined in src/assets/Scene.ts:86
Returns Scene

Properties

deleted

deleted: AsyncEvent<string> = new AsyncEvent<string>()

id

id: string

isPersistent

isPersistent: boolean = false

name

name: string

root

root: Entity

Optional templatePath

templatePath: undefined | string

Accessors

environment

get environment(): undefined | Environment
set environment(environment: Environment | undefined): void

- Defined in src/assets/Scene.ts:78
Returns undefined | Environment
- Defined in src/assets/Scene.ts:70
Parameters
- environment: Environment | undefined
Returns void

fog

get fog(): undefined | Fog
set fog(fog: Fog | undefined): void

- Defined in src/assets/Scene.ts:66
Returns undefined | Fog
- Defined in src/assets/Scene.ts:58
Parameters
- fog: Fog | undefined
Returns void

version

get version(): number

- Defined in src/assets/Scene.ts:47
Returns number

Methods

copy

copy(): Scene

Overrides UniqueObject.copy
- Defined in src/assets/Scene.ts:264
Returns Scene

deserialize

deserialize(_json: SerializedObjectType): Promise<Scene>

Overrides SerializableObject.deserialize
- Defined in src/assets/Scene.ts:138
Parameters
- _json: SerializedObjectType
Returns Promise<Scene>

destroy

destroy(): void

Overrides Asset.destroy
- Defined in src/assets/Scene.ts:188
Returns void

isA

isA<T>(type: object): boolean

Inherited from SerializableObject.isA
- Defined in src/core/SerializableObject.ts:23
Type parameters
- T
Parameters
- type: object
  - constructor: function
    - new __type(...args: any[]): T
    - Defined in src/core/SerializableObject.ts:23
      Parameters
      - Rest ...args: any[]
      Returns T
Returns boolean

isLoaded

isLoaded(): boolean

Overrides Asset.isLoaded
- Defined in src/assets/Scene.ts:96
Returns boolean

save

save(folderPath?: undefined | string): void

Inherited from Asset.save
- Defined in src/assets/Asset.ts:33
Parameters
- Optional folderPath: undefined | string
Returns void

serialize

serialize(): SerializedScene

Overrides SerializableObject.serialize
- Defined in src/assets/Scene.ts:109
Returns SerializedScene

setEntityFromPrefab

setEntityFromPrefab(entity: Entity, prefabId: string): Promise<Prefab>

- Defined in src/assets/Scene.ts:193
Parameters
- entity: Entity
- prefabId: string
Returns Promise<Prefab>

setEntityFromPrefabInstance

setEntityFromPrefabInstance(entity: Entity, prefab: Prefab): void

- Defined in src/assets/Scene.ts:209
Parameters
- entity: Entity
- prefab: Prefab
Returns void

setProperty

setProperty(name: string, value: any): void

Inherited from SerializableObject.setProperty
- Defined in src/core/SerializableObject.ts:37
Parameters
- name: string
- value: any
Returns void

setState

setState<T>(props: ObjectProps<T>): void

Inherited from SerializableObject.setState
- Defined in src/core/SerializableObject.ts:54
Type parameters
- T
Parameters
- props: ObjectProps<T>
Returns void

upgrade

upgrade(json: SerializedObject, previousVersion: number): SerializedObject

Inherited from SerializableObject.upgrade
- Defined in src/core/SerializableObject.ts:50
Parameters
- json: SerializedObject
- previousVersion: number
Returns SerializedObject