BIS fnc sideColor: Difference between revisions

Latest revision as of 18:37, 19 March 2024

1.00

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:

false: [R, G ,B, A]
true: "ColourName"

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

@@ Line 1: / Line 1: @@
+{{RV|type=function
-{{Function|= Comments
+|game1= arma3
-____________________________________________________________________________________________
+|version1= 1.00
-| arma3 |= Game name
+|gr1= Sides
-|1.00|= Game version
+|descr= Returns colour of define side either as [[Array]] in format RGBA or the name of the colour as [[String]]
-____________________________________________________________________________________________
-| <pre>/*
+|s1= [side, returnString] call [[BIS_fnc_sideColor]]
-	Description:
+|p1= side: [[Side]]
-	Returns side color in RGBA format.
-	Parameter(s):
+|p2= returnString: [[Boolean]] - (Optional, default [[false]]) wanted output:
-: SIDE or NUMBER - either side or side ID
+* [[false]]: [R, G ,B, A]
-(Optional) - true to return marker color
+* [[true]]: "ColourName"
-	Returns:
+|r1= or [[String]] or [[Array]] format [[Color|Color (RGBA)]]
-	ARRAY or STRING
-*/
-</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
+|x1= <sqf>[blufor, false] call BIS_fnc_sideColor; // returns [0,0.3,0.6,1]</sqf>
-____________________________________________________________________________________________
-| <!-- [] call [[BIS_fnc_sideColor]]; --> |= Syntax
+|x2= <sqf>[blufor, true] call BIS_fnc_sideColor; // returns "ColorWEST"</sqf>
-|p1= |= Parameter 1
-| |= Return value
-____________________________________________________________________________________________
-|x1= <code></code> |=
-____________________________________________________________________________________________
-| |= See also
+|seealso= [[side]] [[Arma 3: CfgMarkerColors]]
 }}
-<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: Sides|{{uc:sideColor}}]]
-[[Category:Functions|{{uc:sideColor}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:sideColor}}]]