Interface IHumanOld

Hierarchy

Partial<default>
- IHumanOld

Index

Properties

activeTurns? allowSmartMovementClientside? anim? asContainer asCorpse asCreature asDoodad asEntity asEntityMovable asEntityWithStats asGenericEntity asGenericHuman asHuman asItem asLoaded asLocalPlayer asNPC asNotLocalPlayer asPlayer asTile asTileEvent asUnion attackAnimationData? connectedVehicle connectedVehicleId? containedItems? containerType? crafted? cumulativeEvilCrafting? customization? days deathBy? defenses? description direction? entityType? equipEffects? equippedOffHandDisabled? equippedReferences? event? facingDirection? facingTile flyingDelay? fromTile fromX? fromY? handEquippedToLast? highestAttack? highestDefense? historicalActions? humansVisible id? identifier? inventory? invocations? isConnecting? isDead isFlying isGhost isHost isLoaded isLocalPlayer isMoving? isMovingSuppressVehicleClientside? isOnFire isResting isRestingCancelled isServer isSwimming isValid isWalkingTo isWithinHumanBounds island islandId? lastAttackedByEntity lastAttackedByEntityHuman lastAttackedByReference? lastGainedStat? lastReceivedRune? luck maelstromLevel manualTickActionDelay? messages? moveType? movementCompleteZ? movementIntent? movingData? nextMoveDirection? nextMoveTime? notes? options? persistentMarker? point preventRendering? quests? realTimeTickActionDelay? reference referenceId? renamed? respawnPoint? restData? score? shouldSkipNextMovement? skill? skills? slippingData sort? sortDirection? stat? state? stats? status? tamedCreatures? ticksSpent? tile tileUpdateType? tilesAround turns? type? vehicleItemReference? walkSoundCounter? walkToInProgress? x? y? z?

Methods

addDelay? addMarkerIcon? addMilestone? addReferenceId? addTag? addTamedCreature? animate? animateAttack? animateBumpTowards? applyTravelingEffects? asNot? asType? burn? calculateDamageAmount? calculateEquipmentStats? canCombatTides? canInspect? canSailAway? canSailTo? canSeeObject? canSeePosition? canSeeTile? canSwapWith? cancelResting? causeStatus? checkForGather? checkForGatherFire? checkForStill? checkForTargetInRange? checkForWell? checkUnder? clearTileCache? cloneItemIntoInventory? computeLights? connectVehicle? createFire? createItemInInventory? createMessageManager? createNoteManager? createQuestManager? createSkillManager? damage? damageByInteractingWith? damageRandomEquipment? disconnectVehicle? discoverRecipe? discoverRecipes? discoverVulnOrResist? ensureDelay? equip? extinguishTorchesIfSwimming? faceDirection? findPathToPort? getActiveStatuses? getAsHuman? getAttack? getBarteringBonus? getBurnDamage? getCombatStrength? getConsumeBonus? getCraftingDifficulty? getCurse? getDamage? getDamageModifier? getData? getDefense? getDiscoveredVulnsAndResists? getEquipEffect? getEquipSlotForItem? getEquippedItem? getEquippedItems? getEquippedUseBenefits? getGameOptions? getGameOptionsBeforeModifiers? getInsulation? getJumpTile? getMaxHealth? getMaxWeight? getMoveType? getMovementDelay? getMovementIntent? getMovementPoint? getMovementProgress? getName? getProducedTemperature? getQualityBonus? getRangedAccuracy? getRangedSkillBonus? getScaledWeight? getSimplifiedCumulativeAttack? getSimplifiedCumulativeDefense? getSkillBonus? getStaminaDelay? getStatus? getStatusLevel? getStatuses? getVehicle? getWanderChance? getWanderHomePoint? getWanderHomeRadius? getWanderIdleChance? getWanderNewDirectionChance? getWeightOrStaminaMovementPenalty? getWeightStatus? giveRune? hasData? hasDelay? hasDiscoveredVulnOrResist? hasStatus? hasTag? healthSyncCheck? hurtHands? incrementIslandTickCount? isContainer? isCorpse? isCreature? isDoodad? isDualWielding? isEntity? isHuman? isItem? isNPC? isNearby? isOffHandDisabled? isPlayer? isTile? isTileEvent? isVehicleAllowedOnTile? kill? loadOnIsland? loadUi? moveTo? moveToIslandId? moveToIslandPosition? moveTowardsIsland? notifyItem? notifyStat? overrideNextMovement? passTurn? processInput? queueSoundEffect? queueSoundEffectInFront? rangeAction? refreshStatuses? removeData? removeMarkerIcon? removeTag? removeTamedCreature? resetChangeTimers? resetMovementIntent? resetStatTimers? setData? setHumansWithinBound? setMoveType? setName? setOptions? setPosition? setStatChangeTimerIgnoreDifficultyOptions? setStatus? setTamedCreatureEnemy? setVehicle? setZ? skipNextMovement? skipNextUpdate? staminaReduction? startResting? startSlipping? stopSlipping? tick? tickStatuses? toString? unequip? unequipAll? updateDirection? updateMovementIntent? updateRender? updateSlipping? updateStatsAndAttributes? updateStrength? updateSwimming? updateTablesAndWeight? updateVehicle? updateView? updateWalkTo? updateWeight? updateWorldTile? waitForWalkTo? walkToEntity? walkToTile?

Properties

`Optional` activeTurns

activeTurns?: number = ...

`Optional` allowSmartMovementClientside

allowSmartMovementClientside?: boolean

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

`Optional` anim

anim?: number = 0

asContainer

asContainer: undefined | default<unknown, number, NPC | Player> & IUncastableContainer

asCorpse

asCorpse: undefined

asCreature

asCreature: undefined

asDoodad

asDoodad: undefined

asEntity

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

asEntityMovable

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

asEntityWithStats

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

asGenericEntity

asGenericEntity: undefined | default<unknown, number, EntityReferenceTypes, unknown>

asGenericHuman

asGenericHuman: undefined | default<unknown, number, NPC | Player>

asHuman

asHuman: undefined | default<unknown, number, NPC | Player>

asItem

asItem: undefined

asLoaded

asLoaded: undefined | default<unknown, number, NPC | Player>

asLocalPlayer

asLocalPlayer: undefined | default

asNPC

asNPC: undefined | default

asNotLocalPlayer

asNotLocalPlayer: undefined | default<unknown, number, NPC | Player>

asPlayer

asPlayer: undefined | default

asTile

asTile: undefined

asTileEvent

asTileEvent: undefined

asUnion

`Optional` attackAnimationData

attackAnimationData?: IAttackAnimationData

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

connectedVehicle

connectedVehicle: undefined | default

`Optional` connectedVehicleId

connectedVehicleId?: number

`Optional` containedItems

containedItems?: default[] = []

`Optional` containerType

containerType?: ContainerType

`Optional` crafted

crafted?: SaferNumberIndexedObject<ICrafted> = {}

`Optional` cumulativeEvilCrafting

cumulativeEvilCrafting?: number = 0

`Optional` customization

customization?: ICustomizations

days

days: undefined | number

`Optional` deathBy

deathBy?: ISerializedTranslation = ...

`Optional` defenses

defenses?: number[] = []

description

description: undefined | Readonly<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<unknown, number, NPC | Player>, IHumanEvents>

`Optional` facingDirection

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

facingTile

facingTile: undefined | default

`Optional` flyingDelay

flyingDelay?: number

fromTile

fromTile: undefined | default

`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` highestAttack

highestAttack?: number

`Optional` highestDefense

highestDefense?: number

`Optional` historicalActions

historicalActions?: PartialRecord<ActionType, number>

humansVisible

humansVisible: undefined | default<unknown, number, NPC | Player>[]

`Optional` id

id?: number

`Optional` identifier

identifier?: string

`Optional` `Readonly` inventory

inventory?: IContainer = ...

Deprecated

(use the entity itself)

`Optional` invocations

invocations?: PartialRecord<ItemType, number>

`Optional` isConnecting

isConnecting?: boolean = false

isDead

isDead: undefined | boolean

isFlying

isFlying: undefined | boolean

isGhost

isGhost: undefined | boolean

isHost

isHost: undefined | boolean

isLoaded

isLoaded: undefined | boolean

isLocalPlayer

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

isOnFire

isOnFire: undefined | FireType

isResting

isResting: undefined | boolean

isRestingCancelled

isRestingCancelled: undefined | boolean

isServer

isServer: undefined | boolean

isSwimming

isSwimming: undefined | boolean

isValid

isValid: undefined | boolean

isWalkingTo

isWalkingTo: undefined | boolean

isWithinHumanBounds

isWithinHumanBounds: undefined | boolean

island

island: undefined | default

`Optional` islandId

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

lastAttackedByEntity

lastAttackedByEntityHuman

lastAttackedByEntityHuman: undefined | default<unknown, number, NPC | Player>

`Optional` lastAttackedByReference

lastAttackedByReference?: Reference

`Optional` lastGainedStat

lastGainedStat?: Stat

`Optional` lastReceivedRune

lastReceivedRune?: Deity

luck

luck: undefined | number

maelstromLevel

maelstromLevel: undefined | number

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

movingData?: IMovingData = {}

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

`Optional` nextMoveDirection

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

`Optional` nextMoveTime

nextMoveTime?: number = 0

`Optional` notes

notes?: INoteManager

`Optional` options

options?: ImmutableObject<IOptions> = ...

`Optional` persistentMarker

persistentMarker?: {
guid: string;
type: Tamed;
}

Notifier marker assigned to this entity

Type declaration

guid: string
type: Tamed

point

point: undefined | IVector3

`Optional` preventRendering

preventRendering?: boolean

`Optional` quests

quests?: IQuestManager

`Optional` realTimeTickActionDelay

realTimeTickActionDelay?: number = 0

reference

reference: undefined | [id: number, type: NPC, context?: ReferenceContext, islandId?: `${number},${number}`, objectId?: number] | [id: number, type: Player, context?: ReferenceContext, islandId?: `${number},${number}`, objectId?: number]

`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;
}>

slippingData

slippingData: undefined | ISlippingData

`Optional` sort

sort?: ContainerSort

`Optional` sortDirection

sortDirection?: SortDirection

`Optional` `Readonly` stat

stat?: default<default<unknown, number, NPC | Player>> = ...

`Optional` state

state?: PlayerState = PlayerState.None

`Optional` stats

stats?: IStats

`Optional` status

status?: IStatus

`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` walkSoundCounter

walkSoundCounter?: number = 4

`Optional` walkToInProgress

walkToInProgress?: IWalkToPathInProgress

`Optional` x

x?: number

`Optional` y

y?: number

`Optional` z

z?: WorldZ

Methods

`Optional` addDelay

addDelay(delay: number, replace?: boolean, addStaminaDelay?: boolean, cap?: number): void
Parameters
- delay: number
- Optional replace: boolean
- Optional addStaminaDelay: boolean
- cap: number = Infinity
Returns void
Inherited from Partial.addDelay
- Defined in src/game/game/entity/Human.ts:2793

`Optional` addMarkerIcon

addMarkerIcon(type: Tamed): void
Parameters
- type: Tamed
Returns void
Inherited from Partial.addMarkerIcon
- Defined in src/game/game/entity/Entity.ts:248

`Optional` `Abstract` addMilestone

addMilestone(milestone: Milestone, data?: string | number, update?: boolean): void
Parameters
- milestone: Milestone
- Optional data: string | number
- Optional update: boolean
Returns void
Inherited from Partial.addMilestone
- Defined in src/game/game/entity/Human.ts:285

`Optional` addReferenceId

addReferenceId(): void
Adds a referenceId to the entity if it doesn't already have one

Returns void
Inherited from Partial.addReferenceId
- Defined in src/game/game/entity/Entity.ts:137

`Optional` addTag

addTag(tag: unknown): void
Parameters
- tag: unknown
Returns void
Inherited from Partial.addTag
- Defined in src/game/game/entity/Entity.ts:299

`Optional` addTamedCreature

addTamedCreature(creature: default): void
Parameters
- creature: default
Returns void
Inherited from Partial.addTamedCreature
- Defined in src/game/game/entity/Human.ts:1086

`Optional` animate

animate(fromX: number, fromY: number, toX: number, toY: number, delay: Delay): void
Animates the entity between a specific set of positions
Parameters
- fromX: number
- fromY: number
- toX: number
- toY: number
- delay: Delay
Returns void
Inherited from Partial.animate
- Defined in src/game/game/entity/EntityMovable.ts:431

`Optional` animateAttack

animateAttack(damageType: undefined | DamageType[]): void
Parameters
- damageType: undefined | DamageType[]
Returns void
Inherited from Partial.animateAttack
- Defined in src/game/game/entity/EntityMovable.ts:481

`Optional` animateBumpTowards

animateBumpTowards(tile: default): void
Faces the target and animates a bump into effect
Parameters
- tile: default
Returns void
Inherited from Partial.animateBumpTowards
- Defined in src/game/game/entity/EntityMovable.ts:422

`Optional` applyTravelingEffects

applyTravelingEffects(voyage: IVoyageInfo): void
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
- voyage: IVoyageInfo
Returns void
Inherited from Partial.applyTravelingEffects
- Defined in src/game/game/entity/Human.ts:4005

`Optional` asNot

asNot(entity: default<unknown, number, EntityReferenceTypes, unknown>): undefined | default<unknown, number, NPC | Player>
Parameters
- entity: default<unknown, number, EntityReferenceTypes, unknown>
Returns undefined | default<unknown, number, NPC | Player>
Inherited from Partial.asNot
- Defined in src/game/game/entity/Entity.ts:410

`Optional` asType

asType(type: number): undefined | default<unknown, number, NPC | Player>
Parameters
- type: number
Returns undefined | default<unknown, number, NPC | Player>
Inherited from Partial.asType
- Defined in src/game/game/entity/Entity.ts:418

`Optional` burn

burn(fireType: FireType, skipMessage?: boolean, skipParry?: boolean, equipType?: EquipType, fromCombat?: boolean, level?: number, thing?: default | default): undefined | number
Burn the player/NPC
Parameters
- fireType: FireType
- skipMessage: boolean = false
- Optional skipParry: boolean
- Optional equipType: EquipType
- Optional fromCombat: boolean
- level: number = 1
- Optional thing: default | default
Returns undefined | number
Inherited from Partial.burn
- Defined in src/game/game/entity/Human.ts:2015

`Optional` calculateDamageAmount

calculateDamageAmount(attackType: AttackType, weapon?: default, ammoItem?: default): number
Parameters
- attackType: AttackType
- Optional weapon: default
- Optional ammoItem: default
Returns number
Inherited from Partial.calculateDamageAmount
- Defined in src/game/game/entity/Human.ts:1135

`Optional` calculateEquipmentStats

calculateEquipmentStats(): void
Returns void
Inherited from Partial.calculateEquipmentStats
- Defined in src/game/game/entity/Human.ts:2968

`Optional` canCombatTides

canCombatTides(): true | ActionSailToIslandCannotUseNotEnoughStamina | ActionSailToIslandCannotUseNotEnoughSwimmingSkill
Returns true | ActionSailToIslandCannotUseNotEnoughStamina | ActionSailToIslandCannotUseNotEnoughSwimmingSkill
Inherited from Partial.canCombatTides
- Defined in src/game/game/entity/Human.ts:3930

`Optional` canInspect

canInspect(human: default<unknown, number, NPC | Player>): boolean
Parameters
- human: default<unknown, number, NPC | Player>
Returns boolean
Inherited from Partial.canInspect
- Defined in src/game/game/entity/Entity.ts:288

`Optional` canSailAway

canSailAway(): ICanSailAwayResult
Returns ICanSailAwayResult
Inherited from Partial.canSailAway
- Defined in src/game/game/entity/Human.ts:3891

`Optional` canSailTo

canSailTo(x: number, y: number): boolean
Parameters
- x: number
- y: number
Returns boolean
Inherited from Partial.canSailTo
- Defined in src/game/game/entity/Human.ts:3925

`Optional` canSeeObject

canSeeObject(type: CanASeeBType, object: IRendererOrigin, fieldOfView?: FieldOfView, customRadius?: number): boolean
Parameters
- type: CanASeeBType
- object: IRendererOrigin
- Optional fieldOfView: FieldOfView
- Optional customRadius: number
Returns boolean
Inherited from Partial.canSeeObject
- Defined in src/game/game/entity/EntityMovable.ts:167

`Optional` canSeePosition

canSeePosition(type: CanASeeBType, islandId: `${number},${number}`, x: number, y: number, z: number, fieldOfView?: FieldOfView, customRadius?: number): boolean
Parameters
- type: CanASeeBType
- islandId: `${number},${number}`
- x: number
- y: number
- z: number
- Optional fieldOfView: FieldOfView
- Optional customRadius: number
Returns boolean
Inherited from Partial.canSeePosition
- Defined in src/game/game/entity/Human.ts:1405

`Optional` canSeeTile

canSeeTile(type: CanASeeBType, tile: default, fieldOfView?: FieldOfView, customRadius?: number): boolean
Parameters
- type: CanASeeBType
- tile: default
- Optional fieldOfView: FieldOfView
- Optional customRadius: number
Returns boolean
Inherited from Partial.canSeeTile
- Defined in src/game/game/entity/EntityMovable.ts:176

`Optional` canSwapWith

canSwapWith(entity: default<unknown, number, EntityReferenceTypes, unknown>, source: undefined | string): boolean
Parameters
- entity: default<unknown, number, EntityReferenceTypes, unknown>
- source: undefined | string
Returns boolean
Inherited from Partial.canSwapWith
- Defined in src/game/game/entity/EntityMovable.ts:553

`Optional` cancelResting

cancelResting(reason: RestCancelReason): boolean
Parameters
- reason: RestCancelReason
Returns boolean
Inherited from Partial.cancelResting
- Defined in src/game/game/entity/Human.ts:1020

`Optional` causeStatus

causeStatus(thing: default | default, equipForProtection?: EquipType): void
Parameters
- thing: default | default
- Optional equipForProtection: EquipType
Returns void
Inherited from Partial.causeStatus
- Defined in src/game/game/entity/Human.ts:3677

`Optional` checkForGather

checkForGather(): undefined | default
Returns undefined | default
Inherited from Partial.checkForGather
- Defined in src/game/game/entity/Human.ts:2947

`Optional` checkForGatherFire

checkForGatherFire(): undefined | default
Returns undefined | default
Inherited from Partial.checkForGatherFire
- Defined in src/game/game/entity/Human.ts:2873

`Optional` checkForStill

checkForStill(withWater?: boolean, isLit?: boolean): boolean
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
Inherited from Partial.checkForStill
- Defined in src/game/game/entity/Human.ts:2908

`Optional` checkForTargetInRange

checkForTargetInRange(towardsTile: undefined | default, range: number, accuracy: undefined | number, includePlayers?: boolean): IMobCheck
Parameters
- towardsTile: undefined | default
- range: number
- accuracy: undefined | number
- Optional includePlayers: boolean
Returns IMobCheck
Inherited from Partial.checkForTargetInRange
- Defined in src/game/game/entity/Human.ts:1972
checkForTargetInRange(towardsTile: undefined | default, range: number, accuracy: undefined | number, includePlayers: undefined | boolean, clientSide: true): IMobCheck[]
Parameters
- towardsTile: undefined | default
- range: number
- accuracy: undefined | number
- includePlayers: undefined | boolean
- clientSide: true
Returns IMobCheck[]
Inherited from Partial.checkForTargetInRange
- Defined in src/game/game/entity/Human.ts:1973

`Optional` checkForWell

checkForWell(): boolean
Returns boolean
Inherited from Partial.checkForWell
- Defined in src/game/game/entity/Human.ts:2927

`Optional` checkUnder

checkUnder(inFacingDirection?: boolean, options?: ICheckUnderOptions): ICheckUnderOptions
Parameters
- Optional inFacingDirection: boolean
- options: ICheckUnderOptions = {}
Returns ICheckUnderOptions
Inherited from Partial.checkUnder
- Defined in src/game/game/entity/Human.ts:2232

`Optional` clearTileCache

clearTileCache(): void
Returns void
Inherited from Partial.clearTileCache
- Defined in src/game/game/entity/Entity.ts:182

`Optional` cloneItemIntoInventory

cloneItemIntoInventory(itemToClone: default, itemType?: ItemType): default
Parameters
- itemToClone: default
- itemType: ItemType = itemToClone.type
Returns default
Inherited from Partial.cloneItemIntoInventory
- Defined in src/game/game/entity/Human.ts:1118

`Optional` computeLights

computeLights(): void
Recompute lights around the human

Returns void
Inherited from Partial.computeLights
- Defined in src/game/game/entity/Human.ts:4833

`Optional` connectVehicle

connectVehicle(vehicle: default): void
Parameters
- vehicle: default
Returns void
Inherited from Partial.connectVehicle
- Defined in src/game/game/entity/Human.ts:4684

`Optional` createFire

createFire(tile: default): undefined | default
Creates a fire at a given tile and assigns the player as its creator.
Parameters
- tile: default
Returns undefined | default
Inherited from Partial.createFire
- Defined in src/game/game/entity/Human.ts:4745

`Optional` createItemInInventory

createItemInInventory(itemType: ItemType | ItemTypeGroup | (ItemType | ItemTypeGroup)[], quality?: Quality, context?: default): default
Parameters
- itemType: ItemType | ItemTypeGroup | (ItemType | ItemTypeGroup)[]
- Optional quality: Quality
- Optional context: default
Returns default
Inherited from Partial.createItemInInventory
- Defined in src/game/game/entity/Human.ts:1113

`Optional` `Abstract` createMessageManager

createMessageManager(): IMessageManager
Returns IMessageManager
Inherited from Partial.createMessageManager
- Defined in src/game/game/entity/Human.ts:283

`Optional` `Abstract` createNoteManager

createNoteManager(): INoteManager
Returns INoteManager
Inherited from Partial.createNoteManager
- Defined in src/game/game/entity/Human.ts:282

`Optional` `Abstract` createQuestManager

createQuestManager(): IQuestManager
Returns IQuestManager
Inherited from Partial.createQuestManager
- Defined in src/game/game/entity/Human.ts:284

`Optional` createSkillManager

createSkillManager(): default
Returns default
Inherited from Partial.createSkillManager
- Defined in src/game/game/entity/Human.ts:287

`Optional` damage

damage(damageInfo: IDamageInfo, causesBlood?: boolean): undefined | number
Parameters
- damageInfo: IDamageInfo
- causesBlood: boolean = true
Returns undefined | number
Inherited from Partial.damage
- Defined in src/game/game/entity/Human.ts:1326

`Optional` damageByInteractingWith

damageByInteractingWith(thing: default | default, options?: ICheckUnderOptions, damageLocation: EquipType): ICheckUnderOptions
Parameters
- thing: default | default
- options: ICheckUnderOptions = {}
- damageLocation: EquipType
Returns ICheckUnderOptions
Inherited from Partial.damageByInteractingWith
- Defined in src/game/game/entity/Human.ts:2344

`Optional` damageRandomEquipment

damageRandomEquipment(): void
Returns void
Inherited from Partial.damageRandomEquipment
- Defined in src/game/game/entity/Human.ts:1124

`Optional` disconnectVehicle

disconnectVehicle(animate?: boolean): void
Parameters
- animate: boolean = true
Returns void
Inherited from Partial.disconnectVehicle
- Defined in src/game/game/entity/Human.ts:4709

`Optional` discoverRecipe

discoverRecipe(recipeType: ItemType, crafted?: ICrafted, discoveredClientSide?: boolean, emit?: boolean): void
Parameters
- recipeType: ItemType
- crafted: ICrafted = ...
- Optional discoveredClientSide: boolean
- emit: boolean = true
Returns void
Inherited from Partial.discoverRecipe
- Defined in src/game/game/entity/Human.ts:3153

`Optional` discoverRecipes

discoverRecipes(recipes: [recipeType: ItemType, crafted: ICrafted][], discoveredClientSide?: boolean): void
Parameters
- recipes: [recipeType: ItemType, crafted: ICrafted][]
- Optional discoveredClientSide: boolean
Returns void
Inherited from Partial.discoverRecipes
- Defined in src/game/game/entity/Human.ts:3143

`Optional` discoverVulnOrResist

discoverVulnOrResist(creatureType: CreatureType, damageType: DamageType): void
Parameters
- creatureType: CreatureType
- damageType: DamageType
Returns void
Inherited from Partial.discoverVulnOrResist
- Defined in src/game/game/entity/Human.ts:4663

`Optional` ensureDelay

ensureDelay(delay: number): void
Parameters
- delay: number
Returns void
Inherited from Partial.ensureDelay
- Defined in src/game/game/entity/Human.ts:2826

`Optional` equip

equip(item: default, slot: EquipType, internal?: boolean, skipRevertItem?: boolean): boolean
Parameters
- item: default
- slot: EquipType
- internal: boolean = false
- skipRevertItem: boolean = false
Returns boolean
Inherited from Partial.equip
- Defined in src/game/game/entity/Human.ts:2463

`Optional` extinguishTorchesIfSwimming

extinguishTorchesIfSwimming(): void
Extinguishes all torches the player is holding of they are swimming.

Returns void
Inherited from Partial.extinguishTorchesIfSwimming
- Defined in src/game/game/entity/Human.ts:1926

`Optional` faceDirection

faceDirection(direction: default<unknown, number, EntityReferenceTypes, unknown> | East | North | West | South): Promise<boolean>
Parameters
- direction: default<unknown, number, EntityReferenceTypes, unknown> | East | North | West | South
Returns Promise<boolean>
Inherited from Partial.faceDirection
- Defined in src/game/game/entity/Human.ts:1437

`Optional` findPathToPort

findPathToPort(portId: number, options?: Partial<{
requireBoat: boolean;
startReversed: boolean;
}>): undefined | default[]
Parameters
- portId: number
- Optional options: Partial<{
  requireBoat: boolean;
  startReversed: boolean;
  }>
Returns undefined | default[]
Inherited from Partial.findPathToPort
- Defined in src/game/game/entity/Human.ts:1030

`Optional` getActiveStatuses

getActiveStatuses(): default[]
Generator for status effects on the entity.

Returns default[]
Inherited from Partial.getActiveStatuses
- Defined in src/game/game/entity/EntityWithStats.ts:169

`Optional` getAsHuman

getAsHuman(): default<unknown, number, NPC | Player>
Returns default<unknown, number, NPC | Player>
Inherited from Partial.getAsHuman
- Defined in src/game/game/entity/Human.ts:3816

`Optional` getAttack

getAttack(attack?: AttackType, weapon?: default): IAttack
Parameters
- Optional attack: AttackType
- Optional weapon: default
Returns IAttack
Inherited from Partial.getAttack
- Defined in src/game/game/entity/Human.ts:1189

`Optional` getBarteringBonus

getBarteringBonus(baseCredits: number): number
Returns the bartering bonus for a given credit value
Parameters
- baseCredits: number
Returns number
Inherited from Partial.getBarteringBonus
- Defined in src/game/game/entity/Human.ts:4146

`Optional` getBurnDamage

getBurnDamage(fireType: FireType, skipParry?: boolean, equipType?: EquipType): number
Parameters
- fireType: FireType
- Optional skipParry: boolean
- Optional equipType: EquipType
Returns number
Inherited from Partial.getBurnDamage
- Defined in src/game/game/entity/Human.ts:1986

`Optional` getCombatStrength

getCombatStrength(): number
Returns number
Inherited from Partial.getCombatStrength
- Defined in src/game/game/entity/Human.ts:1287

`Optional` getConsumeBonus

getConsumeBonus(item: undefined | default, skillUse?: SkillType): number
Parameters
- item: undefined | default
- Optional skillUse: SkillType
Returns number
Inherited from Partial.getConsumeBonus
- Defined in src/game/game/entity/Human.ts:2844

`Optional` getCraftingDifficulty

getCraftingDifficulty(level: RecipeLevel): number
Parameters
- level: RecipeLevel
Returns number
Inherited from Partial.getCraftingDifficulty
- Defined in src/game/game/entity/Human.ts:1424

`Optional` getCurse

getCurse(): number
Returns number
Inherited from Partial.getCurse
- Defined in src/game/game/entity/Human.ts:1401

`Optional` getDamage

getDamage(causesDamage: ICausesDamage, equipType?: EquipType): number
Parameters
- causesDamage: ICausesDamage
- Optional equipType: EquipType
Returns number
Inherited from Partial.getDamage
- Defined in src/game/game/entity/Human.ts:3562

`Optional` getDamageModifier

getDamageModifier(): number
Returns number
Inherited from Partial.getDamageModifier
- Defined in src/game/game/entity/Human.ts:1131

`Optional` getData

getData<T>(key: string): undefined | T
Gets a data

Returns
Data value or undefined if it wasn't found
Type Parameters
- T
Parameters
- key: string
  
  Data key
Returns undefined | T
Inherited from Partial.getData
- Defined in src/game/game/entity/Entity.ts:342

`Optional` getDefense

getDefense(): default
Returns default
Inherited from Partial.getDefense
- Defined in src/game/game/entity/Human.ts:366

`Optional` getDiscoveredVulnsAndResists

getDiscoveredVulnsAndResists(): Map<CreatureType, Set<DamageType>>
Returns Map<CreatureType, Set<DamageType>>
Inherited from Partial.getDiscoveredVulnsAndResists
- Defined in src/game/game/entity/Human.ts:4668
getDiscoveredVulnsAndResists(creatureType: CreatureType): Set<DamageType>
Parameters
- creatureType: CreatureType
Returns Set<DamageType>
Inherited from Partial.getDiscoveredVulnsAndResists
- Defined in src/game/game/entity/Human.ts:4669

`Optional` getEquipEffect

getEquipEffect<E>(type: E): FirstIfOne<EquipEffectByType<E>>
Type Parameters
- E extends EquipEffect
Parameters
- type: E
Returns FirstIfOne<EquipEffectByType<E>>
Inherited from Partial.getEquipEffect
- Defined in src/game/game/entity/Human.ts:395

`Optional` getEquipSlotForItem

getEquipSlotForItem(item: default, includeDisabled?: true): undefined | EquipType
Parameters
- item: default
- Optional includeDisabled: true
Returns undefined | EquipType
Inherited from Partial.getEquipSlotForItem
- Defined in src/game/game/entity/Human.ts:1387

`Optional` getEquippedItem

getEquippedItem(slot: EquipType, includeDisabled?: true): undefined | default
Parameters
- slot: EquipType
- Optional includeDisabled: true
Returns undefined | default
Inherited from Partial.getEquippedItem
- Defined in src/game/game/entity/Human.ts:1374

`Optional` getEquippedItems

getEquippedItems(includeDisabled?: true): default[]
Parameters
- Optional includeDisabled: true
Returns default[]
Inherited from Partial.getEquippedItems
- Defined in src/game/game/entity/Human.ts:1359

`Optional` getEquippedUseBenefits

getEquippedUseBenefits(stat: Stat): undefined | {
amount: number;
items: default[];
}
Gets the use benefits for all equipped items.

Returns
number that is the bonus amount the player recieves when consuming.
Parameters
- stat: Stat
  
  to check use benefits for.
Returns undefined | {
amount: number;
items: default[];
}
Inherited from Partial.getEquippedUseBenefits
- Defined in src/game/game/entity/Human.ts:1335

`Optional` getGameOptions

getGameOptions(): ImmutableObject<IGameOptionsPlayer>
Returns ImmutableObject<IGameOptionsPlayer>
Inherited from Partial.getGameOptions
- Defined in src/game/game/entity/Human.ts:374

`Optional` getGameOptionsBeforeModifiers

getGameOptionsBeforeModifiers(): ImmutableObject<IGameOptionsPlayer>
Returns ImmutableObject<IGameOptionsPlayer>
Inherited from Partial.getGameOptionsBeforeModifiers
- Defined in src/game/game/entity/Human.ts:370

`Optional` getInsulation

getInsulation(type: TempType): number
Parameters
- type: TempType
Returns number
Inherited from Partial.getInsulation
- Defined in src/game/game/entity/Human.ts:4159

`Optional` getJumpTile

getJumpTile(): undefined | default
Returns undefined | default
Inherited from Partial.getJumpTile
- Defined in src/game/game/entity/Human.ts:2748

`Optional` getMaxHealth

getMaxHealth(withBonus?: boolean): number
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
Inherited from Partial.getMaxHealth
- Defined in src/game/game/entity/Human.ts:1419

`Optional` getMaxWeight

getMaxWeight(): number
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
Inherited from Partial.getMaxWeight
- Defined in src/game/game/entity/Human.ts:4645

`Optional` getMoveType

getMoveType(): MoveType
Returns MoveType
Inherited from Partial.getMoveType
- Defined in src/game/game/entity/EntityMovable.ts:545

`Optional` getMovementDelay

getMovementDelay(): number
Returns number
Inherited from Partial.getMovementDelay
- Defined in src/game/game/entity/Human.ts:1433

`Optional` getMovementIntent

getMovementIntent(): IMovementIntent
Note: This is usually only ran on the server

Returns IMovementIntent
Inherited from Partial.getMovementIntent
- Defined in src/game/game/entity/Human.ts:2147

`Optional` getMovementPoint

getMovementPoint(timeStamp: number): IVector2
Parameters
- timeStamp: number
Returns IVector2
Inherited from Partial.getMovementPoint
- Defined in src/game/game/entity/EntityMovable.ts:497

`Optional` getMovementProgress

getMovementProgress(timeStamp: number): number
Gets movement progress and moves the state machine forward when the movement is completed
Parameters
- timeStamp: number
Returns number
Inherited from Partial.getMovementProgress
- Defined in src/game/game/entity/EntityMovable.ts:510

`Optional` `Abstract` getName

getName(): default
Returns default
Inherited from Partial.getName
- Defined in src/game/game/entity/Entity.ts:143

`Optional` getProducedTemperature

getProducedTemperature(): undefined | number
Returns undefined | number
Inherited from Partial.getProducedTemperature
- Defined in src/game/game/entity/Human.ts:4150

`Optional` getQualityBonus

getQualityBonus(item: undefined | default): number
Parameters
- item: undefined | default
Returns number
Inherited from Partial.getQualityBonus
- Defined in src/game/game/entity/Human.ts:2856

`Optional` getRangedAccuracy

getRangedAccuracy(weapon: undefined | default, ranged: undefined | IRangedInProgress, skillType: SkillType): number
Parameters
- weapon: undefined | default
- ranged: undefined | IRangedInProgress
- skillType: SkillType
Returns number
Inherited from Partial.getRangedAccuracy
- Defined in src/game/game/entity/Human.ts:1935

`Optional` getRangedSkillBonus

getRangedSkillBonus(skillUse?: SkillType): number
Parameters
- Optional skillUse: SkillType
Returns number
Inherited from Partial.getRangedSkillBonus
- Defined in src/game/game/entity/Human.ts:2852

`Optional` getScaledWeight

getScaledWeight(): number
Gets this human's current carried weight, scaled down to what it would be without any weight bonuses applied

Returns number
Inherited from Partial.getScaledWeight
- Defined in src/game/game/entity/Human.ts:4653

`Optional` getSimplifiedCumulativeAttack

getSimplifiedCumulativeAttack(): number
Returns number
Inherited from Partial.getSimplifiedCumulativeAttack
- Defined in src/game/game/entity/Human.ts:1273

`Optional` getSimplifiedCumulativeDefense

getSimplifiedCumulativeDefense(): number
Returns number
Inherited from Partial.getSimplifiedCumulativeDefense
- Defined in src/game/game/entity/Human.ts:1282

`Optional` getSkillBonus

getSkillBonus(skillUse?: SkillType): number
Parameters
- Optional skillUse: SkillType
Returns number
Inherited from Partial.getSkillBonus
- Defined in src/game/game/entity/Human.ts:2848

`Optional` getStaminaDelay

getStaminaDelay(staminaToStartAddingDelayAt?: number): number
Gets a stamina penalty delay to be used for slowed actions and movement.
Parameters
- staminaToStartAddingDelayAt: number = STAMINA_LOW_PENALTY_START_VALUE
  
  Stat value where delays start getting added from.
Returns number
Inherited from Partial.getStaminaDelay
- Defined in src/game/game/entity/Human.ts:2834

`Optional` getStatus

getStatus<S>(status: StatusType): undefined | S
Returns the handler for this status effect, whether or not this entity currently has the effect.
Type Parameters
- S extends default<S> = default
Parameters
- status: StatusType
Returns undefined | S
Inherited from Partial.getStatus
- Defined in src/game/game/entity/EntityWithStats.ts:145

`Optional` getStatusLevel

getStatusLevel(status: StatusType): number
Returns the handler for this status effect, whether or not this entity currently has the effect.
Parameters
- status: StatusType
Returns number
Inherited from Partial.getStatusLevel
- Defined in src/game/game/entity/EntityWithStats.ts:152

`Optional` getStatuses

getStatuses(): default[]
Generator for status effects on the entity.

Returns default[]
Inherited from Partial.getStatuses
- Defined in src/game/game/entity/EntityWithStats.ts:160

`Optional` getVehicle

getVehicle(): undefined | IItemVehicle
Returns undefined | IItemVehicle
Inherited from Partial.getVehicle
- Defined in src/game/game/entity/EntityMovable.ts:557

`Optional` getWanderChance

getWanderChance(defaultChance: number): undefined | number
Parameters
- defaultChance: number
Returns undefined | number
Inherited from Partial.getWanderChance
- Defined in src/game/game/entity/EntityMovable.ts:589

`Optional` getWanderHomePoint

getWanderHomePoint(): undefined | IVector2
Returns undefined | IVector2
Inherited from Partial.getWanderHomePoint
- Defined in src/game/game/entity/EntityMovable.ts:592

`Optional` getWanderHomeRadius

getWanderHomeRadius(): undefined | number
Returns undefined | number
Inherited from Partial.getWanderHomeRadius
- Defined in src/game/game/entity/EntityMovable.ts:593

`Optional` getWanderIdleChance

getWanderIdleChance(defaultChance: number): undefined | number
Parameters
- defaultChance: number
Returns undefined | number
Inherited from Partial.getWanderIdleChance
- Defined in src/game/game/entity/EntityMovable.ts:590

`Optional` getWanderNewDirectionChance

getWanderNewDirectionChance(defaultChance: number): undefined | number
Parameters
- defaultChance: number
Returns undefined | number
Inherited from Partial.getWanderNewDirectionChance
- Defined in src/game/game/entity/EntityMovable.ts:591

`Optional` getWeightOrStaminaMovementPenalty

getWeightOrStaminaMovementPenalty(): number
Returns number
Inherited from Partial.getWeightOrStaminaMovementPenalty
- Defined in src/game/game/entity/Human.ts:3861

`Optional` getWeightStatus

getWeightStatus(): WeightStatus
Returns WeightStatus
Inherited from Partial.getWeightStatus
- Defined in src/game/game/entity/Human.ts:1905

`Optional` giveRune

giveRune(deity: ArrayOr<DeityReal>, chance: number, domain: `event:${number}` | `craft:${number}` | `action:${number}` | `skill:${number}` | `killcreature:${number}` | `tamecreature:${number}` | `killnpc:${number}`, context: default): boolean
Returns
whether the rune was given
Parameters
- deity: ArrayOr<DeityReal>
  
  The deity to potentially give a rune for
- chance: number
  
  A chance multiplier on top of the base rune chance of 10% (an additional 30% chance may be added by theurgy)
- domain: `event:${number}` | `craft:${number}` | `action:${number}` | `skill:${number}` | `killcreature:${number}` | `tamecreature:${number}` | `killnpc:${number}`
- context: default
Returns boolean
Inherited from Partial.giveRune
- Defined in src/game/game/entity/Human.ts:1788

`Optional` hasData

hasData(key: string): boolean
Check if a data was set

Returns
True if the data exists, false if it doesn't
Parameters
- key: string
  
  Data key
Returns boolean
Inherited from Partial.hasData
- Defined in src/game/game/entity/Entity.ts:317

`Optional` hasDelay

hasDelay(): boolean
Returns boolean
Inherited from Partial.hasDelay
- Defined in src/game/game/entity/Human.ts:2788

`Optional` hasDiscoveredVulnOrResist

hasDiscoveredVulnOrResist(creatureType: CreatureType, damageType: DamageType): boolean
Parameters
- creatureType: CreatureType
- damageType: DamageType
Returns boolean
Inherited from Partial.hasDiscoveredVulnOrResist
- Defined in src/game/game/entity/Human.ts:4658

`Optional` hasStatus

hasStatus(status: StatusType): number
Returns whether the entity has the given StatusType
Parameters
- status: StatusType
  
  The status to check
Returns number
Inherited from Partial.hasStatus
- Defined in src/game/game/entity/EntityWithStats.ts:93

`Optional` hasTag

hasTag(tag: unknown): boolean
Parameters
- tag: unknown
Returns boolean
Inherited from Partial.hasTag
- Defined in src/game/game/entity/Entity.ts:295

`Optional` healthSyncCheck

healthSyncCheck(reason: string): void
Parameters
- reason: string
Returns void
Inherited from Partial.healthSyncCheck
- Defined in src/game/game/entity/Human.ts:4615

`Optional` hurtHands

hurtHands(damageMessage: default, toolMessage?: default): boolean
Parameters
- damageMessage: default
- Optional toolMessage: default
Returns boolean
Inherited from Partial.hurtHands
- Defined in src/game/game/entity/Human.ts:3770

`Optional` incrementIslandTickCount

incrementIslandTickCount(): void
Returns void
Inherited from Partial.incrementIslandTickCount
- Defined in src/game/game/entity/Human.ts:3193

`Optional` isContainer

isContainer(): this is IUncastableContainer
Returns this is IUncastableContainer
Inherited from Partial.isContainer
- Defined in src/game/game/entity/Human.ts:4818

`Optional` isCorpse

isCorpse(): this is default
Returns this is default
Inherited from Partial.isCorpse
- Defined in src/game/game/entity/Human.ts:4790

`Optional` isCreature

isCreature(): this is default
Returns this is default
Inherited from Partial.isCreature
- Defined in src/game/game/entity/Human.ts:4794

`Optional` isDoodad

isDoodad(): this is default
Returns this is default
Inherited from Partial.isDoodad
- Defined in src/game/game/entity/Human.ts:4798

`Optional` isDualWielding

isDualWielding(): boolean
Returns boolean
Inherited from Partial.isDualWielding
- Defined in src/game/game/entity/Human.ts:1175

`Optional` isEntity

isEntity(): this is default<unknown, number, EntityReferenceTypes, unknown>
Returns this is default<unknown, number, EntityReferenceTypes, unknown>
Inherited from Partial.isEntity
- Defined in src/game/game/entity/Entity.ts:414

`Optional` isHuman

isHuman(): this is default<unknown, number, NPC | Player>
Returns this is default<unknown, number, NPC | Player>
Inherited from Partial.isHuman
- Defined in src/game/game/entity/Human.ts:4802

`Optional` isItem

isItem(): this is default
Returns this is default
Inherited from Partial.isItem
- Defined in src/game/game/entity/Human.ts:4810

`Optional` `Abstract` isNPC

isNPC(): this is default
Returns this is default
Inherited from Partial.isNPC
- Defined in src/game/game/entity/Entity.ts:403

`Optional` isNearby

isNearby(entity: default<unknown, number, EntityReferenceTypes, unknown> | default, includeCurrentTile?: boolean): boolean
Parameters
- entity: default<unknown, number, EntityReferenceTypes, unknown> | default
- includeCurrentTile: boolean = true
Returns boolean
Inherited from Partial.isNearby
- Defined in src/game/game/entity/Entity.ts:186

`Optional` isOffHandDisabled

isOffHandDisabled(): boolean
Returns boolean
Inherited from Partial.isOffHandDisabled
- Defined in src/game/game/entity/Human.ts:1383

`Optional` `Abstract` isPlayer

isPlayer(): this is default
Returns this is default
Inherited from Partial.isPlayer
- Defined in src/game/game/entity/Entity.ts:404

`Optional` isTile

isTile(): this is default
Returns this is default
Inherited from Partial.isTile
- Defined in src/game/game/entity/Human.ts:4814

`Optional` isTileEvent

isTileEvent(): this is default
Returns this is default
Inherited from Partial.isTileEvent
- Defined in src/game/game/entity/Human.ts:4806

`Optional` isVehicleAllowedOnTile

isVehicleAllowedOnTile(tile: default): boolean
Parameters
- tile: default
Returns boolean
Inherited from Partial.isVehicleAllowedOnTile
- Defined in src/game/game/entity/EntityMovable.ts:561

`Optional` kill

kill(): void
Returns void
Inherited from Partial.kill
- Defined in src/game/game/entity/Human.ts:4411

`Optional` loadOnIsland

loadOnIsland(island: default, options?: Partial<ILoadOnIslandOptions>, voyageInfo?: IVoyageInfo): void
Loads the player onto an island Called when the game is initially loading and moving a player to another island
Parameters
- island: default
- Optional options: Partial<ILoadOnIslandOptions>
- Optional voyageInfo: IVoyageInfo
Returns void
Inherited from Partial.loadOnIsland
- Defined in src/game/game/entity/Human.ts:778

`Optional` loadUi

loadUi(): void
Loads ui. Should only be called if this player is local

Returns void
Inherited from Partial.loadUi
- Defined in src/game/game/entity/Human.ts:971

`Optional` moveTo

moveTo(tile: default, options?: IMoveToOptions): boolean
Move the entity to the tile
Parameters
- tile: default
- Optional options: IMoveToOptions
Returns boolean
Inherited from Partial.moveTo
- Defined in src/game/game/entity/EntityMovable.ts:199

`Optional` moveToIslandId

moveToIslandId(islandId: `${number},${number}`, options?: Partial<IMoveToIslandOptions>): Promise<void>
Moves this player to another island
Parameters
- islandId: `${number},${number}`
- Optional options: Partial<IMoveToIslandOptions>
Returns Promise<void>
Inherited from Partial.moveToIslandId
- Defined in src/game/game/entity/Human.ts:451

`Optional` moveToIslandPosition

moveToIslandPosition(position: IVector2, options?: Partial<IMoveToIslandOptions>): Promise<void>
Parameters
- position: IVector2
- Optional options: Partial<IMoveToIslandOptions>
Returns Promise<void>
Inherited from Partial.moveToIslandPosition
- Defined in src/game/game/entity/Human.ts:444

`Optional` moveTowardsIsland

moveTowardsIsland(direction: None | East | North | West | South, options?: Partial<IMoveToIslandOptions>): Promise<void>
Parameters
- direction: None | East | North | West | South
- Optional options: Partial<IMoveToIslandOptions>
Returns Promise<void>
Inherited from Partial.moveTowardsIsland
- Defined in src/game/game/entity/Human.ts:433

`Optional` notifyItem

notifyItem(itemNotifierType: ItemNotifierType, item: default): void
Parameters
- itemNotifierType: ItemNotifierType
- item: default
Returns void
Inherited from Partial.notifyItem
- Defined in src/game/game/entity/Entity.ts:240

`Optional` notifyStat

notifyStat(type: StatNotificationType, value: number): void
Parameters
- type: StatNotificationType
- value: number
Returns void
Inherited from Partial.notifyStat
- Defined in src/game/game/entity/Entity.ts:244

`Optional` overrideNextMovement

overrideNextMovement(tile: default): void
Parameters
- tile: default
Returns void
Inherited from Partial.overrideNextMovement
- Defined in src/game/game/entity/EntityMovable.ts:336

`Optional` passTurn

passTurn(turnType?: TurnTypeFlag): void
Parameters
- Optional turnType: TurnTypeFlag
Returns void
Inherited from Partial.passTurn
- Defined in src/game/game/entity/Human.ts:3219

`Optional` processInput

processInput(timeStamp: number): undefined | IMovementIntent
This is only ran on the server
Parameters
- timeStamp: number
Returns undefined | IMovementIntent
Inherited from Partial.processInput
- Defined in src/game/game/entity/Human.ts:1631

`Optional` queueSoundEffect

queueSoundEffect(type: SfxType, delay?: number, speed?: number): void
Parameters
- type: SfxType
- Optional delay: number
- Optional speed: number
Returns void
Inherited from Partial.queueSoundEffect
- Defined in src/game/game/entity/Entity.ts:228

`Optional` queueSoundEffectInFront

queueSoundEffectInFront(type: SfxType, delay?: number, speed?: number): void
Parameters
- type: SfxType
- Optional delay: number
- Optional speed: number
Returns void
Inherited from Partial.queueSoundEffectInFront
- Defined in src/game/game/entity/EntityMovable.ts:188

`Optional` rangeAction

rangeAction(weapon: undefined | default, ranged: undefined | IRangedInProgress, bonusMagicalType: MagicalPropertyType, skillType: SkillType, useMaxRange?: boolean): IRangedResolvedDistance
Parameters
- weapon: undefined | default
- ranged: undefined | IRangedInProgress
- bonusMagicalType: MagicalPropertyType
- skillType: SkillType
- Optional useMaxRange: boolean
Returns IRangedResolvedDistance
Inherited from Partial.rangeAction
- Defined in src/game/game/entity/Human.ts:1949
rangeAction(weapon: undefined | default, ranged: undefined | IRangedInProgress, bonusMagicalType: MagicalPropertyType, skillType: SkillType, useMaxRange: undefined | boolean, clientSide: true): IRangedResolvedDistance[]
Parameters
- weapon: undefined | default
- ranged: undefined | IRangedInProgress
- bonusMagicalType: MagicalPropertyType
- skillType: SkillType
- useMaxRange: undefined | boolean
- clientSide: true
Returns IRangedResolvedDistance[]
Inherited from Partial.rangeAction
- Defined in src/game/game/entity/Human.ts:1950

`Optional` refreshStatuses

refreshStatuses(): void
Returns void
Inherited from Partial.refreshStatuses
- Defined in src/game/game/entity/EntityWithStats.ts:174

`Optional` removeData

removeData(key: string): boolean
Removes a data

Returns
True when the data is removed. False if the key wasn't set
Parameters
- key: string
  
  Data key
Returns boolean
Inherited from Partial.removeData
- Defined in src/game/game/entity/Entity.ts:351

`Optional` removeMarkerIcon

removeMarkerIcon(): void
Returns void
Inherited from Partial.removeMarkerIcon
- Defined in src/game/game/entity/Entity.ts:260

`Optional` removeTag

removeTag(tag: unknown): void
Parameters
- tag: unknown
Returns void
Inherited from Partial.removeTag
- Defined in src/game/game/entity/Entity.ts:303

`Optional` removeTamedCreature

removeTamedCreature(creature: default): boolean
Parameters
- creature: default
Returns boolean
Inherited from Partial.removeTamedCreature
- Defined in src/game/game/entity/Human.ts:1096

`Optional` resetChangeTimers

resetChangeTimers(): void
Returns void
Inherited from Partial.resetChangeTimers
- Defined in src/game/game/entity/Human.ts:4177

`Optional` resetMovementIntent

resetMovementIntent(): void
Returns void
Inherited from Partial.resetMovementIntent
- Defined in src/game/game/entity/Human.ts:1109

`Optional` resetStatTimers

resetStatTimers(type?: StatChangeCurrentTimerStrategy, isNPC?: boolean): void
Parameters
- type: StatChangeCurrentTimerStrategy = StatChangeCurrentTimerStrategy.Difference
- isNPC: boolean = false
Returns void
Inherited from Partial.resetStatTimers
- Defined in src/game/game/entity/Human.ts:4168

`Optional` setData

setData<T>(key: string, value: T): T
Sets a data

Rturns
The value
Type Parameters
- T
Parameters
- key: string
  
  Data key
- value: T
  
  Data value
Returns T
Inherited from Partial.setData
- Defined in src/game/game/entity/Entity.ts:327

`Optional` setHumansWithinBound

setHumansWithinBound(humansWithinBound: IHumanBound[]): void
Parameters
- humansWithinBound: IHumanBound[]
Returns void
Inherited from Partial.setHumansWithinBound
- Defined in src/game/game/entity/Entity.ts:213

`Optional` setMoveType

setMoveType(moveType: MoveType): void
Parameters
- moveType: MoveType
Returns void
Inherited from Partial.setMoveType
- Defined in src/game/game/entity/EntityMovable.ts:549

`Optional` setName

setName(renamed: undefined | string | ISerializedTranslation): void
Parameters
- renamed: undefined | string | ISerializedTranslation
Returns void
Inherited from Partial.setName
- Defined in src/game/game/entity/Entity.ts:271

`Optional` setOptions

setOptions(options: IOptions): void
Parameters
- options: IOptions
Returns void
Inherited from Partial.setOptions
- Defined in src/game/game/entity/Human.ts:389

`Optional` setPosition

setPosition(tile: default): void
Immediately move the entity to the tile
Parameters
- tile: default
Returns void
Inherited from Partial.setPosition
- Defined in src/game/game/entity/EntityMovable.ts:298

`Optional` setStatChangeTimerIgnoreDifficultyOptions

setStatChangeTimerIgnoreDifficultyOptions(stat: IStat | Stat, timer: number, amt?: number): void
Parameters
- stat: IStat | Stat
- timer: number
- Optional amt: number
Returns void
Inherited from Partial.setStatChangeTimerIgnoreDifficultyOptions
- Defined in src/game/game/entity/Human.ts:4257

`Optional` setStatus

setStatus(status: StatusType, level: number | boolean, reason: StatusChangeReason, force?: boolean): boolean
Parameters
- status: StatusType
- level: number | boolean
- reason: StatusChangeReason
- Optional force: boolean
Returns boolean
Inherited from Partial.setStatus
- Defined in src/game/game/entity/Human.ts:3662

`Optional` setTamedCreatureEnemy

setTamedCreatureEnemy(enemy: default | default<unknown, number, NPC | Player>): void
Parameters
- enemy: default | default<unknown, number, NPC | Player>
Returns void
Inherited from Partial.setTamedCreatureEnemy
- Defined in src/game/game/entity/Human.ts:2860

`Optional` setVehicle

setVehicle(item: undefined | default, extinguishTorches?: boolean): boolean
Parameters
- item: undefined | default
- Optional extinguishTorches: boolean
Returns boolean
Inherited from Partial.setVehicle
- Defined in src/game/game/entity/Human.ts:1844

`Optional` setZ

setZ(z: number, allowCancelation?: boolean, updateFlowField?: boolean): boolean
Parameters
- z: number
- allowCancelation: boolean = true
- updateFlowField: boolean = true
Returns boolean
Inherited from Partial.setZ
- Defined in src/game/game/entity/Human.ts:2071

`Optional` skipNextMovement

skipNextMovement(): void
Skips the next movement for this creature / npc

Returns void
Inherited from Partial.skipNextMovement
- Defined in src/game/game/entity/EntityMovable.ts:316

`Optional` skipNextUpdate

skipNextUpdate(): void
Skips the next update for this creature / npc

Returns void
Inherited from Partial.skipNextUpdate
- Defined in src/game/game/entity/EntityMovable.ts:305

`Optional` staminaReduction

staminaReduction(skill?: SkillType, level?: number): void
Parameters
- Optional skill: SkillType
- Optional level: number
Returns void
Inherited from Partial.staminaReduction
- Defined in src/game/game/entity/Human.ts:1777

`Optional` startResting

startResting(restData: IRestData): void
Parameters
- restData: IRestData
Returns void
Inherited from Partial.startResting
- Defined in src/game/game/entity/Human.ts:984

`Optional` startSlipping

startSlipping(direction: East | North | West | South, speed?: SlippingSpeed): ISlippingData
Start slipping the entity
Parameters
- direction: East | North | West | South
- speed: SlippingSpeed = SlippingSpeed.Normal
Returns ISlippingData
Inherited from Partial.startSlipping
- Defined in src/game/game/entity/EntityMovable.ts:405

`Optional` stopSlipping

stopSlipping(): void
Returns void
Inherited from Partial.stopSlipping
- Defined in src/game/game/entity/EntityMovable.ts:415

`Optional` tick

tick(isPassTurn?: boolean, turnType?: TurnTypeFlag): boolean
Ticks a player

Returns
True if the game should tick after this
Parameters
- Optional isPassTurn: boolean
- Optional turnType: TurnTypeFlag
Returns boolean
Inherited from Partial.tick
- Defined in src/game/game/entity/Human.ts:3270

`Optional` tickStatuses

tickStatuses(): void
Updates caused by status effects such as bleeding, poison, and burns.

Returns void
Inherited from Partial.tickStatuses
- Defined in src/game/game/entity/Human.ts:3657

`Optional` toString

toString(): string
Returns string
Inherited from Partial.toString
- Defined in src/game/game/entity/Entity.ts:150

`Optional` unequip

unequip(item: default, internal?: boolean, skipMessage?: boolean, skipRevertItem?: boolean, isArmorStandSwap?: boolean): boolean
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
- isArmorStandSwap: boolean = false
Returns boolean
Inherited from Partial.unequip
- Defined in src/game/game/entity/Human.ts:2616

`Optional` unequipAll

unequipAll(displayMessage?: boolean, isArmorStandSwap?: boolean): IEquip[]
Unequip all equipment
Parameters
- displayMessage: boolean = true
- isArmorStandSwap: boolean = false
Returns IEquip[]
Inherited from Partial.unequipAll
- Defined in src/game/game/entity/Human.ts:2707

`Optional` updateDirection

updateDirection(tile: default | East | North | West | South, updateVehicleDirection?: boolean): East | North | West | South
Parameters
- tile: default | East | North | West | South
- Optional updateVehicleDirection: boolean
Returns East | North | West | South
Inherited from Partial.updateDirection
- Defined in src/game/game/entity/Human.ts:408

`Optional` updateMovementIntent

updateMovementIntent(movementIntent: IMovementIntent): boolean
Parameters
- movementIntent: IMovementIntent
Returns boolean
Inherited from Partial.updateMovementIntent
- Defined in src/game/game/entity/Human.ts:2215

`Optional` updateRender

updateRender(source: RenderSource, flag: UpdateRenderFlag): void
Parameters
- source: RenderSource
- flag: UpdateRenderFlag
Returns void
Inherited from Partial.updateRender
- Defined in src/game/game/entity/Entity.ts:232

`Optional` updateSlipping

updateSlipping(tile: default, moveDirection: East | North | West | South, slippingSpeed?: SlippingSpeed): undefined | ISlippingData
Start slipping if the tile is slippable. Stops slipping if above the max slip count or if the tile is not slippable.
Parameters
- tile: default
- moveDirection: East | North | West | South
- Optional slippingSpeed: SlippingSpeed
Returns undefined | ISlippingData
Inherited from Partial.updateSlipping
- Defined in src/game/game/entity/EntityMovable.ts:370

`Optional` updateStatsAndAttributes

updateStatsAndAttributes(): void
Returns void
Inherited from Partial.updateStatsAndAttributes
- Defined in src/game/game/entity/Human.ts:1428

`Optional` updateStrength

updateStrength(): void
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
Inherited from Partial.updateStrength
- Defined in src/game/game/entity/Human.ts:4630

`Optional` updateSwimming

updateSwimming(): void
Returns void
Inherited from Partial.updateSwimming
- Defined in src/game/game/entity/Human.ts:3827

`Optional` updateTablesAndWeight

updateTablesAndWeight(source: string): void
Parameters
- source: string
Returns void
Inherited from Partial.updateTablesAndWeight
- Defined in src/game/game/entity/Human.ts:3648

`Optional` updateVehicle

updateVehicle(): void
Returns void
Inherited from Partial.updateVehicle
- Defined in src/game/game/entity/Human.ts:3850

`Optional` updateView

updateView(source: RenderSource, updateFov?: boolean | FieldOfView | FieldOfViewSkipTransition): void
Parameters
- source: RenderSource
- updateFov: boolean | FieldOfView | FieldOfViewSkipTransition = false
Returns void
Inherited from Partial.updateView
- Defined in src/game/game/entity/Entity.ts:236

`Optional` updateWalkTo

updateWalkTo(walkTo: undefined | IWalkToPathInProgress, reason?: WalkToChangeReason): void
Updates the walkTo (automatic pathing) for the human. Use walkToTile/walkToEntity methods when client side.
Parameters
- walkTo: undefined | IWalkToPathInProgress
- reason: WalkToChangeReason = "Unknown"
Returns void
Inherited from Partial.updateWalkTo
- Defined in src/game/game/entity/Human.ts:1575

`Optional` updateWeight

updateWeight(source: string): void
Parameters
- source: string
Returns void
Inherited from Partial.updateWeight
- Defined in src/game/game/entity/Human.ts:3613

`Optional` updateWorldTile

updateWorldTile(tileUpdateType?: TileUpdateType, updateNeighbors?: boolean, skipFlowFieldUpdate?: boolean): void
Updates the world renderer & flow field state for the tile
Parameters
- tileUpdateType: TileUpdateType = ...
- Optional updateNeighbors: boolean
- Optional skipFlowFieldUpdate: boolean
Returns void
Inherited from Partial.updateWorldTile
- Defined in src/game/game/entity/Entity.ts:193

`Optional` waitForWalkTo

waitForWalkTo(): Promise<void>
Returns a promise that resolves once the walk finishes

Returns Promise<void>
Inherited from Partial.waitForWalkTo
- Defined in src/game/game/entity/Human.ts:1458

`Optional` walkToEntity

walkToEntity(entity: default<unknown, number, EntityReferenceTypes, unknown>, range?: FindPathRange, isClientSide?: boolean): Promise<boolean>
Parameters
- entity: default<unknown, number, EntityReferenceTypes, unknown>
- range: FindPathRange = FindPathRangeType.AdjacentTile
- isClientSide: boolean = false
Returns Promise<boolean>
Inherited from Partial.walkToEntity
- Defined in src/game/game/entity/Human.ts:1469

`Optional` walkToTile

walkToTile(tile: default, range?: FindPathRange, isClientSide?: boolean): Promise<boolean>
Parameters
- tile: default
- range: FindPathRange = FindPathRangeType.SameTile
- isClientSide: boolean = false
Returns Promise<boolean>
Inherited from Partial.walkToTile
- Defined in src/game/game/entity/Human.ts:1464

Interface IHumanOld

Hierarchy

Index

Properties

Methods

Properties

Optional activeTurns

Optional allowSmartMovementClientside

Optional anim

asContainer

asCorpse

asCreature

asDoodad

asEntity

asEntityMovable

asEntityWithStats

asGenericEntity

asGenericHuman

asHuman

asItem

asLoaded

asLocalPlayer

asNPC

asNotLocalPlayer

asPlayer

asTile

asTileEvent

asUnion

Optional attackAnimationData

connectedVehicle

Optional connectedVehicleId

Optional containedItems

Optional containerType

Optional crafted

Optional cumulativeEvilCrafting

Optional customization

days

Optional deathBy

Optional defenses

description

Optional direction

Optional Readonly Abstract entityType

Optional Readonly equipEffects

Optional equippedOffHandDisabled

Optional equippedReferences

Optional event

Optional facingDirection

facingTile

Optional flyingDelay

fromTile

Optional fromX

Optional fromY

Optional handEquippedToLast

Optional highestAttack

Optional highestDefense

Optional historicalActions

humansVisible

Optional id

Optional identifier

Optional Readonly inventory

Deprecated

Optional invocations

Optional isConnecting

isDead

isFlying

isGhost

isHost

isLoaded

isLocalPlayer

Optional isMoving

Optional isMovingSuppressVehicleClientside

isOnFire

isResting

isRestingCancelled

isServer

isSwimming

isValid

isWalkingTo

isWithinHumanBounds

island

`Optional` activeTurns

`Optional` allowSmartMovementClientside

`Optional` anim

`Optional` attackAnimationData

`Optional` connectedVehicleId

`Optional` containedItems

`Optional` containerType

`Optional` crafted

`Optional` cumulativeEvilCrafting

`Optional` customization

`Optional` deathBy

`Optional` defenses

`Optional` direction

`Optional` `Readonly` `Abstract` entityType

`Optional` `Readonly` equipEffects

`Optional` equippedOffHandDisabled

`Optional` equippedReferences

`Optional` event

`Optional` facingDirection

`Optional` flyingDelay

`Optional` fromX

`Optional` fromY

`Optional` handEquippedToLast

`Optional` highestAttack

`Optional` highestDefense

`Optional` historicalActions

`Optional` id

`Optional` identifier

`Optional` `Readonly` inventory

`Optional` invocations

`Optional` isConnecting

`Optional` isMoving

`Optional` isMovingSuppressVehicleClientside

`Optional` islandId

`Optional` lastAttackedByReference

`Optional` lastGainedStat

`Optional` lastReceivedRune

`Optional` manualTickActionDelay

`Optional` messages

`Optional` moveType

`Optional` movementCompleteZ

`Optional` `Readonly` movementIntent

`Optional` `Readonly` movingData

`Optional` nextMoveDirection

`Optional` nextMoveTime

`Optional` notes

`Optional` options

`Optional` persistentMarker

`Optional` preventRendering

`Optional` quests

`Optional` realTimeTickActionDelay

`Optional` referenceId

`Optional` renamed

`Optional` respawnPoint

`Optional` restData

`Optional` score

`Optional` shouldSkipNextMovement

`Optional` skill

`Optional` skills

`Optional` sort

`Optional` sortDirection

`Optional` `Readonly` stat

`Optional` state

`Optional` stats

`Optional` status

`Optional` tamedCreatures

`Optional` ticksSpent

`Optional` `Readonly` `Abstract` tileUpdateType

`Optional` turns

`Optional` type

`Optional` vehicleItemReference

`Optional` walkSoundCounter

`Optional` walkToInProgress

`Optional` x

`Optional` y

`Optional` z

`Optional` addDelay

`Optional` replace: boolean

`Optional` addStaminaDelay: boolean

`Optional` addMarkerIcon