Character()

The Character class acts as the base for both NPCs and Players.

new Character()
Character.js, line 27

Properties:
Name Type Description
name string

Name shown on look/who/login
inventory Inventory
combatants Set

Enemies this character is currently in combat with
level number
attributes Attributes
effects EffectList

List of current effects applied to the character
room Room

Room the character is currently in
Mixes In:

Extends

  • EventEmitter

Members

isNpc
Character.js, line 623

Methods

addAttribute()
Character.js, line 103

See:

addCombatant(target)
Character.js, line 276

Parameters:
Name Type Description
target Character
Fires:

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

Parameters:
Name Type Description
effect Effect
Returns:
boolean

addFollower(follower)
Character.js, line 520

Parameters:
Name Type Description
follower Character
Fires:

addItem(item)
Character.js, line 424

Move an item to the character's inventory

Parameters:
Name Type Description
item Item

emit(event, …args)
Character.js, line 60

Proxy all events on the player to effects

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

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

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

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

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

Parameters:
Name Type Description
damage Damage
currentAmount number
Returns:
number
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

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

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

getBroadcastTargets()
Character.js, line 616

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

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

Parameters:
Name Type Description
attr string

Attribute name
Returns:
boolean

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

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

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

Parameters:
Name Type Description
target Character
Returns:
boolean

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

hydrate(state)
Character.js, line 564

Initialize the character from storage

Parameters:
Name Type Description
state GameState

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:

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

Parameters:
Name Type Description
target Character
Returns:
boolean

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

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

Returns:
boolean

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

Lower an attribute by name

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

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

Raise an attribute by name

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

removeCombatant(target)
Character.js, line 295

Parameters:
Name Type Description
target Character
Fires:

removeEffect(effect)
Character.js, line 226

Parameters:
Name Type Description
effect Effect
See:

removeFollower(follower)
Character.js, line 534

Parameters:
Name Type Description
follower Character
Fires:

removeFromCombat()
Character.js, line 321

Fully remove this character from combat

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

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

Gather data to be persisted

Returns:
Object

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:

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:

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

unfollow()
Character.js, line 506

Stop following whoever the character was following

Fires:

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

combatantAdded
Character.js, line 283

Parameters:
Name Type Description
target Character

combatantRemoved
Character.js, line 303

Parameters:
Name Type Description
target Character

combatEnd
Character.js, line 310

combatStart
Character.js, line 240

Fired when Character#initiateCombat is called

damaged
Damage.js, line 68

Parameters:
Name Type Description
damage Damage
finalAmount Number

effectAdded
EffectList.js, line 132

effectRemoved
EffectList.js, line 153

equip
Character.js, line 381

Parameters:
Name Type Description
slot string
item Item

followed
Character.js, line 495

Parameters:
Name Type Description
target Character

gainedFollower
Character.js, line 523

Parameters:
Name Type Description
follower Character

heal
Heal.js, line 21

Parameters:
Name Type Description
heal Heal
target Character
finalAmount number

healed
Heal.js, line 29

Parameters:
Name Type Description
heal Heal
finalAmount number

hit
Damage.js, line 60

Parameters:
Name Type Description
damage Damage
target Character
finalAmount Number

lostFollower
Character.js, line 537

Parameters:
Name Type Description
follower Character

unequip
Character.js, line 411

Parameters:
Name Type Description
slot string
item Item

unfollowed
Character.js, line 508

Parameters:
Name Type Description
following Character