Entity - originalfoo/Prison-Architect-API GitHub Wiki

Were you looking for Callouts-related [Entity](Entity (Callout)) setting?

##Overview

The Entity property defines an Object as being a person.

##Syntax

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

    Properties Entity

##Example Mods

Basic customisations:

Improved Staff Mod - increases ViewRange of range of Workman and Gardener entities
Consuela the janitor Mod - changes sprite of Janitor entities

Scripting examples:

Tired Armed Guards Mod - makes ArmedGuard get tired and rest in Armoury
Aviation Mod - uses entities to create helicopters that fly in prisoners and emergency services!
Chad's Drinks Mod - provides a service engineer that goes round fixing things
Developer Utility Mod - uses entities simply to run scripts (clever use of the fact they don't need constructing)
Automated Gang Sorter Mod - sets prisoner uniform colour based on gang affiliation
Prisoner Suppressor Mod - suppresses prisoners
SCP Architect: Euclid Pack Mod - adds some unusual entities that do unusual things :)

##Notes

Entities can be spawned in the following ways:

Arrive by PrisonBus (Prisoner entities only)
Automatically arrive depending on rooms, reform programmes, etc:
- Visitors, ParoleLawyer, Teacher, ...
Direct placement by player via the "Staff" menu
Callouts
Spawned via Object.Spawn()

In order for an entity to appear on the "Staff" menu, you must also define a Price and ensure their ConstructionTime is 0 or above.

A fairly large number of additional scripting features become available when you use the Entity property. For a full list, see Entities.

##See Also