Lua API
On this page

Character

Inherits from

Information about the current character. This is the class that scripts get access to at game.character.

Fields:

Allegiance Allegiance

read only

Information about the currently logged in character's allegiance

AnimTracker AnimTracker

read only

Information about the currently logged in character's animation state

BurdenUnits number

read only

Your current burden units. Your max burden units (for 100% burden) uses the formula Strength * 150.

BusyTracker BusyTracker

read only

Information about the currently logged in character's busy state

CombatMode CombatMode

read only

The combat mode the character is in

Containers WorldObject[]

read only

List of child container objects, including foci

Equipment WorldObject[]

read only

List of objects equipped to this character.

Fellowship Fellowship

read only

Information about the currently logged in character's fellowship state

Id number

read only

The id of the currently logged in character

InPortalSpace boolean

read only

Wether or not the currently logged in character is in portal space

Inventory WorldObject[]

read only

A list of all objects in your inventory, pulls items from containers as well. (This excludes equipped items and actual containers)

MaxBurdenUnits number

read only

The maximum burden units you can hold before becoming overburdened (100% burden).

Options1 CharacterOptions1

read only

Character Options

SpellBook SpellBook

read only

Information about the currently logged in character's spellbook. (known spells, spell helpers, etc)

Stance MotionStance

read only

The stance the character is in

Trade Trade

read only

Information about the currently logged in character's trade state

Vitae number

read only

Character's current vitae 1 = no vitea, 0.95 = 5% vitae

Weenie WorldObject

read only

The weenie of the currently logged in character

Events:

OnCastSpellAttempt CastSpellAttemptEventArgs

Fired any time your character attempts to cast a spell

OnDeath DeathEventArgs

Fired when your character dies

OnEnchantmentsChanged EnchantmentsChangedEventArgs

Fired when active enchantments change

OnLevelChanged LevelChangedEventArgs

Fired when your character levels up

OnPortalSpaceEntered EventArgs

Fired when portal space is entered (not on login, so the first event is OnPortalSpaceExited)

OnPortalSpaceExited EventArgs

Fired when exiting portal space. (this fires for the first time after logging in, while exiting login portal space)

OnSharedCooldownsChanged SharedCooldownsChangedEventArgs

Fired when object cooldowns change

OnTotalExperienceChanged TotalExperienceChangedEventArgs

Fired when your total experience changes

OnVitaeChanged VitaeChangedEventArgs

Fired when your character's vitae changes

OnVitalChanged VitalChangedEventArgs

Fired when one of your vitals current value changes.

Methods:

ActiveEnchantments() : Enchantment[]

A list of active enchantments on this character. Does not include overlapping enchantments

AllEnchantments() : Enchantment[]

A list of all enchantments on this character. This includes enchantments that may be overriden by other enchantments.

GetActiveEnchantments(attributeId: AttributeId) : Enchantment[]

Gets a list of active enchantments on this character that affect the specified attribute type.

Parameters:
NameTypeDefaultSummary
attributeIdAttributeId

GetActiveEnchantments(skillId: SkillId) : Enchantment[]

Gets a list of active enchantments on this character that affect the specified skill type.

Parameters:
NameTypeDefaultSummary
skillIdSkillId

GetActiveEnchantments(vitalId: VitalId) : Enchantment[]

Gets a list of active enchantments on this character that affect the specified vital

Parameters:
NameTypeDefaultSummary
vitalIdVitalId

GetEnchantmentsAdditiveModifier(attributeId) attributeId AttributeId

GetEnchantmentsAdditiveModifier(type) type SkillId

GetEnchantmentsAdditiveModifier(type) type VitalId

GetEnchantmentsMultiplierModifier(type) type VitalId

GetEnchantmentsMultiplierModifier(type) type SkillId

GetEnchantmentsMultiplierModifier(type) type AttributeId

GetFirstInventory(matchFunction) matchFunction function

GetFirstInventory(name) name string

GetFirstInventory(objectClass) objectClass ObjectClass

GetInventory(matchFunction) matchFunction function

GetInventory(name) name string

GetInventory(objectClass) objectClass ObjectClass

GetInventoryCount(matchFunction) matchFunction function

GetInventoryCount(name) name string

GetInventoryCount(objectClass) objectClass ObjectClass

GetMagicSkill(school) school MagicSchool

GetPropertyKeys(source)

SharedCooldowns()

ToString()