|
Warhorse ScripBind documentation
|
   |
   |
C_ScriptBind_Soul Methods
|
Warhorse ScripBind documentation
|
|
|
The methods of the C_ScriptBind_Soul class are listed here.
|
|
Name |
Description |
 |
Syntax: soul:AddBuff(string buff_id) Adds buff identified by the database id. Returns the instance id. | |
|
|
Syntax: soul:AddSkillXP(string skill, float xp) Adds experience points. Returns how many levels had been reached (0 if no level was reached). | |
|
|
Syntax: soul:AddStatXP(string stat, float xp) Adds experience points. Returns how many levels had been reached (0 if no level was reached). | |
|
|
This is AttachTo, a member of class C_ScriptBind_Soul. | |
|
|
| |
|
|
Syntax: soul:GetArchetype() Returns a table containing the archetype properties. | |
|
|
Syntax: soul:GetGatherMult( ScriptHandle id) gets gather skill multiplier | |
|
|
Syntax: soul:GetHobbies() Returns a table containing all soul's hobbies. | |
 |
This is GetMemoryUsage, a member of class C_ScriptBind_Soul. | |
|
|
Syntax: soul:GetRoles() Returns a table=array containing role ids. | |
|
|
Syntax: soul:GetSchedule() Returns a table containing float-encoded times indexed by activities. | |
|
|
Syntax: soul:GetSkillLevel(string skill) Get skill value using string name (use skill_name from database). | |
|
|
Syntax: soul:GetSkillProgress(string skill) Get skill progress from the current level to the next [0,1) using string name (use skill_name from database). | |
|
|
Syntax: soul:GetSocialClass() Returns social class as a table with Id, Name and Wealth keys. | |
|
|
Syntax: soul:GetState(string state) returns state value for a given name (health, stamina,...) | |
|
|
Syntax: soul:GetStatLevel(string stat) returns stat value for a given name (str, agi, spc, vit, hea, bar, ...) | |
|
|
Syntax: soul:GetStatProgress(string stat) returns stat progress from the current level to the next level [0,1) for a given name (str, agi, spc, vit, hea, bar, ...) | |
|
|
This is Release, a member of class C_ScriptBind_Soul. | |
|
|
Syntax: soul:RemoveBuff(buffInstanceId) Forces removal of a buff. Supply the buff instance id. | |
|
|
Syntax: soul:SetSkillLevel(string skill, float level) Set skill level using string name (use skill_name from database). | |
|
|
Syntax: soul:SetState(string state, float value) sets state value for a given name (health, stamina,...) | |
|
|
Syntax: soul:SetStatLevel(string stat, float level) sets stat level, for example soul:SetStatLevel('str', 20), sets strength to 20 |
|
Copyright (c) 2012. All rights reserved.
|
