Payback 0.0.1
CK Graduation Project
로딩중...
검색중...
일치하는것 없음
FStageEventSubscription 클래스 참조

Represents a subscription to stage events in a system. 더 자세히 ...

#include <StageEventSubscription.h>

FStageEventSubscription에 대한 협력 다이어그램:
Collaboration graph

Public 멤버 함수

 FStageEventSubscription ()=default
 
 FStageEventSubscription (UObject *InListener, const TArray< FName > &InListeningEventIDs, const FGameplayTagContainer &InListeningTags=FGameplayTagContainer::EmptyContainer, int8 InPriority=0, const FInstancedStruct &InListenerContext=FInstancedStruct())
 
FORCEINLINE const FGuid & GetHandle () const
 
FORCEINLINE UObject * GetListener () const
 
FORCEINLINE int8 GetPriority () const
 
FORCEINLINE const FInstancedStruct & GetListenerContext () const
 
FORCEINLINE bool Matches (const FName EventID, const FGameplayTagContainer &EventTags) const
 

Private 속성

FGuid Handle = FGuid::NewGuid()
 
TWeakObjectPtr< UObject > Listener
 
TArray< FName > ListeningEventIDs
 
FGameplayTagContainer ListeningTags
 
int8 Priority = 0
 
FInstancedStruct ListenerContext
 

상세한 설명

Represents a subscription to stage events in a system.

The FStageEventSubscription class is used to manage and handle subscriptions for stage-related events. Subscriptions track events of interest and allow for appropriate event handling or notifications to be triggered when those events occur.

This class encapsulates functionality for subscribing to and managing stage events, ensuring that only relevant events are tracked and delivered to the appropriate listeners or handlers.

Key responsibilities of this class include:

  • Storing and managing details about the subscribed events.
  • Providing a mechanism to enable or disable event subscriptions.
  • Facilitating the interaction between event producers and consumers.

This class is essential in event-driven architectures where different components need to subscribe to and respond to stage-specific events.

생성자 & 소멸자 문서화

◆ FStageEventSubscription() [1/2]

FStageEventSubscription::FStageEventSubscription ( )
default

◆ FStageEventSubscription() [2/2]

FStageEventSubscription::FStageEventSubscription ( UObject *  InListener,
const TArray< FName > &  InListeningEventIDs,
const FGameplayTagContainer &  InListeningTags = FGameplayTagContainer::EmptyContainer,
int8  InPriority = 0,
const FInstancedStruct &  InListenerContext = FInstancedStruct() 
)
inline
44 :
45 Listener(InListener),
46 ListeningEventIDs(InListeningEventIDs),
47 ListeningTags(InListeningTags),
48 Priority(InPriority),
49 ListenerContext(InListenerContext) { }
TArray< FName > ListeningEventIDs
Definition StageEventSubscription.h:87
int8 Priority
Definition StageEventSubscription.h:93
FGameplayTagContainer ListeningTags
Definition StageEventSubscription.h:90
TWeakObjectPtr< UObject > Listener
Definition StageEventSubscription.h:84
FInstancedStruct ListenerContext
Definition StageEventSubscription.h:96

멤버 함수 문서화

◆ GetHandle()

FORCEINLINE const FGuid & FStageEventSubscription::GetHandle ( ) const
inline
53 {
54 return Handle;
55 }
FGuid Handle
Definition StageEventSubscription.h:81

다음에 의해서 참조됨 : UStageSubsystem::NotifyStageEventListeners(), UStageSubsystem::RegisterListener(), UStageSubsystem::UnregisterListener().

이 함수를 호출하는 함수들에 대한 그래프입니다.:

◆ GetListener()

FORCEINLINE UObject * FStageEventSubscription::GetListener ( ) const
inline
58 {
59 return Listener.Get();
60 }

다음에 의해서 참조됨 : UStageSubsystem::GatherListeners(), UStageSubsystem::RegisterListener(), UStageSubsystem::UnregisterListener(), UStageSubsystem::UnregisterListeners().

이 함수를 호출하는 함수들에 대한 그래프입니다.:

◆ GetListenerContext()

FORCEINLINE const FInstancedStruct & FStageEventSubscription::GetListenerContext ( ) const
inline
68 {
69 return ListenerContext;
70 }

◆ GetPriority()

FORCEINLINE int8 FStageEventSubscription::GetPriority ( ) const
inline
63 {
64 return Priority;
65 }

◆ Matches()

FORCEINLINE bool FStageEventSubscription::Matches ( const FName  EventID,
const FGameplayTagContainer &  EventTags 
) const
inline
73 {
74 return ListeningEventIDs.Contains(TEXT("All"))
75 ? ListeningTags.IsEmpty() || EventTags.HasAny(ListeningTags)
76 : EventID.IsNone() == false && ListeningEventIDs.Contains(EventID);
77 }

다음에 의해서 참조됨 : UStageSubsystem::GatherListeners().

이 함수를 호출하는 함수들에 대한 그래프입니다.:

멤버 데이터 문서화

◆ Handle

FGuid FStageEventSubscription::Handle = FGuid::NewGuid()
private

◆ Listener

TWeakObjectPtr<UObject> FStageEventSubscription::Listener
private

◆ ListenerContext

FInstancedStruct FStageEventSubscription::ListenerContext
private

◆ ListeningEventIDs

TArray<FName> FStageEventSubscription::ListeningEventIDs
private

◆ ListeningTags

FGameplayTagContainer FStageEventSubscription::ListeningTags
private

◆ Priority

int8 FStageEventSubscription::Priority = 0
private

이 클래스에 대한 문서화 페이지는 다음의 파일로부터 생성되었습니다.: