Difference between revisions of "OgreAPI"
From ISXOgre\EverQuest1
(Created page with "== OgreAPI == OgreAPI is an easy way for various functions of Ogrebot to be exposed to the outside world. === Methods === * PopulateTargetLists(uint UIBox, ... Params) ** Th...") |
(→OgreAPI) |
||
| (6 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
OgreAPI is an easy way for various functions of Ogrebot to be exposed to the outside world. | OgreAPI is an easy way for various functions of Ogrebot to be exposed to the outside world. | ||
| + | Global TLO is: OgreBotAPI | ||
=== Methods === | === 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. | *** 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 | ||
| + | ==== Set_ShowMiniWindow(bool) ==== | ||
| + | * Sets if the mini window is shown (The small window with Pause/Resume). | ||
| + | ==== ToggleMiniWindow ==== | ||
| + | * Toggles the mini window, being shown, or hidden. This is based off of the button. | ||
| + | ==== Set_ShowMainWindow(bool) ==== | ||
| + | * Sets if the Main window is shown. | ||
| + | ==== ToggleMainWindow ==== | ||
| + | * Toggles the main window, being shown, or hidden. This is based off of the button. | ||
| + | |||
| + | === Members === | ||
| + | ==== bool IsPaused ==== | ||
| + | * Returns if Ogrebot is paused. | ||
Latest revision as of 01:15, 11 September 2014
Contents
OgreAPI
OgreAPI is an easy way for various functions of Ogrebot to be exposed to the outside world.
Global TLO is: OgreBotAPI
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.
- all
Set_Paused(bool)
- Sets Ogrebot to be paused, or unpaused
TogglePause
- Toggles Ogrebot's paused status
Set_ShowMiniWindow(bool)
- Sets if the mini window is shown (The small window with Pause/Resume).
ToggleMiniWindow
- Toggles the mini window, being shown, or hidden. This is based off of the button.
Set_ShowMainWindow(bool)
- Sets if the Main window is shown.
ToggleMainWindow
- Toggles the main window, being shown, or hidden. This is based off of the button.
Members
bool IsPaused
- Returns if Ogrebot is paused.
