class_resourceloader.rst 5.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
  3. .. _class_ResourceLoader:
  4. ResourceLoader
  5. ==============
  6. **Inherits:** :ref:`Object<class_object>`
  7. **Category:** Core
  8. Brief Description
  9. -----------------
  10. Resource Loader.
  11. Member Functions
  12. ----------------
  13. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  14. | :ref:`StringArray<class_stringarray>` | :ref:`get_dependencies<class_ResourceLoader_get_dependencies>` **(** :ref:`String<class_string>` path **)** |
  15. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  16. | :ref:`StringArray<class_stringarray>` | :ref:`get_recognized_extensions_for_type<class_ResourceLoader_get_recognized_extensions_for_type>` **(** :ref:`String<class_string>` type **)** |
  17. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  18. | :ref:`bool<class_bool>` | :ref:`has<class_ResourceLoader_has>` **(** :ref:`String<class_string>` path **)** |
  19. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  20. | :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 **)** |
  21. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  22. | :ref:`ResourceImportMetadata<class_resourceimportmetadata>` | :ref:`load_import_metadata<class_ResourceLoader_load_import_metadata>` **(** :ref:`String<class_string>` path **)** |
  23. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  24. | :ref:`ResourceInteractiveLoader<class_resourceinteractiveloader>` | :ref:`load_interactive<class_ResourceLoader_load_interactive>` **(** :ref:`String<class_string>` path, :ref:`String<class_string>` type_hint="" **)** |
  25. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  26. | void | :ref:`set_abort_on_missing_resources<class_ResourceLoader_set_abort_on_missing_resources>` **(** :ref:`bool<class_bool>` abort **)** |
  27. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  28. Description
  29. -----------
  30. Resource Loader. This is a static object accessible as :ref:`ResourceLoader<class_resourceloader>`. GDScript has a simplified load() function, though.
  31. Member Function Description
  32. ---------------------------
  33. .. _class_ResourceLoader_get_dependencies:
  34. - :ref:`StringArray<class_stringarray>` **get_dependencies** **(** :ref:`String<class_string>` path **)**
  35. .. _class_ResourceLoader_get_recognized_extensions_for_type:
  36. - :ref:`StringArray<class_stringarray>` **get_recognized_extensions_for_type** **(** :ref:`String<class_string>` type **)**
  37. Return the list of recognized extensions for a resource type.
  38. .. _class_ResourceLoader_has:
  39. - :ref:`bool<class_bool>` **has** **(** :ref:`String<class_string>` path **)**
  40. .. _class_ResourceLoader_load:
  41. - :ref:`Resource<class_resource>` **load** **(** :ref:`String<class_string>` path, :ref:`String<class_string>` type_hint="", :ref:`bool<class_bool>` p_no_cache=false **)**
  42. .. _class_ResourceLoader_load_import_metadata:
  43. - :ref:`ResourceImportMetadata<class_resourceimportmetadata>` **load_import_metadata** **(** :ref:`String<class_string>` path **)**
  44. .. _class_ResourceLoader_load_interactive:
  45. - :ref:`ResourceInteractiveLoader<class_resourceinteractiveloader>` **load_interactive** **(** :ref:`String<class_string>` path, :ref:`String<class_string>` type_hint="" **)**
  46. Load a resource interactively, the returned object allows to load with high granularity.
  47. .. _class_ResourceLoader_set_abort_on_missing_resources:
  48. - void **set_abort_on_missing_resources** **(** :ref:`bool<class_bool>` abort **)**
  49. Change the behavior on missing sub-resources. Default is to abort load.