BIS fnc kbTellLocal: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Remove note template usage)
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{Function|Comments=
{{Function|Comments=
____________________________________________________________________________________________


| tkoh |Game name=
| tkoh |Game name=
Line 11: Line 10:


|gr1 = Conversations |GROUP1=
|gr1 = Conversations |GROUP1=
____________________________________________________________________________________________


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


| [mode, parameters] call [[BIS_fnc_kbTellLocal]] |SYNTAX=
| [mode, parameters] call [[BIS_fnc_kbTellLocal]] |SYNTAX=
Line 34: Line 31:


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


|x1= <code>["sentence", [<nowiki/>[[player]], [BIS_HQ, "myTopic", "playerSentence1"]]] [[call]] [[BIS_fnc_kbTellLocal]];</code> |EXAMPLE1=
|x1= <code>["sentence", [<nowiki/>[[player]], [BIS_HQ, "myTopic", "playerSentence1"]]] [[call]] [[BIS_fnc_kbTellLocal]];</code> |EXAMPLE1=
Line 41: Line 37:


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


| [[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]] |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]] |SEEALSO=

Revision as of 23:25, 16 January 2021

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:
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