Useful Events and Delegates
Our plugin has various events and delegates that will be triggered on certain situations. In this document, We provide a list for them!
tip
You can easily find the real usages of each events and delegates in the official plugin assets. Take a look into them if you need any references.
Dialogue Widget Base
Delegates
Widget Construction / Destruction Related
| Native Name | Display Name | Description |
|---|---|---|
| Dele_OnDialogueWidgetBegin | OnDialogueWidgetBegin | Triggered when the dialogue widget is constructed. Triggered earlier than ManagerFragmentBeginPlay. |
| Dele_OnDialogueWidgetEnd | OnDialogueWidgetEnd | Triggered when the dialogue widget is destructed. Triggered earlier than ManagerFragmentEndPlay. |
Widget Update Related
| Native Name | Display Name | Description |
|---|---|---|
| Dele_OnDialogueWidgetPopulated | OnDialogueWidgetPopulated | Triggered whenever the dialogue widget flushed and reconstructed its component layout. It will be usaully triggered when the widget moves to the next node or the function UpdateWidgetFromCurrentNode() is manually called. |
Node Playback Related
| Native Name | Display Name | Description |
|---|---|---|
| Dele_OnNextNodePlayed | OnNextNodePlayed | Triggered whenever the widget moved to the next node. It will not be triggered when the first node get played. |
| Dele_OnNodePlayed | OnNodePlayed | Triggered whenever a node has been set as the node the widget is currently playing. Triggered after the fragment's BeginPlay event. |
| Dele_OnNodeEnded | OnNodeEnded | Triggered before the widget moves to the next node. Triggered after the fragment's BeginPlay event. |
Text Update Related
| Native Name | Display Name | Description |
|---|---|---|
| Dele_OnTextUpdateStarted | OnTextUpdateStarted | Triggered when the dialgoue widget's text update has been started. |
| Dele_OnTextUpdateFinished | OnTextUpdateFinished | Triggered when the dialgoue widget's text update has been finished. It will be triggered only when the update is fully finished and succeeded to display the whole text without interruption. |
| Dele_OnTextUpdated | OnTextUpdated | Triggered whenever a new character shows up by the text update of the widget. |
| Dele_OnTextSkipped | OnTextSkipped | Triggered whenever widget performed context skip. (Displaying a bunch of text left to display at once.) |
Inline Command Related
| Native Name | Display Name | Description |
|---|---|---|
| Dele_OnInlineCommandTriggered | OnInlineCommandTriggered | Triggered whenever an inline command has been triggered. |
| Native Name | Display Name | Description |
|---|---|---|
| Dele_OnDialogueWidgetBegin | OnDialogueWidgetBegin | Triggered when the dialogue widget is constructed. Triggered earlier than ManagerFragmentBeginPlay. |
| Dele_OnDialogueWidgetEnd | OnDialogueWidgetEnd | Triggered when the dialogue widget is destructed. Triggered earlier than ManagerFragmentEndPlay. |
Events
tip
Those will be triggered right after the delegate that shares same Display Name be triggered.
Those exists for the blueprint extensibility, and should not be triggered manually in the other external resources.
Widget Construction / Destruction Related
| Native Name | Display Name | Description |
|---|---|---|
| K2_OnDialogueWidgetBegin | OnDialogueWidgetBegin | Triggered when the dialogue widget is constructed. Triggered earlier than ManagerFragmentBeginPlay. |
| K2_OnDialogueWidgetEnd | OnDialogueWidgetEnd | Triggered when the dialogue widget is destructed. Triggered earlier than ManagerFragmentEndPlay. |
Widget Update Related
| Native Name | Display Name | Description |
|---|---|---|
| K2_OnDialogueWidgetPopulated | OnDialogueWidgetPopulated | Triggered whenever the dialogue widget flushed and reconstructed its component layout. It will be usaully triggered when the widget moves to the next node or the function UpdateWidgetFromCurrentNode() is manually called. |
Node Playback Related
| Native Name | Display Name | Description |
|---|---|---|
| K2_OnNextNodePlayed | OnNextNodePlayed | Triggered whenever the widget moved to the next node. It will not be triggered when the first node get played. |
| K2_OnNodePlayed | OnNodePlayed | Triggered whenever a node has been set as the node the widget is currently playing. Triggered after the fragment's BeginPlay event. |
| K2_OnNodeEnded | OnNodeEnded | Triggered before the widget moves to the next node. Triggered after the fragment's BeginPlay event. |
Text Update Related
| Native Name | Display Name | Description |
|---|---|---|
| K2_OnTextUpdateStarted | OnTextUpdateStarted | Triggered when the dialgoue widget's text update has been started. |
| K2_OnTextUpdateFinished | OnTextUpdateFinished | Triggered when the dialgoue widget's text update has been finished. It will be triggered only when the update is fully finished and succeeded to display the whole text without interruption. |
| K2_OnTextUpdated | OnTextUpdated | Triggered whenever a new character shows up by the text update of the widget. |
| K2_OnTextSkipped | OnTextSkipped | Triggered whenever widget performed context skip. (Displaying a bunch of text left to display at once.) |
Inline Command Related
| Native Name | Display Name | Description |
|---|---|---|
| K2_OnInlineCommandTriggered | OnInlineCommandTriggered | Triggered whenever an inline command has been triggered. |
Speech Bubble Widget Handled
Events
RenderType (Mode) Related
| Native Name | Display Name | Description |
|---|---|---|
| K2_OnDialogueWidgetModeChanged | On Dialogue Widget Mode Changed | Triggered whenever the mode of the speech bubble widget rendering has been changed. |
Dialogue Node Base
Events
Begin / End Play Related
| Native Name | Description |
|---|---|
| OnNodeBeginPlay | Triggered whenever this node has been set as the node the widget is currently playing. Triggered after the fragment's BeginPlay event. |
| OnNodeEndPlay | Triggered before the widget moves to the next node. Triggered after the fragment's BeginPlay event. |
Select Node
Delegates
Answer Button Related
| Native Name | Display Name | Description |
|---|---|---|
| Dele_OnAnswerButtonsPopulated | OnAnswerButtonsPopulated | Triggered when the answer button has been populated. |
Fragment
Events
Begin / End Play Related
| Native Name | Description |
|---|---|
| OnFragmentBeginPlay | Triggered whenever this fragment's parent object has been Begin-played. Visit Trying Out Dialogue Fragments for the detailed explanation |
| OnFragmentEndPlay | Triggered whenever this fragment's parent object has been End-Played. Visit Trying Out Dialogue Fragments for the detailed explanation |
Simple Dialogue Subsystem
Delegates
Begin / End Play Related
| Native Name | Description |
|---|---|
| OnDialogueBegin | Triggered whenever a new dialogue played. This delegate will not be triggered at the beginning of the world. |
| OnDialogueEnd | Triggered whenever a dialogue ended. This delegate will not be triggered at the beginning of the world. |