Class default

Hierarchy

Implements

Constructors

constructor

Properties

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

Methods

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

Constructors

constructor

Properties

Protected Optional _description

_description?: ICorpseDescription

Optional aberrant

aberrant?: boolean

Optional decay

decay?: number

event

event: IEventEmitter<default, ICorpseEvents>

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 qualityBonus

qualityBonus?: number

Optional referenceId

referenceId?: number

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

Optional renamed

renamed?: string | ISerializedTranslation

Optional respawned

respawned?: number

Optional startingDecay

startingDecay?: number

Optional step

step?: number

type

type: CreatureType

x

x: number

y

y: number

z

z: WorldZ

Accessors

asContainer

  • get asContainer(): undefined

  • Returns undefined

asCorpse

  • get asCorpse(): undefined | default

  • Returns undefined | default

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(): 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

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

  • Returns undefined

asUnion

description

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

  • Get the entities description

    Returns undefined | Readonly<DescriptionType>

entityType

  • get entityType(): Corpse

  • Returns Corpse

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

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>

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

asNot

asType

canInspect

clearTileCache

  • Returns void

creatureDescription

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

getDecayAtStart

  • Returns number

Protected getDescription

getName

  • Parameters

    • Optional article: Article

      Whether to include an article for the name of the creature. Uses the article rules on the language. Defaults to true.

    • Optional count: number

      The number of this creature that you're getting the name of. Defaults to 1.

      Examples:

      • corpse.getName() // "an acid spitter demon"
      • corpse.getName(false) // "acid spitter demon"
      • corpse.getName(undefined, 3) // "acid spitter demons"

    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

getResources

  • Parameters

    • Optional clientSide: boolean

    Returns ItemType[]

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

  • Returns this is default

isNPC

  • Returns this is default

isNearby

isPlayer

isTile

  • Returns this is default

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

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

setHumansWithinBound

setName

toString

  • Returns string

update

  • Returns void

updateRender

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