BIS fnc sideColor: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
(formatted page)
Line 1: Line 1:
{{Function|=
____________________________________________________________________________________________


{{Function|= Comments
|Arma3|= Game
 
|1.00|= Game Version (number surrounded by NO SPACES)
____________________________________________________________________________________________
____________________________________________________________________________________________


| arma3 |= Game name
| Returns colour of define side either as [[Array]] in format RGBA or the name of the colour as [[String]] |= Description
 
|1.00|= Game version
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>/*
| [Side, Output] [[call]] '''BIS_fnc_sideColor'''; |= Syntax


Description:
| [[Array]] or [[String]] - Colour in RGBA or colour name |= RETURNVALUE
Returns side color in RGBA format.


Parameter(s):
|p1= [[Side]] - Side |= Parameter 1
0: SIDE or NUMBER - either side or side ID
1 (Optional) - true to return marker color


Returns:
|p2= [[Bool]] - Output (Optional,default: [[false]] - Type of the returned value, either [R,G,B,A] or "ColourName"  |= Parameter 2
ARRAY or STRING
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_sideColor]]; --> |= Syntax
|x1= <code>
 
[ [[west]], [[false]] ] [[call]] '''BIS_fnc_sideColor''';//Returns [0,0.3,0.6,1]
|p1= |= Parameter 1
</code> |= Example 1


| |= Return value
____________________________________________________________________________________________


|x1= <code></code> |=  
|x2= <code>
[ [[west]], [[true]] ] [[call]] '''BIS_fnc_sideColor''';//Returns "ColorWEST"
</code> |= Example 2
____________________________________________________________________________________________
____________________________________________________________________________________________


| |= See also
| SEEALSO |= See Also


}}
}}


<h3 style="display:none">Notes</h3>
<dl class="command_description">
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- BEGIN Note Section -->
 
<!-- For example:
<!-- Note Section END -->
<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>
</dl>


<h3 style="display:none">Bottom Section</h3>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Sides|{{uc:sideColor}}]]
<!-- Appropriate categories go here -->
[[Category:Functions|{{uc:sideColor}}]]
[[Category:Arma 3: Functions|{{uc:{{PAGENAME}}}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:sideColor}}]]

Revision as of 14:00, 6 August 2016

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:
Uncategorised

Syntax

Syntax:
[Side, Output] call BIS_fnc_sideColor;
Parameters:
Side - Side
Bool - Output (Optional,default: false - Type of the returned value, either [R,G,B,A] or "ColourName"
Return Value:
Array or String - Colour in RGBA or colour name

Examples

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

Additional Information

See also:
SEEALSO

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

Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_sideColor&oldid=97054"