BIS fnc sideColor: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= Game " to "|Game= ")
m (removed extra whitespace)
 
(30 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function
____________________________________________________________________________________________


| arma3 |Game=
|game1= arma3
|version1= 1.00


|1.00|= Game Version
|gr1= Sides
____________________________________________________________________________________________


| Returns colour of define side either as [[Array]] in format RGBA or the name of the colour as [[String]] |DESCRIPTION=
|descr= Returns colour of define side either as [[Array]] in format RGBA or the name of the colour as [[String]]
____________________________________________________________________________________________


| [side, returnString] call [[BIS_fnc_sideColor]]; |SYNTAX=
|s1= [side, returnString] call [[BIS_fnc_sideColor]]


| [[Array]] or [[String]] - Colour in RGBA or colour name |RETURNVALUE=
|p1= side: [[Side]]


|p1= side: [[Side]] |PARAMETER1=
|p2= returnString: [[Boolean]] - (Optional, default [[false]]) wanted output:
* [[false]]: [R, G ,B, A]
* [[true]]: "ColourName"


|p2= returnString: [[Bool]] - (Optional, default false) wanted output: [[false]]: [R,G,B,A], [[true]]: "ColourName" |PARAMETER2=
|r1= or [[String]] or [[Array]] format [[Color|Color (RGBA)]]


____________________________________________________________________________________________
|x1= <sqf>[blufor, false] call BIS_fnc_sideColor; // returns [0,0.3,0.6,1]</sqf>


|x1= <code><nowiki>[</nowiki>[[blufor]], [[false]]] [[call]] [[BIS_fnc_sideColor]]; {{codecomment|// Returns [0,0.3,0.6,1]}}</code> |EXAMPLE1=
|x2= <sqf>[blufor, true] call BIS_fnc_sideColor; // returns "ColorWEST"</sqf>


|x2= <code><nowiki>[</nowiki>[[blufor]], &nbsp;[[true]]] [[call]] [[BIS_fnc_sideColor]]; {{codecomment|// Returns "ColorWEST"}}</code> |EXAMPLE2=
|seealso= [[side]] [[Arma 3: CfgMarkerColors]]
____________________________________________________________________________________________
 
| [[side]], [[Arma 3 CfgMarkerColors]] |SEEALSO=
}}
}}
<dl class="command_description">
<!-- BEGIN Note Section -->
<!-- END Note Section -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Arma 3: Functions|{{uc:sideColor}}]]
[[Category:Functions|{{uc:sideColor}}]]

Latest revision as of 18:37, 19 March 2024

Hover & click on the images for description

Description

Description:
Returns colour of define side either as Array in format RGBA or the name of the colour as String
Execution:
call
Groups:
Sides

Syntax

Syntax:
[side, returnString] call BIS_fnc_sideColor
Parameters:
side: Side
returnString: Boolean - (Optional, default false) wanted output:
Return Value:
or String or Array format Color (RGBA)

Examples

Example 1:
[blufor, false] call BIS_fnc_sideColor; // returns [0,0.3,0.6,1]
Example 2:
[blufor, true] call BIS_fnc_sideColor; // returns "ColorWEST"

Additional Information

See also:
side Arma 3: CfgMarkerColors

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