{"name":"BIS_fnc_kbTell","operator":null,"title":"BIS fnc kbTell","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_kbTell","revid":370523,"updated":"2025-01-01T18:16:34Z","groups":["Conversations"],"status":"ok","replaced_by":[],"games":[{"game":"tkoh","name":"Take On Helicopters","version":"1.00"},{"game":"arma3","name":"Arma 3","version":"0.50"}],"since":{"game":"tkoh","name":"Take On Helicopters","version":"1.00"},"arma3_since":"0.50","branch":null,"locality":{"argument":"global","effect":"global","server_exec":false},"exec":"spawn","description":"Play given sentence/conversation. Script terminates itself when conversation is finished.\n\nConversation must be declared in Description.ext/CfgSentences.\n\n> [!NOTE]\n> This function can also be executed with call. Doing so will make it internally spawn since it needs to be able suspend its execution.","syntaxes":[{"syntax":"[topic, container, section, radioMode, code, speakers, soundVolume, radioProtocol] spawn BIS_fnc_kbTell","since":null,"effect":null,"exec":null,"params":[{"name":"topic","type":"String","optional":false,"default":null,"description":"topic name","types":["String"],"since":null,"text":"topic: String - topic name"},{"name":"container","type":"String","optional":true,"default":"missionName","description":"container name (CfgSentences sub-category)","types":["String"],"since":null,"text":"container: String - (Optional, default missionName) container name (CfgSentences sub-category)"},{"name":"section","type":"Array or String","optional":true,"default":"\"\"","description":"section to be played. Elements can be:\n- String - \"variant\" - play specific variant\n- Array\n  - [startingSentence(, endingSentence)] - play all sentences between specific start and end\n    - startingSentence and endingSentence can be in format:\n      - String - full sentence name (example: \"04_intro_team_PLA_0\")\n      - Array - [<actorID>(, <sentenceID>)] (example: [\"PLA\", 0] or just [\"PLA_0\"])\n      - Boolean - true to play random sentence, false to play first sentence\n      - default - first sentence for startingSentence, last sentence for endingSentence\n- default: play everything","types":["Array","String"],"since":null,"text":"section: Array or String - (Optional, default \"\") section to be played. Elements can be:\n- String - \"variant\" - play specific variant\n- Array\n  - [startingSentence(, endingSentence)] - play all sentences between specific start and end\n    - startingSentence and endingSentence can be in format:\n      - String - full sentence name (example: \"04_intro_team_PLA_0\")\n      - Array - [<actorID>(, <sentenceID>)] (example: [\"PLA\", 0] or just [\"PLA_0\"])\n      - Boolean - true to play random sentence, false to play first sentence\n      - default - first sentence for startingSentence, last sentence for endingSentence\n- default: play everything"},{"name":"radioMode","type":"Boolean, String, Object or Code","optional":true,"default":"false","description":"can be:\n- Boolean - true to force radio\n- String - name of radio channel (\"DIRECT\" or \"VEHICLE\")\n- Number - custom radio channel\n- Object - listener's channel\n- Code - returned value of code","types":["Boolean","String","Object","Code"],"since":null,"text":"radioMode: Boolean, String, Object or Code - (Optional, default: false) can be:\n- Boolean - true to force radio\n- String - name of radio channel (\"DIRECT\" or \"VEHICLE\")\n- Number - custom radio channel\n- Object - listener's channel\n- Code - returned value of code"},{"name":"code","type":"Code or Array","optional":true,"default":"`{ true }`","description":"can be:\n- Code - executed at the start of every sentence (arguments are same as in kbAddTopic event handler)\n- Array - code with arguments in format [code, arguments]","types":["Code","Array"],"since":null,"text":"code: Code or Array - (Optional, default `{ true }`) can be:\n- Code - executed at the start of every sentence (arguments are same as in kbAddTopic event handler)\n- Array - code with arguments in format [code, arguments]"},{"name":"speakers","type":"Array or Boolean","optional":true,"default":"`[]`","description":"can be:\n- Array - replacement units for those defined in .bikb file (in chronological order)\n- Boolean - 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)","types":["Array","Boolean"],"since":null,"text":"speakers: Array or Boolean - (Optional, default `[]`) can be:\n- Array - replacement units for those defined in .bikb file (in chronological order)\n- Boolean - 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)"},{"name":"soundVolume","type":"Number","optional":true,"default":"Take On Helicopters v1.00 0.2, Arma 3 v1.00 -1","description":"music and sound volumes lowering ratio during the conversation, range 0..1 (e.g 0 = no music, 0.25 = a quarter of the current volume, 1 or out of range = no change)","types":["Number"],"since":null,"text":"soundVolume: Number - (Optional, default Take On Helicopters v1.00 0.2, Arma 3 v1.00 -1) music and sound volumes lowering ratio during the conversation, range 0..1 (e.g 0 = no music, 0.25 = a quarter of the current volume, 1 or out of range = no change)"},{"name":"radioProtocol","type":"Boolean","optional":true,"default":"true","description":"true to disable radio protocol message while the conversation is playing","types":["Boolean"],"since":null,"text":"radioProtocol: Boolean - (Optional, default true) true to disable radio protocol message while the conversation is playing"}],"returns":{"type":"Nothing","types":["Nothing"],"description":null,"text":"Nothing"}}],"examples":[{"text":"```sqf\n[\"01_Wave\", \"A_in\", nil, \"SIDE\", nil, nil, 1, false] spawn BIS_fnc_kbTell;\n```","code":["[\"01_Wave\", \"A_in\", nil, \"SIDE\", nil, nil, 1, false] spawn BIS_fnc_kbTell;"]}],"multiplayer":null,"problems":null,"aliases":[],"see_also":["Conversations","kbTell","BIS_fnc_kbCanSpeak","BIS_fnc_kbCreateDummy","BIS_fnc_kbIsSpeaking","BIS_fnc_kbMenu","BIS_fnc_kbPriority","BIS_fnc_kbSentence","BIS_fnc_kbSkip","BIS_fnc_kbTellLocal","BIS_fnc_kbTopicConfig"],"notes":[],"categories":["Arma 3: Functions","Function Group: Conversations","Functions","Functions: Global Effect","Introduced with Take On Helicopters version 1.00","Take On Helicopters: Functions","Take On Helicopters: New Functions"],"docblock":null,"filled_from_docblock":[]}