Difference between revisions of "OgreAPI"

From ISXOgre\EverQuest1
Jump to: navigation, search
Line 6: Line 6:
 
=== Methods ===
 
=== Methods ===
 
==== PopulateTargetLists(uint UIBox, ... Params) ====
 
==== PopulateTargetLists(uint UIBox, ... Params) ====
** This method clears out the combo/list box, then adds anything you add from below.
+
This method clears out the combo/list box, then adds anything you add from below.
** UIBox is the ID of the listbox that will be updated.
+
* UIBox is the ID of the listbox that will be updated.
** Params accepts the following. Note: Any command with a prefix of "-", means to remove it.
+
* Params accepts the following. Note: Any command with a prefix of "-", means to remove it.
*** all
+
** all
**** Adds all options below
+
*** Adds all options below
*** ShowGroup | -ShowGroup
+
** ShowGroup | -ShowGroup
**** Adds/Removes @Group from the list
+
*** Adds/Removes @Group from the list
*** ShowRaid| -ShowRaid
+
** ShowRaid| -ShowRaid
**** Adds/Removes @Raid from the list
+
*** Adds/Removes @Raid from the list
*** ShowMe| -ShowMe
+
** ShowMe| -ShowMe
**** Adds/Removes @Me from the list
+
*** Adds/Removes @Me from the list
*** ShowGroupPCs| -ShowGroupPCs
+
** ShowGroupPCs| -ShowGroupPCs
**** Adds/Removes individual group member names from the list
+
*** Adds/Removes individual group member names from the list
*** ShowRaidPCs| -ShowRaidPCs
+
** ShowRaidPCs| -ShowRaidPCs
**** Adds/Removes individual raid member names from the list
+
*** Adds/Removes individual raid member names from the list
*** ShowPets| -ShowPets
+
** ShowPets| -ShowPets
**** Adds/Removes individual pet names from the list, based on ShowGroupPCs and ShowRaidPCs.
+
*** Adds/Removes individual pet names from the list, based on ShowGroupPCs and ShowRaidPCs.
**** Note: If you do not have [Enable Pets in Drop Downs] checked, pets will not be displayed.
+
*** Note: If you do not have [Enable Pets in Drop Downs] checked, pets will not be displayed.
*** ShowPCTarget| -ShowPCTarget
+
** ShowPCTarget| -ShowPCTarget
**** Adds/Removes @PCTarget from the list. This basically means if you have a player targeted, it uses that player as the target.
+
*** Adds/Removes @PCTarget from the list. This basically means if you have a player targeted, it uses that player as the target.
**** Requires [Enable Aliases] to be checked.
+
*** Requires [Enable Aliases] to be checked.
 +
==== Set_Paused(bool) ====
 +
* Sets Ogrebot to be paused, or unpaused
 +
==== TogglePause ====
 +
* Toggles Ogrebot's paused status
 +
=== Members ===
 +
==== bool IsPaused ====
 +
* Returns if Ogrebot is paused.

Revision as of 23:51, 10 September 2014

OgreAPI

OgreAPI is an easy way for various functions of Ogrebot to be exposed to the outside world.

Global TLO is: OgreAPI

Methods

PopulateTargetLists(uint UIBox, ... Params)

This method clears out the combo/list box, then adds anything you add from below.

  • UIBox is the ID of the listbox that will be updated.
  • Params accepts the following. Note: Any command with a prefix of "-", means to remove it.
    • all
      • Adds all options below
    • ShowGroup | -ShowGroup
      • Adds/Removes @Group from the list
    • ShowRaid| -ShowRaid
      • Adds/Removes @Raid from the list
    • ShowMe| -ShowMe
      • Adds/Removes @Me from the list
    • ShowGroupPCs| -ShowGroupPCs
      • Adds/Removes individual group member names from the list
    • ShowRaidPCs| -ShowRaidPCs
      • Adds/Removes individual raid member names from the list
    • ShowPets| -ShowPets
      • Adds/Removes individual pet names from the list, based on ShowGroupPCs and ShowRaidPCs.
      • Note: If you do not have [Enable Pets in Drop Downs] checked, pets will not be displayed.
    • ShowPCTarget| -ShowPCTarget
      • Adds/Removes @PCTarget from the list. This basically means if you have a player targeted, it uses that player as the target.
      • Requires [Enable Aliases] to be checked.

Set_Paused(bool)

  • Sets Ogrebot to be paused, or unpaused

TogglePause

  • Toggles Ogrebot's paused status

Members

bool IsPaused

  • Returns if Ogrebot is paused.