Class default<DescriptionType, TypeType, EntityReferenceType, TagType>Abstract

Entity class that includes stats/status system. Note: We're assuming something with stats is also movable!

Type Parameters

Hierarchy

Implements

Constructors

constructor

Properties

_description? allowSmartMovementClientside? anim? attackAnimationData? direction? entityType event facingDirection? fromX? fromY? historicalActions? id isMoving? islandId moveType? movementCompleteZ? movingData persistentMarker preventRendering? referenceId? renamed? shouldSkipNextMovement? shouldSkipNextUpdate? slipping? stat stats status tileUpdateType type x y z

Accessors

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

Methods

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

Constructors

constructor

Properties

Protected Optional _description

_description?: DescriptionType

Optional allowSmartMovementClientside

allowSmartMovementClientside?: boolean

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

Optional anim

anim?: number

Optional attackAnimationData

attackAnimationData?: IAttackAnimationData

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

Optional direction

direction?: default

undefined = Vector2.ZERO for this

Readonly Abstract entityType

entityType: EntityType

event

event: IEventEmitter<default<DescriptionType, TypeType, EntityReferenceType, TagType>, IEntityWithStatsEvents>

Optional facingDirection

facingDirection?: East | North | West | South

undefined = Direction.None for this

Optional fromX

fromX?: number

Note: This might not be a whole number.

Optional fromY

fromY?: number

Note: This might not be a whole 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 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

Readonly stat

stat: default<default<DescriptionType, TypeType, EntityReferenceType, TagType>> = ...

stats

stats: IStats

status

status: IStatus

Readonly Abstract tileUpdateType

tileUpdateType: TileUpdateType

type

type: TypeType

x

x: number

y

y: number

z

z: WorldZ

Accessors

Abstract asContainer

Abstract asCorpse

  • get asCorpse(): undefined | default

  • Returns undefined | default

Abstract asCreature

  • get asCreature(): undefined | default

  • Returns undefined | default

Abstract asDoodad

  • get asDoodad(): undefined | default

  • Returns undefined | default

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(): default<DescriptionType, TypeType, EntityReferenceType, TagType>

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

asGenericEntity

Abstract asHuman

  • get asHuman(): undefined | default<unknown, number, NPC | Player>

  • Returns undefined | default<unknown, number, NPC | Player>

Abstract asItem

  • get asItem(): undefined | default

  • Returns undefined | default

asLoaded

  • get asLoaded(): undefined | this

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

    Returns undefined | this

Abstract asLocalPlayer

  • get asLocalPlayer(): undefined | default

  • Returns undefined | default

Abstract asNPC

  • get asNPC(): undefined | default

  • Returns undefined | default

asNotLocalPlayer

  • get asNotLocalPlayer(): undefined | this

  • Returns undefined | this

Abstract asPlayer

  • get asPlayer(): undefined | default

  • Returns undefined | default

Abstract asTile

  • get asTile(): undefined | default

  • Returns undefined | default

Abstract asTileEvent

  • get asTileEvent(): undefined | default

  • Returns undefined | default

asUnion

description

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

  • Get the entities description

    Returns undefined | Readonly<DescriptionType>

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

Abstract isLocalPlayer

  • get isLocalPlayer(): boolean

  • Returns boolean

isOnFire

  • get isOnFire(): FireType

  • Returns FireType

Abstract 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(): undefined | IVector3

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

    Returns undefined | IVector3

reference

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

  • Returns undefined | Reference<EntityReferenceType>

slippingData

  • get slippingData(): undefined | ISlippingData

  • Returns undefined | ISlippingData

tile

  • get tile(): undefined | default

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

    Returns undefined | default

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: TagType

    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

  • Parameters

    • type: TypeType

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

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

getActiveStatuses

  • Generator for status effects on the entity.

    Returns default[]

Protected getApplicableStatuses

  • Returns undefined | Set<StatusType>

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 Abstract getDescription

  • Called when filling out the entities description for the first time

    Returns undefined | DescriptionType

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

Abstract 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

getStatus

  • Returns the handler for this status effect, whether or not this entity currently has the effect.

    Type Parameters

    Parameters

    Returns undefined | S

getStatusLevel

  • Returns the handler for this status effect, whether or not this entity currently has the effect.

    Parameters

    Returns number

getStatuses

  • Generator for status effects on the entity.

    Returns default[]

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

hasStatus

  • Returns whether the entity has the given StatusType

    Parameters

    Returns number

hasTag

  • Parameters

    • tag: TagType

    Returns boolean

Protected initializeStatuses

  • Called when loading the human

    Returns void

Abstract isContainer

Abstract isCorpse

Abstract isCreature

Abstract isDoodad

isEntity

Abstract isHuman

Abstract isItem

Abstract isNPC

isNearby

Abstract isPlayer

Abstract isTile

Abstract 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

refreshStatuses

  • 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

removeMarkerIcon

  • Returns void

removeTag

  • Parameters

    • tag: TagType

    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

setStatus

  • Sets whether the entity has the given StatusType. Emits EntityEvent.StatusChange.

    Parameters

    • status: StatusType

      The status to change

    • level: number | boolean

      Whether the entity will have the status.
      If given false/0, removes the status. If given true/1+, raises the status to the given level.

    • reason: StatusChangeReason

      The reason for the change

    • force: boolean = false

      Forces the status to be set to the given value, even if the current effect is being lowered.

    Returns boolean

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

updateRender

updateSlipping

Protected Abstract 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

Settings

Member Visibility

Theme

Generated using TypeDoc