--- name: "Conversations" type: topic source: https://community.bistudio.com/wiki/Conversations revid: 370901 updated: 2025-02-21T10:44:31Z --- # Conversations Arma 2 v1.00 Arma 2: Operation Arrowhead v1.50 Take On Helicopters v1.00 Arma 3 v1.00 [Conversations](../topics/Conversations.md) is a system created to manage discussions that was introduced in **Arma 2**. This system allows dynamic conversations and a more fluid sentence/answer flow. Its main advantages are: - The system itself waits for the sound sample to finish. No more sample time measuring and countless sleeps! - Conversation always flows through the appropriate channel (direct for face to face, team radio for distant team members etc.) - Possibility to create fully dynamic conversations - Transparent syntax (FSM branches allow fast and efficient edits) ### Usage - A **topic** is defined by a [String](../topics/String.md) for id and sentences defined in a **Conversation .bikb** file - A **[Conversation .bikb](../topics/Conversations.md#conversation-bikb)** lists all available sentences in a **topic** - A **topic** must be added to the concerned units, with eventually a **Conversation FSM** and/or a **Conversation Event Handler** - A **[Conversation FSM](../topics/Conversations.md#conversation-fsm)** defines an **AI unit** reaction to a sentence - A **[Conversation Event Handler](../topics/Conversations.md#conversation-event-handler)** defines a **[player](../commands/player.md)'s unit** reaction to a sentence, potentially defining available answers - If the unit is [playable](../commands/switchableUnits.md) (can be either player or AI), both should be present to ensure a proper reaction in every encountered scenario. ### Commands A conversation topic: 1. must be added to units (via [kbAddTopic](../commands/kbAddTopic.md)) 1. for the units to be able use it (via [kbTell](../commands/kbTell.md) for example) 1. once the unit said wanted sentences (checked via [kbWasSaid](../commands/kbWasSaid.md)), 1. the topic can be removed (via [kbRemoveTopic](../commands/kbRemoveTopic.md)). - Related commands are listed in Conversations Command Group - Related functions are listed in Conversations Function Group #### Manual Conversation Example ```sqf miles kbAddTopic ["briefing", "kb\briefing.bikb"]; shaftoe kbAddTopic ["briefing", "kb\briefing.bikb"]; shaftoe kbTell [miles, "briefing", "shaftoe_briefing_H_1"]; waitUntil { shaftoe kbWasSaid [miles, "briefing", "shaftoe_briefing_H_1", 3]; }; miles kbTell [shaftoe, "briefing", "shaftoe_briefing_M_1"]; waitUntil { miles kbWasSaid [shaftoe, "briefing", "shaftoe_briefing_M_1", 3]; }; hint "Conversation ended."; // kbRemoveTopic can be used here to "clear" the units if the topic is not required anymore. This is not mandatory. ``` ### Conversation .bikb **.bikb** extension stands for "**B**ohemia **I**nteractive **K**nowledge **B**ase" as it was originally used only for storing an AI unit's memory of what it has seen.\ This file declares the available sentences in the topic, their sound samples and the corresponding subtitles (see [example 1](../topics/Conversations.md#bikb-simple-example) and [example 2](../topics/Conversations.md#bikb-advanced-example)).\ As the syntax is the same as config files ([Description.ext](../topics/Description.ext.md), [Config.cpp](../topics/Config.cpp~2Fbin_File_Format.md)) [PreProcessor Commands](../topics/PreProcessor_Commands.md) can be used. Conversation sounds do **not** need to be defined in [CfgSounds](../topics/Description.ext.md#cfgsounds) or [CfgRadio](../topics/Description.ext.md#cfgradio), unless of course they are to be used with e.g [playSound](../commands/playSound.md), [say](../commands/say.md) or [groupRadio](../commands/groupRadio.md) too.\ As opposed to these commands, this new conversation system will automatically use [setRandomLip](../commands/setRandomLip.md) during the speech if no .lip file is present. A .lip file can however still be used for a more precise animation. > [!IMPORTANT] > A duplicate sentence in .bikb file **WILL** crash the game! #### "Interrupted" Event The left-side conversation menu (with the list of possible sentences) can be closed via backspace at all times. In order to handle this event as well, add a sentence class called **Interrupted** into the .bikb file. It can then be used as a standard `_sentenceId` in the script. #### .bikb Simple Example ```cpp class Sentences { class hello1 { text = "Hello!"; // sentence subtitle - can be "text" or $STR_ stringtable reference speech[] = { "\Sound\hello1.ogg" }; // sound file path relative to mission or campaign directory class Arguments {}; // unused here }; class hi_how_are_you { text = "Hi, how are you?"; speech[] = { "\Sound\hi_how_are_you.ogg" }; class Arguments {}; }; class good_you { text = "$STR_GoodYou"; // has to start with "STR_"! speech[] = { "\Sound\good_you.ogg" }; class Arguments {}; }; class fine_thanks { text = "$STR_FineThanks"; speech[] = { "\Sound\fine_thanks" }; // no extension means .wss to the engine class Arguments {}; }; // these sentences are here to be a full example for later Conversation Event Handler example class what_do_we_do { text = "What do we do today?"; speech[] = { "\Sound\wdwd.ogg" }; class Arguments {}; }; class choose_football { text = "Let's football!"; speech[] = { "\Sound\cf.ogg" }; class Arguments {}; }; class choose_bike { text = "Let's bike?"; speech[] = { "\Sound\cb.ogg" }; class Arguments {}; }; class choose_arma2 { text = "I know! Arma 2"; speech[] = { "\Sound\ca.ogg" }; class Arguments {}; }; // the Interrupted sentence triggered when the conversation menu is closed without answering (e.g using backspace) class Interrupted { text = "Hey, come back!"; speech[] = { "\Sound\interrupted.ogg" }; class Arguments {}; }; }; // Needed parameters. class Arguments {}; class Special {}; startWithVocal[] = { hour }; startWithConsonant[] = { europe, university }; ``` #### .bikb Advanced Example See [Words configuration](../topics/Radio_Protocol.md#words) and below for more details. ```cpp class Sentences { class AirstrikeRequest { // %team and %location will be replaced by the game engine with according values text = "%team requesting close air support at grid %location "; // available words are defined in config > RadioProtocol > Words speech[] = { %Team, RequestingCloseAirSupportAtGrid, %Location }; class Arguments { class Team { type = "simple"; }; // refers to %Team, first element of speech[] // "RequestingCloseAirSupportAtGrid" is part of Radio Protocol class Location { type = "simple"; }; // refers to %Location, last element of speech[] }; }; }; class Arguments {}; class Special {}; startWithVocal[] = { hour }; startWithConsonant[] = { europe, university }; ``` Above sentence would be used this way: ```sqf player kbTell [ BIS_HQ, // to "Airstrike", // topic "AirstrikeRequest", // sentence ["Team", {}, "Anvil", ["Anvil"]], // argument 1 ["Location", {}, "Strelka", ["Strelka"]] // argument 2 ]; ``` #### .bikb BIS_fnc_kbTell Example > [!NOTE] > **Arma 3:** > > ```cpp > class Sentences > { > class Sentence1 > { > text = ""; // must be empty > textPlain = "$STR_MySubTitle"; > /* other parameters */ > }; > }; > ``` > > **In an addon/mod scope**, an additional subtitle entry is available to have subtitle rendered with [BIS_fnc_showSubtitle](../functions/BIS_fnc_showSubtitle.md): `textPlain`, declared as shown.\ > **This is not available for standard missions** as [BIS_fnc_kbTellLocal](../functions/BIS_fnc_kbTellLocal.md) only checks [configFile](../commands/configFile.md) and none of [missionConfigFile](../commands/missionConfigFile.md) or [campaignConfigFile](../commands/campaignConfigFile.md). [BIS_fnc_kbTell](../functions/BIS_fnc_kbTell.md) needs a [Description.ext](../topics/Description.ext.md) **CfgSentences** entry presented as follows: ```cpp class CfgSentences { class MissionName { class Event1 { file = "kb\event1.bikb"; // mandatory class Sentences { class Sentence1 { // the following arguments are used by BIS_fnc_kbTell (if they are defined, they are not mandatory) actor = "obi1"; // (missionNamespace getVariable actor) speaker variable name (can NOT be "player") variant = ""; // used by BIS_fnc_kbTell to define an alternative sentence variantText = ""; // used by BIS_fnc_kbTell to define an alternative sentence }; class Sentence2 { actor = "griev"; }; class Sentence3 { actor = "griev"; }; }; }; }; }; ``` with a .bikb file looking like this: ```cpp class Sentences { class Sentence1 { text = "$STR_HelloThere"; speech[] = { "\Sound\hello.ogg" }; class Arguments {}; }; class Sentence2 { text = "$STR_GeneralKenobi"; speech[] = { "Sound\gk.ogg" }; class Arguments {}; }; class Sentence3 { text = "$STR_YouAreABoldOne"; speech[] = { "Sound\bold.ogg" }; class Arguments {}; }; }; class Arguments {}; class Special {}; startWithVocal[] = { hour }; startWithConsonant[] = { europe, university }; ``` A tidier way of doing so is to put all the needed information in the **.bikb** file: ```cpp class Sentences { class Sentence1 { text = "$STR_HelloThere"; speech[] = { "\Sound\hello.ogg" }; class Arguments {}; actor = "obi1"; }; class Sentence2 { text = "$STR_GeneralKenobi"; speech[] = { "Sound\gk.ogg" }; class Arguments {}; actor = "griev"; }; class Sentence3 { text = "$STR_YouAreABoldOne"; speech[] = { "Sound\bold.ogg" }; class Arguments {}; actor = "griev"; }; }; class Arguments {}; class Special {}; startWithVocal[] = { hour }; startWithConsonant[] = { europe, university }; ``` And to include it via `#include` in [Description.ext](../topics/Description.ext.md): ```cpp class CfgSentences { class MissionName { class Event1 { file = "kb\event1.bikb"; #include "kb\event1.bikb" // avoids a double declaration }; }; }; ``` *Et voilà !* All that remains to be done now is to call the discussion like this: `["Event1", "MissionName"] call BIS_fnc_kbTell; // note that the topic comes first`; the game will make the defined actors say the lines in the order they were declared. [BIS_fnc_kbTell](../functions/BIS_fnc_kbTell.md) will manage to use [kbAddTopic](../commands/kbAddTopic.md), [kbTell](../commands/kbTell.md) and other commands. > [!IMPORTANT] > Please note: > > - use **class CfgSentences** in [Description.ext](../topics/Description.ext.md) > - use **class Sentences** in .bikb files ### Conversation FSM As stated earlier, the **Conversation FSM** fires on sentences **received by an AI** and defines an AI unit's reaction. The Conversation FSM receives the following arguments: - **_this:** [Object](../topics/Object.md) - receiver or listener of the sentence. One of the units that had this particular script assigned via [kbAddTopic](../commands/kbAddTopic.md) - **_from:** [Object](../topics/Object.md) - the unit that told the sentence - **_sentenceId:** [String](../topics/String.md) - the sentence this unit is reacting to. Defined in .bikb in class Sentences - **_topic:** [String](../topics/String.md) - topic name used in [kbAddTopic](../commands/kbAddTopic.md) See also: [FSM](../topics/FSM.md), [FSM Editor](../topics/FSM_Editor.md) #### Conversation FSM Example ### Conversation Event Handler The **Conversation Event Handler** is code, provided through [kbAddTopic](../commands/kbAddTopic.md), that is executed with each sentence **received by a player**, and will constantly fire ([onEachFrame](../commands/onEachFrame.md)) when the player is pointing at a "talkable" person at "talkable" range. Following parameters are passed: - **_this:** [Object](../topics/Object.md) - the [player](../commands/player.md) receiving the sentence. Must have had this particular script assigned via [kbAddTopic](../commands/kbAddTopic.md) - **_from:** [Object](../topics/Object.md) - the unit that told the sentence - **_sentenceId:** [String](../topics/String.md) - the sentence the player is reacting to. Defined in .bikb in class Sentences - **_topic:** [String](../topics/String.md) - topic name used in [kbAddTopic](../commands/kbAddTopic.md) > [!NOTE] > This Conversation Event Handler is **not** an Event Handler as we know them. Its return value is used to provide the player's available replies; its format is an [Array](../topics/Array.md) of arrays (or an empty array) that can look like this: ```sqf [ [ localize "STR_AnswerTitle1", // conversation menu's display text "myTopic", // topic to answer to "answer1SentenceId", // sentence ID [] // sentence arguments ], [ localize "STR_AnswerTitle2", "myTopic", "answer2SentenceId", [] ] ]; ``` There is a certain resemblance with the [kbTell](../commands/kbTell.md) syntax; note that the *forceRadio* parameter is not present. > [!IMPORTANT] > The Conversation Event Handler's code is executed in [**unscheduled** environment](../topics/Scheduler.md#unscheduled-environment) - be sure to not use [sleep](../commands/sleep.md) or any other [Scheduler](../topics/Scheduler.md)-incompatible commands. #### Conversation Event Handler Example ```sqf // here we will be storing all the sentences from which the player will choose (left side menu) // if there is only one option in the array, the sentence will replace the "Talk to" action name private _convMenu = []; // we want the player to be able to approach his buddy and talk to him via the action menu. // we need to check: // if the player is pointing at his buddy // if the player is not answering any of his buddy's sentences // if the player has not told him hello already // then we add that array to _convMenu - the parameters are mostly self-explanatory: if (_from == buddy1 && _sentenceId == "" && !(_this kbWasSaid [_from, _topic, "hello1", 999999])) then { _convMenu pushBack ["Say hello.", _topic, "hello1", []]; }; // here we make the unit say the proper sentence based on the one he just received // switch-case-do is used here but it is only one solution to manage sentences (if-then etc could do) switch (_sentenceId) do { case "hello1": { _this kbTell [_from, _topic, "hi_how_are_you"]; }; case "good_you": { _this kbTell [_from, _topic, "fine_thanks"]; }; case "what_do_we_do": { // the player will have 3 answers to choose from: _convMenu pushBack ["Football.", _topic, "choose_football", []]; _convMenu pushBack ["Bike.", _topic, "choose_bike", []]; _convMenu pushBack ["Arma 2.", _topic, "choose_arma2", []]; }; }; // return the sentence list pool _convMenu; ``` ### See Also - Conversations Command Group - Conversations Function Group - [Jezuro's introduction forum post](https://forums.bohemia.net/forums/topic/89071-new-conversation-system-how-to/) - [HateDread's forum post and Evil_Echo's answers](https://forums.bohemia.net/forums/topic/107662-using-dialogue-system-between-player-and-ai/) - [FSM](../topics/FSM.md) - [FSM Editor](../topics/FSM_Editor.md) Source: [BI Community Wiki — Conversations](https://community.bistudio.com/wiki/Conversations) (revision 370901).