Navigation
API > API/Plugins > API/Plugins/SceneStateEvent
Holds and keeps track of Events added at Runtime
| Name | USceneStateEventStream |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/SceneState/Source/SceneStateEvent/Public/SceneStateEventStream.h |
| Include Path | #include "SceneStateEventStream.h" |
Syntax
UCLASS (MinimalAPI)
class USceneStateEventStream : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → USceneStateEventStream
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CapturedEvents | TMap< FGuid, FSharedStruct > | Map of the Handler Id to the Event it has captured | SceneStateEventStream.h |
|
| Events | TArray< FSharedStruct > | Active Events kept in push order | SceneStateEventStream.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void CaptureEvents
(
TConstArrayView< FSceneStateEventHandler > InEventHandlers |
Removes the Events (first/oldest) that match the given Event Handlers and moves them to the Captured Event map | SceneStateEventStream.h | |
bool ConsumeEventBySchema
(
const FSceneStateEventSchemaHandle& InEventSchemaHandle |
Consumes the first (oldest) Event that was pushed that matches the given Schema | SceneStateEventStream.h | |
FSceneStateEvent * FindCapturedEvent
(
const FGuid& InHandlerId |
Finds the event that is captured by the Handler with the given Id | SceneStateEventStream.h | |
const FSceneStateEvent * FindEventBySchema
(
const FSceneStateEventSchemaHandle& InEventSchemaHandle |
Finds the first (oldest) Event that was pushed that matches the given Schema | SceneStateEventStream.h | |
void PushEvent
(
FSharedStruct&& InEvent |
Pushes a new event into the stream | SceneStateEventStream.h | |
void PushEvent
(
const FSharedStruct& InEvent |
Pushes a new event into the stream | SceneStateEventStream.h | |
bool Register() |
Registers the Event Stream to the Event Subsystem to listen to Broadcast Events | SceneStateEventStream.h | |
void ResetCapturedEvents
(
TConstArrayView< FSceneStateEventHandler > InEventHandlers |
Cleanup the Captured Events that match the given Event Handlers | SceneStateEventStream.h | |
void Unregister() |
Registers the Event Stream from the Event Subsystem | SceneStateEventStream.h |