Waypoints: Difference between revisions

From Citizens Wiki

No edit summary
No edit summary
 
Line 1: Line 1:
NPCs can be given Waypoints to dictate their motion.
NPCs can be given Waypoints to pathfind between.


Waypoints are created by a Waypoint Provider. You can change providers using the /waypoint provider [provider] command.
Waypoints are created by a Waypoint Provider. You can change providers using the /waypoint provider [provider] command.
Line 7: Line 7:
Linear (default) - Sends the NPC to each stored waypoint in sequence.
Linear (default) - Sends the NPC to each stored waypoint in sequence.


Wander - The NPC wanders around randomly.
Wander - The NPC wanders around randomly.  


Guided - The waypoints are split into destination waypoints and guide waypoints. Destination waypoints are chosen randomly and pathed to using a combination of the guide waypoints.
Guided - The waypoints are split into destination waypoints and helper waypoints. Destination waypoints are chosen randomly and pathed to using the helper waypoints as a guide. Useful for say patrolling NPCs in a city where you want them to roughly stick to the roads.


== Waypoint triggers ==
== Waypoint triggers ==
For the linear waypoint provider, triggers can be added to pause the NPC at certain waypoints, change their speed or say something at a waypoint. More information can be found by typing 'triggers' in the waypoint editor.
For the linear and guided waypoint provider, triggers can be added to pause the NPC at certain waypoints, change their speed or say something at a waypoint. More information can be found by typing 'triggers' in the waypoint editor.


{{NavBox}}
{{NavBox}}
[[Category:Configuration]]
[[Category:Configuration]]

Latest revision as of 13:39, 20 April 2023

NPCs can be given Waypoints to pathfind between.

Waypoints are created by a Waypoint Provider. You can change providers using the /waypoint provider [provider] command.

The current Providers are:

Linear (default) - Sends the NPC to each stored waypoint in sequence.

Wander - The NPC wanders around randomly.

Guided - The waypoints are split into destination waypoints and helper waypoints. Destination waypoints are chosen randomly and pathed to using the helper waypoints as a guide. Useful for say patrolling NPCs in a city where you want them to roughly stick to the roads.

Waypoint triggers

For the linear and guided waypoint provider, triggers can be added to pause the NPC at certain waypoints, change their speed or say something at a waypoint. More information can be found by typing 'triggers' in the waypoint editor.