BIS fnc kbTellLocal: Difference between revisions

From Bohemia Interactive Community
m (1 revision)
(Page filling)
Line 6: Line 6:


|1.00|= Game version
|1.00|= Game version
|arg= global |=
|eff= local |=
____________________________________________________________________________________________
____________________________________________________________________________________________


| ''N/A'' |= Description
| Play given sentence, disable radio and/or lower sounds. Will use [[BIS_fnc_showSubtitle]] for better effects if channel is DIRECT or VEHICLE.
{{note|This function is intended to be used by [[BIS_fnc_kbTell]] only}} |= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_kbTellLocal]]; --> |= Syntax
| [mode, parameters] call [[BIS_fnc_kbTellLocal]] |= Syntax
 
|p1= mode: [[String]] - can be either "sentence", "conversationStart" or "conversationEnd" |= Parameter 1
 
|p2= 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


|p1= |= Parameter 1
* "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 |= Parameter 2


| |= Return value
| [[Nothing]] |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code></code> |=  
|x1= <code>["sentence", <nowiki>[</nowiki>[[player]], [BIS_HQ, "myTopic", "playerSentence1"]]] [[call]] [[BIS_fnc_kbTellLocal]];</code> |= Example 1
 
|x2= <code>["conversationStart", [0.5, true]] [[call]] [[BIS_fnc_kbTellLocal]];</code> |= Example 2
 
|x3= <code>["conversationEnd", [0.5, true]] [[call]] [[BIS_fnc_kbTellLocal]];</code> |= Example 3
____________________________________________________________________________________________
____________________________________________________________________________________________


| |= 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]] |= See also


}}
}}

Revision as of 00:44, 4 April 2018


tkoh logo small.png 1.00
GAGlobalLELocal
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

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