Difference between revisions of "Osiris/API/StartDefaultDialog"

From Divinity Engine Wiki
Jump to: navigation, search
(Documented StartDefaultDialog)
 
m
 
Line 2: Line 2:
 
* query '''StartDefaultDialog'''('''''[in]'''(CHARACTERGUID)'''''_Character''', '''''[in]'''(CHARACTERGUID)'''''_Player''', '''''[out]'''(STRING)'''''_Dialog''', '''''[out]'''(INTEGER)'''''_Automated''')
 
* query '''StartDefaultDialog'''('''''[in]'''(CHARACTERGUID)'''''_Character''', '''''[in]'''(CHARACTERGUID)'''''_Player''', '''''[out]'''(STRING)'''''_Dialog''', '''''[out]'''(INTEGER)'''''_Automated''')
 
===== Description =====
 
===== Description =====
Tries to start the [https://youtu.be/XME89rtXzKQ?t=318|default dialog] assigned to '''_Character''' with '''_Character''' as first speaker and '''_Player''' as second speaker.
+
Tries to start the [https://youtu.be/XME89rtXzKQ?t=318 default dialog] assigned to '''_Character''' with '''_Character''' as first speaker and '''_Player''' as second speaker.
 
===== Return Values =====
 
===== Return Values =====
 
* '''Success/Failure''': Fails if '''_Character''' or '''_Player''' are invalid, if no default dialog has been assigned to '''Character''' or it does not exist, or for any of the reasons that [[Osiris/API/StartDialog_Internal|StartDialog_Internal]] may fail.
 
* '''Success/Failure''': Fails if '''_Character''' or '''_Player''' are invalid, if no default dialog has been assigned to '''Character''' or it does not exist, or for any of the reasons that [[Osiris/API/StartDialog_Internal|StartDialog_Internal]] may fail.

Latest revision as of 13:59, 1 November 2018

Full Definition(s)
  • query StartDefaultDialog([in](CHARACTERGUID)_Character, [in](CHARACTERGUID)_Player, [out](STRING)_Dialog, [out](INTEGER)_Automated)
Description

Tries to start the default dialog assigned to _Character with _Character as first speaker and _Player as second speaker.

Return Values
  • Success/Failure: Fails if _Character or _Player are invalid, if no default dialog has been assigned to Character or it does not exist, or for any of the reasons that StartDialog_Internal may fail.
  • _Dialog: The name of the default dialog assigned to _Character.
  • _Automated: 1 if the returned dialog is an automated dialog, 0 if it is an interactive one.
Notes
  • The Shared mod automatically tries to start a character's default dialog if you click on them and no DB_Dialogs was defined for them and no other dialog was started for them in any other way.
  • _Player can also be another NPC if the dialog is automated.
See Also