Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IPlayer

Hierarchy

Implemented by

Index

Properties

Methods

Properties

attack

attack: number

attackFromEquip

attackFromEquip: IAttackHand

benignity

benignity: number

containerSortInfo

containerSortInfo: object

Type declaration

currentHint

currentHint: HintType

customization

customization: IPlayerCustomization

deathBy

deathBy: string

defense

defense: PlayerDefense

defenses

defenses: number[]

dehydration

dehydration: number

dexterity

dexterity: number

dialogContainerInfo

dialogContainerInfo: IDialogInfo[]

dialogInfo

dialogInfo: object

Type declaration

direction

direction: IPoint

equipped

equipped: object

Type declaration

  • [index: number]: number

facingDirection

facingDirection: FacingDirection

flowFieldManager

flowFieldManager: IFlowFieldManager

fromX

fromX: number

fromY

fromY: number

handToUse

handToUse: EquipType

hintSeen

hintSeen: boolean[]

id

id: number

identifier

identifier: string

inventory

inventory: IContainer

isMoving

isMoving: boolean

lightBonus

lightBonus: number

malignity

malignity: number

moveType

moveType: MoveType

movement

movement: IInputMovement

movementAnimation

movementAnimation: number

movementCompleteZ

movementCompleteZ: number | undefined

movementCompleted

movementCompleted: boolean

movementFinishTime

movementFinishTime: number

movementProgress

movementProgress: number

name

name: string

nextMoveDirection

nextMoveDirection: FacingDirection | undefined

nextX

nextX: number

nextY

nextY: number

options

options: IOptions

quickSlotInfo

quickSlotInfo: IQuickSlotInfo[]

raft

raft: number | undefined

restData

restData: IRestData | undefined

score

score: number

skills

skills: ISkillSet

spawnPoint

spawnPoint: IPointZ | undefined

starvation

starvation: number

state

stats

stats: IStats

status

strength

strength: number

swimming

swimming: boolean

tamedCreatures

tamedCreatures: number[]

turns

turns: number

walkSoundCounter

walkSoundCounter: number

wasAbsentPlayer

wasAbsentPlayer: boolean

weight

weight: number

weightBonus

weightBonus: number

x

x: number

y

y: number

z

z: number

Methods

addDelay

  • addDelay(delay: Delay, replace?: boolean): void
  • Parameters

    • delay: Delay
    • Optional replace: boolean

    Returns void

addMilestone

  • Parameters

    Returns void

attributes

  • attributes(): void
  • Returns void

burn

  • burn(skipMessage?: boolean): number | undefined
  • Parameters

    • Optional skipMessage: boolean

    Returns number | undefined

calculateEquipmentStats

  • calculateEquipmentStats(): void
  • Returns void

calculateStats

  • calculateStats(): void
  • Returns void

canCarve

  • canCarve(): IItem | undefined
  • Returns IItem | undefined

canJump

  • canJump(): boolean
  • Returns boolean

canSeeTile

  • canSeeTile(tileX: number, tileY: number, tileZ: number, isClientSide?: boolean): boolean
  • Parameters

    • tileX: number
    • tileY: number
    • tileZ: number
    • Optional isClientSide: boolean

    Returns boolean

cancelResting

  • Parameters

    Returns void

checkAndRemoveBlood

  • checkAndRemoveBlood(): boolean
  • Returns boolean

checkForTargetInRange

  • checkForTargetInRange(range: number, includePlayers?: boolean): IMobCheck
  • Parameters

    • range: number
    • Optional includePlayers: boolean

    Returns IMobCheck

checkReputationMilestones

  • checkReputationMilestones(): void
  • Returns void

checkUnder

  • checkUnder(inFacingDirection?: boolean, autoActions?: boolean, enterCave?: boolean, forcePickUp?: boolean, skipDoodadEvents?: boolean): void
  • Parameters

    • Optional inFacingDirection: boolean
    • Optional autoActions: boolean
    • Optional enterCave: boolean
    • Optional forcePickUp: boolean
    • Optional skipDoodadEvents: boolean

    Returns void

checkWeight

  • checkWeight(): void
  • Returns void

createFlowFieldManager

  • createFlowFieldManager(): void
  • Returns void

createItemInInventory

damage

  • damage(amount: number, damageMessage: string, soundDelay?: number): void
  • Parameters

    • amount: number
    • damageMessage: string
    • Optional soundDelay: number

    Returns void

damageEquipment

  • damageEquipment(): void
  • Returns void

equip

  • equip(item: IItem, slot: EquipType, internal?: boolean, switchingHands?: boolean): void
  • Parameters

    • item: IItem
    • slot: EquipType
    • Optional internal: boolean
    • Optional switchingHands: boolean

    Returns void

getBindDownTime

  • getBindDownTime(key: KeyBind): number | undefined
  • Parameters

    Returns number | undefined

getEquipSlotForItem

  • Parameters

    Returns EquipType | undefined

getEquippedItem

  • Parameters

    Returns IItem | undefined

getEquippedItems

  • getEquippedItems(): IItem[]
  • Returns IItem[]

getHandToUse

  • Returns EquipType | undefined

getMaxHealth

  • getMaxHealth(): number
  • Returns number

getMouseDirection

getReputation

  • getReputation(): number
  • Returns number

getSerializationProperties

  • getSerializationProperties(_: string): string[]

getTouchDirection

hasDelay

  • hasDelay(): boolean
  • Returns boolean

hurtHands

  • Parameters

    Returns void

inspect

  • inspect(x: number, y: number, z?: number): void
  • Parameters

    • x: number
    • y: number
    • Optional z: number

    Returns void

inspectTile

  • Parameters

    Returns IInspect[]

isBindDown

  • isBindDown(key: KeyBind): boolean
  • Parameters

    Returns boolean

isGhost

  • isGhost(): boolean
  • Returns boolean

isLocalPlayer

  • isLocalPlayer(): boolean
  • Returns boolean

isResting

  • isResting(): boolean
  • Returns boolean

isRestingCancelled

  • isRestingCancelled(): boolean
  • Returns boolean

passTurn

  • Parameters

    Returns void

processInput

  • processInput(): void
  • Returns void

queueSoundEffect

  • queueSoundEffect(type: SfxType, delay?: number, speed?: number, noPosition?: boolean): void
  • Parameters

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

    Returns void

queueSoundEffectInFront

  • queueSoundEffectInFront(type: SfxType, delay?: number, speed?: number, noPosition?: boolean): void
  • Parameters

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

    Returns void

resetKeyBindState

  • resetKeyBindState(): void
  • Returns void

resetMovementStates

  • resetMovementStates(): void
  • Returns void

setId

  • setId(id: number): void
  • Parameters

    • id: number

    Returns void

setMouseDirection

  • Parameters

    Returns void

setRaft

  • setRaft(itemId: number | undefined): void
  • Parameters

    • itemId: number | undefined

    Returns void

setTouchDirection

  • Parameters

    Returns void

setZ

  • setZ(z: number): void
  • Parameters

    • z: number

    Returns void

setup

  • setup(completedMilestones: number): void
  • Parameters

    • completedMilestones: number

    Returns void

shakeStat

  • Parameters

    Returns void

skillGain

  • skillGain(skillType: SkillType, mod?: number, bypass?: boolean): void
  • Parameters

    • skillType: SkillType
    • Optional mod: number
    • Optional bypass: boolean

    Returns void

staminaCheck

  • staminaCheck(): boolean
  • Returns boolean

staminaReduction

  • staminaReduction(skillType: SkillType): void
  • Parameters

    Returns void

startResting

  • Parameters

    Returns void

tick

  • tick(isPassTurn?: boolean): void
  • Parameters

    • Optional isPassTurn: boolean

    Returns void

unequip

  • unequip(item: IItem, internal?: boolean, switchingHands?: boolean): void
  • Parameters

    • item: IItem
    • Optional internal: boolean
    • Optional switchingHands: boolean

    Returns void

unequipAll

  • unequipAll(): void
  • Returns void

updateCraftTableAndWeight

  • updateCraftTableAndWeight(): void
  • Returns void

updateDialogInfo

  • updateDialogInfo(dialogIndex: string | number): void
  • Parameters

    • dialogIndex: string | number

    Returns void

updateKeyBindState

  • updateKeyBindState(key: KeyBind, state: number | undefined): void
  • Parameters

    • key: KeyBind
    • state: number | undefined

    Returns void

updateQuickSlotInfo

  • Parameters

    Returns void

updateReputation

  • updateReputation(reputation: number): void
  • Parameters

    • reputation: number

    Returns void

Generated using TypeDoc