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

Improve the ResourcePreloader documentation

Browse source
This commit is contained in:
Hugo Locurcio 2019-02-07 17:00:16 +01:00
parent 3736a65f24
commit 4b51e8a975
No known key found for this signature in database
GPG key ID: 39E8F8BE30B0A49C
1 changed files with 7 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
doc/classes/ResourcePreloader.xml
View file

@ -4,7 +4,7 @@
Resource Preloader Node.
</brief_description>
<description>
Resource Preloader Node. This node is used to preload sub-resources inside a scene, so when the scene is loaded all the resources are ready to use and be retrieved from here.
This node is used to preload sub-resources inside a scene, so when the scene is loaded, all the resources are ready to use and can be retrieved from the preloader.
</description>
<tutorials>
</tutorials>
@ -19,6 +19,7 @@
<argument index="1" name="resource" type="Resource">
</argument>
<description>
Adds a resource to the preloader with the given [code]name[/code]. If a resource with the given [code]name[/code] already exists, the new resource will be renamed to "[code]name[/code] N" where N is an incrementing number starting from 2.
</description>
</method>
<method name="get_resource" qualifiers="const">
@ -27,14 +28,14 @@
<argument index="0" name="name" type="String">
</argument>
<description>
Return the resource given a text-id.
Returns the resource associated to [code]name[/code].
</description>
</method>
<method name="get_resource_list" qualifiers="const">
<return type="PoolStringArray">
</return>
<description>
Return the list of resources inside the preloader.
Returns the list of resources inside the preloader.
</description>
</method>
<method name="has_resource" qualifiers="const">
@ -43,7 +44,7 @@
<argument index="0" name="name" type="String">
</argument>
<description>
Return true if the preloader has a given resource.
Returns true if the preloader contains a resource associated to [code]name[/code].
</description>
</method>
<method name="remove_resource">
@ -52,7 +53,7 @@
<argument index="0" name="name" type="String">
</argument>
<description>
Remove a resource from the preloader by text id.
Removes the resource associated to [code]name[/code] from the preloader.
</description>
</method>
<method name="rename_resource">
@ -63,7 +64,7 @@
<argument index="1" name="newname" type="String">
</argument>
<description>
Rename a resource inside the preloader, from a text-id to a new text-id.
Renames a resource inside the preloader from [code]name[/code] to [code]newname[/code].
</description>
</method>
</methods>