Inherits: Reference < Object

Inherited By: AnimationNodeStateMachinePlayback, AudioStream, Sky, Theme, TextureLayered, CubeMap, DynamicFontData, InputEvent, VisualShaderNode, Curve2D, Image, Shape, Shape2D, Curve, Mesh, StyleBox, Environment, GDNativeLibrary, Material, PhysicsMaterial, VideoStream, PackedScene, Texture, TextFile, ButtonGroup, TileSet, ShortCut, OpenSimplexNoise, BitMap, Animation, BakedLightmapData, PolygonPathFinder, Translation, Shader, Script, AudioBusLayout, AnimationNode, World, AudioEffect, VisualScriptNode, AnimationNodeStateMachineTransition, World2D, GIProbeData, Font, SpriteFrames, MeshLibrary, Curve3D, NavigationPolygon, EditorSettings, Gradient, OccluderPolygon2D, MultiMesh, PackedDataContainer, NavigationMesh

Category: Core

Brief Description

Base class for all resources.


void _setup_local_to_scene ( ) virtual
Resource duplicate ( bool subresources=false ) const
Node get_local_scene ( ) const
RID get_rid ( ) const
void setup_local_to_scene ( )
void take_over_path ( String path )


  • changed ( )


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 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 Node or another resource.

Property Descriptions

  • bool resource_local_to_scene
Setter set_local_to_scene(value)
Getter is_local_to_scene()
Setter set_name(value)
Getter get_name()
Setter set_path(value)
Getter get_path()

Method Descriptions

  • void _setup_local_to_scene ( ) virtual
  • Node get_local_scene ( ) const
  • RID get_rid ( ) const

Return the RID of the resource (or an empty RID). Many resources (such as Texture, Mesh, etc) are high level abstractions of resources stored in a server, so this function will return the original RID.

  • void setup_local_to_scene ( )
  • void take_over_path ( String path )

Set the path of the resource. Differs from set_path(), if another Resource exists with “path” it over-takes it, instead of failing.