V-Gears 0
Free Final Fantasy VII engine.
VGears::LGPArchiveFactory Class Reference

A factory for LGP archives. More...

#include <VGearsLGPArchiveFactory.h>

Inheritance diagram for VGears::LGPArchiveFactory:
Collaboration diagram for VGears::LGPArchiveFactory:

Public Member Functions

 LGPArchiveFactory ()
 Constructor. More...
 
virtual ~LGPArchiveFactory ()
 Destructor. More...
 
const StringgetType (void) const
 Retrieves the factory type. More...
 
Ogre::Archive * createInstance (const String &name, bool readOnly) override final
 Creates a new LGP archive. More...
 
void destroyInstance (Ogre::Archive *arch) override final
 Destroys a LGP archive created by this factory. More...
 

Static Public Attributes

static const String ARCHIVE_TYPE
 The archive type. More...
 

Detailed Description

A factory for LGP archives.

Constructor & Destructor Documentation

◆ LGPArchiveFactory()

VGears::LGPArchiveFactory::LGPArchiveFactory ( )

Constructor.

◆ ~LGPArchiveFactory()

VGears::LGPArchiveFactory::~LGPArchiveFactory ( )
virtual

Destructor.

Member Function Documentation

◆ createInstance()

Ogre::Archive * VGears::LGPArchiveFactory::createInstance ( const String name,
bool  readOnly 
)
inlinefinaloverride

Creates a new LGP archive.

Parameters
[in]nameName of the archive to create.
[in]readOnlyTrue to make the archive read-only, false to enable writting.
Returns
A new LGP archive.

◆ destroyInstance()

void VGears::LGPArchiveFactory::destroyInstance ( Ogre::Archive *  arch)
inlinefinaloverride

Destroys a LGP archive created by this factory.

Parameters
[in]archThe archive to destroy.

◆ getType()

const String & VGears::LGPArchiveFactory::getType ( void  ) const
inline

Retrieves the factory type.

Returns
The factory type.

Member Data Documentation

◆ ARCHIVE_TYPE

const String VGears::LGPArchiveFactory::ARCHIVE_TYPE
static

The archive type.


The documentation for this class was generated from the following files: