BaseGameFeature::BaseGameFeatureUnit Class Reference

#include <basegamefeatureunit.h>

Detailed Description

The BaseGameFeatureUnit creates everything to allow load and run a game level.

Therefore it creates managers to allow creation and handling of entities, properties and attributes.

Copyright

(C) 2007 Radon Labs GmbH (C) 2013-2020 Individual contributors, see AUTHORS file

Inherits Game::FeatureUnit.

Protected Attributes
Game::ManagerHandle	blueprintManager
Game::ManagerHandle	timeManager
Core::CVar *	cl_debug_worlds
Protected Attributes inherited from Game::FeatureUnit
Util::ArrayAllocator< ManagerHandle, ManagerAPI >	managers
Ids::IdGenerationPool	managerPool
bool	active
Util::CommandLineArgs	args
	cmdline args for configuration from cmdline

Private Member Functions
virtual __DeclareClass(BaseGameFeatureUnit) __DeclareSingleton(BaseGameFeatureUnit) public	~BaseGameFeatureUnit ()
	destructor
void	OnAttach () override
	called upon attaching the feature unit
void	OnActivate () override
	Called upon activation of feature unit.
void	OnDeactivate () override
	Called upon deactivation of feature unit.
void	OnEndFrame () override
	called at the end of the feature trigger cycle
void	OnRenderDebug () override
	called when game debug visualization is on
void	OnFrame () override
	called at the beginning of a frame

Additional Inherited Members
Public Member Functions inherited from Game::FeatureUnit
	FeatureUnit ()
	constructor
virtual	~FeatureUnit ()
	destructor
virtual void	OnRemove ()
	called from GameServer::RemoveGameFeature()
bool	IsActive () const
	return true if featureunit is currently active
virtual void	OnLoad (World *world)
	called from within GameServer::Load()
virtual void	OnStart (World *world)
	called from within GameServer::OnStart() after OnLoad
virtual void	OnSave (World *world)
	called from within GameServer::Save()
virtual void	OnBeforeLoad (World *world)
	called from within GameServer::NotifyBeforeLoad()
virtual void	OnBeforeCleanup (World *world)
	called from within GameServer::NotifyBeforeCleanup()
virtual void	OnStop (World *world)
	called from withing GameServer::Stop()
virtual void	OnBeginFrame ()
	called on begin of frame
virtual void	OnBeforeViews ()
	Called between beginning of frame and before the views are iterated.
virtual void	OnDecay ()
	called after entities has been destroyed and before releasing their memory
virtual ManagerHandle	AttachManager (ManagerAPI api)
	attach a manager to the feature unit
virtual void	RemoveManager (ManagerHandle handle)
	remove a manager from the feature unit
void	SetCmdLineArgs (const Util::CommandLineArgs &a)
	set command line args
const Util::CommandLineArgs &	GetCmdLineArgs () const
	get command line args
Public Member Functions inherited from Core::RefCounted
	RefCounted ()
	constructor
int	GetRefCount () const
	get the current refcount
void	AddRef ()
	increment refcount by one
void	Release ()
	decrement refcount and destroy object if refcount is zero
bool	IsInstanceOf (const Rtti &rtti) const
	return true if this object is instance of given class
bool	IsInstanceOf (const Util::String &className) const
	return true if this object is instance of given class by string
bool	IsInstanceOf (const Util::FourCC &classFourCC) const
	return true if this object is instance of given class by fourcc
bool	IsA (const Rtti &rtti) const
	return true if this object is instance of given class, or a derived class
bool	IsA (const Util::String &rttiName) const
	return true if this object is instance of given class, or a derived class, by string
bool	IsA (const Util::FourCC &rttiFourCC) const
	return true if this object is instance of given class, or a derived class, by fourcc
const Util::String &	GetClassName () const
	get the class name
Util::FourCC	GetClassFourCC () const
	get the class FourCC code
Static Public Member Functions inherited from Core::RefCounted
static void	DumpRefCountingLeaks ()
	dump refcounting leaks, call at end of application (NEBULA_DEBUG builds only!)
Protected Member Functions inherited from Core::RefCounted
virtual	~RefCounted ()
	destructor (called when refcount reaches zero)

Constructor & Destructor Documentation

~BaseGameFeatureUnit()

BaseGameFeature::BaseGameFeatureUnit::~BaseGameFeatureUnit ( )

privatevirtual

destructor

Member Function Documentation

OnActivate()

void BaseGameFeature::BaseGameFeatureUnit::OnActivate ( )

overrideprivatevirtual

Called upon activation of feature unit.

Reimplemented from Game::FeatureUnit.

OnAttach()

void BaseGameFeature::BaseGameFeatureUnit::OnAttach ( )

overrideprivatevirtual

called upon attaching the feature unit

Reimplemented from Game::FeatureUnit.

OnDeactivate()

void BaseGameFeature::BaseGameFeatureUnit::OnDeactivate ( )

overrideprivatevirtual

Called upon deactivation of feature unit.

Reimplemented from Game::FeatureUnit.

OnEndFrame()

void BaseGameFeature::BaseGameFeatureUnit::OnEndFrame ( )

overrideprivatevirtual

called at the end of the feature trigger cycle

Reimplemented from Game::FeatureUnit.

OnFrame()

void BaseGameFeature::BaseGameFeatureUnit::OnFrame ( )

overrideprivatevirtual

called at the beginning of a frame

Reimplemented from Game::FeatureUnit.

OnRenderDebug()

void BaseGameFeature::BaseGameFeatureUnit::OnRenderDebug ( )

overrideprivatevirtual

called when game debug visualization is on

Reimplemented from Game::FeatureUnit.

Member Data Documentation

blueprintManager

Game::ManagerHandle BaseGameFeature::BaseGameFeatureUnit::blueprintManager

protected

cl_debug_worlds

Core::CVar* BaseGameFeature::BaseGameFeatureUnit::cl_debug_worlds

protected

timeManager

Game::ManagerHandle BaseGameFeature::BaseGameFeatureUnit::timeManager

protected

---

The documentation for this class was generated from the following files:

• /github/workspace/code/application/basegamefeature/basegamefeatureunit.h
• /github/workspace/code/application/basegamefeature/basegamefeatureunit.cc