Prisoner (Entity) - originalfoo/Prison-Architect-API GitHub Wiki

Represents a prisoner, and has a vast array of properties.

The following modding options are available...

The Prisoner entity is defined in materials.txt:

BEGIN Object     
    Name                 Prisoner  
    MoveSpeedFactor      0.500000  
    Toughness            20.0000  
    RenderDepth          2  
    BlockedBy            Wall  
    BlockedBy            StaticObject  
    BlockedBy            UtilityStation  
    Sprite               Prisoner  
    Properties           Entity
    Properties           DoesNotTire
    ZombieTier           Low
END

Prisoner entities have the most extensive range of features of all Objects, yet alone Entities, giving each one a unique character.

They can perform a wide range of tasks including working, fighting, satisfying needs, escaping, etc.

Prisoner entities expose the following [Properties](Object Properties):

• .Age
• AiSetTarget
• .AiWalkSpeed
• .AnimateRotation
• .AnimateVelocity
• .Attacker
• .AttackTimer
• .AvailableMoney
• .AvatarControl - only in escape mode
• .BoilingPoint
• .BookInCell
• .Carried
• .CarrierId
• .Carrying
• .CarryingBook
• .Category
• .CellId
• .CellIdTimer
• .CutsceneActor
• .Damage
• .Dest
• .Energy
• .Entity
• .Equipment
• .FailedToFindCell
• .FeedJobId
• .FollowerId
• .Gang
• • .Garbage - wat?!
• .HealingJobId
• .Hidden
• .Hostage
• .Id
• • .IsExternalTeacher - always false for prisoners, obviously
• .IsNewIntake
• .JobId
• .LastAte
• .LastTreated
• .LastVisitors
• .LeavingMap
• .Loaded
• • .Locked - isn't this door-specific?
• .Misbehaviour
• .Naked
• .Name
• .Needs
• .Or
• .PermitPlayerControl
• .PlayerOrderPos
• .Pos
• .Prisoner - always true for prisoners
• .ReloadTimer
• .RequiredCellType
• .RestState
• .Shackled
• • .Slot0..7 - unreliable on entities (can crash game)
• .SnitchTimer
• • .Station - possibly only guard staff?
• .StatusEffects
• .SubType
• .TargetObject
• .Timer
• .TimeOfLastMisconduct
• .Tooltip
• .Type
• .UnlockingDoor
• .Vel
• .Walls
• .WatchingFight
• .WorldObject

They also expose the usual [Methods](Object Methods)

• Avatar (Entity) - player entity in escape mode