C# Class OpenIII.GameFiles.ArchiveFile

IMG/CDIMAGE archive files for RenderWare-based GTA games implementation Класс для работы с IMG/CDIMAGE архивами для игр GTA на движке RenderWare

Inheritance: OpenIII.GameFiles.GameFile

ファイルを表示 Open project: worm202/OpenIII Class Usage Examples

Public Methods

Method	Description
AddNewFileEntry ( int offset, OpenIII.GameFiles.GameFile file ) : OpenIII.GameFiles.GameFile	Adds new table of contents entry for the new file in defined offset to the ArchiveFile Добавляет новую запись о файле file в таблицу размещения файлов в архиве ArchiveFile с заданным смещением offset
ArchiveFile ( string filePath ) : System	ArchiveFile constructor Конструктор архива ArchiveFile
CalculateOffsetForNewEntry ( ) : int	Gets the new offset in file that can be used to write new file Получение нового смещения в архиве для записи нового файла
Create ( string path ) : ArchiveFile
CreateInstance ( int offset, int size, string filename, ArchiveFile parentFile ) : ArchiveFile	Creates new handle instance to use archive that is archived based on the archive version Создание нового указателя на архив, который находится в другом архиве на основании его версии This function is not implemented. It is required by GameFile to be implemented but this configuration is never used in the real life.Эта функция не реализована. Она определена в GameFile как абстрактная и её требуется определить для ArchiveFile. Однако в реальности конфигурация с вложенными IMG файлами нигде не используется.
CreateInstance ( string path ) : ArchiveFile	Creates new handle instance to use archive from filesystem based on the archive version Создание нового указателя на архив, расположенный в файле на основании его версии
DeleteFile ( OpenIII.GameFiles.GameFile entry ) : void	Deletes GameFile from the current ArchiveFile Удаляет файл GameFile из текущего архива ArchiveFile
DeleteFileEntry ( GameFile file ) : void	Deletes the table of contents entry for the GameFile from the current ArchiveFile Удаляет запись о файле GameFile из текущего архива ArchiveFile
ExtractFile ( GameFile entry, string destination ) : void	Экспортирует файл из архива
ExtractFileAsync ( GameFile entry, string destination, CancellationToken ct, UpdateProgressDelegate callback ) : void
GetFileList ( ) : List	Gets file handles list to access all archived GameFile files Получение списка указателей на все архивированные файлы GameFile
InsertFile ( GameFile sourceFile ) : void	Inserts new GameFile into current ArchiveFile Добавляет новый файл GameFile в текущий архив ArchiveFile
InsertFileAsync ( GameFile sourceFile, CancellationToken ct, UpdateProgressDelegate callback ) : void
RenameFile ( GameFile entry, string newName ) : void	Renames entry to newName in the current ArchiveFile Переименовывает файл entry в newName в текущем архиве ArchiveFile This function is not implemented yet.Эта функция ещё не реализована.
ReplaceFile ( GameFile oldEntry, GameFile newEntry ) : void	Replaces oldEntry in the ArchiveFile with new file newEntry Заменяет файл oldEntry в архиве ArchiveFile на новый файл newEntry This function is not implemented yet.Эта функция ещё не реализована.

Method Details

AddNewFileEntry() public abstract method

Adds new table of contents entry for the new file in defined offset to the ArchiveFile Добавляет новую запись о файле file в таблицу размещения файлов в архиве ArchiveFile с заданным смещением offset

public abstract AddNewFileEntry ( int offset, OpenIII.GameFiles.GameFile file ) : OpenIII.GameFiles.GameFile
offset	int	Starting offset of a
file	OpenIII.GameFiles.GameFile	that needs new entry to be defined
return	OpenIII.GameFiles.GameFile

ArchiveFile() public method

ArchiveFile constructor Конструктор архива ArchiveFile

public ArchiveFile ( string filePath ) : System
filePath	string	path
return	System

CalculateOffsetForNewEntry() public method

Gets the new offset in file that can be used to write new file Получение нового смещения в архиве для записи нового файла

public CalculateOffsetForNewEntry ( ) : int
return	int

Create() public static method

public static Create ( string path ) : ArchiveFile
path	string
return	ArchiveFile

CreateInstance() public static method

Creates new handle instance to use archive that is archived based on the archive version Создание нового указателя на архив, который находится в другом архиве на основании его версии

This function is not implemented. It is required by GameFile to be implemented but this configuration is never used in the real life. Эта функция не реализована. Она определена в GameFile как абстрактная и её требуется определить для ArchiveFile. Однако в реальности конфигурация с вложенными IMG файлами нигде не используется.

Thrown on function call Вызывается при вызове функции

public static CreateInstance ( int offset, int size, string filename, ArchiveFile parentFile ) : ArchiveFile
offset	int	Offset of the file in the archive
size	int	File size in the archive
filename	string	File name
parentFile	ArchiveFile	where this file belongs to
return	ArchiveFile

CreateInstance() public static method

Creates new handle instance to use archive from filesystem based on the archive version Создание нового указателя на архив, расположенный в файле на основании его версии

public static CreateInstance ( string path ) : ArchiveFile
path	string	Archive file path
return	ArchiveFile

DeleteFile() public method

Deletes GameFile from the current ArchiveFile Удаляет файл GameFile из текущего архива ArchiveFile

public DeleteFile ( OpenIII.GameFiles.GameFile entry ) : void
entry	OpenIII.GameFiles.GameFile	to be deleted
return	void

DeleteFileEntry() public abstract method

Deletes the table of contents entry for the GameFile from the current ArchiveFile Удаляет запись о файле GameFile из текущего архива ArchiveFile

public abstract DeleteFileEntry ( GameFile file ) : void
file	GameFile	which entry needs to be deleted
return	void

ExtractFile() public method

Экспортирует файл из архива

public ExtractFile ( GameFile entry, string destination ) : void
entry	GameFile
destination	string
return	void

ExtractFileAsync() public method

public ExtractFileAsync ( GameFile entry, string destination, CancellationToken ct, UpdateProgressDelegate callback ) : void
entry	GameFile
destination	string
ct	CancellationToken
callback	UpdateProgressDelegate
return	void

GetFileList() public abstract method

Gets file handles list to access all archived GameFile files Получение списка указателей на все архивированные файлы GameFile

public abstract GetFileList ( ) : List
return	List

InsertFile() public method

Inserts new GameFile into current ArchiveFile Добавляет новый файл GameFile в текущий архив ArchiveFile

public InsertFile ( GameFile sourceFile ) : void
sourceFile	GameFile	to be inserted into the
return	void

InsertFileAsync() public method

public InsertFileAsync ( GameFile sourceFile, CancellationToken ct, UpdateProgressDelegate callback ) : void
sourceFile	GameFile
ct	CancellationToken
callback	UpdateProgressDelegate
return	void

RenameFile() public method

Renames entry to newName in the current ArchiveFile Переименовывает файл entry в newName в текущем архиве ArchiveFile

This function is not implemented yet. Эта функция ещё не реализована.

public RenameFile ( GameFile entry, string newName ) : void
entry	GameFile	to be renamed
newName	string	New file name
return	void

ReplaceFile() public method

Replaces oldEntry in the ArchiveFile with new file newEntry Заменяет файл oldEntry в архиве ArchiveFile на новый файл newEntry

This function is not implemented yet. Эта функция ещё не реализована.

public ReplaceFile ( GameFile oldEntry, GameFile newEntry ) : void
oldEntry	GameFile	Old in the that needs to be replaced
newEntry	GameFile	A replacement for the
return	void