BIS fnc teamColor: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma3 |Game name=
| arma3


|1.00|Game version=
|1.00


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


| Convert number to color team name or color. |Description=
| Convert number to color team name or color.


| [teamId, getColour] call [[BIS_fnc_teamColor]] |Syntax=
| [teamId, getColour] call [[BIS_fnc_teamColor]]


|p1= teamId: [[Number]] - in range 1..5 |Parameter 1=
|p1= teamId: [[Number]] - in range 1..5


|p2= getColour: [[Boolean]] - (Optional, default [[false]]) [[true]] to get [[Color|Color (RGBA)]], [[false]] to get localized team name |Parameter 2=
|p2= getColour: [[Boolean]] - (Optional, default [[false]]) [[true]] to get [[Color|Color (RGBA)]], [[false]] to get localized team name


| [[Color|Color (RGBA)]] or [[String]] - color format [r, g, b, a] or localized team name |Return value=
| [[Color|Color (RGBA)]] or [[String]] - color format [r, g, b, a] or localized team name


|x1= <code>[2, [[true]]] [[call]] [[BIS_fnc_teamColor]];</code> |Example 1=
|x1= <code>[2, [[true]]] [[call]] [[BIS_fnc_teamColor]];</code>


| [[BIS_fnc_colorConfigToRGBA]], [[BIS_fnc_colorRGBAtoHTML]] |See also=
| [[BIS_fnc_colorConfigToRGBA]], [[BIS_fnc_colorRGBAtoHTML]]
}}
}}



Revision as of 23:48, 17 January 2021

Hover & click on the images for description

Description

Description:
Convert number to color team name or color.
Execution:
call
Groups:
Object Manipulation

Syntax

Syntax:
[teamId, getColour] call BIS_fnc_teamColor
Parameters:
teamId: Number - in range 1..5
getColour: Boolean - (Optional, default false) true to get Color (RGBA), false to get localized team name
Return Value:
Color (RGBA) or String - color format [r, g, b, a] or localized team name

Examples

Example 1:
[2, true] call BIS_fnc_teamColor;

Additional Information

See also:
BIS_fnc_colorConfigToRGBABIS_fnc_colorRGBAtoHTML

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

Bottom Section