kbAddTopic: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Take[ _]On[ _]Helicopters(\|.*)?\]\]" to "{{GameCategory|tkoh|Scripting Commands}}")
m (Text replacement - "\{\{Feature *\| *Informative *\| ([^↵]+) *\}\}" to "{{Feature|informative|$1}}")
 
(30 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma2 |Game name=
|game1= arma2
|version1= 1.00


|gr1= Conversations |GROUP1=
|game2= arma2oa
|version2= 1.50


|game3= tkoh
|version3= 1.00


|game4= arma3
|version4= 0.50


|1.00|Game version=
|gr1= Conversations


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


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


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


| person [[kbAddTopic]] [topicName, conversationFile, fsmFile, eventHandler] |SYNTAX=
|s1= 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 31: Line 34:
* '''_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=
|r1= [[Nothing]]
____________________________________________________________________________________________


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


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


| [[Conversations]], [[kbHasTopic]], [[kbTell]], [[kbWasSaid]], [[kbReact]], [[kbRemoveTopic]], [[kbAddDatabase]], [[kbAddDatabaseTargets]], [[FSM]], [[FSM Editor]] |SEEALSO=
|seealso= [[Conversations]] [[kbHasTopic]] [[kbTell]] [[kbWasSaid]] [[kbReact]] [[kbRemoveTopic]] [[kbAddDatabase]] [[kbAddDatabaseTargets]] [[FSM]] [[FSM Editor]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}

Latest revision as of 18:11, 15 March 2024

Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
LALocalLELocal
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
Retrieved from "https://community.bistudio.com/wiki?title=kbAddTopic&oldid=353355"