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

Merge pull request #35131 from Xrayez/doc-engine-frames

Browse source 
Document `Engine.get_idle/physics_frames` methods
This commit is contained in:
Rémi Verschelde 2020-01-14 22:03:39 +01:00 committed by GitHub
commit 42d3d06195
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
doc/classes/Engine.xml
View file

@ -41,7 +41,7 @@
<return type="int">
</return>
<description>
Returns the total number of frames drawn.
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].
</description>
</method>
<method name="get_frames_per_second" qualifiers="const">
@ -51,6 +51,13 @@
Returns the frames per second of the running game.
</description>
</method>
<method name="get_idle_frames" qualifiers="const">
<return type="int">
</return>
<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].
</description>
</method>
<method name="get_license_info" qualifiers="const">
<return type="Dictionary">
</return>
@ -72,6 +79,13 @@
Returns the main loop object (see [MainLoop] and [SceneTree]).
</description>
</method>
<method name="get_physics_frames" qualifiers="const">
<return type="int">
</return>
<description>
Returns the total number of frames passed since engine initialization which is advanced on each [b]physics frame[/b].
</description>
</method>
<method name="get_physics_interpolation_fraction" qualifiers="const">
<return type="float">
</return>