Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Hop

Data for hopping or attempting to hop.

Hierarchy

  • Component
    • Hop

Indexable

[name: string]: any

Data for hopping or attempting to hop.

Index

Properties

Accessors

Methods

Object literals

Properties

direction

direction: Direction

The direction of the hop.

entity

entity: Entity

frame

frame: number

The frame of the hop animation to display.

id

id: string

placeholder

placeholder: Entity | null

The entity added to the map to reserve the target grid of the hop.

tick

tick: number

The current tick number of the hop.

x

x: number

The relative X coordinate of the hop.

y

y: number

The relative Y coordinate of the hop.

z

z: number

The relative Z coordinate of the hop.

Static key

key: string = "hop"

Static registered

registered: Boolean

Static serialize

serialize: Boolean

Static serializeFields

serializeFields: string[]

Static skipSerializeFields

skipSerializeFields: string[]

Static subbed

subbed: Boolean

Static typeName

typeName: string = "Hop"

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

direction

direction: null = null

frame

frame: number = 0

placeholder

placeholder: EntityRef = EntityRef

tick

tick: number = 0

x

x: number = 0

y

y: number = 0

z

z: number = 0

Generated using TypeDoc