BIS fnc genericSentence: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " it's" to " it is")
mNo edit summary
Line 16: Line 16:
|p2= speaker (Optional): [[Object]] or [[Code]] - sentence speaker (when code, speaker is it is returned value). Default is 2nd [[crew]] member. |Parameter2=
|p2= speaker (Optional): [[Object]] or [[Code]] - sentence speaker (when code, speaker is it is returned value). Default is 2nd [[crew]] member. |Parameter2=


|p3= delay (Optional): [[Number]] - delay from previous generic sentence: When negative, sentence is played always. |=
|p3= delay (Optional): [[Number]] - delay from previous generic sentence: When negative, sentence is played always. |PARAMETER3=


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


| [[Boolean]] - true if sentence was played |RETURNVALUE=
| [[Boolean]] - true if sentence was played |RETURNVALUE=
Line 25: Line 25:
|x1= <code>["FeedbackFlightNegativeHeightTooHigh"] call bis_fnc_genericSentence;</code> |EXAMPLE1=
|x1= <code>["FeedbackFlightNegativeHeightTooHigh"] call bis_fnc_genericSentence;</code> |EXAMPLE1=


|x2= <code>["FeedbackFlightNegativeSpeedTooSlow",nil,5,true] call bis_fnc_genericSentence;</code> |EXAMPLE1=
|x2= <code>["FeedbackFlightNegativeSpeedTooSlow",nil,5,true] call bis_fnc_genericSentence;</code> |EXAMPLE2=
____________________________________________________________________________________________
____________________________________________________________________________________________



Revision as of 09:20, 25 September 2020

Hover & click on the images for description

Description

Description:
Play generic sentence with probablity set by bis_genericSentenceMode variable (0.5 = 50%, 1 = 100%)
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
[class,(speaker,delay,canRepeat)] call BIS_fnc_genericSentence;
Parameters:
class: String - sentence name (from class RadioProtocol_EN_H)
speaker (Optional): Object or Code - sentence speaker (when code, speaker is it is 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:
Boolean - true if sentence was played

Examples

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

Additional Information

See also:
Generic Sentences

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