Scavenger

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

Table of Contents

Methods

AddItemByTarget

Syntax: Scavenger.AddItemByTarget()

Initiate targeting to add an item to the active list.

Returns: Void

ChangeList

Syntax: Scavenger.ChangeList(listName)

Change the Scavenger's active list.

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

ClearList

Syntax: Scavenger.ClearList(listName)

Clear all items from a Scavenger list.

Parameters:
  • listName (String)
Returns: Void

GetScavengerBag

Syntax: Scavenger.GetScavengerBag()

Get current Scravenger destination container.

Returns: UInt32

ItemInsert

Syntax: Scavenger.ItemInsert(listName, item)

Insert an item into a Scavenger list.

Parameters:
  • listName (String)
  • item (Scavenger.ScavengerItem)
Returns: Void

ItemsRead

Syntax: Scavenger.ItemsRead(list)

Read items from a Scavenger list.

Parameters:
  • list (String)
Returns: List[Scavenger.ScavengerItem]

ListDelete

Syntax: Scavenger.ListDelete(description)

Delete a Scavenger list from persistence.

Parameters:
  • description (String)
Returns: Void

ListDetailsRead

Syntax: Scavenger.ListDetailsRead(listname, bag, range)
Parameters:
  • listname (String)
  • bag (Int32&@)
  • range (Int32&@)
Returns: Void

ListExists

Syntax: Scavenger.ListExists(description)

Check if a Scavenger list exists by name.

Parameters:
  • description (String)
Returns: Boolean

ListInsert

Syntax: Scavenger.ListInsert(description, bag, range)

Insert a new Scavenger list into persistence.

Parameters:
  • description (String)
  • bag (Int32)
  • range (Int32)
Returns: Void

ListsRead

Syntax: Scavenger.ListsRead()

Read all Scavenger lists from persistence.

Returns: List[Scavenger.ScavengerList]

RunOnce

Syntax: Scavenger.RunOnce(scavengerList, millisec, filter)
Parameters:
  • scavengerList (List[Scavenger.ScavengerItem])
  • millisec (Int32)
  • filter (Items.Filter)
Returns: Void

SetBag

Syntax: Scavenger.SetBag()

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

Returns: Void

Start

Syntax: Scavenger.Start()

Start the Scavenger Agent on the currently active list.

Returns: Void

Status

Syntax: Scavenger.Status()

Check Scavenger Agent status

Returns: Boolean

Stop

Syntax: Scavenger.Stop()

Stop the Scavenger Agent.

Returns: Void