mirror of
https://github.com/Relintai/pandemonium_engine_docs.git
synced 2025-01-21 15:07:22 +01:00
69 lines
3.5 KiB
ReStructuredText
69 lines
3.5 KiB
ReStructuredText
|
:github_url: hide
|
||
|
|
||
|
.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
|
||
|
.. DO NOT EDIT THIS FILE, but the PCKPacker.xml source instead.
|
||
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
||
|
|
||
|
.. _class_PCKPacker:
|
||
|
|
||
|
PCKPacker
|
||
|
=========
|
||
|
|
||
|
**Inherits:** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
||
|
|
||
|
Creates packages that can be loaded into a running project.
|
||
|
|
||
|
Description
|
||
|
-----------
|
||
|
|
||
|
The ``PCKPacker`` is used to create packages that can be loaded into a running project using :ref:`ProjectSettings.load_resource_pack<class_ProjectSettings_method_load_resource_pack>`.
|
||
|
|
||
|
::
|
||
|
|
||
|
var packer = PCKPacker.new()
|
||
|
packer.pck_start("test.pck")
|
||
|
packer.add_file("res://text.txt", "text.txt")
|
||
|
packer.flush()
|
||
|
|
||
|
The above ``PCKPacker`` creates package ``test.pck``, then adds a file named ``text.txt`` at the root of the package.
|
||
|
|
||
|
Methods
|
||
|
-------
|
||
|
|
||
|
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||
|
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`add_file<class_PCKPacker_method_add_file>` **(** :ref:`String<class_String>` pck_path, :ref:`String<class_String>` source_path **)** |
|
||
|
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||
|
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`flush<class_PCKPacker_method_flush>` **(** :ref:`bool<class_bool>` verbose=false **)** |
|
||
|
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||
|
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`pck_start<class_PCKPacker_method_pck_start>` **(** :ref:`String<class_String>` pck_name, :ref:`int<class_int>` alignment=0 **)** |
|
||
|
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||
|
|
||
|
Method Descriptions
|
||
|
-------------------
|
||
|
|
||
|
.. _class_PCKPacker_method_add_file:
|
||
|
|
||
|
- :ref:`Error<enum_@GlobalScope_Error>` **add_file** **(** :ref:`String<class_String>` pck_path, :ref:`String<class_String>` source_path **)**
|
||
|
|
||
|
Adds the ``source_path`` file to the current PCK package at the ``pck_path`` internal path (should start with ``res://``).
|
||
|
|
||
|
----
|
||
|
|
||
|
.. _class_PCKPacker_method_flush:
|
||
|
|
||
|
- :ref:`Error<enum_@GlobalScope_Error>` **flush** **(** :ref:`bool<class_bool>` verbose=false **)**
|
||
|
|
||
|
Writes the files specified using all :ref:`add_file<class_PCKPacker_method_add_file>` calls since the last flush. If ``verbose`` is ``true``, a list of files added will be printed to the console for easier debugging.
|
||
|
|
||
|
----
|
||
|
|
||
|
.. _class_PCKPacker_method_pck_start:
|
||
|
|
||
|
- :ref:`Error<enum_@GlobalScope_Error>` **pck_start** **(** :ref:`String<class_String>` pck_name, :ref:`int<class_int>` alignment=0 **)**
|
||
|
|
||
|
Creates a new PCK file with the name ``pck_name``. The ``.pck`` file extension isn't added automatically, so it should be part of ``pck_name`` (even though it's not required).
|
||
|
|
||
|
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
|
||
|
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
|
||
|
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|