CBA_fnc_modulePatrol

Description

A function for commanding a group to patrol a location with information parsed from a module.

Parameters

  • Logic (Object)
  • Group Leader(s) (Array)

Optional

Logic Parameters (Must be passed associated with Object using “setVariable”)

  • Location Type (String) setVariable [“patrolLocType”, value]
  • Patrol Center (XYZ, Object, Location, Marker, or Task) setVariable [“patrolPosition”, value]
  • Patrol Radius (Scalar) setVariable [“patrolRadius”, value]
  • Waypoint Count (Scalar) setVariable [“waypointCount”, value]
  • Waypoint Type (String) setVariable [“waypointType”, value]
  • Behaviour (String) setVariable [“behaviour”, value]
  • Combast Mode (String) setVariable [“combatMode”, value]
  • Speed Mode (String) setVariable [“speedMode”, value]
  • Formation (String) setVariable [“formation”, value]
  • Code to Execute at Each Waypoint (String) setVariable [“executableCode”, value]
  • Timeout at each waypoint (Array in String “[Min,Med,Max]”) setVariable [“timeout”, value]

Example

[Logic, [group1, group2, ..., groupN]] call CBA_fnc_modulePatrol;

Returns

Nil

Author

WiredTiger

Close