roleDescription

From Bohemia Interactive Community
Jump to: navigation, search
Introduced with Arma 3 version 1.48
  

Click on the images for descriptions

Introduced in

Game:
Arma 3
Version:
1.48

Description

Description:
Returns unit description set in Editor and visible on role selection screen in MP. Works in MP and SP.

Syntax

Syntax:
roleDescription unit
Parameters:
unit: Object
Return Value:
String

Examples

Example 1:
_playerRole = roleDescription player;

Additional Information

Multiplayer:
-
See also:
namegetPlayerUIDvehicleVarNameworldNamebriefingNamemissionNameserverName

Notes

Only post proven facts here. Report bugs on the feedback tracker. Use the talk page or the forums for discussions.
Add New Note | How To

Notes

Bottom Section

Posted on June 29, 2015 - 12:05 (UTC)
Killzone Kid
One thing you should know about roles. When switching to units placed in editor on the fly in MP, it could mess up the role of the player. Could be bug, could be intended, but I would not recommend doing this. Create new unit dynamically if you need to switch to. Anyway, if role of the unit is messed up so is roleDescription.
Posted on May 26, 2017 - 01:10 (UTC)
Pierre MGI
roleDescription works for playableUnits only. That means not on AI disabled in lobby and not in SP (even for player).