Difference between revisions of "OgreInstanceHelperAPI"

From ISXOgre
Jump to: navigation, search
(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...")
 
Line 1: Line 1:
−
== Importent Note ==
+
== Important Note ==
  
 
*This is currently not released.
 
*This is currently not released.

Revision as of 12:34, 2 July 2019

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
Command Parameters Example Notes Description
Set_Disable_AEsEncounters
Param 1 Disabled TRUE/FALSE N/A Disable AOEs and Encounters for group or self if not grouped.
ClearRelativeCampSpot
Param 1 N/A N/A N/A Clears relative campspots for group or self if not grouped.
ClearCampSpot
Param 1 N/A N/A N/A Clears campspots for group or self if not grouped.
SetCampSpot
Param 1 N/A N/A N/A Sets campspot for group or self if not grouped.
ChangeCampSpot
Param 1 Loc "127.084137,-180.863373,-832.558899" Loc to change campspot to. Change campspot for group or self if not grouped.
SetUpFor
Param 1 N/A N/A N/A Does a SetUpFor command for group or self if not grouped. ( Requires being Campspotted )
Set_NoMove
Param 1 N/A N/A N/A Sets NoMove for group or self if not grouped.
Actor_Click
Param 1 Actor "Name" or ID Name or ID of actor to Click. Clicks an Actor for group or self if not grouped.
Use_Item
Param 1 Item "Name" Name of item to Use. Uses an item from inventory for group or self if not grouped.
LetsGo
Param 1 N/A N/A N/A Hits LetsGo for group or self if not grouped.
Jump
Param 1 N/A N/A N/A makes bots Jump. for group or self if not grouped.
Jump_Me
Param 1 N/A N/A N/A makes only you Jump. for self Only.
CallGH
Param 1 N/A N/A N/A Calls to Guild Hall. For group or self if not grouped.
CallHome
Param 1 N/A N/A N/A Calls to Home. For group or self if not grouped.
Tradeskill_Close
Param 1 N/A N/A N/A Closes tradeskill window. For self Only.
ChangeOgreBotUIOption
Param 1 UI Code "Checkbox_blah" UI Code/element to change from Ogrebotui.xml. Set a UI element in ogrebot to on/off. for group or self if not grouped.
Param 2 T or F TRUE/FALSE Set UI element to on/off.
Set_ZoneInformation
Param 1 Zone Name "Myrist, the Great Library" Zone name to set. via ${Zone.Name}. Sets all zone information for files usaully called from main function of script.
Param 2 Zone ShortName "exp15_rgn_plane_of_knowledge" Zone Short name to set. via ${Zone.ShortName}.
Param 3 Actor "zone_to_poa" Actor name to click to zone.
Set_Debug_Mode
Param 1 T or F TRUE/FALSE N/A. Turn debug mode on or off. ( Very Spammy )
Message_FailedZone
Param 1 N/A N/A N/A Sends a failed message to Ogre Console with zone information.
Message_FailedNamed
Param 1 Named "Trakanon" Name of Named. Sends a failed message to Ogre Console with specified named information.
Message_FailedZoneOut
Param 1 N/A N/A N/A Sends a failed message to Ogre Console with zone out information.
Message_NamedDoesNotExistSkipping
Param 1 Named "Trakanon" Name of Named. Sends a Skipping message to Ogre Console with specified named information.
Message_FailedToKill
Param 1 Named "Trakanon" Name of Named. Sends a failed to kill message to Ogre Console named information.
MonkeyInMiddle
Param 1 Range 10 Range to spread to. Default = 10 Set monkey in the middle by specified range. for group or self if not grouped.


Members

Usage

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
Command Parameters Example Notes Description
DuoMode
Param 1 N/A N/A N/A 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.
Get_NPC_ID
Param 1 NPC "Trakanon" Name of NPC. Gets the ID for the specified NPC.
Get_IDFromActorQuery
Param 1 Actor Name "Trakanon" Name of Actor. Checks if Actor Name specified Loc exists at Loc supplied within distance supplied.
Param 2 Loc "737.106506,411.865784,-388.380249" Loc to compare to.
Param 3 Distance 2 Disatnce to check. Default = 2
SoloMode
Param 1 N/A N/A N/A 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.
Tradeskill_vis
Param 1 N/A N/A N/A 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
Command Parameters Example Notes Description
ClearTrashUntilNamedSpawns
Param 1 NPC "Trakanon" Name of NPC. Kill trash untill specified NPC spawns within specified distance.
Param 2 Radius 30 Radius to check trash. Default = 30
HandleAcceptReward
Param 1 Max Times 10 How many times to accept rewards #. Default = 10 Accept rewards specified # of times. .5 second wait between each.
NamedSpawnWait
Param 1 NamedNPC "Trakanon" Name of Actor. Waits specified time or untill specified name and specified Type exist as true. fail message if Named does not spawn.
Param 2 Time to wait 60 = 60 seconds Time to wait.
Param 3 Type "NamedNPC" Type of actor your waiting for.
RunInstanceController
Param 1 Start point 0 Starting point #. Default = 0 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.
Reply_Option
Param 1 Text "I want to carry on!!!" Text you want to click within the reply dialog. Must be Quoted and Exact. Clicks a reply dialog via Text specified. self only.
Set_PriestAscension
Param 1 T or F TRUE/FALSE N/A. Turn priest ascensions on/off. Also turns Combo's off.
Set_VariousOptions
Param 1 N/A N/A N/A 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
Set_Follow
Param 1 N/A N/A N/A Sets follow and assist. for group and self if not grouped.
ZoneSpecialwait
Param 1 Wait Time 30 = 3 seconds Time to wait before click. Default = 30 Hits Special Zone Specific and waits before Click and after Click for specified times for Group or self if not grouped.
Param 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.
Retrieved from "https://wiki.ogregaming.com/eq2/index.php?title=OgreInstanceHelperAPI&oldid=10069"