diff options
Diffstat (limited to 'doc/classes/Resource.xml')
| -rw-r--r-- | doc/classes/Resource.xml | 27 |
1 files changed, 9 insertions, 18 deletions
diff --git a/doc/classes/Resource.xml b/doc/classes/Resource.xml index c8800a3c25..701ecf815c 100644 --- a/doc/classes/Resource.xml +++ b/doc/classes/Resource.xml @@ -13,17 +13,14 @@ </tutorials> <methods> <method name="_setup_local_to_scene" qualifiers="virtual"> - <return type="void"> - </return> + <return type="void" /> <description> Virtual function which can be overridden to customize the behavior value of [method setup_local_to_scene]. </description> </method> <method name="duplicate" qualifiers="const"> - <return type="Resource"> - </return> - <argument index="0" name="subresources" type="bool" default="false"> - </argument> + <return type="Resource" /> + <argument index="0" name="subresources" type="bool" default="false" /> <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 which will copy the subresources. [b]Note:[/b] If [code]subresources[/code] is [code]true[/code], this method will only perform a shallow copy. Nested resources within subresources will not be duplicated and will still be shared. @@ -31,8 +28,7 @@ </description> </method> <method name="emit_changed"> - <return type="void"> - </return> + <return type="void" /> <description> Emits the [signal changed] signal. If external objects which depend on this resource should be updated, this method must be called manually whenever the state of this resource has changed (such as modification of properties). @@ -44,32 +40,27 @@ </description> </method> <method name="get_local_scene" qualifiers="const"> - <return type="Node"> - </return> + <return type="Node" /> <description> If [member resource_local_to_scene] is enabled and the resource was loaded from a [PackedScene] instantiation, returns the local scene where this resource's unique copy is in use. Otherwise, returns [code]null[/code]. </description> </method> <method name="get_rid" qualifiers="const"> - <return type="RID"> - </return> + <return type="RID" /> <description> Returns the RID of the resource (or an empty RID). Many resources (such as [Texture2D], [Mesh], etc) are high-level abstractions of resources stored in a server, so this function will return the original RID. </description> </method> <method name="setup_local_to_scene"> - <return type="void"> - </return> + <return type="void" /> <description> This method is called when a resource with [member resource_local_to_scene] enabled is loaded from a [PackedScene] instantiation. Its behavior can be customized by overriding [method _setup_local_to_scene] from script. For most resources, this method performs no base logic. [ViewportTexture] performs custom logic to properly set the proxy texture and flags in the local viewport. </description> </method> <method name="take_over_path"> - <return type="void"> - </return> - <argument index="0" name="path" type="String"> - </argument> + <return type="void" /> + <argument index="0" name="path" type="String" /> <description> Sets the path of the resource, potentially overriding an existing cache entry for this path. This differs from setting [member resource_path], as the latter would error out if another resource was already cached for the given path. </description> |