BIS_fnc_kbTellLocal

From Bohemia Interactive Community
Jump to: navigation, search
Introduced with Take On Helicopters version 1.00
  Arguments of this scripting function don't have to be local to the client the function is executed onEffects of this scripting function are not broadcasted over the network and remain local to the client the function is executed on

Click on the images for descriptions

Introduced in

Game:
Take On Helicopters
Version:
1.00

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

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

Execution:
call
Multiplayer:
-
See also:
ConversationskbTellBIS_fnc_kbCanSpeakBIS_fnc_kbCreateDummyBIS_fnc_kbIsSpeakingBIS_fnc_kbMenuBIS_fnc_kbPriorityBIS_fnc_kbSentenceBIS_fnc_kbSkipBIS_fnc_kbTellBIS_fnc_kbTopicConfig

Notes

Only post proven facts here. Report bugs on the feedback tracker. Use the talk page or the forums for discussions.
Add New Note | How To

Notes

Bottom Section