BIS fnc VRTimer: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "_{10,} " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma3 |Game name=
| arma3


|1.00|Game version=
|1.00


|gr1= VR |GROUP1=
|gr1= VR


|eff= local |MP Effects=
|eff= local |MP Effects=
Line 12: Line 12:
* <tt>BIS_stopTimer</tt>: 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
* <tt>RscFiringDrillTime_current</tt>: 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)
* <tt>RscFiringDrillTime_done</tt>: 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'''''


| [colour] spawn [[BIS_fnc_VRTimer]] |Syntax=
| [colour] spawn [[BIS_fnc_VRTimer]]


|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=
|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}})


| [[Nothing]] |Return value=
| [[Nothing]]


|x1= <code>[] [[spawn]] [[BIS_fnc_VRTimer]];</code> |Example 1=
|x1= <code>[] [[spawn]] [[BIS_fnc_VRTimer]];</code>


|x2= <code>"#025D00" [[spawn]] [[BIS_fnc_VRTimer]];</code> |Example 2=
|x2= <code>"#025D00" [[spawn]] [[BIS_fnc_VRTimer]];</code>


|x3= <code>["#025D00"] [[spawn]] [[BIS_fnc_VRTimer]];</code> |Example 3=
|x3= <code>["#025D00"] [[spawn]] [[BIS_fnc_VRTimer]];</code>


| [[BIS_fnc_displayColorGet]], [[BIS_fnc_colorRGBtoHTML]] |See also=
| [[BIS_fnc_displayColorGet]], [[BIS_fnc_colorRGBtoHTML]]
}}
}}



Revision as of 23:23, 17 January 2021

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

Syntax

Syntax:
[colour] spawn 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:
[] spawn BIS_fnc_VRTimer;
Example 2:
"#025D00" spawn BIS_fnc_VRTimer;
Example 3:
["#025D00"] spawn 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:
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"] spawn LM_fnc_timeoutCountdown;

Bottom Section