iVlkLevel Struct Reference

Inheritance diagram for iVlkLevel:

Detailed Description

Vlk level interface.

Public Member Functions
virtual const ni::achar *	GetName () const =0
	Get the level name. {Property}. More...
virtual const ni::iDataTable *	GetDataTable () const =0
	Get the original level data table. {Property}. More...
virtual iVlkEntity *	GetRoot () const =0
	Get the root entity. {Property}. More...
virtual ni::tBool	Load (vlk::iVlk *apVlk)=0
	Load the level. More...
virtual iVlkEntity *	LoadEx (vlk::iVlk *apVlk, const ni::achar *aaszName, const ni::achar *aaszClassName)=0
	Load the level as an independant entity. More...
virtual void	Unload ()=0
	Unload the level. More...
virtual ni::tBool	GetIsLoaded () const =0
	Check if the level is already loaded. {Property}. More...
virtual ni::tBool	Reset ()=0
	Reset the level. More...
virtual ni::tBool	PrepareDataTable (vlk::iVlk *apVlk)=0
	Prepare the level data table. More...
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 const ni::achar* GetName ( ) const

pure virtual

Get the level name. {Property}.

virtual const ni::iDataTable* GetDataTable ( ) const

pure virtual

Get the original level data table. {Property}.

virtual iVlkEntity* GetRoot ( ) const

pure virtual

Get the root entity. {Property}.

virtual ni::tBool Load ( vlk::iVlk *  apVlk )

pure virtual

Load the level.

Remarks

Calls LoadEx then adds the Level class flags and attach a sink to allow the query of this Level object (through the iVlkLevel interface).

virtual iVlkEntity* LoadEx ( vlk::iVlk *  apVlk, const ni::achar *  aaszName, const ni::achar *  aaszClassName  )

pure virtual

Load the level as an independant entity.

Parameters

apVlk
aaszName	specifies the name to be used for the new level entity.
aaszClassName	specifies the classname to be used for the new level entity, usually 'layer_level' for levels embedded in another level.

Remarks

Does not attach a sink that allows to query the level object nor set the Level class flag.

virtual void Unload ( )

pure virtual

Unload the level.

virtual ni::tBool GetIsLoaded ( ) const

pure virtual

Check if the level is already loaded. {Property}.

virtual ni::tBool Reset ( )

pure virtual

Reset the level.

Remarks

Will unload all scripts and reload them all to reset all states that may remain.

virtual ni::tBool PrepareDataTable ( vlk::iVlk *  apVlk )

pure virtual

Prepare the level data table.