obj.Patrol - originalfoo/Prison-Architect-API GitHub Wiki

##Overview

Applicable to ArmedGuard, Dog and Guard entities, this property defines whether they are patrolling, and if so their previous and next positions along the patrol route.

##Syntax

The .Patrol property is a table with the following properties:

• Patrol.Active – Boolean (true or false or nil); is the entity assigned to a patrol?
• Patrol.LastPos – Table (with x and y properties); the previous position on their patrol path
• Patrol.ThisPos – Table (with x and y properties); the current position on their patrol path

##Example

##Mods:

• Tired Armed Guards Mod - checks .Patrol before altering .RestState of ArmedGuard entities

##Notes

Anything that changes the entity position, or clears their route, will cause them to stop patrolling (which may only be temporary as they'll try and return to work if idle).

##See Also

• .Dest
• .PlayerOrderPos
• .Pos
• .RestState
• .NavigateTo()
• [ArmedGuard (Entity)](ArmedGuard (Entity))
• [Guard (Entity)](Guard (Entity))
• [Dog (Entity)](Dog (Entity))
• [DogHandler (Entity)](DogHandler (Entity))