Difference between revisions of "OgreBotAPI"

Revision as of 16:06, 26 May 2016

OgreBotAPI

OgreBotAPI is an Application Program Interface built for people (scripters) to use various OgreBot functions.

The basics

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.

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 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_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 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 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 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 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 IsReady()
• member:int RoundNumToNearestValue(int _Health, int _Divider=1, int _IncrementBy=0)
• member:string Get_Alias(string _Alias)