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 1: / Line 1: @@
-{{Command|= Comments
+{{RV|type=command
-____________________________________________________________________________________________
-| arma |= Game name
+|game1= ofpe
+|version1= 1.00
-|1.00|= Game version
+|game2= arma1
-____________________________________________________________________________________________
+|version2= 1.00
-| Adds a point guarded by the given side. If idStatic is not negative, the position of a static object with the given id is guarded. If the given vehicle is valid, the starting position of the vehicle is guarded, otherwise the given position is guarded. |= Description
+|game3= arma2
-____________________________________________________________________________________________
+|version3= 1.00
-| '''createGuardedPoint''' [side, position, idStatic, vehicle] |= Syntax
+|game4= arma2oa
+|version4= 1.50
-|p1= [side, [[side]] |= Parameter 1
+|game5= tkoh
-|p2= [position, [[array]] in position format |= Parameter 2
+|version5= 1.00
-|p3= [idStatic, [[number]] |= Parameter 3
-|p4= [vehicle,  [[Array]] of type objects |= Parameter 4
-| [[Nothing]] or undocumented |= Return value
+|game6= arma3
-____________________________________________________________________________________________
+|version6= 0.50
-|x1= <code>point <nowiki>=</nowiki> createGuardedPoint [ [[east]], [0, 0], -1, [[vehicle]] [[player]] ]</code> |= Example 1
-____________________________________________________________________________________________
-|  |= See also
+|gr1= Waypoints
-}}
+|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.
+* 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" [[setWaypointType|waypoint]].
+{{Feature|informative|To know how does the "GUARD" waypoint work, see [[Waypoint:Guard]].}}
+|s1= [[createGuardedPoint]] [side, position, objectMapID, vehicle]
+|p1= side: [[Side]] - the side which will be guarding
+|p2= position: [[Object]], [[Group]], [[Position#Introduction|Position2D]] or [[Position#Introduction|Position3D]]
+|p3= objectMapID: [[Number]] - static id of map object. -1 to ignore
-<h3 style="display:none">Notes</h3>
+|p4= vehicle: [[Object]] - vehicle to be used for position. [[objNull]] to ignore
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
+|r1= [[Nothing]]
-</dl>
-<h3 style="display:none">Bottom Section</h3>
+|x1= <sqf>createGuardedPoint [east, [0,0], -1, vehicle player];</sqf>
-[[Category:Scripting Commands|CREATEGUARDEDPOINT]]
+|seealso= [[createTrigger]] [[addWaypoint]] [[setWaypointType]]
-[[Category:Scripting Commands OFP Elite |CREATEGUARDEDPOINT]]
+}}
-[[Category:Scripting Commands ArmA|CREATEGUARDEDPOINT]]
-[[Category:Command_Group:_Sides|{{uc:{{PAGENAME}}}}]]
-[[Category:Command_Group:_Waypoints|{{uc:{{PAGENAME}}}}]]