Difference between revisions of "SetRole"

From cluster wiki
Jump to navigation Jump to search
(Created page with "<div style="padding:0.33em 2em;font-size:1.2em;font-weight:bold;display:block; border-bottom: #25A1A1 solid 1px; background-color:#E0FFFF;color:#25A1A1">Description</div> <dl...")
 
Line 66: Line 66:
<dd style="width:90%;padding:.3em .3em .3em 7em;"><code style="border:#25A1A1 dashed 1px;display:block;">
<dd style="width:90%;padding:.3em .3em .3em 7em;"><code style="border:#25A1A1 dashed 1px;display:block;">
// Set this object's role to "MED" and team to 1<br>
// Set this object's role to "MED" and team to 1<br>
[this, "MED", 1] call '''EMF_fnc_EMFRoleSet''';
[this, "MED", 1] call '''emf_gameplay_fnc_setRole''';
</code></dd>
</code></dd>


Line 78: Line 78:
<dt style="clear:both;font-weight:bold;position:absolute;padding:.3em;">See also:</dt>
<dt style="clear:both;font-weight:bold;position:absolute;padding:.3em;">See also:</dt>
<dd style="width:90%;padding:.3em .3em .3em 7em;column-count:4;">
<dd style="width:90%;padding:.3em .3em .3em 7em;column-count:4;">
<div style="display:block;">[[SetDate]]</div>
<div style="display:block;">[[restrictedVehicle]]</div>
<div style="display:block;">[[ZeusFPS]]</div>
<div style="display:block;">[[repairRearmTrigger]]</div>
<div style="display:block;">[[preventProne]]</div>
<div style="display:block;">[[rallyPoint]]</div>
<div style="display:block;">[[countDown]]</div>
<div style="display:block;">[[safeStart]]</div>
<div style="display:block;">[[slotLimit]]</div>
<div style="display:block;">[[slingPrimary]]</div>
<div style="display:block;">[[notZeus]]</div>
<div style="display:block;">[[unitInvestigate]]</div>
<div style="display:block;">[[getParamValue]]</div>
<div style="display:block;">[[nearestPlayer]]</div>
</dd>
</dd>



Revision as of 13:23, 26 March 2022

Description
Description:

This function sets the team and squad role of a playerunit, due to how i use EMF in missions it is required for a lot of functions in EMF. it is recommended you run this function for each playable unit in your mission.

Execution:

call

Groups:

Utility Functions: Eric's Mission Framework

Syntax
Syntax:

[unit, role, team] call emf_gameplay_fnc_setRole

Parameters:

unit: Object - Unit to affect.

role: String - Unit's Squad Role as defined in the loadout whitelist.

Team: Number - (Optional) Sets team. [Default: 0]

Return Value:

Boolean - Returns true on success.

Examples
Example 1:
// Set myUnit's role to "SL"
[myUnit, "SL"] call emf_gameplay_fnc_setRole;
Example 2:
// Set this object's role to "MED" and team to 1
[this, "MED", 1] call emf_gameplay_fnc_setRole;
Additional Information
See also:


Notes
  • the variable name for unit role is: emf_utilities_setRole_role
  • the variable name for unit team is: emf_utilities_setRole_team