Difference between revisions of "diag captureFrame"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\| *gr([0-9]) *= *Diagnosis * " to "|gr$1= Diagnostic ")
(page formatting, fixed categories)
Line 1: Line 1:
 
{{RV|type=command
 
{{RV|type=command
  
| arma2oa
+
|game1= arma2oa
  
|1.63
+
|version1= 1.63
 +
 
 +
|game2= arma3diag
 +
 
 +
|version2= 1.00
  
 
|gr1= Diagnostic
 
|gr1= Diagnostic
Line 9: Line 13:
 
|gr2= Performance Logging
 
|gr2= Performance Logging
  
| This command starts counting frames from the moment it is executed and when the count reaches the number passed as param, the current frame is captured and captured data UI dialog appears, similar to [[diag_captureSlowFrame]].<br>
+
|descr= This command starts counting frames from the moment it is executed and when the count reaches the number passed as param, the current frame is captured and captured data UI dialog appears, similar to [[diag_captureSlowFrame]]. This can also be executed on a dedicated Server and because a Server has no UI it will behave like [[diag_captureFrameToFile]]. {{Feature|Important|
This can also be executed on a dedicated Server and because a Server has no UI it will behave like [[diag_captureFrameToFile]].<br>
+
* Only available in specific builds. See [[Performance Profiling]] for details.
Special: BattlEye's RCON variant of this command is #captureFrame<br>
+
* BattlEye's RCON variant of this command is '''#captureFrame'''}}
'''Note''': Only available in specific builds. See [[Performance Profiling]] for details.
+
 
  
| '''diag_captureFrame''' frame
+
|s1= '''diag_captureFrame''' frame
  
 
|p1= frame: [[Number]] - next n-th frame to be captured
 
|p1= frame: [[Number]] - next n-th frame to be captured
  
| [[Nothing]]
+
|r1= [[Nothing]]
 
   
 
   
|x1= <code>[[diag_captureFrame]] 1; //capture the first frame after command execution</code>
+
|x1= <code>[[diag_captureFrame]] 1; {{cc|capture the first frame after command execution}}</code>
|x2= <code>[[diag_captureFrame]] 24; //capture 24th frame after command execution</code>
+
 
 +
|x2= <code>[[diag_captureFrame]] 24; {{cc|capture 24th frame after command execution}}</code>
  
|seealso= [[Performance Profiling]], [[diag_captureSlowFrame]], [[diag_logSlowFrame]], [[logEntities]], [[exportJIPMessages]], [[diag_captureFrameToFile]]
+
|seealso= [[Arma 3: Diagnostics Exe]] [[Performance Profiling]] [[diag_captureSlowFrame]] [[diag_logSlowFrame]] [[logEntities]] [[exportJIPMessages]] [[diag_captureFrameToFile]]
 
}}
 
}}
 
 
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
 
{{GameCategory|arma2|Scripting Commands}}
 
{{GameCategory|arma3|Scripting Commands}}
 

Revision as of 12:26, 25 February 2021

A2 OA Logo.png1.63-wrong parameter ("arma3diag") defined!-[[:Category:Introduced with arma3diag version 1.00|1.00]]
Hover & click on the images for description

Description

Description:
This command starts counting frames from the moment it is executed and when the count reaches the number passed as param, the current frame is captured and captured data UI dialog appears, similar to diag_captureSlowFrame. This can also be executed on a dedicated Server and because a Server has no UI it will behave like diag_captureFrameToFile.
  • Only available in specific builds. See Performance Profiling for details.
  • BattlEye's RCON variant of this command is #captureFrame
Groups:
DiagnosticPerformance Logging

Syntax

Syntax:
diag_captureFrame frame
Parameters:
frame: Number - next n-th frame to be captured
Return Value:
Nothing

Examples

Example 1:
diag_captureFrame 1; // capture the first frame after command execution
Example 2:
diag_captureFrame 24; // capture 24th frame after command execution

Additional Information

See also:
Arma 3: Diagnostics Exe Performance Profiling diag_captureSlowFrame diag_logSlowFrame logEntities exportJIPMessages diag_captureFrameToFile

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

[[ Category: arma3diag: Scripting Commands | DIAG CAPTUREFRAME]]