ISXOgre - User contributions [en]

OgreAutoTargetBalance

2019-11-14T13:12:45Z

Pork: Created page with "== Main Overview == File:AutoTargetBalance.png *Will load specified actor's into your auto target tab and balance them via % added. * Load via ** ogre autotargetbalance..."

== Main Overview ==
[[File:AutoTargetBalance.png]]

*Will load specified actor's into your auto target tab and balance them via % added.
* Load via
** ogre autotargetbalance
** ogre atb

File:AutoTargetBalance.png

2019-11-14T13:06:29Z

Pork:

ForWho

2019-11-14T13:04:21Z

Pork: /* Advanced Options */

== For Who ==
When issuing commands to OgreBot, most commands take a 'ForWho' parameter. This is how you specify who will execute or process the request you are giving.

The most common one is 'all', meaning everyone.

=== Options ===
{| class="wikitable"
|-
!Command
!colspan="2"|Parameter & Description
|-
|rowspan="1"|<center>'''all'''</center>||colspan="2"|Everyone
|-
|rowspan="1"|<center>'''groups:#'''</center>||colspan="2"|If you are in raid, the Group specified will do it. For example: 'groups:2' would mean only group 2
|-
|rowspan="1"|<center>'''Class'''</center>||colspan="2"|Your Class. For example: 'guardian' - would mean only Guadians.
|-
|rowspan="1"|<center>'''Ascension Class'''</center>||colspan="2"|Your Class. For example: 'Elementalist' - would mean only Elementalists.
|-
|rowspan="1"|<center>'''Subclass'''</center>||colspan="2"|Your Subclass. For example: 'Crusader' - Would mean only Shadowknight and paladins.
|-
|rowspan="1"|<center>'''Archetype'''</center>||colspan="2"|Your archetype. For example: 'Scout' - Would mean only scouts.
|-
|rowspan="1"|<center>'''Not Archetype'''</center>||colspan="2"|Not your archetype. For example: 'NotFighter' - Would mean anyone who is not a fighter.
|-
|rowspan="1"|<center>'''Melee'''</center>||colspan="2"|If I consider you melee. Refers to Fighters and Scouts.
|-
|rowspan="1"|<center>'''NotMelee'''</center>||colspan="2"|Refers to not being melee. So Mages and Priests.
|-
|rowspan="1"|<center>'''Casters'''</center>||colspan="2"|If I consider you a caster. Refers to Mages and Priests.
|-
|rowspan="1"|<center>'''NotCasters'''</center>||colspan="2"|Refers to not being a caster. So Fighters and Scouts.
|-
|rowspan="1"|<center>'''IGW:___'''</center>||colspan="2"|Stands for: In Group With. Example: 'IGW:Kannkor' - Refers to Kannkor and anyone in the group with Kannkor
|-
|rowspan="1"|<center>'''IGWBN:___'''</center>||colspan="2"|Stands for: In Group With But Not. Example: 'IGWBN:Kannkor' - Refers to anyone in the group with Kannkor, but not Kannkor.
|-
|rowspan="1"|<center>'''IRW:___'''</center>||colspan="2"|Stands for: In Raid With. Example: 'IRW:Kannkor' - Refers to Kannkor and anyone in the raid with Kannkor.
|-
|rowspan="1"|<center>'''IRWBN:___'''</center>||colspan="2"|Stands for: In Group With But Not. Example: 'IRWBN:Kannkor' - Refers to anyone in the raid with Kannkor, but not Kannkor.
|-
|rowspan="1"|<center>'''Not:___'''</center>||colspan="2"|Stands for Not:Player. Example: 'Not:Kannkor' - Refers to anyone who is not Kannkor.
|-
|rowspan="2"|<center>'''Not<classification>'''</center>
|colspan="2"|Stands for Not<classification>. Example: 'Not:priest' - Refers to anyone who is not a priest.
|-
|colspan="2"|Parameters currently supported:
*NotScout
*NotFighter
*NotMage
*NotPriest
*NotMelee (mage or priest)
*NotCaster (scout or fighter)
|-
|}

=== Advanced Options ===
You can use "or" by using the delimiter |. This will split the check into multiple pieces. Where if all of the checks in a delimiter are valid, it will return true. See examples below.

You can use "and" to perform multiple checks. Prepend the check with +.

You can get the opposite value. Prepend the check with -.

* Example 1
** fighter|scout
*** Fighter or scout
* Example 2
** fighter+groups:1
*** Fighter in group 1 (in a raid situation)
* Example 3
** fighter|scout+groups:1
*** Fighter (doesn't matter what group) OR a scout in group 1.
**** Note: The only way to make this check for groups:1 for fighters or scouts is: fighter+groups:1|scout+groups:1, which would result in a fighter in groups:1 OR a scout in groups:1.
* Example 4
** -fighter
*** TRUE if you are NOT a fighter. FALSE if you ARE a fighter.
* Example 5
** -mage+-scout+-priest
*** TRUE if you are NOT a mage and NOT a scout and NOT a priest. (A really ugly way to say 'fighter').
* Example 6
** fighter+groups:1+-kannkor
*** Fighters in group 1 whom are NOT named 'Kannkor'
* Example 7
** all+-priest
*** Everyone except for priests. (notpriest would be easier)
* Example 8
** all+-kannkor+-user01+-primalz
*** Everyone except for kannkor, user01, and primalz.
* Example 9
** kannkor|user01|primalz
*** Only people named: kannkor|user01|primalz

== ForWho Button ==

* ForWho Button - *When MCP loads, there is now a new window. Labeled 'For Who'.
**This will modify MCP buttons in real time. There's two sections.
***ForWhere (OgreConsole and IRC)
****If NONE of these are selected, then it uses whatever kind of button it was. For example: If you have a "Cast" button, that would use OgreConsole. If you have a "OgreIRC" button, that will use IRC.
****If you select OgreConsole, then ALL buttons will be sent to OgreConsole, including those that are set as 'OgreIRC'.
****Likewise, if you select IRC, all OgreConsole buttons will be sent to IRC. Note: IRC must be set up prior or these commands will be sent to the avoid. IRC is generally used for bot raiding.
***ForWho
****Any button where a ForWho is possible, and it is not specified, will be converted based on your selection. For example:
*****MCP -> Jump. If you do not specify the ForWho (leave it blank), the default is all. However, is you select something in the list, such as [x] Mages only, it will then only apply to mages. You could then select Priests only, and press it again, and only priests would jump.
****There is a [x] Multi-select option, that lets you select more than one option. You need to be smart about this, as you can make impossible scenarios. Such as: [x] Mage only and [x] Priest only. This is an AND, not an OR. If you selected both, it means someone would need to be a MAGE and a PRIEST, which is impossible, so no one would listen to your button. Multi-select isn't used often, but cases where it is used, are usually for a specific group and a specific class. Such as: [x] G3 Only and [x] Mages only. This means Group 3 and Mages only will listen to the command.
[[File:ForWho.PNG]]
*[x] IRC Me Only
**This will be phased out, as using [x] OgreConsole will do the same thing
*When you hide (alt+~) MCP, it will hide the ForWho window also. When you unhide MCP (alt+~), if the ForWho window was visible before it was hidden, it will be visible again. If it was hidden before, it will remain hidden.
*This window is HIDDEN by default. You can click the [ForWho] button (beside the [Setup] button) on the MCP to show it. If you wish for it to always be shown on load, inside of [Setup] is a checkbox that will have it show on load.
*If you wish to specifically invoke this new behaviour, you can do so via command line. Using the keyword "auto" in place of any forwho, and adding a -cfw <ForWhoHere> BEFORE any commands. Example: !c -cfw g1, would result in all commands on that same line, having a default of 'g1' if it's not supplied.
*In order to complete this change, I had to manually change every single OgreConsole/MCP command that exists. That means every single button. It's possible I made a mistake/typo. If ANY button that was working prior, is not working now, please right click it (to edit it), then take a picture and send it to me. Then I can reproduce the button and fix it. Please include a picture of your ForWho UI also, so I know what you have checked.

ForWho

2019-11-14T13:03:07Z

Pork: /* Options */

== For Who ==
When issuing commands to OgreBot, most commands take a 'ForWho' parameter. This is how you specify who will execute or process the request you are giving.

The most common one is 'all', meaning everyone.

=== Options ===
{| class="wikitable"
|-
!Command
!colspan="2"|Parameter & Description
|-
|rowspan="1"|<center>'''all'''</center>||colspan="2"|Everyone
|-
|rowspan="1"|<center>'''groups:#'''</center>||colspan="2"|If you are in raid, the Group specified will do it. For example: 'groups:2' would mean only group 2
|-
|rowspan="1"|<center>'''Class'''</center>||colspan="2"|Your Class. For example: 'guardian' - would mean only Guadians.
|-
|rowspan="1"|<center>'''Ascension Class'''</center>||colspan="2"|Your Class. For example: 'Elementalist' - would mean only Elementalists.
|-
|rowspan="1"|<center>'''Subclass'''</center>||colspan="2"|Your Subclass. For example: 'Crusader' - Would mean only Shadowknight and paladins.
|-
|rowspan="1"|<center>'''Archetype'''</center>||colspan="2"|Your archetype. For example: 'Scout' - Would mean only scouts.
|-
|rowspan="1"|<center>'''Not Archetype'''</center>||colspan="2"|Not your archetype. For example: 'NotFighter' - Would mean anyone who is not a fighter.
|-
|rowspan="1"|<center>'''Melee'''</center>||colspan="2"|If I consider you melee. Refers to Fighters and Scouts.
|-
|rowspan="1"|<center>'''NotMelee'''</center>||colspan="2"|Refers to not being melee. So Mages and Priests.
|-
|rowspan="1"|<center>'''Casters'''</center>||colspan="2"|If I consider you a caster. Refers to Mages and Priests.
|-
|rowspan="1"|<center>'''NotCasters'''</center>||colspan="2"|Refers to not being a caster. So Fighters and Scouts.
|-
|rowspan="1"|<center>'''IGW:___'''</center>||colspan="2"|Stands for: In Group With. Example: 'IGW:Kannkor' - Refers to Kannkor and anyone in the group with Kannkor
|-
|rowspan="1"|<center>'''IGWBN:___'''</center>||colspan="2"|Stands for: In Group With But Not. Example: 'IGWBN:Kannkor' - Refers to anyone in the group with Kannkor, but not Kannkor.
|-
|rowspan="1"|<center>'''IRW:___'''</center>||colspan="2"|Stands for: In Raid With. Example: 'IRW:Kannkor' - Refers to Kannkor and anyone in the raid with Kannkor.
|-
|rowspan="1"|<center>'''IRWBN:___'''</center>||colspan="2"|Stands for: In Group With But Not. Example: 'IRWBN:Kannkor' - Refers to anyone in the raid with Kannkor, but not Kannkor.
|-
|rowspan="1"|<center>'''Not:___'''</center>||colspan="2"|Stands for Not:Player. Example: 'Not:Kannkor' - Refers to anyone who is not Kannkor.
|-
|rowspan="2"|<center>'''Not<classification>'''</center>
|colspan="2"|Stands for Not<classification>. Example: 'Not:priest' - Refers to anyone who is not a priest.
|-
|colspan="2"|Parameters currently supported:
*NotScout
*NotFighter
*NotMage
*NotPriest
*NotMelee (mage or priest)
*NotCaster (scout or fighter)
|-
|}

=== Advanced Options ===
You can use "or" by using the delimiter |. This will split the check into multiple pieces. Where if all of the checks in a delimiter are valid, it will return true. See examples below.

You can use "and" to perform multiple checks. Prepend the check with +.

You can get the opposite value. Prepend the check with -.

* Example 1
** fighter|scout
*** Fighter or scout
* Example 2
** fighter+g1
*** Fighter in group 1 (in a raid situation)
* Example 3
** fighter|scout+g1
*** Fighter (doesn't matter what group) OR a scout in group 1.
**** Note: The only way to make this check for g1 for fighters or scouts is: fighter+g1|scout+g1, which would result in a fighter in g1 OR a scout in g1.
* Example 4
** -fighter
*** TRUE if you are NOT a fighter. FALSE if you ARE a fighter.
* Example 5
** -mage+-scout+-priest
*** TRUE if you are NOT a mage and NOT a scout and NOT a priest. (A really ugly way to say 'fighter').
* Example 6
** fighter+g1+-kannkor
*** Fighters in group 1 whom are NOT named 'Kannkor'
* Example 7
** all+-priest
*** Everyone except for priests. (notpriest would be easier)
* Example 8
** all+-kannkor+-user01+-primalz
*** Everyone except for kannkor, user01, and primalz.
* Example 9
** kannkor|user01|primalz
*** Only people named: kannkor|user01|primalz

== ForWho Button ==

* ForWho Button - *When MCP loads, there is now a new window. Labeled 'For Who'.
**This will modify MCP buttons in real time. There's two sections.
***ForWhere (OgreConsole and IRC)
****If NONE of these are selected, then it uses whatever kind of button it was. For example: If you have a "Cast" button, that would use OgreConsole. If you have a "OgreIRC" button, that will use IRC.
****If you select OgreConsole, then ALL buttons will be sent to OgreConsole, including those that are set as 'OgreIRC'.
****Likewise, if you select IRC, all OgreConsole buttons will be sent to IRC. Note: IRC must be set up prior or these commands will be sent to the avoid. IRC is generally used for bot raiding.
***ForWho
****Any button where a ForWho is possible, and it is not specified, will be converted based on your selection. For example:
*****MCP -> Jump. If you do not specify the ForWho (leave it blank), the default is all. However, is you select something in the list, such as [x] Mages only, it will then only apply to mages. You could then select Priests only, and press it again, and only priests would jump.
****There is a [x] Multi-select option, that lets you select more than one option. You need to be smart about this, as you can make impossible scenarios. Such as: [x] Mage only and [x] Priest only. This is an AND, not an OR. If you selected both, it means someone would need to be a MAGE and a PRIEST, which is impossible, so no one would listen to your button. Multi-select isn't used often, but cases where it is used, are usually for a specific group and a specific class. Such as: [x] G3 Only and [x] Mages only. This means Group 3 and Mages only will listen to the command.
[[File:ForWho.PNG]]
*[x] IRC Me Only
**This will be phased out, as using [x] OgreConsole will do the same thing
*When you hide (alt+~) MCP, it will hide the ForWho window also. When you unhide MCP (alt+~), if the ForWho window was visible before it was hidden, it will be visible again. If it was hidden before, it will remain hidden.
*This window is HIDDEN by default. You can click the [ForWho] button (beside the [Setup] button) on the MCP to show it. If you wish for it to always be shown on load, inside of [Setup] is a checkbox that will have it show on load.
*If you wish to specifically invoke this new behaviour, you can do so via command line. Using the keyword "auto" in place of any forwho, and adding a -cfw <ForWhoHere> BEFORE any commands. Example: !c -cfw g1, would result in all commands on that same line, having a default of 'g1' if it's not supplied.
*In order to complete this change, I had to manually change every single OgreConsole/MCP command that exists. That means every single button. It's possible I made a mistake/typo. If ANY button that was working prior, is not working now, please right click it (to edit it), then take a picture and send it to me. Then I can reproduce the button and fix it. Please include a picture of your ForWho UI also, so I know what you have checked.

ISXOgre

2019-10-31T19:28:01Z

Pork: /* Introduction */

<big>'''Welcome to Ogre Wiki.'''</big>

This page is for the Everquest 2 Ogre Adventure bot and Ogre Crafting bot.
OgreBot is a fully customizable adventure bot. OgreCraft is an advanced crafting bot.
* OgreBot and OgreCraft are part of the ISXOgre extension. However one thing to point out, ISXOgre does NOT do anything ISXEQ2 does. You REQUIRE ISXEQ2 in order to use ISXOgre.
* Lastly, ISXOgre requires a subscription, see Ogre Pricing for more details.

----

== Introduction ==

Ogrebot is a fully customizable adventure bot.

* [[WhyOgre|Why OgreBot? OgreBot vs the competition! (Adventure bot)]]

* [[WhyOgreCraft|Why OgreCraft? OgreCraft vs the competition! (Crafting bot)]]

* [[OgrePricing|Ogre Pricing]]

* [[ObtainingASubscription|How to obtain a subscription]]

* [[HowToCancelASubscription|How to cancel a subscription]]

* [[NewUserWalkthrough:Page01|New User Walkthrough]]

* [[Advanced User Tips|Advanced User Tips]] - Been with Ogre a little while now? Next Steps found here

* [[Ogre:FAQ|FAQ and Help]] - Including screen shots of examples of how to setup classes.

* [[Ogre:DidYouKnow|Did you know...]] - Random pieces of information that will help you sleep at night.

* [[ContactInfo|Contact information and Ventrilo]]

* [[RevisionHistory|Revision History]] - Here you will find the revision history. Every time a file is updated, I will do my best to include specifics of what was added, and any important details about it.

* [https://forge.isxgames.com/projects/ogrebot-eq2/issues Feature Requests] - Here you will find a list of items I have on my list to code. Some are new, some are upgrades etc.

* [https://forums.ogregaming.com/viewtopic.php?f=9&t=438 Donations] - Link to a Donation post.

== Ogre Bot ==

* [[Tab:Overview|Tabs]] - Click here for more information about each tab and to see screen shots.
* [[Aliases|Aliases]] - Aliases
* [[ProfileAliases|Profile Aliases]] - Aliases
* [[Raid Instances|Raid Options]] - Raid specific options
* [[Heroic Instances|Heroic Options]] - Heroic options
* [[OgreMCP|OgreMCP]] - Ogre Master Control Panel.
* [[UplinkController|Uplink Controller]] - It controls other sessions.
* [[OgreBotCommands| Ogre Commands]] - How to load Ogrebot, as well as various other commands included.
* [[OgreMapper| Ogre Mapping]] & [[Ogre Nav]] - mapping and moving
* [[OgreBotChatCommands| Ogre Chat Window Commands]] - In-game chat commands that Ogrebot responds to.
* [[OgreInfo|Ogre info | options | config]] - Loads a UI for user information and other Ogrebot options
* [[ISXOgre:MethodsAndMembers|ISXOgre methods and members]]
* [[ISXOgre:OgreProcessorlocking|Ogre Processor Locking]]
* [[OgreBot:UnfixableBugs|Unfixable bugs]]
* [[OgreEvents|OgreEvents]]
* [[ForWho|ForWho]] - Documentation for any place you need to reference a ForWho command

== Advanced Usage ==

* [[Torment Runes|Torment Runes]] - Setting up Torment Runes to be handled by OgreBot.

== Crafting - Harvesting & Depots ==

*'''Crafting'''
** [[OgreCraft:Overview|OgreCraft]]
** [[OgreCraft:MainWindow|Tabs]]
** [[OgreCraft:MethodsandMembers|Ogre Craft Methods and Members]]

*'''Harvesting'''
** [[Ogre GoblinHousePlant|Ogre Plant]] - Manages the house plant (Kunark Ascending Crafting Quests)
** [[Ogre GatherGoblin|Ogre Goblin]] - Manages the gathering goblin
** [[OgreOther:Hirex|HireX]] - HireX is a script that allows you to run guild hall hirelings automaticaly and have them put their harvests into the GH depots.
** [[OgreMapper|Ogre Map]] - A zone mapping and WP marking tool.
** Ogre Harvest -- In the ISXEQ2 Command Window type '''Ogre Harvest'''; should be used with Ogre Map, this will allow your toons to auto harvest.

*'''Depots'''
** [[OgreOther:Depots|Depot]] - Guild Hall Depot Management and Commands

* '''Tradeskill Apprentice Managment'''
** [[OgreTradeskillApprentice|Ogre Tradeskill Apprentice]]
** [[OgreTradeskillApprenticeManager|Ogre Tradeskill Apprentice Manager (TSAM)]]

*'''Transmute'''
** In your ISXEQ2 command drop down window type Ogre Transmute - Loads the Transmute UI (supports to level 110 now)

*'''Salvage'''
** In your ISXEQ2 command drop down window type Ogre Salvage - Loads the Salvage UI (supports to level 110 now)
***Please note you must have the salvage crafting AA in order to use this option

== Faction Scripts ==

* [[OgreOther:FreeportFaction|FreeportFaction]] - Freeport faction is a script to assist in the faction part of the betrayal quest.
* [[QeynosFaction|QeynosFaction]] - Qeynos faction is a script that assist in the faction part of the betrayal quest.
* [[OgreOther:Othmir|Othmir]] - Does repeatable faction quests in Great Divide. NOTE: This script is a use-as-is. It is NOT supported or maintained.

== Heroic / Raid Scripts ==

*'''Heroic Zones'''
* [[Heroic Instances]] - Heroic specific options

*'''Raid Zones'''
* [[Raid_Instances|Raid Options]] - Raid specific options

== Other Ogre Scripts ==

* [[OgreOther:AutoLogin|AutoLogin]] - Directions to set up some Auto Login scripts that will load multiple clients including across multiple pc's.
* [[OgreOther:Item|OgreItem]] - Currently in testing, only accessible by testers. An Item Database manager to help track what characters have what items.
* [[OgreOther:InventoryManager|Old Inventory Manager]] - Used to transfer items between toons and bags. A collection of scripts used to assist with inventory management.
* [[Ogre Inventory Manager|Ogre Inventory Manager]] - Used for all your inventory Needs. Sell - Destroy - Trade - Transmute/salvage/extract and more.
* [[OgreListManager|Ogre List Manager]] - Used to create custom lists for later use in other Ogre features.
* [[OgreAscensionDailyTask|Ogre Ascension Daily Task]] - Designed to run characters to ascension trainers to get their daily scrolls.
* [[OgreProvingGroundsTheUnderdepths|Ogre Proving Grounds: The Underdepths]] - Designed to run the proving grounds solo for each of your characters automagically
* [[Ogre Boat|Ogre Boat]] - Runs the Frillik Tide key quest in OF
* [[Ogre Collection Manager|Ogre Collection Manager]] - Both depot and inventory options for managing collectibles
* [[Ogre HideEffects|Ogre HideEffects]] - Helps cut down the number of effects in your spell effects window.
* [[Ogre TrackShiny|Ogre TrackShiny]] - Helps track down shinies nearby, can sort out colors.
* [[Ogre Zone Resetter|Ogre Zone Resetter]] - Zone Resetting User Interface
* [[Ogre Export|Ogre Export]] - Exports ability information for us in Ogre Bot
* [[Ogre Ability Efficiency|Ogre Ability Efficiency]] - parse your ability export and export it
* [[Ogre TempAdorns|Ogre TempAdorns]] - Make a List and Apply the List of Temporary Adorns to a Character.
* [[OgreMerchantCraft|Ogre Merchant Craft]] - Craft limited use recipes from merchant at merchant.
* [[OgreRPC|Ogre RPC]] - Checks your Raid Armour Patterns to see what is unlocked.
* [[OgreInfuse|Ogre Infuse]] - Infuse items Automatically with infusers or Plat.
* [[OgreReforge|Ogre Reforge]] - Reforge into a predefined or self defined set of stats.
* [[OgreAdorns|Ogre Adorns]] - Scans your inventory and Equipment and compares in a UI.
* [[OgreExperiment|Ogre Experiment]] - Loads a UI so you can make a list of items to experiment on and choose stats etc.
* [[OgreInstanceController|Ogre Instance Controller]] - IC - Runs Instances for you.
* [[OgreAutoTargetBalance|Ogre Auto Target Balance]] - Loads a UI where you can enter some basic information and create an Auto Target list for balancing mobs health.
* [[OgreSmartLoot|Ogre Smart Loot]] - Loads a UI to assist you in keeping track of specific looted items, and to ensure each specified team member acquires them.
* [[OgreCollectionChecker|Ogre Collection Checker]] - Scans inventory and depots in the area for Collection items still needed. If found, it adds them to your completed collections page.

* [[Miscellaneous Scripts|Miscellaneous Scripts]] - This page is for other smaller Ogre scripts to be compiled

== OgreAffiliates ==
* [[Ogre Affiliates|Ogre Affiliates]] - Scripts written and hosted inside of ogre
* [[ogreaautoquest|ogrea autoquest]] - Information about Autoquest what is scripted etc...

== OgreIRC ==

* [[OgreIRC:OgreIRC|OgreIRC]] - OgreIRC is a IRC plugin that hooks into the uplink and allows control of some functions inside sessions.

== Script Developers ==

* [[SpewStats|Spew Stats]] - A list of all spewstats options
* [[OgreBotAPI|OgreBotAPI]] - Methods & Members for scriptwriters to utilise
* [[OgreInstanceHelperAPI|Ogre Instance Helper API]] - Methods & Members for scriptwriters to utilise when making instance files
* [[OgreUtilitiesAPI|Ogre Utilities API]] - Methods & Members for scriptwriters to utilise when making instance files or local scripts

OgreInstanceController

2019-09-11T22:58:40Z

Pork: /* Main Overview */

== Main Overview ==

* Forum post explanation with video link at bottom of post.
[[https://forums.ogregaming.com/viewtopic.php?f=21&t=436| Twitch Recording]]

OgreInstanceController

2019-09-11T22:57:33Z

Pork: /* */

== Main Overview ==

=== Main Overview ===
[[https://forums.ogregaming.com/viewtopic.php?f=21&t=436| Twitch Recording]]

OgreInstanceController

2019-09-11T22:55:53Z

Pork: Created page with "== Main Overview == === === Twitch Recording"

== Main Overview ==

=== ===
[[https://updater.ogregaming.com/videos/2019-07-28_Instance_Controller.mkv| Twitch Recording]]

Tab:IM Broker

2019-09-11T22:41:06Z

Pork:

== Disclaimer ==
 
*This is Currently in BETA and as such may be Buggy or unfinished...
 
*While all testing has been done to make sure each script is working as intended some bugs may have slipped through.
*I am not responsible for any lost, sold or destroyed items.
 
*'''USE AT YOUR OWN RISK'''
 
== Main Overview ==
[[File:IM Broker Tab.png]]

*Will list stuff on the broker for you.


== UI Overview ==
Below are all the instructions of how the UI works.
 
=== Broker Bags ===
* UI Overview
** What broker bags to scan/list.
* UI Interaction
** Check what bags to scan/list
=== Price Match ===
* UI Overview
** match lowest price
* UI Interaction
** Check to match lowest price.
=== Take Coin ===
** UI Interaction
*** Will take coin from broker bags.

=== List Items ===
* UI Overview
** List all
*** will search broker for all items in selected bags.
** Un-Listed only
*** Will only search for un listed items in bags selected only.
** Selected only
*** Will only list selected items in the broker list window only.
* UI Interaction
** ctrl + Leftclick to select multiple.

=== Set Item Prices ===
* UI Overview
** Skip item prices.
*** Will skip setting "Minimum price" - "Default price" - "Static price"
** Set missing prices.
*** Will pop up a window for items missing "Minimum price" - "Default price" - "Static price" so they can be set and saved to xml.
** Force set prices.
*** Will pop up a window for all items regardless if the following have already been set "Minimum price" - "Default price" - "Static price"

=== Save Settings "Button" ===
* UI Overview
** Will save the current settings you have selected IE: checkboxs.
=== Broker List ===
* UI Overview
** Shows items from your broker bags.
*** Green with a price == Listed for sale.
*** Orange no price == Not listed for sale.
 

== Set Prices Window ==
[[File:IM Broker Tab SetPrice.png]]
 

=== Minimum Price ===
* The minimum price you would want to list this item on the broker for.
** If an item on the broker is found that is lower than your minimum price the item will not be listed and will show withing the Listing Window.
 
=== Default Price ===
* Default price you would list this item at if none were found on the broker.
** if none of this item are found on the broker it will use this Price if one is set.
 
=== Static Price ===
*Static price will simply set this item to this price no matter what it will skip all other checks.

== Broker Listing Window ==
[[File:IM Broker Tab Listing.png]]
 

* When started will list any items priced within this window.
=== Colour Code ===
* Green == Listed Fine
* Red == Their is an item listed lower than your minimum set price.
** The item will not be listed for sale.
* Purple == None of this item on broker and no default price set.

OgreExperiment

2019-09-11T21:56:58Z

Pork:

== Main Overview ==
[[File:Ogre Experiment Main.png]]

*Will experiment on an item or multiple items.

== Importent Info ==
*Must have Experiment AA.
*Crafting window adjusts size for multiple reasons there is a "Reset TS UI Size" button if this screws up.
*Must be on Innerspace Build ( 6535 ) or above for this to work.
 
== UI Overview ==
Below are all the instructions of how the UI works.
 
=== Items List ===
* UI Overview
** This lists all items that can be experimented on.
*** This also lists stuff from inside your bank.
* UI Interaction
** Leftclick an item you want to experiment on.
*** ctrl + Leftclick to select multiple items.
 
=== Choose Stats ===
* UI Overview
** This allows you to choose what stats you want to experiment into the item.
*** Leave blank if you do not want it to use one. Will register as None in the final lists window.
* UI Interaction
** Select stat from dropdown per stat round.
 
=== Final List ===
* UI Overview
** Lists items you want to experiment on with said stats you want to use.
** UI Interaction
*** Rightclick to remove an item from this list.
 
=== Start "Button" ===
* UI Interaction
** Starts the experiment process.
 
=== Close "Button" ===
* UI Interaction
** Closes the experiment script.
 
=== Reset TS UI Size "Button" ===
* UI Interaction
** Resets the in game crafting window to default size.

File:Ogre Experiment Main.png

2019-09-11T21:37:00Z

Pork:

OgreInfo

2019-09-11T21:32:48Z

Pork:

== ogre info ==

[[File:Ogre Auth.png]]

* To load this UI, type the following into the console:
** ogre info
=== Username: ===
*Your Ogrebot username (stored in ISXOgre.xml)
 
=== Password: ===
*Your Ogrebot password (stored in ISXOgre.xml)
 
=== Use old UI ===
*Loads a the login UI with more options (currently 'Use Old Skin' was added). This will switch back to the "eq2" skin instead of the "eq2ogre" skin.
 
=== Always Patch ===
*When checked: Force the extension to check for new patches every time it's loaded, even if it's already patch during that session.
*When unchecked (current behavior): Extension will only check for a new patch when initially loaded, and not again if it's unloaded and reloaded during that session.
 
=== Patch on all sessions ===
*When checked: All sessions will try to patch when they are loaded.
*When unchecked: Only IS1 (first session to be loaded) will try to patch.
 
=== Delete awesomium_process ===
*When checked: ISXOgre will remove awesomium_process. '''NOTE: This will cause a memory leak that eventually leads to a crash.'''
*When unchecked (current behavior): ISXOgre will not remove this extra process for those wishing to use the in-game browser.
 
=== Delete SOE crash reporter ===
*Deletes the soe/dbg crash reporter so you do not upload crashes due to Innerspace.
 
=== Do not load ogre console on load ===
*Does not load ogre console on load
 
=== Force full screen ===
*Puts your window into full screen mode.
 
=== Skip Innerspace Version Checks ===
*will stop ogre from checking your innerspace version upon load forever.
**This is not recommended due to new Innerspace code being used in scripts.

[[File:ISXOgreInnerSpaceChecker.PNG]]

File:Ogre Auth.png

2019-09-11T21:13:45Z

Pork:

File:IM Broker Tab SetPrice.png

2019-09-10T21:20:16Z

Pork:

File:IM Broker Tab Listing.png

2019-09-10T21:20:02Z

Pork:

File:IM Broker Tab.png

2019-09-10T21:19:49Z

Pork:

OgreInfuse

2019-09-10T19:17:44Z

Pork:

== Main Overview ==
[[File:Main Ogre Infuse.png]]

== Summary ==

* Allows you to Infuse equiped gear with infusers and plat.

== Usage ==

* Add items you want to infuse to list of items to infuse ( via Doubleclick, All Items, Add via Resolve )
* Check what infusers you want to use.
* Check Plat infuse if you want to Plat infuse.
* Hit Start to start infusing.

== CLI ==

'''Example:''' ogre infuse -addall -plat -start -end

* -addall ( Adds all items to infuse list )
* -platonly ( Checks plat and unchecks all the other infusers )
* -plat ( Checks Plat checkbox )
* -start ( sets it to auto start infusing )
* -end ( ends script when done )

== Changing Infusers XML ==

* You can change all infusers you use with this script via editing the Infuser_Data.xml
** File can be found "\InnerSpace\Scripts\EQ2OgreCommon\OgreInfuse"

* If for some reason you corrupt this file you can delete it and re-patch ogre and the file will re download again

Ogreaautoquest

2019-09-10T16:18:58Z

Pork: Created page with "== Summary == * Auto runs Listed Quest lines for you. * will check the quest and start from any point during the current quest. * Most Important Thing to remember DO NOT Run..."

== Summary ==

* Auto runs Listed Quest lines for you.
* will check the quest and start from any point during the current quest.
* Most Important Thing to remember DO NOT Run this AFK.

== Usage ==

* To load
** ogrea autoquest

* To End
** ogrea end autoquest

== Planes of Prophecy Expansion ==

=== Factions ===

Order to run them in

* 1. Yrzu
* 2. Pakiat
* 3. Vahla
** Reason for this is some vahla quests make you run around Pakiat and you will die to the X2s.

== Chaos Descending Expansion ==

=== Tradeskill Sigline ===

Will auto run the entire TS sigline for you from start to finish.

=== Known Issues ===

* Harvesting is pretty buggy due to not being able to check for any collision between terrain.
** most people pause autoquest and do the harvesting manually and then restart autoquest to carry on.

ISXOgre

2019-09-10T15:39:32Z

Pork:

<big>'''Welcome to Ogre Wiki.'''</big>

This page is for the Everquest 2 Ogre Adventure bot and Ogre Crafting bot.
OgreBot is a fully customizable adventure bot. OgreCraft is an advanced crafting bot.
* OgreBot and OgreCraft are part of the ISXOgre extension. However one thing to point out, ISXOgre does NOT do anything ISXEQ2 does. You REQUIRE ISXEQ2 in order to use ISXOgre.
* Lastly, ISXOgre requires a subscription, see Ogre Pricing for more details.

----

== Introduction ==

Ogrebot is a fully customizable adventure bot.

* [[WhyOgre|Why OgreBot? OgreBot vs the competition! (Adventure bot)]]

* [[WhyOgreCraft|Why OgreCraft? OgreCraft vs the competition! (Crafting bot)]]

* [[OgrePricing|Ogre Pricing]]

* [[ObtainingASubscription|How to obtain a subscription]]

* [[HowToCancelASubscription|How to cancel a subscription]]

* [[NewUserWalkthrough:Page01|New User Walkthrough]]

* [[Advanced User Tips|Advanced User Tips]] - Been with Ogre a little while now? Next Steps found here

* [[Ogre:FAQ|FAQ and Help]] - Including screen shots of examples of how to setup classes.

* [[Ogre:DidYouKnow|Did you know...]] - Random pieces of information that will help you sleep at night.

* [[ContactInfo|Contact information and Ventrilo]]

* [[RevisionHistory|Revision History]] - Here you will find the revision history. Every time a file is updated, I will do my best to include specifics of what was added, and any important details about it.
* [https://forge.isxgames.com/projects/ogrebot-eq2/issues Feature Requests] - Here you will find a list of items I have on my list to code. Some are new, some are upgrades etc.

== Ogre Bot ==

* [[Tab:Overview|Tabs]] - Click here for more information about each tab and to see screen shots.
* [[Aliases|Aliases]] - Aliases
* [[ProfileAliases|Profile Aliases]] - Aliases
* [[Raid Instances|Raid Options]] - Raid specific options
* [[Heroic Instances|Heroic Options]] - Heroic options
* [[OgreMCP|OgreMCP]] - Ogre Master Control Panel.
* [[UplinkController|Uplink Controller]] - It controls other sessions.
* [[OgreBotCommands| Ogre Commands]] - How to load Ogrebot, as well as various other commands included.
* [[OgreMapper| Ogre Mapping]] & [[Ogre Nav]] - mapping and moving
* [[OgreBotChatCommands| Ogre Chat Window Commands]] - In-game chat commands that Ogrebot responds to.
* [[OgreInfo|Ogre info | options | config]] - Loads a UI for user information and other Ogrebot options
* [[ISXOgre:MethodsAndMembers|ISXOgre methods and members]]
* [[ISXOgre:OgreProcessorlocking|Ogre Processor Locking]]
* [[OgreBot:UnfixableBugs|Unfixable bugs]]
* [[OgreEvents|OgreEvents]]
* [[ForWho|ForWho]] - Documentation for any place you need to reference a ForWho command

== Advanced Usage ==

* [[Torment Runes|Torment Runes]] - Setting up Torment Runes to be handled by OgreBot.

== Crafting - Harvesting & Depots ==

*'''Crafting'''
** [[OgreCraft:Overview|OgreCraft]]
** [[OgreCraft:MainWindow|Tabs]]
** [[OgreCraft:MethodsandMembers|Ogre Craft Methods and Members]]

*'''Harvesting'''
** [[Ogre GoblinHousePlant|Ogre Plant]] - Manages the house plant (Kunark Ascending Crafting Quests)
** [[Ogre GatherGoblin|Ogre Goblin]] - Manages the gathering goblin
** [[OgreOther:Hirex|HireX]] - HireX is a script that allows you to run guild hall hirelings automaticaly and have them put their harvests into the GH depots.
** [[OgreMapper|Ogre Map]] - A zone mapping and WP marking tool.
** Ogre Harvest -- In the ISXEQ2 Command Window type '''Ogre Harvest'''; should be used with Ogre Map, this will allow your toons to auto harvest.

*'''Depots'''
** [[OgreOther:Depots|Depot]] - Guild Hall Depot Management and Commands

* '''Tradeskill Apprentice Managment'''
** [[OgreTradeskillApprentice|Ogre Tradeskill Apprentice]]
** [[OgreTradeskillApprenticeManager|Ogre Tradeskill Apprentice Manager (TSAM)]]

*'''Transmute'''
** In your ISXEQ2 command drop down window type Ogre Transmute - Loads the Transmute UI (supports to level 110 now)

*'''Salvage'''
** In your ISXEQ2 command drop down window type Ogre Salvage - Loads the Salvage UI (supports to level 110 now)
***Please note you must have the salvage crafting AA in order to use this option

== Faction Scripts ==

* [[OgreOther:FreeportFaction|FreeportFaction]] - Freeport faction is a script to assist in the faction part of the betrayal quest.
* [[QeynosFaction|QeynosFaction]] - Qeynos faction is a script that assist in the faction part of the betrayal quest.
* [[OgreOther:Othmir|Othmir]] - Does repeatable faction quests in Great Divide. NOTE: This script is a use-as-is. It is NOT supported or maintained.

== Heroic / Raid Scripts ==

*'''Heroic Zones'''
* [[Heroic Instances]] - Heroic specific options

*'''Raid Zones'''
* [[Raid_Instances|Raid Options]] - Raid specific options

== Other Ogre Scripts ==

* [[OgreOther:AutoLogin|AutoLogin]] - Directions to set up some Auto Login scripts that will load multiple clients including across multiple pc's.
* [[OgreOther:Item|OgreItem]] - Currently in testing, only accessible by testers. An Item Database manager to help track what characters have what items.
* [[OgreOther:InventoryManager|Old Inventory Manager]] - Used to transfer items between toons and bags. A collection of scripts used to assist with inventory management.
* [[Ogre Inventory Manager|Ogre Inventory Manager]] - Used for all your inventory Needs. Sell - Destroy - Trade - Transmute/salvage/extract and more.
* [[OgreListManager|Ogre List Manager]] - Used to create custom lists for later use in other Ogre features.
* [[OgreAscensionDailyTask|Ogre Ascension Daily Task]] - Designed to run characters to ascension trainers to get their daily scrolls.
* [[OgreProvingGroundsTheUnderdepths|Ogre Proving Grounds: The Underdepths]] - Designed to run the proving grounds solo for each of your characters automagically
* [[Ogre Boat|Ogre Boat]] - Runs the Frillik Tide key quest in OF
* [[Ogre Collection Manager|Ogre Collection Manager]] - Both depot and inventory options for managing collectibles
* [[Ogre HideEffects|Ogre HideEffects]] - Helps cut down the number of effects in your spell effects window.
* [[Ogre TrackShiny|Ogre TrackShiny]] - Helps track down shinies nearby, can sort out colors.
* [[Ogre Zone Resetter|Ogre Zone Resetter]] - Zone Resetting User Interface
* [[Ogre Export|Ogre Export]] - Exports ability information for us in Ogre Bot
* [[Ogre Ability Efficiency|Ogre Ability Efficiency]] - parse your ability export and export it
* [[Ogre TempAdorns|Ogre TempAdorns]] - Make a List and Apply the List of Temporary Adorns to a Character.
* [[OgreMerchantCraft|Ogre Merchant Craft]] - Craft limited use recipes from merchant at merchant.
* [[OgreRPC|Ogre RPC]] - Checks your Raid Armour Patterns to see what is unlocked.
* [[OgreInfuse|Ogre Infuse]] - Infuse items Automatically with infusers or Plat.
* [[OgreReforge|Ogre Reforge]] - Reforge into a predefined or self defined set of stats.
* [[OgreAdorns|Ogre Adorns]] - Scans your inventory and Equipment and compares in a UI.
* [[OgreExperiment|Ogre Experiment]] - Loads a UI so you can make a list of items to experiment on and choose stats etc.
* [[OgreInstanceController|Ogre Instance Controller]] - IC - Runs Instances for you.

* [[Miscellaneous Scripts|Miscellaneous Scripts]] - This page is for other smaller Ogre scripts to be compiled

== OgreAffiliates ==
* [[Ogre Affiliates|Ogre Affiliates]] - Scripts written and hosted inside of ogre
* [[ogreaautoquest|ogrea autoquest]] - Information about Autoquest what is scripted etc...

== OgreIRC ==

* [[OgreIRC:OgreIRC|OgreIRC]] - OgreIRC is a IRC plugin that hooks into the uplink and allows control of some functions inside sessions.

== Script Developers ==

* [[SpewStats|Spew Stats]] - A list of all spewstats options
* [[OgreBotAPI|OgreBotAPI]] - Methods & Members for scriptwriters to utilise
* [[OgreInstanceHelperAPI|Ogre Instance Helper API]] - Methods & Members for scriptwriters to utilise when making instance files
* [[OgreUtilitiesAPI|Ogre Utilities API]] - Methods & Members for scriptwriters to utilise when making instance files or local scripts

OgreUtilitiesAPI

2019-08-01T02:45:55Z

Pork: /* List of Methods */

== Implementing OgreUtilities ==

* To use '''OgreUtilities''' you will need to load the code into your script.
** The following will load '''OgreUtilities''' into your script.

function Load_OgreUtilities()
{
ogre utilities
wait 5
Obj_CreateOgreUtilities:CreateOgreUtilities[${Script.Filename}]
;// Returns variable: OgreUtilities
Obj_CreateOgreUtilities:CreateOgreCharacterData[${Script.Filename}]
;// Returns variable: OgreCharacterData

;// Usage here. See wiki <Link here would likely be helpful, and some examples>
}

* This will allow you to use all of the below '''Methods''', '''Members''', '''Functions''' below.

== Summary ==

* List of '''Methods''', '''Members''', '''Functions'''

* pre configured '''Methods''', '''Members''', '''Functions''' to make coding scripts easier for people.

* If their is a command you do not understand please feel free to ask in ogre discord and someone will explain and try to word it better here in the list

== Advanced Navigation Options ==

=== Usage ===

* Obj_OgreUtilities.OgreNavChecks:<MethodNameHere>[<ParametersHere>]
** Example - Obj_OgreUtilities.OgreNavChecks:Set_Check_MeInCombat[FALSE]

=== List of Methods ===

*Below is a list of all available methods.

{| class="wikitable"
|-
!Command
!colspan="3"|Parameters||Example||Notes||Description
|-

|rowspan="2"|<center>'''Set_CheckAll'''</center>
|-
|Param 1
|colspan="2"|Distance||50|| Default = 50
|rowspan="2"| Sets checking group in combat, and distance to 50, sets checking if you are in combat.
|-

|rowspan="2"|<center>'''Set_Check_MeInCombat'''</center>
|-
|Param 1
|colspan="2"|T or F||TRUE or FALSE|| Default = TRUE
|rowspan="2"| Sets checking if you are in combat.
|-

|rowspan="3"|<center>'''Set_Check_Group'''</center>
|-
|Param 1
|colspan="2"|T or F||TRUE or FALSE|| Default = TRUE
|rowspan="3"| Sets checking the group for combat and the distance.
|-
|Param 2
|colspan="2"|Distance||50|| Default = 50
|-

|rowspan="2"|<center>'''Set_Check_GroupCombatOnly'''</center>
|-
|Param 1
|colspan="2"|T or F||TRUE or FALSE|| Default = TRUE
|rowspan="2"| Sets checking if you are in combat. Will disable "Set_Check_GroupDistanceOnly" if it is enabled.
|-

|rowspan="3"|<center>'''Set_Check_GroupDistanceOnly'''</center>
|-
|Param 1
|colspan="2"|T or F||TRUE or FALSE|| Default = TRUE
|rowspan="3"| Sets checking the group for combat and the distance. Will disable "Set_Check_GroupCombatOnly" if it is enabled.
|-
|Param 2
|colspan="2"|Distance||50|| Default = 50
|-

|rowspan="3"|<center>'''Set_Checks_GroupHealth'''</center>
|-
|Param 1
|colspan="2"|T or F||TRUE or FALSE|| Default = TRUE
|rowspan="3"| Sets checking the group health is under specified and if so stops naving till health goes above specified.
|-
|Param 2
|colspan="2"|Health||90|| Default = 90
|-

|rowspan="2"|<center>'''Set_Check_NoChecks'''</center>
|-
|Param 1
|colspan="2"|T or F||TRUE or FALSE|| Default = TRUE
|rowspan="2"| Will disable any and all Nav checks
|-

|}

== Methods ==

=== Usage ===

* Example - Obj_OgreUtilities:AcceptQuest
** Would Accept a quest if a quest window exists.

=== List of Methods ===

*Below is a list of all available methods.

{| class="wikitable"
|-
!Command
!colspan="3"|Parameters||Example||Notes||Description
|-

|rowspan="2"|<center>'''AcceptQuest'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Accepts a quest if a quest window exists.
|-

|rowspan="2"|<center>'''EQ2_onQuestOffered'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| If enabled, accepts new quests.
|-

|rowspan="2"|<center>'''EQ2_onRewardWindowAppeared'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| If enabled, accepts Reward windows.
|-

|rowspan="2"|<center>'''Jump'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Jumps a toon.
|-

|rowspan="2"|<center>'''Set_EQ2_onQuestOffered'''</center>
|-
|Param 1
|colspan="2"|T or F||TRUE/FALSE|| Enables (TRUE) or disables (FALSE) the EQ2_onQuestOffered event.
|rowspan="2"| Turns the event on or off
|-

|rowspan="2"|<center>'''Set_EQ2_onRewardWindowAppeared'''</center>
|-
|Param 1
|colspan="2"|T or F||TRUE/FALSE|| Enables (TRUE) or disables (FALSE) the EQ2_onRewardWindowAppeared event.
|rowspan="2"| Turns the event on or off
|-
|}

== Members ==

=== Usage ===

{| class="wikitable"
|-
|Example 1
if ${Obj_OgreUtilities.AnyGroupMembersDead}
{
;// Will return TRUE if any group members are dead False if all alive
;// Code to execute if it comes back as TRUE
}
Example 2
*echo ${Obj_OgreUtilities.ConvertSecondsToHMS[4500]}
**Would convert and return the specified seconds into hour.minute.seconds.
|-
|}

=== List of Members ===

*Below is a list of all available members.

{| class="wikitable"
|-
!Command
!colspan="3"|Parameters||Example||Notes||Description
|-

|rowspan="2"|<center>'''AnyGroupMembersDead'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Checks if any group members are dead.
|-

|rowspan="2"|<center>'''CleanName'''</center>
|-
|Param 1
|colspan="2"|Input to clean||Kannkor's battle Bot|| Cleans an input
|rowspan="2"| Some zones, I believe such as proving grounds, you can end up with some very odd names for characters, this removes it and "cleans" the input.
|-

|rowspan="2"|<center>'''ConvertSecondsToHMS'''</center>
|-
|Param 1
|colspan="2"|Seconds||2500|| Seconds to convert.
|rowspan="2"| Converts seconds to hour minutes seconds.
|-

|rowspan="2"|<center>'''Get_Hours'''</center>
|-
|Param 1
|colspan="2"|Seconds||2500|| Seconds to convert.
|rowspan="2"| Determines how many whole hours are in the seconds.
|-

|rowspan="2"|<center>'''Get_Minutes'''</center>
|-
|Param 1
|colspan="2"|Seconds||2500|| Seconds to convert.
|rowspan="2"| Determines how many whole minutes are in the seconds. Return can only be 0 to 59, as any value above that would be returned in Get_Hours.
|-

|rowspan="2"|<center>'''Get_Seconds'''</center>
|-
|Param 1
|colspan="2"|Seconds||2500|| Seconds to convert.
|rowspan="2"| Determines how many whole seconds are in the seconds. Return can only be 0 to 59, as any value above that would be returned in Get_Hours or Get_Minutes.
|-

|rowspan="2"|<center>'''GetAscensionClass'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| spews your current ascension class.
|-

|rowspan="2"|<center>'''HaveAbilityID'''</center>
|-
|Param 1
|colspan="2"|ID||483993047|| ID of ability to check.
|rowspan="2"| returns TRUE if you have the ability or FALSE if you do not.
|-

|rowspan="2"|<center>'''InZoneName'''</center>
|-
|Param 1
|colspan="2"|Zone Name||"Myrist, the Great Library"|| Zone name to check.
|rowspan="2"| Checks if you are in specified zone name.
|-

|rowspan="2"|<center>'''InZoneShortName'''</center>
|-
|Param 1
|colspan="2"|Zone Name||"exp15_rgn_plane_of_knowledge"|| Zone short name to check.
|rowspan="2"| Checks if you are in specified zone short name.
|-

|rowspan="2"|<center>'''ItemCount'''</center>
|-
|Param 1
|colspan="2"|Item Name||"mechanical gear"|| Item name to check.
|rowspan="2"| Counts how many of said item you have in your inventory. Does NOT count bank. This handles counting multiple stacks.
|-

|rowspan="3"|<center>'''NearLoc'''</center>
|-
|Param 1
|colspan="2"|Loc||"737.106506,411.865784,-388.380249"|| Loc to check.
|rowspan="3"| Checks if you are within specified distance to specified Loc.
|-
|Param 2
|colspan="2"|Distance|| 10 || how close. Default = 10
|-

|rowspan="2"|<center>'''NPCCount'''</center>
|-
|Param 1
|colspan="2"|Distance||30|| Distance to check.
|rowspan="2"| Counts how many NPCs are within specified distance.
|-

|rowspan="2"|<center>'''OnCorrectCharacter'''</center>
|-
|Param 1
|colspan="2"|Toon name||"Kannkor"|| Name of toon to check.
|rowspan="2"| Checks currently logged in toon name matches specified toon name.
|-

|rowspan="2"|<center>'''WhereAreWe'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Returns where you are. Valid returns are: GUILDHALL, or the zone hash ( ${Zone.ShortName} ). Basically used for checking if you're in a guild hall.
|-
|}

== Functions ==

=== Usage ===

*All functions are locking. That means when you call them, they 'hold' the script and return once completed.
**Almost every single function has a return, usually bool that you can access. If TRUE, it means it believes the function was successful, if FALSE, it believes the function was not successful.
***You can access this return, by checking ${Return} immediately after the function call.

Example 1
call Obj_OgreUtilities.CallToGH
if ${Return}
echo Means CallToGH was successful!

=== List of Functions ===

* Below is a list of all available functions

{| class="wikitable"
|-
!Command
!colspan="3"|Parameters||Example||Notes||Description
|-

|rowspan="2"|<center>'''CallToGH'''</center>
|-
|Param 1
|colspan="2"|T or F||TRUE/FALSE|| Default FALSE. FALSE means if Call to Guild Hall is not available, wait for it. TRUE means if the call is not available, then don't cast it.
|rowspan="2"| Calls to Guild Hall.
|-

|rowspan="3"|<center>'''CastAbilityID'''</center>
|-
|Param 1
|colspan="2"|ID||106506|| ID of the ability.
|rowspan="3"| Casts ability and waits specified time for ability to cast.
|-
|Param 2
|colspan="2"|Wait Time|| 50 = 5 seconds || Time to wait. Default = 50
|-

|rowspan="2"|<center>'''CastEvac'''</center>
|-
|Param 1
|colspan="2"|NotAvailableAtThisTime||NotAvailableAtThisTime|| NotAvailableAtThisTime
|rowspan="2"| Can't be used at this time. Requires a reference that isn't accessible yet.
|-

|rowspan="2"|<center>'''CheckEvacTotems'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Checks you have evac totems.
|-

|rowspan="2"|<center>'''CheckIfGroupInSameZone'''</center>
|-
|Param 1
|colspan="2"|How many seconds to check for||30|| How many seconds to check for
|rowspan="2"| returns TRUE as soon as your entire group is in the same zone. Returns FALSE if at the end of the seconds to check for, if everyone is not in the same zone
|-

|rowspan="2"|<center>'''ClearQuestWindow'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Clears the quest helper window. The in-game on-screen quest information with checkboxes that can only show like 5 quests. This just unchecks them. It does NOT delete quests.
|-

|rowspan="2"|<center>'''DoConversation'''</center>
|-
|Param 1
|colspan="2"|Numerical sequence of conversation baubles to choose||1 1 2 3 1|| When conversing with an NPC, this example would choose option 1, then 1, then 2, then 3, then 1.
|rowspan="2"| Accepts any number of conversations, and does so with a 1/2 second delay
|-

|rowspan="2"|<center>'''DoHail'''</center>
|-
|Param 1
|colspan="2"|NPC||"Flag dude"|| Name of NPC.
|rowspan="2"| Hails specified NPC via Name.
|-

|rowspan="2"|<center>'''DoHailID'''</center>
|-
|Param 1
|colspan="2"|ID||8959659794|| ID of NPC.
|rowspan="2"| Hails specified NPC via ID.
|-

|rowspan="3"|<center>'''DoTarget'''</center>
|-
|Param 1
|colspan="2"|NPC||"Flag dude"|| Name of NPC.
|rowspan="3"| Targets NPC if withing specified Range.
|-
|Param 2
|colspan="2"|Range|| 50 || within Range. Default = 40
|-

|rowspan="3"|<center>'''FastTravel'''</center>
|-
|Param 1
|colspan="2"|Name||"Freeport"|| Name of Zone/Destination.
|rowspan="3"| Travels to specified destination. ( Requires Membership )
|-
|Param 2
|colspan="2"|Exact match|| TRUE/FALSE || Default = FALSE
|-

|rowspan="2"|<center>'''GetIntoCorrectZone'''</center>
|-
|Param 1
|colspan="2"|NotAvailableAtThisTime||NotAvailableAtThisTime|| NotAvailableAtThisTime
|rowspan="2"| This was never finished, it would help navigating from zone to zone automatically, through connecting zones. However the manual input and maps required map the set up extremely difficult.
|-

|rowspan="2"|<center>'''GHToHouse'''</center>
|-
|Param 1
|colspan="2"|Name||"Kannkors house"|| Name of house to go to.
|rowspan="2"| Zones you to specified house from Guild Hall.
|-

|rowspan="3"|<center>'''HandleCampSpotToLoc'''</center>
|-
|Param 1
|colspan="2"|Loc||"737.106506,411.865784,-388.380249"|| Loc to campspot to.
|rowspan="3"| Sets your campspot to the location you passed it, and waits until you are within Range of it. Example, if you set it to 100, it would return TRUE if you are within 100 meters of the campspot.
|-
|Param 2
|colspan="2"|Range|| 125 || within Range. Default = 125
|-

|rowspan="2"|<center>'''HandleWaitForGroupDistance'''</center>
|-
|Param 1
|colspan="2"|Distance|| 5 || within Disatnce. Default = 5
|rowspan="2"| Waits until your entire group is within # distance of you. Good to use after you nav some where to make sure everyone is with you.
|-

|rowspan="2"|<center>'''HandleClickActor_Special'''</center>
|-
|Param 1
|colspan="2"|Distance|| 10 || within Disatnce. Default = 10
|rowspan="2"| Clicks special actor within disance specified.
|-

|rowspan="3"|<center>'''HandleClickActor'''</center>
|-
|Param 1
|colspan="2"|Name||"Mechanical gear"|| Name of actor.
|rowspan="3"| Clicks an actor within disance specified.
|-
|Param 2
|colspan="2"|Distance|| 10 || within Disatnce. Default = 10
|-

|rowspan="2"|<center>'''HandleConversation'''</center>
|-
|Param 1
|colspan="2"|NotAvailableAtThisTime||NotAvailableAtThisTime|| NotAvailableAtThisTime
|rowspan="2"| Requires an object not available at this time
|-

|rowspan="2"|<center>'''HandleConversationByText'''</center>
|-
|Param 1
|colspan="2"|Text inputs||"Where would you like to go?" "I want to get a rally flag" || Will handle chat baubles based on text input. Accepts up to 10 parameters.
|rowspan="2"| Conversation baubles
|-

|rowspan="2"|<center>'''HandleWaitForCampSpot'''</center>
|-
|Param 1
|colspan="2"|WaitBeforeChecking||10|| Waits this amount of time before checking, allowing campspot to be set. Default is 0 (no wait at all). Recommend use of 10 (1 second) if you JUST changed your campspot
|rowspan="2"| Waits until you are dead or within range of campspot. Returns TRUE if you are at your campspot (regardless of your range), returns FALSE if you are NOT at your campspot.
|-

|rowspan="5"|<center>'''HandleWaitForCombat'''</center>
|-
|Param 1
|colspan="2"|wait time||50 = 5 seconds|| Time to wait. Default = 50
|rowspan="5"| Waits specified time if in combat with specified options.
|-
|Param 2
|colspan="2"|Skip|| TRUE/FALSE || Skip if no mobs exist.
|-
|Param 3
|colspan="2"|Distance|| 30 || Skip if no mobs exist within specified distance.
|-
|Param 4
|colspan="2"|Clear target|| 40 || Clear target if distance of target over specified distance. Default = 40
|-

|rowspan="5"|<center>'''HandleWaitForCombatOrPower'''</center>
|-
|Param 1
|colspan="2"|wait time||50 = 5 seconds|| Time to wait. Default = 50
|rowspan="5"| Waits specified time if in combat with specified options.
|-
|Param 2
|colspan="2"|Skip|| TRUE/FALSE || Skip if no mobs exist.
|-
|Param 3
|colspan="2"|Distance|| 30 || Skip if no mobs exist within specified distance.
|-
|Param 4
|colspan="2"|Clear target|| 40 || Clear target if distance of target over specified distance. Default = 40
|-

|rowspan="3"|<center>'''HandleWaitForCombatWithNPC'''</center>
|-
|Param 1
|colspan="2"|NPC||"Trakanon"|| Name of NPC.
|rowspan="3"| Waits until combat is over. Returns TRUE if there was combat, and FALSE if there was not combat.
|-
|Param 2
|colspan="2"|Args|| -TimeToWait 50 (5 seconds), -SkipIfNoMobs TRUE/FALSE, -SkipIfNoMobsWithin 30, -ClearTargetIfTargetDistanceOver 50|| Accepts any of these args in pairs. The defaults are listed.
|-

|rowspan="2"|<center>'''HandleWaitForZoning'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Handles wait for when you are Zoning.
|-

|rowspan="2"|<center>'''HandleWaitTime'''</center>
|-
|Param 1
|colspan="2"|Wait Time||50|| Time to wait. Default = 50 (5 seconds)
|rowspan="2"| Literally just waits the specified amount of time.
|-

|rowspan="2"|<center>'''HandleZoneDoor'''</center>
|-
|Param 1
|colspan="2"|Option||1|| Zone door option. Default = 1
|rowspan="2"| Clicks specified Zone within a List UI.
|-

|rowspan="2"|<center>'''LoginToon'''</center>
|-
|Param 1
|colspan="2"|Toon||"Kannkor"|| Toon name to log in
|rowspan="2"| Logs in specified toon.
|-

|rowspan="3"|<center>'''NavTo'''</center>
|-
|Param 1
|colspan="2"|Loc||"737.106506,411.865784,-388.380249"|| Loc to nav to.
|rowspan="3"| Nav to specified location.
|-
|Param 2
|colspan="2"|How Close|| 1.5 || Get this close to destination. Default = 1.5
|-

|rowspan="3"|<center>'''NavToLoc'''</center>
|-
|Param 1
|colspan="2"|Loc||"737.106506,411.865784,-388.380249"|| Loc to nav to.
|rowspan="3"| Nav to specified location by specified precision.
|-
|Param 2
|colspan="2"|Precision|| 5 || Precision to destination. Default = 5
|-

|rowspan="3"|<center>'''NavToLocation'''</center>
|-
|Param 1
|colspan="2"|Location||"NPC_Loc_Main_Room"|| Saved Location to nav to.
|rowspan="3"| Nav to specified location by specified precision.
|-
|Param 2
|colspan="2"|Precision|| 5 || Precision to destination. Default = 5
|-

|rowspan="2"|<center>'''PreCombatBuff'''</center>
|-
|Param 1
|colspan="2"|Seconds||5 = 5 seconds|| Amount of Time to buff.
|rowspan="2"| Enters bots into Combat to force them to start casting incombat buffs/heals etc.
|-

|rowspan="2"|<center>'''ResetCameraAngle'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Resets your camera angle on your character, so it's in 3rd person view facing forward. Super useful if it may change before conversing with an NPC.
|-

|rowspan="2"|<center>'''Revive'''</center>
|-
|Param 1
|colspan="2"|Option||1|| Revive Option to use. Default = 1
|rowspan="2"| Revives at specified location.
|-

|rowspan="2"|<center>'''Set_FirstPersonView'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Puts you into First person view.
|-

|rowspan="2"|<center>'''Set_LookDown'''</center>
|-
|Param 1
|colspan="2"|Value||30|| How long to hold look down for. Default = 30 (3 seconds)
|rowspan="2"| Makes you "look down" for x seconds.
|-

|rowspan="2"|<center>'''Set_LookUp'''</center>
|-
|Param 1
|colspan="2"|Value||30|| How long to hold look up for Default = 30 (3 seconds)
|rowspan="2"| Makes you "look up" for x seconds.
|-

|rowspan="2"|<center>'''Set_ZoomIn'''</center>
|-
|Param 1
|colspan="2"|Value||30|| Default = 30
|rowspan="2"| Does nothing - Use Set_FirstPersonView if you wish to be zoomed in.
|-

|rowspan="2"|<center>'''Set_ZoomOut_MouseWheel'''</center>
|-
|Param 1
|colspan="2"|Value||30|| How many zoom out clicks to do. Default = 30
|rowspan="2"| Zooms out using the mouse wheel
|-

|rowspan="2"|<center>'''Set_ZoomOut'''</center>
|-
|Param 1
|colspan="2"|Value||30|| How long to hold the Zoom out key for. Default = 30 (3 seconds)
|rowspan="2"| Holds the zoom out key for this long.
|-

|rowspan="2"|<center>'''WaitForCasting'''</center>
|-
|Param 1
|colspan="2"|Wait Time||50 = 5 seconds|| Time to wait. Default = 50
|rowspan="2"| Wait while you are casting a spell or specified wait time.
|-

|rowspan="2"|<center>'''WaitForGroupToZone'''</center>
|-
|Param 1
|colspan="2"|How many||60 = 6 times|| Check how many times. Default = 60
|rowspan="2"| Check specified times for whole group to be in zone.
|-

|rowspan="2"|<center>'''WaitForLootWindow'''</center>
|-
|Param 1
|colspan="2"|wait time||50 = 5 seconds|| wait time. Default = 50
|rowspan="2"| Wait specified time for a lootwindow.
|-

|rowspan="2"|<center>'''WaitForPower'''</center>
|-
|Param 1
|colspan="2"|%||95|| wait for power %. Default = 95
|rowspan="2"| Wait for Power to be at or above specified %.
|-

|rowspan="2"|<center>'''WaitForScript'''</center>
|-
|Param 1
|colspan="2"|Script name||"Random Script"|| Script name.
|rowspan="2"| Wait while specified script is running.
|-

|rowspan="2"|<center>'''WaitForZoning'''</center>
|-
|Param 1
|colspan="2"|Wait Time||50 = 5 seconds|| wait time. Default = 50
|rowspan="2"| Wait while zoning and specified time.
|-

|rowspan="2"|<center>'''WaitWhileGroupMembersDead'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| wait while group members dead.
|-
|}

OgreInstanceHelperAPI

2019-08-01T00:05:09Z

Pork: /* List of Functions */

== Important Note ==

*This is currently not released.
*It will be ready when its ready.

== Summary ==

* List of '''Methods''', '''Members''', '''Functions''' that are to be used with '''Ogre ic''' files.

* pre configured '''Methods''', '''Members''', '''Functions''' to make coding zones easier for people.

* If their is a command you do not understand please feel free to ask in ogre discord and someone will explain and try to word it better here in the list

* This list will grow as ogre ic grows
** If you feel something needs adding/updating feel free to ask kannkor or pork on discord.

== Methods ==

=== Usage ===

* Example 1 - Obj_OgreIH:SetCampSpot
** Would Campspot your group.
* Example 2 - Obj_OgreIH:ChangeOgreBotUIOption["checkbox_settings_movebehind",TRUE]
** Would turn on move behind in ogrebot.
*** UI Code can be grabbed from ( InnerSpace\Scripts\EQ2OgreBot\OgreUIXML.xml )

=== List of Methods ===

*Below is a list of all available methods to be used with Ogre ic

{| class="wikitable"
|-
!Command
!colspan="3"|Parameters||Example||Notes||Description
|-

|rowspan="2"|<center>'''Set_Disable_AEsEncounters'''</center>
|-
|Param 1
|colspan="2"|Disabled||TRUE/FALSE|| N/A
|rowspan="2"| Disable AOEs and Encounters for group or self if not grouped.
|-

|rowspan="2"|<center>'''ClearRelativeCampSpot'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Clears relative campspots for group or self if not grouped.
|-

|rowspan="2"|<center>'''ClearCampSpot'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Clears campspots for group or self if not grouped.
|-

|rowspan="3"|<center>'''SetCampSpot'''</center>
|-
|Param 1
|colspan="2"|How Close||1.5|| Default = 1.5
|rowspan="3"| Sets campspot for group or self if not grouped for specified distances.
|-
|Param 2
|colspan="2"|How Far||200|| Default = 200
|-

|rowspan="2"|<center>'''ChangeCampSpot'''</center>
|-
|Param 1
|colspan="2"|Loc||"127.084137,-180.863373,-832.558899"|| Loc to change campspot to. Has to be Quoted.
|rowspan="2"| Change campspot for group or self if not grouped.
|-

|rowspan="2"|<center>'''CCS_Actor'''</center>
|-
|Param 1
|colspan="2"|Actor ID||1234|| Actor ID to change campspot too.
|rowspan="2"| Change campspot for group or self if not grouped to the Actor's position.
|-

|rowspan="2"|<center>'''CCS_Actor_Position'''</center>
|-
|Param 1
|colspan="2"|Actor ID||1234|| Actor ID to change campspot too.
|rowspan="2"| Change campspot for group or self if not grouped to the Actor's position, with using infront (fighters) and behind (non-fighters)
|-

|rowspan="2"|<center>'''SetUpFor'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Does a SetUpFor command for group or self if not grouped. ( Requires being Campspotted )
|-

|rowspan="2"|<center>'''Set_NoMove'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Sets NoMove for group or self if not grouped.
|-

|rowspan="2"|<center>'''Actor_Click'''</center>
|-
|Param 1
|colspan="2"|Actor||"Name" or ID|| Name or ID of actor to Click.
|rowspan="2"| Clicks an Actor for group or self if not grouped.
|-

|rowspan="2"|<center>'''Use_Item'''</center>
|-
|Param 1
|colspan="2"|Item||"Name"|| Name of item to Use.
|rowspan="2"| Uses an item from inventory for group or self if not grouped.
|-

|rowspan="2"|<center>'''LetsGo'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Hits LetsGo for group or self if not grouped.
|-

|rowspan="2"|<center>'''Jump'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| makes bots Jump. for group or self if not grouped.
|-

|rowspan="2"|<center>'''Jump_Me'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| makes only you Jump. for self Only.
|-

|rowspan="2"|<center>'''CallGH'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Calls to Guild Hall. For group or self if not grouped.
|-

|rowspan="2"|<center>'''CallHome'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Calls to Home. For group or self if not grouped.
|-

|rowspan="2"|<center>'''Tradeskill_Close'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Closes tradeskill window. For self Only.
|-

|rowspan="3"|<center>'''ChangeOgreBotUIOption'''</center>
|-
|Param 1
|colspan="2"|UI Code||"Checkbox_blah"|| UI Code/element to change from Ogrebotui.xml.
|rowspan="3"| Set a UI element in ogrebot to on/off. for group or self if not grouped.
|-
|Param 2
|colspan="2"|T or F|| TRUE/FALSE || Set UI element to on/off.
|-

|rowspan="4"|<center>'''Set_ZoneInformation'''</center>
|-
|Param 1
|colspan="2"|Zone Name||"Myrist, the Great Library"|| Zone name to set. via ${Zone.Name}.
|rowspan="4"| Sets all zone information for files usaully called from main function of script.
|-
|Param 2
|colspan="2"|Zone ShortName||"exp15_rgn_plane_of_knowledge"|| Zone Short name to set. via ${Zone.ShortName}.
|-
|Param 3
|colspan="2"|Actor|| "zone_to_poa" || Actor name to click to zone.
|-

|rowspan="2"|<center>'''Set_Debug_Mode'''</center>
|-
|Param 1
|colspan="2"|T or F|| TRUE/FALSE || N/A.
|rowspan="2"| Turn debug mode on or off. ( Very Spammy )
|-

|rowspan="2"|<center>'''Message_FailedZone'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Sends a failed message to Ogre Console with zone information.
|-

|rowspan="2"|<center>'''Message_FailedNamed'''</center>
|-
|Param 1
|colspan="2"|Named||"Trakanon"|| Name of Named.
|rowspan="2"| Sends a failed message to Ogre Console with specified named information.
|-

|rowspan="2"|<center>'''Message_FailedZoneOut'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Sends a failed message to Ogre Console with zone out information.
|-

|rowspan="2"|<center>'''Message_NamedDoesNotExistSkipping'''</center>
|-
|Param 1
|colspan="2"|Named||"Trakanon"|| Name of Named.
|rowspan="2"| Sends a Skipping message to Ogre Console with specified named information.
|-

|rowspan="2"|<center>'''Message_FailedToKill'''</center>
|-
|Param 1
|colspan="2"|Named||"Trakanon"|| Name of Named.
|rowspan="2"| Sends a failed to kill message to Ogre Console named information.
|-

|rowspan="2"|<center>'''MonkeyInMiddle'''</center>
|-
|Param 1
|colspan="2"|Range||10|| Range to spread to. Default = 10
|rowspan="2"| Set monkey in the middle by specified range. for group or self if not grouped.
|-
|}

== Members ==

=== Usage ===

{| class="wikitable"
|-
|Example 1
if ${Obj_OgreIH.Tradeskill_vis}
{
;// Will only trigger this if the tradeskill window is visible in game
;// Code to execute if it comes back as TRUE
}
Example 2
if ${Actor[id, ${Obj_OgreIH.Get_NPC_ID["Trakanon"]}](exists)}
{
;// Will only trigger this if the NPC exists
;// Code to execute if it comes back as TRUE
}
|-
|}

=== List of Members ===

*Below is a list of all available members to be used with Ogre ic

{| class="wikitable"
|-
!Command
!colspan="3"|Parameters||Example||Notes||Description
|-

|rowspan="2"|<center>'''DuoMode'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Checks if only 2 members are in group with you. For duo zones to make sure their is not more or less than 2 members in group.
|-

|rowspan="2"|<center>'''Get_NPC_ID'''</center>
|-
|Param 1
|colspan="2"|NPC||"Trakanon"|| Name of NPC.
|rowspan="2"| Gets the ID for the specified NPC.
|-

|rowspan="4"|<center>'''Get_IDFromActorQuery'''</center>
|-
|Param 1
|colspan="2"|Actor Name||"Trakanon"|| Name of Actor.
|rowspan="4"| Checks if Actor Name specified Loc exists at Loc supplied within distance supplied.
|-
|Param 2
|colspan="2"|Loc||"737.106506,411.865784,-388.380249"|| Loc to compare to.
|-
|Param 3
|colspan="2"|Distance|| 2 || Disatnce to check. Default = 2
|-

|rowspan="2"|<center>'''SoloMode'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Checks if only 1 members are in group or 1 member 1 merc. For Solo zones to make sure their is not more or less than 1 member 1 merc in group.
|-

|rowspan="2"|<center>'''Tradeskill_vis'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Checks to see if Tradeskill window is open in game.
|-
|}

== Functions ==

=== Usage ===

* Example 1 - call Obj_OgreIH.HandleAcceptReward 10
** Would accept reward windows 10 times for your group.
* Example 2 - call Obj_OgreIH.NamedSpawnWait "Trakanon" 60 "NamedNPC"
** Would wait 60 seconds or until the specified Named spawns.

=== List of Functions ===

* Below is a list of all available functions to be used with Ogre ic

{| class="wikitable"
|-
!Command
!colspan="3"|Parameters||Example||Notes||Description
|-

|rowspan="3"|<center>'''ClearTrashUntilNamedSpawns'''</center>
|-
|Param 1
|colspan="2"|NPC||"Trakanon"|| Name of NPC.
|rowspan="3"| Kill trash untill specified NPC spawns within specified distance.
|-
|Param 2
|colspan="2"|Radius||30|| Radius to check trash. Default = 30
|-

|rowspan="2"|<center>'''HandleAcceptReward'''</center>
|-
|Param 1
|colspan="2"|Max Times||10|| How many times to accept rewards #. Default = 10
|rowspan="2"| Accept rewards specified # of times. .5 second wait between each.
|-

|rowspan="3"|<center>'''KillActorType'''</center>
|-
|Param 1
|colspan="2"|Radius||30|| Radius to check trash. Default = 30
|rowspan="3"| Kill trash via Type that are within specified radius.
|-
|Param 2
|colspan="2"|Type||"NPC"|| Actor Type you are looking for. Default = "NPC"
|-

|rowspan="3"|<center>'''KillAll'''</center>
|-
|Param 1
|colspan="2"|NPC Name|| "a random mob" || N/A
|rowspan="3"| Will change campspot to nearest specified npc with specified options. till no more exist.
|-
|Param 2
|colspan="2"|Args||options to use||
Options that can be used.
* -NoPosition = no behind/infront change campspot. Default = TRUE
* -jump = Will jump when at npc. Default = FALSE
* -NoWaitForCombat or -nwc = will not wait for combat before trying to get to next. Default = TRUE
* -MonkeyInMiddle or -mim = Requires range Example: -mim 10 = Will do monkey in middle at each npc. Default = FALSE
* -StopWhenNamedNPCSpawns "Trakanon" = requires NPC named to stop when seen. Will exit function when specified named spawns. Default = FALSE
* -SetUpFor = will setupfor at each npc specified. Default = FALSE
|-

|rowspan="4"|<center>'''NamedSpawnWait'''</center>
|-
|Param 1
|colspan="2"|NamedNPC||"Trakanon"|| Name of Actor.
|rowspan="4"| Waits specified time or untill specified name and specified Type exist as true. fail message if Named does not spawn.
|-
|Param 2
|colspan="2"|Time to wait||60 = 60 seconds|| Time to wait.
|-
|Param 3
|colspan="2"|Type|| "NamedNPC" || Type of actor your waiting for.
|-

|rowspan="2"|<center>'''RunInstanceController'''</center>
|-
|Param 1
|colspan="2"|Start point||0|| Starting point #. Default = 0
|rowspan="2"| This is automatically called by the startup routine. This starts the main function of the instance. It acts as a final place for it to end. If it succeeds/fails it gives a message.
|-

|rowspan="2"|<center>'''Reply_Option'''</center>
|-
|Param 1
|colspan="2"|Text||"I want to carry on!!!"|| Text you want to click within the reply dialog. Must be Quoted and Exact.
|rowspan="2"| Clicks a reply dialog via Text specified. self only.
|-

|rowspan="2"|<center>'''Set_PriestAscension'''</center>
|-
|Param 1
|colspan="2"|T or F|| TRUE/FALSE || N/A.
|rowspan="2"| Turn priest ascensions on/off. Also turns Combo's off.
|-

|rowspan="2"|<center>'''Set_VariousOptions'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Sets various options for solo or group content.
SOLO & DUO & Group
------------------------
Auto Target Clear
* Resume = TRUE
* Auto Target when hated = TRUE
* Move Melee = FALSE
* Move Behind = FALSE
* Move to Area = TRUE
* Ability Rotation = FALSE
* Quest Compare = FALSE
* Auto Target Enable = TRUE
* Loot = TRUE
* Auto target scan radius = 20
* Auto target scan Height = 15
* Loot Leader only enable = TRUE
* Loot Leader only smart assign = TRUE
* Loot Leader only loot everything = TRUE
* Sets Follow
* Sets assist
------------------------
SOLO Specifics
------------------------
* Disable merc support = TRUE
* Free for all Loot accept = TRUE
* Free for all Loot everything = TRUE
* Disable cast stack Items = TRUE
* Mark Toon = TRUE
------------------------
DUO Specifics
------------------------
* Mark Toon = TRUE
* Disable cast stack Items = TRUE
* Cancel and then Cast "Fount of Power"
------------------------
GROUP Specifics
------------------------
* UnMark Toon = TRUE
* Change cast stack Glacial Freeze = TRUE
* Change cast stack Absorb Magic = TRUE
|-

|rowspan="2"|<center>'''Set_Follow'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Sets follow and assist. for group and self if not grouped.
|-

|rowspan="3"|<center>'''Specialwait'''</center>
|-
|Param 1
|colspan="2"|Wait Time||30 = 3 seconds|| Time to wait before click. Default = 30
|rowspan="3"| Pauses bot and waits before Click Hits Special and waits after Click then resumes for Group or self if not grouped.
|-
|Param 2
|colspan="2"|Wait Time||30 = 3 seconds|| Time to wait after click. Default = 30
|-

|rowspan="3"|<center>'''ZoneSpecialwait'''</center>
|-
|Param 1
|colspan="2"|Wait Time||30 = 3 seconds|| Time to wait before click. Default = 30
|rowspan="3"| Pauses bot and waits before Click Hits ZoneSpecialSpecific and waits after Click then resumes for Group or self if not grouped.
|-
|Param 2
|colspan="2"|Wait Time||30 = 3 seconds|| Time to wait after click. Default = 30
|-

|rowspan="2"|<center>'''Get_Shinies_Options'''</center>
|-
|Param 1
|colspan="2"|Shiny Name||"?"|| Default: "?"
|rowspan="2"| Will use campspot to move around and loot shinies. If Skip shinies is checked, it will skip shinies. If Pause For Shiny is checked, will pause.
|-

|rowspan="2"|<center>'''Get_Shinies'''</center>
|-
|Param 1
|colspan="2"|Shiny Name||"?"|| Default: "?"
|rowspan="2"| Will use campspot to move around and loot shinies. If Skip shinies is checked, it will skip shinies. Ignores pause for shiny.
|-

|rowspan="5"|<center>'''Get_Shinies_Nav_Options'''</center>
|-
|Param 1
|colspan="2"|Loc||"-211.139343,84.733673,402.047363"|| N/A
|rowspan="5"| Will use Nav to move around and loot shinies within given range.
Will Nav to Loc supplied before and after looting shinies.
If Skip shinies is checked, it will skip shinies.
If Pause For Shiny is checked, will pause.
|-
|Param 2
|colspan="2"|Shiny Name||"?"|| Default: "?"
|-
|Param 3
|colspan="2"|Range||30|| Default: 30
|-
|Param 4
|colspan="2"|Args||-NoGroup|| will leave toons at starting Loc and only nav Tank to shiny.
|-

|rowspan="5"|<center>'''Get_Shinies_Nav'''</center>
|-
|Param 1
|colspan="2"|Loc||"-211.139343,84.733673,402.047363"|| N/A
|rowspan="5"| Will use Nav to move around and loot shinies within given range.
Will Nav to Loc supplied before and after looting shinies.
|-
|Param 2
|colspan="2"|Shiny Name||"?"|| Default: "?"
|-
|Param 3
|colspan="2"|Range||30|| Default: 30
|-
|Param 4
|colspan="2"|Args||-NoGroup|| will leave toons at starting Loc and only nav Tank to shiny.
|-

|rowspan="2"|<center>'''Get_Chest'''</center>
|-
|Param 1
|colspan="2"|Range||50|| Default: 50
|rowspan="2"| Will use campspot to move around and loot chests. Will not clear Campspot so if pathing use a LetsGo after.
|-

|rowspan="2"|<center>'''CD.GetIntoZone'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="1"| Specific to Chaos Descending: If you are near the mission givers in Myrist, will attempt to navigate over to the portal and zone you in, then wait for everyone to finish zoning. Returns TRUE if you make it into the zone, or FALSE if you do not for any reason.
|-

|rowspan="2"|<center>'''CD.ZoneOut'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="1"| Specific to Chaos Descending: If you are near the exit in a CD instance, will attempt to navigate over to the zone out portal and zone you out, then wait for everyone to finish zoning. Returns TRUE if it attempted to zone you out, or FALSE if the exit wasn't available.
|}

== Notes ==

* If you feel something needs adding or changing please let us know via discord.

OgreUtilitiesAPI

2019-07-31T23:58:46Z

Pork: /* List of Methods */

== Implementing OgreUtilities ==

* To use '''OgreUtilities''' you will need to load the code into your script.
** The following will load '''OgreUtilities''' into your script.

function Load_OgreUtilities()
{
ogre utilities
wait 5
Obj_CreateOgreUtilities:CreateOgreUtilities[${Script.Filename}]
;// Returns variable: OgreUtilities
Obj_CreateOgreUtilities:CreateOgreCharacterData[${Script.Filename}]
;// Returns variable: OgreCharacterData

;// Usage here. See wiki <Link here would likely be helpful, and some examples>
}

* This will allow you to use all of the below '''Methods''', '''Members''', '''Functions''' below.

== Summary ==

* List of '''Methods''', '''Members''', '''Functions'''

* pre configured '''Methods''', '''Members''', '''Functions''' to make coding scripts easier for people.

* If their is a command you do not understand please feel free to ask in ogre discord and someone will explain and try to word it better here in the list

== Advanced Navigation Options ==

=== Usage ===

* Obj_OgreUtilities.OgreNavChecks:<MethodNameHere>[<ParametersHere>]
** Example - Obj_OgreUtilities.OgreNavChecks:Set_Check_MeInCombat[FALSE]

=== List of Methods ===

*Below is a list of all available methods.

{| class="wikitable"
|-
!Command
!colspan="3"|Parameters||Example||Notes||Description
|-

|rowspan="2"|<center>'''Set_CheckAll'''</center>
|-
|Param 1
|colspan="2"|Distance||50|| Default = 50
|rowspan="2"| Sets checking group in combat, and distance to 50, sets checking if you are in combat.
|-

|rowspan="2"|<center>'''Set_Check_MeInCombat'''</center>
|-
|Param 1
|colspan="2"|T or F||TRUE or FALSE|| Default = TRUE
|rowspan="2"| Sets checking if you are in combat.
|-

|rowspan="3"|<center>'''Set_Check_Group'''</center>
|-
|Param 1
|colspan="2"|T or F||TRUE or FALSE|| Default = TRUE
|rowspan="3"| Sets checking the group for combat and the distance.
|-
|Param 2
|colspan="2"|Distance||50|| Default = 50
|-

|rowspan="2"|<center>'''Set_Check_GroupCombatOnly'''</center>
|-
|Param 1
|colspan="2"|T or F||TRUE or FALSE|| Default = TRUE
|rowspan="2"| Sets checking if you are in combat. Will disable "Set_Check_GroupDistanceOnly" if it is enabled.
|-

|rowspan="3"|<center>'''Set_Check_GroupDistanceOnly'''</center>
|-
|Param 1
|colspan="2"|T or F||TRUE or FALSE|| Default = TRUE
|rowspan="3"| Sets checking the group for combat and the distance. Will disable "Set_Check_GroupCombatOnly" if it is enabled.
|-
|Param 2
|colspan="2"|Distance||50|| Default = 50
|-

|rowspan="3"|<center>'''Set_Checks_GroupHealth'''</center>
|-
|Param 1
|colspan="2"|T or F||TRUE or FALSE|| Default = TRUE
|rowspan="3"| Sets checking the group health is under specified and if so stops naving till health goes above specified.
|-
|Param 2
|colspan="2"|Health||90|| Default = 90
|-

|}

== Methods ==

=== Usage ===

* Example - Obj_OgreUtilities:AcceptQuest
** Would Accept a quest if a quest window exists.

=== List of Methods ===

*Below is a list of all available methods.

{| class="wikitable"
|-
!Command
!colspan="3"|Parameters||Example||Notes||Description
|-

|rowspan="2"|<center>'''AcceptQuest'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Accepts a quest if a quest window exists.
|-

|rowspan="2"|<center>'''EQ2_onQuestOffered'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| If enabled, accepts new quests.
|-

|rowspan="2"|<center>'''EQ2_onRewardWindowAppeared'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| If enabled, accepts Reward windows.
|-

|rowspan="2"|<center>'''Jump'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Jumps a toon.
|-

|rowspan="2"|<center>'''Set_EQ2_onQuestOffered'''</center>
|-
|Param 1
|colspan="2"|T or F||TRUE/FALSE|| Enables (TRUE) or disables (FALSE) the EQ2_onQuestOffered event.
|rowspan="2"| Turns the event on or off
|-

|rowspan="2"|<center>'''Set_EQ2_onRewardWindowAppeared'''</center>
|-
|Param 1
|colspan="2"|T or F||TRUE/FALSE|| Enables (TRUE) or disables (FALSE) the EQ2_onRewardWindowAppeared event.
|rowspan="2"| Turns the event on or off
|-
|}

== Members ==

=== Usage ===

{| class="wikitable"
|-
|Example 1
if ${Obj_OgreUtilities.AnyGroupMembersDead}
{
;// Will return TRUE if any group members are dead False if all alive
;// Code to execute if it comes back as TRUE
}
Example 2
*echo ${Obj_OgreUtilities.ConvertSecondsToHMS[4500]}
**Would convert and return the specified seconds into hour.minute.seconds.
|-
|}

=== List of Members ===

*Below is a list of all available members.

{| class="wikitable"
|-
!Command
!colspan="3"|Parameters||Example||Notes||Description
|-

|rowspan="2"|<center>'''AnyGroupMembersDead'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Checks if any group members are dead.
|-

|rowspan="2"|<center>'''CleanName'''</center>
|-
|Param 1
|colspan="2"|Input to clean||Kannkor's battle Bot|| Cleans an input
|rowspan="2"| Some zones, I believe such as proving grounds, you can end up with some very odd names for characters, this removes it and "cleans" the input.
|-

|rowspan="2"|<center>'''ConvertSecondsToHMS'''</center>
|-
|Param 1
|colspan="2"|Seconds||2500|| Seconds to convert.
|rowspan="2"| Converts seconds to hour minutes seconds.
|-

|rowspan="2"|<center>'''Get_Hours'''</center>
|-
|Param 1
|colspan="2"|Seconds||2500|| Seconds to convert.
|rowspan="2"| Determines how many whole hours are in the seconds.
|-

|rowspan="2"|<center>'''Get_Minutes'''</center>
|-
|Param 1
|colspan="2"|Seconds||2500|| Seconds to convert.
|rowspan="2"| Determines how many whole minutes are in the seconds. Return can only be 0 to 59, as any value above that would be returned in Get_Hours.
|-

|rowspan="2"|<center>'''Get_Seconds'''</center>
|-
|Param 1
|colspan="2"|Seconds||2500|| Seconds to convert.
|rowspan="2"| Determines how many whole seconds are in the seconds. Return can only be 0 to 59, as any value above that would be returned in Get_Hours or Get_Minutes.
|-

|rowspan="2"|<center>'''GetAscensionClass'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| spews your current ascension class.
|-

|rowspan="2"|<center>'''HaveAbilityID'''</center>
|-
|Param 1
|colspan="2"|ID||483993047|| ID of ability to check.
|rowspan="2"| returns TRUE if you have the ability or FALSE if you do not.
|-

|rowspan="2"|<center>'''InZoneName'''</center>
|-
|Param 1
|colspan="2"|Zone Name||"Myrist, the Great Library"|| Zone name to check.
|rowspan="2"| Checks if you are in specified zone name.
|-

|rowspan="2"|<center>'''InZoneShortName'''</center>
|-
|Param 1
|colspan="2"|Zone Name||"exp15_rgn_plane_of_knowledge"|| Zone short name to check.
|rowspan="2"| Checks if you are in specified zone short name.
|-

|rowspan="2"|<center>'''ItemCount'''</center>
|-
|Param 1
|colspan="2"|Item Name||"mechanical gear"|| Item name to check.
|rowspan="2"| Counts how many of said item you have in your inventory. Does NOT count bank. This handles counting multiple stacks.
|-

|rowspan="3"|<center>'''NearLoc'''</center>
|-
|Param 1
|colspan="2"|Loc||"737.106506,411.865784,-388.380249"|| Loc to check.
|rowspan="3"| Checks if you are within specified distance to specified Loc.
|-
|Param 2
|colspan="2"|Distance|| 10 || how close. Default = 10
|-

|rowspan="2"|<center>'''NPCCount'''</center>
|-
|Param 1
|colspan="2"|Distance||30|| Distance to check.
|rowspan="2"| Counts how many NPCs are within specified distance.
|-

|rowspan="2"|<center>'''OnCorrectCharacter'''</center>
|-
|Param 1
|colspan="2"|Toon name||"Kannkor"|| Name of toon to check.
|rowspan="2"| Checks currently logged in toon name matches specified toon name.
|-

|rowspan="2"|<center>'''WhereAreWe'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Returns where you are. Valid returns are: GUILDHALL, or the zone hash ( ${Zone.ShortName} ). Basically used for checking if you're in a guild hall.
|-
|}

== Functions ==

=== Usage ===

*All functions are locking. That means when you call them, they 'hold' the script and return once completed.
**Almost every single function has a return, usually bool that you can access. If TRUE, it means it believes the function was successful, if FALSE, it believes the function was not successful.
***You can access this return, by checking ${Return} immediately after the function call.

Example 1
call Obj_OgreUtilities.CallToGH
if ${Return}
echo Means CallToGH was successful!

=== List of Functions ===

* Below is a list of all available functions

{| class="wikitable"
|-
!Command
!colspan="3"|Parameters||Example||Notes||Description
|-

|rowspan="2"|<center>'''CallToGH'''</center>
|-
|Param 1
|colspan="2"|T or F||TRUE/FALSE|| Default FALSE. FALSE means if Call to Guild Hall is not available, wait for it. TRUE means if the call is not available, then don't cast it.
|rowspan="2"| Calls to Guild Hall.
|-

|rowspan="3"|<center>'''CastAbilityID'''</center>
|-
|Param 1
|colspan="2"|ID||106506|| ID of the ability.
|rowspan="3"| Casts ability and waits specified time for ability to cast.
|-
|Param 2
|colspan="2"|Wait Time|| 50 = 5 seconds || Time to wait. Default = 50
|-

|rowspan="2"|<center>'''CastEvac'''</center>
|-
|Param 1
|colspan="2"|NotAvailableAtThisTime||NotAvailableAtThisTime|| NotAvailableAtThisTime
|rowspan="2"| Can't be used at this time. Requires a reference that isn't accessible yet.
|-

|rowspan="2"|<center>'''CheckEvacTotems'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Checks you have evac totems.
|-

|rowspan="2"|<center>'''CheckIfGroupInSameZone'''</center>
|-
|Param 1
|colspan="2"|How many seconds to check for||30|| How many seconds to check for
|rowspan="2"| returns TRUE as soon as your entire group is in the same zone. Returns FALSE if at the end of the seconds to check for, if everyone is not in the same zone
|-

|rowspan="2"|<center>'''ClearQuestWindow'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Clears the quest helper window. The in-game on-screen quest information with checkboxes that can only show like 5 quests. This just unchecks them. It does NOT delete quests.
|-

|rowspan="2"|<center>'''DoConversation'''</center>
|-
|Param 1
|colspan="2"|Numerical sequence of conversation baubles to choose||1 1 2 3 1|| When conversing with an NPC, this example would choose option 1, then 1, then 2, then 3, then 1.
|rowspan="2"| Accepts any number of conversations, and does so with a 1/2 second delay
|-

|rowspan="2"|<center>'''DoHail'''</center>
|-
|Param 1
|colspan="2"|NPC||"Flag dude"|| Name of NPC.
|rowspan="2"| Hails specified NPC via Name.
|-

|rowspan="2"|<center>'''DoHailID'''</center>
|-
|Param 1
|colspan="2"|ID||8959659794|| ID of NPC.
|rowspan="2"| Hails specified NPC via ID.
|-

|rowspan="3"|<center>'''DoTarget'''</center>
|-
|Param 1
|colspan="2"|NPC||"Flag dude"|| Name of NPC.
|rowspan="3"| Targets NPC if withing specified Range.
|-
|Param 2
|colspan="2"|Range|| 50 || within Range. Default = 40
|-

|rowspan="3"|<center>'''FastTravel'''</center>
|-
|Param 1
|colspan="2"|Name||"Freeport"|| Name of Zone/Destination.
|rowspan="3"| Travels to specified destination. ( Requires Membership )
|-
|Param 2
|colspan="2"|Exact match|| TRUE/FALSE || Default = FALSE
|-

|rowspan="2"|<center>'''GetIntoCorrectZone'''</center>
|-
|Param 1
|colspan="2"|NotAvailableAtThisTime||NotAvailableAtThisTime|| NotAvailableAtThisTime
|rowspan="2"| This was never finished, it would help navigating from zone to zone automatically, through connecting zones. However the manual input and maps required map the set up extremely difficult.
|-

|rowspan="2"|<center>'''GHToHouse'''</center>
|-
|Param 1
|colspan="2"|Name||"Kannkors house"|| Name of house to go to.
|rowspan="2"| Zones you to specified house from Guild Hall.
|-

|rowspan="3"|<center>'''HandleCampSpotToLoc'''</center>
|-
|Param 1
|colspan="2"|Loc||"737.106506,411.865784,-388.380249"|| Loc to campspot to.
|rowspan="3"| Sets your campspot to the location you passed it, and waits until you are within Range of it. Example, if you set it to 100, it would return TRUE if you are within 100 meters of the campspot.
|-
|Param 2
|colspan="2"|Range|| 125 || within Range. Default = 125
|-

|rowspan="2"|<center>'''HandleWaitForGroupDistance'''</center>
|-
|Param 1
|colspan="2"|Distance|| 5 || within Disatnce. Default = 5
|rowspan="2"| Waits until your entire group is within # distance of you. Good to use after you nav some where to make sure everyone is with you.
|-

|rowspan="2"|<center>'''HandleClickActor_Special'''</center>
|-
|Param 1
|colspan="2"|Distance|| 10 || within Disatnce. Default = 10
|rowspan="2"| Clicks special actor within disance specified.
|-

|rowspan="3"|<center>'''HandleClickActor'''</center>
|-
|Param 1
|colspan="2"|Name||"Mechanical gear"|| Name of actor.
|rowspan="3"| Clicks an actor within disance specified.
|-
|Param 2
|colspan="2"|Distance|| 10 || within Disatnce. Default = 10
|-

|rowspan="2"|<center>'''HandleConversation'''</center>
|-
|Param 1
|colspan="2"|NotAvailableAtThisTime||NotAvailableAtThisTime|| NotAvailableAtThisTime
|rowspan="2"| Requires an object not available at this time
|-

|rowspan="2"|<center>'''HandleConversationByText'''</center>
|-
|Param 1
|colspan="2"|Text inputs||"Where would you like to go?" "I want to get a rally flag" || Will handle chat baubles based on text input. Accepts up to 10 parameters.
|rowspan="2"| Conversation baubles
|-

|rowspan="2"|<center>'''HandleWaitForCampSpot'''</center>
|-
|Param 1
|colspan="2"|WaitBeforeChecking||10|| Waits this amount of time before checking, allowing campspot to be set. Default is 0 (no wait at all). Recommend use of 10 (1 second) if you JUST changed your campspot
|rowspan="2"| Waits until you are dead or within range of campspot. Returns TRUE if you are at your campspot (regardless of your range), returns FALSE if you are NOT at your campspot.
|-

|rowspan="5"|<center>'''HandleWaitForCombat'''</center>
|-
|Param 1
|colspan="2"|wait time||50 = 5 seconds|| Time to wait. Default = 50
|rowspan="5"| Waits specified time if in combat with specified options.
|-
|Param 2
|colspan="2"|Skip|| TRUE/FALSE || Skip if no mobs exist.
|-
|Param 3
|colspan="2"|Distance|| 30 || Skip if no mobs exist within specified distance.
|-
|Param 4
|colspan="2"|Clear target|| 40 || Clear target if distance of target over specified distance. Default = 40
|-

|rowspan="5"|<center>'''HandleWaitForCombatOrPower'''</center>
|-
|Param 1
|colspan="2"|wait time||50 = 5 seconds|| Time to wait. Default = 50
|rowspan="5"| Waits specified time if in combat with specified options.
|-
|Param 2
|colspan="2"|Skip|| TRUE/FALSE || Skip if no mobs exist.
|-
|Param 3
|colspan="2"|Distance|| 30 || Skip if no mobs exist within specified distance.
|-
|Param 4
|colspan="2"|Clear target|| 40 || Clear target if distance of target over specified distance. Default = 40
|-

|rowspan="3"|<center>'''HandleWaitForCombatWithNPC'''</center>
|-
|Param 1
|colspan="2"|NPC||"Trakanon"|| Name of NPC.
|rowspan="3"| Waits until combat is over. Returns TRUE if there was combat, and FALSE if there was not combat.
|-
|Param 2
|colspan="2"|Args|| -TimeToWait 50 (5 seconds), -SkipIfNoMobs TRUE/FALSE, -SkipIfNoMobsWithin 30, -ClearTargetIfTargetDistanceOver 50|| Accepts any of these args in pairs. The defaults are listed.
|-

|rowspan="2"|<center>'''HandleWaitForZoning'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Handles wait for when you are Zoning.
|-

|rowspan="2"|<center>'''HandleWaitTime'''</center>
|-
|Param 1
|colspan="2"|Wait Time||50|| Time to wait. Default = 50 (5 seconds)
|rowspan="2"| Literally just waits the specified amount of time.
|-

|rowspan="2"|<center>'''HandleZoneDoor'''</center>
|-
|Param 1
|colspan="2"|Option||1|| Zone door option. Default = 1
|rowspan="2"| Clicks specified Zone within a List UI.
|-

|rowspan="2"|<center>'''LoginToon'''</center>
|-
|Param 1
|colspan="2"|Toon||"Kannkor"|| Toon name to log in
|rowspan="2"| Logs in specified toon.
|-

|rowspan="3"|<center>'''NavTo'''</center>
|-
|Param 1
|colspan="2"|Loc||"737.106506,411.865784,-388.380249"|| Loc to nav to.
|rowspan="3"| Nav to specified location.
|-
|Param 2
|colspan="2"|How Close|| 1.5 || Get this close to destination. Default = 1.5
|-

|rowspan="3"|<center>'''NavToLoc'''</center>
|-
|Param 1
|colspan="2"|Loc||"737.106506,411.865784,-388.380249"|| Loc to nav to.
|rowspan="3"| Nav to specified location by specified precision.
|-
|Param 2
|colspan="2"|Precision|| 5 || Precision to destination. Default = 5
|-

|rowspan="3"|<center>'''NavToLocation'''</center>
|-
|Param 1
|colspan="2"|Location||"NPC_Loc_Main_Room"|| Saved Location to nav to.
|rowspan="3"| Nav to specified location by specified precision.
|-
|Param 2
|colspan="2"|Precision|| 5 || Precision to destination. Default = 5
|-

|rowspan="2"|<center>'''PreCombatBuff'''</center>
|-
|Param 1
|colspan="2"|Seconds||5 = 5 seconds|| Amount of Time to buff.
|rowspan="2"| Enters bots into Combat to force them to start casting incombat buffs/heals etc.
|-

|rowspan="2"|<center>'''ResetCameraAngle'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Resets your camera angle on your character, so it's in 3rd person view facing forward. Super useful if it may change before conversing with an NPC.
|-

|rowspan="2"|<center>'''Revive'''</center>
|-
|Param 1
|colspan="2"|Option||1|| Revive Option to use. Default = 1
|rowspan="2"| Revives at specified location.
|-

|rowspan="2"|<center>'''Set_FirstPersonView'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Puts you into First person view.
|-

|rowspan="2"|<center>'''Set_LookDown'''</center>
|-
|Param 1
|colspan="2"|Value||30|| How long to hold look down for. Default = 30 (3 seconds)
|rowspan="2"| Makes you "look down" for x seconds.
|-

|rowspan="2"|<center>'''Set_LookUp'''</center>
|-
|Param 1
|colspan="2"|Value||30|| How long to hold look up for Default = 30 (3 seconds)
|rowspan="2"| Makes you "look up" for x seconds.
|-

|rowspan="2"|<center>'''Set_ZoomIn'''</center>
|-
|Param 1
|colspan="2"|Value||30|| Default = 30
|rowspan="2"| Does nothing - Use Set_FirstPersonView if you wish to be zoomed in.
|-

|rowspan="2"|<center>'''Set_ZoomOut_MouseWheel'''</center>
|-
|Param 1
|colspan="2"|Value||30|| How many zoom out clicks to do. Default = 30
|rowspan="2"| Zooms out using the mouse wheel
|-

|rowspan="2"|<center>'''Set_ZoomOut'''</center>
|-
|Param 1
|colspan="2"|Value||30|| How long to hold the Zoom out key for. Default = 30 (3 seconds)
|rowspan="2"| Holds the zoom out key for this long.
|-

|rowspan="2"|<center>'''WaitForCasting'''</center>
|-
|Param 1
|colspan="2"|Wait Time||50 = 5 seconds|| Time to wait. Default = 50
|rowspan="2"| Wait while you are casting a spell or specified wait time.
|-

|rowspan="2"|<center>'''WaitForGroupToZone'''</center>
|-
|Param 1
|colspan="2"|How many||60 = 6 times|| Check how many times. Default = 60
|rowspan="2"| Check specified times for whole group to be in zone.
|-

|rowspan="2"|<center>'''WaitForLootWindow'''</center>
|-
|Param 1
|colspan="2"|wait time||50 = 5 seconds|| wait time. Default = 50
|rowspan="2"| Wait specified time for a lootwindow.
|-

|rowspan="2"|<center>'''WaitForPower'''</center>
|-
|Param 1
|colspan="2"|%||95|| wait for power %. Default = 95
|rowspan="2"| Wait for Power to be at or above specified %.
|-

|rowspan="2"|<center>'''WaitForScript'''</center>
|-
|Param 1
|colspan="2"|Script name||"Random Script"|| Script name.
|rowspan="2"| Wait while specified script is running.
|-

|rowspan="2"|<center>'''WaitForZoning'''</center>
|-
|Param 1
|colspan="2"|Wait Time||50 = 5 seconds|| wait time. Default = 50
|rowspan="2"| Wait while zoning and specified time.
|-

|rowspan="2"|<center>'''WaitWhileGroupMembersDead'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| wait while group members dead.
|-
|}

OgreInstanceHelperAPI

2019-07-30T20:52:40Z

Pork: /* List of Functions */

== Important Note ==

*This is currently not released.
*It will be ready when its ready.

== Summary ==

* List of '''Methods''', '''Members''', '''Functions''' that are to be used with '''Ogre ic''' files.

* pre configured '''Methods''', '''Members''', '''Functions''' to make coding zones easier for people.

* If their is a command you do not understand please feel free to ask in ogre discord and someone will explain and try to word it better here in the list

* This list will grow as ogre ic grows
** If you feel something needs adding/updating feel free to ask kannkor or pork on discord.

== Methods ==

=== Usage ===

* Example 1 - Obj_OgreIH:SetCampSpot
** Would Campspot your group.
* Example 2 - Obj_OgreIH:ChangeOgreBotUIOption["checkbox_settings_movebehind",TRUE]
** Would turn on move behind in ogrebot.
*** UI Code can be grabbed from ( InnerSpace\Scripts\EQ2OgreBot\OgreUIXML.xml )

=== List of Methods ===

*Below is a list of all available methods to be used with Ogre ic

{| class="wikitable"
|-
!Command
!colspan="3"|Parameters||Example||Notes||Description
|-

|rowspan="2"|<center>'''Set_Disable_AEsEncounters'''</center>
|-
|Param 1
|colspan="2"|Disabled||TRUE/FALSE|| N/A
|rowspan="2"| Disable AOEs and Encounters for group or self if not grouped.
|-

|rowspan="2"|<center>'''ClearRelativeCampSpot'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Clears relative campspots for group or self if not grouped.
|-

|rowspan="2"|<center>'''ClearCampSpot'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Clears campspots for group or self if not grouped.
|-

|rowspan="3"|<center>'''SetCampSpot'''</center>
|-
|Param 1
|colspan="2"|How Close||1.5|| Default = 1.5
|rowspan="3"| Sets campspot for group or self if not grouped for specified distances.
|-
|Param 2
|colspan="2"|How Far||200|| Default = 200
|-

|rowspan="2"|<center>'''ChangeCampSpot'''</center>
|-
|Param 1
|colspan="2"|Loc||"127.084137,-180.863373,-832.558899"|| Loc to change campspot to. Has to be Quoted.
|rowspan="2"| Change campspot for group or self if not grouped.
|-

|rowspan="2"|<center>'''CCS_Actor'''</center>
|-
|Param 1
|colspan="2"|Actor ID||1234|| Actor ID to change campspot too.
|rowspan="2"| Change campspot for group or self if not grouped to the Actor's position.
|-

|rowspan="2"|<center>'''CCS_Actor_Position'''</center>
|-
|Param 1
|colspan="2"|Actor ID||1234|| Actor ID to change campspot too.
|rowspan="2"| Change campspot for group or self if not grouped to the Actor's position, with using infront (fighters) and behind (non-fighters)
|-

|rowspan="2"|<center>'''SetUpFor'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Does a SetUpFor command for group or self if not grouped. ( Requires being Campspotted )
|-

|rowspan="2"|<center>'''Set_NoMove'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Sets NoMove for group or self if not grouped.
|-

|rowspan="2"|<center>'''Actor_Click'''</center>
|-
|Param 1
|colspan="2"|Actor||"Name" or ID|| Name or ID of actor to Click.
|rowspan="2"| Clicks an Actor for group or self if not grouped.
|-

|rowspan="2"|<center>'''Use_Item'''</center>
|-
|Param 1
|colspan="2"|Item||"Name"|| Name of item to Use.
|rowspan="2"| Uses an item from inventory for group or self if not grouped.
|-

|rowspan="2"|<center>'''LetsGo'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Hits LetsGo for group or self if not grouped.
|-

|rowspan="2"|<center>'''Jump'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| makes bots Jump. for group or self if not grouped.
|-

|rowspan="2"|<center>'''Jump_Me'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| makes only you Jump. for self Only.
|-

|rowspan="2"|<center>'''CallGH'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Calls to Guild Hall. For group or self if not grouped.
|-

|rowspan="2"|<center>'''CallHome'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Calls to Home. For group or self if not grouped.
|-

|rowspan="2"|<center>'''Tradeskill_Close'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Closes tradeskill window. For self Only.
|-

|rowspan="3"|<center>'''ChangeOgreBotUIOption'''</center>
|-
|Param 1
|colspan="2"|UI Code||"Checkbox_blah"|| UI Code/element to change from Ogrebotui.xml.
|rowspan="3"| Set a UI element in ogrebot to on/off. for group or self if not grouped.
|-
|Param 2
|colspan="2"|T or F|| TRUE/FALSE || Set UI element to on/off.
|-

|rowspan="4"|<center>'''Set_ZoneInformation'''</center>
|-
|Param 1
|colspan="2"|Zone Name||"Myrist, the Great Library"|| Zone name to set. via ${Zone.Name}.
|rowspan="4"| Sets all zone information for files usaully called from main function of script.
|-
|Param 2
|colspan="2"|Zone ShortName||"exp15_rgn_plane_of_knowledge"|| Zone Short name to set. via ${Zone.ShortName}.
|-
|Param 3
|colspan="2"|Actor|| "zone_to_poa" || Actor name to click to zone.
|-

|rowspan="2"|<center>'''Set_Debug_Mode'''</center>
|-
|Param 1
|colspan="2"|T or F|| TRUE/FALSE || N/A.
|rowspan="2"| Turn debug mode on or off. ( Very Spammy )
|-

|rowspan="2"|<center>'''Message_FailedZone'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Sends a failed message to Ogre Console with zone information.
|-

|rowspan="2"|<center>'''Message_FailedNamed'''</center>
|-
|Param 1
|colspan="2"|Named||"Trakanon"|| Name of Named.
|rowspan="2"| Sends a failed message to Ogre Console with specified named information.
|-

|rowspan="2"|<center>'''Message_FailedZoneOut'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Sends a failed message to Ogre Console with zone out information.
|-

|rowspan="2"|<center>'''Message_NamedDoesNotExistSkipping'''</center>
|-
|Param 1
|colspan="2"|Named||"Trakanon"|| Name of Named.
|rowspan="2"| Sends a Skipping message to Ogre Console with specified named information.
|-

|rowspan="2"|<center>'''Message_FailedToKill'''</center>
|-
|Param 1
|colspan="2"|Named||"Trakanon"|| Name of Named.
|rowspan="2"| Sends a failed to kill message to Ogre Console named information.
|-

|rowspan="2"|<center>'''MonkeyInMiddle'''</center>
|-
|Param 1
|colspan="2"|Range||10|| Range to spread to. Default = 10
|rowspan="2"| Set monkey in the middle by specified range. for group or self if not grouped.
|-
|}

== Members ==

=== Usage ===

{| class="wikitable"
|-
|Example 1
if ${Obj_OgreIH.Tradeskill_vis}
{
;// Will only trigger this if the tradeskill window is visible in game
;// Code to execute if it comes back as TRUE
}
Example 2
if ${Actor[id, ${Obj_OgreIH.Get_NPC_ID["Trakanon"]}](exists)}
{
;// Will only trigger this if the NPC exists
;// Code to execute if it comes back as TRUE
}
|-
|}

=== List of Members ===

*Below is a list of all available members to be used with Ogre ic

{| class="wikitable"
|-
!Command
!colspan="3"|Parameters||Example||Notes||Description
|-

|rowspan="2"|<center>'''DuoMode'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Checks if only 2 members are in group with you. For duo zones to make sure their is not more or less than 2 members in group.
|-

|rowspan="2"|<center>'''Get_NPC_ID'''</center>
|-
|Param 1
|colspan="2"|NPC||"Trakanon"|| Name of NPC.
|rowspan="2"| Gets the ID for the specified NPC.
|-

|rowspan="4"|<center>'''Get_IDFromActorQuery'''</center>
|-
|Param 1
|colspan="2"|Actor Name||"Trakanon"|| Name of Actor.
|rowspan="4"| Checks if Actor Name specified Loc exists at Loc supplied within distance supplied.
|-
|Param 2
|colspan="2"|Loc||"737.106506,411.865784,-388.380249"|| Loc to compare to.
|-
|Param 3
|colspan="2"|Distance|| 2 || Disatnce to check. Default = 2
|-

|rowspan="2"|<center>'''SoloMode'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Checks if only 1 members are in group or 1 member 1 merc. For Solo zones to make sure their is not more or less than 1 member 1 merc in group.
|-

|rowspan="2"|<center>'''Tradeskill_vis'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Checks to see if Tradeskill window is open in game.
|-
|}

== Functions ==

=== Usage ===

* Example 1 - call Obj_OgreIH.HandleAcceptReward 10
** Would accept reward windows 10 times for your group.
* Example 2 - call Obj_OgreIH.NamedSpawnWait "Trakanon" 60 "NamedNPC"
** Would wait 60 seconds or until the specified Named spawns.

=== List of Functions ===

* Below is a list of all available functions to be used with Ogre ic

{| class="wikitable"
|-
!Command
!colspan="3"|Parameters||Example||Notes||Description
|-

|rowspan="3"|<center>'''ClearTrashUntilNamedSpawns'''</center>
|-
|Param 1
|colspan="2"|NPC||"Trakanon"|| Name of NPC.
|rowspan="3"| Kill trash untill specified NPC spawns within specified distance.
|-
|Param 2
|colspan="2"|Radius||30|| Radius to check trash. Default = 30
|-

|rowspan="2"|<center>'''HandleAcceptReward'''</center>
|-
|Param 1
|colspan="2"|Max Times||10|| How many times to accept rewards #. Default = 10
|rowspan="2"| Accept rewards specified # of times. .5 second wait between each.
|-

|rowspan="3"|<center>'''KillActorType'''</center>
|-
|Param 1
|colspan="2"|Radius||30|| Radius to check trash. Default = 30
|rowspan="3"| Kill trash via Type that are within specified radius.
|-
|Param 2
|colspan="2"|Type||"NPC"|| Actor Type you are looking for. Default = "NPC"
|-

|rowspan="3"|<center>'''KillAll'''</center>
|-
|Param 1
|colspan="2"|NPC Name|| "a random mob" || N/A
|rowspan="3"| Will change campspot to nearest specified npc with specified options. till no more exist.
|-
|Param 2
|colspan="2"|Args||options to use||
Options that can be used.
* -NoPosition = no behind/infront change campspot. Default = TRUE
* -jump = Will jump when at npc. Default = FALSE
* -NoWaitForCombat or -nwc = will not wait for combat before trying to get to next. Default = TRUE
* -MonkeyInMiddle or -mim = Requires range Example: -mim 10 = Will do monkey in middle at each npc. Default = FALSE
* -StopWhenNamedNPCSpawns "Trakanon" = requires NPC named to stop when seen. Will exit function when specified named spawns. Default = FALSE
* -SetUpFor = will setupfor at each npc specified. Default = FALSE
|-

|rowspan="4"|<center>'''NamedSpawnWait'''</center>
|-
|Param 1
|colspan="2"|NamedNPC||"Trakanon"|| Name of Actor.
|rowspan="4"| Waits specified time or untill specified name and specified Type exist as true. fail message if Named does not spawn.
|-
|Param 2
|colspan="2"|Time to wait||60 = 60 seconds|| Time to wait.
|-
|Param 3
|colspan="2"|Type|| "NamedNPC" || Type of actor your waiting for.
|-

|rowspan="2"|<center>'''RunInstanceController'''</center>
|-
|Param 1
|colspan="2"|Start point||0|| Starting point #. Default = 0
|rowspan="2"| This is automatically called by the startup routine. This starts the main function of the instance. It acts as a final place for it to end. If it succeeds/fails it gives a message.
|-

|rowspan="2"|<center>'''Reply_Option'''</center>
|-
|Param 1
|colspan="2"|Text||"I want to carry on!!!"|| Text you want to click within the reply dialog. Must be Quoted and Exact.
|rowspan="2"| Clicks a reply dialog via Text specified. self only.
|-

|rowspan="2"|<center>'''Set_PriestAscension'''</center>
|-
|Param 1
|colspan="2"|T or F|| TRUE/FALSE || N/A.
|rowspan="2"| Turn priest ascensions on/off. Also turns Combo's off.
|-

|rowspan="2"|<center>'''Set_VariousOptions'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Sets various options for solo or group content.
SOLO & DUO & Group
------------------------
Auto Target Clear
* Resume = TRUE
* Auto Target when hated = TRUE
* Move Melee = FALSE
* Move Behind = FALSE
* Move to Area = TRUE
* Ability Rotation = FALSE
* Quest Compare = FALSE
* Auto Target Enable = TRUE
* Loot = TRUE
* Auto target scan radius = 20
* Auto target scan Height = 15
* Loot Leader only enable = TRUE
* Loot Leader only smart assign = TRUE
* Loot Leader only loot everything = TRUE
* Sets Follow
* Sets assist
------------------------
SOLO Specifics
------------------------
* Disable merc support = TRUE
* Free for all Loot accept = TRUE
* Free for all Loot everything = TRUE
* Disable cast stack Items = TRUE
* Mark Toon = TRUE
------------------------
DUO Specifics
------------------------
* Mark Toon = TRUE
* Disable cast stack Items = TRUE
* Cancel and then Cast "Fount of Power"
------------------------
GROUP Specifics
------------------------
* UnMark Toon = TRUE
* Change cast stack Glacial Freeze = TRUE
* Change cast stack Absorb Magic = TRUE
|-

|rowspan="2"|<center>'''Set_Follow'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Sets follow and assist. for group and self if not grouped.
|-

|rowspan="3"|<center>'''Specialwait'''</center>
|-
|Param 1
|colspan="2"|Wait Time||30 = 3 seconds|| Time to wait before click. Default = 30
|rowspan="3"| Pauses bot and waits before Click Hits Special and waits after Click then resumes for Group or self if not grouped.
|-
|Param 2
|colspan="2"|Wait Time||30 = 3 seconds|| Time to wait after click. Default = 30
|-

|rowspan="3"|<center>'''ZoneSpecialwait'''</center>
|-
|Param 1
|colspan="2"|Wait Time||30 = 3 seconds|| Time to wait before click. Default = 30
|rowspan="3"| Pauses bot and waits before Click Hits ZoneSpecialSpecific and waits after Click then resumes for Group or self if not grouped.
|-
|Param 2
|colspan="2"|Wait Time||30 = 3 seconds|| Time to wait after click. Default = 30
|-

|rowspan="2"|<center>'''Get_Shinies_Options'''</center>
|-
|Param 1
|colspan="2"|Shiny Name||"?"|| Default: "?"
|rowspan="2"| Will use campspot to move around and loot shinies. If Skip shinies is checked, it will skip shinies. If Pause For Shiny is checked, will pause.
|-

|rowspan="2"|<center>'''Get_Shinies'''</center>
|-
|Param 1
|colspan="2"|Shiny Name||"?"|| Default: "?"
|rowspan="2"| Will use campspot to move around and loot shinies. If Skip shinies is checked, it will skip shinies. Ignores pause for shiny.
|-

|rowspan="4"|<center>'''Get_Shinies_Nav_Options'''</center>
|-
|Param 1
|colspan="2"|Loc||"-211.139343,84.733673,402.047363"|| N/A
|rowspan="4"| Will use Nav to move around and loot shinies within given range.
Will Nav to Loc supplied before and after looting shinies.
If Skip shinies is checked, it will skip shinies.
If Pause For Shiny is checked, will pause.
|-
|Param 2
|colspan="2"|Shiny Name||"?"|| Default: "?"
|-
|Param 3
|colspan="2"|Range||30|| Default: 30
|-

|rowspan="4"|<center>'''Get_Shinies_Nav'''</center>
|-
|Param 1
|colspan="2"|Loc||"-211.139343,84.733673,402.047363"|| N/A
|rowspan="4"| Will use Nav to move around and loot shinies within given range.
Will Nav to Loc supplied before and after looting shinies.
|-
|Param 2
|colspan="2"|Shiny Name||"?"|| Default: "?"
|-
|Param 3
|colspan="2"|Range||30|| Default: 30
|-

|rowspan="2"|<center>'''Get_Chest'''</center>
|-
|Param 1
|colspan="2"|Range||50|| Default: 50
|rowspan="2"| Will use campspot to move around and loot chests. Will not clear Campspot so if pathing use a LetsGo after.
|-

|rowspan="2"|<center>'''CD.GetIntoZone'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="1"| Specific to Chaos Descending: If you are near the mission givers in Myrist, will attempt to navigate over to the portal and zone you in, then wait for everyone to finish zoning. Returns TRUE if you make it into the zone, or FALSE if you do not for any reason.
|-

|rowspan="2"|<center>'''CD.ZoneOut'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="1"| Specific to Chaos Descending: If you are near the exit in a CD instance, will attempt to navigate over to the zone out portal and zone you out, then wait for everyone to finish zoning. Returns TRUE if it attempted to zone you out, or FALSE if the exit wasn't available.
|}

== Notes ==

* If you feel something needs adding or changing please let us know via discord.

ISXOgre

2019-07-30T09:27:15Z

Pork: /* Other Ogre Scripts */

<big>'''Welcome to Ogre Wiki.'''</big>

This page is for the Everquest 2 Ogre Adventure bot and Ogre Crafting bot.
OgreBot is a fully customizable adventure bot. OgreCraft is an advanced crafting bot.
* OgreBot and OgreCraft are part of the ISXOgre extension. However one thing to point out, ISXOgre does NOT do anything ISXEQ2 does. You REQUIRE ISXEQ2 in order to use ISXOgre.
* Lastly, ISXOgre requires a subscription, see Ogre Pricing for more details.

----

== Introduction ==

Ogrebot is a fully customizable adventure bot.

* [[WhyOgre|Why OgreBot? OgreBot vs the competition! (Adventure bot)]]

* [[WhyOgreCraft|Why OgreCraft? OgreCraft vs the competition! (Crafting bot)]]

* [[OgrePricing|Ogre Pricing]]

* [[ObtainingASubscription|How to obtain a subscription]]

* [[HowToCancelASubscription|How to cancel a subscription]]

* [[NewUserWalkthrough:Page01|New User Walkthrough]]

* [[Advanced User Tips|Advanced User Tips]] - Been with Ogre a little while now? Next Steps found here

* [[Ogre:FAQ|FAQ and Help]] - Including screen shots of examples of how to setup classes.

* [[Ogre:DidYouKnow|Did you know...]] - Random pieces of information that will help you sleep at night.

* [[ContactInfo|Contact information and Ventrilo]]

* [[RevisionHistory|Revision History]] - Here you will find the revision history. Every time a file is updated, I will do my best to include specifics of what was added, and any important details about it.
* [https://forge.isxgames.com/projects/ogrebot-eq2/issues Feature Requests] - Here you will find a list of items I have on my list to code. Some are new, some are upgrades etc.

== Ogre Bot ==

* [[Tab:Overview|Tabs]] - Click here for more information about each tab and to see screen shots.
* [[Aliases|Aliases]] - Aliases
* [[ProfileAliases|Profile Aliases]] - Aliases
* [[Raid Instances|Raid Options]] - Raid specific options
* [[Heroic Instances|Heroic Options]] - Heroic options
* [[OgreMCP|OgreMCP]] - Ogre Master Control Panel.
* [[UplinkController|Uplink Controller]] - It controls other sessions.
* [[OgreBotCommands| Ogre Commands]] - How to load Ogrebot, as well as various other commands included.
* [[OgreMapper| Ogre Mapping]] & [[Ogre Nav]] - mapping and moving
* [[OgreBotChatCommands| Ogre Chat Window Commands]] - In-game chat commands that Ogrebot responds to.
* [[OgreInfo|Ogre info | options | config]] - Loads a UI for user information and other Ogrebot options
* [[ISXOgre:MethodsAndMembers|ISXOgre methods and members]]
* [[ISXOgre:OgreProcessorlocking|Ogre Processor Locking]]
* [[OgreBot:UnfixableBugs|Unfixable bugs]]
* [[OgreEvents|OgreEvents]]
* [[Ogre Affiliates|Ogre Affiliates]] - Scripts written and hosted inside of ogre
* [[ForWho|ForWho]] - Documentation for any place you need to reference a ForWho command

== Advanced Usage ==

* [[Torment Runes|Torment Runes]] - Setting up Torment Runes to be handled by OgreBot.

== Crafting - Harvesting & Depots ==

*'''Crafting'''
** [[OgreCraft:Overview|OgreCraft]]
** [[OgreCraft:MainWindow|Tabs]]
** [[OgreCraft:MethodsandMembers|Ogre Craft Methods and Members]]

*'''Harvesting'''
** [[Ogre GoblinHousePlant|Ogre Plant]] - Manages the house plant (Kunark Ascending Crafting Quests)
** [[Ogre GatherGoblin|Ogre Goblin]] - Manages the gathering goblin
** [[OgreOther:Hirex|HireX]] - HireX is a script that allows you to run guild hall hirelings automaticaly and have them put their harvests into the GH depots.
** [[OgreMapper|Ogre Map]] - A zone mapping and WP marking tool.
** Ogre Harvest -- In the ISXEQ2 Command Window type '''Ogre Harvest'''; should be used with Ogre Map, this will allow your toons to auto harvest.

*'''Depots'''
** [[OgreOther:Depots|Depot]] - Guild Hall Depot Management and Commands

* '''Tradeskill Apprentice Managment'''
** [[OgreTradeskillApprentice|Ogre Tradeskill Apprentice]]
** [[OgreTradeskillApprenticeManager|Ogre Tradeskill Apprentice Manager (TSAM)]]

*'''Transmute'''
** In your ISXEQ2 command drop down window type Ogre Transmute - Loads the Transmute UI (supports to level 110 now)

*'''Salvage'''
** In your ISXEQ2 command drop down window type Ogre Salvage - Loads the Salvage UI (supports to level 110 now)
***Please note you must have the salvage crafting AA in order to use this option

== Faction Scripts ==

* [[OgreOther:FreeportFaction|FreeportFaction]] - Freeport faction is a script to assist in the faction part of the betrayal quest.
* [[QeynosFaction|QeynosFaction]] - Qeynos faction is a script that assist in the faction part of the betrayal quest.
* [[OgreOther:Othmir|Othmir]] - Does repeatable faction quests in Great Divide. NOTE: This script is a use-as-is. It is NOT supported or maintained.

== Heroic / Raid Scripts ==

*'''Heroic Zones'''
* [[Heroic Instances]] - Heroic specific options

*'''Raid Zones'''
* [[Raid_Instances|Raid Options]] - Raid specific options

== Other Ogre Scripts ==

* [[OgreOther:AutoLogin|AutoLogin]] - Directions to set up some Auto Login scripts that will load multiple clients including across multiple pc's.
* [[OgreOther:Item|OgreItem]] - Currently in testing, only accessible by testers. An Item Database manager to help track what characters have what items.
* [[OgreOther:InventoryManager|Old Inventory Manager]] - Used to transfer items between toons and bags. A collection of scripts used to assist with inventory management.
* [[Ogre Inventory Manager|Ogre Inventory Manager]] - Used for all your inventory Needs. Sell - Destroy - Trade - Transmute/salvage/extract and more.
* [[OgreListManager|Ogre List Manager]] - Used to create custom lists for later use in other Ogre features.
* [[OgreAscensionDailyTask|Ogre Ascension Daily Task]] - Designed to run characters to ascension trainers to get their daily scrolls.
* [[OgreProvingGroundsTheUnderdepths|Ogre Proving Grounds: The Underdepths]] - Designed to run the proving grounds solo for each of your characters automagically
* [[Ogre Boat|Ogre Boat]] - Runs the Frillik Tide key quest in OF
* [[Ogre Collection Manager|Ogre Collection Manager]] - Both depot and inventory options for managing collectibles
* [[Ogre HideEffects|Ogre HideEffects]] - Helps cut down the number of effects in your spell effects window.
* [[Ogre TrackShiny|Ogre TrackShiny]] - Helps track down shinies nearby, can sort out colors.
* [[Ogre Zone Resetter|Ogre Zone Resetter]] - Zone Resetting User Interface
* [[Ogre Export|Ogre Export]] - Exports ability information for us in Ogre Bot
* [[Ogre Ability Efficiency|Ogre Ability Efficiency]] - parse your ability export and export it
* [[Ogre TempAdorns|Ogre TempAdorns]] - Make a List and Apply the List of Temporary Adorns to a Character.
* [[OgreMerchantCraft|Ogre Merchant Craft]] - Craft limited use recipes from merchant at merchant.
* [[OgreRPC|Ogre RPC]] - Checks your Raid Armour Patterns to see what is unlocked.
* [[OgreInfuse|Ogre Infuse]] - Infuse items Automatically with infusers or Plat.
* [[OgreReforge|Ogre Reforge]] - Reforge into a predefined or self defined set of stats.
* [[OgreAdorns|Ogre Adorns]] - Scans your inventory and Equipment and compares in a UI.
* [[OgreExperiment|Ogre Experiment]] - Loads a UI so you can make a list of items to experiment on and choose stats etc.
* [[OgreInstanceController|Ogre Instance Controller]] - IC - Runs Instances for you.

* [[Miscellaneous Scripts|Miscellaneous Scripts]] - This page is for other smaller Ogre scripts to be compiled

== OgreIRC ==

* [[OgreIRC:OgreIRC|OgreIRC]] - OgreIRC is a IRC plugin that hooks into the uplink and allows control of some functions inside sessions.

== Script Developers ==

* [[SpewStats|Spew Stats]] - A list of all spewstats options
* [[OgreBotAPI|OgreBotAPI]] - Methods & Members for scriptwriters to utilise
* [[OgreInstanceHelperAPI|Ogre Instance Helper API]] - Methods & Members for scriptwriters to utilise when making instance files
* [[OgreUtilitiesAPI|Ogre Utilities API]] - Methods & Members for scriptwriters to utilise when making instance files or local scripts

OgreInstanceHelperAPI

2019-07-28T22:03:10Z

Pork: /* List of Methods */

== Important Note ==

*This is currently not released.
*It will be ready when its ready.

== Summary ==

* List of '''Methods''', '''Members''', '''Functions''' that are to be used with '''Ogre ic''' files.

* pre configured '''Methods''', '''Members''', '''Functions''' to make coding zones easier for people.

* If their is a command you do not understand please feel free to ask in ogre discord and someone will explain and try to word it better here in the list

* This list will grow as ogre ic grows
** If you feel something needs adding/updating feel free to ask kannkor or pork on discord.

== Methods ==

=== Usage ===

* Example 1 - Obj_OgreIH:SetCampSpot
** Would Campspot your group.
* Example 2 - Obj_OgreIH:ChangeOgreBotUIOption["checkbox_settings_movebehind",TRUE]
** Would turn on move behind in ogrebot.
*** UI Code can be grabbed from ( InnerSpace\Scripts\EQ2OgreBot\OgreUIXML.xml )

=== List of Methods ===

*Below is a list of all available methods to be used with Ogre ic

{| class="wikitable"
|-
!Command
!colspan="3"|Parameters||Example||Notes||Description
|-

|rowspan="2"|<center>'''Set_Disable_AEsEncounters'''</center>
|-
|Param 1
|colspan="2"|Disabled||TRUE/FALSE|| N/A
|rowspan="2"| Disable AOEs and Encounters for group or self if not grouped.
|-

|rowspan="2"|<center>'''ClearRelativeCampSpot'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Clears relative campspots for group or self if not grouped.
|-

|rowspan="2"|<center>'''ClearCampSpot'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Clears campspots for group or self if not grouped.
|-

|rowspan="3"|<center>'''SetCampSpot'''</center>
|-
|Param 1
|colspan="2"|How Close||1.5|| Default = 1.5
|rowspan="3"| Sets campspot for group or self if not grouped for specified distances.
|-
|Param 2
|colspan="2"|How Far||200|| Default = 200
|-

|rowspan="2"|<center>'''ChangeCampSpot'''</center>
|-
|Param 1
|colspan="2"|Loc||"127.084137,-180.863373,-832.558899"|| Loc to change campspot to. Has to be Quoted.
|rowspan="2"| Change campspot for group or self if not grouped.
|-

|rowspan="2"|<center>'''CCS_Actor'''</center>
|-
|Param 1
|colspan="2"|Actor ID||1234|| Actor ID to change campspot too.
|rowspan="2"| Change campspot for group or self if not grouped to the Actor's position.
|-

|rowspan="2"|<center>'''CCS_Actor_Position'''</center>
|-
|Param 1
|colspan="2"|Actor ID||1234|| Actor ID to change campspot too.
|rowspan="2"| Change campspot for group or self if not grouped to the Actor's position, with using infront (fighters) and behind (non-fighters)
|-

|rowspan="2"|<center>'''SetUpFor'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Does a SetUpFor command for group or self if not grouped. ( Requires being Campspotted )
|-

|rowspan="2"|<center>'''Set_NoMove'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Sets NoMove for group or self if not grouped.
|-

|rowspan="2"|<center>'''Actor_Click'''</center>
|-
|Param 1
|colspan="2"|Actor||"Name" or ID|| Name or ID of actor to Click.
|rowspan="2"| Clicks an Actor for group or self if not grouped.
|-

|rowspan="2"|<center>'''Use_Item'''</center>
|-
|Param 1
|colspan="2"|Item||"Name"|| Name of item to Use.
|rowspan="2"| Uses an item from inventory for group or self if not grouped.
|-

|rowspan="2"|<center>'''LetsGo'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Hits LetsGo for group or self if not grouped.
|-

|rowspan="2"|<center>'''Jump'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| makes bots Jump. for group or self if not grouped.
|-

|rowspan="2"|<center>'''Jump_Me'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| makes only you Jump. for self Only.
|-

|rowspan="2"|<center>'''CallGH'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Calls to Guild Hall. For group or self if not grouped.
|-

|rowspan="2"|<center>'''CallHome'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Calls to Home. For group or self if not grouped.
|-

|rowspan="2"|<center>'''Tradeskill_Close'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Closes tradeskill window. For self Only.
|-

|rowspan="3"|<center>'''ChangeOgreBotUIOption'''</center>
|-
|Param 1
|colspan="2"|UI Code||"Checkbox_blah"|| UI Code/element to change from Ogrebotui.xml.
|rowspan="3"| Set a UI element in ogrebot to on/off. for group or self if not grouped.
|-
|Param 2
|colspan="2"|T or F|| TRUE/FALSE || Set UI element to on/off.
|-

|rowspan="4"|<center>'''Set_ZoneInformation'''</center>
|-
|Param 1
|colspan="2"|Zone Name||"Myrist, the Great Library"|| Zone name to set. via ${Zone.Name}.
|rowspan="4"| Sets all zone information for files usaully called from main function of script.
|-
|Param 2
|colspan="2"|Zone ShortName||"exp15_rgn_plane_of_knowledge"|| Zone Short name to set. via ${Zone.ShortName}.
|-
|Param 3
|colspan="2"|Actor|| "zone_to_poa" || Actor name to click to zone.
|-

|rowspan="2"|<center>'''Set_Debug_Mode'''</center>
|-
|Param 1
|colspan="2"|T or F|| TRUE/FALSE || N/A.
|rowspan="2"| Turn debug mode on or off. ( Very Spammy )
|-

|rowspan="2"|<center>'''Message_FailedZone'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Sends a failed message to Ogre Console with zone information.
|-

|rowspan="2"|<center>'''Message_FailedNamed'''</center>
|-
|Param 1
|colspan="2"|Named||"Trakanon"|| Name of Named.
|rowspan="2"| Sends a failed message to Ogre Console with specified named information.
|-

|rowspan="2"|<center>'''Message_FailedZoneOut'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Sends a failed message to Ogre Console with zone out information.
|-

|rowspan="2"|<center>'''Message_NamedDoesNotExistSkipping'''</center>
|-
|Param 1
|colspan="2"|Named||"Trakanon"|| Name of Named.
|rowspan="2"| Sends a Skipping message to Ogre Console with specified named information.
|-

|rowspan="2"|<center>'''Message_FailedToKill'''</center>
|-
|Param 1
|colspan="2"|Named||"Trakanon"|| Name of Named.
|rowspan="2"| Sends a failed to kill message to Ogre Console named information.
|-

|rowspan="2"|<center>'''MonkeyInMiddle'''</center>
|-
|Param 1
|colspan="2"|Range||10|| Range to spread to. Default = 10
|rowspan="2"| Set monkey in the middle by specified range. for group or self if not grouped.
|-
|}

== Members ==

=== Usage ===

{| class="wikitable"
|-
|Example 1
if ${Obj_OgreIH.Tradeskill_vis}
{
;// Will only trigger this if the tradeskill window is visible in game
;// Code to execute if it comes back as TRUE
}
Example 2
if ${Actor[id, ${Obj_OgreIH.Get_NPC_ID["Trakanon"]}](exists)}
{
;// Will only trigger this if the NPC exists
;// Code to execute if it comes back as TRUE
}
|-
|}

=== List of Members ===

*Below is a list of all available members to be used with Ogre ic

{| class="wikitable"
|-
!Command
!colspan="3"|Parameters||Example||Notes||Description
|-

|rowspan="2"|<center>'''DuoMode'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Checks if only 2 members are in group with you. For duo zones to make sure their is not more or less than 2 members in group.
|-

|rowspan="2"|<center>'''Get_NPC_ID'''</center>
|-
|Param 1
|colspan="2"|NPC||"Trakanon"|| Name of NPC.
|rowspan="2"| Gets the ID for the specified NPC.
|-

|rowspan="4"|<center>'''Get_IDFromActorQuery'''</center>
|-
|Param 1
|colspan="2"|Actor Name||"Trakanon"|| Name of Actor.
|rowspan="4"| Checks if Actor Name specified Loc exists at Loc supplied within distance supplied.
|-
|Param 2
|colspan="2"|Loc||"737.106506,411.865784,-388.380249"|| Loc to compare to.
|-
|Param 3
|colspan="2"|Distance|| 2 || Disatnce to check. Default = 2
|-

|rowspan="2"|<center>'''SoloMode'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Checks if only 1 members are in group or 1 member 1 merc. For Solo zones to make sure their is not more or less than 1 member 1 merc in group.
|-

|rowspan="2"|<center>'''Tradeskill_vis'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Checks to see if Tradeskill window is open in game.
|-
|}

== Functions ==

=== Usage ===

* Example 1 - call Obj_OgreIH.HandleAcceptReward 10
** Would accept reward windows 10 times for your group.
* Example 2 - call Obj_OgreIH.NamedSpawnWait "Trakanon" 60 "NamedNPC"
** Would wait 60 seconds or until the specified Named spawns.

=== List of Functions ===

* Below is a list of all available functions to be used with Ogre ic

{| class="wikitable"
|-
!Command
!colspan="3"|Parameters||Example||Notes||Description
|-

|rowspan="3"|<center>'''ClearTrashUntilNamedSpawns'''</center>
|-
|Param 1
|colspan="2"|NPC||"Trakanon"|| Name of NPC.
|rowspan="3"| Kill trash untill specified NPC spawns within specified distance.
|-
|Param 2
|colspan="2"|Radius||30|| Radius to check trash. Default = 30
|-

|rowspan="2"|<center>'''HandleAcceptReward'''</center>
|-
|Param 1
|colspan="2"|Max Times||10|| How many times to accept rewards #. Default = 10
|rowspan="2"| Accept rewards specified # of times. .5 second wait between each.
|-

|rowspan="3"|<center>'''KillActorType'''</center>
|-
|Param 1
|colspan="2"|Radius||30|| Radius to check trash. Default = 30
|rowspan="3"| Kill trash via Type that are within specified radius.
|-
|Param 2
|colspan="2"|Type||"NPC"|| Actor Type you are looking for. Default = "NPC"
|-

|rowspan="4"|<center>'''NamedSpawnWait'''</center>
|-
|Param 1
|colspan="2"|NamedNPC||"Trakanon"|| Name of Actor.
|rowspan="4"| Waits specified time or untill specified name and specified Type exist as true. fail message if Named does not spawn.
|-
|Param 2
|colspan="2"|Time to wait||60 = 60 seconds|| Time to wait.
|-
|Param 3
|colspan="2"|Type|| "NamedNPC" || Type of actor your waiting for.
|-

|rowspan="2"|<center>'''RunInstanceController'''</center>
|-
|Param 1
|colspan="2"|Start point||0|| Starting point #. Default = 0
|rowspan="2"| This is automatically called by the startup routine. This starts the main function of the instance. It acts as a final place for it to end. If it succeeds/fails it gives a message.
|-

|rowspan="2"|<center>'''Reply_Option'''</center>
|-
|Param 1
|colspan="2"|Text||"I want to carry on!!!"|| Text you want to click within the reply dialog. Must be Quoted and Exact.
|rowspan="2"| Clicks a reply dialog via Text specified. self only.
|-

|rowspan="2"|<center>'''Set_PriestAscension'''</center>
|-
|Param 1
|colspan="2"|T or F|| TRUE/FALSE || N/A.
|rowspan="2"| Turn priest ascensions on/off. Also turns Combo's off.
|-

|rowspan="2"|<center>'''Set_VariousOptions'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Sets various options for solo or group content.
SOLO & DUO & Group
------------------------
Auto Target Clear
* Resume = TRUE
* Auto Target when hated = TRUE
* Move Melee = FALSE
* Move Behind = FALSE
* Move to Area = TRUE
* Ability Rotation = FALSE
* Quest Compare = FALSE
* Auto Target Enable = TRUE
* Loot = TRUE
* Auto target scan radius = 20
* Auto target scan Height = 15
* Loot Leader only enable = TRUE
* Loot Leader only smart assign = TRUE
* Loot Leader only loot everything = TRUE
* Sets Follow
* Sets assist
------------------------
SOLO Specifics
------------------------
* Disable merc support = TRUE
* Free for all Loot accept = TRUE
* Free for all Loot everything = TRUE
* Disable cast stack Items = TRUE
* Mark Toon = TRUE
------------------------
DUO Specifics
------------------------
* Mark Toon = TRUE
* Disable cast stack Items = TRUE
* Cancel and then Cast "Fount of Power"
------------------------
GROUP Specifics
------------------------
* UnMark Toon = TRUE
* Change cast stack Glacial Freeze = TRUE
* Change cast stack Absorb Magic = TRUE
|-

|rowspan="2"|<center>'''Set_Follow'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Sets follow and assist. for group and self if not grouped.
|-

|rowspan="3"|<center>'''Specialwait'''</center>
|-
|Param 1
|colspan="2"|Wait Time||30 = 3 seconds|| Time to wait before click. Default = 30
|rowspan="3"| Pauses bot and waits before Click Hits Special and waits after Click then resumes for Group or self if not grouped.
|-
|Param 2
|colspan="2"|Wait Time||30 = 3 seconds|| Time to wait after click. Default = 30
|-

|rowspan="3"|<center>'''ZoneSpecialwait'''</center>
|-
|Param 1
|colspan="2"|Wait Time||30 = 3 seconds|| Time to wait before click. Default = 30
|rowspan="3"| Pauses bot and waits before Click Hits ZoneSpecialSpecific and waits after Click then resumes for Group or self if not grouped.
|-
|Param 2
|colspan="2"|Wait Time||30 = 3 seconds|| Time to wait after click. Default = 30
|-

|rowspan="2"|<center>'''Get_Shinies_Options'''</center>
|-
|Param 1
|colspan="2"|Shiny Name||"?"|| Default: "?"
|rowspan="2"| Will use campspot to move around and loot shinies. If Skip shinies is checked, it will skip shinies. If Pause For Shiny is checked, will pause.
|-

|rowspan="2"|<center>'''Get_Shinies'''</center>
|-
|Param 1
|colspan="2"|Shiny Name||"?"|| Default: "?"
|rowspan="2"| Will use campspot to move around and loot shinies. If Skip shinies is checked, it will skip shinies. Ignores pause for shiny.
|-

|rowspan="4"|<center>'''Get_Shinies_Nav_Options'''</center>
|-
|Param 1
|colspan="2"|Loc||"-211.139343,84.733673,402.047363"|| N/A
|rowspan="4"| Will use Nav to move around and loot shinies within given range.
Will Nav to Loc supplied before and after looting shinies.
If Skip shinies is checked, it will skip shinies.
If Pause For Shiny is checked, will pause.
|-
|Param 2
|colspan="2"|Shiny Name||"?"|| Default: "?"
|-
|Param 3
|colspan="2"|Range||30|| Default: 30
|-

|rowspan="4"|<center>'''Get_Shinies_Nav'''</center>
|-
|Param 1
|colspan="2"|Loc||"-211.139343,84.733673,402.047363"|| N/A
|rowspan="4"| Will use Nav to move around and loot shinies within given range.
Will Nav to Loc supplied before and after looting shinies.
|-
|Param 2
|colspan="2"|Shiny Name||"?"|| Default: "?"
|-
|Param 3
|colspan="2"|Range||30|| Default: 30
|-

|rowspan="2"|<center>'''Get_Chest'''</center>
|-
|Param 1
|colspan="2"|Range||50|| Default: 50
|rowspan="2"| Will use campspot to move around and loot chests. Will not clear Campspot so if pathing use a LetsGo after.
|-

|rowspan="2"|<center>'''CD.GetIntoZone'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="1"| Specific to Chaos Descending: If you are near the mission givers in Myrist, will attempt to navigate over to the portal and zone you in, then wait for everyone to finish zoning. Returns TRUE if you make it into the zone, or FALSE if you do not for any reason.
|-

|rowspan="2"|<center>'''CD.ZoneOut'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="1"| Specific to Chaos Descending: If you are near the exit in a CD instance, will attempt to navigate over to the zone out portal and zone you out, then wait for everyone to finish zoning. Returns TRUE if it attempted to zone you out, or FALSE if the exit wasn't available.
|}

== Notes ==

* If you feel something needs adding or changing please let us know via discord.

OgreInstanceHelperAPI

2019-07-28T19:32:27Z

Pork: /* List of Methods */

== Important Note ==

*This is currently not released.
*It will be ready when its ready.

== Summary ==

* List of '''Methods''', '''Members''', '''Functions''' that are to be used with '''Ogre ic''' files.

* pre configured '''Methods''', '''Members''', '''Functions''' to make coding zones easier for people.

* If their is a command you do not understand please feel free to ask in ogre discord and someone will explain and try to word it better here in the list

* This list will grow as ogre ic grows
** If you feel something needs adding/updating feel free to ask kannkor or pork on discord.

== Methods ==

=== Usage ===

* Example 1 - Obj_OgreIH:SetCampSpot
** Would Campspot your group.
* Example 2 - Obj_OgreIH:ChangeOgreBotUIOption["checkbox_settings_movebehind",TRUE]
** Would turn on move behind in ogrebot.
*** UI Code can be grabbed from ( InnerSpace\Scripts\EQ2OgreBot\OgreUIXML.xml )

=== List of Methods ===

*Below is a list of all available methods to be used with Ogre ic

{| class="wikitable"
|-
!Command
!colspan="3"|Parameters||Example||Notes||Description
|-

|rowspan="2"|<center>'''Set_Disable_AEsEncounters'''</center>
|-
|Param 1
|colspan="2"|Disabled||TRUE/FALSE|| N/A
|rowspan="2"| Disable AOEs and Encounters for group or self if not grouped.
|-

|rowspan="2"|<center>'''ClearRelativeCampSpot'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Clears relative campspots for group or self if not grouped.
|-

|rowspan="2"|<center>'''ClearCampSpot'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Clears campspots for group or self if not grouped.
|-

|rowspan="3"|<center>'''SetCampSpot'''</center>
|-
|Param 1
|colspan="2"|How Close||1.5|| Default = 1.5
|rowspan="3"| Sets campspot for group or self if not grouped for specified distances.
|-
|Param 2
|colspan="2"|How Far||200|| Default = 200
|-

|rowspan="2"|<center>'''ChangeCampSpot'''</center>
|-
|Param 1
|colspan="2"|Loc||"127.084137,-180.863373,-832.558899"|| Loc to change campspot to.
|rowspan="2"| Change campspot for group or self if not grouped.
|-

|rowspan="2"|<center>'''CCS_Actor'''</center>
|-
|Param 1
|colspan="2"|Actor ID||1234|| Actor ID to change campspot too.
|rowspan="2"| Change campspot for group or self if not grouped to the Actor's position.
|-

|rowspan="2"|<center>'''CCS_Actor_Position'''</center>
|-
|Param 1
|colspan="2"|Actor ID||1234|| Actor ID to change campspot too.
|rowspan="2"| Change campspot for group or self if not grouped to the Actor's position, with using infront (fighters) and behind (non-fighters)
|-

|rowspan="2"|<center>'''SetUpFor'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Does a SetUpFor command for group or self if not grouped. ( Requires being Campspotted )
|-

|rowspan="2"|<center>'''Set_NoMove'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Sets NoMove for group or self if not grouped.
|-

|rowspan="2"|<center>'''Actor_Click'''</center>
|-
|Param 1
|colspan="2"|Actor||"Name" or ID|| Name or ID of actor to Click.
|rowspan="2"| Clicks an Actor for group or self if not grouped.
|-

|rowspan="2"|<center>'''Use_Item'''</center>
|-
|Param 1
|colspan="2"|Item||"Name"|| Name of item to Use.
|rowspan="2"| Uses an item from inventory for group or self if not grouped.
|-

|rowspan="2"|<center>'''LetsGo'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Hits LetsGo for group or self if not grouped.
|-

|rowspan="2"|<center>'''Jump'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| makes bots Jump. for group or self if not grouped.
|-

|rowspan="2"|<center>'''Jump_Me'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| makes only you Jump. for self Only.
|-

|rowspan="2"|<center>'''CallGH'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Calls to Guild Hall. For group or self if not grouped.
|-

|rowspan="2"|<center>'''CallHome'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Calls to Home. For group or self if not grouped.
|-

|rowspan="2"|<center>'''Tradeskill_Close'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Closes tradeskill window. For self Only.
|-

|rowspan="3"|<center>'''ChangeOgreBotUIOption'''</center>
|-
|Param 1
|colspan="2"|UI Code||"Checkbox_blah"|| UI Code/element to change from Ogrebotui.xml.
|rowspan="3"| Set a UI element in ogrebot to on/off. for group or self if not grouped.
|-
|Param 2
|colspan="2"|T or F|| TRUE/FALSE || Set UI element to on/off.
|-

|rowspan="4"|<center>'''Set_ZoneInformation'''</center>
|-
|Param 1
|colspan="2"|Zone Name||"Myrist, the Great Library"|| Zone name to set. via ${Zone.Name}.
|rowspan="4"| Sets all zone information for files usaully called from main function of script.
|-
|Param 2
|colspan="2"|Zone ShortName||"exp15_rgn_plane_of_knowledge"|| Zone Short name to set. via ${Zone.ShortName}.
|-
|Param 3
|colspan="2"|Actor|| "zone_to_poa" || Actor name to click to zone.
|-

|rowspan="2"|<center>'''Set_Debug_Mode'''</center>
|-
|Param 1
|colspan="2"|T or F|| TRUE/FALSE || N/A.
|rowspan="2"| Turn debug mode on or off. ( Very Spammy )
|-

|rowspan="2"|<center>'''Message_FailedZone'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Sends a failed message to Ogre Console with zone information.
|-

|rowspan="2"|<center>'''Message_FailedNamed'''</center>
|-
|Param 1
|colspan="2"|Named||"Trakanon"|| Name of Named.
|rowspan="2"| Sends a failed message to Ogre Console with specified named information.
|-

|rowspan="2"|<center>'''Message_FailedZoneOut'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Sends a failed message to Ogre Console with zone out information.
|-

|rowspan="2"|<center>'''Message_NamedDoesNotExistSkipping'''</center>
|-
|Param 1
|colspan="2"|Named||"Trakanon"|| Name of Named.
|rowspan="2"| Sends a Skipping message to Ogre Console with specified named information.
|-

|rowspan="2"|<center>'''Message_FailedToKill'''</center>
|-
|Param 1
|colspan="2"|Named||"Trakanon"|| Name of Named.
|rowspan="2"| Sends a failed to kill message to Ogre Console named information.
|-

|rowspan="2"|<center>'''MonkeyInMiddle'''</center>
|-
|Param 1
|colspan="2"|Range||10|| Range to spread to. Default = 10
|rowspan="2"| Set monkey in the middle by specified range. for group or self if not grouped.
|-
|}

== Members ==

=== Usage ===

{| class="wikitable"
|-
|Example 1
if ${Obj_OgreIH.Tradeskill_vis}
{
;// Will only trigger this if the tradeskill window is visible in game
;// Code to execute if it comes back as TRUE
}
Example 2
if ${Actor[id, ${Obj_OgreIH.Get_NPC_ID["Trakanon"]}](exists)}
{
;// Will only trigger this if the NPC exists
;// Code to execute if it comes back as TRUE
}
|-
|}

=== List of Members ===

*Below is a list of all available members to be used with Ogre ic

{| class="wikitable"
|-
!Command
!colspan="3"|Parameters||Example||Notes||Description
|-

|rowspan="2"|<center>'''DuoMode'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Checks if only 2 members are in group with you. For duo zones to make sure their is not more or less than 2 members in group.
|-

|rowspan="2"|<center>'''Get_NPC_ID'''</center>
|-
|Param 1
|colspan="2"|NPC||"Trakanon"|| Name of NPC.
|rowspan="2"| Gets the ID for the specified NPC.
|-

|rowspan="4"|<center>'''Get_IDFromActorQuery'''</center>
|-
|Param 1
|colspan="2"|Actor Name||"Trakanon"|| Name of Actor.
|rowspan="4"| Checks if Actor Name specified Loc exists at Loc supplied within distance supplied.
|-
|Param 2
|colspan="2"|Loc||"737.106506,411.865784,-388.380249"|| Loc to compare to.
|-
|Param 3
|colspan="2"|Distance|| 2 || Disatnce to check. Default = 2
|-

|rowspan="2"|<center>'''SoloMode'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Checks if only 1 members are in group or 1 member 1 merc. For Solo zones to make sure their is not more or less than 1 member 1 merc in group.
|-

|rowspan="2"|<center>'''Tradeskill_vis'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Checks to see if Tradeskill window is open in game.
|-
|}

== Functions ==

=== Usage ===

* Example 1 - call Obj_OgreIH.HandleAcceptReward 10
** Would accept reward windows 10 times for your group.
* Example 2 - call Obj_OgreIH.NamedSpawnWait "Trakanon" 60 "NamedNPC"
** Would wait 60 seconds or until the specified Named spawns.

=== List of Functions ===

* Below is a list of all available functions to be used with Ogre ic

{| class="wikitable"
|-
!Command
!colspan="3"|Parameters||Example||Notes||Description
|-

|rowspan="3"|<center>'''ClearTrashUntilNamedSpawns'''</center>
|-
|Param 1
|colspan="2"|NPC||"Trakanon"|| Name of NPC.
|rowspan="3"| Kill trash untill specified NPC spawns within specified distance.
|-
|Param 2
|colspan="2"|Radius||30|| Radius to check trash. Default = 30
|-

|rowspan="2"|<center>'''HandleAcceptReward'''</center>
|-
|Param 1
|colspan="2"|Max Times||10|| How many times to accept rewards #. Default = 10
|rowspan="2"| Accept rewards specified # of times. .5 second wait between each.
|-

|rowspan="3"|<center>'''KillActorType'''</center>
|-
|Param 1
|colspan="2"|Radius||30|| Radius to check trash. Default = 30
|rowspan="3"| Kill trash via Type that are within specified radius.
|-
|Param 2
|colspan="2"|Type||"NPC"|| Actor Type you are looking for. Default = "NPC"
|-

|rowspan="4"|<center>'''NamedSpawnWait'''</center>
|-
|Param 1
|colspan="2"|NamedNPC||"Trakanon"|| Name of Actor.
|rowspan="4"| Waits specified time or untill specified name and specified Type exist as true. fail message if Named does not spawn.
|-
|Param 2
|colspan="2"|Time to wait||60 = 60 seconds|| Time to wait.
|-
|Param 3
|colspan="2"|Type|| "NamedNPC" || Type of actor your waiting for.
|-

|rowspan="2"|<center>'''RunInstanceController'''</center>
|-
|Param 1
|colspan="2"|Start point||0|| Starting point #. Default = 0
|rowspan="2"| This is automatically called by the startup routine. This starts the main function of the instance. It acts as a final place for it to end. If it succeeds/fails it gives a message.
|-

|rowspan="2"|<center>'''Reply_Option'''</center>
|-
|Param 1
|colspan="2"|Text||"I want to carry on!!!"|| Text you want to click within the reply dialog. Must be Quoted and Exact.
|rowspan="2"| Clicks a reply dialog via Text specified. self only.
|-

|rowspan="2"|<center>'''Set_PriestAscension'''</center>
|-
|Param 1
|colspan="2"|T or F|| TRUE/FALSE || N/A.
|rowspan="2"| Turn priest ascensions on/off. Also turns Combo's off.
|-

|rowspan="2"|<center>'''Set_VariousOptions'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Sets various options for solo or group content.
SOLO & DUO & Group
------------------------
Auto Target Clear
* Resume = TRUE
* Auto Target when hated = TRUE
* Move Melee = FALSE
* Move Behind = FALSE
* Move to Area = TRUE
* Ability Rotation = FALSE
* Quest Compare = FALSE
* Auto Target Enable = TRUE
* Loot = TRUE
* Auto target scan radius = 20
* Auto target scan Height = 15
* Loot Leader only enable = TRUE
* Loot Leader only smart assign = TRUE
* Loot Leader only loot everything = TRUE
* Sets Follow
* Sets assist
------------------------
SOLO Specifics
------------------------
* Disable merc support = TRUE
* Free for all Loot accept = TRUE
* Free for all Loot everything = TRUE
* Disable cast stack Items = TRUE
* Mark Toon = TRUE
------------------------
DUO Specifics
------------------------
* Mark Toon = TRUE
* Disable cast stack Items = TRUE
* Cancel and then Cast "Fount of Power"
------------------------
GROUP Specifics
------------------------
* UnMark Toon = TRUE
* Change cast stack Glacial Freeze = TRUE
* Change cast stack Absorb Magic = TRUE
|-

|rowspan="2"|<center>'''Set_Follow'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Sets follow and assist. for group and self if not grouped.
|-

|rowspan="3"|<center>'''Specialwait'''</center>
|-
|Param 1
|colspan="2"|Wait Time||30 = 3 seconds|| Time to wait before click. Default = 30
|rowspan="3"| Pauses bot and waits before Click Hits Special and waits after Click then resumes for Group or self if not grouped.
|-
|Param 2
|colspan="2"|Wait Time||30 = 3 seconds|| Time to wait after click. Default = 30
|-

|rowspan="3"|<center>'''ZoneSpecialwait'''</center>
|-
|Param 1
|colspan="2"|Wait Time||30 = 3 seconds|| Time to wait before click. Default = 30
|rowspan="3"| Pauses bot and waits before Click Hits ZoneSpecialSpecific and waits after Click then resumes for Group or self if not grouped.
|-
|Param 2
|colspan="2"|Wait Time||30 = 3 seconds|| Time to wait after click. Default = 30
|-

|rowspan="2"|<center>'''Get_Shinies_Options'''</center>
|-
|Param 1
|colspan="2"|Shiny Name||"?"|| Default: "?"
|rowspan="2"| Will use campspot to move around and loot shinies. If Skip shinies is checked, it will skip shinies. If Pause For Shiny is checked, will pause.
|-

|rowspan="2"|<center>'''Get_Shinies'''</center>
|-
|Param 1
|colspan="2"|Shiny Name||"?"|| Default: "?"
|rowspan="2"| Will use campspot to move around and loot shinies. If Skip shinies is checked, it will skip shinies. Ignores pause for shiny.
|-

|rowspan="4"|<center>'''Get_Shinies_Nav_Options'''</center>
|-
|Param 1
|colspan="2"|Loc||"-211.139343,84.733673,402.047363"|| N/A
|rowspan="4"| Will use Nav to move around and loot shinies within given range.
Will Nav to Loc supplied before and after looting shinies.
If Skip shinies is checked, it will skip shinies.
If Pause For Shiny is checked, will pause.
|-
|Param 2
|colspan="2"|Shiny Name||"?"|| Default: "?"
|-
|Param 3
|colspan="2"|Range||30|| Default: 30
|-

|rowspan="4"|<center>'''Get_Shinies_Nav'''</center>
|-
|Param 1
|colspan="2"|Loc||"-211.139343,84.733673,402.047363"|| N/A
|rowspan="4"| Will use Nav to move around and loot shinies within given range.
Will Nav to Loc supplied before and after looting shinies.
|-
|Param 2
|colspan="2"|Shiny Name||"?"|| Default: "?"
|-
|Param 3
|colspan="2"|Range||30|| Default: 30
|-

|rowspan="2"|<center>'''Get_Chest'''</center>
|-
|Param 1
|colspan="2"|Range||50|| Default: 50
|rowspan="2"| Will use campspot to move around and loot chests. Will not clear Campspot so if pathing use a LetsGo after.
|-

|rowspan="2"|<center>'''CD.GetIntoZone'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="1"| Specific to Chaos Descending: If you are near the mission givers in Myrist, will attempt to navigate over to the portal and zone you in, then wait for everyone to finish zoning. Returns TRUE if you make it into the zone, or FALSE if you do not for any reason.
|-

|rowspan="2"|<center>'''CD.ZoneOut'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="1"| Specific to Chaos Descending: If you are near the exit in a CD instance, will attempt to navigate over to the zone out portal and zone you out, then wait for everyone to finish zoning. Returns TRUE if it attempted to zone you out, or FALSE if the exit wasn't available.
|}

== Notes ==

* If you feel something needs adding or changing please let us know via discord.

OgreInstanceHelperAPI

2019-07-27T02:36:46Z

Pork: /* List of Functions */

== Important Note ==

*This is currently not released.
*It will be ready when its ready.

== Summary ==

* List of '''Methods''', '''Members''', '''Functions''' that are to be used with '''Ogre ic''' files.

* pre configured '''Methods''', '''Members''', '''Functions''' to make coding zones easier for people.

* If their is a command you do not understand please feel free to ask in ogre discord and someone will explain and try to word it better here in the list

* This list will grow as ogre ic grows
** If you feel something needs adding/updating feel free to ask kannkor or pork on discord.

== Methods ==

=== Usage ===

* Example 1 - Obj_OgreIH:SetCampSpot
** Would Campspot your group.
* Example 2 - Obj_OgreIH:ChangeOgreBotUIOption["checkbox_settings_movebehind",TRUE]
** Would turn on move behind in ogrebot.
*** UI Code can be grabbed from ( InnerSpace\Scripts\EQ2OgreBot\OgreUIXML.xml )

=== List of Methods ===

*Below is a list of all available methods to be used with Ogre ic

{| class="wikitable"
|-
!Command
!colspan="3"|Parameters||Example||Notes||Description
|-

|rowspan="2"|<center>'''Set_Disable_AEsEncounters'''</center>
|-
|Param 1
|colspan="2"|Disabled||TRUE/FALSE|| N/A
|rowspan="2"| Disable AOEs and Encounters for group or self if not grouped.
|-

|rowspan="2"|<center>'''ClearRelativeCampSpot'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Clears relative campspots for group or self if not grouped.
|-

|rowspan="2"|<center>'''ClearCampSpot'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Clears campspots for group or self if not grouped.
|-

|rowspan="2"|<center>'''SetCampSpot'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Sets campspot for group or self if not grouped.
|-

|rowspan="2"|<center>'''ChangeCampSpot'''</center>
|-
|Param 1
|colspan="2"|Loc||"127.084137,-180.863373,-832.558899"|| Loc to change campspot to.
|rowspan="2"| Change campspot for group or self if not grouped.
|-

|rowspan="2"|<center>'''CCS_Actor'''</center>
|-
|Param 1
|colspan="2"|Actor ID||1234|| Actor ID to change campspot too.
|rowspan="2"| Change campspot for group or self if not grouped to the Actor's position.
|-

|rowspan="2"|<center>'''CCS_Actor_Position'''</center>
|-
|Param 1
|colspan="2"|Actor ID||1234|| Actor ID to change campspot too.
|rowspan="2"| Change campspot for group or self if not grouped to the Actor's position, with using infront (fighters) and behind (non-fighters)
|-

|rowspan="2"|<center>'''SetUpFor'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Does a SetUpFor command for group or self if not grouped. ( Requires being Campspotted )
|-

|rowspan="2"|<center>'''Set_NoMove'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Sets NoMove for group or self if not grouped.
|-

|rowspan="2"|<center>'''Actor_Click'''</center>
|-
|Param 1
|colspan="2"|Actor||"Name" or ID|| Name or ID of actor to Click.
|rowspan="2"| Clicks an Actor for group or self if not grouped.
|-

|rowspan="2"|<center>'''Use_Item'''</center>
|-
|Param 1
|colspan="2"|Item||"Name"|| Name of item to Use.
|rowspan="2"| Uses an item from inventory for group or self if not grouped.
|-

|rowspan="2"|<center>'''LetsGo'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Hits LetsGo for group or self if not grouped.
|-

|rowspan="2"|<center>'''Jump'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| makes bots Jump. for group or self if not grouped.
|-

|rowspan="2"|<center>'''Jump_Me'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| makes only you Jump. for self Only.
|-

|rowspan="2"|<center>'''CallGH'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Calls to Guild Hall. For group or self if not grouped.
|-

|rowspan="2"|<center>'''CallHome'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Calls to Home. For group or self if not grouped.
|-

|rowspan="2"|<center>'''Tradeskill_Close'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Closes tradeskill window. For self Only.
|-

|rowspan="3"|<center>'''ChangeOgreBotUIOption'''</center>
|-
|Param 1
|colspan="2"|UI Code||"Checkbox_blah"|| UI Code/element to change from Ogrebotui.xml.
|rowspan="3"| Set a UI element in ogrebot to on/off. for group or self if not grouped.
|-
|Param 2
|colspan="2"|T or F|| TRUE/FALSE || Set UI element to on/off.
|-

|rowspan="4"|<center>'''Set_ZoneInformation'''</center>
|-
|Param 1
|colspan="2"|Zone Name||"Myrist, the Great Library"|| Zone name to set. via ${Zone.Name}.
|rowspan="4"| Sets all zone information for files usaully called from main function of script.
|-
|Param 2
|colspan="2"|Zone ShortName||"exp15_rgn_plane_of_knowledge"|| Zone Short name to set. via ${Zone.ShortName}.
|-
|Param 3
|colspan="2"|Actor|| "zone_to_poa" || Actor name to click to zone.
|-

|rowspan="2"|<center>'''Set_Debug_Mode'''</center>
|-
|Param 1
|colspan="2"|T or F|| TRUE/FALSE || N/A.
|rowspan="2"| Turn debug mode on or off. ( Very Spammy )
|-

|rowspan="2"|<center>'''Message_FailedZone'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Sends a failed message to Ogre Console with zone information.
|-

|rowspan="2"|<center>'''Message_FailedNamed'''</center>
|-
|Param 1
|colspan="2"|Named||"Trakanon"|| Name of Named.
|rowspan="2"| Sends a failed message to Ogre Console with specified named information.
|-

|rowspan="2"|<center>'''Message_FailedZoneOut'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Sends a failed message to Ogre Console with zone out information.
|-

|rowspan="2"|<center>'''Message_NamedDoesNotExistSkipping'''</center>
|-
|Param 1
|colspan="2"|Named||"Trakanon"|| Name of Named.
|rowspan="2"| Sends a Skipping message to Ogre Console with specified named information.
|-

|rowspan="2"|<center>'''Message_FailedToKill'''</center>
|-
|Param 1
|colspan="2"|Named||"Trakanon"|| Name of Named.
|rowspan="2"| Sends a failed to kill message to Ogre Console named information.
|-

|rowspan="2"|<center>'''MonkeyInMiddle'''</center>
|-
|Param 1
|colspan="2"|Range||10|| Range to spread to. Default = 10
|rowspan="2"| Set monkey in the middle by specified range. for group or self if not grouped.
|-
|}

== Members ==

=== Usage ===

{| class="wikitable"
|-
|Example 1
if ${Obj_OgreIH.Tradeskill_vis}
{
;// Will only trigger this if the tradeskill window is visible in game
;// Code to execute if it comes back as TRUE
}
Example 2
if ${Actor[id, ${Obj_OgreIH.Get_NPC_ID["Trakanon"]}](exists)}
{
;// Will only trigger this if the NPC exists
;// Code to execute if it comes back as TRUE
}
|-
|}

=== List of Members ===

*Below is a list of all available members to be used with Ogre ic

{| class="wikitable"
|-
!Command
!colspan="3"|Parameters||Example||Notes||Description
|-

|rowspan="2"|<center>'''DuoMode'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Checks if only 2 members are in group with you. For duo zones to make sure their is not more or less than 2 members in group.
|-

|rowspan="2"|<center>'''Get_NPC_ID'''</center>
|-
|Param 1
|colspan="2"|NPC||"Trakanon"|| Name of NPC.
|rowspan="2"| Gets the ID for the specified NPC.
|-

|rowspan="4"|<center>'''Get_IDFromActorQuery'''</center>
|-
|Param 1
|colspan="2"|Actor Name||"Trakanon"|| Name of Actor.
|rowspan="4"| Checks if Actor Name specified Loc exists at Loc supplied within distance supplied.
|-
|Param 2
|colspan="2"|Loc||"737.106506,411.865784,-388.380249"|| Loc to compare to.
|-
|Param 3
|colspan="2"|Distance|| 2 || Disatnce to check. Default = 2
|-

|rowspan="2"|<center>'''SoloMode'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Checks if only 1 members are in group or 1 member 1 merc. For Solo zones to make sure their is not more or less than 1 member 1 merc in group.
|-

|rowspan="2"|<center>'''Tradeskill_vis'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Checks to see if Tradeskill window is open in game.
|-
|}

== Functions ==

=== Usage ===

* Example 1 - call Obj_OgreIH.HandleAcceptReward 10
** Would accept reward windows 10 times for your group.
* Example 2 - call Obj_OgreIH.NamedSpawnWait "Trakanon" 60 "NamedNPC"
** Would wait 60 seconds or until the specified Named spawns.

=== List of Functions ===

* Below is a list of all available functions to be used with Ogre ic

{| class="wikitable"
|-
!Command
!colspan="3"|Parameters||Example||Notes||Description
|-

|rowspan="3"|<center>'''ClearTrashUntilNamedSpawns'''</center>
|-
|Param 1
|colspan="2"|NPC||"Trakanon"|| Name of NPC.
|rowspan="3"| Kill trash untill specified NPC spawns within specified distance.
|-
|Param 2
|colspan="2"|Radius||30|| Radius to check trash. Default = 30
|-

|rowspan="2"|<center>'''HandleAcceptReward'''</center>
|-
|Param 1
|colspan="2"|Max Times||10|| How many times to accept rewards #. Default = 10
|rowspan="2"| Accept rewards specified # of times. .5 second wait between each.
|-

|rowspan="3"|<center>'''KillActorType'''</center>
|-
|Param 1
|colspan="2"|Radius||30|| Radius to check trash. Default = 30
|rowspan="3"| Kill trash via Type that are within specified radius.
|-
|Param 2
|colspan="2"|Type||"NPC"|| Actor Type you are looking for. Default = "NPC"
|-

|rowspan="4"|<center>'''NamedSpawnWait'''</center>
|-
|Param 1
|colspan="2"|NamedNPC||"Trakanon"|| Name of Actor.
|rowspan="4"| Waits specified time or untill specified name and specified Type exist as true. fail message if Named does not spawn.
|-
|Param 2
|colspan="2"|Time to wait||60 = 60 seconds|| Time to wait.
|-
|Param 3
|colspan="2"|Type|| "NamedNPC" || Type of actor your waiting for.
|-

|rowspan="2"|<center>'''RunInstanceController'''</center>
|-
|Param 1
|colspan="2"|Start point||0|| Starting point #. Default = 0
|rowspan="2"| This is automatically called by the startup routine. This starts the main function of the instance. It acts as a final place for it to end. If it succeeds/fails it gives a message.
|-

|rowspan="2"|<center>'''Reply_Option'''</center>
|-
|Param 1
|colspan="2"|Text||"I want to carry on!!!"|| Text you want to click within the reply dialog. Must be Quoted and Exact.
|rowspan="2"| Clicks a reply dialog via Text specified. self only.
|-

|rowspan="2"|<center>'''Set_PriestAscension'''</center>
|-
|Param 1
|colspan="2"|T or F|| TRUE/FALSE || N/A.
|rowspan="2"| Turn priest ascensions on/off. Also turns Combo's off.
|-

|rowspan="2"|<center>'''Set_VariousOptions'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Sets various options for solo or group content.
SOLO & DUO & Group
------------------------
Auto Target Clear
* Resume = TRUE
* Auto Target when hated = TRUE
* Move Melee = FALSE
* Move Behind = FALSE
* Move to Area = TRUE
* Ability Rotation = FALSE
* Quest Compare = FALSE
* Auto Target Enable = TRUE
* Loot = TRUE
* Auto target scan radius = 20
* Auto target scan Height = 15
* Loot Leader only enable = TRUE
* Loot Leader only smart assign = TRUE
* Loot Leader only loot everything = TRUE
* Sets Follow
* Sets assist
------------------------
SOLO Specifics
------------------------
* Disable merc support = TRUE
* Free for all Loot accept = TRUE
* Free for all Loot everything = TRUE
* Disable cast stack Items = TRUE
* Mark Toon = TRUE
------------------------
DUO Specifics
------------------------
* Mark Toon = TRUE
* Disable cast stack Items = TRUE
* Cancel and then Cast "Fount of Power"
------------------------
GROUP Specifics
------------------------
* UnMark Toon = TRUE
* Change cast stack Glacial Freeze = TRUE
* Change cast stack Absorb Magic = TRUE
|-

|rowspan="2"|<center>'''Set_Follow'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Sets follow and assist. for group and self if not grouped.
|-

|rowspan="3"|<center>'''Specialwait'''</center>
|-
|Param 1
|colspan="2"|Wait Time||30 = 3 seconds|| Time to wait before click. Default = 30
|rowspan="3"| Pauses bot and waits before Click Hits Special and waits after Click then resumes for Group or self if not grouped.
|-
|Param 2
|colspan="2"|Wait Time||30 = 3 seconds|| Time to wait after click. Default = 30
|-

|rowspan="3"|<center>'''ZoneSpecialwait'''</center>
|-
|Param 1
|colspan="2"|Wait Time||30 = 3 seconds|| Time to wait before click. Default = 30
|rowspan="3"| Pauses bot and waits before Click Hits ZoneSpecialSpecific and waits after Click then resumes for Group or self if not grouped.
|-
|Param 2
|colspan="2"|Wait Time||30 = 3 seconds|| Time to wait after click. Default = 30
|-

|rowspan="2"|<center>'''Get_Shinies_Options'''</center>
|-
|Param 1
|colspan="2"|Shiny Name||"?"|| Default: "?"
|rowspan="2"| Will use campspot to move around and loot shinies. If Skip shinies is checked, it will skip shinies. If Pause For Shiny is checked, will pause.
|-

|rowspan="2"|<center>'''Get_Shinies'''</center>
|-
|Param 1
|colspan="2"|Shiny Name||"?"|| Default: "?"
|rowspan="2"| Will use campspot to move around and loot shinies. If Skip shinies is checked, it will skip shinies. Ignores pause for shiny.
|-

|rowspan="4"|<center>'''Get_Shinies_Nav_Options'''</center>
|-
|Param 1
|colspan="2"|Loc||"-211.139343,84.733673,402.047363"|| N/A
|rowspan="4"| Will use Nav to move around and loot shinies within given range.
Will Nav to Loc supplied before and after looting shinies.
If Skip shinies is checked, it will skip shinies.
If Pause For Shiny is checked, will pause.
|-
|Param 2
|colspan="2"|Shiny Name||"?"|| Default: "?"
|-
|Param 3
|colspan="2"|Range||30|| Default: 30
|-

|rowspan="4"|<center>'''Get_Shinies_Nav'''</center>
|-
|Param 1
|colspan="2"|Loc||"-211.139343,84.733673,402.047363"|| N/A
|rowspan="4"| Will use Nav to move around and loot shinies within given range.
Will Nav to Loc supplied before and after looting shinies.
|-
|Param 2
|colspan="2"|Shiny Name||"?"|| Default: "?"
|-
|Param 3
|colspan="2"|Range||30|| Default: 30
|-

|rowspan="2"|<center>'''Get_Chest'''</center>
|-
|Param 1
|colspan="2"|Range||50|| Default: 50
|rowspan="2"| Will use campspot to move around and loot chests. Will not clear Campspot so if pathing use a LetsGo after.
|-

|rowspan="2"|<center>'''CD.GetIntoZone'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="1"| Specific to Chaos Descending: If you are near the mission givers in Myrist, will attempt to navigate over to the portal and zone you in, then wait for everyone to finish zoning. Returns TRUE if you make it into the zone, or FALSE if you do not for any reason.
|-

|rowspan="2"|<center>'''CD.ZoneOut'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="1"| Specific to Chaos Descending: If you are near the exit in a CD instance, will attempt to navigate over to the zone out portal and zone you out, then wait for everyone to finish zoning. Returns TRUE if it attempted to zone you out, or FALSE if the exit wasn't available.
|}

== Notes ==

* If you feel something needs adding or changing please let us know via discord.

OgreInstanceHelperAPI

2019-07-25T20:29:02Z

Pork: /* List of Functions */

== Important Note ==

*This is currently not released.
*It will be ready when its ready.

== Summary ==

* List of '''Methods''', '''Members''', '''Functions''' that are to be used with '''Ogre ic''' files.

* pre configured '''Methods''', '''Members''', '''Functions''' to make coding zones easier for people.

* If their is a command you do not understand please feel free to ask in ogre discord and someone will explain and try to word it better here in the list

* This list will grow as ogre ic grows
** If you feel something needs adding/updating feel free to ask kannkor or pork on discord.

== Methods ==

=== Usage ===

* Example 1 - Obj_OgreIH:SetCampSpot
** Would Campspot your group.
* Example 2 - Obj_OgreIH:ChangeOgreBotUIOption["checkbox_settings_movebehind",TRUE]
** Would turn on move behind in ogrebot.
*** UI Code can be grabbed from ( InnerSpace\Scripts\EQ2OgreBot\OgreUIXML.xml )

=== List of Methods ===

*Below is a list of all available methods to be used with Ogre ic

{| class="wikitable"
|-
!Command
!colspan="3"|Parameters||Example||Notes||Description
|-

|rowspan="2"|<center>'''Set_Disable_AEsEncounters'''</center>
|-
|Param 1
|colspan="2"|Disabled||TRUE/FALSE|| N/A
|rowspan="2"| Disable AOEs and Encounters for group or self if not grouped.
|-

|rowspan="2"|<center>'''ClearRelativeCampSpot'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Clears relative campspots for group or self if not grouped.
|-

|rowspan="2"|<center>'''ClearCampSpot'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Clears campspots for group or self if not grouped.
|-

|rowspan="2"|<center>'''SetCampSpot'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Sets campspot for group or self if not grouped.
|-

|rowspan="2"|<center>'''ChangeCampSpot'''</center>
|-
|Param 1
|colspan="2"|Loc||"127.084137,-180.863373,-832.558899"|| Loc to change campspot to.
|rowspan="2"| Change campspot for group or self if not grouped.
|-

|rowspan="2"|<center>'''CCS_Actor'''</center>
|-
|Param 1
|colspan="2"|Actor ID||1234|| Actor ID to change campspot too.
|rowspan="2"| Change campspot for group or self if not grouped to the Actor's position.
|-

|rowspan="2"|<center>'''CCS_Actor_Position'''</center>
|-
|Param 1
|colspan="2"|Actor ID||1234|| Actor ID to change campspot too.
|rowspan="2"| Change campspot for group or self if not grouped to the Actor's position, with using infront (fighters) and behind (non-fighters)
|-

|rowspan="2"|<center>'''SetUpFor'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Does a SetUpFor command for group or self if not grouped. ( Requires being Campspotted )
|-

|rowspan="2"|<center>'''Set_NoMove'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Sets NoMove for group or self if not grouped.
|-

|rowspan="2"|<center>'''Actor_Click'''</center>
|-
|Param 1
|colspan="2"|Actor||"Name" or ID|| Name or ID of actor to Click.
|rowspan="2"| Clicks an Actor for group or self if not grouped.
|-

|rowspan="2"|<center>'''Use_Item'''</center>
|-
|Param 1
|colspan="2"|Item||"Name"|| Name of item to Use.
|rowspan="2"| Uses an item from inventory for group or self if not grouped.
|-

|rowspan="2"|<center>'''LetsGo'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Hits LetsGo for group or self if not grouped.
|-

|rowspan="2"|<center>'''Jump'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| makes bots Jump. for group or self if not grouped.
|-

|rowspan="2"|<center>'''Jump_Me'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| makes only you Jump. for self Only.
|-

|rowspan="2"|<center>'''CallGH'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Calls to Guild Hall. For group or self if not grouped.
|-

|rowspan="2"|<center>'''CallHome'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Calls to Home. For group or self if not grouped.
|-

|rowspan="2"|<center>'''Tradeskill_Close'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Closes tradeskill window. For self Only.
|-

|rowspan="3"|<center>'''ChangeOgreBotUIOption'''</center>
|-
|Param 1
|colspan="2"|UI Code||"Checkbox_blah"|| UI Code/element to change from Ogrebotui.xml.
|rowspan="3"| Set a UI element in ogrebot to on/off. for group or self if not grouped.
|-
|Param 2
|colspan="2"|T or F|| TRUE/FALSE || Set UI element to on/off.
|-

|rowspan="4"|<center>'''Set_ZoneInformation'''</center>
|-
|Param 1
|colspan="2"|Zone Name||"Myrist, the Great Library"|| Zone name to set. via ${Zone.Name}.
|rowspan="4"| Sets all zone information for files usaully called from main function of script.
|-
|Param 2
|colspan="2"|Zone ShortName||"exp15_rgn_plane_of_knowledge"|| Zone Short name to set. via ${Zone.ShortName}.
|-
|Param 3
|colspan="2"|Actor|| "zone_to_poa" || Actor name to click to zone.
|-

|rowspan="2"|<center>'''Set_Debug_Mode'''</center>
|-
|Param 1
|colspan="2"|T or F|| TRUE/FALSE || N/A.
|rowspan="2"| Turn debug mode on or off. ( Very Spammy )
|-

|rowspan="2"|<center>'''Message_FailedZone'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Sends a failed message to Ogre Console with zone information.
|-

|rowspan="2"|<center>'''Message_FailedNamed'''</center>
|-
|Param 1
|colspan="2"|Named||"Trakanon"|| Name of Named.
|rowspan="2"| Sends a failed message to Ogre Console with specified named information.
|-

|rowspan="2"|<center>'''Message_FailedZoneOut'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Sends a failed message to Ogre Console with zone out information.
|-

|rowspan="2"|<center>'''Message_NamedDoesNotExistSkipping'''</center>
|-
|Param 1
|colspan="2"|Named||"Trakanon"|| Name of Named.
|rowspan="2"| Sends a Skipping message to Ogre Console with specified named information.
|-

|rowspan="2"|<center>'''Message_FailedToKill'''</center>
|-
|Param 1
|colspan="2"|Named||"Trakanon"|| Name of Named.
|rowspan="2"| Sends a failed to kill message to Ogre Console named information.
|-

|rowspan="2"|<center>'''MonkeyInMiddle'''</center>
|-
|Param 1
|colspan="2"|Range||10|| Range to spread to. Default = 10
|rowspan="2"| Set monkey in the middle by specified range. for group or self if not grouped.
|-
|}

== Members ==

=== Usage ===

{| class="wikitable"
|-
|Example 1
if ${Obj_OgreIH.Tradeskill_vis}
{
;// Will only trigger this if the tradeskill window is visible in game
;// Code to execute if it comes back as TRUE
}
Example 2
if ${Actor[id, ${Obj_OgreIH.Get_NPC_ID["Trakanon"]}](exists)}
{
;// Will only trigger this if the NPC exists
;// Code to execute if it comes back as TRUE
}
|-
|}

=== List of Members ===

*Below is a list of all available members to be used with Ogre ic

{| class="wikitable"
|-
!Command
!colspan="3"|Parameters||Example||Notes||Description
|-

|rowspan="2"|<center>'''DuoMode'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Checks if only 2 members are in group with you. For duo zones to make sure their is not more or less than 2 members in group.
|-

|rowspan="2"|<center>'''Get_NPC_ID'''</center>
|-
|Param 1
|colspan="2"|NPC||"Trakanon"|| Name of NPC.
|rowspan="2"| Gets the ID for the specified NPC.
|-

|rowspan="4"|<center>'''Get_IDFromActorQuery'''</center>
|-
|Param 1
|colspan="2"|Actor Name||"Trakanon"|| Name of Actor.
|rowspan="4"| Checks if Actor Name specified Loc exists at Loc supplied within distance supplied.
|-
|Param 2
|colspan="2"|Loc||"737.106506,411.865784,-388.380249"|| Loc to compare to.
|-
|Param 3
|colspan="2"|Distance|| 2 || Disatnce to check. Default = 2
|-

|rowspan="2"|<center>'''SoloMode'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Checks if only 1 members are in group or 1 member 1 merc. For Solo zones to make sure their is not more or less than 1 member 1 merc in group.
|-

|rowspan="2"|<center>'''Tradeskill_vis'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Checks to see if Tradeskill window is open in game.
|-
|}

== Functions ==

=== Usage ===

* Example 1 - call Obj_OgreIH.HandleAcceptReward 10
** Would accept reward windows 10 times for your group.
* Example 2 - call Obj_OgreIH.NamedSpawnWait "Trakanon" 60 "NamedNPC"
** Would wait 60 seconds or until the specified Named spawns.

=== List of Functions ===

* Below is a list of all available functions to be used with Ogre ic

{| class="wikitable"
|-
!Command
!colspan="3"|Parameters||Example||Notes||Description
|-

|rowspan="3"|<center>'''ClearTrashUntilNamedSpawns'''</center>
|-
|Param 1
|colspan="2"|NPC||"Trakanon"|| Name of NPC.
|rowspan="3"| Kill trash untill specified NPC spawns within specified distance.
|-
|Param 2
|colspan="2"|Radius||30|| Radius to check trash. Default = 30
|-

|rowspan="2"|<center>'''HandleAcceptReward'''</center>
|-
|Param 1
|colspan="2"|Max Times||10|| How many times to accept rewards #. Default = 10
|rowspan="2"| Accept rewards specified # of times. .5 second wait between each.
|-

|rowspan="4"|<center>'''NamedSpawnWait'''</center>
|-
|Param 1
|colspan="2"|NamedNPC||"Trakanon"|| Name of Actor.
|rowspan="4"| Waits specified time or untill specified name and specified Type exist as true. fail message if Named does not spawn.
|-
|Param 2
|colspan="2"|Time to wait||60 = 60 seconds|| Time to wait.
|-
|Param 3
|colspan="2"|Type|| "NamedNPC" || Type of actor your waiting for.
|-

|rowspan="2"|<center>'''RunInstanceController'''</center>
|-
|Param 1
|colspan="2"|Start point||0|| Starting point #. Default = 0
|rowspan="2"| This is automatically called by the startup routine. This starts the main function of the instance. It acts as a final place for it to end. If it succeeds/fails it gives a message.
|-

|rowspan="2"|<center>'''Reply_Option'''</center>
|-
|Param 1
|colspan="2"|Text||"I want to carry on!!!"|| Text you want to click within the reply dialog. Must be Quoted and Exact.
|rowspan="2"| Clicks a reply dialog via Text specified. self only.
|-

|rowspan="2"|<center>'''Set_PriestAscension'''</center>
|-
|Param 1
|colspan="2"|T or F|| TRUE/FALSE || N/A.
|rowspan="2"| Turn priest ascensions on/off. Also turns Combo's off.
|-

|rowspan="2"|<center>'''Set_VariousOptions'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Sets various options for solo or group content.
SOLO & DUO & Group
------------------------
Auto Target Clear
* Resume = TRUE
* Auto Target when hated = TRUE
* Move Melee = FALSE
* Move Behind = FALSE
* Move to Area = TRUE
* Ability Rotation = FALSE
* Quest Compare = FALSE
* Auto Target Enable = TRUE
* Loot = TRUE
* Auto target scan radius = 20
* Auto target scan Height = 15
* Loot Leader only enable = TRUE
* Loot Leader only smart assign = TRUE
* Loot Leader only loot everything = TRUE
* Sets Follow
* Sets assist
------------------------
SOLO Specifics
------------------------
* Disable merc support = TRUE
* Free for all Loot accept = TRUE
* Free for all Loot everything = TRUE
* Disable cast stack Items = TRUE
* Mark Toon = TRUE
------------------------
DUO Specifics
------------------------
* Mark Toon = TRUE
* Disable cast stack Items = TRUE
* Cancel and then Cast "Fount of Power"
------------------------
GROUP Specifics
------------------------
* UnMark Toon = TRUE
* Change cast stack Glacial Freeze = TRUE
* Change cast stack Absorb Magic = TRUE
|-

|rowspan="2"|<center>'''Set_Follow'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Sets follow and assist. for group and self if not grouped.
|-

|rowspan="3"|<center>'''Specialwait'''</center>
|-
|Param 1
|colspan="2"|Wait Time||30 = 3 seconds|| Time to wait before click. Default = 30
|rowspan="3"| Pauses bot and waits before Click Hits Special and waits after Click then resumes for Group or self if not grouped.
|-
|Param 2
|colspan="2"|Wait Time||30 = 3 seconds|| Time to wait after click. Default = 30
|-

|rowspan="3"|<center>'''ZoneSpecialwait'''</center>
|-
|Param 1
|colspan="2"|Wait Time||30 = 3 seconds|| Time to wait before click. Default = 30
|rowspan="3"| Pauses bot and waits before Click Hits ZoneSpecialSpecific and waits after Click then resumes for Group or self if not grouped.
|-
|Param 2
|colspan="2"|Wait Time||30 = 3 seconds|| Time to wait after click. Default = 30
|-

|rowspan="2"|<center>'''Get_Shinies_Options'''</center>
|-
|Param 1
|colspan="2"|Shiny Name||"?"|| Default: "?"
|rowspan="2"| Will use campspot to move around and loot shinies. If Skip shinies is checked, it will skip shinies. If Pause For Shiny is checked, will pause.
|-

|rowspan="2"|<center>'''Get_Shinies'''</center>
|-
|Param 1
|colspan="2"|Shiny Name||"?"|| Default: "?"
|rowspan="2"| Will use campspot to move around and loot shinies. If Skip shinies is checked, it will skip shinies. Ignores pause for shiny.
|-

|rowspan="2"|<center>'''Get_Chests'''</center>
|-
|Param 1
|colspan="2"|Range||50|| Default: 50
|rowspan="2"| Will use campspot to move around and loot chests.
|-

|rowspan="2"|<center>'''CD.GetIntoZone'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="1"| Specific to Chaos Descending: If you are near the mission givers in Myrist, will attempt to navigate over to the portal and zone you in, then wait for everyone to finish zoning. Returns TRUE if you make it into the zone, or FALSE if you do not for any reason.
|-

|rowspan="2"|<center>'''CD.ZoneOut'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="1"| Specific to Chaos Descending: If you are near the exit in a CD instance, will attempt to navigate over to the zone out portal and zone you out, then wait for everyone to finish zoning. Returns TRUE if it attempted to zone you out, or FALSE if the exit wasn't available.
|}

== Notes ==

* If you feel something needs adding or changing please let us know via discord.

OgreInstanceHelperAPI

2019-07-25T20:27:00Z

Pork: /* List of Functions */

== Important Note ==

*This is currently not released.
*It will be ready when its ready.

== Summary ==

* List of '''Methods''', '''Members''', '''Functions''' that are to be used with '''Ogre ic''' files.

* pre configured '''Methods''', '''Members''', '''Functions''' to make coding zones easier for people.

* If their is a command you do not understand please feel free to ask in ogre discord and someone will explain and try to word it better here in the list

* This list will grow as ogre ic grows
** If you feel something needs adding/updating feel free to ask kannkor or pork on discord.

== Methods ==

=== Usage ===

* Example 1 - Obj_OgreIH:SetCampSpot
** Would Campspot your group.
* Example 2 - Obj_OgreIH:ChangeOgreBotUIOption["checkbox_settings_movebehind",TRUE]
** Would turn on move behind in ogrebot.
*** UI Code can be grabbed from ( InnerSpace\Scripts\EQ2OgreBot\OgreUIXML.xml )

=== List of Methods ===

*Below is a list of all available methods to be used with Ogre ic

{| class="wikitable"
|-
!Command
!colspan="3"|Parameters||Example||Notes||Description
|-

|rowspan="2"|<center>'''Set_Disable_AEsEncounters'''</center>
|-
|Param 1
|colspan="2"|Disabled||TRUE/FALSE|| N/A
|rowspan="2"| Disable AOEs and Encounters for group or self if not grouped.
|-

|rowspan="2"|<center>'''ClearRelativeCampSpot'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Clears relative campspots for group or self if not grouped.
|-

|rowspan="2"|<center>'''ClearCampSpot'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Clears campspots for group or self if not grouped.
|-

|rowspan="2"|<center>'''SetCampSpot'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Sets campspot for group or self if not grouped.
|-

|rowspan="2"|<center>'''ChangeCampSpot'''</center>
|-
|Param 1
|colspan="2"|Loc||"127.084137,-180.863373,-832.558899"|| Loc to change campspot to.
|rowspan="2"| Change campspot for group or self if not grouped.
|-

|rowspan="2"|<center>'''CCS_Actor'''</center>
|-
|Param 1
|colspan="2"|Actor ID||1234|| Actor ID to change campspot too.
|rowspan="2"| Change campspot for group or self if not grouped to the Actor's position.
|-

|rowspan="2"|<center>'''CCS_Actor_Position'''</center>
|-
|Param 1
|colspan="2"|Actor ID||1234|| Actor ID to change campspot too.
|rowspan="2"| Change campspot for group or self if not grouped to the Actor's position, with using infront (fighters) and behind (non-fighters)
|-

|rowspan="2"|<center>'''SetUpFor'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Does a SetUpFor command for group or self if not grouped. ( Requires being Campspotted )
|-

|rowspan="2"|<center>'''Set_NoMove'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Sets NoMove for group or self if not grouped.
|-

|rowspan="2"|<center>'''Actor_Click'''</center>
|-
|Param 1
|colspan="2"|Actor||"Name" or ID|| Name or ID of actor to Click.
|rowspan="2"| Clicks an Actor for group or self if not grouped.
|-

|rowspan="2"|<center>'''Use_Item'''</center>
|-
|Param 1
|colspan="2"|Item||"Name"|| Name of item to Use.
|rowspan="2"| Uses an item from inventory for group or self if not grouped.
|-

|rowspan="2"|<center>'''LetsGo'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Hits LetsGo for group or self if not grouped.
|-

|rowspan="2"|<center>'''Jump'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| makes bots Jump. for group or self if not grouped.
|-

|rowspan="2"|<center>'''Jump_Me'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| makes only you Jump. for self Only.
|-

|rowspan="2"|<center>'''CallGH'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Calls to Guild Hall. For group or self if not grouped.
|-

|rowspan="2"|<center>'''CallHome'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Calls to Home. For group or self if not grouped.
|-

|rowspan="2"|<center>'''Tradeskill_Close'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Closes tradeskill window. For self Only.
|-

|rowspan="3"|<center>'''ChangeOgreBotUIOption'''</center>
|-
|Param 1
|colspan="2"|UI Code||"Checkbox_blah"|| UI Code/element to change from Ogrebotui.xml.
|rowspan="3"| Set a UI element in ogrebot to on/off. for group or self if not grouped.
|-
|Param 2
|colspan="2"|T or F|| TRUE/FALSE || Set UI element to on/off.
|-

|rowspan="4"|<center>'''Set_ZoneInformation'''</center>
|-
|Param 1
|colspan="2"|Zone Name||"Myrist, the Great Library"|| Zone name to set. via ${Zone.Name}.
|rowspan="4"| Sets all zone information for files usaully called from main function of script.
|-
|Param 2
|colspan="2"|Zone ShortName||"exp15_rgn_plane_of_knowledge"|| Zone Short name to set. via ${Zone.ShortName}.
|-
|Param 3
|colspan="2"|Actor|| "zone_to_poa" || Actor name to click to zone.
|-

|rowspan="2"|<center>'''Set_Debug_Mode'''</center>
|-
|Param 1
|colspan="2"|T or F|| TRUE/FALSE || N/A.
|rowspan="2"| Turn debug mode on or off. ( Very Spammy )
|-

|rowspan="2"|<center>'''Message_FailedZone'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Sends a failed message to Ogre Console with zone information.
|-

|rowspan="2"|<center>'''Message_FailedNamed'''</center>
|-
|Param 1
|colspan="2"|Named||"Trakanon"|| Name of Named.
|rowspan="2"| Sends a failed message to Ogre Console with specified named information.
|-

|rowspan="2"|<center>'''Message_FailedZoneOut'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Sends a failed message to Ogre Console with zone out information.
|-

|rowspan="2"|<center>'''Message_NamedDoesNotExistSkipping'''</center>
|-
|Param 1
|colspan="2"|Named||"Trakanon"|| Name of Named.
|rowspan="2"| Sends a Skipping message to Ogre Console with specified named information.
|-

|rowspan="2"|<center>'''Message_FailedToKill'''</center>
|-
|Param 1
|colspan="2"|Named||"Trakanon"|| Name of Named.
|rowspan="2"| Sends a failed to kill message to Ogre Console named information.
|-

|rowspan="2"|<center>'''MonkeyInMiddle'''</center>
|-
|Param 1
|colspan="2"|Range||10|| Range to spread to. Default = 10
|rowspan="2"| Set monkey in the middle by specified range. for group or self if not grouped.
|-
|}

== Members ==

=== Usage ===

{| class="wikitable"
|-
|Example 1
if ${Obj_OgreIH.Tradeskill_vis}
{
;// Will only trigger this if the tradeskill window is visible in game
;// Code to execute if it comes back as TRUE
}
Example 2
if ${Actor[id, ${Obj_OgreIH.Get_NPC_ID["Trakanon"]}](exists)}
{
;// Will only trigger this if the NPC exists
;// Code to execute if it comes back as TRUE
}
|-
|}

=== List of Members ===

*Below is a list of all available members to be used with Ogre ic

{| class="wikitable"
|-
!Command
!colspan="3"|Parameters||Example||Notes||Description
|-

|rowspan="2"|<center>'''DuoMode'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Checks if only 2 members are in group with you. For duo zones to make sure their is not more or less than 2 members in group.
|-

|rowspan="2"|<center>'''Get_NPC_ID'''</center>
|-
|Param 1
|colspan="2"|NPC||"Trakanon"|| Name of NPC.
|rowspan="2"| Gets the ID for the specified NPC.
|-

|rowspan="4"|<center>'''Get_IDFromActorQuery'''</center>
|-
|Param 1
|colspan="2"|Actor Name||"Trakanon"|| Name of Actor.
|rowspan="4"| Checks if Actor Name specified Loc exists at Loc supplied within distance supplied.
|-
|Param 2
|colspan="2"|Loc||"737.106506,411.865784,-388.380249"|| Loc to compare to.
|-
|Param 3
|colspan="2"|Distance|| 2 || Disatnce to check. Default = 2
|-

|rowspan="2"|<center>'''SoloMode'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Checks if only 1 members are in group or 1 member 1 merc. For Solo zones to make sure their is not more or less than 1 member 1 merc in group.
|-

|rowspan="2"|<center>'''Tradeskill_vis'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Checks to see if Tradeskill window is open in game.
|-
|}

== Functions ==

=== Usage ===

* Example 1 - call Obj_OgreIH.HandleAcceptReward 10
** Would accept reward windows 10 times for your group.
* Example 2 - call Obj_OgreIH.NamedSpawnWait "Trakanon" 60 "NamedNPC"
** Would wait 60 seconds or until the specified Named spawns.

=== List of Functions ===

* Below is a list of all available functions to be used with Ogre ic

{| class="wikitable"
|-
!Command
!colspan="3"|Parameters||Example||Notes||Description
|-

|rowspan="3"|<center>'''ClearTrashUntilNamedSpawns'''</center>
|-
|Param 1
|colspan="2"|NPC||"Trakanon"|| Name of NPC.
|rowspan="3"| Kill trash untill specified NPC spawns within specified distance.
|-
|Param 2
|colspan="2"|Radius||30|| Radius to check trash. Default = 30
|-

|rowspan="2"|<center>'''HandleAcceptReward'''</center>
|-
|Param 1
|colspan="2"|Max Times||10|| How many times to accept rewards #. Default = 10
|rowspan="2"| Accept rewards specified # of times. .5 second wait between each.
|-

|rowspan="4"|<center>'''NamedSpawnWait'''</center>
|-
|Param 1
|colspan="2"|NamedNPC||"Trakanon"|| Name of Actor.
|rowspan="4"| Waits specified time or untill specified name and specified Type exist as true. fail message if Named does not spawn.
|-
|Param 2
|colspan="2"|Time to wait||60 = 60 seconds|| Time to wait.
|-
|Param 3
|colspan="2"|Type|| "NamedNPC" || Type of actor your waiting for.
|-

|rowspan="2"|<center>'''RunInstanceController'''</center>
|-
|Param 1
|colspan="2"|Start point||0|| Starting point #. Default = 0
|rowspan="2"| This is automatically called by the startup routine. This starts the main function of the instance. It acts as a final place for it to end. If it succeeds/fails it gives a message.
|-

|rowspan="2"|<center>'''Reply_Option'''</center>
|-
|Param 1
|colspan="2"|Text||"I want to carry on!!!"|| Text you want to click within the reply dialog. Must be Quoted and Exact.
|rowspan="2"| Clicks a reply dialog via Text specified. self only.
|-

|rowspan="2"|<center>'''Set_PriestAscension'''</center>
|-
|Param 1
|colspan="2"|T or F|| TRUE/FALSE || N/A.
|rowspan="2"| Turn priest ascensions on/off. Also turns Combo's off.
|-

|rowspan="2"|<center>'''Set_VariousOptions'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Sets various options for solo or group content.
SOLO & DUO & Group
------------------------
Auto Target Clear
* Resume = TRUE
* Auto Target when hated = TRUE
* Move Melee = FALSE
* Move Behind = FALSE
* Move to Area = TRUE
* Ability Rotation = FALSE
* Quest Compare = FALSE
* Auto Target Enable = TRUE
* Loot = TRUE
* Auto target scan radius = 20
* Auto target scan Height = 15
* Loot Leader only enable = TRUE
* Loot Leader only smart assign = TRUE
* Loot Leader only loot everything = TRUE
* Sets Follow
* Sets assist
------------------------
SOLO Specifics
------------------------
* Disable merc support = TRUE
* Free for all Loot accept = TRUE
* Free for all Loot everything = TRUE
* Disable cast stack Items = TRUE
* Mark Toon = TRUE
------------------------
DUO Specifics
------------------------
* Mark Toon = TRUE
* Disable cast stack Items = TRUE
* Cancel and then Cast "Fount of Power"
------------------------
GROUP Specifics
------------------------
* UnMark Toon = TRUE
* Change cast stack Glacial Freeze = TRUE
* Change cast stack Absorb Magic = TRUE
|-

|rowspan="2"|<center>'''Set_Follow'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Sets follow and assist. for group and self if not grouped.
|-

|rowspan="3"|<center>'''Specialwait'''</center>
|-
|Param 1
|colspan="2"|Wait Time||30 = 3 seconds|| Time to wait before click. Default = 30
|rowspan="3"| Hits Special and waits before Click and after Click for specified times for Group or self if not grouped.
|-
|Param 2
|colspan="2"|Wait Time||30 = 3 seconds|| Time to wait after click. Default = 30
|-

|rowspan="3"|<center>'''ZoneSpecialwait'''</center>
|-
|Param 1
|colspan="2"|Wait Time||30 = 3 seconds|| Time to wait before click. Default = 30
|rowspan="3"| Hits Special Zone Specific and waits before Click and after Click for specified times for Group or self if not grouped.
|-
|Param 2
|colspan="2"|Wait Time||30 = 3 seconds|| Time to wait after click. Default = 30
|-

|rowspan="2"|<center>'''Get_Shinies_Options'''</center>
|-
|Param 1
|colspan="2"|Shiny Name||"?"|| Default: "?"
|rowspan="2"| Will use campspot to move around and loot shinies. If Skip shinies is checked, it will skip shinies. If Pause For Shiny is checked, will pause.
|-

|rowspan="2"|<center>'''Get_Shinies'''</center>
|-
|Param 1
|colspan="2"|Shiny Name||"?"|| Default: "?"
|rowspan="2"| Will use campspot to move around and loot shinies. If Skip shinies is checked, it will skip shinies. Ignores pause for shiny.
|-

|rowspan="2"|<center>'''Get_Chests'''</center>
|-
|Param 1
|colspan="2"|Range||50|| Default: 50
|rowspan="2"| Will use campspot to move around and loot chests.
|-

|rowspan="2"|<center>'''CD.GetIntoZone'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="1"| Specific to Chaos Descending: If you are near the mission givers in Myrist, will attempt to navigate over to the portal and zone you in, then wait for everyone to finish zoning. Returns TRUE if you make it into the zone, or FALSE if you do not for any reason.
|-

|rowspan="2"|<center>'''CD.ZoneOut'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="1"| Specific to Chaos Descending: If you are near the exit in a CD instance, will attempt to navigate over to the zone out portal and zone you out, then wait for everyone to finish zoning. Returns TRUE if it attempted to zone you out, or FALSE if the exit wasn't available.
|}

== Notes ==

* If you feel something needs adding or changing please let us know via discord.

OgreUtilitiesAPI

2019-07-24T21:44:12Z

Pork: /* Usage */

== Implementing OgreUtilities ==

* To use '''OgreUtilities''' you will need to load the code into your script.
** The following will load '''OgreUtilities''' into your script.

function Load_OgreUtilities()
{
ogre utilities
wait 5
Obj_CreateOgreUtilities:CreateOgreUtilities[${Script.Filename}]
;// Returns variable: OgreUtilities
Obj_CreateOgreUtilities:CreateOgreCharacterData[${Script.Filename}]
;// Returns variable: OgreCharacterData

;// Usage here. See wiki <Link here would likely be helpful, and some examples>
}

* This will allow you to use all of the below '''Methods''', '''Members''', '''Functions''' below.

== Summary ==

* List of '''Methods''', '''Members''', '''Functions'''

* pre configured '''Methods''', '''Members''', '''Functions''' to make coding scripts easier for people.

* If their is a command you do not understand please feel free to ask in ogre discord and someone will explain and try to word it better here in the list

== Advanced Navigation Options ==

=== Usage ===

* Obj_OgreUtilities.OgreNavChecks:<MethodNameHere>[<ParametersHere>]
** Example - Obj_OgreUtilities.OgreNavChecks:Set_Check_MeInCombat[FALSE]

=== List of Methods ===

*Below is a list of all available methods.

{| class="wikitable"
|-
!Command
!colspan="3"|Parameters||Example||Notes||Description
|-

|rowspan="2"|<center>'''Set_CheckAll'''</center>
|-
|Param 1
|colspan="2"|Distance||50|| Default = 50
|rowspan="2"| Sets checking group in combat, and distance to 50, sets checking if you are in combat.
|-

|rowspan="2"|<center>'''Set_Check_MeInCombat'''</center>
|-
|Param 1
|colspan="2"|T or F||TRUE or FALSE|| Default = TRUE
|rowspan="2"| Sets checking if you are in combat.
|-

|rowspan="3"|<center>'''Set_Check_Group'''</center>
|-
|Param 1
|colspan="2"|T or F||TRUE or FALSE|| Default = TRUE
|rowspan="3"| Sets checking the group for combat and the distance.
|-
|Param 2
|colspan="2"|Distance||50|| Default = 50
|-

|rowspan="2"|<center>'''Set_Check_GroupCombatOnly'''</center>
|-
|Param 1
|colspan="2"|T or F||TRUE or FALSE|| Default = TRUE
|rowspan="2"| Sets checking if you are in combat. Will disable "Set_Check_GroupDistanceOnly" if it is enabled.
|-

|rowspan="3"|<center>'''Set_Check_GroupDistanceOnly'''</center>
|-
|Param 1
|colspan="2"|T or F||TRUE or FALSE|| Default = TRUE
|rowspan="3"| Sets checking the group for combat and the distance. Will disable "Set_Check_GroupCombatOnly" if it is enabled.
|-
|Param 2
|colspan="2"|Distance||50|| Default = 50
|-

|}

== Methods ==

=== Usage ===

* Example - Obj_OgreUtilities:AcceptQuest
** Would Accept a quest if a quest window exists.

=== List of Methods ===

*Below is a list of all available methods.

{| class="wikitable"
|-
!Command
!colspan="3"|Parameters||Example||Notes||Description
|-

|rowspan="2"|<center>'''AcceptQuest'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Accepts a quest if a quest window exists.
|-

|rowspan="2"|<center>'''EQ2_onQuestOffered'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| If enabled, accepts new quests.
|-

|rowspan="2"|<center>'''EQ2_onRewardWindowAppeared'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| If enabled, accepts Reward windows.
|-

|rowspan="2"|<center>'''Jump'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Jumps a toon.
|-

|rowspan="2"|<center>'''Set_EQ2_onQuestOffered'''</center>
|-
|Param 1
|colspan="2"|T or F||TRUE/FALSE|| Enables (TRUE) or disables (FALSE) the EQ2_onQuestOffered event.
|rowspan="2"| Turns the event on or off
|-

|rowspan="2"|<center>'''Set_EQ2_onRewardWindowAppeared'''</center>
|-
|Param 1
|colspan="2"|T or F||TRUE/FALSE|| Enables (TRUE) or disables (FALSE) the EQ2_onRewardWindowAppeared event.
|rowspan="2"| Turns the event on or off
|-
|}

== Members ==

=== Usage ===

{| class="wikitable"
|-
|Example 1
if ${Obj_OgreUtilities.AnyGroupMembersDead}
{
;// Will return TRUE if any group members are dead False if all alive
;// Code to execute if it comes back as TRUE
}
Example 2
*echo ${Obj_OgreUtilities.ConvertSecondsToHMS[4500]}
**Would convert and return the specified seconds into hour.minute.seconds.
|-
|}

=== List of Members ===

*Below is a list of all available members.

{| class="wikitable"
|-
!Command
!colspan="3"|Parameters||Example||Notes||Description
|-

|rowspan="2"|<center>'''AnyGroupMembersDead'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Checks if any group members are dead.
|-

|rowspan="2"|<center>'''CleanName'''</center>
|-
|Param 1
|colspan="2"|Input to clean||Kannkor's battle Bot|| Cleans an input
|rowspan="2"| Some zones, I believe such as proving grounds, you can end up with some very odd names for characters, this removes it and "cleans" the input.
|-

|rowspan="2"|<center>'''ConvertSecondsToHMS'''</center>
|-
|Param 1
|colspan="2"|Seconds||2500|| Seconds to convert.
|rowspan="2"| Converts seconds to hour minutes seconds.
|-

|rowspan="2"|<center>'''Get_Hours'''</center>
|-
|Param 1
|colspan="2"|Seconds||2500|| Seconds to convert.
|rowspan="2"| Determines how many whole hours are in the seconds.
|-

|rowspan="2"|<center>'''Get_Minutes'''</center>
|-
|Param 1
|colspan="2"|Seconds||2500|| Seconds to convert.
|rowspan="2"| Determines how many whole minutes are in the seconds. Return can only be 0 to 59, as any value above that would be returned in Get_Hours.
|-

|rowspan="2"|<center>'''Get_Seconds'''</center>
|-
|Param 1
|colspan="2"|Seconds||2500|| Seconds to convert.
|rowspan="2"| Determines how many whole seconds are in the seconds. Return can only be 0 to 59, as any value above that would be returned in Get_Hours or Get_Minutes.
|-

|rowspan="2"|<center>'''GetAscensionClass'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| spews your current ascension class.
|-

|rowspan="2"|<center>'''HaveAbilityID'''</center>
|-
|Param 1
|colspan="2"|ID||483993047|| ID of ability to check.
|rowspan="2"| returns TRUE if you have the ability or FALSE if you do not.
|-

|rowspan="2"|<center>'''InZoneName'''</center>
|-
|Param 1
|colspan="2"|Zone Name||"Myrist, the Great Library"|| Zone name to check.
|rowspan="2"| Checks if you are in specified zone name.
|-

|rowspan="2"|<center>'''InZoneShortName'''</center>
|-
|Param 1
|colspan="2"|Zone Name||"exp15_rgn_plane_of_knowledge"|| Zone short name to check.
|rowspan="2"| Checks if you are in specified zone short name.
|-

|rowspan="2"|<center>'''ItemCount'''</center>
|-
|Param 1
|colspan="2"|Item Name||"mechanical gear"|| Item name to check.
|rowspan="2"| Counts how many of said item you have in your inventory. Does NOT count bank. This handles counting multiple stacks.
|-

|rowspan="3"|<center>'''NearLoc'''</center>
|-
|Param 1
|colspan="2"|Loc||"737.106506,411.865784,-388.380249"|| Loc to check.
|rowspan="3"| Checks if you are within specified distance to specified Loc.
|-
|Param 2
|colspan="2"|Distance|| 10 || how close. Default = 10
|-

|rowspan="2"|<center>'''NPCCount'''</center>
|-
|Param 1
|colspan="2"|Distance||30|| Distance to check.
|rowspan="2"| Counts how many NPCs are within specified distance.
|-

|rowspan="2"|<center>'''OnCorrectCharacter'''</center>
|-
|Param 1
|colspan="2"|Toon name||"Kannkor"|| Name of toon to check.
|rowspan="2"| Checks currently logged in toon name matches specified toon name.
|-

|rowspan="2"|<center>'''WhereAreWe'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Returns where you are. Valid returns are: GUILDHALL, or the zone hash ( ${Zone.ShortName} ). Basically used for checking if you're in a guild hall.
|-
|}

== Functions ==

=== Usage ===

*All functions are locking. That means when you call them, they 'hold' the script and return once completed.
**Almost every single function has a return, usually bool that you can access. If TRUE, it means it believes the function was successful, if FALSE, it believes the function was not successful.
***You can access this return, by checking ${Return} immediately after the function call.

Example 1
call Obj_OgreUtilities.CallToGH
if ${Return}
echo Means CallToGH was successful!

=== List of Functions ===

* Below is a list of all available functions

{| class="wikitable"
|-
!Command
!colspan="3"|Parameters||Example||Notes||Description
|-

|rowspan="2"|<center>'''CallToGH'''</center>
|-
|Param 1
|colspan="2"|T or F||TRUE/FALSE|| Default FALSE. FALSE means if Call to Guild Hall is not available, wait for it. TRUE means if the call is not available, then don't cast it.
|rowspan="2"| Calls to Guild Hall.
|-

|rowspan="3"|<center>'''CastAbilityID'''</center>
|-
|Param 1
|colspan="2"|ID||106506|| ID of the ability.
|rowspan="3"| Casts ability and waits specified time for ability to cast.
|-
|Param 2
|colspan="2"|Wait Time|| 50 = 5 seconds || Time to wait. Default = 50
|-

|rowspan="2"|<center>'''CastEvac'''</center>
|-
|Param 1
|colspan="2"|NotAvailableAtThisTime||NotAvailableAtThisTime|| NotAvailableAtThisTime
|rowspan="2"| Can't be used at this time. Requires a reference that isn't accessible yet.
|-

|rowspan="2"|<center>'''CheckEvacTotems'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Checks you have evac totems.
|-

|rowspan="2"|<center>'''CheckIfGroupInSameZone'''</center>
|-
|Param 1
|colspan="2"|How many seconds to check for||30|| How many seconds to check for
|rowspan="2"| returns TRUE as soon as your entire group is in the same zone. Returns FALSE if at the end of the seconds to check for, if everyone is not in the same zone
|-

|rowspan="2"|<center>'''ClearQuestWindow'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Clears the quest helper window. The in-game on-screen quest information with checkboxes that can only show like 5 quests. This just unchecks them. It does NOT delete quests.
|-

|rowspan="2"|<center>'''DoConversation'''</center>
|-
|Param 1
|colspan="2"|Numerical sequence of conversation baubles to choose||1 1 2 3 1|| When conversing with an NPC, this example would choose option 1, then 1, then 2, then 3, then 1.
|rowspan="2"| Accepts any number of conversations, and does so with a 1/2 second delay
|-

|rowspan="2"|<center>'''DoHail'''</center>
|-
|Param 1
|colspan="2"|NPC||"Flag dude"|| Name of NPC.
|rowspan="2"| Hails specified NPC via Name.
|-

|rowspan="2"|<center>'''DoHailID'''</center>
|-
|Param 1
|colspan="2"|ID||8959659794|| ID of NPC.
|rowspan="2"| Hails specified NPC via ID.
|-

|rowspan="3"|<center>'''DoTarget'''</center>
|-
|Param 1
|colspan="2"|NPC||"Flag dude"|| Name of NPC.
|rowspan="3"| Targets NPC if withing specified Range.
|-
|Param 2
|colspan="2"|Range|| 50 || within Range. Default = 40
|-

|rowspan="3"|<center>'''FastTravel'''</center>
|-
|Param 1
|colspan="2"|Name||"Freeport"|| Name of Zone/Destination.
|rowspan="3"| Travels to specified destination. ( Requires Membership )
|-
|Param 2
|colspan="2"|Exact match|| TRUE/FALSE || Default = FALSE
|-

|rowspan="2"|<center>'''GetIntoCorrectZone'''</center>
|-
|Param 1
|colspan="2"|NotAvailableAtThisTime||NotAvailableAtThisTime|| NotAvailableAtThisTime
|rowspan="2"| This was never finished, it would help navigating from zone to zone automatically, through connecting zones. However the manual input and maps required map the set up extremely difficult.
|-

|rowspan="2"|<center>'''GHToHouse'''</center>
|-
|Param 1
|colspan="2"|Name||"Kannkors house"|| Name of house to go to.
|rowspan="2"| Zones you to specified house from Guild Hall.
|-

|rowspan="3"|<center>'''HandleCampSpotToLoc'''</center>
|-
|Param 1
|colspan="2"|Loc||"737.106506,411.865784,-388.380249"|| Loc to campspot to.
|rowspan="3"| Sets your campspot to the location you passed it, and waits until you are within Range of it. Example, if you set it to 100, it would return TRUE if you are within 100 meters of the campspot.
|-
|Param 2
|colspan="2"|Range|| 125 || within Range. Default = 125
|-

|rowspan="2"|<center>'''HandleClickActor_Special'''</center>
|-
|Param 1
|colspan="2"|Distance|| 10 || within Disatnce. Default = 10
|rowspan="2"| Clicks special actor within disance specified.
|-

|rowspan="3"|<center>'''HandleClickActor'''</center>
|-
|Param 1
|colspan="2"|Name||"Mechanical gear"|| Name of actor.
|rowspan="3"| Clicks an actor within disance specified.
|-
|Param 2
|colspan="2"|Distance|| 10 || within Disatnce. Default = 10
|-

|rowspan="2"|<center>'''HandleConversation'''</center>
|-
|Param 1
|colspan="2"|NotAvailableAtThisTime||NotAvailableAtThisTime|| NotAvailableAtThisTime
|rowspan="2"| Requires an object not available at this time
|-

|rowspan="2"|<center>'''HandleConversationByText'''</center>
|-
|Param 1
|colspan="2"|Text inputs||"Where would you like to go?" "I want to get a rally flag" || Will handle chat baubles based on text input. Accepts up to 10 parameters.
|rowspan="2"| Conversation baubles
|-

|rowspan="2"|<center>'''HandleWaitForCampSpot'''</center>
|-
|Param 1
|colspan="2"|Range||5|| Waits until you are within this range before returning. Also returns if you are dead. Default = 5
|rowspan="2"| Waits until you are dead or within range of campspot. Returns TRUE if you are at your campspot (regardless of your range), returns FALSE if you are NOT at your campspot, even if you are within the range specified.
|-

|rowspan="5"|<center>'''HandleWaitForCombat'''</center>
|-
|Param 1
|colspan="2"|wait time||50 = 5 seconds|| Time to wait. Default = 50
|rowspan="5"| Waits specified time if in combat with specified options.
|-
|Param 2
|colspan="2"|Skip|| TRUE/FALSE || Skip if no mobs exist.
|-
|Param 3
|colspan="2"|Distance|| 30 || Skip if no mobs exist within specified distance.
|-
|Param 4
|colspan="2"|Clear target|| 40 || Clear target if distance of target over specified distance. Default = 40
|-

|rowspan="5"|<center>'''HandleWaitForCombatOrPower'''</center>
|-
|Param 1
|colspan="2"|wait time||50 = 5 seconds|| Time to wait. Default = 50
|rowspan="5"| Waits specified time if in combat with specified options.
|-
|Param 2
|colspan="2"|Skip|| TRUE/FALSE || Skip if no mobs exist.
|-
|Param 3
|colspan="2"|Distance|| 30 || Skip if no mobs exist within specified distance.
|-
|Param 4
|colspan="2"|Clear target|| 40 || Clear target if distance of target over specified distance. Default = 40
|-

|rowspan="3"|<center>'''HandleWaitForCombatWithNPC'''</center>
|-
|Param 1
|colspan="2"|NPC||"Trakanon"|| Name of NPC.
|rowspan="3"| Waits until combat is over. Returns TRUE if there was combat, and FALSE if there was not combat.
|-
|Param 2
|colspan="2"|Args|| -TimeToWait 50 (5 seconds), -SkipIfNoMobs TRUE/FALSE, -SkipIfNoMobsWithin 30, -ClearTargetIfTargetDistanceOver 50|| Accepts any of these args in pairs. The defaults are listed.
|-

|rowspan="2"|<center>'''HandleWaitForZoning'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Handles wait for when you are Zoning.
|-

|rowspan="2"|<center>'''HandleWaitTime'''</center>
|-
|Param 1
|colspan="2"|Wait Time||50|| Time to wait. Default = 50 (5 seconds)
|rowspan="2"| Literally just waits the specified amount of time.
|-

|rowspan="2"|<center>'''HandleZoneDoor'''</center>
|-
|Param 1
|colspan="2"|Option||1|| Zone door option. Default = 1
|rowspan="2"| Clicks specified Zone within a List UI.
|-

|rowspan="2"|<center>'''LoginToon'''</center>
|-
|Param 1
|colspan="2"|Toon||"Kannkor"|| Toon name to log in
|rowspan="2"| Logs in specified toon.
|-

|rowspan="3"|<center>'''NavTo'''</center>
|-
|Param 1
|colspan="2"|Loc||"737.106506,411.865784,-388.380249"|| Loc to nav to.
|rowspan="3"| Nav to specified location.
|-
|Param 2
|colspan="2"|How Close|| 1.5 || Get this close to destination. Default = 1.5
|-

|rowspan="3"|<center>'''NavToLoc'''</center>
|-
|Param 1
|colspan="2"|Loc||"737.106506,411.865784,-388.380249"|| Loc to nav to.
|rowspan="3"| Nav to specified location by specified precision.
|-
|Param 2
|colspan="2"|Precision|| 5 || Precision to destination. Default = 5
|-

|rowspan="3"|<center>'''NavToLocation'''</center>
|-
|Param 1
|colspan="2"|Location||"NPC_Loc_Main_Room"|| Saved Location to nav to.
|rowspan="3"| Nav to specified location by specified precision.
|-
|Param 2
|colspan="2"|Precision|| 5 || Precision to destination. Default = 5
|-

|rowspan="2"|<center>'''PreCombatBuff'''</center>
|-
|Param 1
|colspan="2"|Seconds||5 = 5 seconds|| Amount of Time to buff.
|rowspan="2"| Enters bots into Combat to force them to start casting incombat buffs/heals etc.
|-

|rowspan="2"|<center>'''ResetCameraAngle'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Resets your camera angle on your character, so it's in 3rd person view facing forward. Super useful if it may change before conversing with an NPC.
|-

|rowspan="2"|<center>'''Revive'''</center>
|-
|Param 1
|colspan="2"|Option||1|| Revive Option to use. Default = 1
|rowspan="2"| Revives at specified location.
|-

|rowspan="2"|<center>'''Set_FirstPersonView'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Puts you into First person view.
|-

|rowspan="2"|<center>'''Set_LookDown'''</center>
|-
|Param 1
|colspan="2"|Value||30|| How long to hold look down for. Default = 30 (3 seconds)
|rowspan="2"| Makes you "look down" for x seconds.
|-

|rowspan="2"|<center>'''Set_LookUp'''</center>
|-
|Param 1
|colspan="2"|Value||30|| How long to hold look up for Default = 30 (3 seconds)
|rowspan="2"| Makes you "look up" for x seconds.
|-

|rowspan="2"|<center>'''Set_ZoomIn'''</center>
|-
|Param 1
|colspan="2"|Value||30|| Default = 30
|rowspan="2"| Does nothing - Use Set_FirstPersonView if you wish to be zoomed in.
|-

|rowspan="2"|<center>'''Set_ZoomOut_MouseWheel'''</center>
|-
|Param 1
|colspan="2"|Value||30|| How many zoom out clicks to do. Default = 30
|rowspan="2"| Zooms out using the mouse wheel
|-

|rowspan="2"|<center>'''Set_ZoomOut'''</center>
|-
|Param 1
|colspan="2"|Value||30|| How long to hold the Zoom out key for. Default = 30 (3 seconds)
|rowspan="2"| Holds the zoom out key for this long.
|-

|rowspan="2"|<center>'''WaitForCasting'''</center>
|-
|Param 1
|colspan="2"|Wait Time||50 = 5 seconds|| Time to wait. Default = 50
|rowspan="2"| Wait while you are casting a spell or specified wait time.
|-

|rowspan="2"|<center>'''WaitForGroupToZone'''</center>
|-
|Param 1
|colspan="2"|How many||60 = 6 times|| Check how many times. Default = 60
|rowspan="2"| Check specified times for whole group to be in zone.
|-

|rowspan="2"|<center>'''WaitForLootWindow'''</center>
|-
|Param 1
|colspan="2"|wait time||50 = 5 seconds|| wait time. Default = 50
|rowspan="2"| Wait specified time for a lootwindow.
|-

|rowspan="2"|<center>'''WaitForPower'''</center>
|-
|Param 1
|colspan="2"|%||95|| wait for power %. Default = 95
|rowspan="2"| Wait for Power to be at or above specified %.
|-

|rowspan="2"|<center>'''WaitForScript'''</center>
|-
|Param 1
|colspan="2"|Script name||"Random Script"|| Script name.
|rowspan="2"| Wait while specified script is running.
|-

|rowspan="2"|<center>'''WaitForZoning'''</center>
|-
|Param 1
|colspan="2"|Wait Time||50 = 5 seconds|| wait time. Default = 50
|rowspan="2"| Wait while zoning and specified time.
|-

|rowspan="2"|<center>'''WaitWhileGroupMembersDead'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| wait while group members dead.
|-
|}

OgreUtilitiesAPI

2019-07-24T16:37:41Z

Pork:

== Implementing OgreUtilities ==

* To use '''OgreUtilities''' you will need to load the code into your script.
** The following will load '''OgreUtilities''' into your script.

function Load_OgreUtilities()
{
ogre utilities
wait 5
Obj_CreateOgreUtilities:CreateOgreUtilities[${Script.Filename}]
;// Returns variable: OgreUtilities
Obj_CreateOgreUtilities:CreateOgreCharacterData[${Script.Filename}]
;// Returns variable: OgreCharacterData

;// Usage here. See wiki <Link here would likely be helpful, and some examples>
}

* This will allow you to use all of the below '''Methods''', '''Members''', '''Functions''' below.

== Summary ==

* List of '''Methods''', '''Members''', '''Functions'''

* pre configured '''Methods''', '''Members''', '''Functions''' to make coding scripts easier for people.

* If their is a command you do not understand please feel free to ask in ogre discord and someone will explain and try to word it better here in the list

== Advanced Navigation Options ==

=== Usage ===

* Obj_OgreUtilities.OgreNavChecks:<MethodNameHere>[<ParametersHere>]
** Example - Obj_OgreUtilities.OgreNavChecks:Set_Check_MeInCombat[FALSE]

=== List of Methods ===

*Below is a list of all available methods.

{| class="wikitable"
|-
!Command
!colspan="3"|Parameters||Example||Notes||Description
|-

|rowspan="2"|<center>'''Set_CheckAll'''</center>
|-
|Param 1
|colspan="2"|Distance||50|| Default = 50
|rowspan="2"| Sets checking group in combat, and distance to 50, sets checking if you are in combat.
|-

|rowspan="2"|<center>'''Set_Check_MeInCombat'''</center>
|-
|Param 1
|colspan="2"|T or F||TRUE or FALSE|| Default = TRUE
|rowspan="2"| Sets checking if you are in combat.
|-

|rowspan="3"|<center>'''Set_Check_Group'''</center>
|-
|Param 1
|colspan="2"|T or F||TRUE or FALSE|| Default = TRUE
|rowspan="3"| Sets checking the group for combat and the distance.
|-
|Param 2
|colspan="2"|Distance||50|| Default = 50
|-

|rowspan="2"|<center>'''Set_Check_GroupCombatOnly'''</center>
|-
|Param 1
|colspan="2"|T or F||TRUE or FALSE|| Default = TRUE
|rowspan="2"| Sets checking if you are in combat. Will disable "Set_Check_GroupDistanceOnly" if it is enabled.
|-

|rowspan="3"|<center>'''Set_Check_GroupDistanceOnly'''</center>
|-
|Param 1
|colspan="2"|T or F||TRUE or FALSE|| Default = TRUE
|rowspan="3"| Sets checking the group for combat and the distance. Will disable "Set_Check_GroupCombatOnly" if it is enabled.
|-
|Param 2
|colspan="2"|Distance||50|| Default = 50
|-

|}

== Methods ==

=== Usage ===

* Example - Obj_OgreUtilities:AcceptQuest
** Would Accept a quest if a quest window exists.

=== List of Methods ===

*Below is a list of all available methods.

{| class="wikitable"
|-
!Command
!colspan="3"|Parameters||Example||Notes||Description
|-

|rowspan="2"|<center>'''AcceptQuest'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Accepts a quest if a quest window exists.
|-

|rowspan="2"|<center>'''EQ2_onQuestOffered'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| If enabled, accepts new quests.
|-

|rowspan="2"|<center>'''EQ2_onRewardWindowAppeared'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| If enabled, accepts Reward windows.
|-

|rowspan="2"|<center>'''Jump'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Jumps a toon.
|-

|rowspan="2"|<center>'''Set_EQ2_onQuestOffered'''</center>
|-
|Param 1
|colspan="2"|T or F||TRUE/FALSE|| Enables (TRUE) or disables (FALSE) the EQ2_onQuestOffered event.
|rowspan="2"| Turns the event on or off
|-

|rowspan="2"|<center>'''Set_EQ2_onRewardWindowAppeared'''</center>
|-
|Param 1
|colspan="2"|T or F||TRUE/FALSE|| Enables (TRUE) or disables (FALSE) the EQ2_onRewardWindowAppeared event.
|rowspan="2"| Turns the event on or off
|-
|}

== Members ==

=== Usage ===

{| class="wikitable"
|-
|Example 1
if ${Obj_OgreUtilities.AnyGroupMembersDead}
{
;// Will return TRUE if any group members are dead False if all alive
;// Code to execute if it comes back as TRUE
}
Example 2
*echo ${Obj_OgreUtilities.ConvertSecondsToHMS[4500]}
**Would convert and return the specified seconds into hour.minute.seconds.
|-
|}

=== List of Members ===

*Below is a list of all available members.

{| class="wikitable"
|-
!Command
!colspan="3"|Parameters||Example||Notes||Description
|-

|rowspan="2"|<center>'''AnyGroupMembersDead'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Checks if any group members are dead.
|-

|rowspan="2"|<center>'''CleanName'''</center>
|-
|Param 1
|colspan="2"|Input to clean||Kannkor's battle Bot|| Cleans an input
|rowspan="2"| Some zones, I believe such as proving grounds, you can end up with some very odd names for characters, this removes it and "cleans" the input.
|-

|rowspan="2"|<center>'''ConvertSecondsToHMS'''</center>
|-
|Param 1
|colspan="2"|Seconds||2500|| Seconds to convert.
|rowspan="2"| Converts seconds to hour minutes seconds.
|-

|rowspan="2"|<center>'''Get_Hours'''</center>
|-
|Param 1
|colspan="2"|Seconds||2500|| Seconds to convert.
|rowspan="2"| Determines how many whole hours are in the seconds.
|-

|rowspan="2"|<center>'''Get_Minutes'''</center>
|-
|Param 1
|colspan="2"|Seconds||2500|| Seconds to convert.
|rowspan="2"| Determines how many whole minutes are in the seconds. Return can only be 0 to 59, as any value above that would be returned in Get_Hours.
|-

|rowspan="2"|<center>'''Get_Seconds'''</center>
|-
|Param 1
|colspan="2"|Seconds||2500|| Seconds to convert.
|rowspan="2"| Determines how many whole seconds are in the seconds. Return can only be 0 to 59, as any value above that would be returned in Get_Hours or Get_Minutes.
|-

|rowspan="2"|<center>'''GetAscensionClass'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| spews your current ascension class.
|-

|rowspan="2"|<center>'''HaveAbilityID'''</center>
|-
|Param 1
|colspan="2"|ID||483993047|| ID of ability to check.
|rowspan="2"| returns TRUE if you have the ability or FALSE if you do not.
|-

|rowspan="2"|<center>'''InZoneName'''</center>
|-
|Param 1
|colspan="2"|Zone Name||"Myrist, the Great Library"|| Zone name to check.
|rowspan="2"| Checks if you are in specified zone name.
|-

|rowspan="2"|<center>'''InZoneShortName'''</center>
|-
|Param 1
|colspan="2"|Zone Name||"exp15_rgn_plane_of_knowledge"|| Zone short name to check.
|rowspan="2"| Checks if you are in specified zone short name.
|-

|rowspan="2"|<center>'''ItemCount'''</center>
|-
|Param 1
|colspan="2"|Item Name||"mechanical gear"|| Item name to check.
|rowspan="2"| Counts how many of said item you have in your inventory. Does NOT count bank. This handles counting multiple stacks.
|-

|rowspan="3"|<center>'''NearLoc'''</center>
|-
|Param 1
|colspan="2"|Loc||"737.106506,411.865784,-388.380249"|| Loc to check.
|rowspan="3"| Checks if you are within specified distance to specified Loc.
|-
|Param 2
|colspan="2"|Distance|| 10 || how close. Default = 10
|-

|rowspan="2"|<center>'''NPCCount'''</center>
|-
|Param 1
|colspan="2"|Distance||30|| Distance to check.
|rowspan="2"| Counts how many NPCs are within specified distance.
|-

|rowspan="2"|<center>'''OnCorrectCharacter'''</center>
|-
|Param 1
|colspan="2"|Toon name||"Kannkor"|| Name of toon to check.
|rowspan="2"| Checks currently logged in toon name matches specified toon name.
|-

|rowspan="2"|<center>'''WhereAreWe'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Returns where you are. Valid returns are: GUILDHALL, or the zone hash ( ${Zone.ShortName} ). Basically used for checking if you're in a guild hall.
|-
|}

== Functions ==

=== Usage ===

*All functions are locking. That means when you call them, they 'hold' the script and return once completed.
**Almost every single function has a return, usually bool that you can access. If TRUE, it means it believes the function was successful, if FALSE, it believes the function was not successful.
***You can access this return, by checking ${Return} immediately after the function call.

Example 1
call OgreUtilities.CallToGH
if ${Return}
echo Means CallToGH was successful!

=== List of Functions ===

* Below is a list of all available functions

{| class="wikitable"
|-
!Command
!colspan="3"|Parameters||Example||Notes||Description
|-

|rowspan="2"|<center>'''CallToGH'''</center>
|-
|Param 1
|colspan="2"|T or F||TRUE/FALSE|| Default FALSE. FALSE means if Call to Guild Hall is not available, wait for it. TRUE means if the call is not available, then don't cast it.
|rowspan="2"| Calls to Guild Hall.
|-

|rowspan="3"|<center>'''CastAbilityID'''</center>
|-
|Param 1
|colspan="2"|ID||106506|| ID of the ability.
|rowspan="3"| Casts ability and waits specified time for ability to cast.
|-
|Param 2
|colspan="2"|Wait Time|| 50 = 5 seconds || Time to wait. Default = 50
|-

|rowspan="2"|<center>'''CastEvac'''</center>
|-
|Param 1
|colspan="2"|NotAvailableAtThisTime||NotAvailableAtThisTime|| NotAvailableAtThisTime
|rowspan="2"| Can't be used at this time. Requires a reference that isn't accessible yet.
|-

|rowspan="2"|<center>'''CheckEvacTotems'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Checks you have evac totems.
|-

|rowspan="2"|<center>'''CheckIfGroupInSameZone'''</center>
|-
|Param 1
|colspan="2"|How many seconds to check for||30|| How many seconds to check for
|rowspan="2"| returns TRUE as soon as your entire group is in the same zone. Returns FALSE if at the end of the seconds to check for, if everyone is not in the same zone
|-

|rowspan="2"|<center>'''ClearQuestWindow'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Clears the quest helper window. The in-game on-screen quest information with checkboxes that can only show like 5 quests. This just unchecks them. It does NOT delete quests.
|-

|rowspan="2"|<center>'''DoConversation'''</center>
|-
|Param 1
|colspan="2"|Numerical sequence of conversation baubles to choose||1 1 2 3 1|| When conversing with an NPC, this example would choose option 1, then 1, then 2, then 3, then 1.
|rowspan="2"| Accepts any number of conversations, and does so with a 1/2 second delay
|-

|rowspan="2"|<center>'''DoHail'''</center>
|-
|Param 1
|colspan="2"|NPC||"Flag dude"|| Name of NPC.
|rowspan="2"| Hails specified NPC via Name.
|-

|rowspan="2"|<center>'''DoHailID'''</center>
|-
|Param 1
|colspan="2"|ID||8959659794|| ID of NPC.
|rowspan="2"| Hails specified NPC via ID.
|-

|rowspan="3"|<center>'''DoTarget'''</center>
|-
|Param 1
|colspan="2"|NPC||"Flag dude"|| Name of NPC.
|rowspan="3"| Targets NPC if withing specified Range.
|-
|Param 2
|colspan="2"|Range|| 50 || within Range. Default = 40
|-

|rowspan="3"|<center>'''FastTravel'''</center>
|-
|Param 1
|colspan="2"|Name||"Freeport"|| Name of Zone/Destination.
|rowspan="3"| Travels to specified destination. ( Requires Membership )
|-
|Param 2
|colspan="2"|Exact match|| TRUE/FALSE || Default = FALSE
|-

|rowspan="2"|<center>'''GetIntoCorrectZone'''</center>
|-
|Param 1
|colspan="2"|NotAvailableAtThisTime||NotAvailableAtThisTime|| NotAvailableAtThisTime
|rowspan="2"| This was never finished, it would help navigating from zone to zone automatically, through connecting zones. However the manual input and maps required map the set up extremely difficult.
|-

|rowspan="2"|<center>'''GHToHouse'''</center>
|-
|Param 1
|colspan="2"|Name||"Kannkors house"|| Name of house to go to.
|rowspan="2"| Zones you to specified house from Guild Hall.
|-

|rowspan="3"|<center>'''HandleCampSpotToLoc'''</center>
|-
|Param 1
|colspan="2"|Loc||"737.106506,411.865784,-388.380249"|| Loc to campspot to.
|rowspan="3"| Sets your campspot to the location you passed it, and waits until you are within Range of it. Example, if you set it to 100, it would return TRUE if you are within 100 meters of the campspot.
|-
|Param 2
|colspan="2"|Range|| 125 || within Range. Default = 125
|-

|rowspan="2"|<center>'''HandleClickActor_Special'''</center>
|-
|Param 1
|colspan="2"|Distance|| 10 || within Disatnce. Default = 10
|rowspan="2"| Clicks special actor within disance specified.
|-

|rowspan="3"|<center>'''HandleClickActor'''</center>
|-
|Param 1
|colspan="2"|Name||"Mechanical gear"|| Name of actor.
|rowspan="3"| Clicks an actor within disance specified.
|-
|Param 2
|colspan="2"|Distance|| 10 || within Disatnce. Default = 10
|-

|rowspan="2"|<center>'''HandleConversation'''</center>
|-
|Param 1
|colspan="2"|NotAvailableAtThisTime||NotAvailableAtThisTime|| NotAvailableAtThisTime
|rowspan="2"| Requires an object not available at this time
|-

|rowspan="2"|<center>'''HandleConversationByText'''</center>
|-
|Param 1
|colspan="2"|Text inputs||"Where would you like to go?" "I want to get a rally flag" || Will handle chat baubles based on text input. Accepts up to 10 parameters.
|rowspan="2"| Conversation baubles
|-

|rowspan="2"|<center>'''HandleWaitForCampSpot'''</center>
|-
|Param 1
|colspan="2"|Range||5|| Waits until you are within this range before returning. Also returns if you are dead. Default = 5
|rowspan="2"| Waits until you are dead or within range of campspot. Returns TRUE if you are at your campspot (regardless of your range), returns FALSE if you are NOT at your campspot, even if you are within the range specified.
|-

|rowspan="5"|<center>'''HandleWaitForCombat'''</center>
|-
|Param 1
|colspan="2"|wait time||50 = 5 seconds|| Time to wait. Default = 50
|rowspan="5"| Waits specified time if in combat with specified options.
|-
|Param 2
|colspan="2"|Skip|| TRUE/FALSE || Skip if no mobs exist.
|-
|Param 3
|colspan="2"|Distance|| 30 || Skip if no mobs exist within specified distance.
|-
|Param 4
|colspan="2"|Clear target|| 40 || Clear target if distance of target over specified distance. Default = 40
|-

|rowspan="5"|<center>'''HandleWaitForCombatOrPower'''</center>
|-
|Param 1
|colspan="2"|wait time||50 = 5 seconds|| Time to wait. Default = 50
|rowspan="5"| Waits specified time if in combat with specified options.
|-
|Param 2
|colspan="2"|Skip|| TRUE/FALSE || Skip if no mobs exist.
|-
|Param 3
|colspan="2"|Distance|| 30 || Skip if no mobs exist within specified distance.
|-
|Param 4
|colspan="2"|Clear target|| 40 || Clear target if distance of target over specified distance. Default = 40
|-

|rowspan="3"|<center>'''HandleWaitForCombatWithNPC'''</center>
|-
|Param 1
|colspan="2"|NPC||"Trakanon"|| Name of NPC.
|rowspan="3"| Waits until combat is over. Returns TRUE if there was combat, and FALSE if there was not combat.
|-
|Param 2
|colspan="2"|Args|| -TimeToWait 50 (5 seconds), -SkipIfNoMobs TRUE/FALSE, -SkipIfNoMobsWithin 30, -ClearTargetIfTargetDistanceOver 50|| Accepts any of these args in pairs. The defaults are listed.
|-

|rowspan="2"|<center>'''HandleWaitForZoning'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Handles wait for when you are Zoning.
|-

|rowspan="2"|<center>'''HandleWaitTime'''</center>
|-
|Param 1
|colspan="2"|Wait Time||50|| Time to wait. Default = 50 (5 seconds)
|rowspan="2"| Literally just waits the specified amount of time.
|-

|rowspan="2"|<center>'''HandleZoneDoor'''</center>
|-
|Param 1
|colspan="2"|Option||1|| Zone door option. Default = 1
|rowspan="2"| Clicks specified Zone within a List UI.
|-

|rowspan="2"|<center>'''LoginToon'''</center>
|-
|Param 1
|colspan="2"|Toon||"Kannkor"|| Toon name to log in
|rowspan="2"| Logs in specified toon.
|-

|rowspan="3"|<center>'''NavTo'''</center>
|-
|Param 1
|colspan="2"|Loc||"737.106506,411.865784,-388.380249"|| Loc to nav to.
|rowspan="3"| Nav to specified location.
|-
|Param 2
|colspan="2"|How Close|| 1.5 || Get this close to destination. Default = 1.5
|-

|rowspan="3"|<center>'''NavToLoc'''</center>
|-
|Param 1
|colspan="2"|Loc||"737.106506,411.865784,-388.380249"|| Loc to nav to.
|rowspan="3"| Nav to specified location by specified precision.
|-
|Param 2
|colspan="2"|Precision|| 5 || Precision to destination. Default = 5
|-

|rowspan="3"|<center>'''NavToLocation'''</center>
|-
|Param 1
|colspan="2"|Location||"NPC_Loc_Main_Room"|| Saved Location to nav to.
|rowspan="3"| Nav to specified location by specified precision.
|-
|Param 2
|colspan="2"|Precision|| 5 || Precision to destination. Default = 5
|-

|rowspan="2"|<center>'''PreCombatBuff'''</center>
|-
|Param 1
|colspan="2"|Seconds||5 = 5 seconds|| Amount of Time to buff.
|rowspan="2"| Enters bots into Combat to force them to start casting incombat buffs/heals etc.
|-

|rowspan="2"|<center>'''ResetCameraAngle'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Resets your camera angle on your character, so it's in 3rd person view facing forward. Super useful if it may change before conversing with an NPC.
|-

|rowspan="2"|<center>'''Revive'''</center>
|-
|Param 1
|colspan="2"|Option||1|| Revive Option to use. Default = 1
|rowspan="2"| Revives at specified location.
|-

|rowspan="2"|<center>'''Set_FirstPersonView'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Puts you into First person view.
|-

|rowspan="2"|<center>'''Set_LookDown'''</center>
|-
|Param 1
|colspan="2"|Value||30|| How long to hold look down for. Default = 30 (3 seconds)
|rowspan="2"| Makes you "look down" for x seconds.
|-

|rowspan="2"|<center>'''Set_LookUp'''</center>
|-
|Param 1
|colspan="2"|Value||30|| How long to hold look up for Default = 30 (3 seconds)
|rowspan="2"| Makes you "look up" for x seconds.
|-

|rowspan="2"|<center>'''Set_ZoomIn'''</center>
|-
|Param 1
|colspan="2"|Value||30|| Default = 30
|rowspan="2"| Does nothing - Use Set_FirstPersonView if you wish to be zoomed in.
|-

|rowspan="2"|<center>'''Set_ZoomOut_MouseWheel'''</center>
|-
|Param 1
|colspan="2"|Value||30|| How many zoom out clicks to do. Default = 30
|rowspan="2"| Zooms out using the mouse wheel
|-

|rowspan="2"|<center>'''Set_ZoomOut'''</center>
|-
|Param 1
|colspan="2"|Value||30|| How long to hold the Zoom out key for. Default = 30 (3 seconds)
|rowspan="2"| Holds the zoom out key for this long.
|-

|rowspan="2"|<center>'''WaitForCasting'''</center>
|-
|Param 1
|colspan="2"|Wait Time||50 = 5 seconds|| Time to wait. Default = 50
|rowspan="2"| Wait while you are casting a spell or specified wait time.
|-

|rowspan="2"|<center>'''WaitForGroupToZone'''</center>
|-
|Param 1
|colspan="2"|How many||60 = 6 times|| Check how many times. Default = 60
|rowspan="2"| Check specified times for whole group to be in zone.
|-

|rowspan="2"|<center>'''WaitForLootWindow'''</center>
|-
|Param 1
|colspan="2"|wait time||50 = 5 seconds|| wait time. Default = 50
|rowspan="2"| Wait specified time for a lootwindow.
|-

|rowspan="2"|<center>'''WaitForPower'''</center>
|-
|Param 1
|colspan="2"|%||95|| wait for power %. Default = 95
|rowspan="2"| Wait for Power to be at or above specified %.
|-

|rowspan="2"|<center>'''WaitForScript'''</center>
|-
|Param 1
|colspan="2"|Script name||"Random Script"|| Script name.
|rowspan="2"| Wait while specified script is running.
|-

|rowspan="2"|<center>'''WaitForZoning'''</center>
|-
|Param 1
|colspan="2"|Wait Time||50 = 5 seconds|| wait time. Default = 50
|rowspan="2"| Wait while zoning and specified time.
|-

|rowspan="2"|<center>'''WaitWhileGroupMembersDead'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| wait while group members dead.
|-
|}

OgreUtilitiesAPI

2019-07-03T20:49:21Z

Pork: Created page with "== Implimenting OgreUtilities == * To use '''OgreUtilities''' you will need to load the code into your script. ** The following will load '''OgreUtilities''' into your script..."

== Implimenting OgreUtilities ==

* To use '''OgreUtilities''' you will need to load the code into your script.
** The following will load '''OgreUtilities''' into your script.

function Load_OgreUtilities()
{
ogre utilities
wait 5
Obj_CreateOgreUtilities:CreateOgreUtilities[${Script.Filename}]
;// Returns variable: OgreUtilities
Obj_CreateOgreUtilities:CreateOgreCharacterData[${Script.Filename}]
;// Returns variable: OgreCharacterData

;// Usage here. See wiki <Link here would likely be helpful, and some examples>
}

* This will allow you to use all of the below '''Methods''', '''Members''', '''Functions''' below.

== Summary ==

* List of '''Methods''', '''Members''', '''Functions'''

* pre configured '''Methods''', '''Members''', '''Functions''' to make coding scripts easier for people.

* If their is a command you do not understand please feel free to ask in ogre discord and someone will explain and try to word it better here in the list

== Methods ==

=== Usage ===

* Example - Obj_OgreUtilities:AcceptQuest
** Would Accept a quest if a quest window exists.

=== List of Methods ===

*Below is a list of all available methods.

{| class="wikitable"
|-
!Command
!colspan="3"|Parameters||Example||Notes||Description
|-

|rowspan="2"|<center>'''AcceptQuest'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Accepts a quest if a quest window exists.
|-

|rowspan="2"|<center>'''EQ2_onQuestOffered'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| If enabled, accepts new quests.
|-

|rowspan="2"|<center>'''EQ2_onRewardWindowAppeared'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| If enabled, accepts Reward windows.
|-

|rowspan="2"|<center>'''Jump'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Jumps a toon.
|-

|rowspan="2"|<center>'''Set_EQ2_onQuestOffered'''</center>
|-
|Param 1
|colspan="2"|T or F||TRUE/FALSE|| Enables (TRUE) or disables (FALSE) the EQ2_onQuestOffered event.
|rowspan="2"| Turns the event on or off
|-

|rowspan="2"|<center>'''Set_EQ2_onRewardWindowAppeared'''</center>
|-
|Param 1
|colspan="2"|T or F||TRUE/FALSE|| Enables (TRUE) or disables (FALSE) the EQ2_onRewardWindowAppeared event.
|rowspan="2"| Turns the event on or off
|-
|}

== Members ==

=== Usage ===

{| class="wikitable"
|-
|Example 1
if ${Obj_OgreUtilities.AnyGroupMembersDead}
{
;// Will return TRUE if any group members are dead False if all alive
;// Code to execute if it comes back as TRUE
}
Example 2
*echo ${Obj_OgreUtilities.ConvertSecondsToHMS[4500]}
**Would convert and return the specified seconds into hour.minute.seconds.
|-
|}

=== List of Members ===

*Below is a list of all available members.

{| class="wikitable"
|-
!Command
!colspan="3"|Parameters||Example||Notes||Description
|-

|rowspan="2"|<center>'''AnyGroupMembersDead'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Checks if any group members are dead.
|-

|rowspan="2"|<center>'''CleanName'''</center>
|-
|Param 1
|colspan="2"|Input to clean||Kannkor's battle Bot|| Cleans an input
|rowspan="2"| Some zones, I believe such as proving grounds, you can end up with some very odd names for characters, this removes it and "cleans" the input.
|-

|rowspan="2"|<center>'''ConvertSecondsToHMS'''</center>
|-
|Param 1
|colspan="2"|Seconds||2500|| Seconds to convert.
|rowspan="2"| Converts seconds to hour minutes seconds.
|-

|rowspan="2"|<center>'''Get_Hours'''</center>
|-
|Param 1
|colspan="2"|Seconds||2500|| Seconds to convert.
|rowspan="2"| Determines how many whole hours are in the seconds.
|-

|rowspan="2"|<center>'''Get_Minutes'''</center>
|-
|Param 1
|colspan="2"|Seconds||2500|| Seconds to convert.
|rowspan="2"| Determines how many whole minutes are in the seconds. Return can only be 0 to 59, as any value above that would be returned in Get_Hours.
|-

|rowspan="2"|<center>'''Get_Seconds'''</center>
|-
|Param 1
|colspan="2"|Seconds||2500|| Seconds to convert.
|rowspan="2"| Determines how many whole seconds are in the seconds. Return can only be 0 to 59, as any value above that would be returned in Get_Hours or Get_Minutes.
|-

|rowspan="2"|<center>'''GetAscensionClass'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| spews your current ascension class.
|-

|rowspan="2"|<center>'''HaveAbilityID'''</center>
|-
|Param 1
|colspan="2"|ID||483993047|| ID of ability to check.
|rowspan="2"| returns TRUE if you have the ability or FALSE if you do not.
|-

|rowspan="2"|<center>'''InZoneName'''</center>
|-
|Param 1
|colspan="2"|Zone Name||"Myrist, the Great Library"|| Zone name to check.
|rowspan="2"| Checks if you are in specified zone name.
|-

|rowspan="2"|<center>'''InZoneShortName'''</center>
|-
|Param 1
|colspan="2"|Zone Name||"exp15_rgn_plane_of_knowledge"|| Zone short name to check.
|rowspan="2"| Checks if you are in specified zone short name.
|-

|rowspan="2"|<center>'''ItemCount'''</center>
|-
|Param 1
|colspan="2"|Item Name||"mechanical gear"|| Item name to check.
|rowspan="2"| Counts how many of said item you have in your inventory. Does NOT count bank. This handles counting multiple stacks.
|-

|rowspan="3"|<center>'''NearLoc'''</center>
|-
|Param 1
|colspan="2"|Loc||"737.106506,411.865784,-388.380249"|| Loc to check.
|rowspan="3"| Checks if you are within specified distance to specified Loc.
|-
|Param 2
|colspan="2"|Distance|| 10 || how close. Default = 10
|-

|rowspan="2"|<center>'''NPCCount'''</center>
|-
|Param 1
|colspan="2"|Distance||30|| Distance to check.
|rowspan="2"| Counts how many NPCs are within specified distance.
|-

|rowspan="2"|<center>'''OnCorrectCharacter'''</center>
|-
|Param 1
|colspan="2"|Toon name||"Kannkor"|| Name of toon to check.
|rowspan="2"| Checks currently logged in toon name matches specified toon name.
|-

|rowspan="2"|<center>'''WhereAreWe'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Returns where you are. Valid returns are: GUILDHALL, or the zone hash ( ${Zone.ShortName} ). Basically used for checking if you're in a guild hall.
|-
|}

== Functions ==

=== Usage ===

*All functions are locking. That means when you call them, they 'hold' the script and return once completed.
**Almost every single function has a return, usually bool that you can access. If TRUE, it means it believes the function was successful, if FALSE, it believes the function was not successful.
***You can access this return, by checking ${Return} immediately after the function call.

Example 1
call OgreUtilities.CallToGH
if ${Return}
echo Means CallToGH was successful!

=== List of Functions ===

* Below is a list of all available functions

{| class="wikitable"
|-
!Command
!colspan="3"|Parameters||Example||Notes||Description
|-

|rowspan="2"|<center>'''CallToGH'''</center>
|-
|Param 1
|colspan="2"|T or F||TRUE/FALSE|| Default FALSE. FALSE means if Call to Guild Hall is not available, wait for it. TRUE means if the call is not available, then don't cast it.
|rowspan="2"| Calls to Guild Hall.
|-

|rowspan="3"|<center>'''CastAbilityID'''</center>
|-
|Param 1
|colspan="2"|ID||106506|| ID of the ability.
|rowspan="3"| Casts ability and waits specified time for ability to cast.
|-
|Param 2
|colspan="2"|Wait Time|| 50 = 5 seconds || Time to wait. Default = 50
|-

|rowspan="2"|<center>'''CastEvac'''</center>
|-
|Param 1
|colspan="2"|NotAvailableAtThisTime||NotAvailableAtThisTime|| NotAvailableAtThisTime
|rowspan="2"| Can't be used at this time. Requires a reference that isn't accessible yet.
|-

|rowspan="2"|<center>'''CheckEvacTotems'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Checks you have evac totems.
|-

|rowspan="2"|<center>'''CheckIfGroupInSameZone'''</center>
|-
|Param 1
|colspan="2"|How many seconds to check for||30|| How many seconds to check for
|rowspan="2"| returns TRUE as soon as your entire group is in the same zone. Returns FALSE if at the end of the seconds to check for, if everyone is not in the same zone
|-

|rowspan="2"|<center>'''ClearQuestWindow'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Clears the quest helper window. The in-game on-screen quest information with checkboxes that can only show like 5 quests. This just unchecks them. It does NOT delete quests.
|-

|rowspan="2"|<center>'''DoConversation'''</center>
|-
|Param 1
|colspan="2"|Numerical sequence of conversation baubles to choose||1 1 2 3 1|| When conversing with an NPC, this example would choose option 1, then 1, then 2, then 3, then 1.
|rowspan="2"| Accepts any number of conversations, and does so with a 1/2 second delay
|-

|rowspan="2"|<center>'''DoHail'''</center>
|-
|Param 1
|colspan="2"|NPC||"Flag dude"|| Name of NPC.
|rowspan="2"| Hails specified NPC via Name.
|-

|rowspan="2"|<center>'''DoHailID'''</center>
|-
|Param 1
|colspan="2"|ID||8959659794|| ID of NPC.
|rowspan="2"| Hails specified NPC via ID.
|-

|rowspan="3"|<center>'''DoTarget'''</center>
|-
|Param 1
|colspan="2"|NPC||"Flag dude"|| Name of NPC.
|rowspan="3"| Targets NPC if withing specified Range.
|-
|Param 2
|colspan="2"|Range|| 50 || within Range. Default = 40
|-

|rowspan="3"|<center>'''FastTravel'''</center>
|-
|Param 1
|colspan="2"|Name||"Freeport"|| Name of Zone/Destination.
|rowspan="3"| Travels to specified destination. ( Requires Membership )
|-
|Param 2
|colspan="2"|Exact match|| TRUE/FALSE || Default = FALSE
|-

|rowspan="2"|<center>'''GetIntoCorrectZone'''</center>
|-
|Param 1
|colspan="2"|NotAvailableAtThisTime||NotAvailableAtThisTime|| NotAvailableAtThisTime
|rowspan="2"| This was never finished, it would help navigating from zone to zone automatically, through connecting zones. However the manual input and maps required map the set up extremely difficult.
|-

|rowspan="2"|<center>'''GHToHouse'''</center>
|-
|Param 1
|colspan="2"|Name||"Kannkors house"|| Name of house to go to.
|rowspan="2"| Zones you to specified house from Guild Hall.
|-

|rowspan="3"|<center>'''HandleCampSpotToLoc'''</center>
|-
|Param 1
|colspan="2"|Loc||"737.106506,411.865784,-388.380249"|| Loc to campspot to.
|rowspan="3"| Sets your campspot to the location you passed it, and waits until you are within Range of it. Example, if you set it to 100, it would return TRUE if you are within 100 meters of the campspot.
|-
|Param 2
|colspan="2"|Range|| 125 || within Range. Default = 125
|-

|rowspan="2"|<center>'''HandleClickActor_Special'''</center>
|-
|Param 1
|colspan="2"|Distance|| 10 || within Disatnce. Default = 10
|rowspan="2"| Clicks special actor within disance specified.
|-

|rowspan="3"|<center>'''HandleClickActor'''</center>
|-
|Param 1
|colspan="2"|Name||"Mechanical gear"|| Name of actor.
|rowspan="3"| Clicks an actor within disance specified.
|-
|Param 2
|colspan="2"|Distance|| 10 || within Disatnce. Default = 10
|-

|rowspan="2"|<center>'''HandleConversation'''</center>
|-
|Param 1
|colspan="2"|NotAvailableAtThisTime||NotAvailableAtThisTime|| NotAvailableAtThisTime
|rowspan="2"| Requires an object not available at this time
|-

|rowspan="2"|<center>'''HandleConversationByText'''</center>
|-
|Param 1
|colspan="2"|Text inputs||"Where would you like to go?" "I want to get a rally flag" || Will handle chat baubles based on text input. Accepts up to 10 parameters.
|rowspan="2"| Conversation baubles
|-

|rowspan="2"|<center>'''HandleWaitForCampSpot'''</center>
|-
|Param 1
|colspan="2"|Range||125|| Waits until you are within this range before returning. Also returns if you are dead. Default = 125
|rowspan="2"| Waits until you are dead or within range of campspot. Returns TRUE if you are at your campspot (regardless of your range), returns FALSE if you are NOT at your campspot, even if you are within the range specified.
|-

|rowspan="5"|<center>'''HandleWaitForCombat'''</center>
|-
|Param 1
|colspan="2"|wait time||50 = 5 seconds|| Time to wait. Default = 50
|rowspan="5"| Waits specified time if in combat with specified options.
|-
|Param 2
|colspan="2"|Skip|| TRUE/FALSE || Skip if no mobs exist.
|-
|Param 3
|colspan="2"|Distance|| 30 || Skip if no mobs exist within specified distance.
|-
|Param 4
|colspan="2"|Clear target|| 40 || Clear target if distance of target over specified distance. Default = 40
|-

|rowspan="5"|<center>'''HandleWaitForCombatOrPower'''</center>
|-
|Param 1
|colspan="2"|wait time||50 = 5 seconds|| Time to wait. Default = 50
|rowspan="5"| Waits specified time if in combat with specified options.
|-
|Param 2
|colspan="2"|Skip|| TRUE/FALSE || Skip if no mobs exist.
|-
|Param 3
|colspan="2"|Distance|| 30 || Skip if no mobs exist within specified distance.
|-
|Param 4
|colspan="2"|Clear target|| 40 || Clear target if distance of target over specified distance. Default = 40
|-

|rowspan="3"|<center>'''HandleWaitForCombatWithNPC'''</center>
|-
|Param 1
|colspan="2"|NPC||"Trakanon"|| Name of NPC.
|rowspan="3"| Waits until combat is over. Returns TRUE if there was combat, and FALSE if there was not combat.
|-
|Param 2
|colspan="2"|Args|| -TimeToWait 50 (5 seconds), -SkipIfNoMobs TRUE/FALSE, -SkipIfNoMobsWithin 30, -ClearTargetIfTargetDistanceOver 50|| Accepts any of these args in pairs. The defaults are listed.
|-

|rowspan="2"|<center>'''HandleWaitForZoning'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Handles wait for when you are Zoning.
|-

|rowspan="2"|<center>'''HandleWaitTime'''</center>
|-
|Param 1
|colspan="2"|Wait Time||50|| Time to wait. Default = 50 (5 seconds)
|rowspan="2"| Literally just waits the specified amount of time.
|-

|rowspan="2"|<center>'''HandleZoneDoor'''</center>
|-
|Param 1
|colspan="2"|Option||1|| Zone door option. Default = 1
|rowspan="2"| Clicks specified Zone within a List UI.
|-

|rowspan="2"|<center>'''LoginToon'''</center>
|-
|Param 1
|colspan="2"|Toon||"Kannkor"|| Toon name to log in
|rowspan="2"| Logs in specified toon.
|-

|rowspan="3"|<center>'''NavTo'''</center>
|-
|Param 1
|colspan="2"|Loc||"737.106506,411.865784,-388.380249"|| Loc to nav to.
|rowspan="3"| Nav to specified location.
|-
|Param 2
|colspan="2"|How Close|| 1.5 || Get this close to destination. Default = 1.5
|-

|rowspan="3"|<center>'''NavToLoc'''</center>
|-
|Param 1
|colspan="2"|Loc||"737.106506,411.865784,-388.380249"|| Loc to nav to.
|rowspan="3"| Nav to specified location by specified precision.
|-
|Param 2
|colspan="2"|Precision|| 5 || Precision to destination. Default = 5
|-

|rowspan="3"|<center>'''NavToLocation'''</center>
|-
|Param 1
|colspan="2"|Location||"NPC_Loc_Main_Room"|| Saved Location to nav to.
|rowspan="3"| Nav to specified location by specified precision.
|-
|Param 2
|colspan="2"|Precision|| 5 || Precision to destination. Default = 5
|-

|rowspan="2"|<center>'''PreCombatBuff'''</center>
|-
|Param 1
|colspan="2"|Seconds||5 = 5 seconds|| Amount of Time to buff.
|rowspan="2"| Enters bots into Combat to force them to start casting incombat buffs/heals etc.
|-

|rowspan="2"|<center>'''ResetCameraAngle'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Resets your camera angle on your character, so it's in 3rd person view facing forward. Super useful if it may change before conversing with an NPC.
|-

|rowspan="2"|<center>'''Revive'''</center>
|-
|Param 1
|colspan="2"|Option||1|| Revive Option to use. Default = 1
|rowspan="2"| Revives at specified location.
|-

|rowspan="2"|<center>'''Set_FirstPersonView'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Puts you into First person view.
|-

|rowspan="2"|<center>'''Set_LookDown'''</center>
|-
|Param 1
|colspan="2"|Value||30|| How long to hold look down for. Default = 30 (3 seconds)
|rowspan="2"| Makes you "look down" for x seconds.
|-

|rowspan="2"|<center>'''Set_LookUp'''</center>
|-
|Param 1
|colspan="2"|Value||30|| How long to hold look up for Default = 30 (3 seconds)
|rowspan="2"| Makes you "look up" for x seconds.
|-

|rowspan="2"|<center>'''Set_ZoomIn'''</center>
|-
|Param 1
|colspan="2"|Value||30|| Default = 30
|rowspan="2"| Does nothing - Use Set_FirstPersonView if you wish to be zoomed in.
|-

|rowspan="2"|<center>'''Set_ZoomOut_MouseWheel'''</center>
|-
|Param 1
|colspan="2"|Value||30|| How many zoom out clicks to do. Default = 30
|rowspan="2"| Zooms out using the mouse wheel
|-

|rowspan="2"|<center>'''Set_ZoomOut'''</center>
|-
|Param 1
|colspan="2"|Value||30|| How long to hold the Zoom out key for. Default = 30 (3 seconds)
|rowspan="2"| Holds the zoom out key for this long.
|-

|rowspan="2"|<center>'''WaitForCasting'''</center>
|-
|Param 1
|colspan="2"|Wait Time||50 = 5 seconds|| Time to wait. Default = 50
|rowspan="2"| Wait while you are casting a spell or specified wait time.
|-

|rowspan="2"|<center>'''WaitForGroupToZone'''</center>
|-
|Param 1
|colspan="2"|How many||60 = 6 times|| Check how many times. Default = 60
|rowspan="2"| Check specified times for whole group to be in zone.
|-

|rowspan="2"|<center>'''WaitForLootWindow'''</center>
|-
|Param 1
|colspan="2"|wait time||50 = 5 seconds|| wait time. Default = 50
|rowspan="2"| Wait specified time for a lootwindow.
|-

|rowspan="2"|<center>'''WaitForPower'''</center>
|-
|Param 1
|colspan="2"|%||95|| wait for power %. Default = 95
|rowspan="2"| Wait for Power to be at or above specified %.
|-

|rowspan="2"|<center>'''WaitForScript'''</center>
|-
|Param 1
|colspan="2"|Script name||"Random Script"|| Script name.
|rowspan="2"| Wait while specified script is running.
|-

|rowspan="2"|<center>'''WaitForZoning'''</center>
|-
|Param 1
|colspan="2"|Wait Time||50 = 5 seconds|| wait time. Default = 50
|rowspan="2"| Wait while zoning and specified time.
|-

|rowspan="2"|<center>'''WaitWhileGroupMembersDead'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| wait while group members dead.
|-
|}

OgreReforge

2019-07-03T19:35:51Z

Pork:

----
=== Main Overview ===
[[File:OReforgeDefault.PNG]]
 
*'''Making a List of Gear to Reforge.'''
*'''Load UI with Command''': ogre reforge
*'''Step 1'''
**Choose the stat you want to reforge into.
**[[File:ORStep1.PNG]]
 
*'''Step 2'''
**Enter the stat amount you want to reach.
**[[File:ORStep2.PNG]]
**Click the Add To List Below button.
**Repeat steps 1&2 until your list is complete with desired stat results.
 
*'''Step 3'''
**Choose the stats you're ok with reforging out of.
**Enter the lowest amount you're ok reducing that stat to.
**[[File:ORStep3.PNG]]
 
*'''Step 4'''
**Click add to List Below button.
**Repeat steps 3&4 until your list is complete with minimum amounts for each stat you're ok with changing.
**[[File:ORStep4.PNG]]
 
*'''Step 5'''
**Once you have finished adding all desired settings, you can click '''Save List''' to create a custom list for a toon, or group of toons that will all use the same stats. This will open a name box for you to enter a custom name.
**Enter a name for the List in the Textbox at bottom right of image. ( '''Try not to use Spaces or special characters when choosing a name for the List''' )
**Once you have Chosen a name for the List Hit the '''Save''' button to save the List to the xml for use later.
**Once you have Saved the List use the '''Close''' button to exit the script.
**[[File:ORSaveList.PNG]]
 
*'''Defaults'''
**Alternatively, there are 2 default predefined lists already saved in Ogre Reforge. '''Default''' and '''Default Fighter'''. These are normally pretty good templates to start with, and/or tweak to your preferences.
**[[File:ORLoadList.PNG]]
 
*'''Default Stats'''
**[[File:OReforgeDefault.PNG]]
 
*'''Default Fighter Stats'''
**[[File:OReforgeDefaultFighter.PNG]]
----

OgreBotAPI

2019-07-02T18:16:59Z

Pork:

== OgreBotAPI ==

OgreBotAPI is an '''A'''pplication '''P'''rogram '''I'''nterface built for people (scripters) to use various OgreBot functions.

== Methods ==

=== Usage ===

All 'methods' are called with the following syntax: OgreBotAPI:MethodName[Parameters]

* Example 1 - OgreBotAPI:CastAbility["all","Kick"]
** This would tell OgreBot to cast "Kick" on anyone who has that ability.
* Example 2 - OgreBotAPI:Change_FoodDrinkAutoConsume["all",TRUE]
** This would tell OgreBot to turn auto consume to on for all sessions.

=== List of Methods ===

* Below is a list of all available methods.

{| class="wikitable"
|-
!Command
!colspan="3"|Parameters||Example||Notes||Description
|-
|rowspan="3"|<center>'''AcceptReward'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}||Default = all
|rowspan="2"|Allows options for choosing rewards where there are actually options.
|-
|Param 2
|colspan="2"|Selection|| 2 || Leaving Parameter 2 blank or 0, will NOT accept a choice window.
|-

|rowspan="4"|<center>'''Actor_Click'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}||Default = all
|rowspan="4"|DoubleClicks an Actor if in range.
|-
|Param 2
|colspan="2"|Actor Name|| "Mechanical Travel Gear" || Actor Name Must be Quoted
|-
|Param 3
|colspan="2"|ExactName|| TRUE/FALSE || FALSE if looking for Partial name TRUE if Looking for Exactname
|-

|rowspan="4"|<center>'''AddNoOffensiveOn'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="4"| Turns on/off OgreBot's internal 'NoOffensive' option. This prevents most options in the caststack from casting if it is offensive when against the actor.
|-
|Param 2
|colspan="2"|Actor Name|| "Trakanon" || Actor Name Must be Quoted
|-
|Param 3
|colspan="2"|Exact Match Only|| TRUE/FALSE || If FALSE, will allow partial searches.
|-

|rowspan="5"|<center>'''Alias_AddEntry'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| N/A
|rowspan="5"| Adds an entry to your alias tab.
|-
|Param 2
|colspan="2"|Alias|| *Tank || what you want alias to be called
|-
|Param 3
|colspan="2"|Toon Name|| Kannkor || Name of toon to add
|-
|Param 4
|colspan="2"|NoRaid|| TRUE/FALSE || If you want to prevent it from scanning the raid, use TRUE (NoRaid=TRUE). Default is FALSE.
|-

|rowspan="5"|<center>'''Alias_ChangeEntry'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}||
|rowspan="5"| Changes a toon name entry in your alias tab.
|-
|Param 2
|colspan="2"|From|| Kannkor || Name of toon to change
|-
|Param 3
|colspan="2"|To|| Pork || Name of toon to change to
|-
|Param 4
|colspan="2"|Silent|| TRUE/FALSE || TRUE spews change to ogre console FALSE does not spew change
|-

|rowspan="5"|<center>'''Alias_ChangeEntryAlias'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}||N/A
|rowspan="5"|Changes an alias entry in your alias tab.
|-
|Param 2
|colspan="2"|From|| *Tank || Alias entry to change
|-
|Param 3
|colspan="2"|To|| *King || Alias entry to change to
|-
|Param 4
|colspan="2"|Silent|| TRUE/FALSE || TRUE spews change to ogre console FALSE does not spew change
|-

|rowspan="3"|<center>'''Alias_RemoveEntry'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="3"|Removes an alias entry in your alias tab.
|-
|Param 2
|colspan="2"|Alias|| *Tank || Alias entry to remove
|-

|rowspan="2"|<center>'''AltarOfTheAncients'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"|Clicks the Alter of the Ancients - ToT preorder clicky.
|-

|rowspan="5"|<center>'''Announce_AddEntry'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="5"|Adds an announce to the announce tab.
|-
|Param 2
|colspan="2"|Ability Name|| Rescue || Ability to trigger the announce
|-
|Param 3
|colspan="2"|Announce to|| Raid || Announce to what channel
|-
|Param 4
|colspan="2"|Text to announce|| Using *Ability* on *Target* || Text you would like to announce
|-

|rowspan="4"|<center>'''ApplyTempAdorn'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="4"|Applies temporary adornments. ( No Longer used )
|-
|Param 2
|colspan="2"|Adorn Name|| "Adorn of Crit" || Adorn to apply
|-
|Param 3
|colspan="2"|Slots|| "Primary", "chest", "Both" || what slots to apply to.
|-

|rowspan="3"|<center>'''ApplyVerb'''</center>
|-
|Param 1
|colspan="2"|Actor Name||"Mechanical Travel Gear"|| Actor name must be Quoted
|rowspan="3"| Clicks a rightclick option on an actor.
|-
|Param 2
|colspan="2"|Verb|| "Travel to the Planes" || Verb from rightclicking the actor must be Quoted
|-

|rowspan="4"|<center>'''ApplyVerbForWho'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="4"|Clicks an actor via Rightclick options.
|-
|Param 2
|colspan="2"|Actor Name||"Mechanical Travel Gear"|| Actor name must be Quoted
|-
|Param 3
|colspan="2"|Verb|| "Travel to the Planes" || Verb from rightclicking the actor must be Quoted
|-

|rowspan="4"|<center>'''ApplyVerbQueuedForWho'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="4"|Queues a Click of an actor via Rightclick options.
|-
|Param 2
|colspan="2"|Actor Name||"Mechanical Travel Gear"|| Actor name must be Quoted
|-
|Param 3
|colspan="2"|Verb|| "Travel to the Planes" || Verb from rightclicking the actor must be Quoted
|-

|rowspan="2"|<center>'''ArcannaseEffigyOfRebirth'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"|Clicks the Arcannase Effigy Of Rebirth - KA preorder clicky.
|-

|rowspan="3"|<center>'''AscensionEmbargo_Add_DoNotCombo'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="3"| Adds an ability to the Do Not combo list for Ascension Embargo
|-
|Param 2
|colspan="2"|Ability|| "Wildfire" || Ability name to add
|-

|rowspan="5"|<center>'''AscensionEmbargo_Change_Disable_Status'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="5"| Changing Ascension Embargo status. From Enabled to Disabled or vice versa.
|-
|Param 2
|colspan="2"|Ability Name|| Wildfire || Ability name to add
|-
|Param 3
|colspan="2"|Object Value|| TRUE/FALSE/Toggle || Changes the value to true/false or toggles from it's current value.
|-
|Param 4
|colspan="2"|Silent mode|| TRUE/FALSE || TRUE spews change to ogre console FALSE does not spew change
|-

|rowspan="3"|<center>'''AscensionEmbargo_Remove_DoNotCombo'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="3"| Removes an ability from the Do Not combo list for Ascension Embargo
|-
|Param 2
|colspan="2"|Ability|| "Wildfire" || Ability name to remove
|-

|rowspan="3"|<center>'''Assist'''</center>
|-
|Param 1
|colspan="2"|Assist Who|| "Kannkor" || Target to Assist.
|rowspan="3"| Makes you Assist specified target.
|-
|Param 2
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = ${Me.Name}
|-

|rowspan="2"|<center>'''AutoHunt_AddPath'''</center>
|-
|Param 1
|colspan="2"|Path name|| "harvest" || Loads a path in combobox for autohunt
|rowspan="2"| Adds the path name specified to autohunt.
|-

|rowspan="2"|<center>'''AutoHunt_AddPoint'''</center>
|-
|Param 1
|colspan="2"|Path name|| "harvestloc1" || Add nav point to list
|rowspan="2"| Adds the point from path name specified to autohunt.
|-

|rowspan="3"|<center>'''AutoHunt_CheckHP'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="3"|Adds Specified amount of HP to textbox in autohunt
|-
|Param 2
|colspan="2"|HP Value||80|| Sets HP in autohunt
|-

|rowspan="3"|<center>'''AutoHunt_CheckMana'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="3"| Adds Specified amount of MP to textbox in autohunt
|-
|Param 2
|colspan="2"|MP Value||80|| Sets MP in autohunt
|-

|rowspan="2"|<center>'''AutoHunt_ClearPoints'''</center>
|-
|N/A
|colspan="2"|N/A||N/A||N/A
|rowspan="2"| Clears all Path points from autohunt
|-

|rowspan="2"|<center>'''AutoHunt_RemovePoint'''</center>
|-
|Param 1
|colspan="2"|Point name|| "harvestloc1" || Remove specified point from list
|rowspan="2"| Removes the point from path name specified to autohunt.
|-

|rowspan="3"|<center>'''AutoHunt_ScanRadius'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="3"| Sets the scan radius within autohunt
|-
|Param 2
|colspan="2"|Raduis value||20|| Sets scan raduis by specified distance
|-

|rowspan="2"|<center>'''AutoRun'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Toggles auto run on and off
|-

|rowspan="3"|<center>'''AutoTarget_SetRescanTime'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="3"| Sets the rescan time for autotarget
|-
|Param 2
|colspan="2"|Rescan Time||500|| Sets rescan time by specified value
|-

|rowspan="3"|<center>'''AutoTarget_SetScanHeight'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="3"| Sets the scan Height for autotarget
|-
|Param 2
|colspan="2"|Scan Height||50|| Sets scan Height by specified value
|-

|rowspan="3"|<center>'''AutoTarget_SetScanRadius'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="3"| Sets the Scan Radius for autotarget
|-
|Param 2
|colspan="2"|Scan Radius||50|| Sets Scan Radius by specified value
|-

|rowspan="2"|<center>'''CallGH'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"|Calls you to Guild Hall
|-

|rowspan="3"|<center>'''CampToDesktop'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="3"|Camps sessions to Desktop or loginscene
|-
|Param 2
|colspan="2"|Login only||TRUE/FALSE|| if set TRUE will camp you to loginscene
|-

|rowspan="2"|<center>'''CancelCasting'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"|Cancels what you are currently casting
|-

|rowspan="3"|<center>'''CancelCurrentCast'''</center>
|-
|Param 1
|colspan="2"|T or F||TRUE/FALSE|| if set TRUE will cancel cast
|rowspan="3"| Cancels what you are currently casting
|-
|Param 2
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|-

|rowspan="2"|<center>'''CancelMaintained'''</center>
|-
|Param 1
|colspan="2"|Args||Ability Names|| Ability Names separated by commas. Example: OgreBotAPI:CancelMaintained["Sprint","AbilityName2Here","AbilityName3Here"]
|rowspan="2"| Cancels maintaned spells/effects
|-

|rowspan="3"|<center>'''CancelMaintainedForWho'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="3"|Cancels maintaned spells/effects
|-
|Param 2
|colspan="2"|Args||Ability Names|| Ability Names separated by commas. Example: OgreBotAPI:CancelMaintained["Sprint","AbilityName2Here","AbilityName3Here"]
|-

|rowspan="3"|<center>'''CastAbility_Relay'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| N/A
|rowspan="3"| Casts the specified ability
|-
|Param 2
|colspan="2"|Ability Name||"Rending"|| Ability name to be cast
|-

|rowspan="3"|<center>'''CastAbility'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| N/A
|rowspan="3"|Casts the specified ability
|-
|Param 2
|colspan="2"|Ability Name||"Rending"|| Ability name to be cast
|-

|rowspan="4"|<center>'''CastAbilityInSeconds_Relay'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| N/A
|rowspan="4"| Casts the specified ability after specified amount of time
|-
|Param 2
|colspan="2"|Ability Name||"Rending"|| Ability name to be cast
|-
|Param 3
|colspan="2"|seconds to wait||10|| Seconds to wait to cast ability
|-

|rowspan="4"|<center>'''CastAbilityInSeconds'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| N/A
|rowspan="4"| Casts the specified ability after specified amount of time
|-
|Param 2
|colspan="2"|Ability Name||"Rending"|| Ability name to be cast
|-
|Param 3
|colspan="2"|seconds to wait||10|| Seconds to wait to cast ability
|-

|rowspan="3"|<center>'''CastAbilityNoChecks'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| N/A
|rowspan="3"| Casts an ability skipping all checks in the bot.
|-
|Param 2
|colspan="2"|Ability Name||"Rending"|| Ability name to be cast
|-

|rowspan="3"|<center>'''CastAbilityNoExport_Relay'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| N/A
|rowspan="3"| Casts an ability without it being within your export.
|-
|Param 2
|colspan="2"|Ability Name||"Rending"|| Ability name to be cast
|-

|rowspan="3"|<center>'''CastAbilityNoExport'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| N/A
|rowspan="3"|Casts an ability without it being within your export.
|-
|Param 2
|colspan="2"|Ability Name||"Rending"|| Ability name to be cast
|-

|rowspan="3"|<center>'''CastAbilityNoExportUntilCast'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| N/A
|rowspan="3"| Casts an ability without it being within your export and waits till the ability is cast.
|-
|Param 2
|colspan="2"|Ability Name||"Rending"|| Ability name to be cast
|-

|rowspan="4"|<center>'''CastAbilityOnNPC'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| N/A
|rowspan="4"| Casts an ability on specified Actor.
|-
|Param 2
|colspan="2"|Ability Name||"Rending"|| Ability name to be cast
|-
|Param 3
|colspan="2"|Actor Name||"Trakanon"|| Actor name to cast ability on
|-

|rowspan="4"|<center>'''CastAbilityOnPlayer_Relay'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| N/A
|rowspan="4"| Casts an ability on specified player character.
|-
|Param 2
|colspan="2"|Ability Name||"Rending"|| Ability name to be cast
|-
|Param 3
|colspan="2"|Player Name||"Kannkor"|| Player Character name to cast ability on
|-

|rowspan="5"|<center>'''CastAbilityOnPlayer'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| N/A
|rowspan="5"| Casts an ability on specified player character in specified seconds to wait.
|-
|Param 2
|colspan="2"|Ability Name||"Rending"|| Ability name to be cast
|-
|Param 3
|colspan="2"|Player Name||"Kannkor"|| Player Character name to cast ability on
|-
|Param 4
|colspan="2"|Seconds to wait||10|| time to wait before casting ability on player character
|-

|rowspan="2"|<center>'''CastHQEar'''</center>
|-
|N/A
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Casts the HQ Ear from KA HQ.
|-

|rowspan="3"|<center>'''CastedCastOnTheMove'''</center>
|-
|Param 1
|colspan="2"|Player Character|| "Kannkor" || Name of the Player who casted a cast on the move ability
|rowspan="3"| Internal option. Passes information in your group if they are allowed to cast while moving.
|-
|Param 2
|colspan="2"|Duration||10.5|| Duration of the ability that gives the cast while moving.
|-

|rowspan="2"|<center>'''CastingCastOnTheMove'''</center>
|-
|Param 1
|colspan="2"|Duration||10.5|| Duration of the ability that gives the cast while moving.
|rowspan="2"| Internal use. This sends out information that you casted a cast while moving buff for the group.
|-

|rowspan="3"|<center>'''Change_FoodDrinkAutoConsume'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| N/A
|rowspan="3"| Sets food & drink autoconsume to on/off.
|-
|Param 2
|colspan="2"|T F T||TRUE/FALSE/TOGGLE|| sets food & drink autoconsume to specified
|-

|rowspan="4"|<center>'''Change_PoisonAutoConsume'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}||N/A
|rowspan="4"| Sets specified poison autoconsume to specified.
|-
|Param 2
|colspan="2"|T F T||TRUE/FALSE/TOGGLE|| sets poison autoconsume to specified
|-
|Param 3
|colspan="2"|Poison name||"Marked Target"|| name of the poison you want to change.
|-

|rowspan="4"|<center>'''Change_StatPotionsAutoConsume'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| N/A
|rowspan="4"|Sets specified stat potion autoconsume to specified.
|-
|Param 2
|colspan="2"|T F T||TRUE/FALSE/TOGGLE|| sets stat potion autoconsume to specified
|-
|Param 3
|colspan="2"|Stat Potion name||"intelect"|| name of the stat potion you want to change.
|-

|rowspan="5"|<center>'''ChangeCampSpotWho'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| N/A
|rowspan="5"| Changes campspot to specified XYZ Cordinates.
|-
|Param 2
|colspan="2"|X||X Cord|| N/A
|-
|Param 3
|colspan="2"|Y||Y Cord|| N/A
|-
|Param 4
|colspan="2"|Z||Z Cord|| N/A
|-

|rowspan="4"|<center>'''ChangeCampSpot'''</center>
|-
|Param 1
|colspan="2"|X||X Cord|| N/A
|rowspan="4"|Changes campspot to specified XYZ Cordinates.
|-
|Param 2
|colspan="2"|Y||Y Cord|| N/A
|-
|Param 3
|colspan="2"|Z||Z Cord|| N/A
|-

|rowspan="5"|<center>'''ChangeCastStackListBoxItem'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| N/A
|rowspan="5"| Changes a cast stack item to on/off.
|-
|Param 2
|colspan="2"|Ability name||"Rending"|| name of ability in the cast stack to change
|-
|Param 3
|colspan="2"|T F T||TRUE/FALSE/TOGGLE|| Changes cast stack item to specified
|-
|Param 4
|colspan="2"|Silent mode||TRUE/FALSE|| TRUE spews change to ogre console FALSE does not spew change
|-

|rowspan="6"|<center>'''ChangeCastStackListBoxItemByTag'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| N/A
|rowspan="6"| Changes a cast stack item to on/off via Custom Tag.
|-
|Param 2
|colspan="2"|Tag name||"Threat"|| name of the custom Tag to change
|-
|Param 3
|colspan="2"|T F T||TRUE/FALSE/TOGGLE|| Changes cast stack item to specified
|-
|Param 4
|colspan="2"|Partial||TRUE/FALSE|| If TRUE, allows substring search. If FALSE, exact tag match only.
|-
|Param 5
|colspan="2"|Silent mode||TRUE/FALSE|| TRUE spews change to ogre console FALSE does not spew change
|-

|rowspan="3"|<center>'''ChangeLootOptions'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="3"| Changes loot options to specified.
|-
|Param 2
|colspan="2"|Args||AutoNone, AutoGreed, AutoDecline, LeaderOnlyLoot, FreeForAll, Lotto, NeedBeforeGreed, RoundRobin, [(item rarity)] All , Treasured, Legendary, Fabled, YellLeaderOnly, YellAll, EncLockLeaderOnly, EncLockAll, AutoSplit, NoAutoSplit, AutoLock, NoAutoLock|| Can pass in as many of these options as you want.
|-

|rowspan="5"|<center>'''ChangeOgreBotUIOption'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| N/A
|rowspan="5"|Changes a ui element.
|-
|Param 2
|colspan="2"|UI code||"checkbox_settings_grindoptions"|| change ui checkbox to specified.
|-
|Param 3
|colspan="2"|T F T||TRUE/FALSE/TOGGLE|| Changes ui checkbox to specified
|-
|Param 4
|colspan="2"|Silent mode||TRUE/FALSE|| TRUE spews change to ogre console FALSE does not spew change
|-

|rowspan="3"|<center>'''ChangeRadarYAxis'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| N/A
|rowspan="3"|Changes Y axis to specified.
|-
|Param 2
|colspan="2"|T F||TRUE/FALSE|| Changes Y axis on radar to on/off
|-

|rowspan="3"|<center>'''ChangeZoneTo'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| N/A
|rowspan="3"| Changes your zone to specified player character.
|-
|Param 2
|colspan="2"|Player character||"Kannkor"|| Name of character to change zone to
|-

|rowspan="6"|<center>'''ChatEvent_AddEntry'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="6"|Adds a chatevent to chat event tab.
|-
|Param 2
|colspan="2"|Text||"Trakanon looks at you"|| Text to listen for to trigger
|-
|Param 3
|colspan="2"|ogre console||TRUE/FALSE|| spew infor to Ogre console on success
|-
|Param 4
|colspan="2"|Ding Sound||TRUE/FALSE|| Will cause the bot to Ding on success
|-
|Param 5
|colspan="2"|Code||OgreBotAPI:Jump[${Me.Name}]|| Code to execute on success.
|-

|rowspan="3"|<center>'''ChatEvent_RemoveEntry'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="3"| Removes chat trigger from chat events tab.
|-
|Param 2
|colspan="2"|Text||"Trakanon looks at you"|| Text of trigger to remove
|-

|rowspan="2"|<center>'''CheckGear'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Checks armour condition.
|-

|rowspan="2"|<center>'''CheckKunarkAscendingRequirements'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Checks for any missing KA sigline quests.
|-

|rowspan="2"|<center>'''CheckMemberLevel'''</center>
|-
|Param 1
|colspan="2"|T F||TRUE/FALSE|| OnlyShowNonMembers. Default FALSE. If set to TRUE, will only if you are NOT a member.
|rowspan="2"|Checks your membership level ( Silver, Gold, Member ).
|-

|rowspan="3"|<center>'''CheckResearch'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="3"| Checks your current research time and spews to ogre console.
|-
|Param 2
|colspan="2"|Report||TRUE/FALSE|| FALSE will only spew info if research complete.
|-

|rowspan="2"|<center>'''ClearNoOffensiveOn'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Clears the internal 'NoOffensive' flag. This should not be used.
|-

|rowspan="2"|<center>'''CloseWindow'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Closes the top EQ2 UI window
|-

|rowspan="4"|<center>'''Come2Me'''</center>
|-
|Param 1
|colspan="2"|PC to move to||"${Me.Name}"|| Target to move to. Default = ${Me.Name}
|rowspan="4"| Moves bots to specified player
|-
|Param 2
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|-
|Param 3
|colspan="2"|Precision||3|| Precision to move into range. Default = 3
|-

|rowspan="2"|<center>'''ConsumeDeityBaubles'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"|Consumes deity bubbles in inventory for you.
|-

|rowspan="3"|<center>'''ConversationBubble'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="3"| Clicks a conversation bubble via specified #.
|-
|Param 2
|colspan="2"|Option||1|| conversation bubble to click via #
|-

|rowspan="2"|<center>'''Crouch'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Crouches you.
|-

|rowspan="2"|<center>'''DailyEtherealMissionReset'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Spews info to ogre console on when daily missions reset and what current missions are.
|-

|rowspan="3"|<center>'''DeleteQuest'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="3"| Deletes a quest from your journal.
|-
|Param 2
|colspan="2"|Quest Name||"quest name"|| Must be quoted.
|-

|rowspan="6"|<center>'''DespawnEvent_AddEntry'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="6"| Adds a despawn event to the despawn event tab.
|-
|Param 2
|colspan="2"|Text||"Trakanon stares at you"|| Must be quoted. Text to listen for.
|-
|Param 3
|colspan="2"|OC||TRUE/FALSE|| Send info to ogre console on success.
|-
|Param 4
|colspan="2"|Ding||TRUE/FALSE|| make a ding sound on success.
|-
|Param 5
|colspan="2"|Code||OgreBotAPI:Kick["all"]|| Code to trigger on success.
|-

|rowspan="3"|<center>'''DespawnEvent_RemoveEntry'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="3"| Removes a despawn entry via text in event.
|-
|Param 2
|colspan="2"|Text||"Trakanon stares at you"|| Must be quoted. Text to remove.
|-

|rowspan="2"|<center>'''Disband'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Disbands you from group or raid.
|-

|rowspan="3"|<center>'''Dispell'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="3"| Casts 'Dispell' (Usually enchanter Absorb magic) on an NPC.
|-
|Param 2
|colspan="2"|NPC To Dispell||"Trakanon"|| Name of the NPC to dispell
|-

|rowspan="2"|<center>'''DisplayAvailableSetups'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Displays all Setups for the current zone into ogre console.
|-

|rowspan="2"|<center>'''DisplayEtherealMissionInfo'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Spews info to ogre console on when daily missions reset and what current missions are.
|-

|rowspan="2"|<center>'''DisplayMyAscensionCombos'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Displays your current ascension combos into IS console.
|-

|rowspan="2"|<center>'''DungeonMakerCancel'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Presses the "Cancel" button in Dungeon Maker. (not really appliciable anymore)
|-

|rowspan="2"|<center>'''End_Bot'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Ends Ogre Bot.
|-

|rowspan="3"|<center>'''EquipCharm'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="3"| Equips a charm by specified value. via the equipment info tab.
|-
|Param 2
|colspan="2"|value||1 or 2|| Charm to equip.
|-

|rowspan="2"|<center>'''Evac'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Anyone with an evacuate ability will use it.
|-

|rowspan="2"|<center>'''F2PWindow_Check'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Does a check to see if the f2p window is open, and closes it.
|-

|rowspan="3"|<center>'''F2PWindow_SetOptions'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="3"| Tells Ogrebot to check for the F2PWindow again for <Minutes>.
|-
|Param 2
|colspan="2"|Minutes||15|| How many Minutes to wait.
|-

|rowspan="4"|<center>'''FastTravel'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="4"| Uses Fast travel if you are a member.
|-
|Param 2
|colspan="2"|Location||Freeport|| Location name.
|-
|Param 3
|colspan="2"|Exact Match||TRUE/FALSE|| Default = FALSE
|-

|rowspan="2"|<center>'''FlyDown'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Makes you Fly/Swim Down. This is a Toggle use FlyStop to stop.
|-

|rowspan="2"|<center>'''FlyStop'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Stops you from flying/swimming up/down.
|-

|rowspan="2"|<center>'''FlyUp'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Makes you Fly/Swim Up. This is a Toggle use FlyStop to stop.
|-

|rowspan="2"|<center>'''Force_MountOn'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| This will recast your mount regardless if you have it on or not.
|-

|rowspan="2"|<center>'''ForceFollow'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Forces toons to follow you.
|-

|rowspan="3"|<center>'''Get_CurePotions'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="3"| Will pull 100 of the specified from poision potion depot if you have under 100 in inventory.
|-
|Param 2
|colspan="2"|Value||"Acerbic Elixir of Intellect"|| Potion name. Must be Quoted.
|-

|rowspan="3"|<center>'''Get_Faction'''</center>
|-
|Param 1
|colspan="2"|Faction||"Exile"|| Faction name. Must be Quoted.
|rowspan="3"| Gets your current specified faction and spews info to ogre console.
|-
|Param 2
|colspan="2"|Spewto||oc or irc|| spew info to ogreconsole or irc
|-

|rowspan="2"|<center>'''Get_FoodDrink'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| N/A
|rowspan="2"| Will pull and equip current food and drink you have in slots.
|-

|rowspan="3"|<center>'''Get_Poisons'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| N/A
|rowspan="3"| Will pull 100 of the specified from poision potion depot if you have under 100 in inventory.
|-
|Param 2
|colspan="2"|Value||"Marked Target"|| Poison name. Must be Quoted.
|-

|rowspan="3"|<center>'''Get_StatPotions'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| N/A
|rowspan="3"| Will pull 100 of the specified from poision potion depot if you have under 100 in inventory.
|-
|Param 2
|colspan="2"|Value||"Arebic Intelect"|| Potion name. Must be Quoted.
|-

|rowspan="2"|<center>'''GetFlag'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Grabs a Guild Hall flag from the npc in Guild Hall.
|-

|rowspan="2"|<center>'''GroupCure_Relay'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| N/A
|rowspan="2"| Makes bots group cure if they have a group cure.
|-

|rowspan="2"|<center>'''GroupCure'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Makes bots group cure if they have a group cure.
|-

|rowspan="3"|<center>'''GuidedAscension'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="3"| Uses Guided Ascension Scrolls
|-
|Param 2
|colspan="2"|Amount||3000000 (3 million)|| Must have less than this much vitality to consume scroll.
|-

|rowspan="3"|<center>'''HailNPC'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="3"| Hails specified npc.
|-
|Param 2
|colspan="2"|Name or ID||"Trakanon"|| Name or ID of npc to hail.
|-

|rowspan="2"|<center>'''Heartstone_RekindleBond'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Clicks hearstone item to refresh heartbound.
|-

|rowspan="2"|<center>'''HoldUp'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Turns autofollow off.
|-

|rowspan="2"|<center>'''HQEar_Recheck'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Re Checks HQ ear from KA and applies buff if not already on.
|-

|rowspan="2"|<center>'''HQEar_ReEquipOriginalEar'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Re Checks HQ ear is not equiped and equips original if it is if it can.
|-

|rowspan="2"|<center>'''ImmRes'''</center>
|-
|Param 1
|colspan="2"|How many||2|| # of people to check are dead to use.
|rowspan="2"| Uses Cleric AA Immaculate Revival if X people are dead.
|-

|rowspan="4"|<center>'''Invite'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="4"| Invites specified to group or raid.
|-
|Param 2
|colspan="2"|PC Name||"Kannkor"|| Player character to invite.
|-
|Param 3
|colspan="2"|Raid invite||TRUE/FALSE|| invite to group or raid Default = FALSE = group
|-

|rowspan="2"|<center>'''ItemDebug'''</center>
|-
|Param 1
|colspan="2"|Item Name||"Buckler of blah"|| Name of item. Must be Quoted.
|rowspan="2"| Debugs item specified and spews info to console.
|-

|rowspan="2"|<center>'''JoustIn'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Jousts in specifeid to engaged mob from campspot. requires move behind or move into melee enabled & campspot.
|-

|rowspan="2"|<center>'''JoustOff'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = Casters
|rowspan="2"| turns jousting off for specifeid. requires move behind or move into melee enabled & campspot.
|-

|rowspan="2"|<center>'''JoustOn'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = Melee
|rowspan="2"| turns jousting on for specifeid. requires move behind or move into melee enabled & campspot.
|-

|rowspan="2"|<center>'''JoustOut'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Jousts out specifeid to engaged mob from campspot. requires move behind or move into melee enabled & campspot.
|-

|rowspan="2"|<center>'''Jump'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Tells specified to Jump.
|-

|rowspan="2"|<center>'''LetsGo'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Removes movement restrictions such as HoldUp and campspot.
|-

|rowspan="3"|<center>'''LogToonIn'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = ${Me.Name}
|rowspan="3"| Logs in specified player character.
|-
|Param 2
|colspan="2"|PC||"Kannkor"|| Player character to log in.
|-

|rowspan="2"|<center>'''Loot_SmartAssign_Add'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Generates the Values in smartloot xml for PoP expac mount parts
|-

|rowspan="2"|<center>'''Loot_SmartAssign_Update'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Updates the Values in smartloot xml for PoP expac mount parts
|-

|rowspan="2"|<center>'''LootWindowLootAll'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Loots all items in a loot window.
|-

|rowspan="3"|<center>'''MakeLeader'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = ${Me.Name}
|rowspan="3"| Changes the group leader to specified.
|-
|Param 2
|colspan="2"|Leader||"Kannkor"|| Player character to make leader. Default = ${Me.Name}
|-

|rowspan="2"|<center>'''MarkToon'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Marks a toon for specific ogre set up operations.
|-

|rowspan="2"|<center>'''Mentor'''</center>
|-
|Param 1
|colspan="2"|Mentor PC||"Kannkor"|| Default = ${Me.Name}
|rowspan="2"| Mentor specified pc.
|-

|rowspan="5"|<center>'''Message_NT'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| N/A
|rowspan="5"| Sends a message to ogre console for specified only with a noise & no Time stamp.
|-
|Param 2
|colspan="2"|Message|| Kannkor sucks || Message to send.
|-
|Param 3
|colspan="2"|Noise|| TRUE/FALSE || Make a noise.
|-
|Param 4
|colspan="2"|Noise|| default or loud || Noise type. Default = default
|-

|rowspan="5"|<center>'''Message_Relay'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| N/A
|rowspan="5"| Sends a message to all sessions ogre console with a noise.
|-
|Param 2
|colspan="2"|Message|| Kannkor sucks || Message to send.
|-
|Param 3
|colspan="2"|Noise|| TRUE/FALSE || Make a noise.
|-
|Param 4
|colspan="2"|Noise|| default or loud || Noise type. Default = default
|-

|rowspan="5"|<center>'''Message'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| N/A
|rowspan="5"| ends a message to ogre console for specified only with a noise.
|-
|Param 2
|colspan="2"|Message|| Kannkor sucks || Message to send.
|-
|Param 3
|colspan="2"|Noise|| TRUE/FALSE || Make a noise.
|-
|Param 4
|colspan="2"|Noise|| default or loud || Noise type. Default = default
|-

|rowspan="2"|<center>'''Mount'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Clicks the mount ability. If you have a mount it will cancel it. If you do not have a mount it will summon it.
|-

|rowspan="5"|<center>'''Move2Area'''</center>
|-
|Param 1
|colspan="2"|X|| X Cord || N/A
|rowspan="5"| tells bots to move to a specific player character.
|-
|Param 2
|colspan="2"|Y|| Y Cord || N/A
|-
|Param 3
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| N/A
|-
|Param 4
|colspan="2"|Precision|| 3 || Precision to target . Default = 3
|-

|rowspan="2"|<center>'''NoMove'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Prevents incombat movement such as move into melee range and move behind.
|-

|rowspan="2"|<center>'''NoTarget'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Clears everyones target.
|-

|rowspan="2"|<center>'''OFolDecDistance'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Decreases the distance of OgreFollow.
|-

|rowspan="2"|<center>'''OFolIncDistance'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Increases the distance of OgreFollow.
|-

|rowspan="3"|<center>'''OgreIRC_AuthIfInRaid'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| N/A
|rowspan="3"| Autherise if in raid for specified.
|-
|Param 2
|colspan="2"|PC Name|| "Pork" || Player character to auth.
|-

|rowspan="5"|<center>'''OnScreenTimer'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="5"| Puts a HUD onscreen with a timer on your screen like group HUD.
|-
|Param 2
|colspan="2"|Time|| 30 || Time to count down.
|-
|Param 3
|colspan="2"|HUD Slot||1 - 10|| Slot to add to.
|-
|Param 4
|colspan="2"|Message|| AOE blah blah || Messahe of what the timer is for.
|-

|rowspan="2"|<center>'''OptNum'''</center>
|-
|Param 1
|colspan="2"|Option||2|| Default = 1
|rowspan="2"| Door Option to Click via #.
|-

|rowspan="2"|<center>'''Pause'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Pauses the bot.
|-

|rowspan="2"|<center>'''PetAttack'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Sends Pets into attack your current target.
|-

|rowspan="2"|<center>'''PetOff'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Back's your pet off.
|-

|rowspan="4"|<center>'''PoP_TempAdorns'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="4"| Applies temp adorns from PoP. check (ogre tempadrons) for updated versions.
|-
|Param 2
|colspan="2"|Adorn Type|| cboc, pot, hp || Type of adorn to apply.
|-
|Param 3
|colspan="2"|Overwrite||TRUE/FALSE|| Overwrite if adorn allready exists.
|-

|rowspan="4"|<center>'''PopulatePCOptionLists'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="4"| When you click on a combo box, such as the Target in the caststack, or the Follow combo on the Setup tab, it generates a list of names. These are generated from this method.
|-
|Param 2
|colspan="2"|UIBox|| 1234 || The ID of a listbox or combo box where you want the information populated
|-
|Param 3
|colspan="2"|Params||clear, !clear, me, !me, aliases, !aliases, pctarget, !pctarget, group, !group, raid, !raid, groupnotself, !groupnotself, groupmembers, !groupmembers, raidmembers, !raidmembers, forcealiases, !forcealiases, disabled, !disabled, pets, !pets|| Can be any combination. "pets" would put pets in the combo box, "!pets" would not put them in. If you use "defaults" as the first parameter, the following are set automatically: clear, me, pctarget, group, raid, groupnotself, groupmembers, raidmembers.
|-

|rowspan="2"|<center>'''PortalToGuildHall'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Uses Magic Door to the Guild Hall
|-

|rowspan="2"|<center>'''ProvingGrounds_Exit'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Exits Proving Grounds.
|-

|rowspan="2"|<center>'''ProvingGrounds_Scoreboard_Close'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| When you complete a proving grounds and get the scoreboard up, this will close it.
|-

|rowspan="2"|<center>'''Rebuff'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Cancels all your maintained abilities that appear in your spellbook.
|-

|rowspan="2"|<center>'''RedeemKrono'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Redeems/uses a krono.
|-

|rowspan="2"|<center>'''Reload_Bot'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Reloads the bot for specified.
|-

|rowspan="2"|<center>'''Reload_DevBot'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Reloads Dev Version of the bot for specified.
|-

|rowspan="2"|<center>'''ReloadExport'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Reloads your export if changes were made in xml.
|-

|rowspan="3"|<center>'''RemoveNoOffensiveOn'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="3"| Internal. Removes the internal flag of "NoOffensive" on a specific actor.
|-
|Param 2
|colspan="2"|NPC|| "Trakanon" || Actor name to remove the flag from
|-

|rowspan="2"|<center>'''RepairGear'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Repairs all your gear if near a mender.
|-

|rowspan="3"|<center>'''ReplyDialog'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="3"| Click specified option on a reply dialog window.
|-
|Param 2
|colspan="2"|Option|| 1 || Option to click. Default = 1
|-

|rowspan="2"|<center>'''Report_ClearList'''</center>
|-
|Param 1
|colspan="2"|Value||1|| Default = 1. 1 = Clear group report. 2 = clear raid report.
|rowspan="2"| Clearing a report list. These are only used in extremely specific scenarios, such as Trakanon in order to keep track of an order of Thauma's.
|-

|rowspan="2"|<center>'''Report_SpewList'''</center>
|-
|Param 1
|colspan="2"|Value||1|| Default = 1. 1 = group report. 2 = raid report.
|rowspan="2"| Sends the list to OgreConsole. These are only used in extremely specific scenarios, such as Trakanon in order to keep track of an order of Thauma's.
|-

|rowspan="2"|<center>'''ReportForList_IRC'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Sends the list to IRC. These are only used in extremely specific scenarios, such as Trakanon in order to keep track of an order of Thauma's.
|-

|rowspan="2"|<center>'''Reporting'''</center>
|-
|Param 1
|colspan="2"|Player Name||Kannkor|| Player name reporting to the report call
|rowspan="2"| This is a response to a Report call. These are only used in extremely specific scenarios, such as Trakanon in order to keep track of an order of Thauma's.
|-

|rowspan="2"|<center>'''Res'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Removes the temporary [Stop Res] flag.
|-

|rowspan="2"|<center>'''ResetActorsLooted'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Resets looted actors and tries to loot them all again. Chests/corpses etc.
|-

|rowspan="2"|<center>'''ResetCameraAngle'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Resets camera angle.
|-

|rowspan="3"|<center>'''ResetZone'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="3"| Resets specified zone.
|-
|Param 2
|colspan="2"|Zone|| "Freeport" || Name of the zone to reset.
|-

|rowspan="2"|<center>'''ResolveBuffCheck'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Checks you have Resolve buff on. ( No Longer Used)
|-

|rowspan="2"|<center>'''Resource'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Attempts to Collect the nearest resource to you.
|-

|rowspan="2"|<center>'''ResStone'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Casts a rez stone.
|-

|rowspan="2"|<center>'''Resume'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Resumes the specified bots.
|-

|rowspan="3"|<center>'''Revive'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="3"| Revives the specified bots at specified location.
|-
|Param 2
|colspan="2"|Option|| 1 || Option to choose. Default = 1
|-

|rowspan="2"|<center>'''RunWalk'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Toggles between running and walking.
|-

|rowspan="4"|<center>'''RO_FSD_BB_Brutas_NeedColdWater'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="4"| Applies specified scrolls to specified.
|-
|Param 2
|colspan="2"|Name|| "Prowess" || Name of Scroll.
|-
|Param 3
|colspan="2"|Duration|| 5 || Cancel existing if duration is less than specified.
|-

|rowspan="4"|<center>'''Send_Tell'''</center>
|-
|Param 1
|colspan="2"|Speaker|| ${Me.Nam} || Name of person sending tell.
|rowspan="4"| Sends a tell to a specified person.
|-
|Param 2
|colspan="2"|Target|| "Pork" || Person to send the tell to.
|-
|Param 3
|colspan="2"|Message|| "Pork you rock" || Message to send to specified.
|-

|rowspan="4"|<center>'''SetAutoLootMode'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="4"| Applies specified scrolls to specified.
|-
|Param 2
|colspan="2"|Option|| 0, 1, 2 || Mode to set (None, Greed, Decline).
|-
|Param 3
|colspan="2"|Silentmode|| TRUE/FALSE || Spew info to ogre console about change.
|-

|rowspan="5"|<center>'''SetCS_BehindNPC'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="5"| Sets campspot behind specified NPC.
|-
|Param 2
|colspan="2"|Name or ID|| "Trakanon" || Name of NPC.
|-
|Param 3
|colspan="2"|Distance|| 3 || Distance to CS behind. Default = 3
|-
|Param 4
|colspan="2"|Aggro|| TRUE/FALSE || Skip moving if you have aggro.
|-

|rowspan="5"|<center>'''SetCS_InFrontNPC'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="5"| Sets campspot in front of specified NPC.
|-
|Param 2
|colspan="2"|Name or ID|| "Trakanon" || Name of NPC.
|-
|Param 3
|colspan="2"|Distance|| 3 || Distance to CS infront. Default = 3
|-
|Param 4
|colspan="2"|Aggro|| TRUE/FALSE || Skip moving if you have aggro.
|-

|rowspan="5"|<center>'''SetCS_NPC'''</center>
|-
|Param 1
|colspan="2"|Angle|| 0-360 || The angle in which you want to move too.
|rowspan="5"| Sets campspot at a specific angle of specified NPC. This is mostly an internal function. It is a common function used by SetCS_InFront/BehindNPC
|-
|Param 2
|colspan="2"|Name or ID|| "Trakanon" || Name of NPC.
|-
|Param 3
|colspan="2"|Distance|| 3 || Distance to CS infront. Default = 3
|-
|Param 4
|colspan="2"|Aggro|| TRUE/FALSE || Skip moving if you have aggro.
|-

|rowspan="3"|<center>'''SetNoDefensive'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="3"| Sets an internal flag for "NoDefensive".
|-
|Param 2
|colspan="2"|Value|| TRUE/FALSE || Turns the flag on or off
|-

|rowspan="4"|<center>'''SetRelayGroup_Relay'''</center>
|-
|Param 1
|colspan="2"|RelayName|| K_Group || Relay group name.
|rowspan="4"| Relay -> Sets your relay group to specified.
|-
|Param 2
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| N/A
|-
|Param 3
|colspan="2"|Value|| relay_group_name_here || The relay group you want to use.
|-

|rowspan="3"|<center>'''SetRelayGroup'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="3"| Set relay group to specified (for you only, does not relay to everyone)
|-
|Param 2
|colspan="2"|Value|| relay_group_name_here || The relay group you want to use.
|-

|rowspan="3"|<center>'''SetRelayGroupToDefault_Relay'''</center>
|-
|Param 1
|colspan="2"|Relaygroup|| "k_Defasult" || relay group name.
|rowspan="3"| Set relay group to specified.
|-
|Param 2
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| N/A
|-

|rowspan="2"|<center>'''SetRelayGroupToDefault'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Set relay group to default.
|-

|rowspan="3"|<center>'''SetUpFor'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="3"| initiates code for a mob if code exists.
|-
|Param 2
|colspan="2"|command||Brutas|| command needed for mob in zone. ( Param 2 is not needed from ToT onwards )
|-

|rowspan="2"|<center>'''ShareAllMissions'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Shares all missions in your Journal.
|-

|rowspan="3"|<center>'''ShareMission'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="3"| Shares the specified mission only from journal.
|-
|Param 2
|colspan="2"|Mission name||"Some Mission"|| Quest name to share.
|-

|rowspan="3"|<center>'''ShareQuest'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="3"| Shares the specified Quest only from journal.
|-
|Param 2
|colspan="2"|Quest name||"Some Quest"|| Quest name to share.
|-

|rowspan="3"|<center>'''ShareQuestsForZone'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="3"| Shares the specified Zonename related Quests from journal.
|-
|Param 2
|colspan="2"|zone name||"Doomefire"|| Zone name of the quests you want to share.
|-

|rowspan="3"|<center>'''ShareQuestWhenAble'''</center>
|-
|Param 1
|colspan="2"|Quest name||"some quest"|| Name of quest to share.
|rowspan="3"| Shares the specified Zonename and specified Quest from journal when bot is not busy.
|-
|Param 2
|colspan="2"|zone name||"Doomefire"|| Zone name of the quests you want to share.
|-

|rowspan="3"|<center>'''ShowOgreConsole'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="3"| Shows or hides the ogre console.
|-
|Param 2
|colspan="2"|Show/Hide||TRUE/FALSE|| Show = TRUE etc.
|-

|rowspan="6"|<center>'''SpawnEvent_AddEntry'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="6"| Adds a spawn event to the spawn event tab.
|-
|Param 2
|colspan="2"|Text||"Trakanon stares at you"|| Must be quoted. Text to listen for.
|-
|Param 3
|colspan="2"|OC||TRUE/FALSE|| Send info to ogre console on success.
|-
|Param 4
|colspan="2"|Ding||TRUE/FALSE|| make a ding sound on success.
|-
|Param 5
|colspan="2"|Code||OgreBotAPI:Kick["all"]|| Code to trigger on success.
|-

|rowspan="3"|<center>'''SpawnEvent_RemoveEntry'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="3"| Removes a spawn entry via text in event.
|-
|Param 2
|colspan="2"|Text||"Trakanon stares at you"|| Must be quoted. Text to remove.
|-

|rowspan="2"|<center>'''Special'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Clicks nearest special from you.
|-

|rowspan="2"|<center>'''SpecialZoneSpecific'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| This will handle clicking of zone specific items. Such as the zipline in Brokenskull Bay: Hoist the Yellow Jack? [Heroic].
|-

|rowspan="4"|<center>'''SpendDeityPoints'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="4"| Spend deity points.
|-
|Param 2
|colspan="2"|Spend on||Auto, potency, crit bonus, stamina|| Deity to spend points in.
|-
|Param 3
|colspan="2"|Amount||1|| Amount of points to spend.
|-

|rowspan="2"|<center>'''Spew_RelayGroup'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Spew your relay group to console.
|-

|rowspan="2"|<center>'''SpewAbility'''</center>
|-
|Param 1
|colspan="2"|Ability||"Rescue"|| Ability name.
|rowspan="2"| Spews all information avalable for specified ability.
|-

|rowspan="2"|<center>'''Stand'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Stands all bots up.
|-

|rowspan="2"|<center>'''StopRes'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Stop rezzing.
|-

|rowspan="2"|<center>'''Summon_Familiar'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Summons your familiar.
|-

|rowspan="3"|<center>'''Target'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| N/A
|rowspan="3"| Target specified target.
|-
|Param 2
|colspan="2"|Target||"Trakanon"|| NPC to target.
|-

|rowspan="3"|<center>'''ToggleConsoleWindow'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| N/A
|rowspan="3"| Toggle console open/close.
|-
|Param 2
|colspan="2"|Show/Hide||TRUE/FALSE|| Shows or hides window.
|-

|rowspan="2"|<center>'''ToggleMainWindow'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Toggles the main UI window.
|-

|rowspan="2"|<center>'''ToggleZoneReuse'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Toggles the Zone reuse ui window.
|-

|rowspan="3"|<center>'''ToonMarked'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="3"| Spews info on marked toons to oc or irc.
|-
|Param 2
|colspan="2"|Spew to||oc, irc|| spews the info to oc or irc.
|-

|rowspan="4"|<center>'''Travel'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="4"| Travel to destination on travel map. ( Must have travel map open )
|-
|Param 2
|colspan="2"|To where||Freeport|| Name of zone to travel to.
|-
|Param 3
|colspan="2"|Exactmatch||TRUE/FALSE|| Exactmatch.
|-

|rowspan="4"|<center>'''TravelBell'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="4"| Travel to destination from bell.
|-
|Param 2
|colspan="2"|To where||Freeport|| Name of zone to travel to.
|-
|Param 3
|colspan="2"|Exactmatch||TRUE/FALSE|| Exactmatch.
|-

|rowspan="4"|<center>'''TravelDruid'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="4"| Travel to destination from druid portal.
|-
|Param 2
|colspan="2"|To where||Freeport|| Name of zone to travel to.
|-
|Param 3
|colspan="2"|Exactmatch||TRUE/FALSE|| Exactmatch.
|-

|rowspan="4"|<center>'''TravelSpires'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="4"| Travel to destination from wiz portal.
|-
|Param 2
|colspan="2"|To where||Freeport|| Name of zone to travel to.
|-
|Param 3
|colspan="2"|Exactmatch||TRUE/FALSE|| Exactmatch.
|-

|rowspan="2"|<center>'''UnmarkToon'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| UnMarks a toon.
|-

|rowspan="2"|<center>'''Unmentor'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| UnMentors specified.
|-

|rowspan="3"|<center>'''Unpack_PlanarStones'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="3"| Unpacks planar stones from PoP/CD by specified.
|-
|Param 2
|colspan="2"|Option||Lowest, Specific name|| Option of what to unpack.
|-

|rowspan="4"|<center>'''Unpack'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="4"| Unpacks specified items that have a reward choice window.
|-
|Param 2
|colspan="2"|Item Name||"Elemental Ores"|| Name of zone to travel to.
|-
|Param 3
|colspan="2"|Option||"2 Celestial Earthen Ores" or #|| Name or # to select in reward window.
|-

|rowspan="2"|<center>'''Update_Guk_Shinies'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Updates Guk shinies.
|-

|rowspan="2"|<center>'''Update_PoP_Shinies'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Updates PoP shinies.
|-

|rowspan="5"|<center>'''UplinkOptionChange'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| N/A
|rowspan="5"| Changes/interacts with a UI element.
|-
|Param 2
|colspan="2"|UI code|| "checkbox_settings_ignore" || Name of object to change (obtained via xml files)
|-
|Param 3
|colspan="2"|Value|| TRUE/FALSE/TOGGLE || N/A
|-
|Param 4
|colspan="2"|Silent|| TRUE/FALSE || Silent mode spew infor to console.
|-

|rowspan="2"|<center>'''UseFlag'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Uses/Takes flag in guild hall if flag is placed.
|-

|rowspan="3"|<center>'''UseItem_Relay'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="3"| Uses an item from inventory.
|-
|Param 2
|colspan="2"|Item Name||"Name of item"|| Name of the item to cast/use.
|-

|rowspan="3"|<center>'''UseItem'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="3"| Uses an item from inventory.
|-
|Param 2
|colspan="2"|Item Name||"Name of item"|| Name of the item to cast/use.
|-

|rowspan="4"|<center>'''UseItemOnPlayer_Relay'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| N/A
|rowspan="4"| Uses an item on a Player character.
|-
|Param 2
|colspan="2"|Item Name||"Elemental Ores"|| Name of iterm to use.
|-
|Param 3
|colspan="2"|Target||"Kannkor"|| Name of PC to cast onto.
|-

|rowspan="4"|<center>'''UseItemOnPlayer'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| N/A
|rowspan="4"| Uses an item on a Player character.
|-
|Param 2
|colspan="2"|Item Name||"Elemental Ores"|| Name of iterm to use.
|-
|Param 3
|colspan="2"|Target||"Kannkor"|| Name of PC to cast onto.
|-

|rowspan="5"|<center>'''Waypoint'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| N/A
|rowspan="5"| Puts a waypoint on your map for specified Loc.
|-
|Param 2
|colspan="2"|X|| X Cord || N/A
|-
|Param 3
|colspan="2"|Y|| Y Cord || N/A
|-
|Param 4
|colspan="2"|Z|| Z Cord || N/A
|-

|rowspan="2"|<center>'''Zone'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Will attempt to zone you.
|-

|rowspan="2"|<center>'''ZoneDoor'''</center>
|-
|Param 1
|colspan="2"|Option|| Name or # || Default = 1
|rowspan="2"| Chooses door option for all based on parameter.
|-

|rowspan="3"|<center>'''ZoneDoorForWho'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="3"| Chooses door option for all based on parameter for specified.
|-
|Param 2
|colspan="2"|Option|| Name or # || Default = 1
|-

|rowspan="5"|<center>'''ZoneInto'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| N/A
|rowspan="5"| Will zone you into specified zone.
|-
|Param 2
|colspan="2"|Zone|| "Doomefire" || Name of zone.
|-
|Param 3
|colspan="2"|ActorName|| zone_to_pof || The Actor name of the object you have to click in order to zone into the zone
|-
|Param 4
|colspan="2"|Option|| 1 || Door option #.
|-

|rowspan="2"|<center>'''ZoneReset_UpdateInfo'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Internal function to update Zone Timer information.
|-

|rowspan="2"|<center>'''ZoneResetAll'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Resets all your zone timers.
|-
|}

== Members ==

=== Usage ===

All 'members' are used in the following way: ${OgreBotAPI.MemberName[Parameters]}

* Example 1 - echo ${OgreBotAPI.AbilityReady["fighter","taunt"]}
** This would return TRUE if the character is considered a "fighter" AND if the ability "taunt" is ready (available to be cast). Otherwise returns FALSE if either one is false.
{| class="wikitable"
|-
|Example 2
if ${OgreBotAPI.AbilityReady["fighter","taunt"]}
{
;// Will only trigger this if you are a fighter and taunt is ready.
;// Code to execute if it comes back as TRUE
}
|-
|}

=== List of Members ===

* Below is a list of all available members.

{| class="wikitable"
|-
!Command
!colspan="3"|Parameters||Example||Notes||Description
|-

|rowspan="3"|<center>'''AbilityReady'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="3"| Spews info about an abilities readiness.
|-
|Param 2
|colspan="2"|Name or ID||id or name|| ID or name of ability.
|-

|rowspan="2"|<center>'''CancelCurrentCast'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Cancels current casting spell.
|-

|rowspan="2"|<center>'''CheckNoDefensiveOn'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| returns TRUE/FALSE of the internal flag 'NoDefensive'
|-

|rowspan="2"|<center>'''CheckNoOffensiveOn'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| returns TRUE/FALSE of the internal flag 'NoOffensive'
|-

|rowspan="2"|<center>'''Clean'''</center>
|-
|Param 1
|colspan="2"|Input to clean||Kannkor's battle Bot|| Cleans an input
|rowspan="2"| Some zones, I believe such as proving grounds, you can end up with some very odd names for characters, this removes it and "cleans" the input.
|-

|rowspan="2"|<center>'''CommandForMe'''</center>
|-
|Param 1
|colspan="2"|[[ForWho|ForWho]]||igw:${Me.Name}|| Default = all
|rowspan="2"| Returns TRUE if you are part of the group. Anywhere there is a "forwho", it's calling this function. You can call it directly if you wish to see the return.
|-

|rowspan="2"|<center>'''ConvertSecondsToHMS'''</center>
|-
|Param 1
|colspan="2"|Seconds||2500|| Seconds to convert.
|rowspan="2"| Converts seconds to hour, minutes, seconds.
|-

|rowspan="5"|<center>'''DetrimentalInfo'''</center>
|-
|Param 1
|colspan="2"|MainiconID|| 1002 || Main icon ID of the detriment.
|rowspan="5"| Reads information from your detrimental window (NOT maintained or Effects window) OR from an actors effect window.
|-
|Param 2
|colspan="2"|BackdropiconID|| 503 || Backdrop icon ID of the detriment.
|-
|Param 3
|colspan="2"|Name or ID|| "Trakanon" || Name of ID of Actor. Default = ${Me.ID}
|-
|Param 4
|colspan="2"|Return|| "exists", "CurrentIncrements" || Returns specified.
|-

|rowspan="3"|<center>'''Get_AbilityInfo'''</center>
|-
|Param 1
|colspan="2"|Name or ID||id or name|| ID or name of ability.
|rowspan="3"| Spews info on specified ability.
|-
|Param 2
|colspan="2"|Member|| Power || You can use any valid member for an ability. This will return whatever you want. In this case, Power of the ability.
|-

|rowspan="2"|<center>'''Get_Alias'''</center>
|-
|Param 1
|colspan="2"|Alias||*Tank|| Alias name.
|rowspan="2"| spew specified alias to console.
|-

|rowspan="2"|<center>'''Get_Alias2'''</center>
|-
|Param 1
|colspan="2"|Alias||*Tank|| Alias name.
|rowspan="2"| spew specified alias to console.
|-

|rowspan="2"|<center>'''Get_Hours'''</center>
|-
|Param 1
|colspan="2"|Seconds||2500|| Seconds to convert.
|rowspan="2"| Determines how many whole hours are in the seconds.
|-

|rowspan="2"|<center>'''Get_Minutes'''</center>
|-
|Param 1
|colspan="2"|Seconds||2500|| Seconds to convert.
|rowspan="2"| Determines how many whole minutes are in the seconds. Return can only be 0 to 59, as any value above that would be returned in Get_Hours.
|-

|rowspan="2"|<center>'''Get_Seconds'''</center>
|-
|Param 1
|colspan="2"|Seconds||2500|| Seconds to convert.
|rowspan="2"| Determines how many whole seconds are in the seconds. Return can only be 0 to 59, as any value above that would be returned in Get_Hours or Get_Minutes.
|-

|rowspan="2"|<center>'''GetAbilityID'''</center>
|-
|Param 1
|colspan="2"|Ability name||"Rescue"|| Name of ability.
|rowspan="2"| Converts name of ability into the ID.
|-

|rowspan="2"|<center>'''GetDeityPoints'''</center>
|-
|Param 1
|colspan="2"|Option||# or name|| # or name of deity to spew.
|rowspan="2"| Spews info on specified.
|-

|rowspan="2"|<center>'''GetMobID'''</center>
|-
|Param 1
|colspan="2"|NPC name||"Trakanon"|| Name of NPC.
|rowspan="2"| Converts name of npc into the ID.
|-

|rowspan="2"|<center>'''GroupInZone'''</center>
|-
|Param 1
|colspan="2"|Within||0|| Distance to check
|rowspan="2"| returns TRUE/FALSE if your entire group is within the zone and within x distance of you.
|-

|rowspan="2"|<center>'''HaveQuest'''</center>
|-
|Param 1
|colspan="2"|Quest name||"some quest"|| name of quest to check.
|rowspan="2"| checks if you have specified quest.
|-

|rowspan="2"|<center>'''HaveSickness'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Checks if you have revive sickness detriment.
|-

|rowspan="2"|<center>'''HaveMaintained'''</center>
|-
|Param 1
|colspan="2"|Args||-partial or -exact plus the name of an ability || Checks pairs of information to see if you have them maintained on you.
|rowspan="2"| Example: -exact, sprint, -partial, haste. Would check to see if you have the exact buff "Sprint" and a buff that contains "haste".
|-

|rowspan="2"|<center>'''InBattleGround'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Checks if you are in battlegrounds.
|-

|rowspan="2"|<center>'''InControlOfAssisting'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Returns TRUE/FALSE if you are in control of your own target. Generally speaking, do you have auto target enabled OR are people assisting you.
|-

|rowspan="3"|<center>'''InEQ2Chars'''</center>
|-
|Param 1
|colspan="2"|Name||"Kannkor"|| Name to check.
|rowspan="3"| Spews info on if specified in eq2chars.xml.
|-
|Param 2
|colspan="2"|Acc Info|| TRUE/FALSE || If TRUE, only returns TRUE if you have all the information for the account in the eq2chars list (IE: username and password).
|-

|rowspan="2"|<center>'''IsReady'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| returns TRUE/FALSE if OgreBot is ready to be used. This is FALSE while the bot is loading, and TRUE once loading has been completed.
|-

|rowspan="2"|<center>'''NPCUnkillableBug'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| returns TRUE/FALSE if your target has the unkillable bug.
|-

|rowspan="2"|<center>'''Paused'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Tells you if bot is paused.
|-

|rowspan="2"|<center>'''Report_Group_GetKey'''</center>
|-
|Param 1
|colspan="2"|Index||1|| Index to use.
|rowspan="2"| Gets the key of the Report_Group. These are only used in extremely specific scenarios, such as Trakanon in order to keep track of an order of Thauma's.
|-

|rowspan="2"|<center>'''Report_Group_GetValue'''</center>
|-
|Param 1
|colspan="2"|Index||1|| Index to use
|rowspan="2"| Gets the value of the Report_Group. These are only used in extremely specific scenarios, such as Trakanon in order to keep track of an order of Thauma's.
|-

|rowspan="2"|<center>'''RoomID'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Spews the Room id for the current room you are in.
|-

|rowspan="4"|<center>'''RoundNumToNearestValue'''</center>
|-
|Param 1
|colspan="2"|Health||99|| Health Percent of the Actor you want to check.
|rowspan="4"| Does math... lots of it. Determines which percent of health a mob is at, in dividers. For example, if you cared about 20% dividers, you could see which increment the mob is at. 20/40/60/80/100.
|-
|Param 2
|colspan="2"|Divider||1|| The chunks, 20 for every 20%
|-
|Param 3
|colspan="2"|Increment||0|| If you didn't want to start at 100, but you wanted to start at 95, and check every 20%, you would need to use an increment.
|-

|rowspan="3"|<center>'''SpewStat'''</center>
|-
|Param 1
|colspan="2"|command||[[SpewStats|commands]]|| specify command.
|rowspan="3"| Spews info on specified stat.
|-
|Param 2
|colspan="2"|Label|| TRUE/FALSE || Add label to info your spewing. IE: stat name.
|-

|rowspan="2"|<center>'''RoomID'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Spews info for toons that are marked or not.
|-

|rowspan="2"|<center>'''Version'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Spews info for current Version of ogrebot.
|-

|rowspan="2"|<center>'''ZoneReset_FullZoneInformationAvailable'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| returns TRUE/FALSE if the ZoneReset Data is available and been cached.
|-

|rowspan="3"|<center>'''ZoneReset_Get_ZoneData'''</center>
|-
|Param 1
|colspan="2"|collection:string||variablename|| Pass collection:string variable and it will add the data to that variable for you.
|rowspan="3"| Gets information about a zone from the zonereset cache.
|-
|Param 2
|colspan="2"|string|| "Doomfire: Vengeance of Ro" || Zone name to get
|-

|rowspan="2"|<center>'''ZoneReset_IsReady'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| If the ZoneReset cache is ready to be used
|-

|rowspan="2"|<center>'''ZoneReset_IsUpdating'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| If the ZoneReset cache is updating
|-
|}

== Camp Spot API ==

* [[API:Ogre_CampSpot|API:Ogre_CampSpot]]

OgreInstanceHelperAPI

2019-07-02T17:35:31Z

Pork: /* Functions */

== Important Note ==

*This is currently not released.
*It will be ready when its ready.

== Summary ==

* List of '''Methods''', '''Members''', '''Functions''' that are to be used with '''Ogre ic''' files.

* pre configured '''Methods''', '''Members''', '''Functions''' to make coding zones easier for people.

* If their is a command you do not understand please feel free to ask in ogre discord and someone will explain and try to word it better here in the list

* This list will grow as ogre ic grows
** If you feel something needs adding/updating feel free to ask kannkor or pork on discord.

== Methods ==

=== Usage ===

* Example 1 - Obj_OgreIH:SetCampSpot
** Would Campspot your group.
* Example 2 - Obj_OgreIH:ChangeOgreBotUIOption["checkbox_settings_movebehind",TRUE]
** Would turn on move behind in ogrebot.
*** UI Code can be grabbed from ( InnerSpace\Scripts\EQ2OgreBot\OgreUIXML.xml )

=== List of Methods ===

*Below is a list of all available methods to be used with Ogre ic

{| class="wikitable"
|-
!Command
!colspan="3"|Parameters||Example||Notes||Description
|-

|rowspan="2"|<center>'''Set_Disable_AEsEncounters'''</center>
|-
|Param 1
|colspan="2"|Disabled||TRUE/FALSE|| N/A
|rowspan="2"| Disable AOEs and Encounters for group or self if not grouped.
|-

|rowspan="2"|<center>'''ClearRelativeCampSpot'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Clears relative campspots for group or self if not grouped.
|-

|rowspan="2"|<center>'''ClearCampSpot'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Clears campspots for group or self if not grouped.
|-

|rowspan="2"|<center>'''SetCampSpot'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Sets campspot for group or self if not grouped.
|-

|rowspan="2"|<center>'''ChangeCampSpot'''</center>
|-
|Param 1
|colspan="2"|Loc||"127.084137,-180.863373,-832.558899"|| Loc to change campspot to.
|rowspan="2"| Change campspot for group or self if not grouped.
|-

|rowspan="2"|<center>'''SetUpFor'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Does a SetUpFor command for group or self if not grouped. ( Requires being Campspotted )
|-

|rowspan="2"|<center>'''Set_NoMove'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Sets NoMove for group or self if not grouped.
|-

|rowspan="2"|<center>'''Actor_Click'''</center>
|-
|Param 1
|colspan="2"|Actor||"Name" or ID|| Name or ID of actor to Click.
|rowspan="2"| Clicks an Actor for group or self if not grouped.
|-

|rowspan="2"|<center>'''Use_Item'''</center>
|-
|Param 1
|colspan="2"|Item||"Name"|| Name of item to Use.
|rowspan="2"| Uses an item from inventory for group or self if not grouped.
|-

|rowspan="2"|<center>'''LetsGo'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Hits LetsGo for group or self if not grouped.
|-

|rowspan="2"|<center>'''Jump'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| makes bots Jump. for group or self if not grouped.
|-

|rowspan="2"|<center>'''Jump_Me'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| makes only you Jump. for self Only.
|-

|rowspan="2"|<center>'''CallGH'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Calls to Guild Hall. For group or self if not grouped.
|-

|rowspan="2"|<center>'''CallHome'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Calls to Home. For group or self if not grouped.
|-

|rowspan="2"|<center>'''Tradeskill_Close'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Closes tradeskill window. For self Only.
|-

|rowspan="3"|<center>'''ChangeOgreBotUIOption'''</center>
|-
|Param 1
|colspan="2"|UI Code||"Checkbox_blah"|| UI Code/element to change from Ogrebotui.xml.
|rowspan="3"| Set a UI element in ogrebot to on/off. for group or self if not grouped.
|-
|Param 2
|colspan="2"|T or F|| TRUE/FALSE || Set UI element to on/off.
|-

|rowspan="4"|<center>'''Set_ZoneInformation'''</center>
|-
|Param 1
|colspan="2"|Zone Name||"Myrist, the Great Library"|| Zone name to set. via ${Zone.Name}.
|rowspan="4"| Sets all zone information for files usaully called from main function of script.
|-
|Param 2
|colspan="2"|Zone ShortName||"exp15_rgn_plane_of_knowledge"|| Zone Short name to set. via ${Zone.ShortName}.
|-
|Param 3
|colspan="2"|Actor|| "zone_to_poa" || Actor name to click to zone.
|-

|rowspan="2"|<center>'''Set_Debug_Mode'''</center>
|-
|Param 1
|colspan="2"|T or F|| TRUE/FALSE || N/A.
|rowspan="2"| Turn debug mode on or off. ( Very Spammy )
|-

|rowspan="2"|<center>'''Message_FailedZone'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Sends a failed message to Ogre Console with zone information.
|-

|rowspan="2"|<center>'''Message_FailedNamed'''</center>
|-
|Param 1
|colspan="2"|Named||"Trakanon"|| Name of Named.
|rowspan="2"| Sends a failed message to Ogre Console with specified named information.
|-

|rowspan="2"|<center>'''Message_FailedZoneOut'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Sends a failed message to Ogre Console with zone out information.
|-

|rowspan="2"|<center>'''Message_NamedDoesNotExistSkipping'''</center>
|-
|Param 1
|colspan="2"|Named||"Trakanon"|| Name of Named.
|rowspan="2"| Sends a Skipping message to Ogre Console with specified named information.
|-

|rowspan="2"|<center>'''Message_FailedToKill'''</center>
|-
|Param 1
|colspan="2"|Named||"Trakanon"|| Name of Named.
|rowspan="2"| Sends a failed to kill message to Ogre Console named information.
|-

|rowspan="2"|<center>'''MonkeyInMiddle'''</center>
|-
|Param 1
|colspan="2"|Range||10|| Range to spread to. Default = 10
|rowspan="2"| Set monkey in the middle by specified range. for group or self if not grouped.
|-
|}

== Members ==

=== Usage ===

{| class="wikitable"
|-
|Example 1
if ${Obj_OgreIH.Tradeskill_vis}
{
;// Will only trigger this if the tradeskill window is visible in game
;// Code to execute if it comes back as TRUE
}
Example 2
if ${Actor[id, ${Obj_OgreIH.Get_NPC_ID["Trakanon"]}](exists)}
{
;// Will only trigger this if the NPC exists
;// Code to execute if it comes back as TRUE
}
|-
|}

=== List of Members ===

*Below is a list of all available members to be used with Ogre ic

{| class="wikitable"
|-
!Command
!colspan="3"|Parameters||Example||Notes||Description
|-

|rowspan="2"|<center>'''DuoMode'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Checks if only 2 members are in group with you. For duo zones to make sure their is not more or less than 2 members in group.
|-

|rowspan="2"|<center>'''Get_NPC_ID'''</center>
|-
|Param 1
|colspan="2"|NPC||"Trakanon"|| Name of NPC.
|rowspan="2"| Gets the ID for the specified NPC.
|-

|rowspan="4"|<center>'''Get_IDFromActorQuery'''</center>
|-
|Param 1
|colspan="2"|Actor Name||"Trakanon"|| Name of Actor.
|rowspan="4"| Checks if Actor Name specified Loc exists at Loc supplied within distance supplied.
|-
|Param 2
|colspan="2"|Loc||"737.106506,411.865784,-388.380249"|| Loc to compare to.
|-
|Param 3
|colspan="2"|Distance|| 2 || Disatnce to check. Default = 2
|-

|rowspan="2"|<center>'''SoloMode'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Checks if only 1 members are in group or 1 member 1 merc. For Solo zones to make sure their is not more or less than 1 member 1 merc in group.
|-

|rowspan="2"|<center>'''Tradeskill_vis'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Checks to see if Tradeskill window is open in game.
|-
|}

== Functions ==

=== Usage ===

* Example 1 - call Obj_OgreIH.HandleAcceptReward 10
** Would accept reward windows 10 times for your group.
* Example 2 - call Obj_OgreIH.NamedSpawnWait "Trakanon" 60 "NamedNPC"
** Would wait 60 seconds or until the specified Named spawns.

=== List of Functions ===

* Below is a list of all available functions to be used with Ogre ic

{| class="wikitable"
|-
!Command
!colspan="3"|Parameters||Example||Notes||Description
|-

|rowspan="3"|<center>'''ClearTrashUntilNamedSpawns'''</center>
|-
|Param 1
|colspan="2"|NPC||"Trakanon"|| Name of NPC.
|rowspan="3"| Kill trash untill specified NPC spawns within specified distance.
|-
|Param 2
|colspan="2"|Radius||30|| Radius to check trash. Default = 30
|-

|rowspan="2"|<center>'''HandleAcceptReward'''</center>
|-
|Param 1
|colspan="2"|Max Times||10|| How many times to accept rewards #. Default = 10
|rowspan="2"| Accept rewards specified # of times. .5 second wait between each.
|-

|rowspan="4"|<center>'''NamedSpawnWait'''</center>
|-
|Param 1
|colspan="2"|NamedNPC||"Trakanon"|| Name of Actor.
|rowspan="4"| Waits specified time or untill specified name and specified Type exist as true. fail message if Named does not spawn.
|-
|Param 2
|colspan="2"|Time to wait||60 = 60 seconds|| Time to wait.
|-
|Param 3
|colspan="2"|Type|| "NamedNPC" || Type of actor your waiting for.
|-

|rowspan="2"|<center>'''RunInstanceController'''</center>
|-
|Param 1
|colspan="2"|Start point||0|| Starting point #. Default = 0
|rowspan="2"| This is automatically called by the startup routine. This starts the main function of the instance. It acts as a final place for it to end. If it succeeds/fails it gives a message.
|-

|rowspan="2"|<center>'''Reply_Option'''</center>
|-
|Param 1
|colspan="2"|Text||"I want to carry on!!!"|| Text you want to click within the reply dialog. Must be Quoted and Exact.
|rowspan="2"| Clicks a reply dialog via Text specified. self only.
|-

|rowspan="2"|<center>'''Set_PriestAscension'''</center>
|-
|Param 1
|colspan="2"|T or F|| TRUE/FALSE || N/A.
|rowspan="2"| Turn priest ascensions on/off. Also turns Combo's off.
|-

|rowspan="2"|<center>'''Set_VariousOptions'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Sets various options for solo or group content.
SOLO & DUO & Group
------------------------
Auto Target Clear
* Resume = TRUE
* Auto Target when hated = TRUE
* Move Melee = FALSE
* Move Behind = FALSE
* Move to Area = TRUE
* Ability Rotation = FALSE
* Quest Compare = FALSE
* Auto Target Enable = TRUE
* Loot = TRUE
* Auto target scan radius = 20
* Auto target scan Height = 15
* Loot Leader only enable = TRUE
* Loot Leader only smart assign = TRUE
* Loot Leader only loot everything = TRUE
* Sets Follow
* Sets assist
------------------------
SOLO Specifics
------------------------
* Disable merc support = TRUE
* Free for all Loot accept = TRUE
* Free for all Loot everything = TRUE
* Disable cast stack Items = TRUE
* Mark Toon = TRUE
------------------------
DUO Specifics
------------------------
* Mark Toon = TRUE
* Disable cast stack Items = TRUE
* Cancel and then Cast "Fount of Power"
------------------------
GROUP Specifics
------------------------
* UnMark Toon = TRUE
* Change cast stack Glacial Freeze = TRUE
* Change cast stack Absorb Magic = TRUE
|-

|rowspan="2"|<center>'''Set_Follow'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Sets follow and assist. for group and self if not grouped.
|-

|rowspan="3"|<center>'''ZoneSpecialwait'''</center>
|-
|Param 1
|colspan="2"|Wait Time||30 = 3 seconds|| Time to wait before click. Default = 30
|rowspan="3"| Hits Special Zone Specific and waits before Click and after Click for specified times for Group or self if not grouped.
|-
|Param 2
|colspan="2"|Wait Time||30 = 3 seconds|| Time to wait after click. Default = 30
|-
|}

== Notes ==

* If you feel something needs adding or changing please let us know via discord.

OgreInstanceHelperAPI

2019-07-02T17:29:28Z

Pork: Created page with "== Importent Note == *This is currently not released. *It will be ready when its ready. == Summary == * List of '''Methods''', '''Members''', '''Functions''' that are to be..."

== Importent Note ==

*This is currently not released.
*It will be ready when its ready.

== Summary ==

* List of '''Methods''', '''Members''', '''Functions''' that are to be used with '''Ogre ic''' files.

* pre configured '''Methods''', '''Members''', '''Functions''' to make coding zones easier for people.

* If their is a command you do not understand please feel free to ask in ogre discord and someone will explain and try to word it better here in the list

* This list will grow as ogre ic grows
** If you feel something needs adding/updating feel free to ask kannkor or pork on discord.

== Methods ==

=== Usage ===

* Example 1 - Obj_OgreIH:SetCampSpot
** Would Campspot your group.
* Example 2 - Obj_OgreIH:ChangeOgreBotUIOption["checkbox_settings_movebehind",TRUE]
** Would turn on move behind in ogrebot.
*** UI Code can be grabbed from ( InnerSpace\Scripts\EQ2OgreBot\OgreUIXML.xml )

=== List of Methods ===

*Below is a list of all available methods to be used with Ogre ic

{| class="wikitable"
|-
!Command
!colspan="3"|Parameters||Example||Notes||Description
|-

|rowspan="2"|<center>'''Set_Disable_AEsEncounters'''</center>
|-
|Param 1
|colspan="2"|Disabled||TRUE/FALSE|| N/A
|rowspan="2"| Disable AOEs and Encounters for group or self if not grouped.
|-

|rowspan="2"|<center>'''ClearRelativeCampSpot'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Clears relative campspots for group or self if not grouped.
|-

|rowspan="2"|<center>'''ClearCampSpot'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Clears campspots for group or self if not grouped.
|-

|rowspan="2"|<center>'''SetCampSpot'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Sets campspot for group or self if not grouped.
|-

|rowspan="2"|<center>'''ChangeCampSpot'''</center>
|-
|Param 1
|colspan="2"|Loc||"127.084137,-180.863373,-832.558899"|| Loc to change campspot to.
|rowspan="2"| Change campspot for group or self if not grouped.
|-

|rowspan="2"|<center>'''SetUpFor'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Does a SetUpFor command for group or self if not grouped. ( Requires being Campspotted )
|-

|rowspan="2"|<center>'''Set_NoMove'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Sets NoMove for group or self if not grouped.
|-

|rowspan="2"|<center>'''Actor_Click'''</center>
|-
|Param 1
|colspan="2"|Actor||"Name" or ID|| Name or ID of actor to Click.
|rowspan="2"| Clicks an Actor for group or self if not grouped.
|-

|rowspan="2"|<center>'''Use_Item'''</center>
|-
|Param 1
|colspan="2"|Item||"Name"|| Name of item to Use.
|rowspan="2"| Uses an item from inventory for group or self if not grouped.
|-

|rowspan="2"|<center>'''LetsGo'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Hits LetsGo for group or self if not grouped.
|-

|rowspan="2"|<center>'''Jump'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| makes bots Jump. for group or self if not grouped.
|-

|rowspan="2"|<center>'''Jump_Me'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| makes only you Jump. for self Only.
|-

|rowspan="2"|<center>'''CallGH'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Calls to Guild Hall. For group or self if not grouped.
|-

|rowspan="2"|<center>'''CallHome'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Calls to Home. For group or self if not grouped.
|-

|rowspan="2"|<center>'''Tradeskill_Close'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Closes tradeskill window. For self Only.
|-

|rowspan="3"|<center>'''ChangeOgreBotUIOption'''</center>
|-
|Param 1
|colspan="2"|UI Code||"Checkbox_blah"|| UI Code/element to change from Ogrebotui.xml.
|rowspan="3"| Set a UI element in ogrebot to on/off. for group or self if not grouped.
|-
|Param 2
|colspan="2"|T or F|| TRUE/FALSE || Set UI element to on/off.
|-

|rowspan="4"|<center>'''Set_ZoneInformation'''</center>
|-
|Param 1
|colspan="2"|Zone Name||"Myrist, the Great Library"|| Zone name to set. via ${Zone.Name}.
|rowspan="4"| Sets all zone information for files usaully called from main function of script.
|-
|Param 2
|colspan="2"|Zone ShortName||"exp15_rgn_plane_of_knowledge"|| Zone Short name to set. via ${Zone.ShortName}.
|-
|Param 3
|colspan="2"|Actor|| "zone_to_poa" || Actor name to click to zone.
|-

|rowspan="2"|<center>'''Set_Debug_Mode'''</center>
|-
|Param 1
|colspan="2"|T or F|| TRUE/FALSE || N/A.
|rowspan="2"| Turn debug mode on or off. ( Very Spammy )
|-

|rowspan="2"|<center>'''Message_FailedZone'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Sends a failed message to Ogre Console with zone information.
|-

|rowspan="2"|<center>'''Message_FailedNamed'''</center>
|-
|Param 1
|colspan="2"|Named||"Trakanon"|| Name of Named.
|rowspan="2"| Sends a failed message to Ogre Console with specified named information.
|-

|rowspan="2"|<center>'''Message_FailedZoneOut'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Sends a failed message to Ogre Console with zone out information.
|-

|rowspan="2"|<center>'''Message_NamedDoesNotExistSkipping'''</center>
|-
|Param 1
|colspan="2"|Named||"Trakanon"|| Name of Named.
|rowspan="2"| Sends a Skipping message to Ogre Console with specified named information.
|-

|rowspan="2"|<center>'''Message_FailedToKill'''</center>
|-
|Param 1
|colspan="2"|Named||"Trakanon"|| Name of Named.
|rowspan="2"| Sends a failed to kill message to Ogre Console named information.
|-

|rowspan="2"|<center>'''MonkeyInMiddle'''</center>
|-
|Param 1
|colspan="2"|Range||10|| Range to spread to. Default = 10
|rowspan="2"| Set monkey in the middle by specified range. for group or self if not grouped.
|-
|}

== Members ==

=== Usage ===

{| class="wikitable"
|-
|Example 1
if ${Obj_OgreIH.Tradeskill_vis}
{
;// Will only trigger this if the tradeskill window is visible in game
;// Code to execute if it comes back as TRUE
}
Example 2
if ${Actor[id, ${Obj_OgreIH.Get_NPC_ID["Trakanon"]}](exists)}
{
;// Will only trigger this if the NPC exists
;// Code to execute if it comes back as TRUE
}
|-
|}

=== List of Members ===

*Below is a list of all available members to be used with Ogre ic

{| class="wikitable"
|-
!Command
!colspan="3"|Parameters||Example||Notes||Description
|-

|rowspan="2"|<center>'''DuoMode'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Checks if only 2 members are in group with you. For duo zones to make sure their is not more or less than 2 members in group.
|-

|rowspan="2"|<center>'''Get_NPC_ID'''</center>
|-
|Param 1
|colspan="2"|NPC||"Trakanon"|| Name of NPC.
|rowspan="2"| Gets the ID for the specified NPC.
|-

|rowspan="4"|<center>'''Get_IDFromActorQuery'''</center>
|-
|Param 1
|colspan="2"|Actor Name||"Trakanon"|| Name of Actor.
|rowspan="4"| Checks if Actor Name specified Loc exists at Loc supplied within distance supplied.
|-
|Param 2
|colspan="2"|Loc||"737.106506,411.865784,-388.380249"|| Loc to compare to.
|-
|Param 3
|colspan="2"|Distance|| 2 || Disatnce to check. Default = 2
|-

|rowspan="2"|<center>'''SoloMode'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Checks if only 1 members are in group or 1 member 1 merc. For Solo zones to make sure their is not more or less than 1 member 1 merc in group.
|-

|rowspan="2"|<center>'''Tradeskill_vis'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Checks to see if Tradeskill window is open in game.
|-
|}

== Functions ==

=== Usage ===

* Example 1 - call Obj_OgreIH.HandleAcceptReward 10
** Would accept reward windows 10 times for your group.
* Example 2 - call Obj_OgreIH.NamedSpawnWait "Trakanon" 60 "NamedNPC"
** Would wait 60 seconds or until the specified Named spawns.

=== List of Functions ===

* Below is a list of all available functions to be used with Ogre ic

{| class="wikitable"
|-
!Command
!colspan="3"|Parameters||Example||Notes||Description
|-

|rowspan="3"|<center>'''ClearTrashUntilNamedSpawns'''</center>
|-
|Param 1
|colspan="2"|NPC||"Trakanon"|| Name of NPC.
|rowspan="3"| Kill trash untill specified NPC spawns within specified distance.
|-
|Param 2
|colspan="2"|Radius||30|| Radius to check trash. Default = 30
|-

|rowspan="2"|<center>'''HandleAcceptReward'''</center>
|-
|Param 1
|colspan="2"|Max Times||10|| How many times to accept rewards #. Default = 10
|rowspan="2"| Accept rewards specified # of times. .5 second wait between each.
|-

|rowspan="4"|<center>'''NamedSpawnWait'''</center>
|-
|Param 1
|colspan="2"|NamedNPC||"Trakanon"|| Name of Actor.
|rowspan="4"| Waits specified time or untill specified name and specified Type exist as true. fail message if Named does not spawn.
|-
|Param 2
|colspan="2"|Time to wait||60 = 60 seconds|| Time to wait.
|-
|Param 3
|colspan="2"|Type|| "NamedNPC" || Type of actor your waiting for.
|-

|rowspan="2"|<center>'''RunInstanceController'''</center>
|-
|Param 1
|colspan="2"|Start point||0|| Starting point #. Default = 0
|rowspan="2"| This is automatically called by the startup routine. This starts the main function of the instance. It acts as a final place for it to end. If it succeeds/fails it gives a message.
|-

|rowspan="2"|<center>'''Reply_Option'''</center>
|-
|Param 1
|colspan="2"|Text||"I want to carry on!!!"|| Text you want to click within the reply dialog. Must be Quoted and Exact.
|rowspan="2"| Clicks a reply dialog via Text specified. self only.
|-

|rowspan="2"|<center>'''Set_PriestAscension'''</center>
|-
|Param 1
|colspan="2"|T or F|| TRUE/FALSE || N/A.
|rowspan="2"| Turn priest ascensions on/off. Also turns Combo's off.
|-

|rowspan="2"|<center>'''Set_VariousOptions'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Sets various options for solo or group content.
SOLO & DUO & Group
------------------------
Auto Target Clear
* Resume = TRUE
* Auto Target when hated = TRUE
* Move Melee = FALSE
* Move Behind = FALSE
* Move to Area = TRUE
* Ability Rotation = FALSE
* Quest Compare = FALSE
* Auto Target Enable = TRUE
* Loot = TRUE
* Auto target scan radius = 20
* Auto target scan Height = 15
* Loot Leader only enable = TRUE
* Loot Leader only smart assign = TRUE
* Loot Leader only loot everything = TRUE
* Sets Follow
* Sets assist
------------------------
SOLO Specifics
------------------------
* Disable merc support = TRUE
* Free for all Loot accept = TRUE
* Free for all Loot everything = TRUE
* Disable cast stack Items = TRUE
* Mark Toon = TRUE
------------------------
DUO Specifics
------------------------
* Mark Toon = TRUE
* Disable cast stack Items = TRUE
* Cancel and then Cast "Fount of Power"
------------------------
GROUP Specifics
------------------------
* UnMark Toon = TRUE
* Change cast stack Glacial Freeze = TRUE
* Change cast stack Absorb Magic = TRUE
|-

|rowspan="2"|<center>'''Set_Follow'''</center>
|-
|Param 1
|colspan="2"|N/A||N/A|| N/A
|rowspan="2"| Sets follow and assist. for group and self if not grouped.
|-

|rowspan="3"|<center>'''ZoneSpecialwait'''</center>
|-
|Param 1
|colspan="2"|Wait Time||30 = 3 seconds|| Time to wait before click. Default = 30
|rowspan="3"| Hits Special Zone Specific and waits before Click and after Click for specified times for Group or self if not grouped.
|-
|Param 2
|colspan="2"|Wait Time||30 = 3 seconds|| Time to wait after click. Default = 30
|-
|}

== Notes ==

* If you feel something needs adding or changing please let us know via discord.

OgreBotAPI

2019-06-28T20:13:02Z

Pork: /* The basics */

== OgreBotAPI ==

OgreBotAPI is an '''A'''pplication '''P'''rogram '''I'''nterface built for people (scripters) to use various OgreBot functions.

== Usage ==
All 'methods' are called with the following syntax: OgreBotAPI:MethodName[Parameters]
* Example: method CastAbility(string _ForWho, string AbilityName)
** Would be used with the following command: OgreBotAPI:CastAbility["all","Kick"]
** This would tell OgreBot to cast "Kick" on anyone who has that ability.

All 'members' are used in the following way: ${OgreBotAPI.MemberName[Parameters]}
* Example: member:bool AbilityReady(string _ForWho, string AbilityName)
** Would be used with the following command: echo ${OgreBotAPI.AbilityReady["fighter","taunt"]}
** This would return TRUE if the character is considered a "fighter" AND if the ability "taunt" is ready (available to be cast). Otherwise returns FALSE if either one is false.

=== Note ===
For pure time sake, I'm copy/pasting this directly out of OgreBot. Most of the member/method names are pretty self explanatory. If you can't figure out what a command does feel free to ask. May update each method/member with an example if it needs additional information. 

The entire OgreBotAPI can be found in the following directory: \InnerSpace\Scripts\OgreConsole\Everquest2

=== Available methods ===
* method AcceptReward(string _ForWho="all")
* method AddNoOffensiveOn(string _ForWho=all, string _MobName, bool _ExactMatchOnly=FALSE)
* method Alias_AddEntry(string _ForWho, string _Alias, string _Value, _NoRaid=FALSE)
* method Alias_ChangeEntry(string _ForWho, string _From, string _To, bool _SilentMode=FALSE)
* method Alias_ChangeEntryAlias(string _ForWho, string _From, string _To, bool _SilentMode=FALSE)
* method Alias_RemoveEntry(string _ForWho=all, string _Text="all")
* method AltarOfTheAncients(string _ForWho=All)
* method ApplyTempAdorn(string _ForWho=all, string _Adorn="auto", string _Slot="Both")
* method ApplyVerb(string _ActorName="all", string _Verb="all")
* method ApplyVerbForWho(string _ForWho="all",string _ActorName="all", string _Verb="all")
* method Assist(string _AssistWho=${Me.Name}, string _ForWho=All)
* method AutoHunt_AddPoint(string _Value)
* method AutoHunt_ClearPoints()
* method AutoHunt_RemovePoint(string _Value)
* method AutoHunt_ScanRadius(string _ForWho=All, int _Value)
* method AutoRun(string _ForWho="all")
* method AutoTarget_SetRescanTime(string _ForWho=All, int _Value=50)
* method AutoTarget_SetScanRadius(string _ForWho=All, int _Value=50)
* method AutoTarget_SetScanHeight(string _ForWho=All, int _Value=5)
* method CallGH(string _ForWho="all")
* method CampToDesktop(string _ForWho="all")
* method CancelCurrentCast(bool _TorF=TRUE, string _CommandForMe=ALL)
* method CancelMaintained(string _AbilityName="all")
* method CastAbility(string _ForWho, string AbilityName)
* method CastAbility_Relay(string _ForWho, string AbilityName)
* method CastAbilityNoExport(string _ForWho, string _Ability)
* method CastAbilityNoExport_Relay(string _ForWho, string _Ability)
* method CastAbilityOnPlayer(string _ForWho, string AbilityName, string sTarget=${Me.Name})
* method CastAbilityOnPlayer_Relay(string _ForWho, string AbilityName, string sTarget=${Me.Name})
* method CastedCastOnTheMove(string _Caster, float _Duration)
* method CastingCastOnTheMove(float _Duration)
* method Change_FoodDrinkAutoConsume(string _ForWho, string _Value)
* method Change_PoisonAutoConsume(string _ForWho, string _Value, string Poison)
* method Change_StatPotionsAutoConsume(string _ForWho, string _Value, string _PotionName)
* method ChangeCampSpot(float _XPos, float _YPos, float _ZPos)
* method ChangeCampSpotWho(string _ForWho, float _XPos, float _YPos, float _ZPos)
* method ChangeCastStackListBoxItem(string _ForWho, string _Object, string _Value=TRUE, bool _SilentMode=FALSE)
* method ChangeRadarYAxis(string _ForWho, bool _Value)
* method ChangeZoneTo(string _ForWho, string _ToWho)
* method ChatEvent_AddEntry(string _ForWho=all, string _Text, bool _OC=FALSE , bool _Ding=FALSE, string _Code)
* method ChatEvent_RemoveEntry(string _ForWho=all, string _Text="all")
* method CheckGear(string _ForWho="all")
* method CheckMemberLevel(bool _Value=FALSE)
* method ClearNoOffensiveOn(string _ForWho=all)
* method CloseWindow(string _ForWho="all")
* method Come2Me(string _MoveTo="${Me.Name}", string _ForWho="all", float _Precision=3)
* method ConversationBubble(string _ForWho="all", int _DoorOption=1)
* method Crouch(string _ForWho="all")
* method Cursed(string _ForWho, string _Toon, bool _HardTarget=FALSE)
* method Cursed_Relay(string _ForWho, string _Toon)
* method DespawnEvent_AddEntry(string _ForWho=all, string _Text, bool _OC=FALSE , bool _Ding=FALSE, string _Code)
* method DespawnEvent_RemoveEntry(string _ForWho=all, string _Text="all")
* method Disband(string _ForWho="all")
* method Dispell(string _ForWho=All, string _Value)
* method DisplayAvailableSetups()
* method DungeonMakerCancel(string _ForWho="all")
* method End_Bot(string _ForWho=all)
* method EquipCharm(string _ForWho=all, int _Value=1)
* method Evac(string _ForWho="all")
* method FlyDown(string _ForWho="all")
* method FlyStop(string _ForWho="all")
* method FlyUp(string _ForWho="all")
* method ForceFollow(string _ForWho="all")
* method Get_CurePotions(string _ForWho, string _Value)
* method Get_FoodDrink(string _ForWho)
* method Get_FoodDrink(string _ForWho)
* method Get_Poisons(string _ForWho, string _Value)
* method Get_StatPotions(string _ForWho, string _Value)
* method GetFlag(string _ForWho="all")
* method GroupCure(string _ForWho=all)
* method GroupCure_Relay(string _ForWho)
* method Heartstone_RekindleBond(string _ForWho=all)
* method HoldUp(string _ForWho="all")
* method ImmRes(int _HowMany=2)
* method InjectChat(string _ForWho="all", string _Chat="Nothing")
* method Invite(string _ForWho=All, string _WhoToInvite, bool _RaidInvite=FALSE)
* method JoustIn(string _ForWho="all")
* method JoustOff(string _ForWho="Casters")
* method JoustOn(string _ForWho="Melee")
* method JoustOut(string _ForWho="all")
* method Jump(string _ForWho="all")
* method LetsGo(string _ForWho="all")
* method LogToonIn(string _ForWho=${Me.Name}, string _ToWho)
* method LootWindowLootAll(string _ForWho=All)
* method MakeLeader(string _ForWho=all, string _Leader=${Me.Name})
* method Mentor(string _Value=${Me.Name})
* method Message(string _ForWho, string _Message, bool _Noise=FALSE, string NoiseToPlay=Default)
* method Message_NT(string _ForWho, string _Message, bool _Noise=FALSE, string NoiseToPlay=Default)
* method Message_Relay(string _ForWho, string _Message, bool _Noise=FALSE, string NoiseToPlay=Default)
* method Mount(string _ForWho="all")
* method Move2Area(float _XPos, float _YPos, string _ForWho, float _Precision=3)
* method NoMove(string _ForWho="all")
* method NoTarget(string _ForWho="all")
* method OFolDecDistance(string _ForWho="all")
* method OFolIncDistance(string _ForWho="all")
* method OgreIRC_AuthIfInRaid(string WhoToAuth, string ToonName)
* method OnScreenTimer(string _ForWho=all, float _Time=30, int _Slot=1, string _Message=Timer:)
* method OptNum(int _DoorOption=1)
* method Pause(string _ForWho="all")
* method PetAttack(string _ForWho="all")
* method PetOff(string _ForWho="all")
* method PortalToGuildHall(string _ForWho=all)
* method Pull(string _ForWho, bool _Named=FALSE)
* method Rebuff(string _ForWho="all")
* method Reload_Bot(string _ForWho=all)
* method Reload_Bot(string _ForWho=all)
* method RemoveNoOffensiveOn(string _ForWho=all, string _MobName)
* method RepairGear(string _ForWho="all")
* method Res(string _ForWho="all")
* method ResolveBuffCheck(string _ForWho=all)
* method ResStone(string _ForWho="all")
* method Resume(string _ForWho="all")
* method Revive(string _ForWho="all")
* method RO_FSD_BB_Brutas_DoNotNeedColdWater(string _ForWho, string _Toon)
* method RO_FSD_BB_Brutas_DoNotNeedColdWater_Relay(string _ForWho, string _Toon)
* method RO_FSD_BB_Brutas_NeedColdWater(string _ForWho, string _Toon)
* method RO_FSD_BB_Brutas_NeedColdWater_Relay(string _ForWho, string _Toon)
* method RunWalk(string _ForWho="all")
* method ScrollOf(string _ForWho=all, string _ScrollName=Prowess, int _CancelIfDurationLessThan=0)
* method Send_Tell(string Speaker, string _Target, string Message)
* method SetRelayGroup(string _ForWho, string _Value)
* method SetRelayGroup_Relay(string _ForRelayGroup, string _ForWho, string _Value)
* method SetRelayGroupToDefault(string _ForWho)
* method SetRelayGroupToDefault_Relay(string _ForRelayGroup, string _ForWho)
* method SetUpFor(string _ForWho="all", string _Chat="Nothing")
* method SpawnEvent_AddEntry(string _ForWho=all, string _Text, bool _OC=FALSE , bool _Ding=FALSE, string _Code)
* method SpawnEvent_RemoveEntry(string _ForWho=all, string _Text="all")
* method Special(string _ForWho="all")
* method SpecialZoneSpecific(string _ForWho="all")
* method SpendDietyPoints(string _ForWho=All, string _SpendOn=Auto, int _Spend=1)
* method Spew_RelayGroup(string _ForWho=all)
* method SpewAbility(string AbilityName)
* method StopRes(string _ForWho="all")
* method Target(string _ForWho, string _Target)
* method ToggleConsoleWindow(string _ForWho=All, string _Value)
* method ToggleMainWindow(string _ForWho="all")
* method Travel(string _ForWho=All, string _ToWhere, bool _ExactMatch=FALSE)
* method TravelBell(string _ForWho=All, string _ToWhere=Bell)
* method TravelDruid(string _ForWho=All, string _ToWhere=Bell)
* method TravelSpires(string _ForWho=All, string _ToWhere=Bell)
* method Unmentor(string _ForWho="all")
* method UplinkOptionChange(string _ForWho, string _Object, string _Value=TRUE, bool _SilentMode=FALSE)
* method UseFlag(string _ForWho="all")
* method UseItem(string _ForWho, string AbilityName)
* method UseItem_Relay(string _ForWho, string AbilityName)
* method UseItemOnPlayer(string _ForWho, string AbilityName, string sTarget=${Me.Name})
* method UseItemOnPlayer_Relay(string _ForWho, string AbilityName, string sTarget=${Me.Name})
* method Waypoint(string _ForWho=all, float _X=0, float _Y=0, float _Z=0)
* method Zone(string _ForWho="all")
* method ZoneDoor(int _DoorOption=1)
* method ZoneDoorForWho(string _ForWho="all", int _DoorOption=1)
* method ZoneInto(string _ForWho, string _ZoneName, string _ActorName=Special, int _DoorOption=0)
* method ZoneResetAll(string _ForWho="all")

=== Available members ===
* member: bool AbilityReady(string _ForWho, string AbilityName)
* member: bool CancelCurrentCast()
* member: bool CheckNoOffensiveOn()
* member: bool CommandForMe(string _ForWho=all)
* member: bool:DevBuild
* member: bool:IsCommand[CommandToTest]
* member: bool IsReady()
* member: float64:TimeUTC
* member: int RoundNumToNearestValue(int _Health, int _Divider=1, int _IncrementBy=0)
* member: string Get_Alias(string _Alias)

=== Camp Spot API ===
* [[API:Ogre_CampSpot|API:Ogre_CampSpot]]

SpewStats

2019-06-28T20:01:32Z

Pork: Created page with "== Summary == * Spews information to ogre console or irc for specified information supplied. == Specific Lookup Options == === Usage === * '''Example:''' oc !c -spewstats a..."

== Summary ==

* Spews information to ogre console or irc for specified information supplied.

== Specific Lookup Options ==

=== Usage ===
* '''Example:''' oc !c -spewstats all "currency_Astral Gloom-Hardened Medallion" oc
** Would send how many of the specified coins you have to ogre console
*** Last paramater can be either oc or irc.
**** Must be wrapped in quotes ( "currency_Astral Gloom-Hardened Medallion" )
 

=== Options ===

* '''currency_'''
** Will open your persona window go to currency tab and scan for specified currency.
* '''faction_'''
** Will open your persona window go to faction tab and scan for specified faction.
* '''AbilityReady_'''
** Will spew time till ready or is ready for the specified ability.
* '''Item_'''
** Will spew Quantity you have in inventory for the specified item.

== Stats Options ==

=== Usage ===
* '''Example:''' oc !c -spewstats all agi oc
** Would send what agi you have to ogre console
*** Last paramater can be either oc or irc.
 

* abilitydoubleattack
* ada
* aeauto
* agi
* ascension
* ascension_exp
* ascension_exp%
* ascension_exppercent
* ascension_exptonextlevel
* ascension_level
* ascension_scrolls
* ascension_vit
* ascension_vitality
* ascension_xpremaining
* block
* cast
* cb
* cc
* critbonus
* critchance
* deity
* deity_cb
* deity_critbonus
* deity_pot
* deity_potency
* deity_stam
* deity_stamina
* deitycb
* deitypoints
* deitypot
* deitystam
* dps
* eth
* Fervor
* flurry
* fps
* haste
* int
* loyalty
* ma
* marked
* mit
* mitigation
* pot
* potency
* recovery
* resolve
* reuse
* runspeed
* sda
* sdc
* speed
* sta
* stam
* str
* wdb
* wis

== Help Options ==

=== Usage ===
* '''Example:''' oc !c -spewstats all help oc
** Would send all options available to ogre console

* help
* ?

== Notes ==

If you find a stat that is not listed please feel free to ask Pork or Kannkor on Discord about adding said stat.

OgreMerchantCraft

2019-06-28T19:43:09Z

Pork: /* Usage */

== Main Overview ==
[[File:Main Merchant Craft.png]]

== Summary ==

* Allows you to craft limited use recipes from the status merchant while standing at the merchant.

== Requirements ==

* Must have 5 AA points in crafting stations tradeskill prestige tab.
* Must have all components for the items you want to craft in your inventory.
* Must target a merchant before you run this script.

== Usage ==

* to start the script ( ogre mc / ogre merchantcraft )
* Target a merchant and then run the script.
* Select a recipe from the recipe list.
* Enter quantity you want to craft.
* Check the quantity conversion is correct.

'''Pull Items from GH'''

* Hit Update Button. ( this will poplate right side ui for you )
* Call to GH with script still running.
* Hit Get Items button to grab all the items you need from containers and fuel merchant.
* Go back the the merchant.
'''Start Crafting'''
* Hit Craft Items button to begin crafting

ISXOgre

2019-06-28T19:12:48Z

Pork:

<big>'''Welcome to Ogre Wiki.'''</big>

This page is for the Everquest 2 Ogre Adventure bot and Ogre Crafting bot.
OgreBot is a fully customizable adventure bot. OgreCraft is an advanced crafting bot.
* OgreBot and OgreCraft are part of the ISXOgre extension. However one thing to point out, ISXOgre does NOT do anything ISXEQ2 does. You REQUIRE ISXEQ2 in order to use ISXOgre.
* Lastly, ISXOgre requires a subscription, see Ogre Pricing for more details.

----

== Introduction ==

Ogrebot is a fully customizable adventure bot.

* [[WhyOgre|Why OgreBot? OgreBot vs the competition! (Adventure bot)]]

* [[WhyOgreCraft|Why OgreCraft? OgreCraft vs the competition! (Crafting bot)]]

* [[OgrePricing|Ogre Pricing]]

* [[ObtainingASubscription|How to obtain a subscription]]

* [[HowToCancelASubscription|How to cancel a subscription]]

* [[NewUserWalkthrough:Page01|New User Walkthrough]]

* [[Advanced User Tips|Advanced User Tips]] - Been with Ogre a little while now? Next Steps found here

* [[Ogre:FAQ|FAQ and Help]] - Including screen shots of examples of how to setup classes.

* [[Ogre:DidYouKnow|Did you know...]] - Random pieces of information that will help you sleep at night.

* [[ContactInfo|Contact information and Ventrilo]]

* [[RevisionHistory|Revision History]] - Here you will find the revision history. Every time a file is updated, I will do my best to include specifics of what was added, and any important details about it.
* [https://forge.isxgames.com/projects/ogrebot-eq2/issues Feature Requests] - Here you will find a list of items I have on my list to code. Some are new, some are upgrades etc.

== Ogre Bot ==

* [[Tab:Overview|Tabs]] - Click here for more information about each tab and to see screen shots.
* [[Aliases|Aliases]] - Aliases
* [[ProfileAliases|Profile Aliases]] - Aliases
* [[Raid Instances|Raid Options]] - Raid specific options
* [[Heroic Instances|Heroic Options]] - Heroic options
* [[OgreMCP|OgreMCP]] - Ogre Master Control Panel.
* [[UplinkController|Uplink Controller]] - It controls other sessions.
* [[OgreBotCommands| Ogre Commands]] - How to load Ogrebot, as well as various other commands included.
* [[OgreMapper| Ogre Mapping]] & [[Ogre Nav]] - mapping and moving
* [[OgreBotChatCommands| Ogre Chat Window Commands]] - In-game chat commands that Ogrebot responds to.
* [[OgreInfo|Ogre info | options | config]] - Loads a UI for user information and other Ogrebot options
* [[ISXOgre:MethodsAndMembers|ISXOgre methods and members]]
* [[ISXOgre:OgreProcessorlocking|Ogre Processor Locking]]
* [[OgreBot:UnfixableBugs|Unfixable bugs]]
* [[OgreEvents|OgreEvents]]
* [[Ogre Affiliates|Ogre Affiliates]] - Scripts written and hosted inside of ogre
* [[ForWho|ForWho]] - Documentation for any place you need to reference a ForWho command

== Crafting - Harvesting & Depots ==

*'''Crafting'''
** [[OgreCraft:Overview|OgreCraft]]
** [[OgreCraft:MainWindow|Tabs]]
** [[OgreCraft:MethodsandMembers|Ogre Craft Methods and Members]]

*'''Harvesting'''
** [[Ogre GoblinHousePlant|Ogre Plant]] - Manages the house plant (Kunark Ascending Crafting Quests)
** [[Ogre GatherGoblin|Ogre Goblin]] - Manages the gathering goblin
** [[OgreOther:Hirex|HireX]] - HireX is a script that allows you to run guild hall hirelings automaticaly and have them put their harvests into the GH depots.
** [[OgreMapper|Ogre Map]] - A zone mapping and WP marking tool.
** Ogre Harvest -- In the ISXEQ2 Command Window type '''Ogre Harvest'''; should be used with Ogre Map, this will allow your toons to auto harvest.

*'''Depots'''
** [[OgreOther:Depots|Depot]] - Guild Hall Depot Management and Commands

* '''Tradeskill Apprentice Managment'''
** [[OgreTradeskillApprentice|Ogre Tradeskill Apprentice]]
** [[OgreTradeskillApprenticeManager|Ogre Tradeskill Apprentice Manager (TSAM)]]

*'''Transmute'''
** In your ISXEQ2 command drop down window type Ogre Transmute - Loads the Transmute UI (supports to level 110 now)

*'''Salvage'''
** In your ISXEQ2 command drop down window type Ogre Salvage - Loads the Salvage UI (supports to level 110 now)
***Please note you must have the salvage crafting AA in order to use this option

== Faction Scripts ==

* [[OgreOther:FreeportFaction|FreeportFaction]] - Freeport faction is a script to assist in the faction part of the betrayal quest.
* [[QeynosFaction|QeynosFaction]] - Qeynos faction is a script that assist in the faction part of the betrayal quest.
* [[OgreOther:Othmir|Othmir]] - Does repeatable faction quests in Great Divide. NOTE: This script is a use-as-is. It is NOT supported or maintained.

== Heroic / Raid Scripts ==

*'''Heroic Zones'''
* [[Heroic Instances]] - Heroic specific options

*'''Raid Zones'''
* [[Raid_Instances|Raid Options]] - Raid specific options

== Other Ogre Scripts ==

* [[OgreOther:AutoLogin|AutoLogin]] - Directions to set up some Auto Login scripts that will load multiple clients including across multiple pc's.
* [[OgreOther:Item|OgreItem]] - Currently in testing, only accessible by testers. An Item Database manager to help track what characters have what items.
* [[OgreOther:InventoryManager|Old Inventory Manager]] - Used to transfer items between toons and bags. A collection of scripts used to assist with inventory management.
* [[Ogre Inventory Manager|Ogre Inventory Manager]] - Used for all your inventory Needs. Sell - Destroy - Trade - Transmute/salvage/extract and more.
* [[OgreListManager|Ogre List Manager]] - Used to create custom lists for later use in other Ogre features.
* [[OgreAscensionDailyTask|Ogre Ascension Daily Task]] - Designed to run characters to ascension trainers to get their daily scrolls.
* [[OgreProvingGroundsTheUnderdepths|Ogre Proving Grounds: The Underdepths]] - Designed to run the proving grounds solo for each of your characters automagically
* [[Ogre Boat|Ogre Boat]] - Runs the Frillik Tide key quest in OF
* [[Ogre Collection Manager|Ogre Collection Manager]] - Both depot and inventory options for managing collectibles
* [[Ogre HideEffects|Ogre HideEffects]] - Helps cut down the number of effects in your spell effects window.
* [[Ogre TrackShiny|Ogre TrackShiny]] - Helps track down shinies nearby, can sort out colors.
* [[Ogre Zone Resetter|Ogre Zone Resetter]] - Zone Resetting User Interface
* [[Ogre Export|Ogre Export]] - Exports ability information for us in Ogre Bot
* [[Ogre Ability Efficiency|Ogre Ability Efficiency]] - parse your ability export and export it
* [[Ogre TempAdorns|Ogre TempAdorns]] - Make a List and Apply the List of Temporary Adorns to a Character.
* [[OgreMerchantCraft|Ogre Merchant Craft]] - Craft limited use recipes from merchant at merchant.
* [[OgreRPC|Ogre RPC]] - Checks your Raid Armour Patterns to see what is unlocked.
* [[OgreInfuse|Ogre Infuse]] - Infuse items Automatically with infusers or Plat.
* [[OgreSpewStats|Ogre Spew Stats]] - Spews info to Ogre console Multiple uses see page for details.
* [[OgreAdorns|Ogre Adorns]] - Scans your inventory and Equipment and compares in a UI.
* [[OgreExperiment|Ogre Experiment]] - Loads a UI so you can make a list of items to experiment on and choose stats etc.

* [[Miscellaneous Scripts|Miscellaneous Scripts]] - This page is for other smaller Ogre scripts to be compiled

== OgreIRC ==

* [[OgreIRC:OgreIRC|OgreIRC]] - OgreIRC is a IRC plugin that hooks into the uplink and allows control of some functions inside sessions.

== Script Developers ==

* [[SpewStats|Spew Stats]] - A list of all spewstats options
* [[OgreBotAPI|OgreBotAPI]] - Methods & Members for scriptwriters to utilise
* [[OgreInstanceHelperAPI|Ogre Instance Helper API]] - Methods & Members for scriptwriters to utilise when making instance files
* [[OgreUtilitiesAPI|Ogre Utilities API]] - Methods & Members for scriptwriters to utilise when making instance files or local scripts

Tab:CastStack

2019-06-27T22:44:10Z

Pork: /* Checkboxes */

== Tab Summary ==

This tab is the replacement for CAs, and all other tabs removed in v17.

[[File:Cast Stack Tab.png]]

== Notes ==

'''Abilities added will be ran in a top-down order, as they are available.'''

== Adding Abilities ==

To add an ability, select it from the left side list, select the Type of ability it is, then select the options specific to the ability. Below is a list of those options. Once you have all Checkboxes/Options filled out, click Add Entry. Once an ability has been added, it can be moved up/down the list by holding left click and dragging.

''If CA or NamedCA, you do not need to specify a target''

''If Combat, you must specify a target''

''If NonNamedCA, This will only be used on non-named.''

'' 'Debuff' and 'NamedDebuff' allow you (and the bot) to turn on/off debuffing. '''
*Example of usage: You may put non-damaging abilities in here. Then when that character has to kill a mob by themselves, and you don't want them debuffing, just killing it, can now easily disable debuffs.

''If Heal or PowerHeal, you must select a Target, and at what percent it should go off. If you select a single person instead of @Group, it will ignore the # of people to heal, since that doesn't make sense. You either want it to look at the group (in which case you'd use @Group), or you want it to look at a single person and ignore the #.''

''If Buff, you may or may not need to select a target, if the dropdown option is visible, then you must select a target.''

''If NonCombatBuff, you may or may not need to select a target, if the dropdown option is visible, then you must select a target.''

''If Cure, you may or may not need to select a target, if the dropdown option is visible, then you must select a target. If you select a single person instead of @Group, it will ignore the # of people to heal, since that doesn't make sense. You either want it to look at the group (in which case you'd use @Group), or you want it to look at a single person and ignore the #.''

== Checkboxes ==

* '''[ID]Ignore Duration''' - Will use abilities as they are available, overwriting existing instances. Ogre detects duration of all abilities in the new Ability Export, so it shouldn't be necessary to use this much, unless for instance, you have a dot that ends up doing more damage if you refresh before it expires.
* '''[IE]Ignore Encounter Nukes''' - When enabled, will cast Green AEs even when fighting a single mob.
* '''[IAE]Ignore Encounter Nukes''' - When enabled, will cast Blue AEs even when fighting a single mob
* '''[MAX]Max Increments''' - Will only use the ability once it is at max increments.
* '''[Named]Named NPCs Only''' - Will only cast the spell when a NamedNPC is your target.
** Checking this means ONLY use that entry if you have a Named NPC as your target (or implied target).
** Checking this serves NO purpose for Types that already have 'Named' in them, such as 'NamedCA' or 'NamedDebuff'.
** The intended use for this, is to allow Type of Combat to be specified to use with a named mob only.
** This works the same way NamedCA from the dropdown works Main use would be Combat, Heal, Buff etc.
* '''[RIE]Requires Item Equipped''' - Only visible when adding an item to CastStack, If the item requires you to be wearing it to use, then you need to tick this option.

== Textboxes ==

* '''# of ppl:'''
** CA/NamedCA - Will fire the spell via the number or engaged npcs with you.
*** This requires that you have AE Smart Nukes Enabled on Tab [[Tab:Settings|Settings]]
** Heal/Rez - Will fire the spell via the number entered for heals, Rezzes etc.
* '''Fervor'''
** '''Fervor <''' - will fire the Ability if Fervor is at or below entered amount.
** '''Fervor >''' - will fire the Ability if Fervor is at or Above entered amount.
* '''Dissonance''' ( Channeler Only )
** '''Dissonance <=''' - Only use when you have less than or equal to X Dissonance.
** '''Dissonance >=''' - Only use when you have greater than or equal to X Dissonance.
* '''Savagery''' ( Beastlord Only )
** '''Savagery Required''' - A slider to adjust the savagery level required to use an ability.
* '''My HP'''
** '''My HP <''' - will fire the Ability if your HP is at or below entered amount.
** '''My HP >''' - will fire the Ability if your HP is at or Above entered amount.
* '''My MP'''
** '''My MP <''' - will fire the Ability if your MP is at or below entered amount.
** '''My MP >''' - will fire the Ability if your MP is at or Above entered amount.
* '''NPC HP'''
** '''NPC HP <''' - will fire the Ability if NPC HP is at or below entered amount.
** '''NPC HP >''' - will fire the Ability if NPC HP is at or Above entered amount.
* '''Aggro'''
** '''Aggro <''' - will fire the Ability if your Aggro to mob is at or below entered amount.
** '''Aggro >''' - will fire the Ability if your Aggro to mob is at or Above entered amount.
* '''Custom Tag'''
** Allows you to Put a Custom Tag onto an ability so you can enable/Disable them in cast stack easily via MCP button or code.

ISXOgre

2019-06-27T19:35:07Z

Pork: /* Other Ogre Scripts */

<big>'''Welcome to Ogre Wiki.'''</big>

This page is for the Everquest 2 Ogre Adventure bot and Ogre Crafting bot.
OgreBot is a fully customizable adventure bot. OgreCraft is an advanced crafting bot.
* OgreBot and OgreCraft are part of the ISXOgre extension. However one thing to point out, ISXOgre does NOT do anything ISXEQ2 does. You REQUIRE ISXEQ2 in order to use ISXOgre.
* Lastly, ISXOgre requires a subscription, see Ogre Pricing for more details.

----

== Introduction ==

Ogrebot is a fully customizable adventure bot.

* [[WhyOgre|Why OgreBot? OgreBot vs the competition! (Adventure bot)]]

* [[WhyOgreCraft|Why OgreCraft? OgreCraft vs the competition! (Crafting bot)]]

* [[OgrePricing|Ogre Pricing]]

* [[ObtainingASubscription|How to obtain a subscription]]

* [[HowToCancelASubscription|How to cancel a subscription]]

* [[NewUserWalkthrough:Page01|New User Walkthrough]]

* [[Advanced User Tips|Advanced User Tips]] - Been with Ogre a little while now? Next Steps found here

* [[Ogre:FAQ|FAQ and Help]] - Including screen shots of examples of how to setup classes.

* [[Ogre:DidYouKnow|Did you know...]] - Random pieces of information that will help you sleep at night.

* [[ContactInfo|Contact information and Ventrilo]]

* [[RevisionHistory|Revision History]] - Here you will find the revision history. Every time a file is updated, I will do my best to include specifics of what was added, and any important details about it.
* [https://forge.isxgames.com/projects/ogrebot-eq2/issues Feature Requests] - Here you will find a list of items I have on my list to code. Some are new, some are upgrades etc.

* [[OgreBotAPI|OgreBotAPI - For scripters]]

== Ogre Bot ==

* [[Tab:Overview|Tabs]] - Click here for more information about each tab and to see screen shots.
* [[Aliases|Aliases]] - Aliases
* [[ProfileAliases|Profile Aliases]] - Aliases
* [[Raid Instances|Raid Options]] - Raid specific options
* [[Heroic Instances|Heroic Options]] - Heroic options
* [[OgreMCP|OgreMCP]] - Ogre Master Control Panel.
* [[UplinkController|Uplink Controller]] - It controls other sessions.
* [[OgreBotCommands| Ogre Commands]] - How to load Ogrebot, as well as various other commands included.
* [[OgreMapper| Ogre Mapping]] & [[Ogre Nav]] - mapping and moving
* [[OgreBotChatCommands| Ogre Chat Window Commands]] - In-game chat commands that Ogrebot responds to.
* [[OgreInfo|Ogre info | options | config]] - Loads a UI for user information and other Ogrebot options
* [[ISXOgre:MethodsAndMembers|ISXOgre methods and members]]
* [[ISXOgre:OgreProcessorlocking|Ogre Processor Locking]]
* [[OgreBot:UnfixableBugs|Unfixable bugs]]
* [[OgreEvents|OgreEvents]]
* [[Ogre Affiliates|Ogre Affiliates]] - Scripts written and hosted inside of ogre
* [[ForWho|ForWho]] - Documentation for any place you need to reference a ForWho command

== Crafting - Harvesting & Depots ==

*'''Crafting'''
** [[OgreCraft:Overview|OgreCraft]]
** [[OgreCraft:MainWindow|Tabs]]
** [[OgreCraft:MethodsandMembers|Ogre Craft Methods and Members]]

*'''Harvesting'''
** [[Ogre GoblinHousePlant|Ogre Plant]] - Manages the house plant (Kunark Ascending Crafting Quests)
** [[Ogre GatherGoblin|Ogre Goblin]] - Manages the gathering goblin
** [[OgreOther:Hirex|HireX]] - HireX is a script that allows you to run guild hall hirelings automaticaly and have them put their harvests into the GH depots.
** [[OgreMapper|Ogre Map]] - A zone mapping and WP marking tool.
** Ogre Harvest -- In the ISXEQ2 Command Window type '''Ogre Harvest'''; should be used with Ogre Map, this will allow your toons to auto harvest.

*'''Depots'''
** [[OgreOther:Depots|Depot]] - Guild Hall Depot Management and Commands

* '''Tradeskill Apprentice Managment'''
** [[OgreTradeskillApprentice|Ogre Tradeskill Apprentice]]
** [[OgreTradeskillApprenticeManager|Ogre Tradeskill Apprentice Manager (TSAM)]]

*'''Transmute'''
** In your ISXEQ2 command drop down window type Ogre Transmute - Loads the Transmute UI (supports to level 110 now)

*'''Salvage'''
** In your ISXEQ2 command drop down window type Ogre Salvage - Loads the Salvage UI (supports to level 110 now)
***Please note you must have the salvage crafting AA in order to use this option

== Faction Scripts ==

* [[OgreOther:FreeportFaction|FreeportFaction]] - Freeport faction is a script to assist in the faction part of the betrayal quest.
* [[QeynosFaction|QeynosFaction]] - Qeynos faction is a script that assist in the faction part of the betrayal quest.
* [[OgreOther:Othmir|Othmir]] - Does repeatable faction quests in Great Divide. NOTE: This script is a use-as-is. It is NOT supported or maintained.

== Heroic / Raid Scripts ==

*'''Heroic Zones'''
* [[Heroic Instances]] - Heroic specific options

*'''Raid Zones'''
* [[Raid_Instances|Raid Options]] - Raid specific options

== Other Ogre Scripts ==

* [[OgreOther:AutoLogin|AutoLogin]] - Directions to set up some Auto Login scripts that will load multiple clients including across multiple pc's.
* [[OgreOther:Item|OgreItem]] - Currently in testing, only accessible by testers. An Item Database manager to help track what characters have what items.
* [[OgreOther:InventoryManager|Old Inventory Manager]] - Used to transfer items between toons and bags. A collection of scripts used to assist with inventory management.
* [[Ogre Inventory Manager|Ogre Inventory Manager]] - Used for all your inventory Needs. Sell - Destroy - Trade - Transmute/salvage/extract and more.
* [[OgreListManager|Ogre List Manager]] - Used to create custom lists for later use in other Ogre features.
* [[OgreAscensionDailyTask|Ogre Ascension Daily Task]] - Designed to run characters to ascension trainers to get their daily scrolls.
* [[OgreProvingGroundsTheUnderdepths|Ogre Proving Grounds: The Underdepths]] - Designed to run the proving grounds solo for each of your characters automagically
* [[Ogre Boat|Ogre Boat]] - Runs the Frillik Tide key quest in OF
* [[Ogre Collection Manager|Ogre Collection Manager]] - Both depot and inventory options for managing collectibles
* [[Ogre HideEffects|Ogre HideEffects]] - Helps cut down the number of effects in your spell effects window.
* [[Ogre TrackShiny|Ogre TrackShiny]] - Helps track down shinies nearby, can sort out colors.
* [[Ogre Zone Resetter|Ogre Zone Resetter]] - Zone Resetting User Interface
* [[Ogre Export|Ogre Export]] - Exports ability information for us in Ogre Bot
* [[Ogre Ability Efficiency|Ogre Ability Efficiency]] - parse your ability export and export it
* [[Ogre TempAdorns|Ogre TempAdorns]] - Make a List and Apply the List of Temporary Adorns to a Character.
* [[OgreMerchantCraft|Ogre Merchant Craft]] - Craft limited use recipes from merchant at merchant.
* [[OgreRPC|Ogre RPC]] - Checks your Raid Armour Patterns to see what is unlocked.
* [[OgreInfuse|Ogre Infuse]] - Infuse items Automatically with infusers or Plat.
* [[OgreSpewStats|Ogre Spew Stats]] - Spews info to Ogre console Multiple uses see page for details.
* [[OgreAdorns|Ogre Adorns]] - Scans your inventory and Equipment and compares in a UI.
* [[OgreExperiment|Ogre Experiment]] - Loads a UI so you can make a list of items to experiment on and choose stats etc.

* [[Miscellaneous Scripts|Miscellaneous Scripts]] - This page is for other smaller Ogre scripts to be compiled

== OgreIRC ==

* [[OgreIRC:OgreIRC|OgreIRC]] - OgreIRC is a IRC plugin that hooks into the uplink and allows control of some functions inside sessions.

OgreExperiment

2019-06-27T19:34:36Z

Pork: Created page with "== Main Overview == Coming to an ogre Dev build for you soon! == Summary =="

== Main Overview ==

Coming to an ogre Dev build for you soon!

== Summary ==

OgreRPC

2019-06-27T19:32:04Z

Pork: Created page with "== Main Overview == File:Main Ogre RPC.png == Summary == * Scans inventory and merchant to determine what unlocks you have. * Also compares what you have equipped to wha..."

== Main Overview ==
[[File:Main Ogre RPC.png]]

== Summary ==

* Scans inventory and merchant to determine what unlocks you have.
* Also compares what you have equipped to what you have unlocked in right List.

== Requirements ==

* Must be standing next to Armour merchant.

== Usage ==

* Run the script and wait.

== Notes ==

* Will need updating each expac feel free to PM Pork or Kannkor on Discord if outdated for a while.

OgreAdorns

2019-06-27T19:27:47Z

Pork: Created page with "== Main Overview == File:Main Ogre Adorns.png == Summary == * Scans you inventory and Equipment for current adorns and lists them all into a listbox. * highlights adorns..."

== Main Overview ==
[[File:Main Ogre Adorns.png]]

== Summary ==

* Scans you inventory and Equipment for current adorns and lists them all into a listbox.
* highlights adorns on right list green if you have them.
* Used mainly for seeing what you have equipped and were.

== Requirements ==

* Must have an adorn =P

== Usage ==

* Run the script and wait for UI.

== Notes ==

* Will need updating each expac feel free to PM Pork or Kannkor on Discord if outdated for a while.

OgreInfuse

2019-06-27T19:15:15Z

Pork: Created page with "== Main Overview == File:Main Ogre Infuse.png == Summary == * Allows you to Infuse equiped gear with infusers and plat. == Usage == * Add items you want to infuse to..."

OgreMerchantCraft

2019-06-27T18:49:46Z

Pork: Created page with "== Main Overview == File:Main Merchant Craft.png == Summary == * Allows you to craft limited use recipes from the status merchant while standing at the merchant. == Req..."

== Main Overview ==
[[File:Main Merchant Craft.png]]

== Summary ==

* Allows you to craft limited use recipes from the status merchant while standing at the merchant.

== Requirements ==

* Must have 5 AA points in crafting stations tradeskill prestige tab.
* Must have all components for the items you want to craft in your inventory.
* Must target a merchant before you run this script.

== Usage ==

* Target a merchant and then run the script.
* Select a recipe from the recipe list.
* Enter quantity you want to craft.
* Check the quantity conversion is correct.

'''Pull Items from GH'''

* Hit Update Button. ( this will poplate right side ui for you )
* Call to GH with script still running.
* Hit Get Items button to grab all the items you need from containers and fuel merchant.
* Go back the the merchant.
'''Start Crafting'''
* Hit Craft Items button to begin crafting

File:Main Ogre RPC.png

2019-06-27T18:23:04Z

Pork:

File:Main Ogre Infuse.png

2019-06-27T18:22:50Z

Pork:

File:Main Ogre Adorns.png

2019-06-27T18:22:40Z

Pork: