Difference between revisions of "Tab:IM Restock"

Latest revision as of 12:49, 16 June 2019

Disclaimer

• This is Currently in BETA and as such may be Buggy or unfinished...

• While all testing has been done to make sure each script is working as intended some bugs may have slipped through.
• I am not responsible for any lost, sold or destroyed items.

• USE AT YOUR OWN RISK

Main Overview

• Pulls from a saved list of items you want from containers automatically.

UI Overview

Below are all the instructions of how the UI works.

Depot List

• UI Overview
  • This lists all items in the consumbale, adornment, food & drink depots will pull both Large & small depots.
• UI Interaction
  • Highlight Item for it to be added when all info is selected.

Refresh List "Button"

• UI Overview
  • Re-Scans consumbale, adornment, food & drink depots and lists in the depot list.

Load List

• UI Overview
  • loads a list from your xml.
• UI Interaction
  • Select a list from the dropdown and then hit load this will clear and load that list into final list.

Quantity to Restock

• UI Overview
  • Enter Quantity of said item you want in your inventory.

Manual Item Entry

• UI Overview
  • Text box to allow manual entry of an item name.
    • If Enable is Checked. This can not be Left Empty.
      • Examine button - allows you to pull the name from an examine window to auto fill text box.
• UI Interaction
  • Enter item name ready to be added to list.

Add Item "Button"

• UI Overview
  • Adds the information from the following to the final list.
    • Highlighted item Depot List or manual item name entry.
• UI Interaction
  • adds to the final list.

Final List

• UI Overview
  • holds the information from xml list loaded.
• UI Interaction
  • Right Click to remove an item from list.

Save List As

• UI Overview
  • Text box so you can name what you are saving to something convenient. ( must be 4 characters or above )
    • Button Save List.
      • Saves the list from final list to xml.
• UI Interaction
  • saves the list from final list to xml.

Save Settings "Button"

• UI Overview
  • Saves settings from this tab to xml so on next load it auto loads them settings.
    • Restock Tab only saves what list to auto load.
      • Simply Select a list from Dropdown hit load list and then save settings if you then restart I.M it will auto load your list.
• UI Interaction
  • saves the loaded list to auto load on startup.

Start Restock "Button"

• UI Interaction
  • Starts the Restock process.

CLI Commands

Below are all the CLI commands for the Restock Tab.

• Currently this is limited till i have time to integrate them all.

Usage

• Example: ogre im -restock -end ( will load up IM start restock process once done it will end the script )

Commands

• -restock
  • will start the restock process
• -end or -endwhenfinished
  • Will end the script once it has processed all of the commands
    • This should always be passed last

API Commands

Below are all the API commands for the Restock Tab.

• Currently this is limited till i have time to integrate them all.

Usage

• Example: OgreIMAPI.Restock:Start ( will start restock process )

Methods

• Start
  • will start the restock process.
• Load_List["List Name"]
  • Will load the entered list name )
• Add_Item["Item Name",Qty]
  • adds an item to the final list.