kbAddTopic: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
 
m (Text replacement - "\{\{Feature *\| *Informative *\| ([^↵]+) *\}\}" to "{{Feature|informative|$1}}")
 
(76 intermediate revisions by 13 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands|KBADDTOPIC]]
{{RV|type=command
[[Category:Scripting Commands ArmA|KBADDTOPIC]]


|game1= arma2
|version1= 1.00


<h2 style="color:#000066">''person'' ''' kbAddTopic ''[name, filename(, task type)]'''''</h2>
|game2= arma2oa
|version2= 1.50


|game3= tkoh
|version3= 1.00


'''Operand types:'''
|game4= arma3
   
|version4= 0.50
person: [[Object]]


[name, filename(, task type)]: [[Array]]
|gr1= Conversations


'''Type of returned value:'''
|arg= local


[[Nothing]]
|eff= local


'''Compatibility:'''
|descr= Register conversation topic to given person. See [[Conversations]] for more details.
{{Feature|informative|Only the speaker(s) need to have the topic added.}}


Version 2.92 required.
|s1= person [[kbAddTopic]] [topicName, conversationFile, fsmFile, eventHandler]


'''Description:'''
|p1= person: [[Object]]


Register conversation topic to given person
|p2= topicName: [[String]] - the topic id for further reference


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


'''Example:'''
|p4= 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
 
|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.
 
|r1= [[Nothing]]
 
|x1= <sqf>player kbAddTopic ["myTest", "myTest.bikb", "myTest.fsm", compile preprocessFileLineNumbers "myTest.sqf"];</sqf>
 
|x2= <sqf>player kbAddTopic ["itsGettingWarm", "weatherTalk.bikb"];</sqf>
 
|seealso= [[Conversations]] [[kbHasTopic]] [[kbTell]] [[kbWasSaid]] [[kbReact]] [[kbRemoveTopic]] [[kbAddDatabase]] [[kbAddDatabaseTargets]] [[FSM]] [[FSM Editor]]
}}

Latest revision as of 18:11, 15 March 2024

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:
Conversations kbHasTopic kbTell kbWasSaid kbReact kbRemoveTopic kbAddDatabase kbAddDatabaseTargets FSM FSM 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