Difference between revisions of "Osiris/API/DialogEnded"
From Divinity Engine Wiki
(Documented DialogEnded event) |
m (→Notes) |
||
| (5 intermediate revisions by 2 users not shown) | |||
| Line 2: | Line 2: | ||
* event '''DialogEnded'''(''(STRING)'''''_Dialog''', ''(INTEGER)'''''_InstanceID''') | * event '''DialogEnded'''(''(STRING)'''''_Dialog''', ''(INTEGER)'''''_InstanceID''') | ||
===== Description ===== | ===== Description ===== | ||
| − | Thrown once an interactive dialog has | + | Thrown once an interactive dialog has ended. |
===== Parameters ===== | ===== Parameters ===== | ||
* '''_Dialog''': The name of the dialog. | * '''_Dialog''': The name of the dialog. | ||
| − | * '''_InstanceID''': Unique identifier for this interactive dialog. | + | * '''_InstanceID''': Unique identifier for this interactive dialog instance. |
===== Notes ===== | ===== Notes ===== | ||
| − | * Automated dialogs | + | * Automated dialogs will throw an [[Osiris/API/AutomatedDialogEnded|AutomatedDialogEnded]] event instead. |
| − | * Even if the attempt to start an interactive dialog failed and a [[Osiris/API/DialogRequestFailed|DialogRequestFailed]] event was thrown, you will still | + | * Even if the attempt to start an interactive dialog failed and a [[Osiris/API/DialogRequestFailed|DialogRequestFailed]] event was thrown, you will still get a '''DialogEnded''' event as well. |
| + | * This event is not thrown if [[Osiris/API/StartDialog_Internal|StartDialog_Internal]] returned that it failed to start the dialog. Conversely, if that routine returned success, this event will always be thrown regardless of any subsequent errors. | ||
| + | |||
===== See Also ===== | ===== See Also ===== | ||
* [[Osiris/API/AutomatedDialogEnded|AutomatedDialogEnded]] | * [[Osiris/API/AutomatedDialogEnded|AutomatedDialogEnded]] | ||
| Line 17: | Line 19: | ||
* Helper [[Osiris/Shared/Proc_StartDialog|Proc_StartDialog]] | * Helper [[Osiris/Shared/Proc_StartDialog|Proc_StartDialog]] | ||
| − | [[Category:Osiris Events| | + | [[Category:Osiris Events|DialogEnded]] |
Latest revision as of 10:06, 6 October 2019
Full Definition(s)
- event DialogEnded((STRING)_Dialog, (INTEGER)_InstanceID)
Description
Thrown once an interactive dialog has ended.
Parameters
- _Dialog: The name of the dialog.
- _InstanceID: Unique identifier for this interactive dialog instance.
Notes
- Automated dialogs will throw an AutomatedDialogEnded event instead.
- Even if the attempt to start an interactive dialog failed and a DialogRequestFailed event was thrown, you will still get a DialogEnded event as well.
- This event is not thrown if StartDialog_Internal returned that it failed to start the dialog. Conversely, if that routine returned success, this event will always be thrown regardless of any subsequent errors.
See Also
- AutomatedDialogEnded
- DialogRequestFailed
- DialogStarted
- Helper DB_DialogNPCs
- Helper DB_DialogPlayers
- Helper Proc_StartDialog
