class_resourceloader.rst 6.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the ResourceLoader.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_ResourceLoader:
  5. ResourceLoader
  6. ==============
  7. **Inherits:** :ref:`Object<class_Object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Resource Loader.
  12. Methods
  13. -------
  14. +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  15. | :ref:`bool<class_bool>` | :ref:`exists<class_ResourceLoader_exists>` **(** :ref:`String<class_String>` path, :ref:`String<class_String>` type_hint="" **)** |
  16. +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  17. | :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`get_dependencies<class_ResourceLoader_get_dependencies>` **(** :ref:`String<class_String>` path **)** |
  18. +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  19. | :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`get_recognized_extensions_for_type<class_ResourceLoader_get_recognized_extensions_for_type>` **(** :ref:`String<class_String>` type **)** |
  20. +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  21. | :ref:`bool<class_bool>` | :ref:`has<class_ResourceLoader_has>` **(** :ref:`String<class_String>` path **)** |
  22. +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  23. | :ref:`bool<class_bool>` | :ref:`has_cached<class_ResourceLoader_has_cached>` **(** :ref:`String<class_String>` path **)** |
  24. +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  25. | :ref:`Resource<class_Resource>` | :ref:`load<class_ResourceLoader_load>` **(** :ref:`String<class_String>` path, :ref:`String<class_String>` type_hint="", :ref:`bool<class_bool>` p_no_cache=false **)** |
  26. +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  27. | :ref:`ResourceInteractiveLoader<class_ResourceInteractiveLoader>` | :ref:`load_interactive<class_ResourceLoader_load_interactive>` **(** :ref:`String<class_String>` path, :ref:`String<class_String>` type_hint="" **)** |
  28. +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  29. | void | :ref:`set_abort_on_missing_resources<class_ResourceLoader_set_abort_on_missing_resources>` **(** :ref:`bool<class_bool>` abort **)** |
  30. +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  31. Description
  32. -----------
  33. Resource Loader. This is a static object accessible as ``ResourceLoader``. GDScript has a simplified load() function, though.
  34. Method Descriptions
  35. -------------------
  36. .. _class_ResourceLoader_exists:
  37. - :ref:`bool<class_bool>` **exists** **(** :ref:`String<class_String>` path, :ref:`String<class_String>` type_hint="" **)**
  38. .. _class_ResourceLoader_get_dependencies:
  39. - :ref:`PoolStringArray<class_PoolStringArray>` **get_dependencies** **(** :ref:`String<class_String>` path **)**
  40. .. _class_ResourceLoader_get_recognized_extensions_for_type:
  41. - :ref:`PoolStringArray<class_PoolStringArray>` **get_recognized_extensions_for_type** **(** :ref:`String<class_String>` type **)**
  42. Return the list of recognized extensions for a resource type.
  43. .. _class_ResourceLoader_has:
  44. - :ref:`bool<class_bool>` **has** **(** :ref:`String<class_String>` path **)**
  45. .. _class_ResourceLoader_has_cached:
  46. - :ref:`bool<class_bool>` **has_cached** **(** :ref:`String<class_String>` path **)**
  47. .. _class_ResourceLoader_load:
  48. - :ref:`Resource<class_Resource>` **load** **(** :ref:`String<class_String>` path, :ref:`String<class_String>` type_hint="", :ref:`bool<class_bool>` p_no_cache=false **)**
  49. .. _class_ResourceLoader_load_interactive:
  50. - :ref:`ResourceInteractiveLoader<class_ResourceInteractiveLoader>` **load_interactive** **(** :ref:`String<class_String>` path, :ref:`String<class_String>` type_hint="" **)**
  51. Load a resource interactively, the returned object allows to load with high granularity.
  52. .. _class_ResourceLoader_set_abort_on_missing_resources:
  53. - void **set_abort_on_missing_resources** **(** :ref:`bool<class_bool>` abort **)**
  54. Change the behavior on missing sub-resources. Default is to abort load.