CP_SDK::ModuleBase< t_Type > Class Template Reference

Module base interface. More...

#include <ModuleBase.hpp>

Inheritance diagram for CP_SDK::ModuleBase< t_Type >:

Collaboration diagram for CP_SDK::ModuleBase< t_Type >:

Public Member Functions
void	SetEnabled (bool p_Enabled) override
	Set enabled.
void	CheckForActivation (EIModuleBaseActivationType p_Kind) override
	Check for module activation.
void	OnApplicationExit () override
	On application exit.
Public Member Functions inherited from CP_SDK::IModuleBase
virtual EIModuleBaseType	Type () const =0
virtual std::u16string_view	Name () const =0
virtual std::u16string_view	FancyName () const =0
virtual std::u16string_view	Description () const =0
virtual std::u16string_view	DocumentationURL () const =0
virtual bool	UseChatFeatures () const =0
virtual bool	IsEnabled () const =0
virtual void	IsEnabled (bool p_Enabled)=0
virtual EIModuleBaseActivationType	ActivationType () const =0
virtual t_InitialViews	GetSettingsViewControllers ()
	Get Module settings UI.

Protected Member Functions
	ModuleBase ()
	Constructor.
virtual	~ModuleBase ()
	Destructor.
virtual void	SetInstance (t_Type *p_Instance)=0
	Set singleton instance.
virtual void	OnEnable ()=0
	Enable the Module.
virtual void	OnDisable ()=0
	Disable the Module.
Protected Member Functions inherited from CP_SDK::IModuleBase
	IModuleBase ()=default
	Constructor.
virtual	~IModuleBase ()
	Destructor.

Detailed Description

template<class t_Type>
class CP_SDK::ModuleBase< t_Type >

Module base interface.

Definition at line 94 of file ModuleBase.hpp.

Constructor & Destructor Documentation

ModuleBase()

template<class t_Type >

CP_SDK::ModuleBase< t_Type >::ModuleBase ( )

inlineprotected

Constructor.

Definition at line 101 of file ModuleBase.hpp.

~ModuleBase()

template<class t_Type >

virtual CP_SDK::ModuleBase< t_Type >::~ModuleBase ( )

inlineprotectedvirtual

Destructor.

Definition at line 107 of file ModuleBase.hpp.

Member Function Documentation

CheckForActivation()

template<class t_Type >

void CP_SDK::ModuleBase< t_Type >::CheckForActivation ( EIModuleBaseActivationType  p_Kind )

inlineoverridevirtual

Check for module activation.

Parameters

p_Kind

Activation type

Implements CP_SDK::IModuleBase.

Definition at line 126 of file ModuleBase.hpp.

OnApplicationExit()

template<class t_Type >

void CP_SDK::ModuleBase< t_Type >::OnApplicationExit ( )

inlineoverridevirtual

On application exit.

Implements CP_SDK::IModuleBase.

Definition at line 132 of file ModuleBase.hpp.

OnDisable()

template<class t_Type >

virtual void CP_SDK::ModuleBase< t_Type >::OnDisable ( )

protectedpure virtual

Disable the Module.

OnEnable()

template<class t_Type >

virtual void CP_SDK::ModuleBase< t_Type >::OnEnable ( )

protectedpure virtual

Enable the Module.

SetEnabled()

template<class t_Type >

void CP_SDK::ModuleBase< t_Type >::SetEnabled ( bool  p_Enabled )

inlineoverridevirtual

Set enabled.

Parameters

p_Enabled

New state

Implements CP_SDK::IModuleBase.

Definition at line 115 of file ModuleBase.hpp.

SetInstance()

template<class t_Type >

virtual void CP_SDK::ModuleBase< t_Type >::SetInstance ( t_Type *  p_Instance )

protectedpure virtual

Set singleton instance.

---

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

• shared/CP_SDK/ModuleBase.hpp