This API component provides functionality related to MDL archives. More...
Public Member Functions | |
virtual Sint32 | create_archive (const char *directory, const char *archive, const IArray *manifest_fields)=0 |
Creates an MDL archive given a directory. More... | |
virtual Sint32 | extract_archive (const char *archive, const char *directory)=0 |
Unpacks an MDL archive into a given directory. More... | |
virtual const IManifest * | get_manifest (const char *archive)=0 |
Returns the manifest for an MDL archive, or NULL in case of failure. More... | |
virtual IReader * | get_file (const char *archive, const char *filename)=0 |
Returns an arbitrary file from an MDL archive. More... | |
virtual IReader * | get_file (const char *filename)=0 |
Returns an arbitrary file from an MDL archive. More... | |
virtual Sint32 | set_extensions_for_compression (const char *extensions)=0 |
Sets the file types to be compressed in archives. More... | |
virtual const char * | get_extensions_for_compression () const =0 |
Returns the file types to be compressed in archives. More... | |
Additional Inherited Members | |
![]() | |
typedef Interface_declare< id1, id2, id3, id4, id5, id6, id7, id8, id9, id10, id11, IInterface > | Self |
Own type. More... | |
typedef Uuid_t< id1, id2, id3, id4, id5, id6, id7, id8, id9, id10, id11 > | IID |
Declares the interface ID (IID) of this interface. More... | |
![]() | |
static bool | compare_iid (const Uuid &iid) |
Compares the interface ID iid against the interface ID of this interface and of its ancestors. More... | |
This API component provides functionality related to MDL archives.
|
pure virtual |
Creates an MDL archive given a directory.
directory | The contents of this directory will be packed into the archive. Logically, the directory needs to be on the same level as a directory of the search path, i.e., packages in the MDL archive name are represented as empty sub-directories of the given directory. |
archive | The filename of the MDL archive to be created. |
manifest_fields | A static or dynamic array of structs of type "Manifest_field" which holds fields with optional or user-defined keys to be added to the manifest. The struct has two members, "key" and "value" , both of type "String" . NULL is treated like an empty array. |
NULL
pointer).archive
does not end in ".mdr"
.manifest_fields
or a struct member of one of the array elements has an incorrect type.
|
pure virtual |
Unpacks an MDL archive into a given directory.
archive | The filename of the MDL archive to be extracted. |
directory | The directory into which the contents of the MDL archive will be extracted. |
NULL
pointer).
|
pure virtual |
Returns the file types to be compressed in archives.
|
pure virtual |
Returns an arbitrary file from an MDL archive.
archive | The filename of the MDL archive. |
filename | The name of the file inside the MDL archive. |
NULL
in case of failures.
|
pure virtual |
Returns an arbitrary file from an MDL archive.
filename | The name of the archive followed by a colon followed by the name of the file inside the archive (e. g. my_archive.mdr:my_package/my_file.mdl). |
NULL
in case of failures.
|
pure virtual |
Returns the manifest for an MDL archive, or NULL
in case of failure.
|
pure virtual |
Sets the file types to be compressed in archives.
extensions | A comma-separated list of file name extensions. Files with a matching extension will be compressed when archives are created. Independent of this setting here, .mdl files will always be compressed, and textures as defined in [MDLLS] will never be compressed. |