createGuardedPoint: Difference between revisions

Latest revision as of 14:45, 8 November 2023

1.00

1.50

1.00

0.50

Hover & click on the images for description

Description

Description:

Adds a point guarded by the given side (scripted way of adding equivalent of "GUARDED BY" trigger in Editor). A closest AI group in the given side with assigned "GUARD" waypoint will attempt to secure this guard point. The actual guarded position is determined via the following rules:

Given "position" is always considered. It could be Object, Group, Position2D or Position3D. In every case, z coordinate will be ignored and point will be placed on nearest surface.
If "objectMapID" is not negative, the position of the object with the given ID is used (Overrides "position"). -1 to ignore this argument. z of the object position will be intact.
If the given "vehicle" is valid, the position of the vehicle is extracted and guarded (Overrides both "position" and "objectMapID"). objNull to ignore. z of the vehicle position will be intact.

To be used with "GUARD" waypoint.

ⓘ

To know how does the "GUARD" waypoint work, see Waypoint:Guard.

Groups:

Waypoints

Syntax

Syntax:: createGuardedPoint [side, position, objectMapID, vehicle]
Parameters:: side: Side - the side which will be guarding
: position: Object, Group, Position2D or Position3D
: objectMapID: Number - static id of map object. -1 to ignore
: vehicle: Object - vehicle to be used for position. objNull to ignore
Return Value:: Nothing

Examples

Example 1:: createGuardedPoint [east, [0,0], -1, vehicle player];

Additional Information

See also:: createTrigger addWaypoint setWaypointType

Notes

: Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note

@@ Line 21: / Line 21: @@
 |gr1= Waypoints
-|descr= Adds a point guarded by the given side (scripted way of adding equivalent of "GUARDED BY" trigger in [[3DEN|Editor]]). A closest AI group in the given side with assigned "GUARD" waypoint will attempt to secure this guard point. The actual guarded position is determined via the following rules:
+|descr= Adds a point guarded by the given side (scripted way of adding equivalent of "GUARDED BY" trigger in [[:Category:Eden Editor|Editor]]). A closest AI group in the given side with assigned "GUARD" waypoint will attempt to secure this guard point. The actual guarded position is determined via the following rules:
 * Given "position" is always considered. It could be [[Object]], [[Group]], [[Position#Introduction|Position2D]] or [[Position#Introduction|Position3D]]. In every case, z coordinate will be ignored and point will be placed on nearest surface.
 * If "objectMapID" is not negative, the position of the object with the given ID is used (Overrides "position"). -1 to ignore this argument. z of the object position will be intact.
@@ Line 30: / Line 30: @@
 |s1= [[createGuardedPoint]] [side, position, objectMapID, vehicle]
-|p1= side: [[Side]] - The side which will be guarding
+|p1= side: [[Side]] - the side which will be guarding
 |p2= position: [[Object]], [[Group]], [[Position#Introduction|Position2D]] or [[Position#Introduction|Position3D]]
@@ Line 40: / Line 40: @@
 |r1= [[Nothing]]
-|x1= <code>[[createGuardedPoint]] [<nowiki/>[[east]], [0,0], -1, [[vehicle]] [[player]]];</code>
+|x1= <sqf>createGuardedPoint [east, [0,0], -1, vehicle player];</sqf>
-|seealso= [[createTrigger]], [[addWaypoint]], [[setWaypointType]]
+|seealso= [[createTrigger]] [[addWaypoint]] [[setWaypointType]]
 }}