Difference between revisions of "ISXOgre:MethodsAndMembers"

From ISXOgre
Jump to: navigation, search
(OgreBot functions available for call)
(ISXOgre Methods and Members)
Line 9: Line 9:
 
'''''Methods'''''
 
'''''Methods'''''
 
* Patch - Runs the ISXOgre patcher to update files. This is generally used when you have the NoPatch option set to true.
 
* Patch - Runs the ISXOgre patcher to update files. This is generally used when you have the NoPatch option set to true.
 
+
* Repatch - Runs the patcher with the current version - 1. Example: If you are on Patch 20, doing a Repatch would patch as if you were on Patch 19, and repatch all files patched with Patch 20.
 
+
* Repatch[#] - Runs the patcher specifying to patch from the #. Example: If you are on Patch 20, doing a Repatch[5] will repatch all files from Patch 5 to the latest (20 in this example).
 +
** Doing a Repatch[0] will re-download every single file. This is useful if you completely broke something.
  
 
== OgreBot functions available for call ==
 
== OgreBot functions available for call ==

Revision as of 13:03, 23 October 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.
  • Repatch - Runs the patcher with the current version - 1. Example: If you are on Patch 20, doing a Repatch would patch as if you were on Patch 19, and repatch all files patched with Patch 20.
  • Repatch[#] - Runs the patcher specifying to patch from the #. Example: If you are on Patch 20, doing a Repatch[5] will repatch all files from Patch 5 to the latest (20 in this example).
    • Doing a Repatch[0] will re-download every single file. This is useful if you completely broke something.

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