BIS fnc genericSentence: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Created page with "genericSentence {{Function|= Comments ____________________________________________________________________________________________ | ...")
Line 1: Line 1:
 
[[Category:Take_On_Helicopters:_Functions|genericSentence]]
{{Function|= Comments
{{Function|= Comments
____________________________________________________________________________________________
____________________________________________________________________________________________


| tkoh |= Game name
| TKOH |= Game name


|1.00|= Game version
|1.00|= Game version
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>/*
| Play generic sentence with probablity set by bis_genericSentenceMode variable (0.5 = 50%, 1 = 100%) |= Description
 
____________________________________________________________________________________________
Description:
Play generic sentence with probablity set by bis_genericSentenceMode variable (0.5 = 50%, 1 = 100%)


Parameter(s):
| [class,(speaker,delay,canRepeat)] call BIS_fnc_genericSentence; |= Syntax
_this select 0: STRING - sentence name
_this select 1 (Optional): OBJECT or CODE - speaker (when code, speaker is it's returned value)
_this select 2 (Optional): NUMBER - delay from previous generic sentence: When negative, sentence is played always.
_this select 3 (Optional): BOOL - true to allow repeating same sentence


Returns:
|p1= class: [[String]] - sentence name (from ''class RadioProtocol_EN_H'') |=
BOOL - true if sentence was played
*/


//--- No radio channel - terminate (client) or initialize (server)
|p2= speaker (Optional): [[Object]] or [[Code]] - sentence speaker (when code, speaker is it's returned value). Default is 2nd [[crew]] member. |=
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_genericSentence]]; --> |= Syntax
|p3= delay (Optional): [[Number]] - delay from previous generic sentence: When negative, sentence is played always. |=


|p1= |= Parameter 1
|p4= canRepeat (Optional): [[Boolean]] - true to allow repeating same sentence |=


| |= Return value
| [[Boolean]] - true if sentence was played |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________
 
|x1= <code>["FeedbackFlightNegativeHeightTooHigh"] call bis_fnc_genericSentence;</code> |= Example 1


|x1= <code></code> |=  
|x2= <code>["FeedbackFlightNegativeSpeedTooSlow",nil,5,true] call bis_fnc_genericSentence;</code> |= Example 1
____________________________________________________________________________________________
____________________________________________________________________________________________


Line 49: Line 41:


<h3 style="display:none">Bottom Section</h3>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Conversations|{{uc:genericSentence}}]]
[[Category:Functions|{{uc:genericSentence}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:genericSentence}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:genericSentence}}]]

Revision as of 10:36, 24 October 2011


Hover & click on the images for description

Description

Description:
[class,(speaker,delay,canRepeat)] call BIS_fnc_genericSentence;
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
Boolean - true if sentence was played
Parameters:
class: String - sentence name (from class RadioProtocol_EN_H)
speaker (Optional): Object or Code - sentence speaker (when code, speaker is it's returned value). Default is 2nd crew member.
delay (Optional): Number - delay from previous generic sentence: When negative, sentence is played always.
canRepeat (Optional): Boolean - true to allow repeating same sentence
Return Value:
Return value needed

Examples

Example 1:
["FeedbackFlightNegativeHeightTooHigh"] call bis_fnc_genericSentence;
Example 2:
["FeedbackFlightNegativeSpeedTooSlow",nil,5,true] call bis_fnc_genericSentence;

Additional Information

See also:
See also needed

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