diag codePerformance: Difference between revisions

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


| arma3 |Game name=
| arma3
|1.58|Game Version (number surrounded by NO SPACES)=
|1.58


|gr1= Diagnosis |GROUP1=
|gr1= Diagnosis


|gr2= Performance Logging|GROUP2=
|gr2= Performance Logging


| Attempts to run given code with given arguments given number of cycles in unscheduled environment and returns average time it took to run the code as well as actual number of executions performed. The command will return as soon as possible if the tested code is slow and the duration of the command exceeds 1 second. Engine alternative to [[BIS_fnc_codePerformance]]<br><br>
| Attempts to run given code with given arguments given number of cycles in unscheduled environment and returns average time it took to run the code as well as actual number of executions performed. The command will return as soon as possible if the tested code is slow and the duration of the command exceeds 1 second. Engine alternative to [[BIS_fnc_codePerformance]]<br><br>
{{Informative|For security purposes, this command will only run for 1 cycle in MP, unless in-game [[Mission_Editor:_Debug_Console_(Arma_3)|debug console]] is available via [[description.ext]] option or [[Eden]] attribute setting.}} |DESCRIPTION=
{{Informative|For security purposes, this command will only run for 1 cycle in MP, unless in-game [[Mission_Editor:_Debug_Console_(Arma_3)|debug console]] is available via [[description.ext]] option or [[Eden]] attribute setting.}}


|  '''diag_codePerformance''' [code, arguments, cycles] |SYNTAX=
|  '''diag_codePerformance''' [code, arguments, cycles]
|p1= [code, arguments, cycles]: [[Array]] |Parameter1=
|p1= [code, arguments, cycles]: [[Array]]


|p2= code: [[Code]] - code to compare performance |Parameter2=
|p2= code: [[Code]] - code to compare performance


|p3= arguments (Optional): [[Anything]] - arguments to pass to the code in _this variable. Default: [[nil]] |PARAMETER3=
|p3= arguments (Optional): [[Anything]] - arguments to pass to the code in _this variable. Default: [[nil]]
|p4= cycles (Optional): [[Number]] - wanted number of cycles to run the given code. > 1000 is recommended. Default: 100000 |PARAMETER4=
|p4= cycles (Optional): [[Number]] - wanted number of cycles to run the given code. > 1000 is recommended. Default: 100000
| [[Array]] - format [duration, cycles], where:
| [[Array]] - format [duration, cycles], where:
* duration: [[Number]] - average duration of 1 execution in milliseconds
* duration: [[Number]] - average duration of 1 execution in milliseconds
* cycles: [[Number]] - actual number of cycles executed |RETURNVALUE=
* cycles: [[Number]] - actual number of cycles executed




|x1= <code>_result = [[diag_codePerformance]] [{[[private]] _a = 123;}, 0, 10000];</code>|EXAMPLE1=
|x1= <code>_result = [[diag_codePerformance]] [{[[private]] _a = 123;}, 0, 10000];</code>


| [[diag_log]], [[BIS_fnc_codePerformance]], [[Code_Optimisation|Code Optimisation]] |SEEALSO=
| [[diag_log]], [[BIS_fnc_codePerformance]], [[Code_Optimisation|Code Optimisation]]


|  |MPBEHAVIOUR=  
|  |MPBEHAVIOUR=  

Revision as of 00:29, 18 January 2021


Hover & click on the images for description

Description

Description:
Attempts to run given code with given arguments given number of cycles in unscheduled environment and returns average time it took to run the code as well as actual number of executions performed. The command will return as soon as possible if the tested code is slow and the duration of the command exceeds 1 second. Engine alternative to BIS_fnc_codePerformance

For security purposes, this command will only run for 1 cycle in MP, unless in-game debug console is available via description.ext option or Eden attribute setting.
Groups:
DiagnosisPerformance Logging

Syntax

Syntax:
diag_codePerformance [code, arguments, cycles]
Parameters:
[code, arguments, cycles]: Array
code: Code - code to compare performance
arguments (Optional): Anything - arguments to pass to the code in _this variable. Default: nil
cycles (Optional): Number - wanted number of cycles to run the given code. > 1000 is recommended. Default: 100000
Return Value:
Array - format [duration, cycles], where:
  • duration: Number - average duration of 1 execution in milliseconds
  • cycles: Number - actual number of cycles executed

Examples

Example 1:
_result = diag_codePerformance [{private _a = 123;}, 0, 10000];

Additional Information

See also:
diag_logBIS_fnc_codePerformanceCode Optimisation

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

Bottom Section