Class UiScreen

Hierarchy

SizedComponent
- UiScreen

Index

Constructors

Properties

canvas gameObject layer onActiveChanges onAnchorUpdate onFlipUpdate onPositionUpdate onRotationUpdate onSizeUpdate onSomeUpdate renderer scale smoothing

Accessors

anchor flip isActive positionType realPosition realSize rotation size sizeType transform

Methods

awake destroy error lateUpdate log onDestroy onResize register render start uiRender update updatePosition updateSize warn

Constructors

constructor

new UiScreen(renderer: Renderer, scale: number, layer: number, smoothing?: boolean): UiScreen
Parameters
- renderer: Renderer
- scale: number
- layer: number
- smoothing: boolean = true
Returns UiScreen
Overrides SizedComponent.constructor
- Defined in components/UiScreen.ts:11

Properties

canvas

canvas: VirtualCanvas

gameObject

gameObject: GameObject

layer

layer: number

onActiveChanges

onActiveChanges: Event<Component>

onAnchorUpdate

onAnchorUpdate: Event<SizedComponent>

onFlipUpdate

onFlipUpdate: Event<SizedComponent>

onPositionUpdate

onPositionUpdate: Event<SizedComponent>

onRotationUpdate

onRotationUpdate: Event<SizedComponent>

onSizeUpdate

onSizeUpdate: Event<SizedComponent>

onSomeUpdate

onSomeUpdate: Event<SizedComponent>

renderer

renderer: Renderer

scale

scale: number

smoothing

smoothing: boolean

Accessors

anchor

get anchor(): Vector2
Returns Vector2
Inherited from SizedComponent.anchor
- Defined in classes/Components/SizedComponent.ts:57
set anchor(value: Vector2): void
Parameters
- value: Vector2
Returns void
Inherited from SizedComponent.anchor
- Defined in classes/Components/SizedComponent.ts:60

flip

get flip(): [boolean, boolean]
Returns [boolean, boolean]
Inherited from SizedComponent.flip
- Defined in classes/Components/SizedComponent.ts:94
set flip(value: [boolean, boolean]): void
Parameters
- value: [boolean, boolean]
Returns void
Inherited from SizedComponent.flip
- Defined in classes/Components/SizedComponent.ts:97

isActive

get isActive(): boolean
Returns boolean
Inherited from SizedComponent.isActive
- Defined in classes/Components/Component.ts:16
set isActive(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from SizedComponent.isActive
- Defined in classes/Components/Component.ts:19

positionType

get positionType(): PositionType
Returns PositionType
Inherited from SizedComponent.positionType
- Defined in classes/Components/SizedComponent.ts:85
set positionType(value: PositionType): void
Parameters
- value: PositionType
Returns void
Inherited from SizedComponent.positionType
- Defined in classes/Components/SizedComponent.ts:88

realPosition

get realPosition(): Vector2
Returns Vector2
Inherited from SizedComponent.realPosition
- Defined in classes/Components/SizedComponent.ts:71

realSize

get realSize(): Vector2
Returns Vector2
Inherited from SizedComponent.realSize
- Defined in classes/Components/SizedComponent.ts:66

rotation

get rotation(): number
Returns number
Inherited from SizedComponent.rotation
- Defined in classes/Components/SizedComponent.ts:39
set rotation(value: number): void
Parameters
- value: number
Returns void
Inherited from SizedComponent.rotation
- Defined in classes/Components/SizedComponent.ts:42

size

get size(): Vector2
Returns Vector2
Inherited from SizedComponent.size
- Defined in classes/Components/SizedComponent.ts:48
set size(value: Vector2): void
Parameters
- value: Vector2
Returns void
Inherited from SizedComponent.size
- Defined in classes/Components/SizedComponent.ts:51

sizeType

get sizeType(): SizeType
Returns SizeType
Inherited from SizedComponent.sizeType
- Defined in classes/Components/SizedComponent.ts:76
set sizeType(value: SizeType): void
Parameters
- value: SizeType
Returns void
Inherited from SizedComponent.sizeType
- Defined in classes/Components/SizedComponent.ts:79

transform

get transform(): Transform
Returns Transform
Inherited from SizedComponent.transform
- Defined in classes/Components/Component.ts:11

Methods

awake

awake(): Promise<void>
Called on scene load

Returns Promise<void>
Inherited from SizedComponent.awake
- Defined in classes/Components/Component.ts:49

destroy

destroy(): void
Destroy component

Returns void
Inherited from SizedComponent.destroy
- Defined in classes/Components/Component.ts:40

error

error(...obj: any): void
Utility function for logging. Logs using console.error and appends info about gameObject and component
Parameters
- Rest ...obj: any
  
  thing to log
Returns void
Inherited from SizedComponent.error
- Defined in classes/Components/Component.ts:102

lateUpdate

lateUpdate(): Promise<void>
Called every frame after render

Returns Promise<void>
Inherited from SizedComponent.lateUpdate
- Defined in classes/Components/Component.ts:64

log

log(...obj: any): void
Utility function for logging. Logs using console.log and appends info about gameObject and component
Parameters
- Rest ...obj: any
  
  thing to log
Returns void
Inherited from SizedComponent.log
- Defined in classes/Components/Component.ts:89

onDestroy

onDestroy(): Promise<void>
Called when component is destroyed

Returns Promise<void>
Overrides SizedComponent.onDestroy
- Defined in components/UiScreen.ts:45

onResize

onResize(args: onResizeArgs): void
Parameters
- args: onResizeArgs
Returns void
- Defined in components/UiScreen.ts:30

register

register(obj: GameObject): void
Called when component added to GameObject
Parameters
- obj: GameObject
  
  GameObject
Returns void
Inherited from SizedComponent.register
- Defined in classes/Components/Component.ts:33

render

render(renderer: Renderer, _camera: Camera): void
Used for rendering
Parameters
- renderer: Renderer
- _camera: Camera
Returns void
Overrides SizedComponent.render
- Defined in components/UiScreen.ts:37

start

start(): Promise<void>
Called when object is created

Returns Promise<void>
Inherited from SizedComponent.start
- Defined in classes/Components/SizedComponent.ts:133

uiRender

uiRender(canvas: VirtualCanvas): void
Used for rendering UI
Parameters
- canvas: VirtualCanvas
Returns void
Inherited from SizedComponent.uiRender
- Defined in classes/Components/SizedComponent.ts:259

update

update(): Promise<void>
Called every frame before render

Returns Promise<void>
Inherited from SizedComponent.update
- Defined in classes/Components/Component.ts:59

updatePosition

updatePosition(): void
Returns void
Inherited from SizedComponent.updatePosition
- Defined in classes/Components/SizedComponent.ts:167

updateSize

updateSize(): void
Returns void
Inherited from SizedComponent.updateSize
- Defined in classes/Components/SizedComponent.ts:230

warn

warn(...obj: any): void
Utility function for logging. Logs using console.warn and appends info about gameObject and component
Parameters
- Rest ...obj: any
  
  thing to log
Returns void
Inherited from SizedComponent.warn
- Defined in classes/Components/Component.ts:115

Generated using TypeDoc