asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #52616 from Calinou/doc-idle-physics-frames-3.x

Browse source 
Improve documentation for `Engine.get_idle_frames/get_physics_frames()` (3.x)
This commit is contained in:
Max Hilbrunner 2021-09-13 02:38:10 +02:00 committed by GitHub
commit 13884099e7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
doc/classes/Engine.xml
View file

@ -37,7 +37,7 @@
<method name="get_frames_drawn">
<return type="int" />
<description>
Returns the total number of frames drawn. If the render loop is disabled with [code]--disable-render-loop[/code] via command line, this returns [code]0[/code]. See also [method get_idle_frames].
Returns the total number of frames drawn. On headless platforms, or if the render loop is disabled with [code]--disable-render-loop[/code] via command line, [method get_frames_drawn] always returns [code]0[/code]. See [method get_idle_frames].
</description>
</method>
<method name="get_frames_per_second" qualifiers="const">
@ -49,7 +49,13 @@
<method name="get_idle_frames" qualifiers="const">
<return type="int" />
<description>
Returns the total number of frames passed since engine initialization which is advanced on each [b]idle frame[/b], regardless of whether the render loop is enabled. See also [method get_frames_drawn].
Returns the total number of frames passed since engine initialization which is advanced on each [b]idle frame[/b], regardless of whether the render loop is enabled. See also [method get_frames_drawn] and [method get_physics_frames].
[method get_idle_frames] can be used to run expensive logic less often without relying on a [Timer]:
[codeblock]
func _process(_delta):
if Engine.get_idle_frames() % 2 == 0:
pass # Run expensive logic only once every 2 idle (render) frames here.
[/codeblock]
</description>
</method>
<method name="get_license_info" qualifiers="const">
@ -73,7 +79,13 @@
<method name="get_physics_frames" qualifiers="const">
<return type="int" />
<description>
Returns the total number of frames passed since engine initialization which is advanced on each [b]physics frame[/b].
Returns the total number of frames passed since engine initialization which is advanced on each [b]physics frame[/b]. See also [method get_idle_frames].
[method get_physics_frames] can be used to run expensive logic less often without relying on a [Timer]:
[codeblock]
func _physics_process(_delta):
if Engine.get_physics_frames() % 2 == 0:
pass # Run expensive logic only once every 2 physics frames here.
[/codeblock]
</description>
</method>
<method name="get_physics_interpolation_fraction" qualifiers="const">