BIS_fnc_kbTell

From Bohemia Interactive Community
Jump to: navigation, search
Introduced with Take On Helicopters version 1.00
  Arguments of this scripting function don't have to be local to the client the function is executed onEffects of this scripting function are broadcasted over the network and happen on every computer in the network

Click on the images for descriptions

Introduced in

Game:
Take On Helicopters
Version:
1.00

Description

Description:
Play given sentence/conversation. Script terminates itself when conversation is finished.
Conversation must be declared in Description.ext/CfgSentences.
This function can also be executed with call. Doing so will make it internally spawn since it needs to be able suspend its execution.

Syntax

Syntax:
[topic, container, section, radioMode, code, speakers, soundVolume, radioProtocol] spawn BIS_fnc_kbTell
Parameters:
topic: String - topic name
container: String - (Optional, default missionName) container name (CfgSentences sub-category)
section: Array or String - (Optional, default "") section to be played. Elements can be:
  • String - "variant" - play specific variant
  • Array
    • [startingSentence(, endingSentence)] - play all sentences between specific start and end
      • startingSentence and 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 random sentence, false to play first sentence
        • default - first sentence for startingSentence, last sentence for endingSentence
  • default: play everything
radioMode: Bool, String, Object or Code - (Optional, default: false) can be:
  • Bool - true to force radio
  • String - name of radio channel, original or custom
  • Object - listener's channel
  • Code - returned value of code
code: Code or Array - (Optional, default {true} ) 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, default []) 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:
["01_Wave", "A_in", nil, "SIDE", nil, nil, 1, false] spawn BIS_fnc_kbTell;

Additional Information

Execution:
spawn
Multiplayer:
-
See also:
ConversationskbTellBIS_fnc_kbCanSpeakBIS_fnc_kbCreateDummyBIS_fnc_kbIsSpeakingBIS_fnc_kbMenuBIS_fnc_kbPriorityBIS_fnc_kbSentenceBIS_fnc_kbSkipBIS_fnc_kbTellLocalBIS_fnc_kbTopicConfig

Notes

Only post proven facts here. Report bugs on the feedback tracker. Use the talk page or the forums for discussions.
Add New Note | How To

Notes

Bottom Section