diff options
| author | Andrii Doroshenko (Xrayez) <xrayez@gmail.com> | 2020-01-14 22:13:03 +0200 |
|---|---|---|
| committer | Andrii Doroshenko (Xrayez) <xrayez@gmail.com> | 2020-01-14 22:32:32 +0200 |
| commit | 42567bffb9c6ab8fab21968401d687448b450efe (patch) | |
| tree | b89910fc339cf34d87dda62073e0b7348d63a476 | |
| parent | 562bc1941d390f2897ef04992e2bcdfda616d7a6 (diff) | |
Document `Engine.get_idle/physics_frames` methods
| -rw-r--r-- | doc/classes/Engine.xml | 16 |
1 files changed, 15 insertions, 1 deletions
diff --git a/doc/classes/Engine.xml b/doc/classes/Engine.xml index 04e203793b..53ddde0e4a 100644 --- a/doc/classes/Engine.xml +++ b/doc/classes/Engine.xml @@ -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> |