BIS_fnc_kbTell

From Bohemia Interactive Community
Revision as of 16:15, 30 March 2018 by Lou Montana (talk | contribs) (Page formatting)
Jump to navigation Jump to search


Hover & click on the images for description

Description

Description:
Plays conversation. Script terminates itself when conversation is finished.
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
[topic, container, section, radioMode, code, speakers, soundVolume, radioProtocol] call BIS_fnc_kbTell
Parameters:
topic: String - topic name
container: String - (Optional) container name (default: current mission ID)
section: Array - (Optional) section to be played. Elements can be:
  • String - "variant" - play specific variant
  • Array
    • [startingSentence(, endingSentence)] - play all sentences between specific start and end
      • startingSentence can be in format:
        • String - full sentence name (example: "04_intro_team_PLA_0")
        • Array - [<actorID>(, <sentenceID>)] (example: ["PLA", 0] or just ["PLA_0"])
        • Bool - true to play random sentence, false to play first sentence
        • default - first sentence
      • endingSentence can be in format:
        • String - full sentence name (example: "04_intro_team_PLA_0")
        • Array - [<actorID>(, <sentenceID>)] (example: ["PLA", 0] or just ["PLA_0"])
        • Bool - true to play only one sentence, false if continue to last sentence
        • default - last sentence
  • default: play everything
radioMode: Bool, String, Object or Code - (Optional) can be:
  • Bool - true to force radio
  • String - name of custom radio channel
  • Object - listener's channel
  • Code - returned value of code
code: Code or Array - (Optional, default: {}) can be:
  • Code - executed at the start of every sentence (arguments are same as in kbAddTopic event handler)
  • Array - code with arguments in format [code, arguments]
speakers: Array or Bool - (Optional) can be:
  • Array - replacement units for those defined in .bikb file (in chronological order)
  • Bool - when true, dummy logics will be created for all actor units which doesn't exist (default: false or value of 'bis_fnc_kbTell_createDummy' variable)
soundVolume: Number - (Optional, default: 0.1) music and sound volumes will be multiplied by this value when conversation starts
radioProtocol: Bool - (Optional, default: true) true to disable radio protocol message while the conversation is playing
Return Value:
Nothing

Examples

Example 1:

Additional Information

See also:
See also needed

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note

Notes

Bottom Section