Difference between revisions of "Osiris/API/DialogAddActor"

From Divinity Engine Wiki
Jump to: navigation, search
(Created page with "===== Full Definition(s) ===== * call '''DialogAddActor'''(''''(INTEGER)'''''_InstanceID''''',''(CHARACTERGUID)'''''_Actor''') ===== Description ===== Adds character or item '...")
 
m
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
===== Full Definition(s) =====
 
===== Full Definition(s) =====
* call '''DialogAddActor'''(''''(INTEGER)'''''_InstanceID''''',''(CHARACTERGUID)'''''_Actor''')
+
* call '''DialogAddActor'''(''''(INTEGER)'''''_InstanceID''''',''(GUIDSTRING)'''''_Actor''')
 
===== Description =====
 
===== Description =====
Adds character or item '''_Actor''' as an '''''observer''''' to the ongoing dialog with ID '''_InstanceID'''. I.e., '''_Actor''' will follow the dialog along with its participants and will see/hear everything that gets said, but cannot make any choices in the dialog.
+
Adds character or item '''_Actor''' to the ongoing dialog with ID '''_InstanceID'''.
 +
 
 +
When starting a dialog, you can specify NULL as one or more speakers. These speakers can afterwards be filled in using this API or [[Osiris/API/DialogAddActorAt|DialogAddActorAt]].
 +
 
 +
If the dialog instance has a null speaker slot available right after its last non-null speaker slot, this API will fill that speaker slot with the '''_Actor''' and '''_Actor''' will participate in the dialog as if it had been added from the start. If no such slot is available, '''_Actor''' will be added as an '''''observer''''', which means '''_Actor''' will follow the dialog along with its participants and will see/hear everything that gets said, but cannot make any choices in the dialog.
 
===== Notes =====
 
===== Notes =====
 
* Take care that '''_Actor''' is close enough to the characters participating in the dialog, otherwise you may get visual culling issues in multiplayer.
 
* Take care that '''_Actor''' is close enough to the characters participating in the dialog, otherwise you may get visual culling issues in multiplayer.
 
* (DOS2 Classic) Used to be [[Osiris/API/DialogAddCharacter|DialogAddCharacter]]
 
* (DOS2 Classic) Used to be [[Osiris/API/DialogAddCharacter|DialogAddCharacter]]
 
===== See Also =====
 
===== See Also =====
 +
* [[Osiris/API/DialogAddActorAt|DialogAddActorAt]]
 
* [[Osiris/API/DialogActorJoined|DialogActorJoined]]
 
* [[Osiris/API/DialogActorJoined|DialogActorJoined]]
 
* [[Osiris/API/DialogActorLeft|DialogActorLeft]]
 
* [[Osiris/API/DialogActorLeft|DialogActorLeft]]
 +
* [[Osiris/API/DialogRemoveActorFromDialog|DialogRemoveActorFromDialog]]
 
* 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]]
Line 14: Line 20:
 
   
 
   
 
[[Category:Osiris Calls|DialogAddActor]]
 
[[Category:Osiris Calls|DialogAddActor]]
[[Category:Osiris Calls (Changed in DOS2DE)|DialogAddActor]]
+
[[Category:Osiris Calls (Added in DOS2DE)|DialogAddCharacter]]

Latest revision as of 11:27, 12 July 2019

Full Definition(s)
  • call DialogAddActor('(INTEGER)_InstanceID,(GUIDSTRING)_Actor)
Description

Adds character or item _Actor to the ongoing dialog with ID _InstanceID.

When starting a dialog, you can specify NULL as one or more speakers. These speakers can afterwards be filled in using this API or DialogAddActorAt.

If the dialog instance has a null speaker slot available right after its last non-null speaker slot, this API will fill that speaker slot with the _Actor and _Actor will participate in the dialog as if it had been added from the start. If no such slot is available, _Actor will be added as an observer, which means _Actor will follow the dialog along with its participants and will see/hear everything that gets said, but cannot make any choices in the dialog.

Notes
  • Take care that _Actor is close enough to the characters participating in the dialog, otherwise you may get visual culling issues in multiplayer.
  • (DOS2 Classic) Used to be DialogAddCharacter
See Also