BIS fnc deltaTime: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category\:Function Group\: Math(\|\{\{[a-zA-Z0-9_:]+\}\})?\]\]" 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 = Math |GROUP1=
|gr1 = Math


|gr2 = Diagnostic |GROUP2=
|gr2 = Diagnostic


| Calculates and returns the time's delta between previous and current call to this function.
| Calculates and returns the time's delta between previous and current call to this function.


{{Informative | This commands internally uses [[time]]. For accurate-critical time measurement, use [[diag_tickTime]].}} |Description=
{{Informative | This commands internally uses [[time]]. For accurate-critical time measurement, use [[diag_tickTime]].}}


| [id, clear] call [[BIS_fnc_deltaTime]] |Syntax=
| [id, clear] call [[BIS_fnc_deltaTime]]


|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 |Parameter 1=
|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


|p2= clear: [[Boolean]] - (Optional, default [[false]]) if set to [[true]], will delete the [[missionNamespace]] variable (defined by ''id'')
|p2= clear: [[Boolean]] - (Optional, default [[false]]) if set to [[true]], will delete the [[missionNamespace]] variable (defined by ''id'')


| [[Number]] - the delta time - 0.001 if ''clear'' is [[true]] |Return value=
| [[Number]] - the delta time - 0.001 if ''clear'' is [[true]]


|x1= <code>["TAG_duration"] [[call]] [[BIS_fnc_deltaTime]]; {{cc|Defines the starting point}}
|x1= <code>["TAG_duration"] [[call]] [[BIS_fnc_deltaTime]]; {{cc|Defines the starting point}}
Line 26: Line 26:
{{cc|...}}
{{cc|...}}
[[private]] _duration2 = ["TAG_duration"] [[call]] [[BIS_fnc_deltaTime]]; {{cc|Gets time between _duration1 and now}}
[[private]] _duration2 = ["TAG_duration"] [[call]] [[BIS_fnc_deltaTime]]; {{cc|Gets time between _duration1 and now}}
["TAG_duration", [[true]]] [[call]] [[BIS_fnc_deltaTime]]; {{cc|deletes the global variable "TAG_duration"}}</code> |Example 1=
["TAG_duration", [[true]]] [[call]] [[BIS_fnc_deltaTime]]; {{cc|deletes the global variable "TAG_duration"}}</code>


| [[diag_tickTime]] [[diag_deltaTime]] |See also=
| [[diag_tickTime]] [[diag_deltaTime]]
}}
}}

Revision as of 23:01, 17 January 2021

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