BIS fnc kbTellLocal: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (template:command argument fix)
Line 18: Line 18:
| [mode, parameters] call [[BIS_fnc_kbTellLocal]] |SYNTAX=
| [mode, parameters] call [[BIS_fnc_kbTellLocal]] |SYNTAX=


|p1= mode: [[String]] - can be either "sentence", "conversationStart" or "conversationEnd" |= Parameter 1
|p1= mode: [[String]] - can be either "sentence", "conversationStart" or "conversationEnd" |PARAMETER1=


|p2= parameters: [[Array]] - depends on the mode:
|p2= parameters: [[Array]] - depends on the mode:
Line 30: Line 30:
* "conversationEnd": [volumeCoefUsedInStart, disableRadioUsedInStart]
* "conversationEnd": [volumeCoefUsedInStart, disableRadioUsedInStart]
** volumeCoefUsedInStart: [[Number]] - a volume multiplier, shouldn't be used - if < 0 or >= 1, the volume won't be restored
** volumeCoefUsedInStart: [[Number]] - a volume multiplier, shouldn't be used - if < 0 or >= 1, the volume won't be restored
** disableRadioUsedInStart: [[Boolean]] - has the radio chat been disabled and should be restored |= Parameter 2
** disableRadioUsedInStart: [[Boolean]] - has the radio chat been disabled and should be restored |PARAMETER2=


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


|x1= <code>["sentence", <nowiki>[</nowiki>[[player]], [BIS_HQ, "myTopic", "playerSentence1"]]] [[call]] [[BIS_fnc_kbTellLocal]];</code> |= Example 1
|x1= <code>["sentence", <nowiki>[</nowiki>[[player]], [BIS_HQ, "myTopic", "playerSentence1"]]] [[call]] [[BIS_fnc_kbTellLocal]];</code> |EXAMPLE1=


|x2= <code>["conversationStart", [0.5, true]] [[call]] [[BIS_fnc_kbTellLocal]];</code> |= Example 2
|x2= <code>["conversationStart", [0.5, true]] [[call]] [[BIS_fnc_kbTellLocal]];</code> |EXAMPLE2=


|x3= <code>["conversationEnd", [0.5, true]] [[call]] [[BIS_fnc_kbTellLocal]];</code> |= Example 3
|x3= <code>["conversationEnd", [0.5, true]] [[call]] [[BIS_fnc_kbTellLocal]];</code> |EXAMPLE3=
____________________________________________________________________________________________
____________________________________________________________________________________________



Revision as of 14:30, 7 April 2019


Hover & click on the images for description

Description

Description:
Play given sentence, disable radio and/or lower sounds. Will use BIS_fnc_showSubtitle for better effects if channel is DIRECT or VEHICLE. Template:note
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
[mode, parameters] call BIS_fnc_kbTellLocal
Parameters:
mode: String - can be either "sentence", "conversationStart" or "conversationEnd"
parameters: Array - depends on the mode:
  • "sentence": same parameters as kbTell (receiver, topicName etc.)
  • "conversationStart": [volumeCoef, disableRadio]
    • volumeCoef: Number - a volume multiplier to reduce other sounds but the chat (0.1 = environment volume set to 10%)
    • disableRadio: Boolean - should the radio chat be disabled
  • "conversationEnd": [volumeCoefUsedInStart, disableRadioUsedInStart]
    • volumeCoefUsedInStart: Number - a volume multiplier, shouldn't be used - if < 0 or >= 1, the volume won't be restored
    • disableRadioUsedInStart: Boolean - has the radio chat been disabled and should be restored
Return Value:
Nothing

Examples

Example 1:
["sentence", [player, [BIS_HQ, "myTopic", "playerSentence1"]]] call BIS_fnc_kbTellLocal;
Example 2:
["conversationStart", [0.5, true]] call BIS_fnc_kbTellLocal;
Example 3:
["conversationEnd", [0.5, true]] call BIS_fnc_kbTellLocal;

Additional Information

See also:
ConversationskbTellBIS_fnc_kbCanSpeakBIS_fnc_kbCreateDummyBIS_fnc_kbIsSpeakingBIS_fnc_kbMenuBIS_fnc_kbPriorityBIS_fnc_kbSentenceBIS_fnc_kbSkipBIS_fnc_kbTellBIS_fnc_kbTopicConfig

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