ISXEQ2:character (Data Type)
From ISMods Wiki
Contents |
[edit]
ISXEQ2 information for ISXEQ2:character (Data Type) has moved
[edit]
Please see: http://eq2.isxgames.com/wiki for up-to-date content.
[edit]
Description
This Data Type includes all of the data available to ISXEQ2 that can be gathered from the character Information structure.
[edit]
Members
- int ID
- string Name
- string Race
- string Class
- string Race
- string Archetype
- string Class
- string SubClass
- string TSArchetype
- string TSClass
- string TSSubClass
- string Gender
- string PetName
- Location
- float X
- float Y
- float Z
- float Heading
- bool IsMoving
- bool InGameWorld
- bool AtCharSelect
- string BindLocation
- string HouseLocation
- float WaterDepth
- Returns your current depth in the water
- Experience/Level/Status
- int Exp
- Returns the percent Experience gained towards the next adventurer level
- Returns the percent Experience gained towards the next tradeskill level
- Returns the percent of current adventurer vitality
- float TSVitality
- Returns the percent of current tradeskill vitality
- float MentoringXPAdj
- int Level
- int EffectiveLevel
- int TSLevel
- int CurrentStatus
- int LifetimeGuildStatus
- float APExp
- int TotalEarnedAPs
- int MaxAPs
- Achievement Achievement[# or string]
- Parameter can be one of the following:
- The index (1-26) of the achievment
- The ID # of the achievement
- The name of the achievement
- Consignment system
- Please note that you must be in a broker transation AND have the broker targetted for these members to work
- int NumConsignmentItems (int type)
- Returns the number of items you currently are selling on consignment through the broker system.
- Consignment <tt>Consignment[# or string]
- Works exactly the same as the 'Merchandise' member of the character datatype with the exception that this member deals with items you are selling via consignment on the broker system.
- VendingContainer <tt>Vending[# or string]
- would be the location of the vending container (1-6);
- 'string' would be an exact name of the vending container you're wanting to access.
- Example: 'echo ${Me.Vending[sturdy backpack].CapacityUsed}'
- int <tt>TotalVendingCapacity
- Total slot capacity of all your vending containers combined.
- int VendingCapacityUsed
- Number of vending container slots currently being used
- int VendingCapacityFree
- Number of vending container slots currently free for use
- Combat Stats
- float Mitigation
- Returns the percent of current overall mitigation
- float OverallAvoidance
- Returns the percent of overall Avoidance. This value takes into account all avoidances types (Avoidance,Parry,Deflection, and Block). This is value that is displayed in the persona window as your "avoidance percent".
- Money
- Health/Power/Breath
- Spells & Concentration
- int CountMaintained
- Returns the number of spells the character is currently maintaining
- Returns the number of spells by which the character is currently affected
- maintained Maintained[# or <string>]
- This member works for Maintained Buffs 1-30 (zero is not used) or accepts a <string> which would be a substring of the buff/debuff name for which you are searching.
- Effects
- effect Effect[# or <string>]
- This member works for Effects 1-30 (zero is not used) or accepts a <string> which would be a substring of the effect name for which you are searching.
- bool IsAfflicted
- Returns true if player is afflicted by arcane, noxious, etc..
- int Noxious
- The affliction count for this affliction type (A value of -1 indicates that the affliction is incurable.)
- int Trauma
- The affliction count for this affliction type (A value of -1 indicates that the affliction is incurable.)
- int Elemental
- The affliction count for this affliction type (A value of -1 indicates that the affliction is incurable.)
- int Arcane
- The affliction count for this affliction type (A value of -1 indicates that the affliction is incurable.)
- General Stats
- Resists
- Group Information
- int GroupCount
- bool Grouped
- GroupMember Group[#|<name>]
- Parameter can be 1-5 or a player's name
- Note: Your character is not considered part of the group. Just think of yourself as group member 0.
- Raid Information
- int RaidCount
- RaidMember Raid[# or "string"]
- Works similar to the 'Group' member
- When iterating through the raid list, always check from 1 to 24 even though your 'RaidCount' might be lower than 24.
- Also, YOU will be included in the 24 raid members.
- actor ToActor
- This converts the 'character' datatype object into an 'actor' datatype object.
- actor CursorActor
- This member will return an 'actor' object of whatever is currently underneath your mouse cursor.
- Inventory
- item Inventory[parameters]
- This array includes all items that you possess, including items that are in your bank.
- See Item Search Forms and Parameters below for more information on this member
- item Equipment[parameters]
- This array only includes items that you currently have equipped.
- See Item Search Forms and Parameters below for more information on this member
- item CustomInventory[parameters]
- See Custom Item Search Forms and Parameters below for more information on this member
- (Note: To create your custom inventory array, use the CreateCustomInventoryArray method illustrated later in this document.)
- merchandise Merchandise[# or <string>]
- This member returns a 'merchandise' object that the character is currently capable of selling based upon either the index of its location within the array or a substring :of the item's name.
- int NumItemsICanSell
- Returns the number of items that the character is capable of selling (ie, the number of items in the inventory minus the number of NO VALUE and NO TRADE items.)
- Returns an integer which is the ID of the first available container in the inventory that has an open slot
- Abilities and Recipes
- ability Ability[# or <string>]
- This member returns an 'ability' object based upon the index of the ability (from 1 through NumAbilities) or the exact name of the ability. "Abilities" are defined as anything found in your Knowledge book.
- int NumAbilities
- Returns the number of abilities your character currently has in his/her knowledge book.
- recipe Recipe[# or <string>]
- This member returns a 'recipe' object based upon the index of the recipe (from 1 through NumRecipes) or a substring of the recipe.
- int NumRecipes
- Returns the number of recipes your character currently has in his/her recipe book.
- Current Status/Action
-
- Returns TRUE if you are currently casting a spell
- Returns TRUE if you're in combat, even if autoattack is off
- int InRaid
- bool InWater
- bool IsCamping
- bool IsSitting
- bool IsAFK
- bool IsLFG
- bool IsLFW
- bool IsAnonymous
- bool IsRolePlaying
- bool IsDecliningGroupInvites
- bool IsDecliningTradeInvites
- bool IsDecliningDuelInvites
- bool TargetLOS
- Returns TRUE if you have Line of Sight to your current target
- float TimeToCampOut
- In seconds. Starts at 20, and updates every 5 seconds.
[edit]
Methods
- face[#]
- TakeAllVendingCoin
- Retrieves all of the money available in all your vending containers
- CreateCustomInventoryArray
- If no parameter is given, then it creates an array with ALL inventory items -- this does not include worn items.
- CreateCustomInventoryArray[nonbankonly]
- Creates an array with only the inventory items that are not in your bank or shared bank.
- CreateCustomInventoryArray[bankonly]
- Creates an array which only includes items that are in your bank or shared bank.
[edit]
Returns
[edit]
Inherits
[edit]
