Nebula
Loading...
Searching...
No Matches
Private Member Functions | Private Attributes | List of all members
Multiplayer::MultiplayerFeatureUnit Class Reference

#include <multiplayerfeatureunit.h>

Detailed Description

Copyright
(C) 2025 Individual contributors, see AUTHORS file

Inherits Game::FeatureUnit.

Private Member Functions

__DeclareClass(MultiplayerFeatureUnit) __DeclareSingleton(MultiplayerFeatureUnit) public ~MultiplayerFeatureUnit ()
 destructor
 
void OnAttach () override
 called from GameServer::AttachGameFeature()
 
void OnActivate () override
 called after GameServer::AttachGameFeature()
 
void OnDeactivate () override
 called before GameServer::RemoveGameFeature()
 
void OnBeginFrame () override
 called on begin of frame
 
void OnFrame () override
 called in the middle of the feature trigger cycle
 
void OnEndFrame () override
 called at the end of the feature trigger cycle
 
virtual void OnRenderDebug ()
 called when game debug visualization is on
 
bool IsServer () const
 returns true if this instance is the server.
 
void SetServer (BaseMultiplayerServer *server)
 Set the server that should be used (if any). You must set this before activating the feature unit.
 
void SetClient (BaseMultiplayerClient *client)
 Set the client that should be used (if any). You must set this before activating the feature unit.
 

Private Attributes

BaseMultiplayerServer * server = nullptr
 
BaseMultiplayerClient * client = nullptr
 

Additional Inherited Members

- 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)
 
- Protected Attributes inherited from Game::FeatureUnit
Util::Array< Ptr< Manager > > managers
 
bool active
 
Util::CommandLineArgs args
 cmdline args for configuration from cmdline
 

Constructor & Destructor Documentation

◆ ~MultiplayerFeatureUnit()

Multiplayer::MultiplayerFeatureUnit::~MultiplayerFeatureUnit ( )
private

destructor

Member Function Documentation

◆ IsServer()

bool Multiplayer::MultiplayerFeatureUnit::IsServer ( ) const
inlineprivate

returns true if this instance is the server.

◆ OnActivate()

void Multiplayer::MultiplayerFeatureUnit::OnActivate ( )
overrideprivatevirtual

called after GameServer::AttachGameFeature()

This method is called by Game::GameServer::AttachGameFeature().

Use this method for one-time initializations of the FeatureUnit.

Reimplemented from Game::FeatureUnit.

◆ OnAttach()

void Multiplayer::MultiplayerFeatureUnit::OnAttach ( )
overrideprivatevirtual

called from GameServer::AttachGameFeature()

Reimplemented from Game::FeatureUnit.

◆ OnBeginFrame()

void Multiplayer::MultiplayerFeatureUnit::OnBeginFrame ( )
overrideprivatevirtual

called on begin of frame

This method is called from Game::GameServer::OnBeginFrame() on all game features attached to an GameServer in the order of attachment.

Override this method if your FeatureUnit has to do any work at the beginning of the frame.

Reimplemented from Game::FeatureUnit.

◆ OnDeactivate()

void Multiplayer::MultiplayerFeatureUnit::OnDeactivate ( )
overrideprivatevirtual

called before GameServer::RemoveGameFeature()

This method is called by Game::GameServer::RemoveGameFeature().

Use this method to cleanup stuff which has been initialized in OnActivate().

Reimplemented from Game::FeatureUnit.

◆ OnEndFrame()

void Multiplayer::MultiplayerFeatureUnit::OnEndFrame ( )
overrideprivatevirtual

called at the end of the feature trigger cycle

This method is called from Game::GameServer::OnRender() on all game features attached to an GameServer in the order of attachment.

Override this method if your FeatureUnit has any work to do before rendering happens.

Reimplemented from Game::FeatureUnit.

◆ OnFrame()

void Multiplayer::MultiplayerFeatureUnit::OnFrame ( )
overrideprivatevirtual

called in the middle of the feature trigger cycle

This method is called from Game::GameServer::OnMoveBefore() on all game features attached to an GameServer in the order of attachment.

Override this method if your FeatureUnit has any work to do before the physics subsystem is triggered.

Reimplemented from Game::FeatureUnit.

◆ OnRenderDebug()

void Multiplayer::MultiplayerFeatureUnit::OnRenderDebug ( )
privatevirtual

called when game debug visualization is on

This method is called from Game::GameServer::OnRenderDebug() on all game features attached to an GameServer in the order of attachment.

It's meant for debug issues. It will be called when debug mode is enabled.

Reimplemented from Game::FeatureUnit.

◆ SetClient()

void Multiplayer::MultiplayerFeatureUnit::SetClient ( BaseMultiplayerClient * client)
inlineprivate

Set the client that should be used (if any). You must set this before activating the feature unit.

◆ SetServer()

void Multiplayer::MultiplayerFeatureUnit::SetServer ( BaseMultiplayerServer * server)
inlineprivate

Set the server that should be used (if any). You must set this before activating the feature unit.

Member Data Documentation

◆ client

BaseMultiplayerClient* Multiplayer::MultiplayerFeatureUnit::client = nullptr
private

◆ server

BaseMultiplayerServer* Multiplayer::MultiplayerFeatureUnit::server = nullptr
private
The documentation for this class was generated from the following files: