Difference between revisions of "cmf common fnc setRole"

Revision as of 21:36, 17 December 2022

Hover & click on the images for description

Description

Description:: This function sets the team and squad role of a playerunit, due to how CMF3 functions it is recommended you run this function for each playable unit in your mission.
Execution:: Call
Groups:: CMF3: common

Syntax

Syntax:: [unit, role, team] call cmf_common_fnc_setRole
Parameters:: unit: Object - The unit to assign a role and team to
: role: String - (Optional, deafult "RFL") Role to assign unit
: team: Number - (Optional, default 0) Which team to assign unit, when 0 will use the first supplied loadoutfile
Return Value:: None

Examples

Example 1:

// Set myUnit's role to "SL"
[myUnit, "SL"] call cmf_common_fnc_setRole;

Example 2:

// Set this object's role to "MED" and team to 1
[this, "MED", 1] call cmf_common_fnc_setRole;

Additional Information

See also:: cmf_common_fnc_getConfigParam cmf_common_fnc_isRole cmf_common_fnc_setCallsign

Internal Variables

Locality	Namespace	Name	Description
GLOBAL	Unit	cmf_common_role	A String variable containing the assigned unit's CMF role. e.g. "RFL"
GLOBAL	Unit	cmf_common_team	A String variable containing the assigned unit's CMF team. e.g. 0

Events

Locality	Name	Variables	Description
UNITLOCAL	cmf_common_onUnitRoleChanged	[unit, role, team]	Is fired locally for unit when the unit's role is changed.

Notes

@@ Line 28: / Line 28: @@
 |x2= {{code|lang=scilab|// Set this object's role to "MED" and team to 1
 [this, "MED", 1] call cmf_common_fnc_setRole;}}
+|seealso= [[cmf_common_fnc_getConfigParam]] [[cmf_common_fnc_isRole]] [[cmf_common_fnc_setCallsign]]
 |var1= {{!}} GLOBAL {{!}}{{!}} Unit {{!}}{{!}} cmf_common_role {{!}}{{!}} A [https://community.bistudio.com/wiki/String String] variable containing the assigned unit's CMF role. e.g. "RFL"
 |var2= {{!}} GLOBAL {{!}}{{!}} Unit {{!}}{{!}} cmf_common_team {{!}}{{!}} A [https://community.bistudio.com/wiki/String String] variable containing the assigned unit's CMF team. e.g. 0
-|event1= {{!}} LOCAL {{!}}{{!}} cmf_common_onUnitRoleChanged {{!}}{{!}} [Unit, Role, Team] {{!}}{{!}} Is fired locally for unit when the unit's role is changed.
+|event1= {{!}} UNITLOCAL {{!}}{{!}} cmf_common_onUnitRoleChanged {{!}}{{!}} [unit, role, team] {{!}}{{!}} Is fired locally for unit when the unit's role is changed.
 }}