BIS fnc deltaTime: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(created page)
 
m (Text replacement - "{{Feature | Informative | " to "{{Feature|informative|")
 
(32 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Function|= Comments
{{RV|type=function


| arma3 |Game name=
|game1= arma3
|version1= 1.00


|1.00|Game version=
|gr1= Math


<!---|arg= local |Multiplayer Arguments=--->
|gr2= Diagnostic


<!---|eff= local |Multiplayer Effects=--->
|descr= Calculates and returns the time's delta between previous and current call to this function.


| <pre>/*
{{Feature|informative|This commands internally uses [[time]]. For accurate-critical time measurement, use [[diag_tickTime]].}}
Author: Nelson Duarte <@Nelson_G_Duarte>


Description:
|s1= [id, clear] call [[BIS_fnc_deltaTime]]
Calculates and returns delta time


Parameter(s):
|p1= id: [[String]] - (Optional, default "generic") used to not create conflicts between different systems calling this function, each system can calculate delta time since it last ticked. Will be a [[missionNamespace]] variable
_this select 0: String - The id, used to not create conflicts between different systems calling this function, each system can calculate delta time since it last ticked
_this select 1: Bool - Whether to clear, if true it will return SMALL_NUMBER


Returns:
|p2= clear: [[Boolean]] - (Optional, default [[false]]) if set to [[true]], will delete the [[missionNamespace]] variable (defined by ''id'')
The delta time
*/</pre>{{Informative|Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]]}} |Description=


|[] call [[BIS_fnc_deltaTime]]|Syntax=
|r1= [[Number]] - the delta time - 0.001 if ''clear'' is [[true]]


|p1= parameter: Datatype - (Optional, default defValue) description |Parameter 1=
|x1= <sqf>["TAG_duration"] call BIS_fnc_deltaTime; // Defines the starting point
// ...
private _duration1 = ["TAG_duration"] call BIS_fnc_deltaTime; // Gets time between starting point and now
// ...
private _duration2 = ["TAG_duration"] call BIS_fnc_deltaTime; // Gets time between _duration1 and now
["TAG_duration", true] call BIS_fnc_deltaTime; // deletes the global variable "TAG_duration"</sqf>


|Datatype - description|Return value=
|seealso= [[diag_tickTime]] [[diag_deltaTime]]
 
|x1= <code></code>|Example 1=
 
| |See also=
}}
}}
[[Category:Function Group: Math|{{uc:deltaTime}}]]
[[Category:Functions|{{uc:deltaTime}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:deltaTime}}]]

Latest revision as of 21:42, 16 May 2024

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

Description

Description:
Calculates and returns the time's delta between previous and current call to this function.
ⓘ
This commands internally uses time. For accurate-critical time measurement, use diag_tickTime.
Execution:
call
Groups:
MathDiagnostic

Syntax

Syntax:
[id, clear] call BIS_fnc_deltaTime
Parameters:
id: String - (Optional, default "generic") used to not create conflicts between different systems calling this function, each system can calculate delta time since it last ticked. Will be a missionNamespace variable
clear: Boolean - (Optional, default false) if set to true, will delete the missionNamespace variable (defined by id)
Return Value:
Number - the delta time - 0.001 if clear is true

Examples

Example 1:
["TAG_duration"] call BIS_fnc_deltaTime; // Defines the starting point // ... private _duration1 = ["TAG_duration"] call BIS_fnc_deltaTime; // Gets time between starting point and now // ... private _duration2 = ["TAG_duration"] call BIS_fnc_deltaTime; // Gets time between _duration1 and now ["TAG_duration", true] call BIS_fnc_deltaTime; // deletes the global variable "TAG_duration"

Additional Information

See also:
diag_tickTime diag_deltaTime

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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_deltaTime&oldid=364505"