Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Branch: 3.1
Branches Tags
godot-docs
/
classes
/
class_resourceformatloader.rst

class_resourceformatloader.rst 8.4 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899 
  1. :github_url: hide
    2. 

  2. 

  3. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
    4. 

  4. .. DO NOT EDIT THIS FILE, but the ResourceFormatLoader.xml source instead.
    5. 

  5. .. The source is found in doc/classes or modules/<name>/doc_classes.
    6. 

  6. 

  7. .. _class_ResourceFormatLoader:
    8. 

  8. 

  9. ResourceFormatLoader
    10. 

  10. ====================
    11. 

  11. 

  12. **Inherits:** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
    13. 

  13. 

  14. **Inherited By:** :ref:`GDNativeLibraryResourceLoader<class_GDNativeLibraryResourceLoader>`, :ref:`ResourceFormatDDS<class_ResourceFormatDDS>`, :ref:`ResourceFormatImporter<class_ResourceFormatImporter>`, :ref:`ResourceFormatLoaderBMFont<class_ResourceFormatLoaderBMFont>`, :ref:`ResourceFormatLoaderBinary<class_ResourceFormatLoaderBinary>`, :ref:`ResourceFormatLoaderDynamicFont<class_ResourceFormatLoaderDynamicFont>`, :ref:`ResourceFormatLoaderGDScript<class_ResourceFormatLoaderGDScript>`, :ref:`ResourceFormatLoaderImage<class_ResourceFormatLoaderImage>`, :ref:`ResourceFormatLoaderNativeScript<class_ResourceFormatLoaderNativeScript>`, :ref:`ResourceFormatLoaderShader<class_ResourceFormatLoaderShader>`, :ref:`ResourceFormatLoaderStreamTexture<class_ResourceFormatLoaderStreamTexture>`, :ref:`ResourceFormatLoaderText<class_ResourceFormatLoaderText>`, :ref:`ResourceFormatLoaderTextureLayered<class_ResourceFormatLoaderTextureLayered>`, :ref:`ResourceFormatLoaderTheora<class_ResourceFormatLoaderTheora>`, :ref:`ResourceFormatLoaderVideoStreamGDNative<class_ResourceFormatLoaderVideoStreamGDNative>`, :ref:`ResourceFormatLoaderWebm<class_ResourceFormatLoaderWebm>`, :ref:`ResourceFormatPKM<class_ResourceFormatPKM>`, :ref:`ResourceFormatPVR<class_ResourceFormatPVR>`, :ref:`TranslationLoaderPO<class_TranslationLoaderPO>`
    15. 

  15. 

  16. **Category:** Core
    17. 

  17. 

  18. Brief Description
    19. 

  19. -----------------
    20. 

  20. 

  21. Loads a specific resource type from a file.
    22. 

  22. 

  23. Methods
    24. 

  24. -------
    25. 

  25. 

  26. +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    27. 

  27. | void                                          | :ref:`get_dependencies<class_ResourceFormatLoader_method_get_dependencies>` **(** :ref:`String<class_String>` path, :ref:`String<class_String>` add_types **)** virtual     |
    28. 

  28. +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    29. 

  29. | :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`get_recognized_extensions<class_ResourceFormatLoader_method_get_recognized_extensions>` **(** **)** virtual                                                           |
    30. 

  30. +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    31. 

  31. | :ref:`String<class_String>`                   | :ref:`get_resource_type<class_ResourceFormatLoader_method_get_resource_type>` **(** :ref:`String<class_String>` path **)** virtual                                          |
    32. 

  32. +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    33. 

  33. | :ref:`bool<class_bool>`                       | :ref:`handles_type<class_ResourceFormatLoader_method_handles_type>` **(** :ref:`String<class_String>` typename **)** virtual                                                |
    34. 

  34. +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    35. 

  35. | :ref:`Variant<class_Variant>`                 | :ref:`load<class_ResourceFormatLoader_method_load>` **(** :ref:`String<class_String>` path, :ref:`String<class_String>` original_path **)** virtual                         |
    36. 

  36. +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    37. 

  37. | :ref:`int<class_int>`                         | :ref:`rename_dependencies<class_ResourceFormatLoader_method_rename_dependencies>` **(** :ref:`String<class_String>` path, :ref:`String<class_String>` renames **)** virtual |
    38. 

  38. +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    39. 

  39. 

  40. Description
    41. 

  41. -----------
    42. 

  42. 

  43. Godot loads resources in the editor or in exported games using ResourceFormatLoaders. They are queried automatically via the :ref:`ResourceLoader<class_ResourceLoader>` singleton, or when a resource with internal dependencies is loaded. Each file type may load as a different resource type, so multiple ResourceFormatLoaders are registered in the engine.
    44. 

  44. 

  45. Extending this class allows you to define your own loader. Be sure to respect the documented return types and values. You should give it a global class name with ``class_name`` for it to be registered. Like built-in ResourceFormatLoaders, it will be called automatically when loading resources of its handled type(s). You may also implement a :ref:`ResourceFormatSaver<class_ResourceFormatSaver>`.
    46. 

  46. 

  47. Note: You can also extend :ref:`EditorImportPlugin<class_EditorImportPlugin>` if the resource type you need exists but Godot is unable to load its format. Choosing one way over another depends if the format is suitable or not for the final exported game. For example, it's better to import ``.png`` textures as ``.stex`` (:ref:`StreamTexture<class_StreamTexture>`) first, so they can be loaded with better efficiency on the graphics card.
    48. 

  48. 

  49. Method Descriptions
    50. 

  50. -------------------
    51. 

  51. 

  52. .. _class_ResourceFormatLoader_method_get_dependencies:
    53. 

  53. 

  54. - void **get_dependencies** **(** :ref:`String<class_String>` path, :ref:`String<class_String>` add_types **)** virtual
    55. 

  55. 

  56. If implemented, gets the dependencies of a given resource. If ``add_types`` is ``true``, paths should be appended ``::TypeName``, where ``TypeName`` is the class name of the dependency. Note that custom resource types defined by scripts aren't known by the :ref:`ClassDB<class_ClassDB>`, so you might just return ``"Resource"`` for them.
    57. 

  57. 

  58. ----
    59. 

  59. 

  60. .. _class_ResourceFormatLoader_method_get_recognized_extensions:
    61. 

  61. 

  62. - :ref:`PoolStringArray<class_PoolStringArray>` **get_recognized_extensions** **(** **)** virtual
    63. 

  63. 

  64. Gets the list of extensions for files this loader is able to read.
    65. 

  65. 

  66. ----
    67. 

  67. 

  68. .. _class_ResourceFormatLoader_method_get_resource_type:
    69. 

  69. 

  70. - :ref:`String<class_String>` **get_resource_type** **(** :ref:`String<class_String>` path **)** virtual
    71. 

  71. 

  72. Gets the class name of the resource associated with the given path. If the loader cannot handle it, it should return ``""``. Note that custom resource types defined by scripts aren't known by the :ref:`ClassDB<class_ClassDB>`, so you might just return ``"Resource"`` for them.
    73. 

  73. 

  74. ----
    75. 

  75. 

  76. .. _class_ResourceFormatLoader_method_handles_type:
    77. 

  77. 

  78. - :ref:`bool<class_bool>` **handles_type** **(** :ref:`String<class_String>` typename **)** virtual
    79. 

  79. 

  80. Tells which resource class this loader can load. Note that custom resource types defined by scripts aren't known by the :ref:`ClassDB<class_ClassDB>`, so you might just handle ``"Resource"`` for them.
    81. 

  81. 

  82. ----
    83. 

  83. 

  84. .. _class_ResourceFormatLoader_method_load:
    85. 

  85. 

  86. - :ref:`Variant<class_Variant>` **load** **(** :ref:`String<class_String>` path, :ref:`String<class_String>` original_path **)** virtual
    87. 

  87. 

  88. Loads a resource when the engine finds this loader to be compatible. If the loaded resource is the result of an import, ``original_path`` will target the source file. Returns a :ref:`Resource<class_Resource>` object on success, or an :ref:`Error<enum_@GlobalScope_Error>` constant in case of failure.
    89. 

  89. 

  90. ----
    91. 

  91. 

  92. .. _class_ResourceFormatLoader_method_rename_dependencies:
    93. 

  93. 

  94. - :ref:`int<class_int>` **rename_dependencies** **(** :ref:`String<class_String>` path, :ref:`String<class_String>` renames **)** virtual
    95. 

  95. 

  96. If implemented, renames dependencies within the given resource and saves it. ``renames`` is a dictionary ``{ String => String }`` mapping old dependency paths to new paths.
    97. 

  97. 

  98. Returns :ref:`@GlobalScope.OK<class_@GlobalScope_constant_OK>` on success, or an :ref:`Error<enum_@GlobalScope_Error>` constant in case of failure.
    99. 

  99.