R3vo/Sandbox – User

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Correct arma discord link)
mNo edit summary
 
(426 intermediate revisions by 3 users not shown)
Line 1: Line 1:
__NOTOC__
{{TOC|side}}
__NOEDITSECTION__
If you have ever wondered why you scenario is running so badly, performance profiling is the way to find it out. It allows you to find bottlenecks and slow code by capturing a "slow" frame.
[[Image:Logo_BI_Black.png|center|256px|link=Bohemia Interactive|Bohemia Interactive]]
The captured data can then be viewed and analysed.
<div align="center">'''Welcome to the Bohemia Interactive Community Wiki.'''</div>


<!--- A3 --->
== Getting the correct Version ==
<div style="margin:0 auto; width:1024px;">
Profiling is enabled in the following {{arma3}} versions
<div class="floating-box">
* arma3profiling_x64.exe - '''Part of the Performance Profiling Build'''
==<div align="center">[[Image:Logo A3 black.png|150px|link=ArmA 3|Arma 3]]</div>==
* arma3diag_x64.exe - '''Part of the Development Build'''
:[[Arma 3|About this game]]
:[[:Category:Arma 3: Editing|Editing]]
:[[:Category:Scripting Commands Arma 3|Scripting commands]]
:[[:Category:Arma 3: Functions|Scripting functions]]
:[[Eden Editor]]
</div>


<!--- A2 OA --->
Read [[Arma_3: Steam Branches]] for a guide on how to access these branches.
<div style="margin:0 auto; width:1024px;">
<div class="floating-box">
==<div align="center">[[Image:A2_OA_Logo.png|115px|link=:Category:ArmA 2: Operation Arrowhead|Arma 2: Operation Arrowhead]]</div>==
:[[ArmA 2: Operation Arrowhead|About this game]]
:[[ArmA 2: Editing|Editing]]
:[[ArmA II Hints and Tips|Hints and tips]]
:[[:Category:Scripting Commands ArmA2|Scripting commands]]
:[[:Category:Arma 2: Multiplayer|Multiplayer]]
</div>


<!--- A2 --->
{{Feature|informative|It is recommended to use the '''Performance Profiling Build''' (arma3profiling_x64.exe) for performance profiling because:
<div style="margin:0 auto; width:1024px;">
* Has tools that might not make it into development build
<div class="floating-box">
* Has all the profiling related commands that ''arma3diag_x64.exe'' has
==<div align="center">[[Image:Logo A2.png|150px|link=ArmA 2|Arma 2|]]</div>==
* Its performance is closer to the default ''arma3_x64.exe''}}
:[[ArmA 2|About this game]]
:[[Arma2: Startup Parameters|Startup parameters]]
:[[ArmA 2: Editing|Editing]]
:[[:Category:ArmA 2: New Scripting Commands List|Scripting commands]]
:[[Mondkalb's Addon Tutorial|Creating Addons]]
</div>


<!--- A1 --->
== Frame Capturing ==
<div style="margin:0 auto; width:1024px;">
There are several commands that allow you to capture a frame.
<div class="floating-box">
* [[diag_captureFrame]]
==<div align="center">[[Image:Logo A1 black.png|150px|link=Armed Assault|Arma: Armed Assault]]</div>==
* [[diag_captureSlowFrame]]
:[[ArmA: The Game|About this game]]
* [[diag_logSlowFrame]] - not available in Arma 3 :(
:[[ArmA: Editing|Editing]]
* [[diag_captureFrameToFile]]
:[[:Category:Scripting Commands ArmA|Scripting commands]]
In most cases you do not want to capture any or all frames, you just want to capture "slow" frames. A slow frame is a frame that takes longer than the average frame and slows down the game.
:[[:ArmA: Mission Editing|Mission Editing]]
:[[ArmA: FAQ|FAQ]]
</div>


<!--- OFP --->
== How to Use ==  
<div style="margin:0 auto; width:1024px;">
# Run a mission
<div class="floating-box">
# Execute a scripted command <sqf inline>diag_captureSlowFrame ["total", 0.3];</sqf> using any means ([[Arma 3: Debug Console|Debug Console]], mission radio trigger...)
==<div align="center">[[Image:Logo A0.png|150px|link=:Category:Operation_Flashpoint|Arma: Cold War Assault]]</div>==
# Once a slow frame is detected, a window will open
:[[:Category:Operation Flashpoint|About this game]]
# In the window you will be able to browse a lot of performance-related data, which can be interesting
:[[:Category:Operation Flashpoint: Startup Parameters|Startup parameters]]
# To export the gathered information for sharing with others:
:[[:Category:Operation Flashpoint: Addons|Addons]]
## Select Main Thread (if not selected yet)
:[[:Category:Scripting Commands OFP 1.96|Scripting commands]]
## Press the Copy button
:[[:Category:Operation Flashpoint: Editing|Editing]]
## Open an external text editor
</div>
## Paste the text into a new file
## Save the file


<!--- TKOH --->
== Capture Frame UI ==
<div style="margin:0 auto; width:1024px;">
[[File: arma3-capture frame ui overview.png]]
<div class="floating-box">
==<div align="center">[[Image:Logo TakOH full.png|150px|link=Take On Helicopters|Take On Helicopters]]</div>==
:[[Take On Helicopters|About this game]]
:[[:Category:Scripting Commands Take On Helicopters|Scripting commands]]
:[[:Category:Take On Helicopters: Functions|Scripting functions]]
:[[:Category:Take On Helicopters: Editing| Editing]]
:[[Functions Library 2.0]]
</div>


<!--- TKOM --->
# {{Wiki|TODO}}
<div style="margin:0 auto; width:1024px;">
# {{Wiki|TODO}}
<div class="floating-box">
# {{Wiki|TODO}}
==<div align="center">[[Image:tkom_logo.png|150px|link=:Category:Take On Mars|Take On Mars]]</div>==
# {{Wiki|TODO}}
:[[Take On Mars|About the game]]
# {{Wiki|TODO}}
:[[:Take On Mars: Editor|Editor]]
# {{Wiki|TODO}}
:[[:Take On Mars: Equipment|Equipment]]
# {{Wiki|TODO}}
</div>
# {{Wiki|TODO}}
# {{Wiki|TODO}}


<!--- DAYZ --->
== External Viewer ==
<div style="margin:0 auto; width:1024px;">
* chrome://tracing
<div class="floating-box">
* https://ui.perfetto.dev/
==<div align="center">[[File:dayzlogoinv.png|150px|link=DayZ|DayZ]]</div>==
:[[DayZ|About this game]]
:[[:Category:DayZ:Editing|Editing]]
:[[:Category:DayZ:Tools|Tools]]
:[[:Category:DayZ:Tutorials|Tutorials]]
:[[:Category:DayZ:Game Mechanics|Game mechanics]]
</div>


<!--- YLANDS --->
[[File:Performance_Profiling_04.png|thumb|diag_captureFrame sample output with custom subtree]]
<div style="margin:0 auto; width:1024px;">
== Creating Your Own Subtree ==
<div class="floating-box">
==<div align="center">[[Image:Ylands_3D_Logo.png|285px|link=Ylands|>Ylands]]</div>==
:[[Ylands|About this game]]
:[[Ylands Visual Scripting|Visual Scripting]]
:[[Ylands Editor|Editor]]
:[[Ylands Database|Database]]
:[[Ylands Game Mechanics|Game mechanics]]
</div>


<!--- CC --->
When Profiling Per-Frame Eventhandlers (PFH), [[diag_captureFrame]] only shows one blob called siFEH that contains all PFH's so you can't see what part of that is caused by your PFH.<br>
<div style="margin:0 auto; width:1024px;">
You can create your own subtree inside siFEH by wrapping your function call inside a [[isNil]] CODE statement like this:<br>
<div class="floating-box">
Turn your old call which may look like this:
==<div align="center">[[Image:CC_Logo.png|200px|link=:Carrier Command: Gaea Mission|Carrier Command:Gaea Mission]]</div>==
<sqf>
:[[Carrier Command: Gaea Mission|About the game]]
addMissionEventHandler ["EachFrame", {
:[[Carrier Command: Gaea Mission: Startup Parameters|Startup Parameters]]
call myPFHFunction
:[[Carrier Command: Gaea Mission: FAQ|FAQ]]
}];
:[[:Category:Carrier Command: Official Tools|Official Tools]]
</sqf>
</div>


<!--- VBS --->
Into something like this:
<div style="margin:0 auto; width:1024px;">
<sqf>
<div class="floating-box">
addMissionEventHandler ["EachFrame", {
==<div align="center">[[:Category:Virtual Battlespace|VBS1]]</div>==
isNil { call myPFHFunction } // isNil creates the subtree
:[[:Category:Virtual Battlespace|About this game]]
}];
:[[Virtual Battlespace: Startup Parameters|Startup Parameters]]
</sqf>
:[[:Category:Scripting Commands VBS1|Scripting commands]]
:[[VBS1 Functions|Scripting functions]]
</div>


<!--- EDITING (GENERAL) --->
Now when you run [[diag_captureFrame]] inside of siPFH you will have a subtree called gsEva and behind that you can see the first line of code inside the isNil statement.<br>
<div style="margin:0 auto; width:1024px;">
It will only show a part of the first line of that code so you should put something descriptive into the [[isNil]] statement.<br>
<div class="floating-box">
You can use the same to create a subtree for any function you like. This will also work inside [[Scheduler#Scheduled_Environment|Scheduled]] ([[spawn]]ed) scripts. <br>
==<div align="center">Editing (General)</div>==
But using this method to "subtree" a function with return values requires a little bit of trickery to get the return value out.
:[[Addons]]
:[[Terrain Editing]]
:[[Modelling]]
:[[:Category:Scripting Topics|Scripting (general)]]
:[[:Category:Tools|Tools]]
:[[Public Data]]
</div>


<!--- CONTRIBUTE --->
<div style="margin:0 auto; width:1024px;">
<div class="floating-box">
==<div align="center">Contribute</div>==
:[[Getting Started]]
:[https://discord.gg/cMzR2sA Discord Community Wiki]
:[[Village Pump (todo)|To-do]]
</div>


<!--- GETTING HELP --->
== Notes ==
<div style="margin:0 auto; width:1024px;">
 
<div class="floating-box">
* 0.3 is a time in second used to determine what duration of a frame you consider abnormal, and first such frame will be captured.
==<div align="center">Getting Help With BI Games</div>==
* 0.3 is definitely something you should not see in a normal game.
:[[:Category:Armaverse|Armaverse]]
* If you do not capture any frames with 0.3, try lowering it to 0.2 or 0.1.
:[[Troubleshooting|Troubleshooting]]
* If it triggers too early, before the main slowdown happens, increase it to a higher value, e.g. 1.0.
:[https://forums.bohemia.net/|BIS Forums]
 
:[[:Category:Walkthroughs|Walkthroughs]]
 
:[[:Category:Hints & Tips |Hints and Tips]]
== See Also ==
:[https://discord.gg/Arma Discord]
 
</div>
* [[Code Optimisation]]
* [[Mission Optimisation]]
 
 
[[Category:Arma Scripting Tutorials]]

Latest revision as of 12:37, 26 October 2024

If you have ever wondered why you scenario is running so badly, performance profiling is the way to find it out. It allows you to find bottlenecks and slow code by capturing a "slow" frame. The captured data can then be viewed and analysed.

Getting the correct Version

Profiling is enabled in the following Arma 3 versions

  • arma3profiling_x64.exe - Part of the Performance Profiling Build
  • arma3diag_x64.exe - Part of the Development Build

Read Arma_3: Steam Branches for a guide on how to access these branches.

It is recommended to use the Performance Profiling Build (arma3profiling_x64.exe) for performance profiling because:
  • Has tools that might not make it into development build
  • Has all the profiling related commands that arma3diag_x64.exe has
  • Its performance is closer to the default arma3_x64.exe

Frame Capturing

There are several commands that allow you to capture a frame.

In most cases you do not want to capture any or all frames, you just want to capture "slow" frames. A slow frame is a frame that takes longer than the average frame and slows down the game.

How to Use

  1. Run a mission
  2. Execute a scripted command diag_captureSlowFrame ["total", 0.3]; using any means (Debug Console, mission radio trigger...)
  3. Once a slow frame is detected, a window will open
  4. In the window you will be able to browse a lot of performance-related data, which can be interesting
  5. To export the gathered information for sharing with others:
    1. Select Main Thread (if not selected yet)
    2. Press the Copy button
    3. Open an external text editor
    4. Paste the text into a new file
    5. Save the file

Capture Frame UI

arma3-capture frame ui overview.png

  1. 🚧
    TODO: this must be updated.
  2. 🚧
    TODO: this must be updated.
  3. 🚧
    TODO: this must be updated.
  4. 🚧
    TODO: this must be updated.
  5. 🚧
    TODO: this must be updated.
  6. 🚧
    TODO: this must be updated.
  7. 🚧
    TODO: this must be updated.
  8. 🚧
    TODO: this must be updated.
  9. 🚧
    TODO: this must be updated.

External Viewer

diag_captureFrame sample output with custom subtree

Creating Your Own Subtree

When Profiling Per-Frame Eventhandlers (PFH), diag_captureFrame only shows one blob called siFEH that contains all PFH's so you can't see what part of that is caused by your PFH.
You can create your own subtree inside siFEH by wrapping your function call inside a isNil CODE statement like this:
Turn your old call which may look like this:

addMissionEventHandler ["EachFrame", { call myPFHFunction }];

Into something like this:

addMissionEventHandler ["EachFrame", { isNil { call myPFHFunction } // isNil creates the subtree }];

Now when you run diag_captureFrame inside of siPFH you will have a subtree called gsEva and behind that you can see the first line of code inside the isNil statement.
It will only show a part of the first line of that code so you should put something descriptive into the isNil statement.
You can use the same to create a subtree for any function you like. This will also work inside Scheduled (spawned) scripts.
But using this method to "subtree" a function with return values requires a little bit of trickery to get the return value out.


Notes

  • 0.3 is a time in second used to determine what duration of a frame you consider abnormal, and first such frame will be captured.
  • 0.3 is definitely something you should not see in a normal game.
  • If you do not capture any frames with 0.3, try lowering it to 0.2 or 0.1.
  • If it triggers too early, before the main slowdown happens, increase it to a higher value, e.g. 1.0.


See Also