From 4f929a0fdfae24b1ca5acf0b732219119090ee43 Mon Sep 17 00:00:00 2001 From: Juan Linietsky Date: Tue, 12 Sep 2017 17:42:36 -0300 Subject: Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. --- doc/classes/Resource.xml | 119 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 119 insertions(+) create mode 100644 doc/classes/Resource.xml (limited to 'doc/classes/Resource.xml') diff --git a/doc/classes/Resource.xml b/doc/classes/Resource.xml new file mode 100644 index 0000000000..35342c3872 --- /dev/null +++ b/doc/classes/Resource.xml @@ -0,0 +1,119 @@ + + + + Base class for all resources. + + + 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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Return the name of the resources, any name is valid (it doesn't have to be unique). Name is for descriptive purposes only. + + + + + + + Return the path of the resource. This is useful mainly for editors when saving/loading, and shouldn't be changed by anything else. + + + + + + + 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. + + + + + + + + + + + + + + + + + + + + + + + Set the name of the resources, any name is valid (it doesn't have to be unique). Name is for descriptive purposes only. + + + + + + + + + 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". + + + + + + + + + + + + + + + Set the path of the resource. Differs from set_path(), if another [Resource] exists with "path" it over-takes it, instead of failing. + + + + + + + + + + + + + + + + + + + + -- cgit v1.2.3