AutoOrderQuantity - originalfoo/Prison-Architect-API GitHub Wiki

##Overview

The AutoOrderQuantity setting defines the quantity of objects to order when used in combination with AutoOrder.

##Syntax

The conditionally-optional setting is used in materials.txt and must be within a BEGIN Object ... definition block. It can be used only once per definition block.

    AutoOrderQuantity <quantity>

Where <quantity> is the (integer) number of units to order.

Must be used in conjunction with the `AutoOrder' setting.

##Example

    AutoOrder Tree
    AutoOrderQuantity 10

##Scripting

The scripting API doesn't expose either setting, however you can define a dummy object with the setting and then spawn it to order items; deleting the dummy item will stop further orders being made. This is useful as it provides a way to bring in supplies in a controllable manner.

data/scripts/:

• Object.Spawn()

##Notes

The item being defined will automatically order <quantity> of the object specified by AutoOrder once per day. It will also place an order as soon as it's first spawned on the map.

##See Also

• data/materials.txt:
  • AutoOrder
  • Properties SlowDelivery
• Example Mods:
  • Improved Workshop Mod - spawns a dummy object that has these settings in order to bulk-purchase trees whenever more trees are needed.