Restock

The Restock class allow you to interact with the Restock Agent, via scripting.

Table of Contents

Methods

AddItem

Syntax: Restock.AddItem()

Initiate targeting to add an item to the active list.

Returns: Void

ChangeList

Syntax: Restock.ChangeList(listName)

Change the Restock's active list.

Parameters:
  • listName (String): Name of an existing restock list.
Returns: Void

ClearList

Syntax: Restock.ClearList(listName)

Clear all items from a Restock list.

Parameters:
  • listName (String)
Returns: Void

FStart

Syntax: Restock.FStart()

Start the Restock Agent on the currently active list.

Returns: Void

FStop

Syntax: Restock.FStop()

Stop the Restock Agent.

Returns: Void

ItemInsert

Syntax: Restock.ItemInsert(list, item)

Insert an item into a Restock list.

Parameters:
  • list (String)
  • item (Restock.RestockItem)
Returns: Void

ItemsRead

Syntax: Restock.ItemsRead(list)

Read items from a Restock list.

Parameters:
  • list (String)
Returns: List[Restock.RestockItem]

ListDelete

Syntax: Restock.ListDelete(description)

Delete a Restock list from persistence.

Parameters:
  • description (String)
Returns: Void

ListDetailsRead

Syntax: Restock.ListDetailsRead(listname, bags, bagd)
Parameters:
  • listname (String)
  • bags (Int32&@)
  • bagd (Int32&@)
Returns: Void

ListExists

Syntax: Restock.ListExists(description)

Check if a Restock list exists by name.

Parameters:
  • description (String)
Returns: Boolean

ListInsert

Syntax: Restock.ListInsert(description, source, destination)

Insert a new Restock list into persistence.

Parameters:
  • description (String)
  • source (Int32)
  • destination (Int32)
Returns: Void

ListsRead

Syntax: Restock.ListsRead()

Read all Restock lists from persistence.

Returns: List[Restock.RestockList]

RunOnce

Syntax: Restock.RunOnce(restockerName, sourceBag, destBag)
Parameters:
  • restockerName (String)
  • sourceBag (Int32)
  • destBag (Int32)
Returns: Void

SetDestination

Syntax: Restock.SetDestination()

Initiate targeting to set the destination bag for the active list.

Returns: Void

SetSource

Syntax: Restock.SetSource()

Initiate targeting to set the source bag for the active list.

Returns: Void

Status

Syntax: Restock.Status()

Check Restock Agent status

Returns: Boolean