BIS fnc kbTell: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " *\|= " to " ")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| tkoh |Game name=
| tkoh


|1.00|Game version=
|1.00


|arg= glob |argument=  
|arg= glob |argument=  
Line 9: Line 9:
|eff= glob |effect=  
|eff= glob |effect=  


|gr1 = Conversations |GROUP1=
|gr1 = Conversations


| Play given sentence/conversation. Script terminates itself when conversation is finished.<br>
| Play given sentence/conversation. Script terminates itself when conversation is finished.<br>
Conversation must be declared in [[Description.ext#CfgSentences|Description.ext/CfgSentences]].
Conversation must be declared in [[Description.ext#CfgSentences|Description.ext/CfgSentences]].
{{Informative|This function can also be executed with [[call]]. Doing so will make it internally [[spawn]] since it needs to be able suspend its execution.}} |DESCRIPTION=
{{Informative|This function can also be executed with [[call]]. Doing so will make it internally [[spawn]] since it needs to be able suspend its execution.}}


| [topic, container, section, radioMode, code, speakers, soundVolume, radioProtocol] spawn [[BIS_fnc_kbTell]] |SYNTAX=
| [topic, container, section, radioMode, code, speakers, soundVolume, radioProtocol] spawn [[BIS_fnc_kbTell]]


|p1= topic: [[String]] - topic name |PARAMETER1=
|p1= topic: [[String]] - topic name


|p2= container: [[String]] - (Optional, default [[missionName]]) container name ([[Description.ext#CfgSentences|CfgSentences]] sub-category) |PARAMETER2=
|p2= container: [[String]] - (Optional, default [[missionName]]) container name ([[Description.ext#CfgSentences|CfgSentences]] sub-category)


|p3= section: [[Array]] or [[String]] - (Optional, default "") section to be played. Elements can be:
|p3= section: [[Array]] or [[String]] - (Optional, default "") section to be played. Elements can be:
Line 30: Line 30:
**** [[Boolean]] - true to play random sentence, false to play first sentence
**** [[Boolean]] - true to play random sentence, false to play first sentence
**** default - first sentence for startingSentence, last sentence for endingSentence
**** default - first sentence for startingSentence, last sentence for endingSentence
* default: play everything |PARAMETER3=
* default: play everything


|p4= radioMode: [[Boolean]], [[String]], [[Object]] or [[Code]] - (Optional, default: [[false]]) can be:
|p4= radioMode: [[Boolean]], [[String]], [[Object]] or [[Code]] - (Optional, default: [[false]]) can be:
Line 36: Line 36:
* [[String]] - name of radio channel, original or [[radioChannelCreate|custom]]
* [[String]] - name of radio channel, original or [[radioChannelCreate|custom]]
* [[Object]] - listener's channel
* [[Object]] - listener's channel
* [[Code]] - returned value of code |PARAMETER4=
* [[Code]] - returned value of code


|p5= code: [[Code]] or [[Array]] - (Optional, default {{Inline code|{[[true]]<nowiki>}</nowiki>}} ) can be:
|p5= code: [[Code]] or [[Array]] - (Optional, default {{Inline code|{[[true]]<nowiki>}</nowiki>}} ) can be:
* [[Code]] - executed at the start of every sentence (arguments are same as in kbAddTopic event handler)
* [[Code]] - executed at the start of every sentence (arguments are same as in kbAddTopic event handler)
* [[Array]] - code with arguments in format [code, arguments] |PARAMETER5=
* [[Array]] - code with arguments in format [code, arguments]


|p6= speakers: [[Array]] or [[Boolean]] - (Optional, default []) can be:
|p6= speakers: [[Array]] or [[Boolean]] - (Optional, default []) can be:
* [[Array]] - replacement units for those defined in .bikb file (in chronological order)
* [[Array]] - replacement units for those defined in .bikb file (in chronological order)
* [[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) |PARAMETER6=
* [[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)


|p7= soundVolume: [[Number]] - (Optional, default 0.1) music and sound volumes will be multiplied by this value when conversation starts |PARAMETER7=
|p7= soundVolume: [[Number]] - (Optional, default 0.1) music and sound volumes will be multiplied by this value when conversation starts


|p8= radioProtocol: [[Boolean]] - (Optional, default [[true]]) true to disable radio protocol message while the conversation is playing |PARAMETER8=
|p8= radioProtocol: [[Boolean]] - (Optional, default [[true]]) true to disable radio protocol message while the conversation is playing


| [[Nothing]] |RETURNVALUE=
| [[Nothing]]


|x1= <code>["01_Wave", "A_in", [[nil]], "SIDE", [[nil]], [[nil]], 1, [[false]]] [[spawn]] [[BIS_fnc_kbTell]];</code> |EXAMPLE1=
|x1= <code>["01_Wave", "A_in", [[nil]], "SIDE", [[nil]], [[nil]], 1, [[false]]] [[spawn]] [[BIS_fnc_kbTell]];</code>


| [[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]] |SEEALSO=
| [[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]]


|exec= spawn
|exec= spawn

Revision as of 23:10, 17 January 2021

tkoh logo small.png1.00
-wrong parameter ("globargument") defined!--wrong parameter ("globeffect") defined!-
Hover & click on the images for description

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.
Execution:
spawn
Groups:
Conversations

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"])
        • Boolean - true to play random sentence, false to play first sentence
        • default - first sentence for startingSentence, last sentence for endingSentence
  • default: play everything
radioMode: Boolean, String, Object or Code - (Optional, default: false) can be:
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 Boolean - (Optional, default []) can be:
  • Array - replacement units for those defined in .bikb file (in chronological order)
  • 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)
soundVolume: Number - (Optional, default 0.1) music and sound volumes will be multiplied by this value when conversation starts
radioProtocol: Boolean - (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

See also:
ConversationskbTellBIS_fnc_kbCanSpeakBIS_fnc_kbCreateDummyBIS_fnc_kbIsSpeakingBIS_fnc_kbMenuBIS_fnc_kbPriorityBIS_fnc_kbSentenceBIS_fnc_kbSkipBIS_fnc_kbTellLocalBIS_fnc_kbTopicConfig

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

Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_kbTell&oldid=203117"