	QSDK 1.1 Documentation

Q::PlacementReaderListenerEd Struct Reference
[EntityInstance Placement Loading]

#include <Q/gameplacement.h>

Inheritance diagram for Q::PlacementReaderListenerEd:

List of all members.


Public Types
typedef Com::Ptr< PlacementReaderListenerEd >	PTR
enum	ErrorType { ParseError, DataError }
enum	PlacementReadFlags { DontWritePreloadAssets = 0x0001 }
Public Member Functions
virtual void	onError (ErrorType, const char *msg, unsigned int lineno)=0
virtual bool	onBeforeCreate (Utils::String &name, const Utils::String &groupName, const Utils::String &entityTypeName, const Utils::Vector< Utils::String > &instanceConcepts, bool isPersistent, bool isTickingEnabled, float tickDelay, bool &canMove)=0
virtual void	onAfterCreate (EntityInstance *)=0
Static Public Attributes
Com::UUID	IID

Detailed Description

See also:: PlacementFactoryEd::read(), PlacementFactoryEd2::readEx()

Member Typedef Documentation

typedef Com::Ptr<PlacementReaderListenerEd> Q::PlacementReaderListenerEd::PTR

A COM pointer to an object of this class.
Reimplemented in Q::PlacementReaderListenerEd2.

Member Enumeration Documentation

enum Q::PlacementReaderListenerEd::ErrorType

Define errors that can be passed on onError().
Enumeration values:

ParseError there was an error in the formatting of the file.

DataError there was an error in the data in the file, e.g. object reference couldn't be resolved.

enum Q::PlacementReaderListenerEd::PlacementReadFlags

Define flags to be used with PlacementFactoryEd2::readEx()
Enumeration values:

DontWritePreloadAssets some tools don't want preload assets automatically created as they make it hard to edit the schema.

Member Function Documentation

virtual void Q::PlacementReaderListenerEd::onAfterCreate ( EntityInstance * ) [pure virtual]

This method is called just after an EntityInstance has been created and fully populated.

virtual bool Q::PlacementReaderListenerEd::onBeforeCreate ( Utils::String & name,

const Utils::String & groupName,

const Utils::String & entityTypeName,

const Utils::Vector< Utils::String > & instanceConcepts,

bool isPersistent,

bool isTickingEnabled,

float tickDelay,

bool & canMove

) [pure virtual]

this method is called just before an EntityInstance is created. Return false to prevent creation. True to affirm creation. Replace the name with "" if you want to make the EntityInstance lightweight.
The canMove parameter is only used if there is no movement information in the Q file. This is for compatibility with Q1.0 database. If the database has been created with Q1.1, this field is not used and should be ignored by developers.

virtual void Q::PlacementReaderListenerEd::onError ( ErrorType ,

const char * msg,

unsigned int lineno

) [pure virtual]

this method gets called when an error occurs while reading a QGP definition.

Member Data Documentation

Com::UUID Q::PlacementReaderListenerEd::IID [static]

COM IID 65d703b7-8078-4d0f-ad87-18f264f0a24c
Reimplemented from Com::Unknown.
Reimplemented in Q::PlacementReaderListenerEd2.


		Qube Software Limited © 2000-2004

Q::PlacementReaderListenerEd Struct Reference [EntityInstance Placement Loading]

Public Types