Class default

Entity class that allows movement

Hierarchy

Implements

Constructors

constructor

Properties

_description? allowSmartMovementClientside? anim attackAnimationData? builderIdentifier? decay? direction? event facingDirection? fromX fromY fuel? gfx? historicalActions? id isMoving? islandId maxDur? minDur? moveType? movementCompleteZ? movingData persistentMarker preventRendering? referenceId? renamed? shouldSkipNextMovement? shouldSkipNextUpdate? slipping? spread? step? type x y z

Accessors

asContainer asCorpse asCreature asDoodad asEntity asEntityMovable asEntityWithStats asGenericEntity asHuman asItem asLoaded asLocalPlayer asNPC asNotLocalPlayer asPlayer asTile asTileEvent asUnion description entityType facingTile fromTile humansVisible isFlying isLoaded isLocalPlayer isOnFire isValid isWithinHumanBounds island point reference slippingData tile tileUpdateType tilesAround

Methods

addMarkerIcon addReferenceId addTag addToTile animate animateAttack animateBumpTowards asNot asType burn canInspect canSeeObject canSeePosition canSeeTile canSwapWith clearTileCache getBuilder getData getDescription getMoveType getMovementDelay getMovementPoint getMovementProgress getName getProducedTemperature getVehicle getWanderChance? getWanderHomePoint? getWanderHomeRadius? getWanderIdleChance? getWanderNewDirectionChance? hasData hasTag isContainer isCorpse isCreature isDoodad isEntity isHuman isItem isNPC isNearby isPlayer isTile isTileEvent isVehicleAllowedOnTile moveTo notifyItem notifyStat onMovementCompleted overrideNextMovement queueSoundEffect queueSoundEffectInFront removeData removeFromTile removeMarkerIcon removeTag setCachedTile setData setFromPosition setHumansWithinBound setMoveType setMoving setName setPosition skipNextMovement skipNextUpdate startSlipping stopSlipping toString updateDirection updateFire updateRender updateSlipping updateTileWhenMoving updateView updateWorldTile is

Constructors

constructor

Properties

Protected Optional _description

_description?: ITileEventDescription

Optional allowSmartMovementClientside

allowSmartMovementClientside?: boolean

Used for smart vehicle movement (minecarts) Note: This is clientside only.

anim

anim: number = 0

Optional attackAnimationData

attackAnimationData?: IAttackAnimationData

Used for attack animations. Note: This is clientside only.

Optional builderIdentifier

builderIdentifier?: string

Optional decay

decay?: number

Optional direction

direction?: default

undefined = Vector2.ZERO for this

event

event: IEventEmitter<default, ITileEventEvents>

Optional facingDirection

facingDirection?: East | North | West | South

undefined = Direction.None for this

fromX

fromX: number = 0

Note: This might not be a whole number.

fromY

fromY: number = 0

Note: This might not be a whole number.

Optional fuel

fuel?: 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?: number

Optional historicalActions

historicalActions?: PartialRecord<ActionType, number>

id

id: number

Optional isMoving

isMoving?: boolean

Not guaranteed to be synced between the server and client for Human entities

islandId

islandId: `${number},${number}`

Optional maxDur

maxDur?: number

Optional minDur

minDur?: number

Optional moveType

moveType?: MoveType

Optional movementCompleteZ

movementCompleteZ?: number

Only used for Human entities

Readonly movingData

movingData: IMovingData = {}

Used for movement animations. Note: This is clientside only.

persistentMarker

persistentMarker: undefined | {
    guid: string;
    type: Tamed;
}

Notifier marker assigned to this entity

Optional preventRendering

preventRendering?: boolean

Optional referenceId

referenceId?: number

Do not use this property directly, instead use `game.references.getReference()

Optional renamed

renamed?: string | ISerializedTranslation

Optional shouldSkipNextMovement

shouldSkipNextMovement?: true

Protected Optional shouldSkipNextUpdate

shouldSkipNextUpdate?: true

Protected Optional slipping

slipping?: ISlippingData

Optional spread

spread?: number

Optional step

step?: number

type

type: TileEventType

x

x: number

y

y: number

z

z: WorldZ

Accessors

asContainer

  • get asContainer(): undefined

  • Returns undefined

asCorpse

  • get asCorpse(): undefined

  • Returns undefined

asCreature

  • get asCreature(): undefined

  • Returns undefined

asDoodad

  • get asDoodad(): undefined

  • Returns undefined

asEntity

  • get asEntity(): default<DescriptionType, TypeType, EntityReferenceType, TagType>

  • Returns default<DescriptionType, TypeType, EntityReferenceType, TagType>

asEntityMovable

  • get asEntityMovable(): default<DescriptionType, TypeType, EntityReferenceType, TagType>

  • Returns default<DescriptionType, TypeType, EntityReferenceType, TagType>

asEntityWithStats

  • get asEntityWithStats(): undefined | default<DescriptionType, TypeType, EntityReferenceType, TagType>

  • Returns undefined | default<DescriptionType, TypeType, EntityReferenceType, TagType>

asGenericEntity

asHuman

  • get asHuman(): undefined

  • Returns undefined

asItem

  • get asItem(): undefined

  • Returns undefined

asLoaded

  • get asLoaded(): undefined | this

  • undefined if this entity's island is not loaded, this if it is

    Returns undefined | this

asLocalPlayer

  • get asLocalPlayer(): undefined

  • Returns undefined

asNPC

  • get asNPC(): undefined

  • Returns undefined

asNotLocalPlayer

  • get asNotLocalPlayer(): undefined | this

  • Returns undefined | this

asPlayer

  • get asPlayer(): undefined

  • Returns undefined

asTile

  • get asTile(): undefined

  • Returns undefined

asTileEvent

  • get asTileEvent(): undefined | default

  • Returns undefined | default

asUnion

description

  • get description(): undefined | Readonly<DescriptionType>

  • Get the entities description

    Returns undefined | Readonly<DescriptionType>

entityType

  • get entityType(): TileEvent

  • Returns TileEvent

facingTile

  • get facingTile(): default

  • Regular entities don't have a direction so this will be the same as getTile()

    Returns default

fromTile

  • get fromTile(): undefined | default

  • Tile the entity is moving from

    Returns undefined | default

humansVisible

  • get humansVisible(): default<unknown, number, NPC | Player>[]

  • Returns humans within this entities fov & that they can see

    Returns default<unknown, number, NPC | Player>[]

isFlying

  • get isFlying(): boolean

  • Returns boolean

isLoaded

  • get isLoaded(): boolean

  • Whether this entity's island is loaded

    Returns boolean

isLocalPlayer

  • get isLocalPlayer(): boolean

  • Returns boolean

isOnFire

  • get isOnFire(): FireType

  • Returns FireType

isValid

  • get isValid(): boolean

  • Returns boolean

isWithinHumanBounds

  • get isWithinHumanBounds(): boolean

  • Checks if the entity is within the viewport bounds of one or more humans

    Returns boolean

island

  • get island(): default

  • Returns default

point

  • get point(): IVector3

  • Location of the entity on the world. Parent classes will probably mark this as always defined

    Returns IVector3

reference

  • get reference(): undefined | Reference<EntityReferenceType>

  • Returns undefined | Reference<EntityReferenceType>

slippingData

  • get slippingData(): undefined | ISlippingData

  • Returns undefined | ISlippingData

tile

  • get tile(): default

  • Tile the entity is on in the world. Parent classes will probably mark this as always defined

    Returns default

tileUpdateType

  • get tileUpdateType(): TileUpdateType

  • Returns TileUpdateType

tilesAround

  • get tilesAround(): undefined | default[]

  • Returns undefined | default[]

Methods

addMarkerIcon

  • Parameters

    Returns void

addReferenceId

  • Adds a referenceId to the entity if it doesn't already have one

    Returns void

addTag

  • Parameters

    • tag: unknown

    Returns void

addToTile

  • Parameters

    Returns void

animate

  • Animates the entity between a specific set of positions

    Parameters

    • fromX: number
    • fromY: number
    • toX: number
    • toY: number
    • delay: Delay

    Returns void

animateAttack

  • Parameters

    Returns void

animateBumpTowards

  • Faces the target and animates a bump into effect

    Parameters

    Returns void

asNot

asType

burn

  • Parameters

    Returns void

canInspect

canSeeObject

canSeePosition

  • Parameters

    • type: CanASeeBType
    • islandId: `${number},${number}`
    • x: number
    • y: number
    • z: number
    • fieldOfView: undefined | FieldOfView = renderer.fieldOfView
    • Optional customRadius: number

    Returns boolean

canSeeTile

canSwapWith

clearTileCache

  • Returns void

getBuilder

  • Gets the builder/creator of this event, or undefined if the tile event is creatorless.

    Returns undefined | default

getData

  • Gets a data

    Returns

    Data value or undefined if it wasn't found

    Type Parameters

    • T

    Parameters

    • key: string

      Data key

    Returns undefined | T

Protected getDescription

getMoveType

getMovementDelay

  • Returns number

getMovementPoint

getMovementProgress

  • Gets movement progress and moves the state machine forward when the movement is completed

    Parameters

    • timeStamp: number

    Returns number

getName

getProducedTemperature

  • Gets the temperature produced by this object. Positive values are "heat", negative values are "cold". Refer to the values of the Temperature enum to see the possible range. If this method is not implemented, or it returns undefined, Temperature.Neutral is used.

    Returns undefined | number

getVehicle

Optional getWanderChance

  • Parameters

    • defaultChance: number

    Returns undefined | number

Optional getWanderHomePoint

Optional getWanderHomeRadius

  • Returns undefined | number

Optional getWanderIdleChance

  • Parameters

    • defaultChance: number

    Returns undefined | number

Optional getWanderNewDirectionChance

  • Parameters

    • defaultChance: number

    Returns undefined | number

hasData

  • Check if a data was set

    Returns

    True if the data exists, false if it doesn't

    Parameters

    • key: string

      Data key

    Returns boolean

hasTag

  • Parameters

    • tag: unknown

    Returns boolean

isContainer

isCorpse

isCreature

isDoodad

isEntity

isHuman

isItem

isNPC

isNearby

isPlayer

isTile

isTileEvent

isVehicleAllowedOnTile

moveTo

notifyItem

notifyStat

Protected onMovementCompleted

overrideNextMovement

queueSoundEffect

  • Parameters

    • type: SfxType
    • Optional delay: number
    • Optional speed: number

    Returns void

queueSoundEffectInFront

  • Parameters

    • type: SfxType
    • Optional delay: number
    • Optional speed: number

    Returns void

removeData

  • Removes a data

    Returns

    True when the data is removed. False if the key wasn't set

    Parameters

    • key: string

      Data key

    Returns boolean

removeFromTile

  • Parameters

    • updateTile: boolean

    Returns void

removeMarkerIcon

  • Returns void

removeTag

  • Parameters

    • tag: unknown

    Returns void

Protected setCachedTile

setData

  • Sets a data

    Rturns

    The value

    Type Parameters

    • T

    Parameters

    • key: string

      Data key

    • value: T

      Data value

    Returns T

Protected setFromPosition

  • Parameters

    • fromX: number = ...
    • fromY: number = ...

    Returns void

setHumansWithinBound

setMoveType

Protected setMoving

  • Parameters

    • fromX: number
    • fromY: number
    • Optional toZ: number
    • Optional options: IMoveToOptions

    Returns void

setName

setPosition

  • Immediately move the entity to the tile

    Parameters

    Returns void

skipNextMovement

  • Skips the next movement for this creature / npc

    Returns void

skipNextUpdate

  • Skips the next update for this creature / npc

    Returns void

startSlipping

stopSlipping

  • Returns void

toString

  • Returns string

updateDirection

updateFire

  • Parameters

    Returns void

updateRender

updateSlipping

Protected updateTileWhenMoving

  • Called when the entity is about to move to another tile. This should update relevant properties on the tile and return true

    Returns

    False to block the move

    Parameters

    • fromTile: default

      Tile the entity was on

    • toTile: default

      Tile the entity is moving onto

    Returns boolean

updateView

updateWorldTile

  • Updates the world renderer & flow field state for the tile

    Parameters

    • tileUpdateType: TileUpdateType = ...
    • Optional updateNeighbors: boolean
    • Optional skipFlowFieldUpdate: boolean

    Returns void

Static is

  • Parameters

    • value: any

    Returns value is default

Settings

Member Visibility

Theme

Generated using TypeDoc