Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TileEvent

Hierarchy

Implements

Index

Constructors

constructor

  • Parameters

    • Optional type: TileEventType
    • Default value x: number = 0
    • Default value y: number = 0
    • Default value z: number = 0

    Returns TileEvent

Properties

Optional decay

decay: undefined | number

Readonly event

event: IEventEmitter<this, ITileEventEvents> = new EventEmitter<this, E>(this)

fromX

fromX: number

fromY

fromY: number

Optional fuel

fuel: undefined | number

For use with the Fire TileEvent to check if it has a fuel source and should create ash by default. Set to 0 to stop all ash production.

Optional gfx

gfx: undefined | number

id

id: number

Optional maxDur

maxDur: undefined | number

Optional minDur

minDur: undefined | number

Readonly objectType

objectType: CreationId

Optional referenceId

referenceId: undefined | number

Optional renamed

renamed: string | ISerializedTranslation

Optional spread

spread: undefined | number

Optional step

step: undefined | number

type

x

x: number

y

y: number

z

z: number

Methods

addToTile

  • addToTile(tile: ITile): void
  • Parameters

    Returns void

description

getMovementProgress

  • getMovementProgress(timeStamp: number): number
  • Parameters

    • timeStamp: number

    Returns number

getName

  • getName(article?: undefined | false | true, count?: undefined | number): Translation
  • Parameters

    • Optional article: undefined | false | true
    • Optional count: undefined | number

    Returns Translation

getProducedTemperature

  • getProducedTemperature(): undefined | number
  • Returns undefined | number

getTile

  • Returns ITile

moveTo

  • moveTo(x: number, y: number, z: number): void
  • Parameters

    • x: number
    • y: number
    • z: number

    Returns void

removeFromTile

  • removeFromTile(updateTile: boolean): void
  • Parameters

    • updateTile: boolean

    Returns void

toString

  • toString(): string
  • Returns string

updateFire

  • updateFire(tile: ITile): void
  • Parameters

    Returns void

Static is

  • is(value: any): value is TileEvent
  • Parameters

    • value: any

    Returns value is TileEvent

Generated using TypeDoc