Resource #

virtual const func _get_rid() -> RID#

Override this method to return a custom RID when get_rid is called.

virtual func _reset_state() -> void#

For resources that use a variable number of properties, either via Object._validate_property or Object._get_property_list, this method should be implemented to correctly clear the resource's state.

virtual const func _set_path_cache(path: String) -> void#

Sets the resource's path to path without involving the resource cache.

virtual func _setup_local_to_scene() -> void#

Override this method to customize the newly duplicated resource created from PackedScene.instantiate, if the original's resource_local_to_scene is set to true.

Example: Set a random damage value to every local resource from an instantiated scene:

extends Resource

var damage = 0

func _setup_local_to_scene():
    damage = randi_range(10, 40)

const func duplicate(subresources: bool = false) -> Resource#

Duplicates this resource, returning a new resource with its exported or PROPERTY_USAGE_STORAGE properties copied from the original.

If subresources is false, a shallow copy is returned; nested resources within subresources are not duplicated and are shared with the original resource (with one exception; see below). If subresources is true, a deep copy is returned; nested subresources will be duplicated and are not shared (with two exceptions; see below).

subresources is usually respected, with the following exceptions:

- Subresource properties with the PROPERTY_USAGE_ALWAYS_DUPLICATE flag are always duplicated.

- Subresource properties with the PROPERTY_USAGE_NEVER_DUPLICATE flag are never duplicated.

- Subresources inside Array and Dictionary properties are never duplicated.

Note: For custom resources, this method will fail if Object._init has been defined with required parameters.

func emit_changed() -> void#

Emits the changed signal. This method is called automatically for some built-in resources.

Note: For custom resources, it's recommended to call this method whenever a meaningful change occurs, such as a modified property. This ensures that custom Objects depending on the resource are properly updated.

var damage:
    set(new_value):
        if damage != new_value:
            damage = new_value
            emit_changed()

static func generate_scene_unique_id() -> String#

Generates a unique identifier for a resource to be contained inside a PackedScene, based on the current date, time, and a random value. The returned string is only composed of letters (a to y) and numbers (0 to 8). See also resource_scene_unique_id.

const func get_id_for_path(path: String) -> String#

Returns the unique identifier for the resource with the given path from the resource cache. If the resource is not loaded and cached, an empty string is returned.

Note: This method is only implemented when running in an editor context. At runtime, it returns an empty string.

const func get_local_scene() -> Node#

If resource_local_to_scene is set to true and the resource has been loaded from a PackedScene instantiation, returns the root Node of the scene where this resource is used. Otherwise, returns null.

const func get_rid() -> RID#

Returns the RID of this resource (or an empty RID). Many resources (such as Texture2D, Mesh, and so on) are high-level abstractions of resources stored in a specialized server (DisplayServer, RenderingServer, etc.), so this function will return the original RID.

const func is_built_in() -> bool#

Returns true if the resource is built-in (from the engine) or false if it is user-defined.

func reset_state() -> void#

For resources that use a variable number of properties, either via Object._validate_property or Object._get_property_list, override _reset_state to correctly clear the resource's state.

func set_id_for_path(id: String) -> void#

Sets the unique identifier to id for the resource with the given path in the resource cache. If the unique identifier is empty, the cache entry using path is removed if it exists.

Note: This method is only implemented when running in an editor context.

func set_path_cache(path: String) -> void#

Sets the resource's path to path without involving the resource cache.

func setup_local_to_scene() -> void#

Calls _setup_local_to_scene. If resource_local_to_scene is set to true, this method is automatically called from PackedScene.instantiate by the newly duplicated resource within the scene instance.

func take_over_path(path: String) -> void#

Sets the resource_path to path, potentially overriding an existing cache entry for this path. Further attempts to load an overridden resource by path will instead return this resource.