BIS fnc VRTimer: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Text replacement - " |s1=[" to " |s1= [")
 
(35 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.00


| arma3 |= Game name
|gr1= VR


|1.00|= Game version
|eff= local
____________________________________________________________________________________________


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


Description:
|s1= [colour] spawn [[BIS_fnc_VRTimer]]
Timer for VR.


Parameter(s):
|p1= colour: [[String]] (Optional, default <sqf inline>(["IGUI", "WARNING_RGB"] call BIS_fnc_displayColorGet) call BIS_fnc_colorRGBtoHTML</sqf>) timer colour in HTML format (#{{Color|red|RR}}{{Color|green|GG}}{{Color|blue|BB}})
0: STRING (Optional) - Timer colour in HTML format


Returns:
|r1= [[Nothing]]
Nothing
*/


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


| <!-- [] call [[BIS_fnc_VRTimer]]; --> |= Syntax
|x2= <sqf>"#025D00" spawn BIS_fnc_VRTimer;</sqf>


|p1= |= Parameter 1
|x3= <sqf>["#025D00"] spawn BIS_fnc_VRTimer;</sqf>


| |= Return value
|seealso= [[BIS_fnc_displayColorGet]] [[BIS_fnc_colorRGBtoHTML]]
____________________________________________________________________________________________
}}


|x1= <code></code> |=  
{{Note
____________________________________________________________________________________________
|user= Lou Montana
 
|timestamp= 20180604195000
| |= See also
|text= Here is a countdown, inspired by this function:
<sqf>
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;
};
</sqf>
and to use it:
<sqf>[10, "#FF5500"] spawn LM_fnc_timeoutCountdown;</sqf>
}}
}}
<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: VR|{{uc:VRTimer}}]]
[[Category:Functions|{{uc:VRTimer}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:VRTimer}}]]

Latest revision as of 00:11, 13 July 2022

Arma 3 logo black.png1.00
LELocal
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_displayColorGet BIS_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
Lou Montana - c
Posted on Jun 04, 2018 - 19:50 (UTC)
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; };
and to use it:
[10, "#FF5500"] spawn LM_fnc_timeoutCountdown;
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_VRTimer&oldid=327281"