Difference between revisions of "Osiris/API/StartVoiceBark"

From Divinity Engine Wiki
Jump to: navigation, search
(Corrected capitalisation)
 
(4 intermediate revisions by 2 users not shown)
Line 4: Line 4:
 
Starts a [[Voice_Bark_editor|Voicebark]] named '''_Bark''' on the '''_Source''' character, selecting an automatic dialogue based on that character's nearby party members.
 
Starts a [[Voice_Bark_editor|Voicebark]] named '''_Bark''' on the '''_Source''' character, selecting an automatic dialogue based on that character's nearby party members.
 
===== Notes =====
 
===== Notes =====
* See the Voicebark editor for the specific on how the voicebark selects the AD that will be played.
+
* See the [[Voice_Bark_editor|Voicebark editor]] for the specifics on how the voicebark selects the AD that will be played.
* In addition to the regular for starting a dialogue, a [[Osiris/API/VoiceBarkStarted|VoiceBarkStarted]] will be sent if the voicebark succeeds in selecting a fitting dialogue, and [[Osiris/API/VoiceBarkFailed|VoiceBarkFailed]] otherwise.
+
* In addition to the regular events for starting an automated dialogue, a [[Osiris/API/VoiceBarkStarted|VoiceBarkStarted]] will be sent if the voicebark succeeds in selecting a fitting dialogue, and [[Osiris/API/VoiceBarkFailed|VoiceBarkFailed]] otherwise.
 +
* '''_Source''' must be a [[Osiris/API/AddToParty|party member]], otherwise [[Osiris/API/VoiceBarkFailed|VoiceBarkFailed]] gets raised immediately.
 
===== See Also =====
 
===== See Also =====
 
* [[Osiris/API/VoiceBarkStarted|VoiceBarkStarted]]
 
* [[Osiris/API/VoiceBarkStarted|VoiceBarkStarted]]
 
* [[Osiris/API/VoiceBarkFailed|VoiceBarkFailed]]
 
* [[Osiris/API/VoiceBarkFailed|VoiceBarkFailed]]
* [[Voice_Bark_editor|Voicebark]]
+
* [[Osiris/API/VoiceBarkEnded|VoiceBarkEnded]]
 +
* [[Voice_Bark_editor|Voicebark editor]]
  
 
[[Category:Osiris Calls|StartVoiceBark]]
 
[[Category:Osiris Calls|StartVoiceBark]]

Latest revision as of 15:18, 17 October 2019

Full Definition(s)
  • call StartVoiceBark((STRING)_Bark, (CHARACTERGUID)_Source)
Description

Starts a Voicebark named _Bark on the _Source character, selecting an automatic dialogue based on that character's nearby party members.

Notes
  • See the Voicebark editor for the specifics on how the voicebark selects the AD that will be played.
  • In addition to the regular events for starting an automated dialogue, a VoiceBarkStarted will be sent if the voicebark succeeds in selecting a fitting dialogue, and VoiceBarkFailed otherwise.
  • _Source must be a party member, otherwise VoiceBarkFailed gets raised immediately.
See Also