CryEngine.LevelSystem

Public Member Functions | Events | List of all members

Listens to CryEngine's LevelSystem and forwards events from it. Classes may use events from this class to be informed about Level System state changes. More...

Inherits ILevelSystemListener.

Public Member Functions
override void	OnLevelNotFound (string levelName)
	Called by the engine when a level was not found. More...

override void	OnLoadingStart (ILevelInfo pLevel)
	Called by the engine when loading a level has started. More...

override void	OnLoadingLevelEntitiesStart (ILevelInfo pLevel)
	Called by the engine when loading the entities in a level has started. More...

override void	OnLoadingComplete (ILevelInfo pLevel)
	Called by the engine when loading a level has completed. More...

override void	OnLoadingError (ILevelInfo pLevel, string error)
	Called by the engine when there is an error during loading. More...

override void	OnLoadingProgress (ILevelInfo pLevel, int progressAmount)
	Called by the engine when there is loading progress. More...

override void	OnUnloadComplete (ILevelInfo pLevel)
	Called by the engine when unloading has completed. More...

override void	Dispose ()
	Disposes of this instance. More...

Events
static Action< EventArgs< string > >	LevelNotFound
	Invked if a level is not found. More...

static Action< EventArgs< ILevelInfo > >	LoadingStart
	Invoked when loading a level has started. More...

static Action< EventArgs< ILevelInfo > >	LoadingLevelEntitiesStart
	Invoked when loading entities in a level has started. More...

static Action< EventArgs< ILevelInfo, string > >	LoadingError
	Invoked when there is an error during loading. More...

static Action< EventArgs< ILevelInfo, int > >	LoadingProgress
	Invoked when there is loading progress. More...

static Action< EventArgs< ILevelInfo > >	LoadingComplete
	Invoked when loading has completed. More...

static Action< EventArgs< ILevelInfo > >	UnloadingComplete
	Invoked when unloading has completed. More...

Detailed Description

Listens to CryEngine's LevelSystem and forwards events from it. Classes may use events from this class to be informed about Level System state changes.

Member Function Documentation

◆ Dispose()

override void CryEngine.LevelSystem.Dispose

(

)

inline

Disposes of this instance.

◆ OnLevelNotFound()

override void CryEngine.LevelSystem.OnLevelNotFound

(

string

levelName

)

inline

Called by the engine when a level was not found.

Parameters

levelName

◆ OnLoadingComplete()

override void CryEngine.LevelSystem.OnLoadingComplete

(

ILevelInfo

pLevel

)

inline

Called by the engine when loading a level has completed.

Parameters

pLevel

◆ OnLoadingError()

override void CryEngine.LevelSystem.OnLoadingError	(	ILevelInfo	pLevel,
		string	error
	)

inline

Called by the engine when there is an error during loading.

Parameters

pLevel
error

◆ OnLoadingLevelEntitiesStart()

override void CryEngine.LevelSystem.OnLoadingLevelEntitiesStart

(

ILevelInfo

pLevel

)

inline

Called by the engine when loading the entities in a level has started.

Parameters

pLevel

◆ OnLoadingProgress()

override void CryEngine.LevelSystem.OnLoadingProgress	(	ILevelInfo	pLevel,
		int	progressAmount
	)

inline

Called by the engine when there is loading progress.

Parameters

pLevel
progressAmount

◆ OnLoadingStart()

override void CryEngine.LevelSystem.OnLoadingStart

(

ILevelInfo

pLevel

)

inline

Called by the engine when loading a level has started.

Parameters

pLevel

◆ OnUnloadComplete()

override void CryEngine.LevelSystem.OnUnloadComplete

(

ILevelInfo

pLevel

)

inline

Called by the engine when unloading has completed.

Parameters

pLevel

Event Documentation

◆ LevelNotFound

Action<EventArgs > CryEngine.LevelSystem.LevelNotFound

static

Invked if a level is not found.

◆ LoadingComplete

Action<EventArgs > CryEngine.LevelSystem.LoadingComplete

static

Invoked when loading has completed.

◆ LoadingError

Action<EventArgs > CryEngine.LevelSystem.LoadingError

static

Invoked when there is an error during loading.

◆ LoadingLevelEntitiesStart

Action<EventArgs > CryEngine.LevelSystem.LoadingLevelEntitiesStart

static

Invoked when loading entities in a level has started.

◆ LoadingProgress

Action<EventArgs > CryEngine.LevelSystem.LoadingProgress

static

Invoked when there is loading progress.

◆ LoadingStart

Action<EventArgs > CryEngine.LevelSystem.LoadingStart

static

Invoked when loading a level has started.

◆ UnloadingComplete

Action<EventArgs > CryEngine.LevelSystem.UnloadingComplete

static

Invoked when unloading has completed.