class_nativescript.rst 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the NativeScript.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_NativeScript:
  5. NativeScript
  6. ============
  7. **Inherits:** :ref:`Script<class_script>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Member Functions
  12. ----------------
  13. +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
  14. | :ref:`String<class_string>` | :ref:`get_class_documentation<class_NativeScript_get_class_documentation>` **(** **)** const |
  15. +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
  16. | :ref:`String<class_string>` | :ref:`get_method_documentation<class_NativeScript_get_method_documentation>` **(** :ref:`String<class_string>` method **)** const |
  17. +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
  18. | :ref:`String<class_string>` | :ref:`get_property_documentation<class_NativeScript_get_property_documentation>` **(** :ref:`String<class_string>` path **)** const |
  19. +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
  20. | :ref:`String<class_string>` | :ref:`get_signal_documentation<class_NativeScript_get_signal_documentation>` **(** :ref:`String<class_string>` signal_name **)** const |
  21. +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
  22. | :ref:`Object<class_object>` | :ref:`new<class_NativeScript_new>` **(** **)** vararg |
  23. +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
  24. Member Variables
  25. ----------------
  26. .. _class_NativeScript_class_name:
  27. - :ref:`String<class_string>` **class_name**
  28. .. _class_NativeScript_library:
  29. - :ref:`GDNativeLibrary<class_gdnativelibrary>` **library**
  30. Member Function Description
  31. ---------------------------
  32. .. _class_NativeScript_get_class_documentation:
  33. - :ref:`String<class_string>` **get_class_documentation** **(** **)** const
  34. Returns the documentation string that was previously set with ``godot_nativescript_set_class_documentation``.
  35. .. _class_NativeScript_get_method_documentation:
  36. - :ref:`String<class_string>` **get_method_documentation** **(** :ref:`String<class_string>` method **)** const
  37. Returns the documentation string that was previously set with ``godot_nativescript_set_method_documentation``.
  38. .. _class_NativeScript_get_property_documentation:
  39. - :ref:`String<class_string>` **get_property_documentation** **(** :ref:`String<class_string>` path **)** const
  40. Returns the documentation string that was previously set with ``godot_nativescript_set_property_documentation``.
  41. .. _class_NativeScript_get_signal_documentation:
  42. - :ref:`String<class_string>` **get_signal_documentation** **(** :ref:`String<class_string>` signal_name **)** const
  43. Returns the documentation string that was previously set with ``godot_nativescript_set_signal_documentation``.
  44. .. _class_NativeScript_new:
  45. - :ref:`Object<class_object>` **new** **(** **)** vararg
  46. Constructs a new object of the base type with a script of this type already attached.
  47. *Note*: Any arguments passed to this function will be ignored and not passed to the native constructor function. This will change with in a future API extension.