CEL

Public API Reference

iEntityTemplateLoader Struct Reference

This interface allows one to access the celentitytpl addon with an easier interface. More...

#include <tools/entitytplloader.h>

Inheritance diagram for iEntityTemplateLoader:

List of all members.

Public Member Functions

virtual iCelPropertyClassTemplateLoad (iCelEntityTemplate *tpl, iDocumentNode *node, iLoaderContext *context)=0
 Load a property class template from a document node.
virtual iCelEntityTemplateLoad (const char *path, const char *file)=0
 Conveniance function to load the entity template from a vfs file.
virtual iCelEntityTemplateLoad (iDocumentNode *node, iLoaderContext *context)=0
 Load the entity template from the document node.
virtual bool Save (iCelPropertyClassTemplate *pctpl, iDocumentNode *node)=0
 Save an property class template to the given node.
virtual bool Save (iCelEntityTemplate *tpl, iDocumentNode *node)=0
 Save an entity template to a document node.

Detailed Description

This interface allows one to access the celentitytpl addon with an easier interface.

With this addon you can load entity templates with assocated behaviour and property classes from an XML description file.

Definition at line 37 of file entitytplloader.h.


Member Function Documentation

virtual iCelPropertyClassTemplate* iEntityTemplateLoader::Load ( iCelEntityTemplate tpl,
iDocumentNode node,
iLoaderContext context 
) [pure virtual]

Load a property class template from a document node.

Returns 0 on failure. In case of failure the error has been reported to the reporter.

virtual iCelEntityTemplate* iEntityTemplateLoader::Load ( const char *  path,
const char *  file 
) [pure virtual]

Conveniance function to load the entity template from a vfs file.

Parameters:
path optional VFS path. Can be 0.
virtual iCelEntityTemplate* iEntityTemplateLoader::Load ( iDocumentNode node,
iLoaderContext context 
) [pure virtual]

Load the entity template from the document node.

Returns entity template or 0 on failure. In case of failure the error has been reported to the reporter.

virtual bool iEntityTemplateLoader::Save ( iCelPropertyClassTemplate pctpl,
iDocumentNode node 
) [pure virtual]

Save an property class template to the given node.

Returns false on failure. In case of failure the error has been reported to the reporter.

virtual bool iEntityTemplateLoader::Save ( iCelEntityTemplate tpl,
iDocumentNode node 
) [pure virtual]

Save an entity template to a document node.

Returns false on failure. In case of failure the error has been reported to the reporter.


The documentation for this struct was generated from the following file:

Generated for CEL: Crystal Entity Layer 2.1 by doxygen 1.6.1