class_resourceloader.rst 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
  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. Member Functions
  13. ----------------
  14. +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  15. | :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_dependencies<class_ResourceLoader_get_dependencies>` **(** :ref:`String<class_string>` path **)** |
  16. +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  17. | :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_recognized_extensions_for_type<class_ResourceLoader_get_recognized_extensions_for_type>` **(** :ref:`String<class_string>` type **)** |
  18. +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  19. | :ref:`bool<class_bool>` | :ref:`has<class_ResourceLoader_has>` **(** :ref:`String<class_string>` path **)** |
  20. +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  21. | :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 **)** |
  22. +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  23. | :ref:`ResourceInteractiveLoader<class_resourceinteractiveloader>` | :ref:`load_interactive<class_ResourceLoader_load_interactive>` **(** :ref:`String<class_string>` path, :ref:`String<class_string>` type_hint="" **)** |
  24. +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  25. | void | :ref:`set_abort_on_missing_resources<class_ResourceLoader_set_abort_on_missing_resources>` **(** :ref:`bool<class_bool>` abort **)** |
  26. +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  27. Description
  28. -----------
  29. Resource Loader. This is a static object accessible as ``ResourceLoader``. GDScript has a simplified load() function, though.
  30. Member Function Description
  31. ---------------------------
  32. .. _class_ResourceLoader_get_dependencies:
  33. - :ref:`PoolStringArray<class_poolstringarray>` **get_dependencies** **(** :ref:`String<class_string>` path **)**
  34. .. _class_ResourceLoader_get_recognized_extensions_for_type:
  35. - :ref:`PoolStringArray<class_poolstringarray>` **get_recognized_extensions_for_type** **(** :ref:`String<class_string>` type **)**
  36. Return the list of recognized extensions for a resource type.
  37. .. _class_ResourceLoader_has:
  38. - :ref:`bool<class_bool>` **has** **(** :ref:`String<class_string>` path **)**
  39. .. _class_ResourceLoader_load:
  40. - :ref:`Resource<class_resource>` **load** **(** :ref:`String<class_string>` path, :ref:`String<class_string>` type_hint="", :ref:`bool<class_bool>` p_no_cache=false **)**
  41. .. _class_ResourceLoader_load_interactive:
  42. - :ref:`ResourceInteractiveLoader<class_resourceinteractiveloader>` **load_interactive** **(** :ref:`String<class_string>` path, :ref:`String<class_string>` type_hint="" **)**
  43. Load a resource interactively, the returned object allows to load with high granularity.
  44. .. _class_ResourceLoader_set_abort_on_missing_resources:
  45. - void **set_abort_on_missing_resources** **(** :ref:`bool<class_bool>` abort **)**
  46. Change the behavior on missing sub-resources. Default is to abort load.