Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Draw

Data for an entity's visual representation on the screen. Systems should manipulate this component instead of the PixiObject component. Changes made to this component will be copied to the PIXI object.

Hierarchy

  • Component
    • Draw

Indexable

[name: string]: any

Data for an entity's visual representation on the screen. Systems should manipulate this component instead of the PixiObject component. Changes made to this component will be copied to the PIXI object.

Index

Properties

Accessors

Methods

Object literals

Properties

entity

entity: Entity

id

id: string

x

x: number

The screen X coordinate of the object.

y

y: number

The screen Y coordinate of the object.

zIndex

zIndex: number

The Z-index of the object. This determines the order in which objects are drawn to the screen.

Static key

key: string = "draw"

Static registered

registered: Boolean

Static serialize

serialize: Boolean

Static serializeFields

serializeFields: string[]

Static skipSerializeFields

skipSerializeFields: string[]

Static subbed

subbed: Boolean

Static typeName

typeName: string = "Draw"

Accessors

key

  • set key(arg: string): any

  • Parameters

    • arg: string

    Returns any

type

  • get type(): string

  • Returns string

Methods

destroy

  • destroy(): void

  • Returns void

getObject

  • getObject(withIds?: undefined | false | true): IComponentObject

  • Parameters

    • Optional withIds: undefined | false | true

    Returns IComponentObject

init

  • init(initial: any): void

  • Parameters

    • initial: any

    Returns void

postDestroy

  • postDestroy(): void

  • Returns void

preDestroy

  • preDestroy(): void

  • Returns void

preInit

  • preInit(initial: any): any

  • Parameters

    • initial: any

    Returns any

update

  • update(values?: IComponentUpdate): void

  • Parameters

    • Optional values: IComponentUpdate

    Returns void

Object literals

Static properties

properties: object

x

x: number = 0

y

y: number = 0

zIndex

zIndex: number = 0

Generated using TypeDoc