createGuardedPoint: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (example formate)
(description, see also)
Line 7: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Adds a point guarded by the given side. The actual item or position guarded is determined by the following priority.
| Adds a point guarded by the given side (scripted way of adding equivalent of "GUARDED BY" trigger in [[Editor|3DEN]]). 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 idStatic is not negative, the position of a static object with the given id is guarded.  
* If "objectMapID" is not negative, the position of the object with the given ID is used. -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. [[objNull]] to ignore. z of the vehicle position will be intact.
*If the given vehicle is valid, the starting position of the vehicle is guarded.
|= Description
 
*otherwise the given position is guarded. |= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


| '''createGuardedPoint''' [side, position, idStatic, vehicle] |= Syntax
| '''createGuardedPoint''' [side, position, objectMapID, vehicle] |= Syntax


|p1=  [side, position, idStatic, vehicle]: [[Array]] |= Parameter 1
|p1=  [side, position, idStatic, vehicle]: [[Array]] |= Parameter 1
|p2= side: [[Side]] |= Parameter 2
|p2= side: [[Side]] - The side which will be guarding |= Parameter 2
|p3= position: [[Position]]|= Parameter 3
|p3= position: [[Position]] - [[Object]], [[Group]], [[Position2D]] or [[Position3D]]|= Parameter 3
|p4= idStatic: [[Number]] |= Parameter 4
|p4= objectMapID: [[Number]] - static id of map object. -1 to ignore |= Parameter 4
|p5= vehicle: [[Object]] |= Parameter 5
|p5= vehicle: [[Object]] - vehicle to be used for position. [[objNull]] to ignore |= Parameter 5


| [[Nothing]] or undocumented |= Return value
| [[Nothing]] |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________
   
   
|x1= <code>_point <nowiki>=</nowiki> [[createGuardedPoint]] [ [[east]], [0, 0], -1, [[vehicle]] [[player]] ];</code> |= Example 1
|x1= <code>_point = [[createGuardedPoint]] <nowiki>[</nowiki> [[east]], [0,0], -1, [[vehicle]] [[player]]];</code> |= Example 1
____________________________________________________________________________________________
____________________________________________________________________________________________


| |= See also
|[[createTrigger]], [[addWaypoint]] |= See also


}}
}}

Revision as of 14:44, 12 November 2016

-wrong parameter ("Arma") defined!-1.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 3DEN). 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. -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. objNull to ignore. z of the vehicle position will be intact.
Groups:
Uncategorised

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:
_point = createGuardedPoint [ east, [0,0], -1, vehicle player];

Additional Information

See also:
createTriggeraddWaypoint

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

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