roleDescription: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " *\|= * " to " ")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments( \("local" or "global"\))?|Effects|Multiplayer Effects( \("local" or "global"\))?|Multiplayer Exe...)
Line 1: Line 1:
{{Command|Comments=
{{Command


| arma3 |Game name=
| arma3


|1.48|Game version=
|1.48


|gr1= Object Manipulation |GROUP1=
|gr1= Object Manipulation


|gr2= Multiplayer |GROUP2=
|gr2= Multiplayer


| Returns unit description set in Editor and visible on role selection screen in MP. Works in MP and SP.|DESCRIPTION=
| Returns unit description set in Editor and visible on role selection screen in MP. Works in MP and SP.


| '''roleDescription''' unit |SYNTAX=
| '''roleDescription''' unit


|p1= unit: [[Object]]
|p1= unit: [[Object]]


| [[String]] |RETURNVALUE=
| [[String]]


|x1= <code>_playerRole = [[roleDescription]] [[player]];</code>|EXAMPLE1=
|x1= <code>_playerRole = [[roleDescription]] [[player]];</code>


| [[name]], [[getPlayerUID]], [[vehicleVarName]], [[worldName]], [[briefingName]], [[missionName]], [[serverName]]|SEEALSO=
| [[name]], [[getPlayerUID]], [[vehicleVarName]], [[worldName]], [[briefingName]], [[missionName]], [[serverName]]


}}
}}

Revision as of 01:22, 18 January 2021

Hover & click on the images for description

Description

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

Syntax

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

Examples

Example 1:
_playerRole = roleDescription player;

Additional Information

See also:
namegetPlayerUIDvehicleVarNameworldNamebriefingNamemissionNameserverName

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note

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).