summaryrefslogtreecommitdiff
path: root/doc/classes/Engine.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/Engine.xml')
-rw-r--r--doc/classes/Engine.xml114
1 files changed, 114 insertions, 0 deletions
diff --git a/doc/classes/Engine.xml b/doc/classes/Engine.xml
new file mode 100644
index 0000000000..2372c619f5
--- /dev/null
+++ b/doc/classes/Engine.xml
@@ -0,0 +1,114 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="Engine" inherits="Object" category="Core" version="3.0.alpha.custom_build">
+ <brief_description>
+ </brief_description>
+ <description>
+ </description>
+ <tutorials>
+ </tutorials>
+ <demos>
+ </demos>
+ <methods>
+ <method name="get_frames_drawn">
+ <return type="int">
+ </return>
+ <description>
+ Return the total amount of frames drawn.
+ </description>
+ </method>
+ <method name="get_frames_per_second" qualifiers="const">
+ <return type="float">
+ </return>
+ <description>
+ Returns the frames per second of the running game.
+ </description>
+ </method>
+ <method name="get_iterations_per_second" qualifiers="const">
+ <return type="int">
+ </return>
+ <description>
+ Return the amount 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]).
+ </description>
+ </method>
+ <method name="get_target_fps" qualifiers="const">
+ <return type="float">
+ </return>
+ <description>
+ </description>
+ </method>
+ <method name="get_time_scale">
+ <return type="float">
+ </return>
+ <description>
+ </description>
+ </method>
+ <method name="get_version_info" qualifiers="const">
+ <return type="Dictionary">
+ </return>
+ <description>
+ Returns the current engine version information in a Dictionary.
+
+ "major" - Holds the major version number as a String
+ "minor" - Holds the minor version number as a String
+ "patch" - Holds the patch version number as a String
+ "status" - Holds the status (e.g. "beta", "rc1", "rc2", ... "stable") as a String
+ "revision" - Holds the revision (e.g. "custom-build") as a String
+ "string" - major + minor + patch + status + revision in a single String
+ </description>
+ </method>
+ <method name="is_editor_hint" qualifiers="const">
+ <return type="bool">
+ </return>
+ <description>
+ </description>
+ </method>
+ <method name="is_in_fixed_frame" qualifiers="const">
+ <return type="bool">
+ </return>
+ <description>
+ </description>
+ </method>
+ <method name="set_editor_hint">
+ <return type="void">
+ </return>
+ <argument index="0" name="enabled" type="bool">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="set_iterations_per_second">
+ <return type="void">
+ </return>
+ <argument index="0" name="iterations_per_second" type="int">
+ </argument>
+ <description>
+ Set the amount of fixed iterations per second (for fixed process and physics).
+ </description>
+ </method>
+ <method name="set_target_fps">
+ <return type="void">
+ </return>
+ <argument index="0" name="target_fps" type="int">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="set_time_scale">
+ <return type="void">
+ </return>
+ <argument index="0" name="time_scale" type="float">
+ </argument>
+ <description>
+ </description>
+ </method>
+ </methods>
+ <constants>
+ </constants>
+</class>