Difference between revisions of "ISXOgre:MethodsAndMembers"
From ISXOgre
(→OgreBot functions available for call) |
|||
| (11 intermediate revisions by 3 users not shown) | |||
| Line 5: | Line 5: | ||
'''''Members''''' | '''''Members''''' | ||
* bool IsReady - returns if the extension is loaded and ready to be used. | * bool IsReady - returns if the extension is loaded and ready to be used. | ||
| − | + | * string Version - returns the string version information about the extension | |
| − | + | * member:SkinName - returns the current skin "Ogre" files are using. | |
'''''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. | ||
| + | * method:SetSkinName[string] - takes a string parameter and sets the skinname to it. Note: The skin must already be loaded. By default, ISXOgre loads "eq2" (from the /skins/eq2/ directory) and it loads "Eq2Ogre" (from the /skins/EQ2Ogre/ directory). EQ2Ogre is now the default. | ||
== OgreBot functions available for call == | == OgreBot functions available for call == | ||
---- | ---- | ||
* CastFromUplink(string CommandForWho, string AbilityName) | * CastFromUplink(string CommandForWho, string AbilityName) | ||
| − | ** Example of usage: relay all "Script[\${OgreBotScriptName}]:QueueCommand[ | + | ** '''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\"]" | ||
| + | |||
| + | * CastFromUplinkOnPlayer(string CommandForWho, string AbilityName, string ToonName). | ||
| + | ** Follows the same rules as CastFromUplink, but takes the 3rd parameter for who to cast the ability on. | ||
| + | |||
| + | * a_OgreBotChangeCampSpot - Takes 3 parameters, x, y, z. Currently there are no "checks" in place, so it will change an existing campspot to whatever location you pass it. | ||
| + | **Example of usage: a_OgreBotChangeCampSpot 0 -24 300 | ||
| + | |||
| + | * ogrebotatom <parameters> | ||
| + | ** Allows for relays to only be executed if ogrebot is running. | ||
| + | |||
| + | *Ob_AutoTarget:LoadListFromSaveListForWho[listname,ForWho] | ||
| + | ** Allows you to load an AutoTarget list on a specific toon. | ||
| − | == OgreBot | + | == OgreBot Parameter information == |
---- | ---- | ||
* CommandForWho options | * CommandForWho options | ||
| Line 25: | Line 44: | ||
** Healer/Healers - Archetype of priest | ** Healer/Healers - Archetype of priest | ||
** Caster/Casters - Archetype of priest or mage | ** Caster/Casters - Archetype of priest or mage | ||
| + | ** G# - If you are in a raid, only effects people in that group. G2 = Group 2. | ||
| + | ** Class/Subclass/Archetype - All 40 of them work. Examples: | ||
| + | *** Coercer - Would activate for a Coercer only. | ||
| + | *** Enchanter - Would activate for Illuisionist or Coercers only. | ||
| + | *** Mage - Would activate for any mage. | ||
** Toonname - Specific toonnames | ** Toonname - Specific toonnames | ||
Latest revision as of 06:38, 30 March 2013
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.
- string Version - returns the string version information about the extension
- member:SkinName - returns the current skin "Ogre" files are using.
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.
- method:SetSkinName[string] - takes a string parameter and sets the skinname to it. Note: The skin must already be loaded. By default, ISXOgre loads "eq2" (from the /skins/eq2/ directory) and it loads "Eq2Ogre" (from the /skins/EQ2Ogre/ directory). EQ2Ogre is now the default.
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\"]"
- NOTE AbilityName MUST BE THE BASE NAME.
- CastFromUplinkOnPlayer(string CommandForWho, string AbilityName, string ToonName).
- Follows the same rules as CastFromUplink, but takes the 3rd parameter for who to cast the ability on.
- a_OgreBotChangeCampSpot - Takes 3 parameters, x, y, z. Currently there are no "checks" in place, so it will change an existing campspot to whatever location you pass it.
- Example of usage: a_OgreBotChangeCampSpot 0 -24 300
- ogrebotatom <parameters>
- Allows for relays to only be executed if ogrebot is running.
- Ob_AutoTarget:LoadListFromSaveListForWho[listname,ForWho]
- Allows you to load an AutoTarget list on a specific toon.
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
- G# - If you are in a raid, only effects people in that group. G2 = Group 2.
- Class/Subclass/Archetype - All 40 of them work. Examples:
- Coercer - Would activate for a Coercer only.
- Enchanter - Would activate for Illuisionist or Coercers only.
- Mage - Would activate for any mage.
- Toonname - Specific toonnames
