File size: 6,639 Bytes
e3db8a9 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 | // Copyright Epic Games, Inc. All Rights Reserved.
#include "GameFramework/GameplayMessageSubsystem.h"
#include "Engine/Engine.h"
#include "Engine/GameInstance.h"
#include "Engine/World.h"
#include "UObject/ScriptMacros.h"
#include "UObject/Stack.h"
#include UE_INLINE_GENERATED_CPP_BY_NAME(GameplayMessageSubsystem)
DEFINE_LOG_CATEGORY(LogGameplayMessageSubsystem);
namespace UE
{
namespace GameplayMessageSubsystem
{
static int32 ShouldLogMessages = 0;
static FAutoConsoleVariableRef CVarShouldLogMessages(TEXT("GameplayMessageSubsystem.LogMessages"),
ShouldLogMessages,
TEXT("Should messages broadcast through the gameplay message subsystem be logged?"));
}
}
//////////////////////////////////////////////////////////////////////
// FGameplayMessageListenerHandle
void FGameplayMessageListenerHandle::Unregister()
{
if (UGameplayMessageSubsystem* StrongSubsystem = Subsystem.Get())
{
StrongSubsystem->UnregisterListener(*this);
Subsystem.Reset();
Channel = FGameplayTag();
ID = 0;
}
}
//////////////////////////////////////////////////////////////////////
// UGameplayMessageSubsystem
UGameplayMessageSubsystem& UGameplayMessageSubsystem::Get(const UObject* WorldContextObject)
{
UWorld* World = GEngine->GetWorldFromContextObject(WorldContextObject, EGetWorldErrorMode::Assert);
check(World);
UGameplayMessageSubsystem* Router = UGameInstance::GetSubsystem<UGameplayMessageSubsystem>(World->GetGameInstance());
check(Router);
return *Router;
}
bool UGameplayMessageSubsystem::HasInstance(const UObject* WorldContextObject)
{
UWorld* World = GEngine->GetWorldFromContextObject(WorldContextObject, EGetWorldErrorMode::Assert);
UGameplayMessageSubsystem* Router = World != nullptr ? UGameInstance::GetSubsystem<UGameplayMessageSubsystem>(World->GetGameInstance()) : nullptr;
return Router != nullptr;
}
void UGameplayMessageSubsystem::Deinitialize()
{
ListenerMap.Reset();
Super::Deinitialize();
}
void UGameplayMessageSubsystem::BroadcastMessageInternal(FGameplayTag Channel, const UScriptStruct* StructType, const void* MessageBytes)
{
// Log the message if enabled
if (UE::GameplayMessageSubsystem::ShouldLogMessages != 0)
{
FString* pContextString = nullptr;
#if WITH_EDITOR
if (GIsEditor)
{
extern ENGINE_API FString GPlayInEditorContextString;
pContextString = &GPlayInEditorContextString;
}
#endif
FString HumanReadableMessage;
StructType->ExportText(/*out*/ HumanReadableMessage, MessageBytes, /*Defaults=*/ nullptr, /*OwnerObject=*/ nullptr, PPF_None, /*ExportRootScope=*/ nullptr);
UE_LOG(LogGameplayMessageSubsystem, Log, TEXT("BroadcastMessage(%s, %s, %s)"), pContextString ? **pContextString : *GetPathNameSafe(this), *Channel.ToString(), *HumanReadableMessage);
}
// Broadcast the message
bool bOnInitialTag = true;
for (FGameplayTag Tag = Channel; Tag.IsValid(); Tag = Tag.RequestDirectParent())
{
if (const FChannelListenerList* pList = ListenerMap.Find(Tag))
{
// Copy in case there are removals while handling callbacks
TArray<FGameplayMessageListenerData> ListenerArray(pList->Listeners);
for (const FGameplayMessageListenerData& Listener : ListenerArray)
{
if (bOnInitialTag || (Listener.MatchType == EGameplayMessageMatch::PartialMatch))
{
if (Listener.bHadValidType && !Listener.ListenerStructType.IsValid())
{
UE_LOG(LogGameplayMessageSubsystem, Warning, TEXT("Listener struct type has gone invalid on Channel %s. Removing listener from list"), *Channel.ToString());
UnregisterListenerInternal(Channel, Listener.HandleID);
continue;
}
// The receiving type must be either a parent of the sending type or completely ambiguous (for internal use)
if (!Listener.bHadValidType || StructType->IsChildOf(Listener.ListenerStructType.Get()))
{
Listener.ReceivedCallback(Channel, StructType, MessageBytes);
}
else
{
UE_LOG(LogGameplayMessageSubsystem, Error, TEXT("Struct type mismatch on channel %s (broadcast type %s, listener at %s was expecting type %s)"),
*Channel.ToString(),
*StructType->GetPathName(),
*Tag.ToString(),
*Listener.ListenerStructType->GetPathName());
}
}
}
}
bOnInitialTag = false;
}
}
void UGameplayMessageSubsystem::K2_BroadcastMessage(FGameplayTag Channel, const int32& Message)
{
// This will never be called, the exec version below will be hit instead
checkNoEntry();
}
DEFINE_FUNCTION(UGameplayMessageSubsystem::execK2_BroadcastMessage)
{
P_GET_STRUCT(FGameplayTag, Channel);
Stack.MostRecentPropertyAddress = nullptr;
Stack.StepCompiledIn<FStructProperty>(nullptr);
void* MessagePtr = Stack.MostRecentPropertyAddress;
FStructProperty* StructProp = CastField<FStructProperty>(Stack.MostRecentProperty);
P_FINISH;
if (ensure((StructProp != nullptr) && (StructProp->Struct != nullptr) && (MessagePtr != nullptr)))
{
P_THIS->BroadcastMessageInternal(Channel, StructProp->Struct, MessagePtr);
}
}
FGameplayMessageListenerHandle UGameplayMessageSubsystem::RegisterListenerInternal(FGameplayTag Channel, TFunction<void(FGameplayTag, const UScriptStruct*, const void*)>&& Callback, const UScriptStruct* StructType, EGameplayMessageMatch MatchType)
{
FChannelListenerList& List = ListenerMap.FindOrAdd(Channel);
FGameplayMessageListenerData& Entry = List.Listeners.AddDefaulted_GetRef();
Entry.ReceivedCallback = MoveTemp(Callback);
Entry.ListenerStructType = StructType;
Entry.bHadValidType = StructType != nullptr;
Entry.HandleID = ++List.HandleID;
Entry.MatchType = MatchType;
return FGameplayMessageListenerHandle(this, Channel, Entry.HandleID);
}
void UGameplayMessageSubsystem::UnregisterListener(FGameplayMessageListenerHandle Handle)
{
if (Handle.IsValid())
{
check(Handle.Subsystem == this);
UnregisterListenerInternal(Handle.Channel, Handle.ID);
}
else
{
UE_LOG(LogGameplayMessageSubsystem, Warning, TEXT("Trying to unregister an invalid Handle."));
}
}
void UGameplayMessageSubsystem::UnregisterListenerInternal(FGameplayTag Channel, int32 HandleID)
{
if (FChannelListenerList* pList = ListenerMap.Find(Channel))
{
int32 MatchIndex = pList->Listeners.IndexOfByPredicate([ID = HandleID](const FGameplayMessageListenerData& Other) { return Other.HandleID == ID; });
if (MatchIndex != INDEX_NONE)
{
pList->Listeners.RemoveAtSwap(MatchIndex);
}
if (pList->Listeners.Num() == 0)
{
ListenerMap.Remove(Channel);
}
}
}
|