Verse API reference page for the ai_patrol_path_device class | Fortnite Documentation

This page is not available in the language you have chosen. It will be displayed in English by default. If you would like to view it in a different language, you can try selecting another language.

Used to create patrolling behavior for guards spawned with the guard_spawner_device.


Verse `using` statement	`using { /Fortnite.com/Devices }`

Inheritance Hierarchy

This class is derived from the following hierarchy, starting with creative_object:

Name	Description
`creative_object`	Base class for creative devices and props.
`creative_device_base`	Base class for creative_device.

Members

This class has both data members and functions.

Data

Data Member Name	Type	Description
`NextNodeUnreachableEvent`	`listenable(payload)`	Signaled when a guard cannot reach the next `ai_patrol_path_device`.
`NodeReachedEvent`	`listenable(payload)`	Signaled when a guard reaches this device.
`PatrolPathStartedEvent`	`listenable(payload)`	Signaled when a guard starts moving on the patrol path.
`PatrolPathStoppedEvent`	`listenable(payload)`	Signaled when a guard stops moving on the patrol path.

Functions

Function Name	Description
`Assign`	Assign an AI to this patrol path.
`Disable`	Disables this device.
`Enable`	Enables this device.
`GetTransform`	Returns the transform of the `creative_object` with units in cm. You must check `creative_object.IsValid` before calling this if there is a possibility the object has been disposed or destroyed by gameplay. Otherwise a runtime error will result.
`GoToNextPatrolGroup`	Commands patroller to follow the Next Patrol Path Group instead of the default Patrol Path Group.
`MoveTo`	Moves the `creative_object` to the specified `Position` and `Rotation` over the specified time, in seconds. If an animation is currently playing on the `creative_object` it will be stopped and put into the `AnimationNotSet` state.
`MoveTo`	Moves the `creative_object` to the specified `Transform` over the specified time, in seconds. If an animation is currently playing on the `creative_object` it will be stopped and put into the `AnimationNotSet` state.
`TeleportTo`	Teleports the `creative_object` to the specified `Position` and `Rotation`.
`TeleportTo`	Teleports the `creative_object` to the specified location defined by `Transform`, also applies rotation and scale accordingly.