Table of Contents

Class PckPacker

Namespace
Godot
Assembly
GodotSharp.dll

The PckPacker is used to create packages that can be loaded into a running project using LoadResourcePack(string, bool, int).

var packer = new PckPacker();
  packer.PckStart("test.pck");
  packer.AddFile("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.

Note: PCK is Godot's own pack file format. To create ZIP archives that can be read by any program, use ZipPacker instead.

[GodotClassName("PCKPacker")]
public class PckPacker : RefCounted, IDisposable
Inheritance
PckPacker
Implements
Inherited Members

Constructors

PckPacker() 

public PckPacker()

Methods

AddFile(string, string, bool)

Adds the sourcePath file to the current PCK package at the targetPath internal path. The res:// prefix for targetPath is optional and stripped internally.

public Error AddFile(string targetPath, string sourcePath, bool encrypt = false)

Parameters

targetPath string
sourcePath string
encrypt bool

Returns

Error

AddFileRemoval(string)

Registers a file removal of the targetPath internal path to the PCK. This is mainly used for patches. If the file at this path has been loaded from a previous PCK, it will be removed. The res:// prefix for targetPath is optional and stripped internally.

public Error AddFileRemoval(string targetPath)

Parameters

targetPath string

Returns

Error

Flush(bool)

Writes the files specified using all AddFile(string, string, bool) calls since the last flush. If verbose is true, a list of files added will be printed to the console for easier debugging.

public Error Flush(bool verbose = false)

Parameters

verbose bool

Returns

Error

HasGodotClassMethod(in godot_string_name)

Check if the type contains a method with the given name. This method is used by Godot to check if a method exists before invoking it. Do not call or override this method.

protected override bool HasGodotClassMethod(in godot_string_name method)

Parameters

method godot_string_name

Name of the method to check for.

Returns

bool

HasGodotClassSignal(in godot_string_name)

Check if the type contains a signal with the given name. This method is used by Godot to check if a signal exists before raising it. Do not call or override this method.

protected override bool HasGodotClassSignal(in godot_string_name signal)

Parameters

signal godot_string_name

Name of the signal to check for.

Returns

bool

InvokeGodotClassMethod(in godot_string_name, NativeVariantPtrArgs, out godot_variant)

Invokes the method with the given name, using the given arguments. This method is used by Godot to invoke methods from the engine side. Do not call or override this method.

protected override bool InvokeGodotClassMethod(in godot_string_name method, NativeVariantPtrArgs args, out godot_variant ret)

Parameters

method godot_string_name

Name of the method to invoke.

args NativeVariantPtrArgs

Arguments to use with the invoked method.

ret godot_variant

Value returned by the invoked method.

Returns

bool

PckStart(string, int, string, bool)

Creates a new PCK file at the file path pckPath. The .pck file extension isn't added automatically, so it should be part of pckPath (even though it's not required).

public Error PckStart(string pckPath, int alignment = 32, string key = "0000000000000000000000000000000000000000000000000000000000000000", bool encryptDirectory = false)

Parameters

pckPath string
alignment int
key string
encryptDirectory bool

Returns

Error
Edit this page