Mcro::Subsystems::Subsystems Namespace Reference

Extra namespace encapsulates common vocabulary. More...

Functions
template<CEngineSubsystem T>
T *	Get ()
	Helper for getting a subsystem, the internal boilerplate will be chosen based on the type of subsystem T inherits from. Required arguments may vary depending on the type of subsystem.
template<CGameInstanceSubsystem T>
T *	Get (const UObject *worldContextObject=nullptr, EGameInstanceFallback fallback=EGameInstanceFallback::UseGameViewport, EGetWorldErrorMode errorMode=EGetWorldErrorMode::LogAndReturnNull)
	Helper for getting a subsystem, the internal boilerplate will be chosen based on the type of subsystem T inherits from. Required arguments may vary depending on the type of subsystem.
template<CLocalPlayerSubsystem T>
T *	Get (const UObject *worldContext)
	Helper for getting a subsystem, the internal boilerplate will be chosen based on the type of subsystem T inherits from. Required arguments may vary depending on the type of subsystem.
template<CWorldSubsystem T>
T *	Get (const UObject *worldContext, EGetWorldErrorMode errorMode=EGetWorldErrorMode::LogAndReturnNull)
	Helper for getting a subsystem, the internal boilerplate will be chosen based on the type of subsystem T inherits from. Required arguments may vary depending on the type of subsystem.
template<CSubsystem T, typename... Args>
T &	GetChecked (Args... args)
	Helper for getting a subsystem, the internal boilerplate will be chosen based on the type of subsystem T inherits from. Required arguments may vary depending on the type of subsystem. This is a checked version so if any steps fail to produce the target subsystem the program may crash.
template<CSubsystem T, typename... Args>
T *	GetEnsured (Args... args)
	Helper for getting a subsystem, the internal boilerplate will be chosen based on the type of subsystem T inherits from. Required arguments may vary depending on the type of subsystem. This is an ensured version so if any steps fail to produce the target subsystem an ensure may be hit.
template<CSubsystem T>
bool	ShouldCreate (UObject *outer)
	Helper for checking if some other subsystem should be created. Useful when you want to make a subsystem which should only be created if some other subsystem should be also created.

Detailed Description

Extra namespace encapsulates common vocabulary.

Function Documentation

Get() [1/4]

template<CEngineSubsystem T>

T * Mcro::Subsystems::Subsystems::Get

(

)

Helper for getting a subsystem, the internal boilerplate will be chosen based on the type of subsystem T inherits from. Required arguments may vary depending on the type of subsystem.

Template Parameters

T	UEngineSubsystem derivative

Returns

Subsystem if exists or nullptr

Definition at line 65 of file Subsystems.h.

Get() [2/4]

template<CLocalPlayerSubsystem T>

T * Mcro::Subsystems::Subsystems::Get

(

const UObject *

worldContext

)

Helper for getting a subsystem, the internal boilerplate will be chosen based on the type of subsystem T inherits from. Required arguments may vary depending on the type of subsystem.

Template Parameters

T	ULocalPlayerSubsystem derivative

Returns

Subsystem if exists or nullptr

Definition at line 135 of file Subsystems.h.

Get() [3/4]

template<CWorldSubsystem T>

T * Mcro::Subsystems::Subsystems::Get	(	const UObject *	worldContext,
		EGetWorldErrorMode	errorMode = EGetWorldErrorMode::LogAndReturnNull )

Helper for getting a subsystem, the internal boilerplate will be chosen based on the type of subsystem T inherits from. Required arguments may vary depending on the type of subsystem.

Template Parameters

T	UWorldSubsystem derivative

Returns

Subsystem if exists or nullptr

Definition at line 153 of file Subsystems.h.

Get() [4/4]

template<CGameInstanceSubsystem T>

T * Mcro::Subsystems::Subsystems::Get	(	const UObject *	worldContextObject = nullptr,
		EGameInstanceFallback	fallback = EGameInstanceFallback::UseGameViewport,
		EGetWorldErrorMode	errorMode = EGetWorldErrorMode::LogAndReturnNull )

Helper for getting a subsystem, the internal boilerplate will be chosen based on the type of subsystem T inherits from. Required arguments may vary depending on the type of subsystem.

Template Parameters

T	UGameInstanceSubsystem derivative

Returns

Subsystem if exists or nullptr

Definition at line 79 of file Subsystems.h.

GetChecked()

template<CSubsystem T, typename... Args>

T & Mcro::Subsystems::Subsystems::GetChecked

(

Args...

args

)

Helper for getting a subsystem, the internal boilerplate will be chosen based on the type of subsystem T inherits from. Required arguments may vary depending on the type of subsystem. This is a checked version so if any steps fail to produce the target subsystem the program may crash.

Template Parameters

T	type of the subsystem

Returns

Guaranteed valid reference to a subsystem

Definition at line 172 of file Subsystems.h.

GetEnsured()

template<CSubsystem T, typename... Args>

T * Mcro::Subsystems::Subsystems::GetEnsured

(

Args...

args

)

Helper for getting a subsystem, the internal boilerplate will be chosen based on the type of subsystem T inherits from. Required arguments may vary depending on the type of subsystem. This is an ensured version so if any steps fail to produce the target subsystem an ensure may be hit.

Template Parameters

T	type of the subsystem

Returns

Subsystem if exists or nullptr

Definition at line 193 of file Subsystems.h.

ShouldCreate()

template<CSubsystem T>

bool Mcro::Subsystems::Subsystems::ShouldCreate

(

UObject *

outer

)

Helper for checking if some other subsystem should be created. Useful when you want to make a subsystem which should only be created if some other subsystem should be also created.

Template Parameters

T	type of the subsystem

Parameters

outer

be sure to pass outer argument which type aligns with checked subsystem outer. This may fail for example if you pass game instance as outer to check for world subsystem existence as ShouldCreateSubsystem of that subsystem may expect the outer to be World.

Returns

True if the target subsystem should be created

Definition at line 215 of file Subsystems.h.