ObjectRequired - originalfoo/Prison-Architect-API GitHub Wiki

##Overview

Foundations Materials

The ObjectRequired setting is only applicable to Materials and specifies what sort of Consumable resource is required to construct the material.

ObjectRequired

##Syntax

This optional setting is used in materials.txt and must be within a BEGIN Material... definition block. The setting can be used only once per definition block.

    ObjectRequired <consumableId>

Where <consumableId> specifies the type of Consumable resource required.

Defaults to not needing a consumable resource.

##Example

    ObjectRequired GrassTurf

##Example Mods

##Notes

Before the material is constructed by a worker, the specified consumable resource will have to be delivered and brought to the construction site. Only then will the construction of the material begin, consuming the resource in the process (if it's a stack then it will reduce the quantity first, and eventually consume the whole stack).

The required object (consumable) may have costs associated with it which will be added to the cost of the material being placed. This is why, for example, a PerimeterWall which costs $150 per-tile will actually cost the player $200 per-tile ...because Brick is the RequiredObject and costs $50 per unit.

If no consumable resource is specified the construction will start immediately without requiring a delivery.

##See Also

⚠️ **GitHub.com Fallback** ⚠️