ArchiveEntry
The
Properties
Property | Type | Description |
---|---|---|
The entry name. As an example, for an entry Actors/Weapons/Gun1.txt this will be Gun1.txt |
||
The path to the entry in the archive, beginning and ending with / .As an example, for an entry Actors/Weapons/Gun1.txt , this will be /Actors/Weapons/ . If the entry isn't in a directory this will be just / |
||
The entry's type information | ||
The size of the entry in bytes | ||
The entry's data | ||
The index of the entry within its containing archive or directory | ||
The 32-bit crc value calculated from the entry's data | ||
The |
||
The |
Constructors
No Constructors
This type can not be created directly in scripts.
See:
Functions
Overview
General
Data Import/Export
FormattedName
Gets the entry name, formatted depending on the parameters given.
Parameters
[includePath] (boolean ): Whether to include the entry path. Default istrue
[includeExtension] (boolean ): Whether to include the entry extension. Default istrue
[upperCase] (boolean ): Whether to convert the entry name to uppercase. Default isfalse
Returns
string : A formatted name of the entry, depending on the parameters given
Notes
Note that
FormattedSize
Gets the size of the entry in a formatted string, eg. 1.3kb
Returns
string : The size of the entry
Rename
Renames the entry.
Parameters
newName (string ): The new name for the entry
Notes
If the entry has a
ExportFile
Exports the entry data to a file at
Parameters
path (string ): The full path to the file to export
Returns
boolean :true
if the export succeededstring : An error message if the export failed
Notes
If a file already exists at
ImportData (1)
Imports
Parameters
dataString (string ): The data to import
Returns
boolean :true
if the import succeededstring : An error message if the import failed
ImportData (2)
Imports
Parameters
data (DataBlock ): The data to import
Returns
boolean :true
if the import succeededstring : An error message if the import failed
ImportEntry
Imports (copies) the data from
Parameters
entry (ArchiveEntry ): The entry to import data from
Returns
boolean :true
if the import succeededstring : An error message if the import failed
ImportFile
Imports the file at the given
Parameters
path (string ): The full path to the file to import
Returns
boolean :true
if the import succeededstring : An error message if the import failed