GodotSharp.xml 2.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="GodotSharp" inherits="Object" category="Core" version="3.4">
  3. <brief_description>
  4. Bridge between Godot and the Mono runtime (Mono-enabled builds only).
  5. </brief_description>
  6. <description>
  7. 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.
  8. See also [CSharpScript].
  9. </description>
  10. <tutorials>
  11. </tutorials>
  12. <methods>
  13. <method name="attach_thread">
  14. <return type="void">
  15. </return>
  16. <description>
  17. Attaches the current thread to the Mono runtime.
  18. </description>
  19. </method>
  20. <method name="detach_thread">
  21. <return type="void">
  22. </return>
  23. <description>
  24. Detaches the current thread from the Mono runtime.
  25. </description>
  26. </method>
  27. <method name="get_domain_id">
  28. <return type="int">
  29. </return>
  30. <description>
  31. Returns the current MonoDomain ID.
  32. [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.
  33. </description>
  34. </method>
  35. <method name="get_scripts_domain_id">
  36. <return type="int">
  37. </return>
  38. <description>
  39. 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.
  40. [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.
  41. </description>
  42. </method>
  43. <method name="is_domain_finalizing_for_unload">
  44. <return type="bool">
  45. </return>
  46. <argument index="0" name="domain_id" type="int">
  47. </argument>
  48. <description>
  49. Returns [code]true[/code] if the domain is being finalized, [code]false[/code] otherwise.
  50. </description>
  51. </method>
  52. <method name="is_runtime_initialized">
  53. <return type="bool">
  54. </return>
  55. <description>
  56. Returns [code]true[/code] if the Mono runtime is initialized, [code]false[/code] otherwise.
  57. </description>
  58. </method>
  59. <method name="is_runtime_shutting_down">
  60. <return type="bool">
  61. </return>
  62. <description>
  63. Returns [code]true[/code] if the Mono runtime is shutting down, [code]false[/code] otherwise.
  64. </description>
  65. </method>
  66. <method name="is_scripts_domain_loaded">
  67. <return type="bool">
  68. </return>
  69. <description>
  70. Returns [code]true[/code] if the scripts domain is loaded, [code]false[/code] otherwise.
  71. </description>
  72. </method>
  73. </methods>
  74. <constants>
  75. </constants>
  76. </class>