diff options
Diffstat (limited to 'doc/classes/ResourceInteractiveLoader.xml')
| -rw-r--r-- | doc/classes/ResourceInteractiveLoader.xml | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/classes/ResourceInteractiveLoader.xml b/doc/classes/ResourceInteractiveLoader.xml index 9d5a52deb2..df552d3656 100644 --- a/doc/classes/ResourceInteractiveLoader.xml +++ b/doc/classes/ResourceInteractiveLoader.xml @@ -4,7 +4,7 @@ Interactive [Resource] loader. </brief_description> <description> - Interactive [Resource] loader. This object is returned by [ResourceLoader] when performing an interactive load. It allows to load with high granularity, so this is mainly useful for displaying loading bars/percentages. + Interactive [Resource] loader. This object is returned by [ResourceLoader] when performing an interactive load. It allows loading resources with high granularity, which makes it mainly useful for displaying loading bars or percentages. </description> <tutorials> </tutorials> @@ -35,9 +35,9 @@ </return> <description> Polls the loading operation, i.e. loads a data chunk up to the next stage. - Returns [constant @GlobalScope.OK] if the poll is successful but the load operation has not finished yet (intermediate stage). This means [method poll] will have to be called again until the last stage is completed. - Returns [constant @GlobalScope.ERR_FILE_EOF] if the load operation has completed successfully. The loaded resource can be obtained by calling [method get_resource]. - Returns another [enum @GlobalScope.Error] code if the poll has failed. + Returns [constant OK] if the poll is successful but the load operation has not finished yet (intermediate stage). This means [method poll] will have to be called again until the last stage is completed. + Returns [constant ERR_FILE_EOF] if the load operation has completed successfully. The loaded resource can be obtained by calling [method get_resource]. + Returns another [enum Error] code if the poll has failed. </description> </method> <method name="wait"> @@ -45,8 +45,8 @@ </return> <description> Polls the loading operation successively until the resource is completely loaded or a [method poll] fails. - Returns [constant @GlobalScope.ERR_FILE_EOF] if the load operation has completed successfully. The loaded resource can be obtained by calling [method get_resource]. - Returns another [enum @GlobalScope.Error] code if a poll has failed, aborting the operation. + Returns [constant ERR_FILE_EOF] if the load operation has completed successfully. The loaded resource can be obtained by calling [method get_resource]. + Returns another [enum Error] code if a poll has failed, aborting the operation. </description> </method> </methods> |