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

##Overview

These entities are members of security staff who keep Prisoner entities under control with lethal force.

##Modding

The following modding options are available...

###data/materials.txt

The ArmedGuard entity is defined in materials.txt.

• Name ArmedGuard
• MoveSpeedFactor 0.500000
• Toughness 15.0000
• Price -1500
• RenderDepth 2
• ViewRange 15
• BlockedBy Wall
• BlockedBy StaticObject
• BlockedBy UtilityStation
• Research Armoury
• Sprite ArmedGuard
• SpriteVariants 4
• Properties Entity
• Properties Staff
• Properties Guard
• Properties DoesNotTire
• Equipment Shotgun

##Notes

Unlike most other prison staff, armed guards don't get tired.

Armed guards can be assigned to patrols and deployed to rooms.

###data/scripts/

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

• • .Age - not checked
• .AnimateRotation
• .AnimateVelocity
• • .Attacker - not checked
• .BodyArmour
• .Carried
• .CarrierId
• .Carrying
• .Damage
• .Dest
• .Energy
• .Equipment
• .FollowerId
• .Gang - always in gang 0 (white)
• .Id
• .JobId
• .Name
• • .Office - not checked
• .Or
• .Patrol
• .PlayerOrderPos
• .Pos
• .RestState
• • .Slot0..7 - unreliable on entities, may crash game
• .Station
• .SubType
• • .TargetObject - not checked
• .Tooltip
• .Type
• .Vel
• .Walls
• • .Weight - not checked
• • .WorldObject - always returns nil

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

##Example Mods

• Tired Armed Guards Mod - makes ArmedGuard get tired and rest in Armoury using properties such as .RestState and .Patrol

##See Also

• [Dog (Entity)](Dog (Entity))
• [Guard (Entity)](Guard (Entity))
• [DogHandler (Entity)](DogHandler (Entity))
• [RiotGuard (Entity)](RiotGuard (Entity))
• [Soldier (Entity)](Soldier (Entity))