classref: Sync with current master branch (cb7cd81)

classes/class_godotinstance.rst

@@ -0,0 +1,145 @@
+:github_url: hide
+
+.. DO NOT EDIT THIS FILE!!!
+.. Generated automatically from Godot engine sources.
+.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
+.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/GodotInstance.xml.
+
+.. _class_GodotInstance:
+
+GodotInstance
+=============
+
+**Inherits:** :ref:`Object<class_Object>`
+
+Provides access to an embedded Godot instance.
+
+.. rst-class:: classref-introduction-group
+
+Description
+-----------
+
+GodotInstance represents a running Godot instance that is controlled from an outside codebase, without a perpetual main loop. It is created by the C API ``libgodot_create_godot_instance``. Only one may be created per process.
+
+.. rst-class:: classref-reftable-group
+
+Methods
+-------
+
+.. table::
+   :widths: auto
+
+   +-------------------------+----------------------------------------------------------------+
+   | |void|                  | :ref:`focus_in<class_GodotInstance_method_focus_in>`\ (\ )     |
+   +-------------------------+----------------------------------------------------------------+
+   | |void|                  | :ref:`focus_out<class_GodotInstance_method_focus_out>`\ (\ )   |
+   +-------------------------+----------------------------------------------------------------+
+   | :ref:`bool<class_bool>` | :ref:`is_started<class_GodotInstance_method_is_started>`\ (\ ) |
+   +-------------------------+----------------------------------------------------------------+
+   | :ref:`bool<class_bool>` | :ref:`iteration<class_GodotInstance_method_iteration>`\ (\ )   |
+   +-------------------------+----------------------------------------------------------------+
+   | |void|                  | :ref:`pause<class_GodotInstance_method_pause>`\ (\ )           |
+   +-------------------------+----------------------------------------------------------------+
+   | |void|                  | :ref:`resume<class_GodotInstance_method_resume>`\ (\ )         |
+   +-------------------------+----------------------------------------------------------------+
+   | :ref:`bool<class_bool>` | :ref:`start<class_GodotInstance_method_start>`\ (\ )           |
+   +-------------------------+----------------------------------------------------------------+
+
+.. rst-class:: classref-section-separator
+
+----
+
+.. rst-class:: classref-descriptions-group
+
+Method Descriptions
+-------------------
+
+.. _class_GodotInstance_method_focus_in:
+
+.. rst-class:: classref-method
+
+|void| **focus_in**\ (\ ) :ref:`🔗<class_GodotInstance_method_focus_in>`
+
+Notifies the instance that it is now in focus.
+
+.. rst-class:: classref-item-separator
+
+----
+
+.. _class_GodotInstance_method_focus_out:
+
+.. rst-class:: classref-method
+
+|void| **focus_out**\ (\ ) :ref:`🔗<class_GodotInstance_method_focus_out>`
+
+Notifies the instance that it is now not in focus.
+
+.. rst-class:: classref-item-separator
+
+----
+
+.. _class_GodotInstance_method_is_started:
+
+.. rst-class:: classref-method
+
+:ref:`bool<class_bool>` **is_started**\ (\ ) :ref:`🔗<class_GodotInstance_method_is_started>`
+
+Returns ``true`` if this instance has been fully started.
+
+.. rst-class:: classref-item-separator
+
+----
+
+.. _class_GodotInstance_method_iteration:
+
+.. rst-class:: classref-method
+
+:ref:`bool<class_bool>` **iteration**\ (\ ) :ref:`🔗<class_GodotInstance_method_iteration>`
+
+Runs a single iteration of the main loop. Returns ``true`` if the engine is attempting to quit.
+
+.. rst-class:: classref-item-separator
+
+----
+
+.. _class_GodotInstance_method_pause:
+
+.. rst-class:: classref-method
+
+|void| **pause**\ (\ ) :ref:`🔗<class_GodotInstance_method_pause>`
+
+Notifies the instance that it is going to be paused.
+
+.. rst-class:: classref-item-separator
+
+----
+
+.. _class_GodotInstance_method_resume:
+
+.. rst-class:: classref-method
+
+|void| **resume**\ (\ ) :ref:`🔗<class_GodotInstance_method_resume>`
+
+Notifies the instance that it is being resumed.
+
+.. rst-class:: classref-item-separator
+
+----
+
+.. _class_GodotInstance_method_start:
+
+.. rst-class:: classref-method
+
+:ref:`bool<class_bool>` **start**\ (\ ) :ref:`🔗<class_GodotInstance_method_start>`
+
+Finishes this instance's startup sequence. Returns ``true`` on success.
+
+.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
+.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
+.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
+.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
+.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
+.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
+.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
+.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
+.. |void| replace:: :abbr:`void (No return value.)`