UFtsTriggersFunctionLibrary Class Reference

Utilities for accessing triggers and handling signals. More...

#include <FtsTriggersFunctionLibrary.h>

Inheritance diagram for UFtsTriggersFunctionLibrary:

Static Public Member Functions
static UFtsTriggerSignalComponent *	GetTriggerFromOwner (AActor *Owner, FName Id=NAME_None)
	Helper method to resolve / find a trigger component.
static UFtsTriggerSignalComponent *	GetSourceFromSignal (const FInstancedStruct &Signal)
static UObject *	GetInstigatorFromSignal (const FInstancedStruct &Signal)
static AActor *	GetSignalOwner (const FInstancedStruct &Signal)
static EFtsSignalAccessResult	GetBoolSignalValue (const FInstancedStruct &Signal, bool &bOutValue)
static EFtsSignalAccessResult	GetIntegerSignalValue (const FInstancedStruct &Signal, int64 &OutValue)
static FInstancedStruct	CreateTriggerSignal (UFtsTriggerSignalComponent *Trigger, UObject *Instigator)
static FInstancedStruct	CreateBooleanTriggerSignal (UFtsTriggerSignalComponent *Trigger, bool bValue, UObject *Instigator)
static FInstancedStruct	CreateIntegerTriggerSignal (UFtsTriggerSignalComponent *Trigger, int64 Value, UObject *Instigator)

Detailed Description

Utilities for accessing triggers and handling signals.

Member Function Documentation

CreateBooleanTriggerSignal()

FInstancedStruct UFtsTriggersFunctionLibrary::CreateBooleanTriggerSignal ( UFtsTriggerSignalComponent * Trigger, bool bValue, UObject * Instigator )

static

Ease of use wrapper to create an instanced struct trigger signal with a boolean payload

Parameters

Trigger	Trigger sending the signal
bValue	Value payload for signal
Instigator	Instigator responsible for triggering the signal

Returns

Instanced signal struct

CreateIntegerTriggerSignal()

FInstancedStruct UFtsTriggersFunctionLibrary::CreateIntegerTriggerSignal ( UFtsTriggerSignalComponent * Trigger, int64 Value, UObject * Instigator )

static

Ease of use wrapper to create an instanced struct trigger signal with an integer payload

Parameters

Trigger	Trigger sending the signal
Value	Value payload for signal
Instigator	Instigator responsible for triggering the signal

Returns

Instanced signal struct

CreateTriggerSignal()

FInstancedStruct UFtsTriggersFunctionLibrary::CreateTriggerSignal ( UFtsTriggerSignalComponent * Trigger, UObject * Instigator )

static

Ease of use wrapper to create an instanced struct trigger signal

Parameters

Trigger	Trigger sending the signal
Instigator	Instigator responsible for triggering the signal

Returns

Instanced signal struct

GetBoolSignalValue()

EFtsSignalAccessResult UFtsTriggersFunctionLibrary::GetBoolSignalValue ( const FInstancedStruct & Signal, bool & bOutValue )

static

Attempts to get the boolean value payload from a given signal

Parameters

Signal	Signal to get value from
bOutValue	Value in signal, if found

Returns

Whether the signal contained a value

GetInstigatorFromSignal()

UObject * UFtsTriggersFunctionLibrary::GetInstigatorFromSignal ( const FInstancedStruct & Signal )

static

Checks the signal if it contains an instigator property and returns its value if found.

Parameters

Signal

Signal to get instigator from

Returns

Instigator, if found

GetIntegerSignalValue()

EFtsSignalAccessResult UFtsTriggersFunctionLibrary::GetIntegerSignalValue ( const FInstancedStruct & Signal, int64 & OutValue )

static

Attempts to get the integer value payload from a given signal

Parameters

Signal	Signal to get value from
OutValue	Value in signal, if found

Returns

Whether the signal contained a value

GetSignalOwner()

AActor * UFtsTriggersFunctionLibrary::GetSignalOwner ( const FInstancedStruct & Signal )

static

Checks the signal if it contains a source property and returns its owner if found.

Parameters

Signal

Signal to get owner from

Returns

Owner, if found

GetSourceFromSignal()

UFtsTriggerSignalComponent * UFtsTriggersFunctionLibrary::GetSourceFromSignal ( const FInstancedStruct & Signal )

static

Checks the signal if it contains a source property and returns its value if found.

Parameters

Signal

Signal to get source from

Returns

Source, if found

GetTriggerFromOwner()

UFtsTriggerSignalComponent * UFtsTriggersFunctionLibrary::GetTriggerFromOwner ( AActor * Owner, FName Id = NAME_None )

static

Helper method to resolve / find a trigger component.

Parameters

Owner	Owner of the trigger component
Id	Id of trigger to find

Returns

Trigger component if found

---

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

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