Difference between revisions of "cmf respawn fnc rallypoint"

From cluster wiki
Jump to navigation Jump to search
(Created page with "{{CMF Function |game1=arma3 |version1=0.50 |game2=cmf3 |version2=2.1.0 |descr=This function adds a rallypoint system Similar to Offworld Industry's Squad. It allows for a p...")
 
 
Line 21: Line 21:
|x1= {{code|lang=scilab|// Add rallypoints to "SL", "PL" and myUnit
|x1= {{code|lang=scilab|// Add rallypoints to "SL", "PL" and myUnit
[["SL", "PL", myUnit]] call cmf_respawn_fnc_rallypoint;}}
[["SL", "PL", myUnit]] call cmf_respawn_fnc_rallypoint;}}
|seealso= [[cmf_respawn_fnc_limit]] [[cmf_respawn_fnc_setLimit]]


|var1= {{!}} GLOBAL {{!}}{{!}} Unit {{!}}{{!}} cmf_respawn_rallypoint {{!}}{{!}} A [https://community.bistudio.com/wiki/Boolean Boolean] variable that is true when the unit has been initialized with rallypoints
|var1= {{!}} GLOBAL {{!}}{{!}} Unit {{!}}{{!}} cmf_respawn_rallypoint {{!}}{{!}} A [https://community.bistudio.com/wiki/Boolean Boolean] variable that is true when the unit has been initialized with rallypoints
|var2= {{!}} GLOBAL {{!}}{{!}} Unit {{!}}{{!}} cmf_respawn_showRallypoint {{!}}{{!}} A [https://community.bistudio.com/wiki/Boolean Boolean] variable that when is true will hide the rallypoint action for unit
|var2= {{!}} GLOBAL {{!}}{{!}} Unit {{!}}{{!}} cmf_respawn_showRallypoint {{!}}{{!}} A [https://community.bistudio.com/wiki/Boolean Boolean] variable that when is true will hide the rallypoint action for unit
|var3= {{!}} GLOBAL {{!}}{{!}} Mission {{!}}{{!}} cmf_respawn_rallypoint_placeLoop {{!}}{{!}} A [https://community.bistudio.com/wiki/Boolean Boolean] variable that when is set to false will close the rallypoint placement loop
|var3= {{!}} LOCAL {{!}}{{!}} Mission {{!}}{{!}} cmf_respawn_rallypoint_placeLoop {{!}}{{!}} A [https://community.bistudio.com/wiki/Boolean Boolean] variable that when is set to false will close the rallypoint placement loop
|var4= {{!}} GLOBAL {{!}}{{!}} unit {{!}}{{!}} cmf_respawn_rallypoint_lastRally {{!}}{{!}} An [https://community.bistudio.com/wiki/Array Array] variable that contains the unit's last placed rallypoint in format: [Object, Respawn, Killscript]
|var4= {{!}} GLOBAL {{!}}{{!}} unit {{!}}{{!}} cmf_respawn_rallypoint_lastRally {{!}}{{!}} An [https://community.bistudio.com/wiki/Array Array] variable that contains the unit's last placed rallypoint in format: [Object, Respawn, Killscript]
}}
}}

Latest revision as of 22:04, 17 December 2022


Hover & click on the images for description
Description
Description:
This function adds a rallypoint system Similar to Offworld Industry's Squad. It allows for a player to place down a respawn position for dead players to spawn on. It is called automatically if enabled in cmf_config.hpp.
Execution:
Call
Groups:
CMF3: respawn
Syntax
Syntax:
[targetArray] call cmf_respawn_fnc_rallypoint
Parameters:
targetArray: Array - An array of targets, either a unitRole: String or a unit: Object
Return Value:
None
Examples
Example 1:
// Add rallypoints to "SL", "PL" and myUnit
[["SL", "PL", myUnit]] call cmf_respawn_fnc_rallypoint;
Additional Information
See also:
cmf_respawn_fnc_limit cmf_respawn_fnc_setLimit
Internal Variables
Locality Namespace Name Description
GLOBAL Unit cmf_respawn_rallypoint A Boolean variable that is true when the unit has been initialized with rallypoints
GLOBAL Unit cmf_respawn_showRallypoint A Boolean variable that when is true will hide the rallypoint action for unit
LOCAL Mission cmf_respawn_rallypoint_placeLoop A Boolean variable that when is set to false will close the rallypoint placement loop
GLOBAL unit cmf_respawn_rallypoint_lastRally An Array variable that contains the unit's last placed rallypoint in format: [Object, Respawn, Killscript]
Events
No events
Notes