BIS fnc sayMessage: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Text replacement - "= <code>([^<{]+)<\/code>" to "= <sqf>$1</sqf>")
 
(43 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.00


| arma3 |= Game name
|gr1= Sound


|1.00|= Game version
|arg= global
____________________________________________________________________________________________


| <pre>/*
|eff= local


Description:
|descr= Make a speaker say a message.
Play radio message.


Parameter(s):
|s1= [speaker, message, channel] call [[BIS_fnc_sayMessage]]
0:
OBJECT - speaker
SIDE - side HQ (created by "Headquarters Entity" module)
1: STRING - message
2: STRING or NUMBER - channel ("say3D", "direct", "group", "vehicle", "side", "command", "global" or custom channel ID; default is "side")


Returns:
|p1= speaker: [[Object]] or [[Side]]
BOOL
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|p2= message: [[String]] - must be defined in either [[Description.ext#CfgSounds|CfgSounds]] or [[Description.ext#CfgRadio|CfgRadio]]
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_sayMessage]]; --> |= Syntax
|p3= channel: [[String]] or [[Number]] - (Optional, default "side") can be "say3D", "direct", "group", "vehicle", "side", "command", "global", or custom channel ID


|p1= |= Parameter 1
|r1= [[Boolean]] - [[true]] when done


| |= Return value
|x1= <sqf>[leader player, "to_c01_m01_brief_001_br_briefing_a_CENTAUR_0", "say3D"] call BIS_fnc_sayMessage;</sqf>
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


|seealso= [[say]] [[say3D]] [[directSay]] [[groupRadio]] [[vehicleRadio]] [[sideRadio]] [[commandRadio]] [[globalRadio]] [[customRadio]]
}}
}}
<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: MP|{{uc:sayMessage}}]]
[[Category:Functions|{{uc:sayMessage}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:sayMessage}}]]

Latest revision as of 18:00, 13 July 2022

Hover & click on the images for description

Description

Description:
Make a speaker say a message.
Execution:
call
Groups:
Sound

Syntax

Syntax:
[speaker, message, channel] call BIS_fnc_sayMessage
Parameters:
speaker: Object or Side
message: String - must be defined in either CfgSounds or CfgRadio
channel: String or Number - (Optional, default "side") can be "say3D", "direct", "group", "vehicle", "side", "command", "global", or custom channel ID
Return Value:
Boolean - true when done

Examples

Example 1:
[leader player, "to_c01_m01_brief_001_br_briefing_a_CENTAUR_0", "say3D"] call BIS_fnc_sayMessage;

Additional Information

See also:
say say3D directSay groupRadio vehicleRadio sideRadio commandRadio globalRadio customRadio

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