UFtsToggleTriggerComponent Class Reference

Variant of the trigger component that holds a persistent state and emits signals on state change. More...

#include <FtsToggleTriggerComponent.h>

Inheritance diagram for UFtsToggleTriggerComponent:

Public Member Functions
void	SetState (bool bNewState, UObject *Instigator=nullptr, bool bAlwaysBroadcast=false)
bool	GetState () const
virtual void	BindOnTriggerSignalEmitted (const FFtsTriggerSignalEmittedDelegate &OnSignalEmittedEvent) override
virtual FLinearColor	GetCurrentColor () const override
Public Member Functions inherited from UFtsTriggerSignalComponent
	UFtsTriggerSignalComponent ()
FFtsTriggerSignalEmitted &	GetTriggerSignalDelegate ()
	Get the signal delegate.
virtual void	UnbindOnTriggerSignalEmitted (const FFtsTriggerSignalEmittedDelegate &OnSignalEmittedEvent)
void	BroadcastTriggerSignal (FInstancedStruct Signal)
	Sends a trigger signal to bound listeners.
FName	GetTriggerId () const
virtual FLinearColor	GetActiveColor () const
virtual FLinearColor	GetInactiveColor () const

Protected Attributes
bool	bTriggerState = false

Detailed Description

Variant of the trigger component that holds a persistent state and emits signals on state change.

Member Function Documentation

BindOnTriggerSignalEmitted()

void UFtsToggleTriggerComponent::BindOnTriggerSignalEmitted ( const FFtsTriggerSignalEmittedDelegate & OnSignalEmittedEvent )

overridevirtual

Reimplemented from UFtsTriggerSignalComponent.

GetCurrentColor()

FLinearColor UFtsToggleTriggerComponent::GetCurrentColor ( ) const

overridevirtual

Reimplemented from UFtsTriggerSignalComponent.

GetState()

bool UFtsToggleTriggerComponent::GetState

(

)

const

Get whether the trigger is currently toggled on

Returns

Current state of toggle

SetState()

void UFtsToggleTriggerComponent::SetState	(	bool	bNewState,
		UObject *	Instigator = nullptr,
		bool	bAlwaysBroadcast = false )

Sets the internal state of the trigger and emits a signal

Parameters

bNewState	The new state to set
Instigator	Optional object responsible for the change
bAlwaysBroadcast	True to always emit a signal, false to only emit if new state is different from current

Member Data Documentation

bTriggerState

bool UFtsToggleTriggerComponent::bTriggerState = false

protected

The internal state of the trigger

---

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

• Plugins/FtsTriggers/Source/FtsTriggers/Public/Triggers/FtsToggleTriggerComponent.h
• Plugins/FtsTriggers/Source/FtsTriggers/Private/Triggers/FtsToggleTriggerComponent.cpp