Difference between revisions of "ISXOgre:MethodsAndMembers"

From ISXOgre
Jump to: navigation, search
(OgreBot functions available for call)
(OgreBot functions available for call)
Line 15: Line 15:
 
----
 
----
 
* CastFromUplink(string CommandForWho, string AbilityName)
 
* CastFromUplink(string CommandForWho, string AbilityName)
 +
** '''NOTE''' AbilityName MUST BE THE BASE NAME.
 +
*** Examples of CORRECT AbilityName's: Kick, Punch, Channel
 +
*** Examples of INCORRECT AbilityName's: Kick III, Punch VI, Channel II
 
** Example of usage: relay all "Script[\${OgreBotScriptName}]:QueueCommand[Call CastFromUplink All Sanctuary]"
 
** Example of usage: relay all "Script[\${OgreBotScriptName}]:QueueCommand[Call CastFromUplink All Sanctuary]"
 
** Note: Abilities with spaces need to be escaped.
 
** Note: Abilities with spaces need to be escaped.

Revision as of 18:53, 2 September 2010

ISXOgre Methods and Members

Note: This page is for scripters/people who plan to edit various files via code.


Members

  • bool IsReady - returns if the extension is loaded and ready to be used.


Methods

  • Patch - Runs the ISXOgre patcher to update files. This is generally used when you have the NoPatch option set to true.


OgreBot functions available for call


  • CastFromUplink(string CommandForWho, string AbilityName)
    • NOTE AbilityName MUST BE THE BASE NAME.
      • Examples of CORRECT AbilityName's: Kick, Punch, Channel
      • Examples of INCORRECT AbilityName's: Kick III, Punch VI, Channel II
    • Example of usage: relay all "Script[\${OgreBotScriptName}]:QueueCommand[Call CastFromUplink All Sanctuary]"
    • Note: Abilities with spaces need to be escaped.
      • Example: relay all "Script[\${OgreBotScriptName}]:QueueCommand[Call CastFromUplink All \"Divine Recovery\"]"

OgreBot Parameter information


  • CommandForWho options
    • all - Everyone
    • Mage/Mages - Archetype of Mage
    • Melee - Archetype of Fighter or scout
    • Healer/Healers - Archetype of priest
    • Caster/Casters - Archetype of priest or mage
    • Toonname - Specific toonnames