diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/Engine.xml | 19 |
1 files changed, 14 insertions, 5 deletions
diff --git a/doc/classes/Engine.xml b/doc/classes/Engine.xml index 2372c619f5..5bb0810296 100644 --- a/doc/classes/Engine.xml +++ b/doc/classes/Engine.xml @@ -1,8 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="Engine" inherits="Object" category="Core" version="3.0.alpha.custom_build"> <brief_description> + Access to basic engine properties. </brief_description> <description> + The [Engine] class allows you to query and modify the game's run-time parameters, such as frames per second, time scale, and others. </description> <tutorials> </tutorials> @@ -13,7 +15,7 @@ <return type="int"> </return> <description> - Return the total amount of frames drawn. + Returns the total number of frames drawn. </description> </method> <method name="get_frames_per_second" qualifiers="const"> @@ -27,26 +29,28 @@ <return type="int"> </return> <description> - Return the amount of fixed iterations per second (for fixed process and physics). + Returns the number of fixed iterations per second (for fixed process and physics). </description> </method> <method name="get_main_loop" qualifiers="const"> <return type="MainLoop"> </return> <description> - Return the main loop object (see [MainLoop] and [SceneTree]). + Returns the main loop object (see [MainLoop] and [SceneTree]). </description> </method> <method name="get_target_fps" qualifiers="const"> <return type="float"> </return> <description> + Returns the desired frames per second. If the hardware cannot keep up, this setting may not be respected. It defaults to 0, which indicates no limit. </description> </method> <method name="get_time_scale"> <return type="float"> </return> <description> + Returns how fast or slow the in-game clock ticks versus the real life one. It defaults to 1.0. A value of 2.0 means the game moves twice as fast as real life, whilst a value of 0.5 means the game moves at half the regular speed. </description> </method> <method name="get_version_info" qualifiers="const"> @@ -67,12 +71,14 @@ <return type="bool"> </return> <description> + Returns [code]true[/code] if the editor is running. </description> </method> - <method name="is_in_fixed_frame" qualifiers="const"> + <method name="is_in_physics_frame" qualifiers="const"> <return type="bool"> </return> <description> + Returns [code]true[/code] if the game is inside the fixed process and physics phase of the game loop. </description> </method> <method name="set_editor_hint"> @@ -81,6 +87,7 @@ <argument index="0" name="enabled" type="bool"> </argument> <description> + Sets the running inside the editor hint if [code]enabled[/code] is [code]true[/code]. </description> </method> <method name="set_iterations_per_second"> @@ -89,7 +96,7 @@ <argument index="0" name="iterations_per_second" type="int"> </argument> <description> - Set the amount of fixed iterations per second (for fixed process and physics). + Sets the number of fixed iterations per second (for fixed process and physics). </description> </method> <method name="set_target_fps"> @@ -98,6 +105,7 @@ <argument index="0" name="target_fps" type="int"> </argument> <description> + Sets the target frames per second. </description> </method> <method name="set_time_scale"> @@ -106,6 +114,7 @@ <argument index="0" name="time_scale" type="float"> </argument> <description> + Sets the time scale. </description> </method> </methods> |