LikelyObject - originalfoo/Prison-Architect-API GitHub Wiki

##Overview

The LikelyObject setting block is used to indicate which optional Objects are likely to be built in a Room.

##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 <objectId>.

    BEGIN LikelyObject Id <objectId> END

Where <objectId> defines an object that the player will likely want to build in the room.

##Example

Taken from the [Cell room](Cell (Room)):

    BEGIN LikelyObject Id JailDoor   END
    BEGIN LikelyObject Id Bookshelf  END
    BEGIN LikelyObject Id Tv         END
    BEGIN LikelyObject Id Window     END
    BEGIN LikelyObject Id Radio      END
    BEGIN LikelyObject Id OfficeDesk END
    BEGIN LikelyObject Id Chair      END
    BEGIN LikelyObject Id ShowerHead END
    BEGIN LikelyObject Id Drain      END

##Notes

This setting causes hidden objects to reappear in the "Objects" menu when the room is near the middle of the map window.

The object will also have a white border around its icon in the "Objects" menu making it easier to find, regardless of whether it was previously hidden or not.

Objects can be hidden from the menu by giving them the Properties RoomSpecific setting.

###data/scripts/

Rooms and their settings are not currently exposed by the scripting API :(

##See Also

• Requirement ... * Object - room setting
• Requirement ... * AdjacentObject - room setting
• Properties RoomSpecific - object setting