BIS fnc dataTerminalColor: Difference between revisions

Latest revision as of 23:11, 12 July 2022

1.42

Hover & click on the images for description

Description

Description:

Set Data Terminal colors for its different steps. Steps are:

closed terminal
opening terminal
emitting terminal.

Default step colors are "blue", "orange", "green". See BIS_fnc_dataTerminalAnimate to animate a terminal.

Execution:

call

Groups:

Scripts

Syntax

Syntax:

[dataTerminal, step1color, step2color, step3color] call BIS_fnc_dataTerminalColor

Parameters:

dataTerminal: Object

step1color: String - step 1 color. Can be one of:

"blue"
"orange"
"green"
"red"
"purple"

If not set, the selection color will simply not be changed.

step2color: String - step 2 color

step3color: String - step 3 color

Return Value:

Boolean - false if data terminal is null, true if the script ends properly

Examples

Example 1:: [myTerminal, "purple", "red", "orange"] call BIS_fnc_dataTerminalColor;

Additional Information

See also:: End Game (MP mode) BIS_fnc_dataTerminalAnimate

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.42
-| arma3 |= Game name
+|gr1= Scripts
-|1.42|= Game version
+|descr= Set Data Terminal colors for its different steps. Steps are:
-____________________________________________________________________________________________
-| Set Data Terminal colors for its different steps. Steps are:
 # closed terminal
 # opening terminal
@@ Line 14: / Line 12: @@
 Default step colors are "blue", "orange", "green".
-See [[BIS_fnc_DataTerminalAnimate]] to animate a terminal. |= Description
+See [[BIS_fnc_dataTerminalAnimate]] to animate a terminal.
-____________________________________________________________________________________________
-| [dataTerminal, step1color, step2color, step3color] call [[BIS_fnc_DataTerminalColor]] |= Syntax
+|s1= [dataTerminal, step1color, step2color, step3color] call [[BIS_fnc_dataTerminalColor]]
-|p1= dataTerminal: [[Object]] |= Parameter 1
+|p1= dataTerminal: [[Object]]
 |p2= step1color: [[String]] - step 1 color.  Can be one of:
@@ Line 28: / Line 25: @@
 * "purple"
-If not set, the selection color will simply not be changed. |= Parameter 2
+If not set, the selection color will simply not be changed.
-|p3= step2color: [[String]] - step 2 color |= Parameter 3
+|p3= step2color: [[String]] - step 2 color
-|p4= step3color: [[String]] - step 3 color |= Parameter 4
+|p4= step3color: [[String]] - step 3 color
-| [[Boolean]] - [[false]] if data terminal is null, [[true]] if the script ends properly |= Return value
+|r1= [[Boolean]] - [[false]] if data terminal is null, [[true]] if the script ends properly
-____________________________________________________________________________________________
-|x1= <code>[myTerminal, "purple", "red", "orange"] [[call]] [[BIS_fnc_DataTerminalColor]];</code> |= Example 1
+|x1= <sqf>[myTerminal, "purple", "red", "orange"] call BIS_fnc_dataTerminalColor;</sqf>
-____________________________________________________________________________________________
-| [[MP End Game|End Game (MP mode)]], [[BIS_fnc_DataTerminalAnimate]] |= See also
+|seealso= [[MP End Game|End Game (MP mode)]] [[BIS_fnc_dataTerminalAnimate]]
 }}
-<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: Scripts|{{uc:DataTerminalColor}}]]
-[[Category:Functions|{{uc:DataTerminalColor}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:DataTerminalColor}}]]