mirror of
https://github.com/godotengine/godot.git
synced 2026-01-01 05:49:28 +03:00
32ddd4f4e0
We don't use that info for anything, and it generates unnecessary diffs
every time we bump the minor version (and CI failures if we forget to
sync some files from opt-in modules (mono, text_server_fb).
(cherry picked from commit 81064cc239)
46 lines
2.0 KiB
XML
46 lines
2.0 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="PCKPacker" inherits="Reference" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
|
<brief_description>
|
|
Creates packages that can be loaded into a running project.
|
|
</brief_description>
|
|
<description>
|
|
The [PCKPacker] is used to create packages that can be loaded into a running project using [method ProjectSettings.load_resource_pack].
|
|
[codeblock]
|
|
var packer = PCKPacker.new()
|
|
packer.pck_start("test.pck")
|
|
packer.add_file("res://text.txt", "text.txt")
|
|
packer.flush()
|
|
[/codeblock]
|
|
The above [PCKPacker] creates package [code]test.pck[/code], then adds a file named [code]text.txt[/code] at the root of the package.
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="add_file">
|
|
<return type="int" enum="Error" />
|
|
<argument index="0" name="pck_path" type="String" />
|
|
<argument index="1" name="source_path" type="String" />
|
|
<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">
|
|
<return type="int" enum="Error" />
|
|
<argument index="0" name="verbose" type="bool" default="false" />
|
|
<description>
|
|
Writes the files specified using all [method add_file] calls since the last flush. If [code]verbose[/code] is [code]true[/code], a list of files added will be printed to the console for easier debugging.
|
|
</description>
|
|
</method>
|
|
<method name="pck_start">
|
|
<return type="int" enum="Error" />
|
|
<argument index="0" name="pck_name" type="String" />
|
|
<argument index="1" name="alignment" type="int" default="0" />
|
|
<description>
|
|
Creates a new PCK file with the name [code]pck_name[/code]. The [code].pck[/code] file extension isn't added automatically, so it should be part of [code]pck_name[/code] (even though it's not required).
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<constants>
|
|
</constants>
|
|
</class>
|