virtualx-engine/modules/mono/doc_classes/GodotSharp.xml

66 lines
2.6 KiB
XML
Raw Normal View History

2017-10-02 23:24:00 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
<class name="GodotSharp" inherits="Object" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
2017-10-02 23:24:00 +02:00
<brief_description>
Bridge between Godot and the Mono runtime (Mono-enabled builds only).
2017-10-02 23:24:00 +02:00
</brief_description>
<description>
This class is a bridge between Godot and the Mono runtime. It exposes several low-level operations and is only available in Mono-enabled Godot builds.
See also [CSharpScript].
2017-10-02 23:24:00 +02:00
</description>
<tutorials>
</tutorials>
<methods>
<method name="attach_thread">
2021-10-01 08:14:54 +02:00
<return type="void" />
2017-10-02 23:24:00 +02:00
<description>
Attaches the current thread to the Mono runtime.
2017-10-02 23:24:00 +02:00
</description>
</method>
<method name="detach_thread">
2021-10-01 08:14:54 +02:00
<return type="void" />
2017-10-02 23:24:00 +02:00
<description>
Detaches the current thread from the Mono runtime.
2017-10-02 23:24:00 +02:00
</description>
</method>
2018-10-07 15:52:07 +02:00
<method name="get_domain_id">
2021-10-01 08:14:54 +02:00
<return type="int" />
2018-10-07 15:52:07 +02:00
<description>
Returns the current MonoDomain ID.
[b]Note:[/b] The Mono runtime must be initialized for this method to work (use [method is_runtime_initialized] to check). If the Mono runtime isn't initialized at the time this method is called, the engine will crash.
2018-10-07 15:52:07 +02:00
</description>
</method>
<method name="get_scripts_domain_id">
2021-10-01 08:14:54 +02:00
<return type="int" />
2018-10-07 15:52:07 +02:00
<description>
Returns the scripts MonoDomain's ID. This will be the same MonoDomain ID as [method get_domain_id], unless the scripts domain isn't loaded.
[b]Note:[/b] The Mono runtime must be initialized for this method to work (use [method is_runtime_initialized] to check). If the Mono runtime isn't initialized at the time this method is called, the engine will crash.
2018-10-07 15:52:07 +02:00
</description>
</method>
<method name="is_domain_finalizing_for_unload">
2021-10-01 08:14:54 +02:00
<return type="bool" />
<argument index="0" name="domain_id" type="int" />
2018-10-07 15:52:07 +02:00
<description>
Returns [code]true[/code] if the domain is being finalized, [code]false[/code] otherwise.
2018-10-07 15:52:07 +02:00
</description>
</method>
<method name="is_runtime_initialized">
2021-10-01 08:14:54 +02:00
<return type="bool" />
2018-10-07 15:52:07 +02:00
<description>
Returns [code]true[/code] if the Mono runtime is initialized, [code]false[/code] otherwise.
2018-10-07 15:52:07 +02:00
</description>
</method>
<method name="is_runtime_shutting_down">
2021-10-01 08:14:54 +02:00
<return type="bool" />
2017-10-02 23:24:00 +02:00
<description>
Returns [code]true[/code] if the Mono runtime is shutting down, [code]false[/code] otherwise.
2017-10-02 23:24:00 +02:00
</description>
</method>
2018-10-07 15:52:07 +02:00
<method name="is_scripts_domain_loaded">
2021-10-01 08:14:54 +02:00
<return type="bool" />
2017-10-02 23:24:00 +02:00
<description>
Returns [code]true[/code] if the scripts domain is loaded, [code]false[/code] otherwise.
2017-10-02 23:24:00 +02:00
</description>
</method>
</methods>
</class>