Interface IHumanOld

Hierarchy

Properties

allowSmartMovementClientside? anim? asCorpse asCreature asDoodad asEntity asEntityMovable asEntityWithStats asHuman asItem asLocalPlayer asNPC asPlayer asTileEvent attackAnimationTime? attackAnimationType? crafted? customization? deathBy? defense? defenses? description direction? entityType? equipEffects? equippedOffHandDisabled? equippedReferences? event? facingDirection? facingTile flyingDelay? fromX? fromY? handEquippedToLast? id? identifier? inventory? isConnecting? isFlying isMoving? isMovingSuppressVehicleClientside? island islandId? lastAttackedByReference? manualTickActionDelay? messages? moveType? movementCompleteZ? movementIntent? movingClientside? movingOptions? nextMoveDirection? nextMoveTime? notes? options? point preventRendering? quests? realTimeTickActionDelay? reference referenceId? renamed? respawnPoint? restData? score? shouldSkipNextMovement? skill? skills? stat? state? stats? status? swimming? tamedCreatures? ticksSpent? tile tileUpdateType? tilesAround turns? type? vehicleItemReference? walkPath? walkSoundCounter? x? y? z?

Methods

addDelay? addMilestone? addReferenceId? addTag? addTamedCreature? animateAttack? animateBumpTowards? applyTravelingEffects? burn? calculateDamageAmount? calculateEquipmentStats? canCombatTides? canInspect? canSailAway? canSailTo? canSeeObject? canSeePosition? canSeeTile? canSwapWith? cancelResting? capReputation? causeStatus? checkForGather? checkForGatherFire? checkForStill? checkForTargetInRange? checkForWell? checkUnder? clearTileCache? createItemInInventory? createMessageManager? createNoteManager? createQuestManager? createSkillManager? damage? damageByInteractingWith? damageRandomEquipment? discoverRecipe? discoverVulnOrResist? equip? extinguishTorches? findPathToPort? getActiveStatuses? getAsHuman? getAttack? getBarteringBonus? getBurnDamage? getCombatStrength? getConsumeBonus? getCraftingDifficulty? getDamage? getDamageModifier? getData? getDiscoveredVulnsAndResists? getEquipEffect? getEquipSlotForItem? getEquippedItem? getEquippedItems? getGameOptions? getGameOptionsBeforeModifiers? getInspectionId? getInsulation? getJumpTile? getMaxHealth? getMaxWeight? getMoveType? getMovementDelay? getMovementIntent? getMovementPoint? getMovementProgress? getName? getProducedTemperature? getQualityBonus? getReputation? getReputationMultiplier? getScaledWeight? getSimplifiedCumulativeAttack? getSkillBonus? getStaminaDelay? getStatus? getStatuses? getWeightOrStaminaMovementPenalty? getWeightStatus? hasData? hasDelay? hasDiscoveredVulnOrResist? hasStatus? hasTag? hasWalkPath? healthSyncCheck? humansVisible? hurtHands? incrementIslandTickCount? isDead? isDualWielding? isGhost? isHost? isLocalPlayer? isNearby? isOffHandDisabled? isOnFire? isResting? isRestingCancelled? isServer? isSwimming? isValid? isWithinHumanBounds? kill? loadOnIsland? loadUi? moveTo? moveToIslandId? moveToIslandPosition? moveTowardsIsland? notifyItem? notifyStat? overrideNextMovement? passTurn? processInput? queueSoundEffect? queueSoundEffectInFront? rangeAction? refreshStatusEffects? removeData? removeTag? removeTamedCreature? resetMovementIntent? resetStatTimers? setData? setHumansWithinBound? setMoveType? setName? setOptions? setPosition? setStatChangeTimerIgnoreDifficultyOptions? setStatus? setTamedCreatureEnemy? setVehicle? setWalkPath? setZ? skipNextMovement? skipNextUpdate? staminaReduction? startResting? tick? tickStatuses? toString? trampleFire? unequip? unequipAll? updateDirection? updateMovementIntent? updateRender? updateReputation? updateReputationForAttackingWithTamedCreature? updateStatsAndAttributes? updateStrength? updateSwimming? updateTablesAndWeight? updateVehicle? updateView? updateWeight?

Properties

Optional allowSmartMovementClientside

allowSmartMovementClientside?: boolean

Optional anim

anim?: number = 0

asCorpse

asCorpse: undefined

asCreature

asCreature: undefined

asDoodad

asDoodad: undefined

asEntity

asEntity: undefined | default<unknown, number, unknown, unknown>

asEntityMovable

asEntityMovable: undefined | default<unknown, number, unknown, unknown>

asEntityWithStats

asEntityWithStats: undefined | default<unknown, number, unknown>

asHuman

asHuman: undefined | default<number>

asItem

asItem: undefined

asLocalPlayer

asLocalPlayer: undefined | default

asNPC

asNPC: undefined | default

asPlayer

asPlayer: undefined | default

asTileEvent

asTileEvent: undefined

Optional attackAnimationTime

attackAnimationTime?: IMovementTime

Optional attackAnimationType

attackAnimationType?: DamageType

Optional crafted

crafted?: Record<number, ICrafted> = {}

Optional customization

customization?: ICustomizations

Optional deathBy

deathBy?: ISerializedTranslation = ...

Optional defense

defense?: default = ...

Optional defenses

defenses?: number[] = []

description

description: unknown

Optional direction

direction?: default = Vector2.ZERO

Optional Readonly Abstract entityType

entityType?: EntityType

Optional Readonly equipEffects

equipEffects?: Map<EquipEffect, EquipEffects> = ...

Optional equippedOffHandDisabled

equippedOffHandDisabled?: default

Optional equippedReferences

equippedReferences?: Map<EquipType, default> = ...

Optional event

event?: IEventEmitter<default<number>, IHumanEvents>

Optional facingDirection

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

facingTile

facingTile: undefined | default

Optional flyingDelay

flyingDelay?: number

Optional fromX

fromX?: number = 0

Note: This might not be a whole number.

Optional fromY

fromY?: number = 0

Note: This might not be a whole number.

Optional handEquippedToLast

handEquippedToLast?: MainHand | OffHand = EquipType.OffHand

Optional id

id?: number

Optional identifier

identifier?: string

Optional inventory

inventory?: IContainer = ...

Optional isConnecting

isConnecting?: boolean = false

isFlying

isFlying: undefined | boolean

Optional isMoving

isMoving?: boolean

Not guaranteed to be synced between the server and client for Human entities

Optional isMovingSuppressVehicleClientside

isMovingSuppressVehicleClientside?: boolean = false

Flag that will prevent a humans vehicle from showing up until the movement finishews

island

island: undefined | default

Optional islandId

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

Optional lastAttackedByReference

lastAttackedByReference?: Reference

Optional manualTickActionDelay

manualTickActionDelay?: number

Optional messages

messages?: IMessageManager

Optional moveType

moveType?: MoveType

Optional movementCompleteZ

movementCompleteZ?: number

Only used for Human entities

Optional Readonly movementIntent

movementIntent?: IMovementIntent = {}

Optional movingClientside

movingClientside?: MovingClientSide = MovingClientSide.NoInput

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

Optional movingOptions

movingOptions?: IMoveToOptions

Optional nextMoveDirection

nextMoveDirection?: None | East | North | West | South

Optional nextMoveTime

nextMoveTime?: number = 0

Optional notes

notes?: INoteManager

Optional options

options?: Readonly<IOptions> = ...

point

point: undefined | IVector3

Optional preventRendering

preventRendering?: boolean

Optional quests

quests?: IQuestManager

Optional realTimeTickActionDelay

realTimeTickActionDelay?: number = 0

reference

reference: undefined | Reference

Optional referenceId

referenceId?: number

Optional renamed

renamed?: string | ISerializedTranslation

Optional respawnPoint

respawnPoint?: IVector4

Optional restData

restData?: IRestData

Optional score

score?: number = 0

Optional shouldSkipNextMovement

shouldSkipNextMovement?: true

Optional skill

skill?: default

Optional skills

skills?: Record<SkillType, {
    bonus: number;
    core: number;
}>

Optional Readonly stat

stat?: default<default<number>> = ...

Optional state

state?: PlayerState = PlayerState.None

Optional stats

stats?: IStats

Optional status

status?: IStatus

Optional swimming

swimming?: boolean = false

Optional tamedCreatures

tamedCreatures?: Map<`${number},${number}`, Set<number>> = ...

Optional ticksSpent

ticksSpent?: Map<`${number},${number}`, number> = ...

tile

tile: undefined | default

Optional Readonly Abstract tileUpdateType

tileUpdateType?: TileUpdateType

tilesAround

tilesAround: undefined | default[]

Optional turns

turns?: number = 1

Optional type

type?: number

Optional vehicleItemReference

vehicleItemReference?: default

Optional walkPath

walkPath?: IWalkPath

Optional walkSoundCounter

walkSoundCounter?: number = 4

Optional x

x?: number

Optional y

y?: number

Optional z

z?: WorldZ

Methods

Optional addDelay

  • Parameters

    • delay: number
    • Optional replace: boolean
    • Optional addStaminaDelay: boolean

    Returns void

Optional Abstract addMilestone

  • Parameters

    • milestone: Milestone
    • Optional data: string | number
    • Optional update: boolean

    Returns void

Optional addReferenceId

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

    Returns void

Optional addTag

  • Parameters

    • tag: unknown

    Returns void

Optional addTamedCreature

  • Parameters

    Returns void

Optional animateAttack

  • Parameters

    Returns void

Optional animateBumpTowards

  • Faces the target and animates a bump into effect

    Parameters

    Returns void

Optional applyTravelingEffects

  • Applies traveling effects to the player

    • Loses stamina, hunger, and thirst
    • Damages spyglass, golden sextant, and boat if it's being used
    • Decays items in the player's inventory

    Parameters

    Returns void

Optional burn

  • Burn the player

    Parameters

    • fireType: FireType
    • skipMessage: boolean = false
    • Optional skipParry: boolean
    • Optional equipType: EquipType
    • Optional fromCombat: boolean
    • level: number = 1

    Returns undefined | number

Optional calculateDamageAmount

  • Parameters

    Returns number

Optional calculateEquipmentStats

  • Returns void

Optional canCombatTides

Optional canInspect

  • Parameters

    Returns boolean

Optional canSailAway

Optional canSailTo

  • Parameters

    • x: number
    • y: number

    Returns boolean

Optional canSeeObject

Optional canSeePosition

  • Parameters

    • type: CanASeeBType
    • islandId: `${number},${number}`
    • x: number
    • y: number
    • z: number
    • Optional fieldOfView: default
    • Optional customRadius: number

    Returns boolean

Optional canSeeTile

  • Parameters

    Returns boolean

Optional canSwapWith

  • Parameters

    • entity: default<unknown, number, unknown, unknown>
    • source: undefined | string

    Returns boolean

Optional cancelResting

  • Parameters

    Returns boolean

Optional capReputation

  • Returns void

Optional causeStatus

  • Parameters

    Returns void

Optional checkForGather

  • Returns undefined | default

Optional checkForGatherFire

  • Returns undefined | default

Optional checkForStill

  • Check if there is a still in front of the player.

    Parameters

    • Optional withWater: boolean

      Check if the still has water in it?

    • Optional isLit: boolean

      Check if the still is lit?

    Returns boolean

Optional checkForTargetInRange

  • Parameters

    • range: number
    • Optional includePlayers: boolean

    Returns IMobCheck

Optional checkForWell

  • Returns boolean

Optional checkUnder

Optional clearTileCache

  • Returns void

Optional createItemInInventory

Optional Abstract createMessageManager

  • Returns IMessageManager

Optional Abstract createNoteManager

  • Returns INoteManager

Optional Abstract createQuestManager

  • Returns IQuestManager

Optional createSkillManager

  • Returns default

Optional damage

  • Parameters

    Returns undefined | number

  • Deprecated

    provide a full IDamageInfo object yourself you lazy fiend

    Parameters

    • damageInfoOrAmount: number | IDamageInfo
    • Optional damageMessage: default | default
    • Optional soundDelay: number
    • Optional causesBlood: boolean
    • Optional statusEffect: default

    Returns undefined | number

Optional damageByInteractingWith

Optional damageRandomEquipment

  • Returns void

Optional discoverRecipe

  • Parameters

    • recipeType: ItemType
    • crafted: ICrafted = ...
    • Optional discoveredClientSide: boolean

    Returns void

Optional discoverVulnOrResist

  • Parameters

    Returns void

Optional equip

  • Parameters

    Returns boolean

Optional extinguishTorches

  • Extinguishes all torches the player is holding.

    Returns void

Optional findPathToPort

  • Parameters

    • portId: number
    • Optional options: Partial<{
          requireBoat: boolean;
          startReversed: boolean;
      }>

    Returns undefined | default[]

Optional getActiveStatuses

  • Generator for status effects on the entity.

    Returns default[]

Optional getAsHuman

  • Returns default<number>

Optional getAttack

Optional getBarteringBonus

  • Returns the bartering bonus for a given credit value

    Parameters

    • baseCredits: number

    Returns number

Optional getBurnDamage

  • Parameters

    Returns number

Optional getCombatStrength

  • Returns number

Optional getConsumeBonus

  • Parameters

    Returns number

Optional getCraftingDifficulty

  • Parameters

    Returns number

Optional getDamage

  • Parameters

    Returns number

Optional getDamageModifier

  • Returns number

Optional 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

Optional getDiscoveredVulnsAndResists

  • Returns Map<CreatureType, Set<DamageType>>

  • Parameters

    Returns Set<DamageType>

Optional getEquipEffect

  • Type Parameters

    Parameters

    • type: E

    Returns FirstIfOne<EquipEffectByType<E>>

Optional getEquipSlotForItem

  • Parameters

    • item: default
    • Optional includeDisabled: true

    Returns undefined | EquipType

Optional getEquippedItem

  • Parameters

    • slot: EquipType
    • Optional includeDisabled: true

    Returns undefined | default

Optional getEquippedItems

  • Parameters

    • Optional includeDisabled: true

    Returns default[]

Optional getGameOptions

Optional getGameOptionsBeforeModifiers

Optional getInspectionId

  • Returns string

Optional getInsulation

  • Parameters

    Returns number

Optional getJumpTile

  • Returns undefined | default

Optional getMaxHealth

  • Gets the max health of the player.

    Returns the result of the "getMaxHealth" event, or the max in Stat.Health, if the result of the hook is undefined.

    Parameters

    • withBonus: boolean = true

    Returns number

Optional getMaxWeight

  • Gets the strength of the player.

    Returns the result of Hook.GetPlayerStrength, or the max in Stat.Health, if the result of the hook is undefined.

    Used internally for Stat.Weight.max

    Returns number

Optional getMoveType

  • Returns MoveType

Optional getMovementDelay

  • Returns number

Optional getMovementIntent

Optional getMovementPoint

  • Parameters

    • timeStamp: number

    Returns IVector2

Optional getMovementProgress

  • Gets movement progress and moves the state machine forward when the movement is completed

    Parameters

    • timeStamp: number

    Returns number

Optional Abstract getName

  • Returns default

Optional getProducedTemperature

  • Returns undefined | number

Optional getQualityBonus

  • Parameters

    Returns number

Optional getReputation

  • Returns number

Optional getReputationMultiplier

  • Multiply the reputation amount with whatever is set via milestone modifiers or custom game options for this player.

    Returns

    A number or undefined if a reputation number was not passed.

    Parameters

    • reputation: undefined | number

      A number or undefined to be mutiplied.

    Returns undefined | number

Optional getScaledWeight

  • Gets this human's current carried weight, scaled down to what it would be without any weight bonuses applied

    Returns number

Optional getSimplifiedCumulativeAttack

  • Returns number

Optional getSkillBonus

  • Parameters

    Returns number

Optional getStaminaDelay

  • Gets a stamina penalty delay to be used for slowed actions and movement.

    Parameters

    • staminaToStartAddingDelayAt: number = STAMINA_LOW_PENALTY_START

      Stat value where delays start getting added from.

    Returns number

Optional getStatus

  • Returns the handler for this status effect, whether or not this entity currently has the effect.

    Type Parameters

    Parameters

    Returns undefined | S

Optional getStatuses

  • Generator for status effects on the entity.

    Returns default[]

Optional getWeightOrStaminaMovementPenalty

  • Returns number

Optional getWeightStatus

  • Returns WeightStatus

Optional 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

Optional hasDelay

  • Returns boolean

Optional hasDiscoveredVulnOrResist

  • Parameters

    Returns boolean

Optional hasStatus

  • Returns whether the entity has the given StatusType

    Parameters

    Returns number

Optional hasTag

  • Parameters

    • tag: unknown

    Returns boolean

Optional hasWalkPath

  • Returns boolean

Optional healthSyncCheck

  • Parameters

    • reason: string

    Returns void

Optional humansVisible

  • Returns default<number>[]

Optional hurtHands

  • Parameters

    Returns boolean

Optional incrementIslandTickCount

  • Returns void

Optional isDead

  • Returns boolean

Optional isDualWielding

  • Returns boolean

Optional isGhost

  • Returns boolean

Optional isHost

  • Returns boolean

Optional isLocalPlayer

  • Returns boolean

Optional isNearby

  • Parameters

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

    Returns boolean

Optional isOffHandDisabled

  • Returns boolean

Optional isOnFire

  • Returns FireType

Optional isResting

  • Returns boolean

Optional isRestingCancelled

  • Returns boolean

Optional isServer

  • Returns true if this is the special dedicated server player

    Returns boolean

Optional isSwimming

  • Gets if the human is swimming (and not on a boat)

    Returns boolean

Optional Abstract isValid

  • Returns boolean

Optional isWithinHumanBounds

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

    Returns boolean

Optional kill

  • Returns void

Optional loadOnIsland

  • Loads the player onto an island Called when the game is initially loading and moving a player to another island

    Parameters

    Returns void

Optional loadUi

  • Loads ui. Should only be called if this player is local

    Returns void

Optional moveTo

  • Parameters

    Returns boolean

Optional moveToIslandId

  • Moves this player to another island

    Parameters

    Returns Promise<void>

Optional moveToIslandPosition

  • Parameters

    Returns Promise<void>

Optional moveTowardsIsland

Optional notifyItem

Optional notifyStat

  • Parameters

    Returns void

Optional overrideNextMovement

  • Parameters

    Returns void

Optional passTurn

  • Parameters

    Returns void

Optional processInput

  • This is only ran on the server

    Parameters

    • timeStamp: number

    Returns undefined | IMovementIntent

Optional queueSoundEffect

  • Parameters

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

    Returns void

Optional queueSoundEffectInFront

  • Parameters

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

    Returns void

Optional rangeAction

  • Parameters

    Returns {
        actionRange: number;
        bonusRange: number;
        mobCheck: IMobCheck;
    }

    • actionRange: number
    • bonusRange: number
    • mobCheck: IMobCheck

Optional refreshStatusEffects

  • Returns void

Optional 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

Optional removeTag

  • Parameters

    • tag: unknown

    Returns void

Optional removeTamedCreature

  • Parameters

    Returns boolean

Optional resetMovementIntent

  • Returns void

Optional resetStatTimers

Optional setData

  • Sets a data

    Rturns

    The value

    Type Parameters

    • T

    Parameters

    • key: string

      Data key

    • value: T

      Data value

    Returns T

Optional setHumansWithinBound

  • Parameters

    Returns void

Optional setMoveType

  • Parameters

    Returns void

Optional setName

  • Parameters

    Returns void

Optional setOptions

  • Parameters

    Returns void

Optional setPosition

  • Parameters

    Returns void

Optional setStatChangeTimerIgnoreDifficultyOptions

  • Parameters

    • stat: Stat | IStat
    • timer: number
    • Optional amt: number

    Returns void

Optional setStatus

Optional setTamedCreatureEnemy

  • Parameters

    Returns void

Optional setVehicle

  • Parameters

    • item: undefined | default
    • Optional extinguishTorches: boolean

    Returns boolean

Optional setWalkPath

  • Parameters

    Returns void

Optional setZ

  • Parameters

    • z: number
    • allowCancelation: boolean = true
    • effects: boolean = true

      If true, adds a delay to the player, clears any particles, and updates the view. (Default: true)

    • updateFlowField: boolean = true

    Returns boolean

Optional skipNextMovement

  • Skips the next movement for this creature / npc

    Returns void

Optional skipNextUpdate

  • Skips the next update for this creature / npc

    Returns void

Optional staminaReduction

  • Parameters

    • Optional skill: SkillType
    • Optional level: number

    Returns void

Optional startResting

  • Parameters

    Returns void

Optional tick

  • Ticks a player

    Returns

    True if the game should tick after this

    Parameters

    • Optional isPassTurn: boolean
    • Optional turnType: TurnTypeFlag

    Returns boolean

Optional tickStatuses

  • Updates caused by status effects such as bleeding, poison, and burns.

    Returns void

Optional toString

  • Returns string

Optional trampleFire

  • Parameters

    Returns void

Optional unequip

  • Unequips an item. Note: This is safe to call even if the item isn't equipped. it'll do nothing in that case.

    Parameters

    • item: default
    • internal: boolean = false
    • skipMessage: boolean = false
    • skipRevertItem: boolean = false

    Returns void

Optional unequipAll

  • Returns void

Optional updateDirection

  • Parameters

    • tile: default
    • Optional updateVehicleDirection: boolean

    Returns void

Optional updateMovementIntent

  • Parameters

    Returns boolean

Optional updateRender

Optional updateReputation

  • Parameters

    • reputation: number

    Returns void

Optional updateReputationForAttackingWithTamedCreature

  • Parameters

    Returns void

Optional updateStatsAndAttributes

  • Returns void

Optional updateStrength

  • This needs to be called whenever the player's strength requires an update.

    Example usage includes:

    1. When max health changes. Max health is used in calculating the strength.
    2. If a mod is using the GetPlayerStrength hook and the calculation needs to be refreshed.

    Returns void

Optional updateSwimming

  • Returns void

Optional updateTablesAndWeight

  • Parameters

    • source: string

    Returns void

Optional updateVehicle

  • Returns void

Optional updateView

Optional updateWeight

  • Parameters

    • source: string

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc