Difference between revisions of "Osiris/API/DialogRequestFailed"
From Divinity Engine Wiki
(Documented DialogRequestFailed) |
m |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
* event '''DialogRequestFailed'''(''(STRING)'''''_Dialog''', ''(INTEGER)'''''_InstanceID''') | * event '''DialogRequestFailed'''(''(STRING)'''''_Dialog''', ''(INTEGER)'''''_InstanceID''') | ||
===== Description ===== | ===== Description ===== | ||
| − | Thrown when an interactive dialog file was not found, or if an interactive dialog was [[Osiris/API/DialogRequestStop| | + | Thrown when an interactive dialog file was not found, or if an interactive dialog was [[Osiris/API/DialogRequestStop|stopped]] before the [[Osiris/API/DialogStarted|DialogStarted]] event was thrown. |
===== 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/AutomatedDialogRequestFailed|AutomatedDialogRequestFailed]] event instead. |
* This event is not thrown if [[Osiris/API/StartDialog_Internal|StartDialog_Internal]] returned that it failed to start the dialog. It's only thrown if that routine returned success, but then the dialog did not start after all because of one of the reasons mentioned in the description. | * This event is not thrown if [[Osiris/API/StartDialog_Internal|StartDialog_Internal]] returned that it failed to start the dialog. It's only thrown if that routine returned success, but then the dialog did not start after all because of one of the reasons mentioned in the description. | ||
* A [[Osiris/API/DialogEnded|DialogEnded]] event will always follow after a '''DialogRequestFailed''' event. | * A [[Osiris/API/DialogEnded|DialogEnded]] event will always follow after a '''DialogRequestFailed''' event. | ||
| + | |||
===== See Also ===== | ===== See Also ===== | ||
* [[Osiris/API/AutomatedDialogRequestFailed|AutomatedDialogRequestFailed]] | * [[Osiris/API/AutomatedDialogRequestFailed|AutomatedDialogRequestFailed]] | ||
Latest revision as of 22:58, 6 October 2019
Full Definition(s)
- event DialogRequestFailed((STRING)_Dialog, (INTEGER)_InstanceID)
Description
Thrown when an interactive dialog file was not found, or if an interactive dialog was stopped before the DialogStarted event was thrown.
Parameters
- _Dialog: The name of the dialog.
- _InstanceID: Unique identifier for this interactive dialog instance.
Notes
- Automated dialogs will throw an AutomatedDialogRequestFailed event instead.
- This event is not thrown if StartDialog_Internal returned that it failed to start the dialog. It's only thrown if that routine returned success, but then the dialog did not start after all because of one of the reasons mentioned in the description.
- A DialogEnded event will always follow after a DialogRequestFailed event.
See Also
- AutomatedDialogRequestFailed
- DialogEnded
- DialogStarted
- Helper DB_DialogNPCs
- Helper DB_DialogPlayers
- Helper Proc_StartDialog
