1. Epic GamesDeveloper
  3. USceneStateEventLibrary

USceneStateEventLibrary

API > API/Plugins > API/Plugins/SceneStateEvent

   
Name USceneStateEventLibrary
Type class
Header File /Engine/Plugins/Experimental/SceneState/Source/SceneStateEvent/Public/SceneStateEventLibrary.h
Include Path #include "SceneStateEventLibrary.h"

Syntax

UCLASS (MinimalAPI)  
class USceneStateEventLibrary : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Functions

Static

Name Remarks Include Path Unreal Specifiers

static bool BroadcastEvent ( UObject* WorldContextObject,
FSceneStateEventSchemaHandle InEventSchemaHandle,
FInstancedStruct InEventData
)

 Broadcasts an event to the every registered event stream within a world. SceneStateEventLibrary.h
  • BlueprintCallable
  • Category="Scene State|Event"
  • Meta=(BlueprintInternalUseOnly="true", WorldContext="WorldContextObject")

static bool EventDataToStruct ( const FInstancedStruct& InEventData,
int32& OutStructValue
)

 Converts the given event data instanced struct to the wild card if it matches struct types SceneStateEventLibrary.h
  • BlueprintPure
  • CustomThunk
  • Category="Scene State|Event"
  • Meta=(CustomStructureParam="OutStructValue", BlueprintInternalUseOnly="true")

static bool FindEvent ( UObject* InContextObject,
USceneStateEventStream* InEventStream,
FSceneStateEventSchemaHandle InEventSchemaHandle,
const FString& InEventHandlerId,
bool bInCapturedEventsOnly,
FInstancedStruct& OutEventData
)

 Finds a captured event within an Event Stream with option to look into any pushed event in that stream (not only captured) SceneStateEventLibrary.h
  • BlueprintPure
  • Category="Scene State|Event"
  • Meta=(BlueprintInternalUseOnly="true")

static bool HasEvent ( UObject* InContextObject,
USceneStateEventStream* InEventStream,
FSceneStateEventSchemaHandle InEventSchemaHandle,
const FString& InEventHandlerId,
bool bInCapturedEventsOnly
)

 Returns whether an event is present as a captured event (or optionally just pushed) within an Event Stream SceneStateEventLibrary.h
  • BlueprintPure
  • Category="Scene State|Event"
  • Meta=(BlueprintInternalUseOnly="true")

static bool PushEvent ( USceneStateEventStream* InEventStream,
FSceneStateEventSchemaHandle InEventSchemaHandle,
FInstancedStruct InEventData
)

 Pushes an event to the given event stream SceneStateEventLibrary.h
  • BlueprintCallable
  • Category="Scene State|Event"
  • Meta=(BlueprintInternalUseOnly="true")

static bool TryGetEventHandlerId ( UObject* InContextObject,
const FSceneStateEventSchemaHandle& InEventSchemaHandle,
const FString& InEventHandlerId,
FGuid& OutEventHandlerId
)

   SceneStateEventLibrary.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page