EMFRoleSet

From cluster wiki
Revision as of 15:31, 15 June 2021 by Eric (talk | contribs) (Created page with "=== Description === {| class="wikitable" !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 o...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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_fnc_EMFRoleSet
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

// Set myUnit's role to "SL"

[myUnit, "SL"] call EMF_fnc_EMFRoleSet;

// Set this object's role to "MED" and team to 1

[this, "MED", 1] call EMF_fnc_EMFRoleSet;

Notes

  • the variable name for unit role is: unitSquadRole (this is subject to change in the near future)
  • the variable name for unit team is: unitTeamRole (this is subject to change in the near future)