Updated Lua Spell (markdown)

KimLS
2014-09-27 14:35:09 -07:00
parent a8550150a3
commit bc3f80f5c5
+96 -86
@@ -1,87 +1,97 @@
Spell is a class exported to Lua that represents the spdat object from EQEmu. Spell is a class exported to Lua that represents the spdat object from EQEmu.
[Return to the Lua API](Lua-API) [Return to the Lua API](Lua-API)
### Properties ### Properties
``` ```
spell.null -- Returns true if this object is null spell.null -- Returns true if this object is null
spell.valid -- Returns true if this object is not null spell.valid -- Returns true if this object is not null
``` ```
### Member Functions ### Member Functions
``` ```
Spell() -- Creates a null spell Spell() -- Creates a null spell
Spell(Integer id) -- Creates a spell with a specific id Spell(Integer id) -- Creates a spell with a specific id
Integer ID(); Integer ID();
String Name(); String Name();
String Player1(); String Player1();
String TeleportZone(); String TeleportZone();
String YouCast(); String YouCast();
String OtherCasts(); String OtherCasts();
String CastOnYou(); String CastOnYou();
String CastOnOther(); String CastOnOther();
String SpellFades(); String SpellFades();
Real Range(); Real Range();
Real AoeRange(); Real AoeRange();
Real PushBack(); Real PushBack();
Real PushUp(); Real PushUp();
Integer CastTime(); Integer CastTime();
Integer RecoveryTime(); Integer RecoveryTime();
Integer RecastTime(); Integer RecastTime();
Integer BuffdurationFormula(); Integer BuffdurationFormula();
Integer BuffDuration(); Integer BuffDuration();
Integer AEDuration(); Integer AEDuration();
Integer Mana(); Integer Mana();
Integer Base(Integer i); Integer Base(Integer i);
Integer Base2(Integer i); Integer Base2(Integer i);
Integer Max(Integer i); Integer Max(Integer i);
Integer Components(Integer i); Integer Components(Integer i);
Integer ComponentCounts(Integer i); Integer ComponentCounts(Integer i);
Integer NoexpendReagent(Integer i); Integer NoexpendReagent(Integer i);
Integer Formula(Integer i); Integer Formula(Integer i);
Integer GoodEffect(); Integer GoodEffect();
Integer Activated(); Integer Activated();
Integer ResistType(); Integer ResistType();
Integer EffectID(Integer i); Integer EffectID(Integer i);
Integer TargetType(); Integer TargetType();
Integer BaseDiff(); Integer BaseDiff();
Integer Skill(); Integer Skill();
Integer ZoneType(); Integer ZoneType();
Integer EnvironmentType(); Integer EnvironmentType();
Integer TimeOfDay(); Integer TimeOfDay();
Integer Classes(Integer i); Integer Classes(Integer i);
Integer CastingAnim(); Integer CastingAnim();
Integer SpellAffectIndex(); Integer SpellAffectIndex();
Integer DisallowSit(); Integer DisallowSit();
Integer Deities(Integer i); Integer Deities(Integer i);
Integer Uninterruptable(); Integer Uninterruptable();
Integer ResistDiff(); Integer ResistDiff();
Integer RecourseLink(); Integer RecourseLink();
Integer ShortBuffBox(); Integer ShortBuffBox();
Integer DescNum(); Integer DescNum();
Integer EffectDescNum(); Integer EffectDescNum();
Integer BonusHate(); Integer BonusHate();
Integer EndurCost(); Integer EndurCost();
Integer EndurTimerIndex(); Integer EndurTimerIndex();
Integer HateAdded(); Integer HateAdded();
Integer EndurUpkeep(); Integer EndurUpkeep();
Integer NumHits(); Integer NumHits();
Integer PVPResistBase(); Integer PVPResistBase();
Integer PVPResistCalc(); Integer PVPResistCalc();
Integer PVPResistCap(); Integer PVPResistCap();
Integer SpellCategory(); Integer SpellCategory();
Integer CanMGB(); Integer CanMGB();
Integer DispelFlag(); Integer DispelFlag();
Integer MinResist(); Integer MinResist();
Integer MaxResist(); Integer MaxResist();
Integer ViralTargets(); Integer ViralTargets();
Integer ViralTimer(); Integer ViralTimer();
Integer NimbusEffect(); Integer NimbusEffect();
Real DirectionalStart(); Real DirectionalStart();
Real DirectionalEnd(); Real DirectionalEnd();
Integer SpellGroup(); Integer SpellGroup();
Integer PowerfulFlag(); Integer PowerfulFlag();
Integer CastRestriction(); Integer CastRestriction();
Boolean AllowRest(); Boolean AllowRest();
Integer DamageShieldType(); Boolean InCombat();
Boolean OutOfCombat();
Integer AEMaxTargets();
Integer MaxTargets();
Boolean PersistDeath();
Real MinDist();
Real MinDistMod();
Real MaxDist();
Real MaxDistMod();
Real MinRange();
Integer DamageShieldType();
``` ```