Class TArchiveLoader

DescriptionHierarchyFieldsMethodsProperties

Unit

Irrlicht

Declaration

type TArchiveLoader = class(TReferenceCounted)

Description

Class which is able to create an archive from a file.
If you want the Irrlicht Engine be able to load archives of currently unsupported file formats (e.g .wad), then derive a class from TCustomArchiveLoader and add your new Archive loader with TFileSystem.AddArchiveLoader to the engine.

Hierarchy

Overview

Methods

Public function CreateArchive(FileName: StringType; IgnoreCase, IgnorePaths: Boolean) : TFileArchive; overload; inline;
Public function CreateArchive(ReadFile: TReadFile; IgnoreCase, IgnorePaths: Boolean) : TFileArchive; overload; inline;
Public function IsALoadableFileFormat(FileName: StringType): Boolean; overload; inline;
Public function IsALoadableFileFormat(ReadFile: TReadFile): Boolean; overload; inline;
Public function IsALoadableFileFormat(FileType: TFileArchiveType): Boolean; overload; inline;

Description

Methods

Public function CreateArchive(FileName: StringType; IgnoreCase, IgnorePaths: Boolean) : TFileArchive; overload; inline;

Creates an archive from a file name.

Parameters
FileName
Name of the file to open.
IgnoreCase
Searching is performed without regarding the case.
IgnorePaths
Files are searched for without checking for the directories.
Returns

Pointer to newly created archive, or nil upon error.

Public function CreateArchive(ReadFile: TReadFile; IgnoreCase, IgnorePaths: Boolean) : TFileArchive; overload; inline;

Creates an archive from a read file.

Parameters
ReadFile
File handle to use.
IgnoreCase
Searching is performed without regarding the case.
IgnorePaths
Files are searched for without checking for the directories.
Returns

Pointer to newly created archive, or nil upon error.

Public function IsALoadableFileFormat(FileName: StringType): Boolean; overload; inline;

Checks if the file might be loadable based on it's extension.

Public function IsALoadableFileFormat(ReadFile: TReadFile): Boolean; overload; inline;

Checks if the file content might be loaded by this class.
This check may look into the file.

Public function IsALoadableFileFormat(FileType: TFileArchiveType): Boolean; overload; inline;

Returns whether a given archive type is loadable by this loader.

Generated by PasDoc 0.12.1 on 2012-09-14 17:32:22