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

Type Parameters

  • DescriptionType = unknown

  • TypeType extends number = number

  • TagType = unknown

  • CounterType = unknown

Hierarchy

Implements

Constructors

constructor

Properties

_description? entityType event id islandId preventRendering? referenceId? renamed? tileUpdateType type x y z

Accessors

asCorpse asCreature asDoodad asEntity asEntityMovable asEntityWithStats asHuman asItem asLocalPlayer asNPC asPlayer asTileEvent description island point reference tile tilesAround

Methods

addReferenceId addTag canInspect clearTileCache getData getDescription getInspectionId getName getProducedTemperature hasData hasTag humansVisible isNearby isOnFire isValid isWithinHumanBounds notifyItem notifyStat queueSoundEffect removeData removeTag setCachedTile setData setHumansWithinBound setName toString updateRender updateView

Constructors

constructor

  • Type Parameters

    • DescriptionType = unknown

    • TypeType extends number = number

    • TagType = unknown

    • CounterType = unknown

    Parameters

    Returns default<DescriptionType, TypeType, TagType, CounterType>

Properties

Protected Optional _description

_description?: DescriptionType

Readonly Abstract entityType

entityType: EntityType

Readonly event

event: IEventEmitter<default<DescriptionType, TypeType, TagType, CounterType>, IEntityEvents> = ...

id

id: number

islandId

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

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 asCorpse

  • get asCorpse(): undefined | default

  • Returns undefined | default

Abstract asCreature

Abstract asDoodad

  • get asDoodad(): undefined | default

  • Returns undefined | default

asEntity

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

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

asEntityMovable

  • get asEntityMovable(): undefined | default<DescriptionType, TypeType, TagType, unknown>

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

asEntityWithStats

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

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

Abstract asHuman

  • get asHuman(): undefined | default<number>

  • Returns undefined | default<number>

Abstract asItem

  • get asItem(): undefined | default

  • Returns undefined | default

Abstract asLocalPlayer

  • get asLocalPlayer(): undefined | default

  • Returns undefined | default

Abstract asNPC

Abstract asPlayer

Abstract asTileEvent

  • get asTileEvent(): undefined | default

  • Returns undefined | default

description

  • get description(): undefined | DescriptionType

  • Get the entities description

    Returns undefined | DescriptionType

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

  • Returns undefined | Reference

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

addReferenceId

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

    Returns void

addTag

  • Parameters

    • tag: TagType

    Returns void

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

getInspectionId

  • Returns string

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

humansVisible

  • Returns default<number>[]

isNearby

  • Parameters

    • entity: default<DescriptionType, number, unknown, unknown>

    Returns boolean

isOnFire

  • Returns FireType

Abstract isValid

  • Returns boolean

isWithinHumanBounds

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

    Returns boolean

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

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

Settings

Member Visibility

Theme

Generated using TypeDoc