Inheritance diagram for iVlkGame:

Detailed Description

Vlk game interface.

General
virtual vlk::iVlk *	GetVlk () const =0
	Get the vlk interface. {Property}. More...

virtual void	SetName (const ni::achar *aaszName)=0
	Set the game's name. {Property}. More...

virtual const ni::achar *	GetName () const =0
	Get the game's name. {Property}. More...

virtual ni::tBool	WriteDataTable (ni::iDataTable *apDT)=0
	Write the game's data table. More...

virtual void	RegisterCreateInstance ()=0
	Register all the descriptions in the CreateInstanceMap. More...

virtual void	UnregisterCreateInstance ()=0
	Unregister all the descriptions from the CreateInstanceMap. More...

Levels
virtual ni::tBool	SetLevel (const ni::achar *aaszLevel)=0
	Set the current level. More...

virtual vlk::iVlkLevel *	GetLevel () const =0
	Get the current level. {Property}. More...

virtual ni::tBool	Reset ()=0
	Reset all levels of the game. More...

virtual ni::tU32	GetNumLevelDescs () const =0
	Get the number of level description. {Property}. More...

virtual vlk::iVlkLevelDesc *	GetLevelDesc (ni::tU32 anIndex) const =0
	Get the level description at the specified index. {Property}. More...

virtual vlk::iVlkLevelDesc *	GetLevelDescFromName (const ni::achar *aaszName) const =0
	Get a level description from it's name. {Property}. More...

virtual ni::tBool	AddLevelDesc (const ni::achar aaszName, const ni::achar aaszPath)=0
	Add a level description. More...

virtual ni::tBool	RemoveLevelDesc (vlk::iVlkLevelDesc *apDesc)=0
	Remove the level description at the specified index. More...

virtual ni::tBool	ReassignCurrentLevel (vlk::iVlkLevelDesc *apDesc)=0
	Reassign the current level to a new level description. More...

Entities
virtual ni::tU32	GetNumEntityClassDescs () const =0
	Get the number of entity class description. {Property}. More...

virtual vlk::iVlkEntityClassDesc *	GetEntityClassDesc (ni::tU32 anIndex) const =0
	Get the entity class description at the specified index. {Property}. More...

virtual vlk::iVlkEntityClassDesc *	GetEntityClassDescFromName (const ni::achar *aaszName) const =0
	Get a entity class description from it's name. {Property}. More...

virtual ni::tBool	AddEntityClassDesc (const ni::achar aaszName, const ni::achar aaszPath)=0
	Add a entity class description. More...

virtual ni::tBool	RemoveEntityClassDesc (vlk::iVlkEntityClassDesc *apDesc)=0
	Remove the entity class description at the specified index. More...

Actions
virtual ni::tU32	GetNumActionDescs () const =0
	Get the number of action description. {Property}. More...

virtual vlk::iVlkActionDesc *	GetActionDesc (ni::tU32 anIndex) const =0
	Get the action description at the specified index. {Property}. More...

virtual vlk::iVlkActionDesc *	GetActionDescFromName (const ni::achar *aaszName) const =0
	Get a action description from it's name. {Property}. More...

virtual ni::tBool	AddActionDesc (const ni::achar aaszName, const ni::achar aaszPath)=0
	Add a action description. More...

virtual ni::tBool	RemoveActionDesc (vlk::iVlkActionDesc *apDesc)=0
	Remove the action description at the specified index. More...

Events
virtual ni::tU32	GetNumEventClassDescs () const =0
	Get the number of event description. {Property}. More...

virtual vlk::iVlkEventClassDesc *	GetEventClassDesc (ni::tU32 anIndex) const =0
	Get the event description at the specified index. {Property}. More...

virtual vlk::iVlkEventClassDesc *	GetEventClassDescFromName (const ni::achar *aaszName) const =0
	Get a event description from it's name. {Property}. More...

virtual ni::tBool	AddEventClassDesc (const ni::achar aaszName, const ni::achar aaszPath)=0
	Add a event description. More...

virtual ni::tBool	RemoveEventClassDesc (vlk::iVlkEventClassDesc *apDesc)=0
	Remove the event description at the specified index. More...

Additional Inherited Members
Public Member Functions inherited from iUnknown
virtual tBool	IsOK () const =0
	Check if the object is valid. More...

virtual tI32	AddRef ()=0
	Signal that one more reference of the object has been created. More...

virtual tI32	Release ()=0
	Release a reference of the object. More...

virtual void	DeleteThis ()=0
	Bypass any reference counting and delete this object. More...

virtual void	Invalidate ()=0
	Invalidate the object. More...

virtual iUnknown *	QueryInterface (const tUUID &aIID)=0
	Query an interface. More...

virtual void	ListInterfaces (iMutableCollection *apLst, tU32 anFlags) const =0
	Fill a UUID list containing the UUIDs of the implemented interfaces. More...

virtual tI32	SetNumRefs (tI32 anNumRefs)=0
	Set the reference counter directly. More...

virtual tI32	GetNumRefs () const =0
	Get the number of references to this object. More...

Member Function Documentation

virtual vlk::iVlk* GetVlk ( ) const

pure virtual

Get the vlk interface. {Property}.

virtual void SetName ( const ni::achar * aaszName )

pure virtual

Set the game's name. {Property}.

virtual const ni::achar* GetName ( ) const

pure virtual

Get the game's name. {Property}.

virtual ni::tBool WriteDataTable ( ni::iDataTable * apDT )

pure virtual

Write the game's data table.

virtual void RegisterCreateInstance ( )

pure virtual

Register all the descriptions in the CreateInstanceMap.

Remarks: This is needed so that iVlk::CreateEntity/Action/EventSink can create the sinks of the custom entities/actions/events in the game.

virtual void UnregisterCreateInstance ( )

pure virtual

Unregister all the descriptions from the CreateInstanceMap.

virtual ni::tBool SetLevel ( const ni::achar * aaszLevel )

pure virtual

Set the current level.

Remarks: If the level hasn't been loaded the function will fail. {Property}

virtual vlk::iVlkLevel* GetLevel ( ) const

pure virtual

Get the current level. {Property}.

virtual ni::tBool Reset ( )

pure virtual

Reset all levels of the game.

virtual ni::tU32 GetNumLevelDescs ( ) const

pure virtual

Get the number of level description. {Property}.

virtual vlk::iVlkLevelDesc* GetLevelDesc ( ni::tU32 anIndex ) const

pure virtual

Get the level description at the specified index. {Property}.

virtual vlk::iVlkLevelDesc* GetLevelDescFromName ( const ni::achar * aaszName ) const

pure virtual

Get a level description from it's name. {Property}.

virtual ni::tBool AddLevelDesc	(	const ni::achar *	aaszName,
		const ni::achar *	aaszPath
	)

pure virtual

Add a level description.

virtual ni::tBool RemoveLevelDesc ( vlk::iVlkLevelDesc * apDesc )

pure virtual

Remove the level description at the specified index.

virtual ni::tBool ReassignCurrentLevel ( vlk::iVlkLevelDesc * apDesc )

pure virtual

Reassign the current level to a new level description.

Remarks: The the description to assign the level can't already have loaded its level.; This method exist mainly to implement a "SaveAs" type feature

virtual ni::tU32 GetNumEntityClassDescs ( ) const

pure virtual

Get the number of entity class description. {Property}.

virtual vlk::iVlkEntityClassDesc* GetEntityClassDesc ( ni::tU32 anIndex ) const

pure virtual

Get the entity class description at the specified index. {Property}.

virtual vlk::iVlkEntityClassDesc* GetEntityClassDescFromName ( const ni::achar * aaszName ) const

pure virtual

Get a entity class description from it's name. {Property}.

virtual ni::tBool AddEntityClassDesc	(	const ni::achar *	aaszName,
		const ni::achar *	aaszPath
	)

pure virtual

Add a entity class description.

virtual ni::tBool RemoveEntityClassDesc ( vlk::iVlkEntityClassDesc * apDesc )

pure virtual

Remove the entity class description at the specified index.

virtual ni::tU32 GetNumActionDescs ( ) const

pure virtual

Get the number of action description. {Property}.

virtual vlk::iVlkActionDesc* GetActionDesc ( ni::tU32 anIndex ) const

pure virtual

Get the action description at the specified index. {Property}.

virtual vlk::iVlkActionDesc* GetActionDescFromName ( const ni::achar * aaszName ) const

pure virtual

Get a action description from it's name. {Property}.

virtual ni::tBool AddActionDesc	(	const ni::achar *	aaszName,
		const ni::achar *	aaszPath
	)

pure virtual

Add a action description.

virtual ni::tBool RemoveActionDesc ( vlk::iVlkActionDesc * apDesc )

pure virtual

Remove the action description at the specified index.

virtual ni::tU32 GetNumEventClassDescs ( ) const

pure virtual

Get the number of event description. {Property}.

virtual vlk::iVlkEventClassDesc* GetEventClassDesc ( ni::tU32 anIndex ) const

pure virtual

Get the event description at the specified index. {Property}.

virtual vlk::iVlkEventClassDesc* GetEventClassDescFromName ( const ni::achar * aaszName ) const

pure virtual

Get a event description from it's name. {Property}.

virtual ni::tBool AddEventClassDesc	(	const ni::achar *	aaszName,
		const ni::achar *	aaszPath
	)

pure virtual

Add a event description.

virtual ni::tBool RemoveEventClassDesc ( vlk::iVlkEventClassDesc * apDesc )

pure virtual

Remove the event description at the specified index.

Detailed Description

General

Levels

Entities

Actions

Events

Additional Inherited Members

Member Function Documentation