Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Transform

Data for an entity's location in 3D space. Systems should manipulate this component instead of the map cell component. Changes made to this component will be copied to the map cell.

Hierarchy

  • Component
    • Transform

Indexable

[name: string]: any

Data for an entity's location in 3D space. Systems should manipulate this component instead of the map cell component. Changes made to this component will be copied to the map cell.

Index

Properties

Accessors

Methods

Object literals

Properties

entity

entity: Entity

id

id: string

x

x: number

The X coordinate of the entity's location. Negative is West, positive is East.

y

y: number

The Y coordinate of the entity's location. Negative is North, positive is South.

z

z: number

The Z coordinate of the entity's location. Negative is down, positive is up.

Static key

key: string = "transform"

Static registered

registered: Boolean

Static serialize

serialize: Boolean

Static serializeFields

serializeFields: string[]

Static skipSerializeFields

skipSerializeFields: string[]

Static subbed

subbed: Boolean

Static typeName

typeName: string = "Transform"

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

z

z: number = 0

Generated using TypeDoc