Player()

new Player()
Player.js, line 24

Properties:
Name Type Description
account Account
experience number

current experience this level
password string
prompt string

default prompt string
socket net.Socket
questTracker QuestTracker
extraPrompts Map.<string, function()>

Extra prompts to render after the default prompt
questData Object

Extends

Members

isNpc
Character.js, line 623

Inherited From:

Methods

addAttribute()
Character.js, line 103

Inherited From:
See:

addCombatant(target)
Character.js, line 276

Parameters:
Name Type Description
target Character
Fires:
Inherited From:

addEffect(effect) → {boolean}
Character.js, line 218

Parameters:
Name Type Description
effect Effect
Returns:
boolean
Inherited From:

addFollower(follower)
Character.js, line 520

Parameters:
Name Type Description
follower Character
Fires:
Inherited From:

addItem(item)
Character.js, line 424

Move an item to the character's inventory

Parameters:
Name Type Description
item Item
Inherited From:

addPrompt(id, renderer, removeOnRendernullable)
Player.js, line 108

Add a line of text to be displayed immediately after the prompt when the prompt is displayed

Parameters:
Name Type Attributes Default Description
id string

Unique prompt id
renderer function

Function to call to render the prompt string
removeOnRender boolean <nullable>
 false

When true prompt will remove itself once rendered otherwise prompt will continue to be rendered until removed.

emit(event, …args)
Player.js, line 62

Proxy all events on the player to the quest tracker

Parameters:
Name Type Attributes Description
event string
args * <repeatable>
Overrides:

equip(item, slot)
Character.js, line 360

Parameters:
Name Type Description
item Item
slot string

Slot to equip the item in
Fires:
Throws:

  • EquipSlotTakenError

  • EquipAlreadyEquippedError

Inherited From:

evaluateIncomingDamage(damage) → {number}
Character.js, line 336

Parameters:
Name Type Description
damage Damage
Returns:
number
Inherited From:
See:
  • EffectList.evaluateIncomingDamage

evaluateOutgoingDamage(damage, currentAmount) → {number}
Character.js, line 347

Parameters:
Name Type Description
damage Damage
currentAmount number
Returns:
number
Inherited From:
See:
  • EffectList.evaluateOutgoingDamage

follow(target)
Character.js, line 487

Begin following another character. If the character follows itself they stop following.

Parameters:
Name Type Description
target Character
Inherited From:

getAttribute(attr) → {number}
Character.js, line 112

Get the current value of an attribute (base modified by delta)

Parameters:
Name Type Description
attr string
Returns:
number
Inherited From:

getBaseAttribute(attr) → {number}
Character.js, line 125

Get the base value for a given attribute

Parameters:
Name Type Description
attr string

Attribute name
Returns:
number
Inherited From:

getBroadcastTargets()
Character.js, line 616

Inherited From:
See:

getMaxAttribute(attr) → {number}
Character.js, line 79

Get current maximum value of attribute (as modified by effects.)

Parameters:
Name Type Description
attr string
Returns:
number
Inherited From:

hasAttribute(attr) → {boolean}
Character.js, line 70

Parameters:
Name Type Description
attr string

Attribute name
Returns:
boolean
Inherited From:

hasEffectType(type) → {boolean}
Character.js, line 210

Parameters:
Name Type Description
type string
Returns:
boolean
Inherited From:
See:

hasFollower(target) → {boolean}
Character.js, line 556

Parameters:
Name Type Description
target Character
Returns:
boolean
Inherited From:

hasItem(itemReference) → {Item|boolean}
Character.js, line 454

Check to see if this character has a particular item by EntityReference

Parameters:
Name Type Description
itemReference EntityReference
Returns:
Item | boolean
Inherited From:

hasPrompt(id) → {boolean}
Player.js, line 123

Parameters:
Name Type Description
id string
Returns:
boolean

hydrate(state)
Character.js, line 564

Initialize the character from storage

Parameters:
Name Type Description
state GameState
Overrides:

initiateCombat(target, lagnullable)
Character.js, line 236

Start combat with a given target.

Parameters:
Name Type Attributes Default Description
target Character
lag number <nullable>
 0

Optional milliseconds of lag to apply before the first attack
Fires:
Inherited From:

interpolatePrompt(promptStr, extraData)
Player.js, line 77

Convert prompt tokens into actual data

Parameters:
Name Type Description
promptStr string
extraData object

Any extra data to give the prompt access to

isFollowing(target) → {boolean}
Character.js, line 548

Parameters:
Name Type Description
target Character
Returns:
boolean
Inherited From:

isInCombat(targetnullable)
Character.js, line 268

Check to see if this character is currently in combat or if they are currently in combat with a specific character

Parameters:
Name Type Attributes Description
target Character <nullable>
Returns:
-

boolean

Inherited From:

isInventoryFull() → {boolean}
Character.js, line 467

Returns:
boolean
Inherited From:

lowerAttribute(attr, amount)
Character.js, line 174

Lower an attribute by name

Parameters:
Name Type Description
attr string
amount number
Fires:
Inherited From:
See:
  • Attributes#lower

moveTo(nextRoom, onMoved)
Player.js, line 135

Move the player to the given room, emitting events appropriately

Parameters:
Name Type Description
nextRoom Room
onMoved function

Function to run after the player is moved to the next room but before enter events are fired
Fires:

queueCommand()
Player.js, line 52

See:
  • CommandQueue::enqueue

raiseAttribute(attr, amount)
Character.js, line 158

Raise an attribute by name

Parameters:
Name Type Description
attr string
amount number
Fires:
Inherited From:
See:
  • Attributes#raise

removeCombatant(target)
Character.js, line 295

Parameters:
Name Type Description
target Character
Fires:
Inherited From:

removeEffect(effect)
Character.js, line 226

Parameters:
Name Type Description
effect Effect
Inherited From:
See:

removeFollower(follower)
Character.js, line 534

Parameters:
Name Type Description
follower Character
Fires:
Inherited From:

removeFromCombat()
Character.js, line 321

Fully remove this character from combat

Inherited From:

removeItem(item)
Character.js, line 436

Remove an item from the character's inventory. Warning: This does not automatically place the item in any particular place. You will need to manually add it to the room or another character's inventory

Parameters:
Name Type Description
item Item
Inherited From:

removePrompt(id)
Player.js, line 115

Parameters:
Name Type Description
id string

serialize() → {Object}
Character.js, line 603

Gather data to be persisted

Returns:
Object
Overrides:

setAttributeBase(attr, newBase)
Character.js, line 196

Update an attribute's base value.

NOTE: You probably don't want to use this the way you think you do. You should not use this for any temporary modifications to an attribute, instead you should use an Effect modifier.

This will permanently update the base value for an attribute to be used for things like a player purchasing a permanent upgrade or increasing a stat on level up

Parameters:
Name Type Description
attr string

Attribute name
newBase number

New base value
Fires:
Inherited From:

setAttributeToMax(attr)
Character.js, line 142

Clears any changes to the attribute, setting it to its base value.

Parameters:
Name Type Description
attr string
Fires:
Inherited From:

unequip(slot)
Character.js, line 397

Remove equipment in a given slot and move it to the character's inventory

Parameters:
Name Type Description
slot string
Fires:
Throws:

InventoryFullError

Inherited From:

unfollow()
Character.js, line 506

Stop following whoever the character was following

Fires:
Inherited From:

Events

attributeUpdate
Character.js, line 130

Fired when a Character's attribute is set, raised, or lowered

Parameters:
Name Type Description
attributeName string
attribute Attribute
Inherited From:

combatantAdded
Character.js, line 283

Parameters:
Name Type Description
target Character
Inherited From:

combatantRemoved
Character.js, line 303

Parameters:
Name Type Description
target Character
Inherited From:

combatEnd
Character.js, line 310

Inherited From:

combatStart
Character.js, line 240

Fired when Character#initiateCombat is called

Inherited From:

damaged
Damage.js, line 68

Parameters:
Name Type Description
damage Damage
finalAmount Number
Inherited From:

effectAdded
EffectList.js, line 132

Inherited From:

effectRemoved
EffectList.js, line 153

Inherited From:

enterRoom
Player.js, line 158

Parameters:
Name Type Description
room Room

equip
Character.js, line 381

Parameters:
Name Type Description
slot string
item Item
Inherited From:

followed
Character.js, line 495

Parameters:
Name Type Description
target Character
Inherited From:

gainedFollower
Character.js, line 523

Parameters:
Name Type Description
follower Character
Inherited From:

heal
Heal.js, line 21

Parameters:
Name Type Description
heal Heal
target Character
finalAmount number
Inherited From:

healed
Heal.js, line 29

Parameters:
Name Type Description
heal Heal
finalAmount number
Inherited From:

hit
Damage.js, line 60

Parameters:
Name Type Description
damage Damage
target Character
finalAmount Number
Inherited From:

lostFollower
Character.js, line 537

Parameters:
Name Type Description
follower Character
Inherited From:

saved
PlayerManager.js, line 150

unequip
Character.js, line 411

Parameters:
Name Type Description
slot string
item Item
Inherited From:

unfollowed
Character.js, line 508

Parameters:
Name Type Description
following Character
Inherited From:

updateTick
PlayerManager.js, line 170