View source for Vehicle Route Constraint System

== Overview ==

The main two entities involved in the vehicle route constraint system are:

* [[Entity vehicle_route_constraint_controller|vehicle_route_constraint_controller]]
* [[Entity vehicle_route_constraint_marker|vehicle_route_constraint_marker]]

Constraints:

*You need one controller per route, and 1 or more markers per route.
*You may only have one start point, and one end point. 
*You may not have any loops in the route.

== Markers ==
*To connect the markers together, use {{accelkey|ctrl}}{{accelkey|k}} as usual.
*Position markers 32 units off the ground, about 1024 units apart (more is ok, try not to go less). The precision cursor ({{accelkey|F11}}) is particularly useful for this.
*All the markers must also be linked to the contoller by setting a {{keyname|parent}} key to the name of the controller.
*To disable air drops on a point, set the {{keyname|no_air_drop}} key to  {{keyvalue|1}}. Use this for markers inside tunnels or under overhangs.

== Controller ==

*Set {{keyname|editor_unique}}{{keyvalue|1}} to make sure this entity is not renamed
*Set the mask to use on the {{keyname|mask}} key (see Playzone below).
*Set the number of points that will be considered a warning on the {{keyname|num_points_warning}} key. (Default: {{keyvalue|3}})
*Set the number of points that will be kick the player on the {{keyname|num_points_max}} key. (Default: {{keyvalue|6}})
*Set the model to use for the arrow on the {{keyname|model_directional}} key. (Default: {{keyvalue|models/guis/assets/arrow.lwo}})
*Set the skin to use on the arrow on the {{keyname|skin_direction_model}} key. (Default: {{keyvalue|deployEffect}}}
*Set the colour of the arrow on the {{keyname|directional_model_color}} key. (Default: {{keyvalue|0 1 0}})

== Playzone ==

* The mask is defined in an appropriate playzone (Default: {{keyname|mask_mcp_route}})
* Set {{keyname|mask_mcp_route}} at an {{filename|mcp_route.tga}} in the {{filename|masks/}} folder for your map (e.g. for Valley you'd use {{keyvalue|masks/valley/mcp_route.tga}})
* Add a key {{keyname|zone_vehicle_route}} with the value of {{keyvalue|1}} to the same playzone as the mask key

== Debugging ==

* {{consolecmd|g_drawRouteConstraints}} Set this to 1 to debug the route of the vehicle you are currently using, set it to 2 to debug paths being used by any vehicle.
** The green sphere is the best point reached by the vehicle
** The red box is the current point the vehicle is at.
** The blue sphere is the best point reached that is available for an air drop.
* {{consolecmd|g_noRouteConstraintKick}} Enables/disables the player being kicked for going the wrong way.
* {{consolecmd|g_noRouteMaskDestruction}} Enables/disables the MCP checking the mask position is valid.

== Examples ==

*An example map can be found at {{filename|base/maps/examples/routeconstraint.world}}
*An example script can be found at {{filename|base/script/maps/routeconstraint.script}}

[[Category:Level Design]] [[Category:Advanced Level Design]]