Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IPlayer

Hierarchy

Implemented by

Index

Properties

Methods

Properties

absentLastUsedTime

absentLastUsedTime: number

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

exploredMap

exploredMap: IExploreMap[] | undefined

exploredMapEncodedData

exploredMapEncodedData: number[][]

exploredMapNotSaved

exploredMapNotSaved: IExploreMap[] | undefined

facingDirection

facingDirection: FacingDirection

fromX

fromX: number

fromY

fromY: number

handToUse

handToUse: EquipType

hintSeen

hintSeen: boolean[]

id

id: number

identifier

identifier: string

inventory

inventory: IContainer

isConnecting

isConnecting: boolean

isMoving

isMoving: boolean

isMovingClientside

isMovingClientside: boolean

lightBonus

lightBonus: number

malignity

malignity: number

moveType

moveType: MoveType

movementAnimation

movementAnimation: number

movementComplete

movementComplete: boolean

movementCompleteZ

movementCompleteZ: number | undefined

movementFinishTime

movementFinishTime: number

movementProgress

movementProgress: number

name

name: string

nextMoveDirection

nextMoveDirection: FacingDirection | undefined

nextMoveTime

nextMoveTime: number

nextX

nextX: number

nextY

nextY: number

noInputReceived

noInputReceived: boolean

options

options: IOptions

quickSlotInfo

quickSlotInfo: IQuickSlotInfo[]

raft

raft: number | undefined

restData

restData: IRestData | undefined

revealedItems

revealedItems: object

Type declaration

  • [index: number]: boolean

score

score: number

skills

skills: ISkillSet

spawnPoint

spawnPoint: IPointZ | undefined

starvation

starvation: number

state

stats

stats: IStats

status

stopNextMovement

stopNextMovement: boolean

strength

strength: number

swimming

swimming: boolean

tamedCreatures

tamedCreatures: number[]

travelData

travelData: IPlayerTravelData | undefined

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, skipParry?: boolean, equipType?: EquipType): number | undefined
  • Parameters

    • Optional skipMessage: boolean
    • Optional skipParry: boolean
    • Optional equipType: EquipType

    Returns number | undefined

calculateEquipmentStats

  • calculateEquipmentStats(): void
  • Returns void

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

checkForGather

  • checkForGather(): IDoodad | undefined
  • Returns IDoodad | undefined

checkForGatherFire

  • checkForGatherFire(): string | undefined
  • Returns string | undefined

checkForStill

  • checkForStill(): boolean
  • Returns boolean

checkForTargetInRange

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

    • range: number
    • Optional includePlayers: boolean

    Returns IMobCheck

checkReputationMilestones

  • checkReputationMilestones(): void
  • Returns void

checkSkillMilestones

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

createItemInInventory

damage

  • damage(amount: number, damageMessage: string, soundDelay?: number): number | undefined
  • damage(damageInfo: IDamageInfo): number | undefined
  • Parameters

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

    Returns number | undefined

  • Parameters

    Returns number | undefined

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

getConsumeBonus

  • getConsumeBonus(skillUse: SkillType, item: IItem | undefined): number
  • Parameters

    Returns number

getDefaultCarveTool

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

getDialogInfo

  • getDialogInfo(dialogIndex: string | number): IDialogInfo
  • Parameters

    • dialogIndex: string | number

    Returns IDialogInfo

getEquipSlotForItem

  • Parameters

    Returns EquipType | undefined

getEquippedItem

  • Parameters

    Returns IItem | undefined

getEquippedItems

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

getFacingPoint

  • Returns IPointZ

getFacingTile

  • Returns ITile

getHandToUse

  • Returns EquipType | undefined

getInspectHealthMessage

getMaxHealth

  • getMaxHealth(): number
  • Returns number

getMovementFinishTime

  • getMovementFinishTime(): number
  • Returns number

getMovementIntent

  • getMovementIntent(): Bindable | undefined
  • Returns Bindable | undefined

getName

  • getName(html?: boolean): string
  • Parameters

    • Optional html: boolean

    Returns string

getPoint

  • Returns IPointZ

getReputation

  • getReputation(): number
  • Returns number

getTile

  • Returns ITile

getWeightMovementPenalty

  • getWeightMovementPenalty(): number
  • Returns number

getWeightStatus

hasDelay

  • hasDelay(): boolean
  • Returns boolean

hasTamedCreature

  • hasTamedCreature(creature: ICreature): boolean
  • Parameters

    Returns boolean

healthSyncCheck

  • healthSyncCheck(): void
  • Returns void

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

isFacingCarvableTile

  • isFacingCarvableTile(): boolean
  • Returns boolean

isGhost

  • isGhost(): boolean
  • Returns boolean

isLocalPlayer

  • isLocalPlayer(): boolean
  • Returns boolean

isResting

  • isResting(): boolean
  • Returns boolean

isRestingCancelled

  • isRestingCancelled(): boolean
  • Returns boolean

isServer

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

resetMovementStates

  • resetMovementStates(): void
  • Returns void

restoreExploredMap

  • restoreExploredMap(): void
  • Returns void

revealItem

  • Parameters

    Returns void

setId

  • setId(id: number): void
  • Parameters

    • id: number

    Returns void

setPosition

  • setPosition(point: IPointZ): void
  • Parameters

    Returns void

setRaft

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

    • itemId: number | undefined

    Returns void

setTamedCreatureEnemy

  • 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, skipMessage?: boolean, switchingHands?: boolean): void
  • Parameters

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

    Returns void

unequipAll

  • unequipAll(): void
  • Returns void

updateCraftTable

  • updateCraftTable(): void
  • Returns void

updateDialogInfo

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

    • dialogIndex: string | number

    Returns void

updateDismantleTable

  • updateDismantleTable(): void
  • Returns void

updateMilestones

  • updateMilestones(): void
  • Returns void

updateMovementIntent

  • updateMovementIntent(bind: Bindable | undefined): void
  • Parameters

    Returns void

updateQuickSlotInfo

  • Parameters

    Returns void

updateReputation

  • updateReputation(reputation: number): void
  • Parameters

    • reputation: number

    Returns void

updateStatsAndAttributes

  • updateStatsAndAttributes(): void
  • Returns void

updateTables

  • updateTables(): void
  • Returns void

updateTablesAndWeight

  • updateTablesAndWeight(): void
  • Returns void

Generated using TypeDoc