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

Type Parameters

Hierarchy

Implements

Constructors

constructor

Properties

_description? entityType event historicalActions? id islandId persistentMarker preventRendering? referenceId? renamed? 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 humansVisible isLoaded isLocalPlayer isOnFire isValid isWithinHumanBounds island point reference tile tilesAround

Methods

addMarkerIcon addReferenceId addTag asNot asType canInspect clearTileCache getData getDescription getName getProducedTemperature hasData hasTag isContainer isCorpse isCreature isDoodad isEntity isHuman isItem isNPC isNearby isPlayer isTile isTileEvent notifyItem notifyStat queueSoundEffect removeData removeMarkerIcon removeTag setCachedTile setData setHumansWithinBound setName toString updateRender updateView updateWorldTile

Constructors

constructor

  • Type Parameters

    Parameters

    Returns default<DescriptionType, TypeType, EntityReferenceType, TagType>

Properties

Protected Optional _description

_description?: DescriptionType

Readonly Abstract entityType

entityType: EntityType

Readonly event

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

Optional historicalActions

historicalActions?: PartialRecord<ActionType, number>

id

id: number

islandId

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

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

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

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

asEntityWithStats

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

  • Returns undefined | 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>

humansVisible

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

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

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

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>

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

asNot

  • Parameters

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

asType

  • Parameters

    • type: TypeType

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

canInspect

  • Parameters

    Returns boolean

clearTileCache

  • Returns void

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

Abstract getName

  • Returns default

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

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

    Returns boolean

Abstract isContainer

Abstract isCorpse

Abstract isCreature

Abstract isDoodad

isEntity

Abstract isHuman

Abstract isItem

Abstract isNPC

isNearby

Abstract isPlayer

Abstract isTile

Abstract isTileEvent

notifyItem

notifyStat

queueSoundEffect

  • 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

removeMarkerIcon

  • Returns void

removeTag

  • Parameters

    • tag: TagType

    Returns void

Protected setCachedTile

  • Parameters

    Returns void

setData

  • Sets a data

    Rturns

    The value

    Type Parameters

    • T

    Parameters

    • key: string

      Data key

    • value: T

      Data value

    Returns T

setHumansWithinBound

  • Parameters

    Returns void

setName

toString

  • Returns string

updateRender

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