BIS fnc kbTellLocal: Difference between revisions

Latest revision as of 17:00, 13 July 2022

1.00

0.50

GAGlobal LELocal

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.
⚠
This function is intended to be used by BIS_fnc_kbTell only.
Execution:: call
Groups:: Conversations

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:: Conversations kbTell BIS_fnc_kbCanSpeak BIS_fnc_kbCreateDummy BIS_fnc_kbIsSpeaking BIS_fnc_kbMenu BIS_fnc_kbPriority BIS_fnc_kbSentence BIS_fnc_kbSkip BIS_fnc_kbTell BIS_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

@@ Line 1: / Line 1: @@
+{{RV|type=function
-{{Function|= Comments
+|game1= tkoh
-____________________________________________________________________________________________
+|version1= 1.00
-| tkoh |= Game name
+|game2= arma3
+|version2= 0.50
-|1.00|= Game version
+|arg= global
-____________________________________________________________________________________________
-| ''N/A'' |= Description
+|eff= local|gr1= Conversations
-____________________________________________________________________________________________
-| <!-- [] call [[BIS_fnc_kbTellLocal]]; --> |= Syntax
+|descr= Play given sentence, disable radio and/or lower sounds. Will use [[BIS_fnc_showSubtitle]] for better effects if channel is DIRECT or VEHICLE.
+{{Feature | important | This function is intended to be used by [[BIS_fnc_kbTell]] only.}}
-|p1= |= Parameter 1
+|s1= [mode, parameters] call [[BIS_fnc_kbTellLocal]]
-| |= Return value
+|p1= mode: [[String]] - can be either "sentence", "conversationStart" or "conversationEnd"
-____________________________________________________________________________________________
-|x1= <code></code> |=
+|p2= parameters: [[Array]] - depends on the mode:
-____________________________________________________________________________________________
-| |= See also
+* "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
+|r1= [[Nothing]]
+|x1= <sqf>["sentence", [player, [BIS_HQ, "myTopic", "playerSentence1"]]] call BIS_fnc_kbTellLocal;</sqf>
-<h3 style="display:none">Notes</h3>
+|x2= <sqf>["conversationStart", [0.5, true]] call BIS_fnc_kbTellLocal;</sqf>
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
+|x3= <sqf>["conversationEnd", [0.5, true]] call BIS_fnc_kbTellLocal;</sqf>
-</dl>
-<h3 style="display:none">Bottom Section</h3>
+|seealso= [[Conversations]] [[kbTell]] [[BIS_fnc_kbCanSpeak]] [[BIS_fnc_kbCreateDummy]] [[BIS_fnc_kbIsSpeaking]] [[BIS_fnc_kbMenu]] [[BIS_fnc_kbPriority]] [[BIS_fnc_kbSentence]] [[BIS_fnc_kbSkip]] [[BIS_fnc_kbTell]] [[BIS_fnc_kbTopicConfig]]
-[[Category:Function Group: Conversations|{{uc:kbTellLocal}}]]
+}}
-[[Category:Functions|{{uc:kbTellLocal}}]]
-[[Category:{{Name|tkoh}}: Functions|{{uc:kbTellLocal}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:kbTellLocal}}]]