OgreBotAPI

From ISXOgre
Jump to: navigation, search

OgreBotAPI

OgreBotAPI is an Application Program Interface 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.
Command Parameters Example Notes Description
AcceptReward
Param 1 ForWho igw:${Me.Name} Default = all Allows options for choosing rewards where there are actually options.
Param 2 Selection 2 Leaving Parameter 2 blank or 0, will NOT accept a choice window.
Actor_Click
Param 1 ForWho igw:${Me.Name} Default = all DoubleClicks an Actor if in range.
Param 2 Actor Name "Mechanical Travel Gear" Actor Name Must be Quoted
Param 3 ExactName TRUE/FALSE FALSE if looking for Partial name TRUE if Looking for Exactname
AddNoOffensiveOn
Param 1 ForWho igw:${Me.Name} Default = all 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 Actor Name "Trakanon" Actor Name Must be Quoted
Param 3 Exact Match Only TRUE/FALSE If FALSE, will allow partial searches.
Alias_AddEntry
Param 1 ForWho igw:${Me.Name} N/A Adds an entry to your alias tab.
Param 2 Alias *Tank what you want alias to be called
Param 3 Toon Name Kannkor Name of toon to add
Param 4 NoRaid TRUE/FALSE If you want to prevent it from scanning the raid, use TRUE (NoRaid=TRUE). Default is FALSE.
Alias_ChangeEntry
Param 1 ForWho igw:${Me.Name} Changes a toon name entry in your alias tab.
Param 2 From Kannkor Name of toon to change
Param 3 To Pork Name of toon to change to
Param 4 Silent TRUE/FALSE TRUE spews change to ogre console FALSE does not spew change
Alias_ChangeEntryAlias
Param 1 ForWho igw:${Me.Name} N/A Changes an alias entry in your alias tab.
Param 2 From *Tank Alias entry to change
Param 3 To *King Alias entry to change to
Param 4 Silent TRUE/FALSE TRUE spews change to ogre console FALSE does not spew change
Alias_RemoveEntry
Param 1 ForWho igw:${Me.Name} Default = all Removes an alias entry in your alias tab.
Param 2 Alias *Tank Alias entry to remove
AltarOfTheAncients
Param 1 ForWho igw:${Me.Name} Default = all Clicks the Alter of the Ancients - ToT preorder clicky.
Announce_AddEntry
Param 1 ForWho igw:${Me.Name} Default = all Adds an announce to the announce tab.
Param 2 Ability Name Rescue Ability to trigger the announce
Param 3 Announce to Raid Announce to what channel
Param 4 Text to announce Using *Ability* on *Target* Text you would like to announce
ApplyTempAdorn
Param 1 ForWho igw:${Me.Name} Default = all Applies temporary adornments. ( No Longer used )
Param 2 Adorn Name "Adorn of Crit" Adorn to apply
Param 3 Slots "Primary", "chest", "Both" what slots to apply to.
ApplyVerb
Param 1 Actor Name "Mechanical Travel Gear" Actor name must be Quoted Clicks a rightclick option on an actor.
Param 2 Verb "Travel to the Planes" Verb from rightclicking the actor must be Quoted
ApplyVerbForWho
Param 1 ForWho igw:${Me.Name} Default = all Clicks an actor via Rightclick options.
Param 2 Actor Name "Mechanical Travel Gear" Actor name must be Quoted
Param 3 Verb "Travel to the Planes" Verb from rightclicking the actor must be Quoted
ApplyVerbQueuedForWho
Param 1 ForWho igw:${Me.Name} Default = all Queues a Click of an actor via Rightclick options.
Param 2 Actor Name "Mechanical Travel Gear" Actor name must be Quoted
Param 3 Verb "Travel to the Planes" Verb from rightclicking the actor must be Quoted
ArcannaseEffigyOfRebirth
Param 1 ForWho igw:${Me.Name} Default = all Clicks the Arcannase Effigy Of Rebirth - KA preorder clicky.
AscensionEmbargo_Add_DoNotCombo
Param 1 ForWho igw:${Me.Name} Default = all Adds an ability to the Do Not combo list for Ascension Embargo
Param 2 Ability "Wildfire" Ability name to add
AscensionEmbargo_Change_Disable_Status
Param 1 ForWho igw:${Me.Name} Default = all Changing Ascension Embargo status. From Enabled to Disabled or vice versa.
Param 2 Ability Name Wildfire Ability name to add
Param 3 Object Value TRUE/FALSE/Toggle Changes the value to true/false or toggles from it's current value.
Param 4 Silent mode TRUE/FALSE TRUE spews change to ogre console FALSE does not spew change
AscensionEmbargo_Remove_DoNotCombo
Param 1 ForWho igw:${Me.Name} Default = all Removes an ability from the Do Not combo list for Ascension Embargo
Param 2 Ability "Wildfire" Ability name to remove
Assist
Param 1 Assist Who "Kannkor" Target to Assist. Makes you Assist specified target.
Param 2 ForWho igw:${Me.Name} Default = ${Me.Name}
AutoHunt_AddPath
Param 1 Path name "harvest" Loads a path in combobox for autohunt Adds the path name specified to autohunt.
AutoHunt_AddPoint
Param 1 Path name "harvestloc1" Add nav point to list Adds the point from path name specified to autohunt.
AutoHunt_CheckHP
Param 1 ForWho igw:${Me.Name} Default = all Adds Specified amount of HP to textbox in autohunt
Param 2 HP Value 80 Sets HP in autohunt
AutoHunt_CheckMana
Param 1 ForWho igw:${Me.Name} Default = all Adds Specified amount of MP to textbox in autohunt
Param 2 MP Value 80 Sets MP in autohunt
AutoHunt_ClearPoints
N/A N/A N/A N/A Clears all Path points from autohunt
AutoHunt_RemovePoint
Param 1 Point name "harvestloc1" Remove specified point from list Removes the point from path name specified to autohunt.
AutoHunt_ScanRadius
Param 1 ForWho igw:${Me.Name} Default = all Sets the scan radius within autohunt
Param 2 Raduis value 20 Sets scan raduis by specified distance
AutoRun
Param 1 ForWho igw:${Me.Name} Default = all Toggles auto run on and off
AutoTarget_SetRescanTime
Param 1 ForWho igw:${Me.Name} Default = all Sets the rescan time for autotarget
Param 2 Rescan Time 500 Sets rescan time by specified value
AutoTarget_SetScanHeight
Param 1 ForWho igw:${Me.Name} Default = all Sets the scan Height for autotarget
Param 2 Scan Height 50 Sets scan Height by specified value
AutoTarget_SetScanRadius
Param 1 ForWho igw:${Me.Name} Default = all Sets the Scan Radius for autotarget
Param 2 Scan Radius 50 Sets Scan Radius by specified value
CallGH
Param 1 ForWho igw:${Me.Name} Default = all Calls you to Guild Hall
CampToDesktop
Param 1 ForWho igw:${Me.Name} Default = all Camps sessions to Desktop or loginscene
Param 2 Login only TRUE/FALSE if set TRUE will camp you to loginscene
CancelCasting
Param 1 ForWho igw:${Me.Name} Default = all Cancels what you are currently casting
CancelCurrentCast
Param 1 T or F TRUE/FALSE if set TRUE will cancel cast Cancels what you are currently casting
Param 2 ForWho igw:${Me.Name} Default = all
CancelMaintained
Param 1 Args Ability Names Ability Names separated by commas. Example: OgreBotAPI:CancelMaintained["Sprint","AbilityName2Here","AbilityName3Here"] Cancels maintaned spells/effects
CancelMaintainedForWho
Param 1 ForWho igw:${Me.Name} Default = all Cancels maintaned spells/effects
Param 2 Args Ability Names Ability Names separated by commas. Example: OgreBotAPI:CancelMaintained["Sprint","AbilityName2Here","AbilityName3Here"]
CastAbility_Relay
Param 1 ForWho igw:${Me.Name} N/A Casts the specified ability
Param 2 Ability Name "Rending" Ability name to be cast
CastAbility
Param 1 ForWho igw:${Me.Name} N/A Casts the specified ability
Param 2 Ability Name "Rending" Ability name to be cast
CastAbilityInSeconds_Relay
Param 1 ForWho igw:${Me.Name} N/A Casts the specified ability after specified amount of time
Param 2 Ability Name "Rending" Ability name to be cast
Param 3 seconds to wait 10 Seconds to wait to cast ability
CastAbilityInSeconds
Param 1 ForWho igw:${Me.Name} N/A Casts the specified ability after specified amount of time
Param 2 Ability Name "Rending" Ability name to be cast
Param 3 seconds to wait 10 Seconds to wait to cast ability
CastAbilityNoChecks
Param 1 ForWho igw:${Me.Name} N/A Casts an ability skipping all checks in the bot.
Param 2 Ability Name "Rending" Ability name to be cast
CastAbilityNoExport_Relay
Param 1 ForWho igw:${Me.Name} N/A Casts an ability without it being within your export.
Param 2 Ability Name "Rending" Ability name to be cast
CastAbilityNoExport
Param 1 ForWho igw:${Me.Name} N/A Casts an ability without it being within your export.
Param 2 Ability Name "Rending" Ability name to be cast
CastAbilityNoExportUntilCast
Param 1 ForWho igw:${Me.Name} N/A Casts an ability without it being within your export and waits till the ability is cast.
Param 2 Ability Name "Rending" Ability name to be cast
CastAbilityOnNPC
Param 1 ForWho igw:${Me.Name} N/A Casts an ability on specified Actor.
Param 2 Ability Name "Rending" Ability name to be cast
Param 3 Actor Name "Trakanon" Actor name to cast ability on
CastAbilityOnPlayer_Relay
Param 1 ForWho igw:${Me.Name} N/A Casts an ability on specified player character.
Param 2 Ability Name "Rending" Ability name to be cast
Param 3 Player Name "Kannkor" Player Character name to cast ability on
CastAbilityOnPlayer
Param 1 ForWho igw:${Me.Name} N/A Casts an ability on specified player character in specified seconds to wait.
Param 2 Ability Name "Rending" Ability name to be cast
Param 3 Player Name "Kannkor" Player Character name to cast ability on
Param 4 Seconds to wait 10 time to wait before casting ability on player character
CastHQEar
N/A N/A N/A N/A Casts the HQ Ear from KA HQ.
CastedCastOnTheMove
Param 1 Player Character "Kannkor" Name of the Player who casted a cast on the move ability Internal option. Passes information in your group if they are allowed to cast while moving.
Param 2 Duration 10.5 Duration of the ability that gives the cast while moving.
CastingCastOnTheMove
Param 1 Duration 10.5 Duration of the ability that gives the cast while moving. Internal use. This sends out information that you casted a cast while moving buff for the group.
Change_FoodDrinkAutoConsume
Param 1 ForWho igw:${Me.Name} N/A Sets food & drink autoconsume to on/off.
Param 2 T F T TRUE/FALSE/TOGGLE sets food & drink autoconsume to specified
Change_PoisonAutoConsume
Param 1 ForWho igw:${Me.Name} N/A Sets specified poison autoconsume to specified.
Param 2 T F T TRUE/FALSE/TOGGLE sets poison autoconsume to specified
Param 3 Poison name "Marked Target" name of the poison you want to change.
Change_StatPotionsAutoConsume
Param 1 ForWho igw:${Me.Name} N/A Sets specified stat potion autoconsume to specified.
Param 2 T F T TRUE/FALSE/TOGGLE sets stat potion autoconsume to specified
Param 3 Stat Potion name "intelect" name of the stat potion you want to change.
ChangeCampSpotWho
Param 1 ForWho igw:${Me.Name} N/A Changes campspot to specified XYZ Cordinates.
Param 2 X X Cord N/A
Param 3 Y Y Cord N/A
Param 4 Z Z Cord N/A
ChangeCampSpot
Param 1 X X Cord N/A Changes campspot to specified XYZ Cordinates.
Param 2 Y Y Cord N/A
Param 3 Z Z Cord N/A
ChangeCastStackListBoxItem
Param 1 ForWho igw:${Me.Name} N/A Changes a cast stack item to on/off.
Param 2 Ability name "Rending" name of ability in the cast stack to change
Param 3 T F T TRUE/FALSE/TOGGLE Changes cast stack item to specified
Param 4 Silent mode TRUE/FALSE TRUE spews change to ogre console FALSE does not spew change
ChangeCastStackListBoxItemByTag
Param 1 ForWho igw:${Me.Name} N/A Changes a cast stack item to on/off via Custom Tag.
Param 2 Tag name "Threat" name of the custom Tag to change
Param 3 T F T TRUE/FALSE/TOGGLE Changes cast stack item to specified
Param 4 Partial TRUE/FALSE If TRUE, allows substring search. If FALSE, exact tag match only.
Param 5 Silent mode TRUE/FALSE TRUE spews change to ogre console FALSE does not spew change
ChangeLootOptions
Param 1 ForWho igw:${Me.Name} Default = all Changes loot options to specified.
Param 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.
ChangeOgreBotUIOption
Param 1 ForWho igw:${Me.Name} N/A Changes a ui element.
Param 2 UI code "checkbox_settings_grindoptions" change ui checkbox to specified.
Param 3 T F T TRUE/FALSE/TOGGLE Changes ui checkbox to specified
Param 4 Silent mode TRUE/FALSE TRUE spews change to ogre console FALSE does not spew change
ChangeRadarYAxis
Param 1 ForWho igw:${Me.Name} N/A Changes Y axis to specified.
Param 2 T F TRUE/FALSE Changes Y axis on radar to on/off
ChangeZoneTo
Param 1 ForWho igw:${Me.Name} N/A Changes your zone to specified player character.
Param 2 Player character "Kannkor" Name of character to change zone to
ChatEvent_AddEntry
Param 1 ForWho igw:${Me.Name} Default = all Adds a chatevent to chat event tab.
Param 2 Text "Trakanon looks at you" Text to listen for to trigger
Param 3 ogre console TRUE/FALSE spew infor to Ogre console on success
Param 4 Ding Sound TRUE/FALSE Will cause the bot to Ding on success
Param 5 Code OgreBotAPI:Jump[${Me.Name}] Code to execute on success.
ChatEvent_RemoveEntry
Param 1 ForWho igw:${Me.Name} Default = all Removes chat trigger from chat events tab.
Param 2 Text "Trakanon looks at you" Text of trigger to remove
CheckGear
Param 1 ForWho igw:${Me.Name} Default = all Checks armour condition.
CheckKunarkAscendingRequirements
Param 1 ForWho igw:${Me.Name} Default = all Checks for any missing KA sigline quests.
CheckMemberLevel
Param 1 T F TRUE/FALSE OnlyShowNonMembers. Default FALSE. If set to TRUE, will only if you are NOT a member. Checks your membership level ( Silver, Gold, Member ).
CheckResearch
Param 1 ForWho igw:${Me.Name} Default = all Checks your current research time and spews to ogre console.
Param 2 Report TRUE/FALSE FALSE will only spew info if research complete.
ClearNoOffensiveOn
Param 1 ForWho igw:${Me.Name} Default = all Clears the internal 'NoOffensive' flag. This should not be used.
CloseWindow
Param 1 ForWho igw:${Me.Name} Default = all Closes the top EQ2 UI window
Come2Me
Param 1 PC to move to "${Me.Name}" Target to move to. Default = ${Me.Name} Moves bots to specified player
Param 2 ForWho igw:${Me.Name} Default = all
Param 3 Precision 3 Precision to move into range. Default = 3
ConsumeDeityBaubles
Param 1 ForWho igw:${Me.Name} Default = all Consumes deity bubbles in inventory for you.
ConversationBubble
Param 1 ForWho igw:${Me.Name} Default = all Clicks a conversation bubble via specified #.
Param 2 Option 1 conversation bubble to click via #
Crouch
Param 1 ForWho igw:${Me.Name} Default = all Crouches you.
DailyEtherealMissionReset
Param 1 N/A N/A N/A Spews info to ogre console on when daily missions reset and what current missions are.
DeleteQuest
Param 1 ForWho igw:${Me.Name} Default = all Deletes a quest from your journal.
Param 2 Quest Name "quest name" Must be quoted.
DespawnEvent_AddEntry
Param 1 ForWho igw:${Me.Name} Default = all Adds a despawn event to the despawn event tab.
Param 2 Text "Trakanon stares at you" Must be quoted. Text to listen for.
Param 3 OC TRUE/FALSE Send info to ogre console on success.
Param 4 Ding TRUE/FALSE make a ding sound on success.
Param 5 Code OgreBotAPI:Kick["all"] Code to trigger on success.
DespawnEvent_RemoveEntry
Param 1 ForWho igw:${Me.Name} Default = all Removes a despawn entry via text in event.
Param 2 Text "Trakanon stares at you" Must be quoted. Text to remove.
Disband
Param 1 ForWho igw:${Me.Name} Default = all Disbands you from group or raid.
Dispell
Param 1 ForWho igw:${Me.Name} Default = all Casts 'Dispell' (Usually enchanter Absorb magic) on an NPC.
Param 2 NPC To Dispell "Trakanon" Name of the NPC to dispell
DisplayAvailableSetups
Param 1 N/A N/A N/A Displays all Setups for the current zone into ogre console.
DisplayEtherealMissionInfo
Param 1 ForWho igw:${Me.Name} Default = all Spews info to ogre console on when daily missions reset and what current missions are.
DisplayMyAscensionCombos
Param 1 N/A N/A N/A Displays your current ascension combos into IS console.
DungeonMakerCancel
Param 1 ForWho igw:${Me.Name} Default = all Presses the "Cancel" button in Dungeon Maker. (not really appliciable anymore)
End_Bot
Param 1 ForWho igw:${Me.Name} Default = all Ends Ogre Bot.
EquipCharm
Param 1 ForWho igw:${Me.Name} Default = all Equips a charm by specified value. via the equipment info tab.
Param 2 value 1 or 2 Charm to equip.
Evac
Param 1 ForWho igw:${Me.Name} Default = all Anyone with an evacuate ability will use it.
F2PWindow_Check
Param 1 ForWho igw:${Me.Name} Default = all Does a check to see if the f2p window is open, and closes it.
F2PWindow_SetOptions
Param 1 ForWho igw:${Me.Name} Default = all Tells Ogrebot to check for the F2PWindow again for <Minutes>.
Param 2 Minutes 15 How many Minutes to wait.
FastTravel
Param 1 ForWho igw:${Me.Name} Default = all Uses Fast travel if you are a member.
Param 2 Location Freeport Location name.
Param 3 Exact Match TRUE/FALSE Default = FALSE
FlyDown
Param 1 ForWho igw:${Me.Name} Default = all Makes you Fly/Swim Down. This is a Toggle use FlyStop to stop.
FlyStop
Param 1 ForWho igw:${Me.Name} Default = all Stops you from flying/swimming up/down.
FlyUp
Param 1 ForWho igw:${Me.Name} Default = all Makes you Fly/Swim Up. This is a Toggle use FlyStop to stop.
Force_MountOn
Param 1 ForWho igw:${Me.Name} Default = all This will recast your mount regardless if you have it on or not.
ForceFollow
Param 1 ForWho igw:${Me.Name} Default = all Forces toons to follow you.
Get_CurePotions
Param 1 ForWho igw:${Me.Name} Default = all Will pull 100 of the specified from poision potion depot if you have under 100 in inventory.
Param 2 Value "Acerbic Elixir of Intellect" Potion name. Must be Quoted.
Get_Faction
Param 1 Faction "Exile" Faction name. Must be Quoted. Gets your current specified faction and spews info to ogre console.
Param 2 Spewto oc or irc spew info to ogreconsole or irc
Get_FoodDrink
Param 1 ForWho igw:${Me.Name} N/A Will pull and equip current food and drink you have in slots.
Get_Poisons
Param 1 ForWho igw:${Me.Name} N/A Will pull 100 of the specified from poision potion depot if you have under 100 in inventory.
Param 2 Value "Marked Target" Poison name. Must be Quoted.
Get_StatPotions
Param 1 ForWho igw:${Me.Name} N/A Will pull 100 of the specified from poision potion depot if you have under 100 in inventory.
Param 2 Value "Arebic Intelect" Potion name. Must be Quoted.
GetFlag
Param 1 ForWho igw:${Me.Name} Default = all Grabs a Guild Hall flag from the npc in Guild Hall.
GroupCure_Relay
Param 1 ForWho igw:${Me.Name} N/A Makes bots group cure if they have a group cure.
GroupCure
Param 1 ForWho igw:${Me.Name} Default = all Makes bots group cure if they have a group cure.
GuidedAscension
Param 1 ForWho igw:${Me.Name} Default = all Uses Guided Ascension Scrolls
Param 2 Amount 3000000 (3 million) Must have less than this much vitality to consume scroll.
HailNPC
Param 1 ForWho igw:${Me.Name} Default = all Hails specified npc.
Param 2 Name or ID "Trakanon" Name or ID of npc to hail.
Heartstone_RekindleBond
Param 1 ForWho igw:${Me.Name} Default = all Clicks hearstone item to refresh heartbound.
HoldUp
Param 1 ForWho igw:${Me.Name} Default = all Turns autofollow off.
HQEar_Recheck
Param 1 ForWho igw:${Me.Name} Default = all Re Checks HQ ear from KA and applies buff if not already on.
HQEar_ReEquipOriginalEar
Param 1 ForWho igw:${Me.Name} Default = all Re Checks HQ ear is not equiped and equips original if it is if it can.
ImmRes
Param 1 How many 2 # of people to check are dead to use. Uses Cleric AA Immaculate Revival if X people are dead.
Invite
Param 1 ForWho igw:${Me.Name} Default = all Invites specified to group or raid.
Param 2 PC Name "Kannkor" Player character to invite.
Param 3 Raid invite TRUE/FALSE invite to group or raid Default = FALSE = group
ItemDebug
Param 1 Item Name "Buckler of blah" Name of item. Must be Quoted. Debugs item specified and spews info to console.
JoustIn
Param 1 ForWho igw:${Me.Name} Default = all Jousts in specifeid to engaged mob from campspot. requires move behind or move into melee enabled & campspot.
JoustOff
Param 1 ForWho igw:${Me.Name} Default = Casters turns jousting off for specifeid. requires move behind or move into melee enabled & campspot.
JoustOn
Param 1 ForWho igw:${Me.Name} Default = Melee turns jousting on for specifeid. requires move behind or move into melee enabled & campspot.
JoustOut
Param 1 ForWho igw:${Me.Name} Default = all Jousts out specifeid to engaged mob from campspot. requires move behind or move into melee enabled & campspot.
Jump
Param 1 ForWho igw:${Me.Name} Default = all Tells specified to Jump.
LetsGo
Param 1 ForWho igw:${Me.Name} Default = all Removes movement restrictions such as HoldUp and campspot.
LogToonIn
Param 1 ForWho igw:${Me.Name} Default = ${Me.Name} Logs in specified player character.
Param 2 PC "Kannkor" Player character to log in.
Loot_SmartAssign_Add
Param 1 N/A N/A N/A Generates the Values in smartloot xml for PoP expac mount parts
Loot_SmartAssign_Update
Param 1 N/A N/A N/A Updates the Values in smartloot xml for PoP expac mount parts
LootWindowLootAll
Param 1 ForWho igw:${Me.Name} Default = all Loots all items in a loot window.
MakeLeader
Param 1 ForWho igw:${Me.Name} Default = ${Me.Name} Changes the group leader to specified.
Param 2 Leader "Kannkor" Player character to make leader. Default = ${Me.Name}
MarkToon
Param 1 ForWho igw:${Me.Name} Default = all Marks a toon for specific ogre set up operations.
Mentor
Param 1 Mentor PC "Kannkor" Default = ${Me.Name} Mentor specified pc.
Message_NT
Param 1 ForWho igw:${Me.Name} N/A Sends a message to ogre console for specified only with a noise & no Time stamp.
Param 2 Message Kannkor sucks Message to send.
Param 3 Noise TRUE/FALSE Make a noise.
Param 4 Noise default or loud Noise type. Default = default
Message_Relay
Param 1 ForWho igw:${Me.Name} N/A Sends a message to all sessions ogre console with a noise.
Param 2 Message Kannkor sucks Message to send.
Param 3 Noise TRUE/FALSE Make a noise.
Param 4 Noise default or loud Noise type. Default = default
Message
Param 1 ForWho igw:${Me.Name} N/A ends a message to ogre console for specified only with a noise.
Param 2 Message Kannkor sucks Message to send.
Param 3 Noise TRUE/FALSE Make a noise.
Param 4 Noise default or loud Noise type. Default = default
Mount
Param 1 ForWho igw:${Me.Name} Default = all Clicks the mount ability. If you have a mount it will cancel it. If you do not have a mount it will summon it.
Move2Area
Param 1 X X Cord N/A tells bots to move to a specific player character.
Param 2 Y Y Cord N/A
Param 3 ForWho igw:${Me.Name} N/A
Param 4 Precision 3 Precision to target . Default = 3
NoMove
Param 1 ForWho igw:${Me.Name} Default = all Prevents incombat movement such as move into melee range and move behind.
NoTarget
Param 1 ForWho igw:${Me.Name} Default = all Clears everyones target.
OFolDecDistance
Param 1 ForWho igw:${Me.Name} Default = all Decreases the distance of OgreFollow.
OFolIncDistance
Param 1 ForWho igw:${Me.Name} Default = all Increases the distance of OgreFollow.
OgreIRC_AuthIfInRaid
Param 1 ForWho igw:${Me.Name} N/A Autherise if in raid for specified.
Param 2 PC Name "Pork" Player character to auth.
OnScreenTimer
Param 1 ForWho igw:${Me.Name} Default = all Puts a HUD onscreen with a timer on your screen like group HUD.
Param 2 Time 30 Time to count down.
Param 3 HUD Slot 1 - 10 Slot to add to.
Param 4 Message AOE blah blah Messahe of what the timer is for.
OptNum
Param 1 Option 2 Default = 1 Door Option to Click via #.
Pause
Param 1 ForWho igw:${Me.Name} Default = all Pauses the bot.
PetAttack
Param 1 ForWho igw:${Me.Name} Default = all Sends Pets into attack your current target.
PetOff
Param 1 ForWho igw:${Me.Name} Default = all Back's your pet off.
PoP_TempAdorns
Param 1 ForWho igw:${Me.Name} Default = all Applies temp adorns from PoP. check (ogre tempadrons) for updated versions.
Param 2 Adorn Type cboc, pot, hp Type of adorn to apply.
Param 3 Overwrite TRUE/FALSE Overwrite if adorn allready exists.
PopulatePCOptionLists
Param 1 ForWho igw:${Me.Name} Default = all 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 UIBox 1234 The ID of a listbox or combo box where you want the information populated
Param 3 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.
PortalToGuildHall
Param 1 ForWho igw:${Me.Name} Default = all Uses Magic Door to the Guild Hall
ProvingGrounds_Exit
Param 1 ForWho igw:${Me.Name} Default = all Exits Proving Grounds.
ProvingGrounds_Scoreboard_Close
Param 1 ForWho igw:${Me.Name} Default = all When you complete a proving grounds and get the scoreboard up, this will close it.
Rebuff
Param 1 ForWho igw:${Me.Name} Default = all Cancels all your maintained abilities that appear in your spellbook.
RedeemKrono
Param 1 ForWho igw:${Me.Name} Default = all Redeems/uses a krono.
Reload_Bot
Param 1 ForWho igw:${Me.Name} Default = all Reloads the bot for specified.
Reload_DevBot
Param 1 ForWho igw:${Me.Name} Default = all Reloads Dev Version of the bot for specified.
ReloadExport
Param 1 N/A N/A N/A Reloads your export if changes were made in xml.
RemoveNoOffensiveOn
Param 1 ForWho igw:${Me.Name} Default = all Internal. Removes the internal flag of "NoOffensive" on a specific actor.
Param 2 NPC "Trakanon" Actor name to remove the flag from
RepairGear
Param 1 ForWho igw:${Me.Name} Default = all Repairs all your gear if near a mender.
ReplyDialog
Param 1 ForWho igw:${Me.Name} Default = all Click specified option on a reply dialog window.
Param 2 Option 1 Option to click. Default = 1
Report_ClearList
Param 1 Value 1 Default = 1. 1 = Clear group report. 2 = clear raid report. 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.
Report_SpewList
Param 1 Value 1 Default = 1. 1 = group report. 2 = raid report. 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.
ReportForList_IRC
Param 1 ForWho igw:${Me.Name} Default = all 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.
Reporting
Param 1 Player Name Kannkor Player name reporting to the report call 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.
Res
Param 1 ForWho igw:${Me.Name} Default = all Removes the temporary [Stop Res] flag.
ResetActorsLooted
Param 1 ForWho igw:${Me.Name} Default = all Resets looted actors and tries to loot them all again. Chests/corpses etc.
ResetCameraAngle
Param 1 ForWho igw:${Me.Name} Default = all Resets camera angle.
ResetZone
Param 1 ForWho igw:${Me.Name} Default = all Resets specified zone.
Param 2 Zone "Freeport" Name of the zone to reset.
ResolveBuffCheck
Param 1 ForWho igw:${Me.Name} Default = all Checks you have Resolve buff on. ( No Longer Used)
Resource
Param 1 ForWho igw:${Me.Name} Default = all Attempts to Collect the nearest resource to you.
ResStone
Param 1 ForWho igw:${Me.Name} Default = all Casts a rez stone.
Resume
Param 1 ForWho igw:${Me.Name} Default = all Resumes the specified bots.
Revive
Param 1 ForWho igw:${Me.Name} Default = all Revives the specified bots at specified location.
Param 2 Option 1 Option to choose. Default = 1
RunWalk
Param 1 ForWho igw:${Me.Name} Default = all Toggles between running and walking.
RO_FSD_BB_Brutas_NeedColdWater
Param 1 ForWho igw:${Me.Name} Default = all Applies specified scrolls to specified.
Param 2 Name "Prowess" Name of Scroll.
Param 3 Duration 5 Cancel existing if duration is less than specified.
Send_Tell
Param 1 Speaker ${Me.Nam} Name of person sending tell. Sends a tell to a specified person.
Param 2 Target "Pork" Person to send the tell to.
Param 3 Message "Pork you rock" Message to send to specified.
SetAutoLootMode
Param 1 ForWho igw:${Me.Name} Default = all Applies specified scrolls to specified.
Param 2 Option 0, 1, 2 Mode to set (None, Greed, Decline).
Param 3 Silentmode TRUE/FALSE Spew info to ogre console about change.
SetCS_BehindNPC
Param 1 ForWho igw:${Me.Name} Default = all Sets campspot behind specified NPC.
Param 2 Name or ID "Trakanon" Name of NPC.
Param 3 Distance 3 Distance to CS behind. Default = 3
Param 4 Aggro TRUE/FALSE Skip moving if you have aggro.
SetCS_InFrontNPC
Param 1 ForWho igw:${Me.Name} Default = all Sets campspot in front of specified NPC.
Param 2 Name or ID "Trakanon" Name of NPC.
Param 3 Distance 3 Distance to CS infront. Default = 3
Param 4 Aggro TRUE/FALSE Skip moving if you have aggro.
SetCS_NPC
Param 1 Angle 0-360 The angle in which you want to move too. 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 Name or ID "Trakanon" Name of NPC.
Param 3 Distance 3 Distance to CS infront. Default = 3
Param 4 Aggro TRUE/FALSE Skip moving if you have aggro.
SetNoDefensive
Param 1 ForWho igw:${Me.Name} Default = all Sets an internal flag for "NoDefensive".
Param 2 Value TRUE/FALSE Turns the flag on or off
SetRelayGroup_Relay
Param 1 RelayName K_Group Relay group name. Relay -> Sets your relay group to specified.
Param 2 ForWho igw:${Me.Name} N/A
Param 3 Value relay_group_name_here The relay group you want to use.
SetRelayGroup
Param 1 ForWho igw:${Me.Name} Default = all Set relay group to specified (for you only, does not relay to everyone)
Param 2 Value relay_group_name_here The relay group you want to use.
SetRelayGroupToDefault_Relay
Param 1 Relaygroup "k_Defasult" relay group name. Set relay group to specified.
Param 2 ForWho igw:${Me.Name} N/A
SetRelayGroupToDefault
Param 1 ForWho igw:${Me.Name} Default = all Set relay group to default.
SetUpFor
Param 1 ForWho igw:${Me.Name} Default = all initiates code for a mob if code exists.
Param 2 command Brutas command needed for mob in zone. ( Param 2 is not needed from ToT onwards )
ShareAllMissions
Param 1 ForWho igw:${Me.Name} Default = all Shares all missions in your Journal.
ShareMission
Param 1 ForWho igw:${Me.Name} Default = all Shares the specified mission only from journal.
Param 2 Mission name "Some Mission" Quest name to share.
ShareQuest
Param 1 ForWho igw:${Me.Name} Default = all Shares the specified Quest only from journal.
Param 2 Quest name "Some Quest" Quest name to share.
ShareQuestsForZone
Param 1 ForWho igw:${Me.Name} Default = all Shares the specified Zonename related Quests from journal.
Param 2 zone name "Doomefire" Zone name of the quests you want to share.
ShareQuestWhenAble
Param 1 Quest name "some quest" Name of quest to share. Shares the specified Zonename and specified Quest from journal when bot is not busy.
Param 2 zone name "Doomefire" Zone name of the quests you want to share.
ShowOgreConsole
Param 1 ForWho igw:${Me.Name} Default = all Shows or hides the ogre console.
Param 2 Show/Hide TRUE/FALSE Show = TRUE etc.
SpawnEvent_AddEntry
Param 1 ForWho igw:${Me.Name} Default = all Adds a spawn event to the spawn event tab.
Param 2 Text "Trakanon stares at you" Must be quoted. Text to listen for.
Param 3 OC TRUE/FALSE Send info to ogre console on success.
Param 4 Ding TRUE/FALSE make a ding sound on success.
Param 5 Code OgreBotAPI:Kick["all"] Code to trigger on success.
SpawnEvent_RemoveEntry
Param 1 ForWho igw:${Me.Name} Default = all Removes a spawn entry via text in event.
Param 2 Text "Trakanon stares at you" Must be quoted. Text to remove.
Special
Param 1 ForWho igw:${Me.Name} Default = all Clicks nearest special from you.
SpecialZoneSpecific
Param 1 ForWho igw:${Me.Name} Default = all This will handle clicking of zone specific items. Such as the zipline in Brokenskull Bay: Hoist the Yellow Jack? [Heroic].
SpendDeityPoints
Param 1 ForWho igw:${Me.Name} Default = all Spend deity points.
Param 2 Spend on Auto, potency, crit bonus, stamina Deity to spend points in.
Param 3 Amount 1 Amount of points to spend.
Spew_RelayGroup
Param 1 ForWho igw:${Me.Name} Default = all Spew your relay group to console.
SpewAbility
Param 1 Ability "Rescue" Ability name. Spews all information avalable for specified ability.
Stand
Param 1 ForWho igw:${Me.Name} Default = all Stands all bots up.
StopRes
Param 1 ForWho igw:${Me.Name} Default = all Stop rezzing.
Summon_Familiar
Param 1 ForWho igw:${Me.Name} Default = all Summons your familiar.
Target
Param 1 ForWho igw:${Me.Name} N/A Target specified target.
Param 2 Target "Trakanon" NPC to target.
ToggleConsoleWindow
Param 1 ForWho igw:${Me.Name} N/A Toggle console open/close.
Param 2 Show/Hide TRUE/FALSE Shows or hides window.
ToggleMainWindow
Param 1 ForWho igw:${Me.Name} Default = all Toggles the main UI window.
ToggleZoneReuse
Param 1 ForWho igw:${Me.Name} Default = all Toggles the Zone reuse ui window.
ToonMarked
Param 1 ForWho igw:${Me.Name} Default = all Spews info on marked toons to oc or irc.
Param 2 Spew to oc, irc spews the info to oc or irc.
Travel
Param 1 ForWho igw:${Me.Name} Default = all Travel to destination on travel map. ( Must have travel map open )
Param 2 To where Freeport Name of zone to travel to.
Param 3 Exactmatch TRUE/FALSE Exactmatch.
TravelBell
Param 1 ForWho igw:${Me.Name} Default = all Travel to destination from bell.
Param 2 To where Freeport Name of zone to travel to.
Param 3 Exactmatch TRUE/FALSE Exactmatch.
TravelDruid
Param 1 ForWho igw:${Me.Name} Default = all Travel to destination from druid portal.
Param 2 To where Freeport Name of zone to travel to.
Param 3 Exactmatch TRUE/FALSE Exactmatch.
TravelSpires
Param 1 ForWho igw:${Me.Name} Default = all Travel to destination from wiz portal.
Param 2 To where Freeport Name of zone to travel to.
Param 3 Exactmatch TRUE/FALSE Exactmatch.
UnmarkToon
Param 1 ForWho igw:${Me.Name} Default = all UnMarks a toon.
Unmentor
Param 1 ForWho igw:${Me.Name} Default = all UnMentors specified.
Unpack_PlanarStones
Param 1 ForWho igw:${Me.Name} Default = all Unpacks planar stones from PoP/CD by specified.
Param 2 Option Lowest, Specific name Option of what to unpack.
Unpack
Param 1 ForWho igw:${Me.Name} Default = all Unpacks specified items that have a reward choice window.
Param 2 Item Name "Elemental Ores" Name of zone to travel to.
Param 3 Option "2 Celestial Earthen Ores" or # Name or # to select in reward window.
Update_Guk_Shinies
Param 1 N/A N/A N/A Updates Guk shinies.
Update_PoP_Shinies
Param 1 N/A N/A N/A Updates PoP shinies.
UplinkOptionChange
Param 1 ForWho igw:${Me.Name} N/A Changes/interacts with a UI element.
Param 2 UI code "checkbox_settings_ignore" Name of object to change (obtained via xml files)
Param 3 Value TRUE/FALSE/TOGGLE N/A
Param 4 Silent TRUE/FALSE Silent mode spew infor to console.
UseFlag
Param 1 ForWho igw:${Me.Name} Default = all Uses/Takes flag in guild hall if flag is placed.
UseItem_Relay
Param 1 ForWho igw:${Me.Name} Default = all Uses an item from inventory.
Param 2 Item Name "Name of item" Name of the item to cast/use.
UseItem
Param 1 ForWho igw:${Me.Name} Default = all Uses an item from inventory.
Param 2 Item Name "Name of item" Name of the item to cast/use.
UseItemOnPlayer_Relay
Param 1 ForWho igw:${Me.Name} N/A Uses an item on a Player character.
Param 2 Item Name "Elemental Ores" Name of iterm to use.
Param 3 Target "Kannkor" Name of PC to cast onto.
UseItemOnPlayer
Param 1 ForWho igw:${Me.Name} N/A Uses an item on a Player character.
Param 2 Item Name "Elemental Ores" Name of iterm to use.
Param 3 Target "Kannkor" Name of PC to cast onto.
Waypoint
Param 1 ForWho igw:${Me.Name} N/A Puts a waypoint on your map for specified Loc.
Param 2 X X Cord N/A
Param 3 Y Y Cord N/A
Param 4 Z Z Cord N/A
Zone
Param 1 ForWho igw:${Me.Name} Default = all Will attempt to zone you.
ZoneDoor
Param 1 Option Name or # Default = 1 Chooses door option for all based on parameter.
ZoneDoorForWho
Param 1 ForWho igw:${Me.Name} Default = all Chooses door option for all based on parameter for specified.
Param 2 Option Name or # Default = 1
ZoneInto
Param 1 ForWho igw:${Me.Name} N/A Will zone you into specified zone.
Param 2 Zone "Doomefire" Name of zone.
Param 3 ActorName zone_to_pof The Actor name of the object you have to click in order to zone into the zone
Param 4 Option 1 Door option #.
ZoneReset_UpdateInfo
Param 1 N/A N/A N/A Internal function to update Zone Timer information.
ZoneResetAll
Param 1 ForWho igw:${Me.Name} Default = all 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.
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.
Command Parameters Example Notes Description
AbilityReady
Param 1 ForWho igw:${Me.Name} Default = all Spews info about an abilities readiness.
Param 2 Name or ID id or name ID or name of ability.
CancelCurrentCast
Param 1 N/A N/A N/A Cancels current casting spell.
CheckNoDefensiveOn
Param 1 N/A N/A N/A returns TRUE/FALSE of the internal flag 'NoDefensive'
CheckNoOffensiveOn
Param 1 N/A N/A N/A returns TRUE/FALSE of the internal flag 'NoOffensive'
Clean
Param 1 Input to clean Kannkor's battle Bot Cleans an input 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.
CommandForMe
Param 1 ForWho igw:${Me.Name} Default = all 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.
ConvertSecondsToHMS
Param 1 Seconds 2500 Seconds to convert. Converts seconds to hour, minutes, seconds.
DetrimentalInfo
Param 1 MainiconID 1002 Main icon ID of the detriment. Reads information from your detrimental window (NOT maintained or Effects window) OR from an actors effect window.
Param 2 BackdropiconID 503 Backdrop icon ID of the detriment.
Param 3 Name or ID "Trakanon" Name of ID of Actor. Default = ${Me.ID}
Param 4 Return "exists", "CurrentIncrements" Returns specified.
Get_AbilityInfo
Param 1 Name or ID id or name ID or name of ability. Spews info on specified ability.
Param 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.
Get_Alias
Param 1 Alias *Tank Alias name. spew specified alias to console.
Get_Alias2
Param 1 Alias *Tank Alias name. spew specified alias to console.
Get_Hours
Param 1 Seconds 2500 Seconds to convert. Determines how many whole hours are in the seconds.
Get_Minutes
Param 1 Seconds 2500 Seconds to convert. 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.
Get_Seconds
Param 1 Seconds 2500 Seconds to convert. 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.
GetAbilityID
Param 1 Ability name "Rescue" Name of ability. Converts name of ability into the ID.
GetDeityPoints
Param 1 Option # or name # or name of deity to spew. Spews info on specified.
GetMobID
Param 1 NPC name "Trakanon" Name of NPC. Converts name of npc into the ID.
GroupInZone
Param 1 Within 0 Distance to check returns TRUE/FALSE if your entire group is within the zone and within x distance of you.
HaveQuest
Param 1 Quest name "some quest" name of quest to check. checks if you have specified quest.
HaveSickness
Param 1 N/A N/A N/A Checks if you have revive sickness detriment.
HaveMaintained
Param 1 Args -partial or -exact plus the name of an ability Checks pairs of information to see if you have them maintained on you. Example: -exact, sprint, -partial, haste. Would check to see if you have the exact buff "Sprint" and a buff that contains "haste".
InBattleGround
Param 1 N/A N/A N/A Checks if you are in battlegrounds.
InControlOfAssisting
Param 1 N/A N/A N/A 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.
InEQ2Chars
Param 1 Name "Kannkor" Name to check. Spews info on if specified in eq2chars.xml.
Param 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).
IsReady
Param 1 N/A N/A N/A 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.
NPCUnkillableBug
Param 1 N/A N/A N/A returns TRUE/FALSE if your target has the unkillable bug.
Paused
Param 1 N/A N/A N/A Tells you if bot is paused.
Report_Group_GetKey
Param 1 Index 1 Index to use. 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.
Report_Group_GetValue
Param 1 Index 1 Index to use 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.
RoomID
Param 1 N/A N/A N/A Spews the Room id for the current room you are in.
RoundNumToNearestValue
Param 1 Health 99 Health Percent of the Actor you want to check. 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 Divider 1 The chunks, 20 for every 20%
Param 3 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.
SpewStat
Param 1 command commands specify command. Spews info on specified stat.
Param 2 Label TRUE/FALSE Add label to info your spewing. IE: stat name.
RoomID
Param 1 N/A N/A N/A Spews info for toons that are marked or not.
Version
Param 1 N/A N/A N/A Spews info for current Version of ogrebot.
ZoneReset_FullZoneInformationAvailable
Param 1 N/A N/A N/A returns TRUE/FALSE if the ZoneReset Data is available and been cached.
ZoneReset_Get_ZoneData
Param 1 collection:string variablename Pass collection:string variable and it will add the data to that variable for you. Gets information about a zone from the zonereset cache.
Param 2 string "Doomfire: Vengeance of Ro" Zone name to get
ZoneReset_IsReady
Param 1 N/A N/A N/A If the ZoneReset cache is ready to be used
ZoneReset_IsUpdating
Param 1 N/A N/A N/A If the ZoneReset cache is updating


Camp Spot API

Retrieved from "https://wiki.ogregaming.com/eq2/index.php?title=OgreBotAPI&oldid=10071"