Files
UnrealEngineUWP/Engine/Source/Developer/CollectionManager/Public/CollectionManagerModule.h
logan buchy 63b05e7fc4 Collection Manager Telemetry Events
* Uses method of exposing a delegate for telemetry events to be registered by a StudioAnalytic provider implementation to avoid embedding schema in the engine
* Generic templates for RAII scoped timed telemetry events added to aid in generating timed events

#jira UE-155132
#rb Brooke.Hubert Wes.Hunt Ronald.Koppers
#preflight 645022cdee56ca4c247ef92a

[CL 25291458 by logan buchy in ue5-main branch]
2023-05-01 17:00:52 -04:00

58 lines
1.7 KiB
C++

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
#include "CoreMinimal.h"
#include "CollectionManagerTelemetry.h"
#include "Modules/ModuleInterface.h"
#include "Modules/ModuleManager.h"
#include "UObject/NameTypes.h"
class ICollectionManager;
class FCollectionManagerModule : public IModuleInterface
{
public:
virtual void StartupModule();
virtual void ShutdownModule();
virtual ICollectionManager& Get() const;
/**
* Singleton-like access to this module's interface. This is just for convenience!
* Beware of calling this during the shutdown phase, though. Your module might have been unloaded already.
*
* @return Returns singleton instance, loading the module on demand if needed
*/
static inline FCollectionManagerModule& GetModule()
{
static const FName CollectionManagerModuleName("CollectionManager");
FCollectionManagerModule* Module = FModuleManager::GetModulePtr<FCollectionManagerModule>(CollectionManagerModuleName);
if (Module == nullptr)
{
return FModuleManager::LoadModuleChecked<FCollectionManagerModule>(CollectionManagerModuleName);
}
else
{
return *Module;
}
}
/**
* Checks to see if this module is loaded and ready. It is only valid to call Get() if IsAvailable() returns true.
*
* @return True if the module is loaded and ready to use
*/
static inline bool IsModuleAvailable()
{
static const FName CollectionManagerModuleName("CollectionManager");
return FModuleManager::Get().IsModuleLoaded(CollectionManagerModuleName);
}
UE::CollectionManager::Analytics::FEmitAnalyticsEvent OnAnalyticsEventEmitted;
private:
ICollectionManager* CollectionManager;
class FCollectionManagerConsoleCommands* ConsoleCommands;
};