BIS fnc teamColor: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Text replacement - " |s1=[" to " |s1= [")
 
(27 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.00


| arma3 |= Game name
|gr1= Object Manipulation


|1.00|= Game version
|descr= Convert number to color team name or color.
____________________________________________________________________________________________


| <pre>/*
|s1= [teamId, getColour] call [[BIS_fnc_teamColor]]


Description:
|p1= teamId: [[Number]] - in range 1..5
Convert number to color team name or color


Parameter(s):
|p2= getColour: [[Boolean]] - (Optional, default [[false]]) [[true]] to get [[Color|Color (RGBA)]], [[false]] to get localized team name
0: NUMBER
1: BOOL - true to return RGBA color, otherwise name is returned (default)


Returns:
|r1= [[Color|Color (RGBA)]] or [[String]] - color format [r, g, b, a] or localized team name
STRING or ARRAY
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|x1= <sqf>[2, true] call BIS_fnc_teamColor;</sqf>
____________________________________________________________________________________________
 
| <!-- [] call [[BIS_fnc_teamColor]]; --> |= Syntax
 
|p1= |= Parameter 1
 
| |= Return value
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


|seealso= [[BIS_fnc_colorConfigToRGBA]] [[BIS_fnc_colorRGBAtoHTML]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Strings|{{uc:teamColor}}]]
[[Category:Functions|{{uc:teamColor}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:teamColor}}]]

Latest revision as of 23:12, 12 July 2022

Arma 3 logo black.png1.00
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_colorConfigToRGBA BIS_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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_teamColor&oldid=327462"