From 4b51e8a9756d4cb8b1fefb0bde078c4cef917ded Mon Sep 17 00:00:00 2001 From: Hugo Locurcio Date: Thu, 7 Feb 2019 17:00:16 +0100 Subject: [PATCH] Improve the ResourcePreloader documentation --- doc/classes/ResourcePreloader.xml | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/doc/classes/ResourcePreloader.xml b/doc/classes/ResourcePreloader.xml index 002bcd891a8..18d6e04d8ee 100644 --- a/doc/classes/ResourcePreloader.xml +++ b/doc/classes/ResourcePreloader.xml @@ -4,7 +4,7 @@ Resource Preloader Node. - 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. @@ -19,6 +19,7 @@ + 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. @@ -27,14 +28,14 @@ - Return the resource given a text-id. + Returns the resource associated to [code]name[/code]. - Return the list of resources inside the preloader. + Returns the list of resources inside the preloader. @@ -43,7 +44,7 @@ - Return true if the preloader has a given resource. + Returns true if the preloader contains a resource associated to [code]name[/code]. @@ -52,7 +53,7 @@ - Remove a resource from the preloader by text id. + Removes the resource associated to [code]name[/code] from the preloader. @@ -63,7 +64,7 @@ - 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].