createGuardedPoint: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments( \("local" or "global"\))?|Effects|Multiplayer Effects( \("local" or "global"\))?|Multiplayer Exe...)
Line 1: Line 1:
{{Command|Comments=
{{Command


| arma1 |Game name=
| arma1


|1.00|Game version=
|1.00


|gr1= Waypoints |GROUP1=
|gr1= Waypoints


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


| '''createGuardedPoint''' [side, position, objectMapID, vehicle] |SYNTAX=


|p1=  [side, position, idStatic, vehicle]: [[Array]] |PARAMETER1=
| '''createGuardedPoint''' [side, position, objectMapID, vehicle]
|p2= side: [[Side]] - The side which will be guarding |PARAMETER2=
|p3= position: [[Position]] - [[Object]], [[Group]], [[Position2D]] or [[Position3D]]|PARAMETER3=
|p4= objectMapID: [[Number]] - static id of map object. -1 to ignore |PARAMETER4=
|p5= vehicle: [[Object]] - vehicle to be used for position. [[objNull]] to ignore |PARAMETER5=


| [[Nothing]] |RETURNVALUE=
|p1=  [side, position, idStatic, vehicle]: [[Array]]
|p2= side: [[Side]] - The side which will be guarding
|p3= position: [[Position]] - [[Object]], [[Group]], [[Position2D]] or [[Position3D]]
|p4= objectMapID: [[Number]] - static id of map object. -1 to ignore
|p5= vehicle: [[Object]] - vehicle to be used for position. [[objNull]] to ignore
 
| [[Nothing]]
   
   
|x1= <code>[[createGuardedPoint]] [<nowiki/>[[east]], [0,0], -1, [[vehicle]] [[player]]];</code> |EXAMPLE1=
|x1= <code>[[createGuardedPoint]] [<nowiki/>[[east]], [0,0], -1, [[vehicle]] [[player]]];</code>


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


}}
}}

Revision as of 01:12, 18 January 2021

Logo A1 black.png1.00
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

Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=createGuardedPoint&oldid=204162"