Difference between revisions of "VN ms fnc sfx playRadioConv"

From Savage Game Design Wiki
Jump to navigation Jump to search
m (Text replacement - " {{Function" to "Category:TODO {{Function")
(Page filling)
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
−
[[Category:TODO]]
 
 
{{Function
 
{{Function
  
Line 12: Line 11:
 
|g1= sfx
 
|g1= sfx
  
−
|d= <pre>/*
+
|d= Plays the given radio message via text and audio from the given entity. Will use {{Biki|playSound}} or {{Biki|globalRadio}}/{{Biki|sideRadio}} depending on provided arguments.
−
    Author: Wyqer, veteran29
 
−
    Date: 2019-08-08
 
  
−
    Description:
+
|s= [stringtableKey, soundClass, speaker, useGlobalChannel, isRadio] call [[VN_ms_fnc_sfx_playRadioConv]]
−
        Plays the given radio message via text and audio from the given entity.
 
  
−
    Parameter(s):
+
|p1n= stringtableKey
−
        _text      - Localization key for text                            [STRING, defaults to ""]
+
|p1t= string
−
        _sound      - Configname of the audio message                      [STRING, defaults to ""]
+
|p1d= text's localisation key - '''not''' the text itself
−
        _entity    - Entity to play the message from                      [OBJECT, defaults to objNull]
+
|p1v=
−
        _global    - Switch to use global channel instead of side channel  [BOOL, defaults to false]
 
−
        _isRadio    - Switch to either play it via radio or sound          [BOOL, defaults to true]
 
  
−
    Returns:
+
|p2n= soundClass
−
        Function reached the end [BOOL]
+
|p2t= string
−
*/
+
|p2d= {{Biki|Description.ext#CfgRadio|CfgRadio}} or {{Biki|Description.ext#CfgSounds|CfgSounds}} entry
 +
|p2v=
  
−
</pre><small>''(Placeholder description extracted from the function header by '''LM_exportFunctionsToWiki.sqf''')''</small>
+
|p3n= speaker
 +
|p3t= object
 +
|p3d= sound source
 +
|p3v=
  
−
|s= [] call [[vn_ms_fnc_sfx_playRadioConv]];
+
|p4n= useGlobalChannel
 +
|p4t= boolean
 +
|p4d= if ''isRadio'', use {{Biki|globalRadio}} instead of {{Biki|sideRadio}}
 +
|p4v= false
  
−
|p1n=
+
|p5n= isRadio
−
|p1t=
+
|p5t= boolean
−
|p1d=
+
|p5d= sets if radio channel is used, else uses {{Biki|playSound}}
−
|p1v=
+
|p5v= true
−
 
 
−
|p2n=
 
−
|p2t=
 
−
|p2d=
 
−
|p2v=
 
  
−
|r1t=
+
|r1t= boolean
−
|r1d=
+
|r1d= function's success
  
−
|x1= <code>-</code>
+
|x1= <code>["STR_MySentence", "MyCfgSoundsEntry", player, true, false] call [[VN_ms_fnc_sfx_playRadioConv]];</code>
 
}}
 
}}

Latest revision as of 18:01, 22 February 2021

← back to Functions Introduced in S.O.G. Prairie Fire v1.00
by Wyqer, veteran29
Argument(s): n/a
Effect(s): unknown

Description

Plays the given radio message via text and audio from the given entity. Will use playSound or globalRadio/sideRadio depending on provided arguments.

Syntax

Syntax
[stringtableKey, soundClass, speaker, useGlobalChannel, isRadio] call VN_ms_fnc_sfx_playRadioConv
Parameters
stringtableKey: String - text's localisation key - not the text itself
soundClass: String - CfgRadio or CfgSounds entry
speaker: Object - sound source
useGlobalChannel: Boolean - (Optional, default false) if isRadio, use globalRadio instead of sideRadio
isRadio: Boolean - (Optional, default true) sets if radio channel is used, else uses playSound
Return value
Boolean - function's success

Examples

Example 1
["STR_MySentence", "MyCfgSoundsEntry", player, true, false] call VN_ms_fnc_sfx_playRadioConv;
Retrieved from "https://wiki.sogpf.com/index.php?title=VN_ms_fnc_sfx_playRadioConv&oldid=4074"