Class EngineSettings

Hierarchy

UniqueObject
- EngineSettings

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new EngineSettings(): EngineSettings

Inherited from UniqueObject.constructor
- Defined in src/core/UniqueObject.ts:16
Returns EngineSettings

Properties

canvasAlpha

canvasAlpha: boolean = true

id

id: string

name

name: string

Optional startupScene

startupScene: undefined | string = undefined

Optional templatePath

templatePath: undefined | string

Optional useCustomDefaultAssets

useCustomDefaultAssets: undefined | false | true = undefined

Accessors

version

get version(): number

- Defined in src/core/EngineSettings.ts:19
Returns number

Static instance

get instance(): EngineSettings

- Defined in src/core/EngineSettings.ts:46
Returns EngineSettings

Methods

copy

copy(): UniqueObject

Inherited from UniqueObject.copy

Overrides SerializableObject.copy
- Defined in src/core/UniqueObject.ts:24
Returns UniqueObject

deserialize

deserialize(json: SerializedObjectType): Promise<SerializableObject> | SerializableObject

Inherited from SerializableObject.deserialize
- Defined in src/core/SerializableObject.ts:45
Parameters
- json: SerializedObjectType
Returns Promise<SerializableObject> | SerializableObject

destroy

destroy(): void

Inherited from SerializableObject.destroy
- Defined in src/core/SerializableObject.ts:33
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

save

save(): void

- Defined in src/core/EngineSettings.ts:65
Returns void

serialize

serialize(): SerializedObjectType

Inherited from SerializableObject.serialize
- Defined in src/core/SerializableObject.ts:41
Returns SerializedObjectType

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

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

Static load

load(): Promise<unknown>

- Defined in src/core/EngineSettings.ts:25
Returns Promise<unknown>