kbReact: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(*finally* understood what this command does! Add description and example)
m (template:command argument fix)
Line 11: Line 11:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Pass a non-verbal communication to the receiver. This command does '''as if''' the sentence was said and triggers the reaction scripts (AI FSM or player's conversation EH). See [[Conversations]] for more details. |= Description
| Pass a non-verbal communication to the receiver. This command does '''as if''' the sentence was said and triggers the reaction scripts (AI FSM or player's conversation EH). See [[Conversations]] for more details. |DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


| person [[kbReact]] [receiver, topicName, sentenceID(, argumentArray1, argumentArray2, …)] |= Syntax
| person [[kbReact]] [receiver, topicName, sentenceID(, argumentArray1, argumentArray2, …)] |SYNTAX=


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


|p2= [receiver, topicName, sentenceID, argumentArray1, argumentArray2, …]: [[Array]] |= Parameter 2
|p2= [receiver, topicName, sentenceID, argumentArray1, argumentArray2, …]: [[Array]] |PARAMETER2=


|p3= receiver: [[Object]] |= Parameter 3
|p3= receiver: [[Object]] |PARAMETER3=


|p4= topicName: [[String]] |= Parameter 4
|p4= topicName: [[String]] |PARAMETER4=


|p5= sentenceID: [[String]] |= Parameter 5
|p5= sentenceID: [[String]] |PARAMETER5=


|p6= argumentArray1toN (Optional): [[Array]] - [argumentName, argumentValue, argumentText, argumentSpeech]:
|p6= argumentArray1toN (Optional): [[Array]] - [argumentName, argumentValue, argumentText, argumentSpeech]:
Line 30: Line 30:
* argumentValue: [[Code]]
* argumentValue: [[Code]]
* argumentText: [[String]]
* argumentText: [[String]]
* argumentSpeech: [[Array]] of [[String|Strings]] - each string is an already defined word in config. |= Parameter 6
* argumentSpeech: [[Array]] of [[String|Strings]] - each string is an already defined word in config. |PARAMETER6=


| [[Nothing]] |= Return value
| [[Nothing]] |RETURNVALUE=


|x1= <code>unit1 [[kbReact]] [unit2, "topicName", "speech1"];
|x1= <code>unit1 [[kbReact]] [unit2, "topicName", "speech1"];
{{codecomment|will trigger '''as if''' unit1 said the sentence (''via'' [[kbTell]])
{{codecomment|will trigger '''as if''' unit1 said the sentence (''via'' [[kbTell]])
// unit2's FSM will [[kbReact|react]] accordingly.}}</code>|= Example 1
// unit2's FSM will [[kbReact|react]] accordingly.}}</code>|EXAMPLE1=


____________________________________________________________________________________________
____________________________________________________________________________________________


| [[Conversations]], [[kbAddTopic]], [[kbHasTopic]], [[kbTell]], [[kbWasSaid]], [[kbRemoveTopic]], [[kbAddDatabase]], [[kbAddDatabaseTargets]], [[FSM]], [[FSM Editor]] |= See also
| [[Conversations]], [[kbAddTopic]], [[kbHasTopic]], [[kbTell]], [[kbWasSaid]], [[kbRemoveTopic]], [[kbAddDatabase]], [[kbAddDatabaseTargets]], [[FSM]], [[FSM Editor]] |SEEALSO=
____________________________________________________________________________________________
____________________________________________________________________________________________
}}
}}

Revision as of 14:42, 7 April 2019

Hover & click on the images for description

Description

Description:
Pass a non-verbal communication to the receiver. This command does as if the sentence was said and triggers the reaction scripts (AI FSM or player's conversation EH). See Conversations for more details.
Groups:
Uncategorised

Syntax

Syntax:
person kbReact [receiver, topicName, sentenceID(, argumentArray1, argumentArray2, …)]
Parameters:
person: Object
[receiver, topicName, sentenceID, argumentArray1, argumentArray2, …]: Array
receiver: Object
topicName: String
sentenceID: String
argumentArray1toN (Optional): Array - [argumentName, argumentValue, argumentText, argumentSpeech]:
  • argumentName: String
  • argumentValue: Code
  • argumentText: String
  • argumentSpeech: Array of Strings - each string is an already defined word in config.
Return Value:
Nothing

Examples

Example 1:
unit1 kbReact [unit2, "topicName", "speech1"]; will trigger as if unit1 said the sentence (via kbTell) // unit2's FSM will react accordingly.

Additional Information

See also:
ConversationskbAddTopickbHasTopickbTellkbWasSaidkbRemoveTopickbAddDatabasekbAddDatabaseTargetsFSMFSM 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

Notes

Bottom Section