FSubsonicEventCollectionDefinition

API > API/Plugins > API/Plugins/SubsonicCore

   
Name FSubsonicEventCollectionDefinition
Type struct
Header File /Engine/Plugins/Experimental/Subsonic/Source/SubsonicCore/Public/SubsonicEventCollection.h
Include Path #include "SubsonicEventCollection.h"

Syntax

USTRUCT (MinimalAPI, BlueprintType )  
struct FSubsonicEventCollectionDefinition

Constructors

Name Remarks Include Path Unreal Specifiers
  SubsonicEventCollection.h  
  SubsonicEventCollection.h  
Generates empty, invalid event collection. SubsonicEventCollection.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FSubsonicEventCollectionDefinition()

   SubsonicEventCollection.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
CollectionId uint32 Unique Collection Id assigned post initialization of struct properties or via static initializer Independent from UObject identifier to allow for transient construction without having to utilize UObject wrapper. SubsonicEventCollection.h  
DeviceId Audio::FDeviceId Device associated with the given event collection. SubsonicEventCollection.h  
Events TMap< FGameplayTag, FSubsonicEvent >   SubsonicEventCollection.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Events"
  • Meta=(AllowPrivateAccess)
OnStaleBindingsDetected BindingUtils::FOnStaleBindingsDetected   SubsonicEventCollection.h  
Parameters FInstancedPropertyBag   SubsonicEventCollection.h
  • EditAnywhere
  • Category="Parameters"

Functions

Public

Name Remarks Include Path Unreal Specifiers

FSubsonicEventActionDefinition * AddAction ( const FEventHandle& InHandle,
int32 InsertIndex
)

 Adds action to event with handle if it exists. If insert index set to less than 0 (default), adds to end of collection array. SubsonicEventCollection.h  

FSubsonicEvent * AddEvent ( const FGameplayTag& InTag,
FSubsonicEvent NewEvent
)

 Adds event with given tag if does not yet exists. Returns pointer to new event if added, null if none added. SubsonicEventCollection.h  

void AssignId()

 Assigns a universal CollectionId to the given collection. SubsonicEventCollection.h  

void BindAllParameters()

 Binds all parameters across all events in the collection. SubsonicEventCollection.h  

bool ClearActions ( const FEventHandle& InHandle
)

 Clears all actions under the given event. SubsonicEventCollection.h  

void ClearEvents()

 Removes all events in the given collection. SubsonicEventCollection.h  

bool ContainsBinding ( FName EventName,
FName ParameterName
) const

 Returns true if binding exists with the given parameter name on either the collection or event with the given name, false if not. SubsonicEventCollection.h  

bool ContainsEvent ( const FEventHandle& InHandle
) const

   SubsonicEventCollection.h  

bool ContainsEvent ( const FGameplayTag& EventTag
) const

   SubsonicEventCollection.h  

bool ContainsEvent ( FName Name
) const

   SubsonicEventCollection.h  

const FSubsonicEventActionDefinition * FindAction ( const FActionHandle& InHandle
) const

 Returns pointer to action at handle if it exists. SubsonicEventCollection.h  

const FSubsonicEvent * FindEvent ( const FEventHandle& InHandle
) const

   SubsonicEventCollection.h  

const FSubsonicEvent * FindEvent ( const FGameplayTag& EventTag
) const

   SubsonicEventCollection.h  

const FSubsonicEvent * FindEvent ( FName Name
) const

 Returns event with the given name. SubsonicEventCollection.h  

FSubsonicEventActionDefinition * FindMutableAction ( const FActionHandle& InHandle
)

 Returns pointer to action at handle if it exists. SubsonicEventCollection.h  

FSubsonicEvent * FindMutableEvent ( const FEventHandle& InHandle
)

 Returns mutable pointer to event at handle if it exists. SubsonicEventCollection.h  

uint32 GetCollectionId()

   SubsonicEventCollection.h  

const TMap< FGameplayTag, FSubsonicEvent > & GetEvents()

   SubsonicEventCollection.h  

BindingUtils::FOnStaleBindingsDetected & GetOnStaleBindingsDetectedDelegate ()

 Fired when a structural parameter change creates stale editor bindings. SubsonicEventCollection.h  

const FInstancedPropertyBag & GetParameters()

   SubsonicEventCollection.h  

bool IsValid()

   SubsonicEventCollection.h  

void Register ( const Core::FCollectionHandle& InHandle,
Audio::FDeviceId InDeviceId
)

 Register's the given collection with the SubsonicEventRegistry. SubsonicEventCollection.h  

bool RemoveAction ( const FActionHandle& InHandle
)

 Removes action at given handle and returns if successful. SubsonicEventCollection.h  

bool RemoveEvent ( const FEventHandle& InHandle
)

 Removes event at given handle and returns if successful. SubsonicEventCollection.h  

bool RemoveStaleBindings ( const FCollectionHandle& ParentHandle,
bool bPromptRemoval
)

 Removes all stale property bindings. SubsonicEventCollection.h  

void Unregister()

 Unregisters collection, leaving it in clear, invalid state. SubsonicEventCollection.h  

Static

Name Remarks Include Path Unreal Specifiers

static FSubsonicEventCollectionDefinition Create ( FName Name,
TMap< FGameplayTag, FSubsonicEvent > InEvents,
Audio::FDeviceId DeviceId
)

 Create a collection definition with a valid transient Id for tracking within the Subsonic System. SubsonicEventCollection.h  

static FName GetEventsPropertyName()

   SubsonicEventCollection.h  

static uint32 GetInvalidId()

 Returns Id of invalid (default constructed or unregistered/reset collection). SubsonicEventCollection.h  

static FName GetParametersPropertyName()

   SubsonicEventCollection.h  

Operators

Name Remarks Include Path Unreal Specifiers
  SubsonicEventCollection.h  
  SubsonicEventCollection.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page