Class Button

Hierarchy

UIElement
- Button

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new Button(props?: ObjectProps<Button>): Button

- Defined in src/ui/Button.ts:57
Parameters
- Optional props: ObjectProps<Button>
Returns Button

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

currentFill

get currentFill(): undefined | UIFill

- Defined in src/ui/Button.ts:34
Returns undefined | UIFill

disabled

get disabled(): undefined | UIFill
set disabled(fill: UIFill | undefined): void

- Defined in src/ui/Button.ts:22
Returns undefined | UIFill
- Defined in src/ui/Button.ts:26
Parameters
- fill: UIFill | undefined
Returns void

enabled

get enabled(): boolean
set enabled(enabled: boolean): void

- Defined in src/ui/Button.ts:29
Returns boolean
- Defined in src/ui/Button.ts:30
Parameters
- enabled: boolean
Returns void

entity

get entity(): Entity

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

highlighted

get highlighted(): undefined | UIFill
set highlighted(fill: UIFill | undefined): void

- Defined in src/ui/Button.ts:20
Returns undefined | UIFill
- Defined in src/ui/Button.ts:24
Parameters
- fill: UIFill | undefined
Returns void

id

get id(): string

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

isTouchInside

get isTouchInside(): boolean

Inherited from UIElement.isTouchInside
- Defined in src/ui/UIElement.ts:17
Returns boolean

isTouchPressed

get isTouchPressed(): boolean

Inherited from UIElement.isTouchPressed
- Defined in src/ui/UIElement.ts:18
Returns boolean

normal

get normal(): undefined | UIFill
set normal(fill: UIFill | undefined): void

- Defined in src/ui/Button.ts:19
Returns undefined | UIFill
- Defined in src/ui/Button.ts:23
Parameters
- fill: UIFill | undefined
Returns void

parent

get parent(): undefined | Entity

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

pressed

get pressed(): undefined | UIFill
set pressed(fill: UIFill | undefined): void

- Defined in src/ui/Button.ts:21
Returns undefined | UIFill
- Defined in src/ui/Button.ts:25
Parameters
- fill: UIFill | undefined
Returns void

pushed

get pushed(): boolean
set pushed(pushed: boolean): void

- Defined in src/ui/Button.ts:28
Returns boolean
- Defined in src/ui/Button.ts:27
Parameters
- pushed: boolean
Returns void

version

get version(): number

- Defined in src/ui/Button.ts:17
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/Button.ts:75
Returns void

getVertexBuffer

getVertexBuffer(): VertexBuffer

Overrides UIElement.getVertexBuffer
- Defined in src/ui/Button.ts:104
Returns VertexBuffer

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 Component.isLoaded
- Defined in src/ui/Button.ts:80
Returns boolean

onReplace

onReplace(previous: Component): void

Inherited from Component.onReplace
- Defined in src/core/Component.ts:46
Parameters
- previous: Component
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(entity: Entity): void

Overrides UIElement.setEntity
- Defined in src/ui/Button.ts:68
Parameters
- entity: 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

setTouchInside

setTouchInside(inside: boolean): void

Inherited from UIElement.setTouchInside
- Defined in src/ui/UIElement.ts:35
Parameters
- inside: boolean
Returns void

setTouchPressed

setTouchPressed(pressed: boolean): void

Inherited from UIElement.setTouchPressed
- Defined in src/ui/UIElement.ts:39
Parameters
- pressed: boolean
Returns void

upgrade

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

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