Organizer

The Organizer class allow you to interect with the Scavenger Agent, via scripting.

Table of Contents

Methods

AddItem

Syntax: Organizer.AddItem()

Initiate targeting to add an item to the active list.

Returns: Void

ChangeList

Syntax: Organizer.ChangeList(listName)

Change the Organizer's active list.

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

ClearList

Syntax: Organizer.ClearList(listName)

Clear all items from an Organizer list.

Parameters:
  • listName (String)
Returns: Void

FStart

Syntax: Organizer.FStart()

Start the Organizer Agent on the currently active list.

Returns: Void

FStop

Syntax: Organizer.FStop()

Stop the Organizer Agent.

Returns: Void

ItemInsert

Syntax: Organizer.ItemInsert(listName, item)

Insert an item into an Organizer list.

Parameters:
  • listName (String)
  • item (Organizer.OrganizerItem)
Returns: Void

ItemsRead

Syntax: Organizer.ItemsRead(listName)

Read items from an Organizer list.

Parameters:
  • listName (String)
Returns: List[Organizer.OrganizerItem]

ListDelete

Syntax: Organizer.ListDelete(description)

Delete an Organizer list from persistence.

Parameters:
  • description (String)
Returns: Void

ListDetailsRead

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

ListExists

Syntax: Organizer.ListExists(description)

Check if an Organizer list exists by name.

Parameters:
  • description (String)
Returns: Boolean

ListInsert

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

Insert a new Organizer list into persistence. Insert a new Organizer list into persistence (overload).

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

ListsRead

Syntax: Organizer.ListsRead()

Read all Organizer lists from persistence.

Returns: List[Organizer.OrganizerList]

RunOnce

Syntax: Organizer.RunOnce(organizerName, sourceBag, destBag)
Parameters:
  • organizerName (String)
  • sourceBag (Int32)
  • destBag (Int32)
Returns: Void

SetDestination

Syntax: Organizer.SetDestination()

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

Returns: Void

SetSource

Syntax: Organizer.SetSource()

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

Returns: Void

Status

Syntax: Organizer.Status()

Check Organizer Agent status

Returns: Boolean