kbAddTopic: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Remove from Arma 1 commands)
m (Add examples)
Line 10: Line 10:
____________________________________________________________________________________________
____________________________________________________________________________________________


| person '''kbAddTopic''' [TopicName, filename.bikb, filename.fsm, event_handler] |= Syntax
| person [[kbAddTopic]] [topicName, conversationFile, fsmFile, eventHandler] |= Syntax


|p1= person: [[Object]] |= Parameter 1
|p1= person: [[Object]] |= Parameter 1


|p2= [TopicName, filename.bikb, filename.fsm, event_handler]: [[Array]] |= Parameter 2
|p2= topicName: [[String]] - the topic id for further reference |= Parameter 2


|p3= TopicName: [[String]] - |= Parameter 3
|p3= conversationFile: [[String]] - .bikb file path, mandatory |= Parameter 3


|p4= filename.bikb: [[String]] - Must exist. bikb file name. |= Parameter 4
|p4= fsmFile: [[String]] - (Optional) .fsm file path |= Parameter 4
 
|p5= filename.fsm: [[String]] - Optional. Can be empty string. fsm file name |= Parameter 5
 
|p6= event_handler: [[Code]] or [[String]] - Optional. New to Arma2.


|p5= eventHandler: [[Code]] or [[String]] - (Optional) New to Arma2.
The event handler receives parameters:
The event handler receives parameters:
 
* '''_sentenceId:''' the sentence as defined in the .bikb file
<b>_sentenceId:</b> the sentence as defined in the .bikb file
* '''_topic:''' TopicName registered via kbAddTopic
 
* '''_this:''' the person that was talked to (receiver)
<b>_topic:</b> TopicName registered via kbAddTopic
* '''_from:''' the person that talked to the receiver and triggered the script  
 
<b>_this:</b> the person that was talked to (receiver)
 
<b>_from:</b> the person that talked to the receiver and triggered the script  
 
|= Parameter 6
|= Parameter 6


Line 39: Line 31:
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <pre>player kbAddtopic["myTest", "myTest.bikb", "myTest.fsm", {call compile preprocessFileLineNumbers "myTest.sqf"}];</pre>
|x1= <code>[[player]] [[kbAddTopic]] ["myTest", "myTest.bikb", "myTest.fsm", { execVM "myTest.sqf" }];</code> |= Example 1
 
|x2= <code>[[player]] [[kbAddTopic]] ["itsGettingWarm", "weatherTalk.bikb"];</code> |= Example 2


| [[kbRemoveTopic]], [[kbHasTopic]], [[kbTell]], [[FSM]] |= See also
| [[kbRemoveTopic]], [[kbHasTopic]], [[kbTell]], [[FSM]] |= See also

Revision as of 21:19, 26 March 2018

Logo A2.png1.00
Hover & click on the images for description

Description

Description:
Register conversation topic to given person.
Groups:
Uncategorised

Syntax

Syntax:
person kbAddTopic [topicName, conversationFile, fsmFile, eventHandler]
Parameters:
person: Object
topicName: String - the topic id for further reference
conversationFile: String - .bikb file path, mandatory
fsmFile: String - (Optional) .fsm file path
eventHandler: Code or String - (Optional) New to Arma2. The event handler receives 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
Return Value:
Nothing

Examples

Example 1:
player kbAddTopic ["myTest", "myTest.bikb", "myTest.fsm", { execVM "myTest.sqf" }];
Example 2:
player kbAddTopic ["itsGettingWarm", "weatherTalk.bikb"];

Additional Information

See also:
kbRemoveTopickbHasTopickbTellFSM

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

Notes

Mikero
  • .bikb extension is by convention only. It can be anything.
  • There is no default extension.
  • Even tho bikb's are standard class text they cannot be raPified.

Bottom Section

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