BIS fnc sideColor: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Changed see also)
m (removed extra whitespace)
 
(37 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Function|=
{{RV|type=function
____________________________________________________________________________________________


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


|1.00|= Game Version (number surrounded by NO SPACES)
|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, Output] [[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 |= Parameter 1
|p2= returnString: [[Boolean]] - (Optional, default [[false]]) wanted output:
* [[false]]: [R, G ,B, A]
* [[true]]: "ColourName"


|p2= [[Bool]] - Output (Optional,default: [[false]] - Type of the returned value, either [R,G,B,A] or "ColourName"  |= Parameter 2
|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>
|x2= <sqf>[blufor, true] call BIS_fnc_sideColor; // returns "ColorWEST"</sqf>
[ [[west]], [[false]] ] [[call]] '''BIS_fnc_sideColor''';//Returns [0,0.3,0.6,1]
</code> |= Example 1
 
 
|x2= <code>
[ [[west]], [[true]] ] [[call]] '''BIS_fnc_sideColor''';//Returns "ColorWEST"
</code> |= Example 2
____________________________________________________________________________________________
 
| [[side]],[[CfgMarkerColors Arma 3]] |= See Also


|seealso= [[side]] [[Arma 3: CfgMarkerColors]]
}}
}}
<dl class="command_description">
<!-- BEGIN Note Section -->
<!-- For example:
<dd class="notedate">Posted on Month Day, Year - Time (UTC)</dd>
<dt class="note">'''[[User:User Name|User Name]]'''</dt>
<dd class="note">This is an example note. It is true and verifiable, and contains a little code snippet.
<code>[[if]] ([[_this]] == anExample) [[then]] { [[hint]] "Leave it here for others to read"; };</code></dd>
-->
<!-- END Note Section -->
</dl>
<h3 style="display:none">Bottom Section</h3>
<!-- Appropriate categories go here -->
[[Category:Arma 3: Functions|{{uc:{{PAGENAME}}}}]]

Latest revision as of 19:37, 19 March 2024

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