Class default

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

Hierarchy

Implements

Constructors

constructor

Properties

_description? aberrant? ai allowSmartMovementClientside? anim attackAnimationData? direction enemy? event facingDirection fromX fromY historicalActions? hitchedTo? id isMoving? islandId moveType? movementCompleteZ? movingData originalMoveType? owner? persistentMarker preventRendering? referenceId? renamed? respawned? shouldSkipNextMovement? shouldSkipNextUpdate? slipping? spawnAnimationTime stat stats status type x y z zonePoint?

Accessors

asContainer asCorpse asCreature asDoodad asEntity asEntityMovable asEntityWithStats asGenericEntity asHuman asItem asLoaded asLocalPlayer asNPC asNotLocalPlayer asPlayer asTile asTileEvent asUnion description entityType facingTile fromTile humansVisible isFlying isHidden isHostile isLoaded isLocalPlayer isOnFire isRetaliator isTamed isValid isWithinHumanBounds island point reference slippingData tile tileUpdateType tilesAround timesPetted timesTamed zone

Methods

addMarkerIcon addReferenceId addTag animate animateAttack animateBumpTowards animateSpawn asNot asType canInspect canSeeObject canSeePosition canSeeTile canSwapWith canTarget checkCreatureMove checkForBurn checkUnder clearTileCache damage findPath getActiveStatuses getApplicableStatuses getAttackOutcome getCommandedAiType getData getDefense getDescription getEnemy getHitchingPostsAround getMoveType getMovementDelay getMovementPoint getMovementProgress getName getOwner getProducedTemperature getStatus getStatusLevel getStatuses getVehicle getWanderChance getWanderHomePoint getWanderHomeRadius getWanderIdleChance getWanderNewDirectionChance hasData hasStatus hasTag increaseMaxHealth increasePettedCount increaseTamedCount increaseWaste initializeAi initializeStats initializeStatuses isContainer isCorpse isCreature isDoodad isEntity isHuman isItem isNPC isNearby isPlayer isTile isTileEvent isVehicleAllowedOnTile load moveTo moveToIsland notifyItem notifyStat offer onMovementCompleted onStatChange onUnserialized overrideNextMovement processAttack processSpecialAbilities queueSoundEffect queueSoundEffectInFront refreshStatuses release removeData removeMarkerIcon removeTag restore setCachedTile setData setEnemy setFromPosition setHumansWithinBound setMoveType setMoving setName setPosition setStatus skipNextMovement skipNextUpdate startSlipping stopSlipping tame tickStatuses toString unhitch update updateDirection updateRender updateSlipping updateTileWhenMoving updateView updateWorldTile is

Constructors

constructor

Properties

Protected Optional _description

_description?: ICreatureDescription

Optional aberrant

aberrant?: true

ai

ai: default<default<unknown, number, EntityReferenceTypes, unknown>>

Optional allowSmartMovementClientside

allowSmartMovementClientside?: boolean

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

anim

anim: number = 0

Optional attackAnimationData

attackAnimationData?: IAttackAnimationData

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

direction

direction: default = Vector2.ZERO

undefined = Vector2.ZERO for this

Optional enemy

enemy?: {
    attacks: number;
    attempts: number;
    breakAway?: boolean;
    reference: Reference;
}

Type declaration

  • attacks: number
  • attempts: number
  • Optional breakAway?: boolean
  • reference: Reference

event

event: IEventEmitter<default, ICreatureEvents>

facingDirection

facingDirection: East | North | West | South = Direction.South

undefined = Direction.None for this

fromX

fromX: number = 0

Note: This might not be a whole number.

fromY

fromY: number = 0

Note: This might not be a whole number.

Optional historicalActions

historicalActions?: PartialRecord<ActionType, number>

Optional hitchedTo

hitchedTo?: 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.

Optional originalMoveType

originalMoveType?: MoveType

Optional owner

owner?: {
    reference: Reference;
    tameTime: number;
}

Type declaration

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 respawned

respawned?: number

Optional shouldSkipNextMovement

shouldSkipNextMovement?: true

Protected Optional shouldSkipNextUpdate

shouldSkipNextUpdate?: true

Protected Optional slipping

slipping?: ISlippingData

spawnAnimationTime

spawnAnimationTime: undefined | IMovementTime

Readonly stat

stat: default<default> = ...

stats

stats: IStats

status

status: IStatus

type

type: CreatureType

x

x: number

y

y: number

z

z: WorldZ

Optional zonePoint

zonePoint?: IVector3

Accessors

asContainer

  • get asContainer(): undefined

  • Returns undefined

asCorpse

  • get asCorpse(): undefined

  • Returns undefined

asCreature

  • get asCreature(): default

  • Returns default

asDoodad

  • get asDoodad(): undefined

  • Returns undefined

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

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

  • Returns Creature

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

isHidden

  • get isHidden(): boolean

  • Returns boolean

isHostile

  • get isHostile(): boolean

  • Returns boolean

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

isRetaliator

  • get isRetaliator(): boolean

  • Returns boolean

isTamed

  • get isTamed(): boolean

  • Returns boolean

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>

slippingData

  • get slippingData(): undefined | ISlippingData

  • Returns undefined | ISlippingData

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[]

timesPetted

  • get timesPetted(): number

  • Returns the times a creature has been petted.

    Returns

    number if the creature has been petted (0 if it has never been petted).

    Returns number

timesTamed

  • get timesTamed(): number

  • Returns the times a creature has been tamed.

    Returns

    number if the creature has been tamed (0 if it has never been tamed).

    Returns number

zone

  • get zone(): undefined | CreatureZone

  • Returns undefined | CreatureZone

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

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

animateSpawn

  • Returns void

asNot

asType

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

  • Check if this creature can swap with the player in the event that the player is moving into them

    Parameters

    • human: default<unknown, number, NPC | Player>

      Human object

    • source: undefined | string

      Source string. Set to undefined if this is being called from the clientside

    Returns boolean

canTarget

  • Check is a creature is allowed to attack the target (rules of engagement)

    Returns

    True if it can attack them

    Parameters

    Returns boolean

checkCreatureMove

  • Checks that a creature can move to a certain tile and/or interact with doodads/tiles

    Returns

    0 if the creature can move, otherwise an error code

    Parameters

    • isClientside: boolean

      True if clientside. Don't do random stuff in this case

    • tile: default
    • moveType: MoveType
    • willMove: boolean

      Set to true if the object is about to move to this tile. This method will confirm if theres an existing npc/creature there and return false if so

    • Optional options: Partial<ICreatureCheckMoveOptions>

    Returns number

checkForBurn

  • Parameters

    Returns boolean

checkUnder

  • Checks under the creature for getting burned, setting off traps, eating items off the ground, and more

    Returns

    Returns whether the creature can keep moving (in the case of creatures with >= 2 speed)

    Parameters

    • x: number = ...
    • y: number = ...
    • Optional skipParticles: boolean

    Returns boolean

clearTileCache

  • Returns void

damage

  • Parameters

    Returns undefined | number

  • Parameters

    • damageInfo: IDamageInfo
    • Optional creatureX: number
    • Optional creatureY: number
    • Optional creatureZ: number

    Returns undefined | number

findPath

  • Finds a path from the creatures tile to the target tile

    Parameters

    • source: undefined | string

      Provided when the check is running in a sync environment (NOT CLIENTSIDE)

    • target: default
    • moveType: MoveType
    • Optional maxNodesChecked: number
    • Optional ignoreHuman: default<unknown, number, NPC | Player>

    Returns undefined | default[]

getActiveStatuses

Protected getApplicableStatuses

getAttackOutcome

getCommandedAiType

  • Returns undefined | AiType

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

getDefense

Protected getDescription

getEnemy

  • Gets the enemy the creature marked

    Returns

    Enemy

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

getHitchingPostsAround

  • Returns IHitch

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

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:

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

    Returns default

getOwner

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

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

getWanderChance

  • Parameters

    • defaultChance: number

    Returns undefined | number

getWanderHomePoint

getWanderHomeRadius

  • Returns undefined | number

getWanderIdleChance

  • Parameters

    • defaultChance: number

    Returns undefined | number

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

    Returns boolean

increaseMaxHealth

  • Increases the creature's maximum health in the event of offering/re-taming and petting (to a lesser extent)

    Parameters

    Returns void

increasePettedCount

  • Increases the number of times the creature has been petted.

    Returns void

increaseTamedCount

  • Returns

    The new times tamed

    Returns number

increaseWaste

  • Parameters

    Returns void

initializeAi

  • Parameters

    • resetAiType: boolean = true

    Returns void

initializeStats

  • Initializes the creature's stats. Used in the constructor & save conversion.

    Parameters

    • hp: number
    • Optional maxhp: number

    Returns void

Protected initializeStatuses

  • Called when loading the human

    Returns void

isContainer

isCorpse

isCreature

isDoodad

isEntity

isHuman

isItem

isNPC

  • Returns this is default

isNearby

isPlayer

isTile

isTileEvent

isVehicleAllowedOnTile

load

  • Returns void

moveTo

moveToIsland

  • Parameters

    Returns void

notifyItem

notifyStat

offer

  • Parameters

    Returns undefined | default

Protected onMovementCompleted

Protected onStatChange

  • Parameters

    Returns void

onUnserialized

overrideNextMovement

processAttack

processSpecialAbilities

  • Parameters

    Returns boolean

queueSoundEffect

  • Parameters

    • type: SfxType
    • delay: number = 0
    • speed: number = ...

    Returns void

queueSoundEffectInFront

  • Parameters

    • type: SfxType
    • Optional delay: number
    • Optional speed: number

    Returns void

refreshStatuses

  • Returns void

release

  • Parameters

    • Optional remainTamed: boolean

    Returns boolean

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

    Returns void

restore

  • Parameters

    • targetTile: default
    • Optional preventRendering: boolean

    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

setEnemy

  • Parameters

    Returns void

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

tame

  • Parameters

    Returns boolean

tickStatuses

  • Returns void

toString

  • Returns string

unhitch

  • Returns void

update

  • Parameters

    Returns boolean

updateDirection

updateRender

updateSlipping

Protected 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

Static is

  • Parameters

    • value: any

    Returns value is default

Settings

Member Visibility

Theme

Generated using TypeDoc