BIS fnc VRTimer: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Fix comment)
m (Fix note and some formatting)
Line 7: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Timer for VR and time trials. The following variables can be used:
| Timer for VR and time trials. The following [[missionNamespace]] variables can be used:
* '''BIS_stopTimer''': set to [[true]] to stop the timer. Once stopped, the function must be executed again to restart the timer
* <tt>BIS_stopTimer</tt>: set to [[true]] to stop the timer. Once stopped, the function must be executed again to restart the timer
* '''RscFiringDrillTime_current''': fill with [[Structured Text]] to display text instead of timer (when timer is stopped)
* <tt>RscFiringDrillTime_current</tt>: fill with [[Structured Text]] to display text instead of timer (when timer is stopped)
* '''RscFiringDrillTime_done''': set to [[true]] to close the display. '''''Stop the timer first''''' |Description=
* <tt>RscFiringDrillTime_done</tt>: set to [[true]] to close the display. '''''Stop the timer first''''' |Description=
____________________________________________________________________________________________
____________________________________________________________________________________________


| ''colour'' call [[BIS_fnc_VRTimer]] |Syntax=
| ''colour'' call [[BIS_fnc_VRTimer]] |Syntax=


|p1= colour: [[String]] (Optional, default {{Inline code|(["IGUI", "WARNING_RGB"] [[call]] [[BIS_fnc_displayColorGet]]) [[call]] [[BIS_fnc_colorRGBtoHTML]]}}) timer colour in HTML format (#<span style{{=}}"color: red">RR</span><span style{{=}}"color: green">GG</span><span style{{=}}"color: blue">BB</span>) |Parameter 1=
|p1= colour: [[String]] (Optional, default {{Inline code|(["IGUI", "WARNING_RGB"] [[call]] [[BIS_fnc_displayColorGet]]) [[call]] [[BIS_fnc_colorRGBtoHTML]]}}) timer colour in HTML format (#{{Color|red|RR}}{{Color|green|GG}}{{Color|blue|BB}}) |Parameter 1=


| [[Nothing]] |Return value=
| [[Nothing]] |Return value=
Line 36: Line 36:
<dd class="note">
<dd class="note">
Here is a countdown, inspired by this function:
Here is a countdown, inspired by this function:
<spoiler>
<spoiler text="Show function">
  [[private]] _timeout = {
  [[private]] LM_fnc_timeoutCountdown = {
  [[params]] [
  [[params]] [
  ["_time", 30, [0]],
  ["_time", 30, [0]],
Line 43: Line 44:
  ];
  ];
  [[private]] _timeout = [[time]] + _time;
  [[private]] _timeout = [[time]] + _time;
[[private]] ["_text", "_remainingTime", "_timeFormat"];
  RscFiringDrillTime_done = [[false]];
  RscFiringDrillTime_done = [[false]];
  1 [[cutRsc]] ["RscFiringDrillTime", "PLAIN"];
  1 [[cutRsc]] ["RscFiringDrillTime", "PLAIN"];
  [[while]] { [[time]] < _timeout } [[do]]
  [[while]] { [[time]] < _timeout } [[do]]
  {
  {
  _remainingTime = _timeout - [[time]];
  [[private]] _remainingTime = _timeout - [[time]];
  _timeFormat = [_remainingTime, "MM:SS.MS", [[true]]] [[call]] [[BIS_fnc_secondsToString]];
  [[private]] _timeFormat = [_remainingTime, "MM:SS.MS", [[true]]] [[call]] [[BIS_fnc_secondsToString]];
  _text = [[format]] ["<t align='left' color='%1'><img image='%2' />%3:%4<t size='0.8'>.%5</t>",
  [[private]] _text = [[format]] ["<t align='left' color='%1'><img image='%2' />%3:%4<t size='0.8'>.%5</t>",
  _colour,
  _colour,
  "A3\Modules_F_Beta\data\FiringDrills\timer_ca",
  "A3\Modules_F_Beta\data\FiringDrills\timer_ca",
Line 60: Line 60:
  [[sleep]] 0.01;
  [[sleep]] 0.01;
  };
  };
  _timeFormat = [0, "MM:SS.MS", true] [[call]] [[BIS_fnc_secondsToString]];
  [[private]] _timeFormat = [0, "MM:SS.MS", [[true]]] [[call]] [[BIS_fnc_secondsToString]];
  RscFiringDrillTime_current = [[parseText]] [[format]] ["<t align='left' color='%1'><img image='%2' />%3:%4<t size='0.8'>.%5</t>",
  RscFiringDrillTime_current = [[parseText]] [[format]] ["<t align='left' color='%1'><img image='%2' />%3:%4<t size='0.8'>.%5</t>",
  _colour,
  _colour,
Line 71: Line 71:
  };</spoiler>
  };</spoiler>
and to use it:
and to use it:
<code>[10, "#FF5500"] [[call]] _timeout;</code>
<code>[10, "#FF5500"] [[call]] LM_fnc_timeoutCountdown;</code>


<!-- Note Section END -->
<!-- Note Section END -->

Revision as of 22:51, 31 July 2020

Arma 3 logo black.png1.00
Hover & click on the images for description

Description

Description:
Timer for VR and time trials. The following missionNamespace variables can be used:
  • BIS_stopTimer: set to true to stop the timer. Once stopped, the function must be executed again to restart the timer
  • RscFiringDrillTime_current: fill with Structured Text to display text instead of timer (when timer is stopped)
  • RscFiringDrillTime_done: set to true to close the display. Stop the timer first
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
colour call BIS_fnc_VRTimer
Parameters:
colour: String (Optional, default (["IGUI", "WARNING_RGB"] call BIS_fnc_displayColorGet) call BIS_fnc_colorRGBtoHTML) timer colour in HTML format (#RRGGBB)
Return Value:
Nothing

Examples

Example 1:
call BIS_fnc_VRTimer;
Example 2:
"#025D00" call BIS_fnc_VRTimer;

Additional Information

See also:
BIS_fnc_displayColorGetBIS_fnc_colorRGBtoHTML

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

Notes

Posted on June 04, 2018 - 19:50 (UTC)
Lou Montana
Here is a countdown, inspired by this function: 
private LM_fnc_timeoutCountdown = {

	params [
		["_time", 30, [0]],
		["_colour", "#FFFFFF", [""]]
	];
	private _timeout = time + _time;
	RscFiringDrillTime_done = false;
	1 cutRsc ["RscFiringDrillTime", "PLAIN"];
	while { time < _timeout } do
	{
		private _remainingTime = _timeout - time;
		private _timeFormat = [_remainingTime, "MM:SS.MS", true] call BIS_fnc_secondsToString;
		private _text = format ["<t align='left' color='%1'><img image='%2' />%3:%4<t size='0.8'>.%5</t>",
			_colour,
			"A3\Modules_F_Beta\data\FiringDrills\timer_ca",
			_timeFormat select 0,
			_timeFormat select 1,
			_timeFormat select 2
		];
		RscFiringDrillTime_current = parseText _text;
		sleep 0.01;
	};
	private _timeFormat = [0, "MM:SS.MS", true] call BIS_fnc_secondsToString;
	RscFiringDrillTime_current = parseText format ["<t align='left' color='%1'><img image='%2' />%3:%4<t size='0.8'>.%5</t>",
		_colour,
		"A3\Modules_F_Beta\data\FiringDrills\timer_ca",
		_timeFormat select 0,
		_timeFormat select 1,
		_timeFormat select 2];
	sleep 4;
	RscFiringDrillTime_done = true;
};
↑ Back to spoiler's top
and to use it: [10, "#FF5500"] call LM_fnc_timeoutCountdown;

Bottom Section

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