diff options
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/PCKPacker.xml | 9 | ||||
| -rw-r--r-- | doc/classes/SceneTree.xml | 2 |
2 files changed, 10 insertions, 1 deletions
diff --git a/doc/classes/PCKPacker.xml b/doc/classes/PCKPacker.xml index f3091a3e3f..ff45ca925c 100644 --- a/doc/classes/PCKPacker.xml +++ b/doc/classes/PCKPacker.xml @@ -3,6 +3,14 @@ <brief_description> </brief_description> <description> + The [PCKPacker] is used to create packages in application runtime. + [codeblock] + var packer = PCKPacker.new() + packer.pck_start("test.pck", 0) + packer.add_file("res://text.txt", "text.txt") + packer.flush(false) + [/codeblock] + The above [PCKPacker] creates package [b]test.pck[/b], then adds a file named [b]text.txt[/b] in the root of the package. </description> <tutorials> </tutorials> @@ -15,6 +23,7 @@ <argument index="1" name="source_path" type="String"> </argument> <description> + Adds the [code]source_path[/code] file to the current PCK package at the [code]pck_path[/code] internal path (should start with [code]res://[/code]). </description> </method> <method name="flush"> diff --git a/doc/classes/SceneTree.xml b/doc/classes/SceneTree.xml index e14a3b3759..bf22b865d3 100644 --- a/doc/classes/SceneTree.xml +++ b/doc/classes/SceneTree.xml @@ -194,7 +194,7 @@ </return> <description> Reloads the currently active scene. - Returns an [enum Error] code as described in [method change_scene], with the addition of [constant ERR_UNCONFIGURED] if no [member current_scene] was defined yet. + Returns [constant OK] on success, [constant ERR_UNCONFIGURED] if no [member current_scene] was defined yet, [constant ERR_CANT_OPEN] if [member current_scene] cannot be loaded into a [PackedScene], or [constant ERR_CANT_CREATE] if the scene cannot be instantiated. </description> </method> <method name="set_auto_accept_quit"> |