Inicio Explorar Ayuda
Iniciar sesión
Godot
/
godot-docs
espejo de https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Archivos Incidencias 0 Wiki
Árbol: e2662b0d0f
Ramas Etiquetas
godot-docs
/
classes
/
class_resource.rst

class_resource.rst 8.6 KB
Histórico Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142 
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
    2. 

  2. .. DO NOT EDIT THIS FILE, but the Resource.xml source instead.
    3. 

  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
    4. 

  4. 

  5. .. _class_Resource:
    6. 

  6. 

  7. Resource
    8. 

  8. ========
    9. 

  9. 

  10. **Inherits:** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
    11. 

  11. 

  12. **Inherited By:** :ref:`Theme<class_theme>`, :ref:`AudioStream<class_audiostream>`, :ref:`Sky<class_sky>`, :ref:`CubeMap<class_cubemap>`, :ref:`DynamicFontData<class_dynamicfontdata>`, :ref:`InputEvent<class_inputevent>`, :ref:`SpriteFrames<class_spriteframes>`, :ref:`Translation<class_translation>`, :ref:`Curve2D<class_curve2d>`, :ref:`Shape<class_shape>`, :ref:`Shape2D<class_shape2d>`, :ref:`Curve<class_curve>`, :ref:`StyleBox<class_stylebox>`, :ref:`Environment<class_environment>`, :ref:`GDNativeLibrary<class_gdnativelibrary>`, :ref:`Material<class_material>`, :ref:`VideoStream<class_videostream>`, :ref:`PackedScene<class_packedscene>`, :ref:`Texture<class_texture>`, :ref:`Mesh<class_mesh>`, :ref:`ButtonGroup<class_buttongroup>`, :ref:`TileSet<class_tileset>`, :ref:`ShortCut<class_shortcut>`, :ref:`BitMap<class_bitmap>`, :ref:`Animation<class_animation>`, :ref:`PolygonPathFinder<class_polygonpathfinder>`, :ref:`Shader<class_shader>`, :ref:`Script<class_script>`, :ref:`AudioBusLayout<class_audiobuslayout>`, :ref:`World<class_world>`, :ref:`AudioEffect<class_audioeffect>`, :ref:`VisualScriptNode<class_visualscriptnode>`, :ref:`World2D<class_world2d>`, :ref:`GIProbeData<class_giprobedata>`, :ref:`Font<class_font>`, :ref:`MeshLibrary<class_meshlibrary>`, :ref:`Curve3D<class_curve3d>`, :ref:`NavigationPolygon<class_navigationpolygon>`, :ref:`EditorSettings<class_editorsettings>`, :ref:`Image<class_image>`, :ref:`Gradient<class_gradient>`, :ref:`OccluderPolygon2D<class_occluderpolygon2d>`, :ref:`MultiMesh<class_multimesh>`, :ref:`PackedDataContainer<class_packeddatacontainer>`, :ref:`NavigationMesh<class_navigationmesh>`
    13. 

  13. 

  14. **Category:** Core
    15. 

  15. 

  16. Brief Description
    17. 

  17. -----------------
    18. 

  18. 

  19. Base class for all resources.
    20. 

  20. 

  21. Member Functions
    22. 

  22. ----------------
    23. 

  23. 

  24. +----------------------------------+---------------------------------------------------------------------------------------------------------+
    25. 

  25. | void                             | :ref:`_setup_local_to_scene<class_Resource__setup_local_to_scene>` **(** **)** virtual                  |
    26. 

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

  27. | :ref:`Resource<class_resource>`  | :ref:`duplicate<class_Resource_duplicate>` **(** :ref:`bool<class_bool>` subresources=false **)** const |
    28. 

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

  29. | :ref:`Node<class_node>`          | :ref:`get_local_scene<class_Resource_get_local_scene>` **(** **)** const                                |
    30. 

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

  31. | :ref:`String<class_string>`      | :ref:`get_name<class_Resource_get_name>` **(** **)** const                                              |
    32. 

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

  33. | :ref:`String<class_string>`      | :ref:`get_path<class_Resource_get_path>` **(** **)** const                                              |
    34. 

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

  35. | :ref:`RID<class_rid>`            | :ref:`get_rid<class_Resource_get_rid>` **(** **)** const                                                |
    36. 

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

  37. | :ref:`bool<class_bool>`          | :ref:`is_local_to_scene<class_Resource_is_local_to_scene>` **(** **)** const                            |
    38. 

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

  39. | void                             | :ref:`set_local_to_scene<class_Resource_set_local_to_scene>` **(** :ref:`bool<class_bool>` enable **)** |
    40. 

  40. +----------------------------------+---------------------------------------------------------------------------------------------------------+
    41. 

  41. | void                             | :ref:`set_name<class_Resource_set_name>` **(** :ref:`String<class_string>` name **)**                   |
    42. 

  42. +----------------------------------+---------------------------------------------------------------------------------------------------------+
    43. 

  43. | void                             | :ref:`set_path<class_Resource_set_path>` **(** :ref:`String<class_string>` path **)**                   |
    44. 

  44. +----------------------------------+---------------------------------------------------------------------------------------------------------+
    45. 

  45. | void                             | :ref:`setup_local_to_scene<class_Resource_setup_local_to_scene>` **(** **)**                            |
    46. 

  46. +----------------------------------+---------------------------------------------------------------------------------------------------------+
    47. 

  47. | void                             | :ref:`take_over_path<class_Resource_take_over_path>` **(** :ref:`String<class_string>` path **)**       |
    48. 

  48. +----------------------------------+---------------------------------------------------------------------------------------------------------+
    49. 

  49. 

  50. Signals
    51. 

  51. -------
    52. 

  52. 

  53. .. _class_Resource_changed:
    54. 

  54. 

  55. - **changed** **(** **)**
    56. 

  56. 

  57. 

  58. Member Variables
    59. 

  59. ----------------
    60. 

  60. 

  61.   .. _class_Resource_resource_local_to_scene:
    62. 

  62. 

  63. - :ref:`bool<class_bool>` **resource_local_to_scene**
    64. 

  64. 

  65.   .. _class_Resource_resource_name:
    66. 

  66. 

  67. - :ref:`String<class_string>` **resource_name**
    68. 

  68. 

  69.   .. _class_Resource_resource_path:
    70. 

  70. 

  71. - :ref:`String<class_string>` **resource_path**
    72. 

  72. 

  73. 

  74. Description
    75. 

  75. -----------
    76. 

  76. 

  77. Resource is the base class for all resource types. Resources are primarily data containers. They are reference counted and freed when no longer in use. They are also loaded only once from disk, and further attempts to load the resource will return the same reference (all this in contrast to a :ref:`Node<class_node>`, which is not reference counted and can be instanced from disk as many times as desired). Resources can be saved externally on disk or bundled into another object, such as a :ref:`Node<class_node>` or another resource.
    78. 

  78. 

  79. Member Function Description
    80. 

  80. ---------------------------
    81. 

  81. 

  82. .. _class_Resource__setup_local_to_scene:
    83. 

  83. 

  84. - void **_setup_local_to_scene** **(** **)** virtual
    85. 

  85. 

  86. .. _class_Resource_duplicate:
    87. 

  87. 

  88. - :ref:`Resource<class_resource>` **duplicate** **(** :ref:`bool<class_bool>` subresources=false **)** const
    89. 

  89. 

  90. .. _class_Resource_get_local_scene:
    91. 

  91. 

  92. - :ref:`Node<class_node>` **get_local_scene** **(** **)** const
    93. 

  93. 

  94. .. _class_Resource_get_name:
    95. 

  95. 

  96. - :ref:`String<class_string>` **get_name** **(** **)** const
    97. 

  97. 

  98. Return the name of the resources, any name is valid (it doesn't have to be unique). Name is for descriptive purposes only.
    99. 

  99. 

  100. .. _class_Resource_get_path:
    101. 

  101. 

  102. - :ref:`String<class_string>` **get_path** **(** **)** const
    103. 

  103. 

  104. Return the path of the resource. This is useful mainly for editors when saving/loading, and shouldn't be changed by anything else.
    105. 

  105. 

  106. .. _class_Resource_get_rid:
    107. 

  107. 

  108. - :ref:`RID<class_rid>` **get_rid** **(** **)** const
    109. 

  109. 

  110. Return the RID of the resource (or an empty RID). Many resources (such as :ref:`Texture<class_texture>`, :ref:`Mesh<class_mesh>`, etc) are high level abstractions of resources stored in a server, so this function will return the original RID.
    111. 

  111. 

  112. .. _class_Resource_is_local_to_scene:
    113. 

  113. 

  114. - :ref:`bool<class_bool>` **is_local_to_scene** **(** **)** const
    115. 

  115. 

  116. .. _class_Resource_set_local_to_scene:
    117. 

  117. 

  118. - void **set_local_to_scene** **(** :ref:`bool<class_bool>` enable **)**
    119. 

  119. 

  120. .. _class_Resource_set_name:
    121. 

  121. 

  122. - void **set_name** **(** :ref:`String<class_string>` name **)**
    123. 

  123. 

  124. Set the name of the resources, any name is valid (it doesn't have to be unique). Name is for descriptive purposes only.
    125. 

  125. 

  126. .. _class_Resource_set_path:
    127. 

  127. 

  128. - void **set_path** **(** :ref:`String<class_string>` path **)**
    129. 

  129. 

  130. Set the path of the resource. This is useful mainly for editors when saving/loading, and shouldn't be changed by anything else. Fails if another ``Resource`` already has path "path".
    131. 

  131. 

  132. .. _class_Resource_setup_local_to_scene:
    133. 

  133. 

  134. - void **setup_local_to_scene** **(** **)**
    135. 

  135. 

  136. .. _class_Resource_take_over_path:
    137. 

  137. 

  138. - void **take_over_path** **(** :ref:`String<class_string>` path **)**
    139. 

  139. 

  140. Set the path of the resource. Differs from set_path(), if another ``Resource`` exists with "path" it over-takes it, instead of failing.
    141. 

  141. 

  142.