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? _movementTime? aberrant? ai allowSmartMovementClientside? anim attackAnimationTime? attackAnimationType? direction enemy? event facingDirection fromX fromY hitchedTo? id isMoving? islandId moveType? movementCompleteZ? movingClientside movingOptions? originalMoveType? owner? preventRendering? referenceId? renamed? respawned? shouldSkipNextMovement? shouldSkipNextUpdate? spawnAnimationTime stat stats status tameTime? type x y z

Accessors

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

Methods

addReferenceId addTag animateAttack animateBumpTowards animateSpawn canInspect canSeeObject canSeePosition canSeeTile canSwapWith canTarget checkCreatureMove checkForBurn checkUnder clearTileCache damage findPath getActiveStatuses getApplicableStatusEffects getAttackOutcome getCommandedAiType getData getDefense getDescription getEnemy getHitchingPostsAround getInspectionId getMoveType getMovementDelay getMovementPoint getMovementProgress getName getOwner getProducedTemperature getStatus getStatuses hasAi hasData hasStatus hasTag humansVisible increaseTamedCount increaseWaste initializeStats isHidden isNearby isOnFire isRetaliator isTamed isValid isWithinHumanBounds moveTo moveToIsland notifyItem notifyStat offer onMovementCompleted onStatChange onUnserialized overrideNextMovement processAttack processSpecialAbilities queueSoundEffect queueSoundEffectInFront refreshStatusEffects release removeData removeTag restore setCachedTile setData setEnemy setFromPosition setHumansWithinBound setMoveType setMoving setName setStatus skipNextMovement skipNextUpdate tame timesTamed toString unhitch update updateDirection updateDoodadOverHiddenState updateDoodadOverHiddenStateForCurrentTile updateRender updateTile updateView is

Constructors

constructor

Properties

Protected Optional _description

_description?: ICreatureDescription

Protected Optional _movementTime

_movementTime?: {
    end: number;
    start: number;
}

Type declaration

  • end: number
  • start: number

Optional aberrant

aberrant?: true

ai

ai: AiType

Optional allowSmartMovementClientside

allowSmartMovementClientside?: boolean

anim

anim: number = 0

Optional attackAnimationTime

attackAnimationTime?: IMovementTime

Optional attackAnimationType

attackAnimationType?: DamageType

direction

direction: default = Vector2.ZERO

undefined = Vector2.ZERO for this

Optional enemy

enemy?: {
    attacks: number;
    attempts: number;
    breakAway?: boolean;
    id: number;
    type: EntityType;
}

Type declaration

  • attacks: number
  • attempts: number
  • Optional breakAway?: boolean
  • id: number
  • type: EntityType

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

movingClientside

movingClientside: MovingClientSide = MovingClientSide.NoInput

The state of what the client thinks is happening to this entity (regarding movement)

Optional movingOptions

movingOptions?: IMoveToOptions

Optional originalMoveType

originalMoveType?: MoveType

Optional owner

owner?: {
    identifier: string;
    type: Player;
} | {
    id: number;
    type: NPC;
}

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

spawnAnimationTime

spawnAnimationTime: undefined | IMovementTime

Readonly stat

stat: default<default> = ...

stats

stats: IStats

status

status: IStatus

Optional tameTime

tameTime?: number

type

type: CreatureType

x

x: number

y

y: number

z

z: WorldZ

Accessors

asCorpse

  • get asCorpse(): undefined

  • Returns undefined

asCreature

  • get asCreature(): default

  • Returns default

asDoodad

  • get asDoodad(): undefined

  • Returns undefined

asEntity

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

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

asEntityMovable

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

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

asEntityWithStats

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

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

  • Returns Creature

facingTile

  • get facingTile(): default

  • Regular entities don't have a direction so this will be the same as getTile()

    Returns default

isFlying

  • get isFlying(): boolean

  • 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

  • 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

animateAttack

  • Parameters

    Returns void

animateBumpTowards

  • Faces the target and animates a bump into effect

    Parameters

    Returns void

animateSpawn

  • Returns void

canInspect

  • Parameters

    Returns boolean

canSeeObject

canSeePosition

  • Parameters

    • type: CanASeeBType
    • islandId: `${number},${number}`
    • x: number
    • y: number
    • z: number
    • fieldOfView: undefined | default = 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<number>

      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

    • target: undefined | default | default<number>

      Target thing to attack

    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

  • Parameters

    Returns undefined | default[]

getActiveStatuses

Protected getApplicableStatusEffects

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

  • Parameters

    Returns Defense

Protected getDescription

getEnemy

  • Gets the enemy the creature marked

    Returns

    Enemy

    Returns undefined | default | default<number>

getHitchingPostsAround

  • Returns IHitch

getInspectionId

  • Returns string

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

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

getStatuses

  • Generator for status effects on the entity.

    Returns default[]

hasAi

  • Parameters

    Returns boolean

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

humansVisible

increaseTamedCount

  • Returns void

increaseWaste

  • Parameters

    Returns void

initializeStats

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

    Parameters

    • hp: number
    • Optional maxhp: number

    Returns void

isHidden

  • Returns boolean

isNearby

isOnFire

isRetaliator

  • Returns boolean

isTamed

  • Returns boolean

isValid

  • Returns boolean

isWithinHumanBounds

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

    Returns boolean

moveTo

moveToIsland

  • Parameters

    Returns void

notifyItem

notifyStat

offer

  • Parameters

    Returns undefined | default

Protected onMovementCompleted

  • Returns void

Protected onStatChange

  • Parameters

    Returns void

onUnserialized

overrideNextMovement

processAttack

processSpecialAbilities

  • Parameters

    • enemy: undefined | default | default<number>
    • Optional bypass: boolean

    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

refreshStatusEffects

  • 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

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

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

      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

tame

  • Parameters

    • human: default<number>
    • bonus: number = 0

    Returns boolean

timesTamed

  • Returns the times a creature has been tamed.

    Returns

    number if the creature has been tamed and undefined if it has never been tamed.

    Returns undefined | number

toString

  • Returns string

unhitch

  • Returns void

update

  • Parameters

    Returns boolean

updateDirection

  • Faces the target tile

    Parameters

    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

    • tile: default
    • shouldBeHidden: boolean

    Returns void

Protected updateDoodadOverHiddenStateForCurrentTile

  • Parameters

    • hidden: boolean = false

    Returns void

updateRender

Protected updateTile

  • 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

Static is

  • Parameters

    • value: any

    Returns value is default

Settings

Member Visibility

Theme

Generated using TypeDoc