UFtsTriggerListenerComponent Class Reference

Listener component that can bind to any number of signal components. More...

#include <FtsTriggerListenerComponent.h>

Inheritance diagram for UFtsTriggerListenerComponent:

Public Member Functions
	UFtsTriggerListenerComponent ()
FFtsTriggerListenerDelegate &	GetTriggerSignalReceivedDelegate ()
	Get the received signal delegate.
void	StartListeningToTrigger (UFtsTriggerSignalComponent *Trigger)
	Registers a trigger with the listener.
void	StopListeningToTrigger (UFtsTriggerSignalComponent *Trigger)
	Unregisters a trigger from the listener.
void	StartListeningToOwnedTrigger (AActor *InTriggerOwner, FName InTriggerId)
	Searches for a specified trigger from the owner and starts listening to it.
void	StartListeningToAllOwnedTriggers (AActor *InTriggerOwner)
	Queries all triggers of an owner and listens to all.
void	StopListeningToOwnedTrigger (AActor *InTriggerOwner, FName InTriggerId)
	Searches for a specified trigger from the owner and stops listening to it.
void	StopListeningToAllOwnedTriggers (AActor *InTriggerOwner)
	Queries all triggers of an owner and stops listening to all.
bool	IsListeningToTrigger (UFtsTriggerSignalComponent *InTrigger)
	Check if this listener is currently bound to a specified trigger.
void	GetObservedTriggers (TArray< UFtsTriggerSignalComponent * > &OutTriggers)
	Get all triggers this listener listens to.
virtual void	BeginPlay () override
void	CreateListenerConnections ()

Protected Member Functions
void	TriggerSignalReceived (const FInstancedStruct &Signal)
	Callback method for trigger delegate.

Protected Attributes
TArray< FFtsTriggerObservationConfig >	TriggersToObserve
FFtsTriggerSignalEmittedDelegate	SignalDelegate
TArray< UFtsTriggerSignalComponent * >	ObservedTriggers
	Triggers currently being listened to.
FFtsTriggerListenerDelegate	OnTriggerSignalReceived
	Delegate that broadcasts when a listened to trigger send a signal.

Detailed Description

Listener component that can bind to any number of signal components.

Constructor & Destructor Documentation

UFtsTriggerListenerComponent()

UFtsTriggerListenerComponent::UFtsTriggerListenerComponent

(

)

Member Function Documentation

BeginPlay()

void UFtsTriggerListenerComponent::BeginPlay ( )

overridevirtual

CreateListenerConnections()

void UFtsTriggerListenerComponent::CreateListenerConnections

(

)

GetObservedTriggers()

void UFtsTriggerListenerComponent::GetObservedTriggers

(

TArray< UFtsTriggerSignalComponent * > &

OutTriggers

)

Get all triggers this listener listens to.

Parameters

OutTriggers

All triggers this component currently listens to

GetTriggerSignalReceivedDelegate()

FFtsTriggerListenerDelegate & UFtsTriggerListenerComponent::GetTriggerSignalReceivedDelegate

(

)

Get the received signal delegate.

Returns

The received signal delegate

IsListeningToTrigger()

bool UFtsTriggerListenerComponent::IsListeningToTrigger

(

UFtsTriggerSignalComponent *

InTrigger

)

Check if this listener is currently bound to a specified trigger.

Parameters

InTrigger

Trigger to query

Returns

true if currently listening to it

StartListeningToAllOwnedTriggers()

void UFtsTriggerListenerComponent::StartListeningToAllOwnedTriggers

(

AActor *

InTriggerOwner

)

Queries all triggers of an owner and listens to all.

Parameters

InTriggerOwner

Actor holding the trigger components

StartListeningToOwnedTrigger()

void UFtsTriggerListenerComponent::StartListeningToOwnedTrigger	(	AActor *	InTriggerOwner,
		FName	InTriggerId )

Searches for a specified trigger from the owner and starts listening to it.

Parameters

InTriggerOwner	Actor holding the trigger component
InTriggerId	Specific trigger id

StartListeningToTrigger()

void UFtsTriggerListenerComponent::StartListeningToTrigger

(

UFtsTriggerSignalComponent *

Trigger

)

Registers a trigger with the listener.

Parameters

Trigger

Trigger to listen to

StopListeningToAllOwnedTriggers()

void UFtsTriggerListenerComponent::StopListeningToAllOwnedTriggers

(

AActor *

InTriggerOwner

)

Queries all triggers of an owner and stops listening to all.

Parameters

InTriggerOwner

Actor holding the trigger components

StopListeningToOwnedTrigger()

void UFtsTriggerListenerComponent::StopListeningToOwnedTrigger	(	AActor *	InTriggerOwner,
		FName	InTriggerId )

Searches for a specified trigger from the owner and stops listening to it.

Parameters

InTriggerOwner	Actor holding the trigger component
InTriggerId	Specific trigger id

StopListeningToTrigger()

void UFtsTriggerListenerComponent::StopListeningToTrigger

(

UFtsTriggerSignalComponent *

Trigger

)

Unregisters a trigger from the listener.

Parameters

Trigger

Trigger to stop listening to

TriggerSignalReceived()

void UFtsTriggerListenerComponent::TriggerSignalReceived ( const FInstancedStruct & Signal )

protected

Callback method for trigger delegate.

Parameters

Signal

Received signal

Member Data Documentation

ObservedTriggers

TArray<UFtsTriggerSignalComponent*> UFtsTriggerListenerComponent::ObservedTriggers

protected

Triggers currently being listened to.

OnTriggerSignalReceived

FFtsTriggerListenerDelegate UFtsTriggerListenerComponent::OnTriggerSignalReceived

protected

Delegate that broadcasts when a listened to trigger send a signal.

SignalDelegate

FFtsTriggerSignalEmittedDelegate UFtsTriggerListenerComponent::SignalDelegate

protected

TriggersToObserve

TArray<FFtsTriggerObservationConfig> UFtsTriggerListenerComponent::TriggersToObserve

protected

List of triggers this listener will register to.

---

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

• Plugins/FtsTriggers/Source/FtsTriggers/Public/FtsTriggerListenerComponent.h
• Plugins/FtsTriggers/Source/FtsTriggers/Private/FtsTriggerListenerComponent.cpp