Class default

TODO: extends Entity?

Hierarchy

Implements

Constructors

constructor

Properties

_description? aberrant? decay? event id islandId preventRendering? qualityBonus? referenceId? renamed? respawned? startingDecay? step? type x y z

Accessors

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

Methods

addReferenceId addTag addToTile canInspect clearTileCache creatureDescription getData getDecayAtStart getDescription getInspectionId getName getProducedTemperature getResources hasData hasTag humansVisible isNearby isOnFire isValid isWithinHumanBounds notifyItem notifyStat onCreated onRemoved queueSoundEffect removeData removeFromTile removeTag setCachedTile setData setHumansWithinBound setName toString update updateDoodadOverHiddenState updateRender updateView is

Constructors

constructor

Properties

Protected Optional _description

_description?: ICorpseDescription

Optional aberrant

aberrant?: boolean

Optional decay

decay?: number

Readonly event

event: IEventEmitter<default, ICorpseEvents>

id

id: number

islandId

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

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

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, 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>

asHuman

  • get asHuman(): undefined

  • Returns undefined

asItem

  • get asItem(): undefined

  • Returns undefined

asLocalPlayer

  • get asLocalPlayer(): undefined

  • Returns undefined

asNPC

  • get asNPC(): undefined

  • Returns undefined

asPlayer

  • get asPlayer(): undefined

  • Returns undefined

asTileEvent

  • get asTileEvent(): undefined

  • Returns undefined

description

  • get description(): undefined | DescriptionType

  • Get the entities description

    Returns undefined | DescriptionType

entityType

  • get entityType(): Corpse

  • Returns Corpse

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

  • Returns undefined | Reference

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

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

canInspect

  • Parameters

    Returns boolean

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

getInspectionId

  • Returns string

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

humansVisible

isNearby

isOnFire

isValid

  • Returns boolean

isWithinHumanBounds

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

    Returns boolean

notifyItem

notifyStat

Protected onCreated

  • Returns void

Protected onRemoved

  • Returns void

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

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

updateDoodadOverHiddenState

  • Updates the DoodadOverHidden tile flag if the creature is large. Large creatures should render over the doodad over layer, which means we should hide the doodad over layer for doodads on the creatures tile.

    Parameters

    • shouldBeHidden: boolean

    Returns void

updateRender

updateView

Static is

  • Parameters

    • value: any

    Returns value is default

Settings

Member Visibility

Theme

Generated using TypeDoc