BIS fnc kbTellLocal: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|arg= global |=" to "|arg= global |MParg=")
m (Text replacement - "= <code>([^<{]+)<\/code>" to "= <sqf>$1</sqf>")
 
(43 intermediate revisions by 2 users not shown)
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


|arg= global |MParg=  
|eff= local|gr1= Conversations


|eff= local |=
|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.}}


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


| [mode, parameters] call [[BIS_fnc_kbTellLocal]] |SYNTAX=
|p1= mode: [[String]] - can be either "sentence", "conversationStart" or "conversationEnd"
 
|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 28:
* "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 |PARAMETER2=
** disableRadioUsedInStart: [[Boolean]] - has the radio chat been disabled and should be restored


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


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


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


|x3= <code>["conversationEnd", [0.5, true]] [[call]] [[BIS_fnc_kbTellLocal]];</code> |EXAMPLE3=
|x3= <sqf>["conversationEnd", [0.5, true]] call BIS_fnc_kbTellLocal;</sqf>
____________________________________________________________________________________________
 
| [[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=


|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]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Conversations|{{uc:kbTellLocal}}]]
[[Category:Functions|{{uc:kbTellLocal}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:kbTellLocal}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:kbTellLocal}}]]

Latest revision as of 17:00, 13 July 2022

tkoh logo small.png1.00Arma 3 logo black.png0.50
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.
⚠
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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_kbTellLocal&oldid=328389"