tutorials/scripting/resources

[giscus[bot]]

tutorials/scripting/resources

Nodes and resources: Up to this tutorial, we focused on the Node class in Godot as that's the one you use to code behavior and most of the engine's features rely on it. There is another datatype th...

https://docs.godotengine.org/en/stable/tutorials/scripting/resources.html

[corjohnson]

Another word of warning related to how Resource are serialized, storing the path of the script used. If you have persisted a resource to the file system (such as a "user://" path), the existing persisted data will be corrupt. So if you intend to refactor your custom resource into a new folder, such as moving a script from res://scripts/user_profile.gd to res://data/user_profile.gd; any instances of the UserProfile that have been saved to disk will no longer be able to load.

If you're in development and have not shipped a version of your project yet, you can delete the User Data with the corrupt persisted resource by navigating to Project > Open User Data Folder, and then deleting the impacted files.

[tcm151]

When using C#, then the Resource needs to be in it's own file with the same name as the class, otherwise it will not show up in the create resource GUI.

[optimized-riyan]

In C#, if you will be using a custom resource in a node that will be running in the editor (through [Tool]), make sure to add [Tool] attribute to the custom resource class too, otherwise you will get an invalid cast exception that says Unable to cast object of type 'Godot.Resource' to type '<Namespace>.<CustomResourceClass>'.
For example:

[GlobalClass][Tool]
public partial class TextureData : Resource {...}

[Leroymilo]

This can also fix issues in GDScript: I had a custom Resource I used in a tool and couldn't figure out why the getter and setter methods on its properties weren't triggering. Simply adding @tool to the custom Resource script fixed the errors.

[EdGeber]

Resources need not be used only as data containers. They can also provide nodes with on-demand algorithm implementations. That is, Resources can be used to implement the strategy pattern.

[MichaelJBerk]

When exporting a game, resource files are often renamed to .tres.remap (see 66041), which can cause issues when loading resource files from disk. Should this behavior be documented?

[kora-bert]

I exit the scene and the resources that were loaded are not freed. I even exit the game (on Android) and reopen it and I still haven't entered the scene that has the resources, but the memory usage is still high due to the resources of that scene. And using CACHE_MODE_IGNORE and CACHE_MODE_IGNORE_DEEP during load doesn't help.

[Lambach18]

As i strugled multiple Times with this, in order to use saved resources you need to have a simple constructor, else the scripts don't get atached to the resource files, so make sure .new() is a valid constructor to solve this problem