Difference between revisions of "OgreUtilitiesAPI"

Latest revision as of 16:30, 6 November 2019

Implementing OgreUtilities

• To use OgreUtilities you will need to load the code into your script.
  • The following will load OgreUtilities into your script.

   function Load_OgreUtilities()
   {
       ogre utilities
       wait 5
       Obj_CreateOgreUtilities:CreateOgreUtilities[${Script.Filename}]
       ;// Returns variable: OgreUtilities
       Obj_CreateOgreUtilities:CreateOgreCharacterData[${Script.Filename}]
       ;// Returns variable: OgreCharacterData
   
       ;// Usage here. See wiki <Link here would likely be helpful, and some examples>    
   } 

• This will allow you to use all of the below Methods, Members, Functions below.

Summary

• List of Methods, Members, Functions

• pre configured Methods, Members, Functions to make coding scripts 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

Advanced Navigation Options

Usage

• Obj_OgreUtilities.OgreNavChecks:<MethodNameHere>[<ParametersHere>]
  • Example - Obj_OgreUtilities.OgreNavChecks:Set_Check_MeInCombat[FALSE]

List of Methods

• Below is a list of all available methods.

Methods

Usage

• Example - Obj_OgreUtilities:AcceptQuest
  • Would Accept a quest if a quest window exists.

List of Methods

• Below is a list of all available methods.

Members

Usage

   if ${Obj_OgreUtilities.AnyGroupMembersDead}
   {
       ;// Will return TRUE if any group members are dead False if all alive
       ;// Code to execute if it comes back as TRUE
   }

List of Members

• Below is a list of all available members.

Functions

Usage

• All functions are locking. That means when you call them, they 'hold' the script and return once completed.
  • Almost every single function has a return, usually bool that you can access. If TRUE, it means it believes the function was successful, if FALSE, it believes the function was not successful.
    • You can access this return, by checking ${Return} immediately after the function call.

Example 1

   call Obj_OgreUtilities.CallToGH
   if ${Return}
      echo Means CallToGH was successful!

List of Functions

• Below is a list of all available functions