Class Screen

Hierarchy

Component
- Screen

Index

Accessors

Methods

Accessors

active

get active(): boolean
set active(active: boolean): void

Inherited from Component.active
- Defined in src/core/Component.ts:12
Returns boolean
Inherited from Component.active
- Defined in src/core/Component.ts:13
Parameters
- active: boolean
Returns void

cache

get cache(): CacheEntry[]

- Defined in src/ui/Screen.ts:69
Returns CacheEntry[]

cacheSize

get cacheSize(): number

- Defined in src/ui/Screen.ts:70
Returns number

entity

get entity(): Entity

Inherited from Component.entity
- Defined in src/core/Component.ts:10
Returns Entity

id

get id(): string

Inherited from Component.id
- Defined in src/core/Component.ts:11
Returns string

offset

get offset(): Vector2

- Defined in src/ui/Screen.ts:71
Returns Vector2

parent

get parent(): undefined | Entity

Inherited from Component.parent
- Defined in src/core/Component.ts:9
Returns undefined | Entity

resolution

get resolution(): undefined | Resolution

- Defined in src/ui/Screen.ts:78
Returns undefined | Resolution

scale

get scale(): number

- Defined in src/ui/Screen.ts:75
Returns number

screenTransform

get screenTransform(): Matrix44

- Defined in src/ui/Screen.ts:77
Returns Matrix44

translationX

get translationX(): number

- Defined in src/ui/Screen.ts:73
Returns number

translationY

get translationY(): number

- Defined in src/ui/Screen.ts:74
Returns number

version

get version(): number

- Defined in src/ui/Screen.ts:67
Returns number

Methods

copy

copy(): SerializableObject

Inherited from SerializableObject.copy
- Defined in src/core/SerializableObject.ts:27
Returns SerializableObject

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

Overrides SerializableObject.destroy
- Defined in src/ui/Screen.ts:123
Returns void

getResolution

getResolution(fallback: Vector2): Vector2

- Defined in src/ui/Screen.ts:130
Parameters
- fallback: Vector2
Returns Vector2

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

Inherited from Component.isLoaded
- Defined in src/core/Component.ts:36
Returns boolean

onReplace

onReplace(previous: Component): void

Inherited from Component.onReplace
- Defined in src/core/Component.ts:46
Parameters
- previous: Component
Returns void

render

render(uiMaterial: Material): void

- Defined in src/ui/Screen.ts:208
Parameters
- uiMaterial: Material
Returns void

reset

reset(): void

Inherited from Component.reset
- Defined in src/core/Component.ts:40
Returns void

serialize

serialize(): SerializedObjectType

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

setEntity

setEntity(owner: Entity): void

Overrides Component.setEntity
- Defined in src/ui/Screen.ts:111
Parameters
- owner: Entity
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

update

update(): void

- Defined in src/ui/Screen.ts:191
Returns void

updateTransforms

updateTransforms(): void

- Defined in src/ui/Screen.ts:134
Returns void

upgrade

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

Overrides SerializableObject.upgrade
- Defined in src/ui/Screen.ts:315
Parameters
- json: SerializedObject
- previousVersion: number
Returns SerializedObject