TerminalConsumables

TerminalConsumables

Allows rundown developers to add consumables to the terminal system. Only consumables with registerInTerminalSystem enabled and non-blank terminalItemShortName and terminalItemLongName are added. These restrictions exclude all vanilla consumables by default.

Differs from PingConsumables in that vanilla consumables are not supported by default.

For Plugin Developers

This exposes an API at TerminalConsumables.API with the following features:

// Overrides normal query output. Returns the lines of text to print for a query command. Each element represents one line.

public delegate List QueryTextOverride(Item item, iTerminalItem terminalItem, List defaultDetails);

// Registers the passed item to the terminal system. Queries will print as if the item were a consumable.

// If the item already has a terminal item component, it will register it as a tracked item with the given settings.

public static iTerminalItem RegisterTerminalItem(Item item, bool ammoRel, QueryTextOverride? queryOverride);

// Modifies query-related options for the terminal item. If the item is not tracked, it is registered as a tracked item.

public static bool ModifyTerminalItem(iTerminalItem? terminalItem, bool ammoRel, QueryTextOverride? queryOverride);

public static bool ModifyTerminalItem(Item item, bool ammoRel, QueryTextOverride? queryOverride);