Requirement - originalfoo/Prison-Architect-API GitHub Wiki

##Overview

The Requirement setting applies one or more mandatory requirements to Rooms - the room will not become active until the specified requirements have been met.

##Syntax

The setting is used in materials.txt and must be within a BEGIN Room ... definition block. It can be used multiple times per definition block, once for each <requirement>.

    BEGIN Requirement Type <requirement> END

Each <requirement> is a bit like a block in that it can have multiple settings, however they do not have their own BEGIN ... END wrappers (see "Examples" later on this page and it will make more sense).

A list of available

• MinimumSize x <tiles> y <tiles> - room must be at least this size
• Enclosed - room must be enclosed (walls/doors all around it)
• Secure - room must be secure (no escape routes)
• Indoor - room must be indoors
• Outdoor - room must be outdoors
• Object * Id <objectId> - room must contain specified object
• AdjacentObject * Id <objectId> - specified object must be next to room

##Example

Taken from the [Shop (Room)](Shop (Room)):

    BEGIN Requirement Type MinimumSize x 4 y 4 END
    BEGIN Requirement Type Indoor END
    BEGIN Requirement Type Object Id Table END
    BEGIN Requirement Type Object Id ShopShelf END
    BEGIN Requirement Type AdjacentObject Id ShopFront END

##Notes

Secure and Enclosed are never used together in the base game.

Indoor and Outdoor requirements are incompatible with each other. If neither of them are specified, your room can be placed both indoors and outdoors.

Custom objects must be declared above the room definition in materials.txt in order for them to be valid room requirements. Otherwise the game will say "Failed: None".

###data/scripts/

Requirements are not currently exposed via the object scripting API :(

##See Also

• LikelyObject ... *
• Research
• Rooms