UInworldGraphRuntimeData_EventHistory | Inherits from: UInworldGraphRuntimeData
Runtime data class for managing event history in Inworld graphs. This class creates and manages an event history system that tracks various types of events (primarily speech events) during graph execution. It provides functionality for adding, retrieving, and formatting event history with configurable capacity and formatting options.
Methods
- AddGenericEvent
- AddSpeechEvent
- Clear
- DebugDumpEventHistory
- GetHistoryEventData
- GetHistoryString
- GetSpeechEvents
- Set
Reference
AddGenericEvent
Adds a generic event to the event history. This function stores the provided text event and appends it to the history. If the history reaches its capacity, the oldest event is removed.
Examples
Parameters
| Parameter | Type | Description |
|---|---|---|
| Event | const FString& | The text event to be added to the history. |
AddSpeechEvent
Adds a speech event to the event history. This function records a speech event, storing the agent’s name and utterance. The event is formatted based on the SpeechEventFormatter and appended to the history. If the history reaches its capacity, the oldest event is removed.
Examples
Parameters
| Parameter | Type | Description |
|---|---|---|
| Speech | const FInworldEventSpeech& | The speech event data containing the agent’s name and utterance. |
Clear
Clear the event history. This function removes all stored events and resets the history string.
Examples
DebugDumpEventHistory
Outputs debug information about the event history to the console. This function prints detailed information about the current event history state, including all stored events, for debugging and development purposes.
Examples
GetHistoryEventData
Retrieves the speech event history as structured data.
Examples
Returns
Type:FInworldHistoryEventData
Description: Structured event history data containing all speech events
GetHistoryString
Retrieves the full event history as a formatted string. This function returns a concatenated string representation of all stored events.
Examples
Returns
Type:const FString&
Description: A reference to the history string containing all recorded events.
GetSpeechEvents
Retrieves the speech event history. This function returns a representation of all stored speech events.
Examples
Returns
Type:const TArray<FInworldEventSpeech>&
Description: A reference to the history containing all recorded speech events.
Set
Sets the initial event history data table.
Examples
Parameters
| Parameter | Type | Description |
|---|---|---|
| InEventHistoryTable | UDataTable* | The data table containing initial event history entries |