createGuardedPoint: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]OFP[ _]Elite *(\|.*)?\]\]" to "{{GameCategory|ofpe|Scripting Commands}}")
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{Command|Comments=
{{Command|Comments=
____________________________________________________________________________________________


| arma1 |Game name=
| arma1 |Game name=
Line 7: Line 6:


|gr1= Waypoints |GROUP1=
|gr1= Waypoints |GROUP1=
____________________________________________________________________________________________


| 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:
| 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:
Line 15: Line 13:
For use with "GUARD" [[setWaypointType|waypoint]]. How does "GUARD" waypoint work: [[Waypoint:Guard]]
For use with "GUARD" [[setWaypointType|waypoint]]. How does "GUARD" waypoint work: [[Waypoint:Guard]]
  |DESCRIPTION=
  |DESCRIPTION=
____________________________________________________________________________________________


| '''createGuardedPoint''' [side, position, objectMapID, vehicle] |SYNTAX=
| '''createGuardedPoint''' [side, position, objectMapID, vehicle] |SYNTAX=
Line 26: Line 23:


| [[Nothing]] |RETURNVALUE=
| [[Nothing]] |RETURNVALUE=
____________________________________________________________________________________________
   
   
|x1= <code>[[createGuardedPoint]] [<nowiki/>[[east]], [0,0], -1, [[vehicle]] [[player]]];</code> |EXAMPLE1=
|x1= <code>[[createGuardedPoint]] [<nowiki/>[[east]], [0,0], -1, [[vehicle]] [[player]]];</code> |EXAMPLE1=
____________________________________________________________________________________________


|[[createTrigger]], [[addWaypoint]], [[setWaypointType]] |SEEALSO=
|[[createTrigger]], [[addWaypoint]], [[setWaypointType]] |SEEALSO=

Revision as of 01:26, 17 January 2021

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.
For use with "GUARD" waypoint. How does "GUARD" waypoint work: Waypoint:Guard
Groups:
Waypoints

Syntax

Syntax:
createGuardedPoint [side, position, objectMapID, vehicle]
Parameters:
[side, position, idStatic, vehicle]: Array
side: Side - The side which will be guarding
position: 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:
createTriggeraddWaypointsetWaypointType

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

Notes

Bottom Section