BIS fnc curatorWaypointPlaced: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *G([a-z ])" to "$1 - g$2")
 
(29 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.16


| arma3 |= Game name
|gr1= Curator


|1.00|= Game version
|descr= Code executed when curator waypoint is placed.
____________________________________________________________________________________________


| <pre>/*
|s1= [object, waypointGroup, waypointID] call [[BIS_fnc_curatorWaypointPlaced]]


Description:
|p1= object: [[Object]] - curator module '''Isn't used in the function'''
Code executed when curator waypoint is placed.


Parameter(s):
|p2= waypointGroup: [[Array]] - group owning the edited waypoint
0: OBJECT - curator module
1: ARRAY - edited waypoint


Returns:
|p3= waypointID: [[Number]] - ID of the edited waypoint
BOOL
*/


//--- Simplified argument loading to save performance
|r1= [[Boolean]]
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_curatorWaypointPlaced]]; --> |= Syntax
|x1= <sqf>[curatorModule, group player, 5] call BIS_fnc_curatorWaypointPlaced;</sqf>
 
|p1= |= Parameter 1
 
| |= Return value
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


|seealso= [[Arma 3: Curator]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Curator|{{uc:curatorWaypointPlaced}}]]
[[Category:Functions|{{uc:curatorWaypointPlaced}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:curatorWaypointPlaced}}]]

Latest revision as of 15:31, 8 November 2023

Hover & click on the images for description

Description

Description:
Code executed when curator waypoint is placed.
Execution:
call
Groups:
Curator

Syntax

Syntax:
[object, waypointGroup, waypointID] call BIS_fnc_curatorWaypointPlaced
Parameters:
object: Object - curator module Isn't used in the function
waypointGroup: Array - group owning the edited waypoint
waypointID: Number - ID of the edited waypoint
Return Value:
Boolean

Examples

Example 1:
[curatorModule, group player, 5] call BIS_fnc_curatorWaypointPlaced;

Additional Information

See also:
Arma 3: Curator

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