diff --git a/doc/classes/Engine.xml b/doc/classes/Engine.xml index 2372c619f53..5bb08102965 100644 --- a/doc/classes/Engine.xml +++ b/doc/classes/Engine.xml @@ -1,8 +1,10 @@ + Access to basic engine properties. + The [Engine] class allows you to query and modify the game's run-time parameters, such as frames per second, time scale, and others. @@ -13,7 +15,7 @@ - Return the total amount of frames drawn. + Returns the total number of frames drawn. @@ -27,26 +29,28 @@ - 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). - Return the main loop object (see [MainLoop] and [SceneTree]). + Returns the main loop object (see [MainLoop] and [SceneTree]). + 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. + 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. @@ -67,12 +71,14 @@ + Returns [code]true[/code] if the editor is running. - + + Returns [code]true[/code] if the game is inside the fixed process and physics phase of the game loop. @@ -81,6 +87,7 @@ + Sets the running inside the editor hint if [code]enabled[/code] is [code]true[/code]. @@ -89,7 +96,7 @@ - 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). @@ -98,6 +105,7 @@ + Sets the target frames per second. @@ -106,6 +114,7 @@ + Sets the time scale.