kbAddTopic: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments( \("local" or "global"\))?|Effects|Multiplayer Effects( \("local" or "global"\))?|Multiplayer Exe...)
Line 1: Line 1:
{{Command|Comments=
{{Command


| arma2 |Game name=
| arma2


|gr1= Conversations |GROUP1=
|gr1= Conversations






|1.00|Game version=
|1.00


|arg= local |Multiplayer Arguments=
|arg= local


|eff= local |Multiplayer Effects=
|eff= local


| Register conversation topic to given person. See [[Conversations]] for more details.
| Register conversation topic to given person. See [[Conversations]] for more details.
{{Informative | Only the speaker(s) need to have the topic added.}} |DESCRIPTION=
{{Informative | Only the speaker(s) need to have the topic added.}}


| person [[kbAddTopic]] [topicName, conversationFile, fsmFile, eventHandler] |SYNTAX=
| person [[kbAddTopic]] [topicName, conversationFile, fsmFile, eventHandler]


|p1= person: [[Object]] |PARAMETER1=
|p1= person: [[Object]]


|p2= topicName: [[String]] - the topic id for further reference |PARAMETER2=
|p2= topicName: [[String]] - the topic id for further reference


|p3= conversationFile: [[String]] - .bikb file path |PARAMETER3=
|p3= conversationFile: [[String]] - .bikb file path


|p4= fsmFile: [[String]] - (Optional) .fsm file path. Receives the following parameters:
|p4= fsmFile: [[String]] - (Optional) .fsm file path. Receives the following parameters:
Line 28: Line 28:
* '''_topic:''' TopicName registered via kbAddTopic
* '''_topic:''' TopicName registered via kbAddTopic
* '''_this:''' the person that was talked to (receiver)
* '''_this:''' the person that was talked to (receiver)
* '''_from:''' the person that talked to the receiver and triggered the script |PARAMETER4=
* '''_from:''' the person that talked to the receiver and triggered the script


|p5= eventHandler: [[Code]] or [[String]] - (Optional) code to execute - given String will be [[compile]]d. This is '''not''' an sqf file path.<br>
|p5= eventHandler: [[Code]] or [[String]] - (Optional) code to execute - given String will be [[compile]]d. This is '''not''' an sqf file path.<br>
Parameters: identical to ''fsmFile'' - see above. |PARAMETER5=
Parameters: identical to ''fsmFile'' - see above.


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


|x1= <code>[[player]] [[kbAddTopic]] ["myTest", "myTest.bikb", "myTest.fsm", [[compile]] [[preprocessFileLineNumbers]] "myTest.sqf"];</code> |EXAMPLE1=
|x1= <code>[[player]] [[kbAddTopic]] ["myTest", "myTest.bikb", "myTest.fsm", [[compile]] [[preprocessFileLineNumbers]] "myTest.sqf"];</code>


|x2= <code>[[player]] [[kbAddTopic]] ["itsGettingWarm", "weatherTalk.bikb"];</code> |EXAMPLE2=
|x2= <code>[[player]] [[kbAddTopic]] ["itsGettingWarm", "weatherTalk.bikb"];</code>


| [[Conversations]], [[kbHasTopic]], [[kbTell]], [[kbWasSaid]], [[kbReact]], [[kbRemoveTopic]], [[kbAddDatabase]], [[kbAddDatabaseTargets]], [[FSM]], [[FSM Editor]] |SEEALSO=
| [[Conversations]], [[kbHasTopic]], [[kbTell]], [[kbWasSaid]], [[kbReact]], [[kbRemoveTopic]], [[kbAddDatabase]], [[kbAddDatabaseTargets]], [[FSM]], [[FSM Editor]]
}}
}}



Revision as of 01:06, 18 January 2021

Hover & click on the images for description

Description

Description:
Register conversation topic to given person. See Conversations for more details.
Only the speaker(s) need to have the topic added.
Groups:
Conversations

Syntax

Syntax:
person kbAddTopic [topicName, conversationFile, fsmFile, eventHandler]
Parameters:
person: Object
topicName: String - the topic id for further reference
conversationFile: String - .bikb file path
fsmFile: String - (Optional) .fsm file path. Receives the following parameters:
  • _sentenceId: the sentence as defined in the .bikb file
  • _topic: TopicName registered via kbAddTopic
  • _this: the person that was talked to (receiver)
  • _from: the person that talked to the receiver and triggered the script
eventHandler: Code or String - (Optional) code to execute - given String will be compiled. This is not an sqf file path.
Parameters: identical to fsmFile - see above.
Return Value:
Nothing

Examples

Example 1:
player kbAddTopic ["myTest", "myTest.bikb", "myTest.fsm", compile preprocessFileLineNumbers "myTest.sqf"];
Example 2:
player kbAddTopic ["itsGettingWarm", "weatherTalk.bikb"];

Additional Information

See also:
ConversationskbHasTopickbTellkbWasSaidkbReactkbRemoveTopickbAddDatabasekbAddDatabaseTargetsFSMFSM Editor

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