Trigger & Relay Plugin 1.0.0
Easy signal setups done right
Loading...
Searching...
No Matches
AFtsCounterRelay Class Reference

Relay that counts signals received from true triggers and emits a numbered signal itself. More...

#include <FtsCounterRelay.h>

Inheritance diagram for AFtsCounterRelay:
AFtsNumericRelay AFtsTriggerRelay IFtsTriggerOwnerInterface

Public Member Functions

 AFtsCounterRelay (const FObjectInitializer &ObjectInitializer)
void IncrementCounter ()
virtual void OnSignalReceived (UFtsTriggerListenerComponent *Listener, const FInstancedStruct &Signal) override
Public Member Functions inherited from AFtsNumericRelay
 AFtsNumericRelay (const FObjectInitializer &ObjectInitializer)
Public Member Functions inherited from AFtsTriggerRelay
 AFtsTriggerRelay (const FObjectInitializer &ObjectInitializer)
virtual void BeginPlay () override
virtual void EndPlay (const EEndPlayReason::Type EndPlayReason) override
virtual UFtsTriggerSignalComponentGetTriggerComponent_Implementation (FName Id) override
virtual void GetAllTriggerComponents_Implementation (TArray< UFtsTriggerSignalComponent * > &OutTriggers) override
virtual void OnConstruction (const FTransform &Transform) override
virtual void UpdateBillboardMaterial (bool bCalledDuringConstruction=false)
Public Member Functions inherited from IFtsTriggerOwnerInterface
UFtsTriggerSignalComponentGetTriggerComponent (FName Id=NAME_None)
 Get a specific trigger from the owner.
void GetAllTriggerComponents (TArray< UFtsTriggerSignalComponent * > &OutTriggers)
 Get all triggers of the owner.

Protected Attributes

EFtsCounterRelayBehavior Behavior = EFtsCounterRelayBehavior::Unbounded
int64 UpperBound = 0
Protected Attributes inherited from AFtsTriggerRelay
TObjectPtr< UFtsTriggerListenerComponentListenerComponent
TObjectPtr< UFtsTriggerSignalComponentTriggerComponent

Additional Inherited Members

Protected Member Functions inherited from AFtsNumericRelay
void SetRelayState (int64 NewState)
int64 GetRelayState () const

Detailed Description

Relay that counts signals received from true triggers and emits a numbered signal itself.

Constructor & Destructor Documentation

◆ AFtsCounterRelay()

AFtsCounterRelay::AFtsCounterRelay ( const FObjectInitializer & ObjectInitializer)

Member Function Documentation

◆ IncrementCounter()

void AFtsCounterRelay::IncrementCounter ( )

Increases the internal counter by one

◆ OnSignalReceived()

void AFtsCounterRelay::OnSignalReceived ( UFtsTriggerListenerComponent * Listener,
const FInstancedStruct & Signal )
overridevirtual

Internal callback that gets registered to the signal component to do recalculate relay state

Parameters
ListenerListener component that received the signal
SignalThe signal data

Reimplemented from AFtsTriggerRelay.

Member Data Documentation

◆ Behavior

EFtsCounterRelayBehavior AFtsCounterRelay::Behavior = EFtsCounterRelayBehavior::Unbounded
protected

What to do when the internal value becomes greater than the UpperBound value

◆ UpperBound

int64 AFtsCounterRelay::UpperBound = 0
protected

Optional value to bound the counter against


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