OgreCraft:MethodsandMembers

From ISXOgre
Jump to: navigation, search

Ogre Craft Methods and Members

The following work from the command line or a script. Generally speaking, these are for scripters, not your average user.

  • Following are parameters ( ogre craft <parameters here> )
    • -q | -queue <filename.xml> - loads the queue within the file <filename.xml> located in the eq2ogrecraft/xmlfiles/ folder. You can create a saved queue from the "Save/Load Queues" tab.
      • Example: ogre craft -q arrows.xml
    • -s | -start - Starts crafting immediately. (Equal to clicking "Craft Queue").
  • Following is a global object available at run time: OgreCraft
    • OgreCraft Members (Accessed via ${OgreCraft.Member}
      • bool Crafting - TRUE if you are in the crafting process (basically true if the bot is doing anything, and false if it's idle).
      • bool Paused() - returns TRUE only when the bot is sitting in the pause idle routine (meaning it's between crafting items). The only way for it to get to that state, is if the pause checkbox is ticked.
      • bool MissingResources() - Returns TRUE if you are missing resources.
        • Note: While the queue is being updated, this will bounce between TRUE and FALSE depending on what is happening. This shouldn't be used while QueueUpdated is FALSE.
      • int RecipesInQueue() - Returns the total number of recipes in the queue.
        • This shouldn't be used while QueueUpdated is FALSE.
    • OgreCraft Methods (Accessed via OgreCraft:Method[parameters]
      • AddRecipeName(int _Quantity, string _RecipeName)
      • AddRecipeID(int _Quantity, int64 _RecipeID)
      • AddRecipeListFromFile(string _FileInfo)
      • Start - Equal to clicking "Craft Queue".
      • ShowMainWindow(bool TorF=TRUE) - TRUE shows the Main window. FALSE hides it.
      • ShowQueueWindow(bool TorF=TRUE) - TRUE shows the Main window. FALSE hides it.
      • DumpMissingResources(string VarToDump) - Requires a global variable name with type collection:string to be passed.
        • Clears the variable ( :Clear )
        • Then sets Resource/Fuel Name as the key, and the missing amount as the value.
        • This shouldn't be used while QueueUpdated is FALSE.
      • DumpRecipeIDList(string VarToDump) - Requires a global variable name with type collection:string/int/int64 to be passed.
        • Clears the variable ( :Clear )
        • Then sets RecipeID as the key, and the quantity as the value.
        • This shouldn't be used while QueueUpdated is FALSE.