Osiris/API/DialogStarted: Difference between revisions
Jump to navigation
Jump to search
(Document DialogStarted) |
m (→Notes) |
||
| (6 intermediate revisions by the same user not shown) | |||
| Line 5: | Line 5: | ||
===== 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/AutomatedDialogStarted|AutomatedDialogStarted]] event instead. | ||
* If the attempt to start an interactive dialog fails, a [[Osiris/API/ | * If the attempt to start an interactive dialog fails, a [[Osiris/API/DialogRequestFailed|DialogRequestFailed]] event will be thrown instead (see that page for details). | ||
===== See Also ===== | ===== See Also ===== | ||
* [[Osiris/API/AutomatedDialogStarted|AutomatedDialogStarted]] | * [[Osiris/API/AutomatedDialogStarted|AutomatedDialogStarted]] | ||
* [[Osiris/API/DialogEnded|DialogEnded]] | * [[Osiris/API/DialogEnded|DialogEnded]] | ||
* [[Osiris/API/DialogRequestFailed|DialogRequestFailed]] | |||
* Helper [[Osiris/Shared/DB_DialogNPCs|DB_DialogNPCs]] | * Helper [[Osiris/Shared/DB_DialogNPCs|DB_DialogNPCs]] | ||
* Helper [[Osiris/Shared/DB_DialogPlayers|DB_DialogPlayers]] | * Helper [[Osiris/Shared/DB_DialogPlayers|DB_DialogPlayers]] | ||
* Helper [[Osiris/Shared/Proc_StartDialog|Proc_StartDialog]] | |||
[[Category:Osiris Events]] | |||
[[Category:Osiris Events|DialogStarted]] | |||
Latest revision as of 09:06, 6 October 2019
Full Definition(s)
- event DialogStarted((STRING)_Dialog, (INTEGER)_InstanceID)
Description
Thrown once an interactive dialog has started.
Parameters
- _Dialog: The name of the dialog.
- _InstanceID: Unique identifier for this interactive dialog instance.
Notes
- Automated dialogs will throw an AutomatedDialogStarted event instead.
- If the attempt to start an interactive dialog fails, a DialogRequestFailed event will be thrown instead (see that page for details).
See Also
- AutomatedDialogStarted
- DialogEnded
- DialogRequestFailed
- Helper DB_DialogNPCs
- Helper DB_DialogPlayers
- Helper Proc_StartDialog