class_javaclass.rst 5.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/JavaClass.xml.
  6. .. _class_JavaClass:
  7. JavaClass
  8. =========
  9. **Inherits:** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. Represents a class from the Java Native Interface.
  11. .. rst-class:: classref-introduction-group
  12. Description
  13. -----------
  14. Represents a class from the Java Native Interface. It is returned from :ref:`JavaClassWrapper.wrap()<class_JavaClassWrapper_method_wrap>`.
  15. \ **Note:** This class only works on Android. On any other platform, this class does nothing.
  16. \ **Note:** This class is not to be confused with :ref:`JavaScriptObject<class_JavaScriptObject>`.
  17. .. rst-class:: classref-reftable-group
  18. Methods
  19. -------
  20. .. table::
  21. :widths: auto
  22. +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
  23. | :ref:`String<class_String>` | :ref:`get_java_class_name<class_JavaClass_method_get_java_class_name>`\ (\ ) |const| |
  24. +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
  25. | :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] | :ref:`get_java_method_list<class_JavaClass_method_get_java_method_list>`\ (\ ) |const| |
  26. +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
  27. | :ref:`JavaClass<class_JavaClass>` | :ref:`get_java_parent_class<class_JavaClass_method_get_java_parent_class>`\ (\ ) |const| |
  28. +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
  29. | :ref:`bool<class_bool>` | :ref:`has_java_method<class_JavaClass_method_has_java_method>`\ (\ method\: :ref:`StringName<class_StringName>`\ ) |const| |
  30. +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
  31. .. rst-class:: classref-section-separator
  32. ----
  33. .. rst-class:: classref-descriptions-group
  34. Method Descriptions
  35. -------------------
  36. .. _class_JavaClass_method_get_java_class_name:
  37. .. rst-class:: classref-method
  38. :ref:`String<class_String>` **get_java_class_name**\ (\ ) |const| :ref:`🔗<class_JavaClass_method_get_java_class_name>`
  39. Returns the Java class name.
  40. .. rst-class:: classref-item-separator
  41. ----
  42. .. _class_JavaClass_method_get_java_method_list:
  43. .. rst-class:: classref-method
  44. :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] **get_java_method_list**\ (\ ) |const| :ref:`🔗<class_JavaClass_method_get_java_method_list>`
  45. Returns the object's Java methods and their signatures as an :ref:`Array<class_Array>` of dictionaries, in the same format as :ref:`Object.get_method_list()<class_Object_method_get_method_list>`.
  46. .. rst-class:: classref-item-separator
  47. ----
  48. .. _class_JavaClass_method_get_java_parent_class:
  49. .. rst-class:: classref-method
  50. :ref:`JavaClass<class_JavaClass>` **get_java_parent_class**\ (\ ) |const| :ref:`🔗<class_JavaClass_method_get_java_parent_class>`
  51. Returns a **JavaClass** representing the Java parent class of this class.
  52. .. rst-class:: classref-item-separator
  53. ----
  54. .. _class_JavaClass_method_has_java_method:
  55. .. rst-class:: classref-method
  56. :ref:`bool<class_bool>` **has_java_method**\ (\ method\: :ref:`StringName<class_StringName>`\ ) |const| :ref:`🔗<class_JavaClass_method_has_java_method>`
  57. Returns ``true`` if the given ``method`` name exists in the object's Java methods.
  58. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  59. .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
  60. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  61. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  62. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  63. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  64. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  65. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  66. .. |void| replace:: :abbr:`void (No return value.)`