asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Small improvements to the Resource doc

Browse source
This commit is contained in:
Michael Alexsander Silva Dias 2019-02-17 02:12:34 -03:00
parent 1aa7e22b67
commit 8cc3ae11da
1 changed files with 7 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
doc/classes/Resource.xml
View file

@ -4,9 +4,10 @@
Base class for all resources. Base class for all resources.
</brief_description> </brief_description>
<description> <description>
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. Resource is the base class for all resource types, serving primarily as 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.
</description> </description>
<tutorials> <tutorials>
<link>https://docs.godotengine.org/en/stable/getting_started/step_by_step/resources.html</link>
</tutorials> </tutorials>
<demos> <demos>
</demos> </demos>
@ -23,6 +24,7 @@
<argument index="0" name="subresources" type="bool" default="false"> <argument index="0" name="subresources" type="bool" default="false">
</argument> </argument>
<description> <description>
Duplicates the resource, returning a new resource. By default, sub-resources are shared between resource copies for efficiency, this can be changed by passing [code]true[/code] to the [code]subresources[/code] argument.
</description> </description>
</method> </method>
<method name="get_local_scene" qualifiers="const"> <method name="get_local_scene" qualifiers="const">
@ -35,7 +37,7 @@
<return type="RID"> <return type="RID">
</return> </return>
<description> <description>
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. Returns 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.
</description> </description>
</method> </method>
<method name="setup_local_to_scene"> <method name="setup_local_to_scene">
@ -50,7 +52,7 @@
<argument index="0" name="path" type="String"> <argument index="0" name="path" type="String">
</argument> </argument>
<description> <description>
Set the path of the resource. Differs from set_path(), if another [code]Resource[/code] exists with "path" it over-takes it, instead of failing. Sets the path of the resource. Differs from [code]set_path()[/code], if another [code]Resource[/code] exists with "path" it over-takes it, instead of failing.
</description> </description>
</method> </method>
</methods> </methods>
@ -58,8 +60,10 @@
<member name="resource_local_to_scene" type="bool" setter="set_local_to_scene" getter="is_local_to_scene"> <member name="resource_local_to_scene" type="bool" setter="set_local_to_scene" getter="is_local_to_scene">
</member> </member>
<member name="resource_name" type="String" setter="set_name" getter="get_name"> <member name="resource_name" type="String" setter="set_name" getter="get_name">
The name of the resource. This is an optional identifier.
</member> </member>
<member name="resource_path" type="String" setter="set_path" getter="get_path"> <member name="resource_path" type="String" setter="set_path" getter="get_path">
The path to the resource. In case it has its own file, it will return its filepath. If it's tied to the scene, it will return the scene's path, followed by the resource's index.
</member> </member>
</members> </members>
<signals> <signals>