getSuppression: Difference between revisions
Jump to navigation
Jump to search
m (Text replacement - "\[\[Category:[cC]ommand[_ ][gG]roup:[_ ][^|]+\|\{*uc:{{PAGENAME}*]\]" to "") |
Lou Montana (talk | contribs) m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments( \("local" or "global"\))?|Effects|Multiplayer Effects( \("local" or "global"\))?|Multiplayer Exe...) |
||
| Line 1: | Line 1: | ||
{{Command | {{Command | ||
| arma3 | | arma3 | ||
|1.42 | |1.42 | ||
|arg= local | |arg= local | ||
|gr1= Object Manipulation | |gr1= Object Manipulation | ||
| Gets the suppression value for the given unit. Returns varying [[Number]] between 0 and 1, or -1 if suppression is disabled (<tt>[[disableAI]] "SUPPRESSION"</tt>) or the suppression value is not available. Suppression is not calculated for player entities and is always 0, unless it is set with [[setSuppression]]. In this case the return value is the set value. Before Arma 3 v1.91.145360 this command could return [[nil]].<br><br> | | Gets the suppression value for the given unit. Returns varying [[Number]] between 0 and 1, or -1 if suppression is disabled (<tt>[[disableAI]] "SUPPRESSION"</tt>) or the suppression value is not available. Suppression is not calculated for player entities and is always 0, unless it is set with [[setSuppression]]. In this case the return value is the set value. Before Arma 3 v1.91.145360 this command could return [[nil]].<br><br> | ||
{{Important | The unit must not be [[objNull]], must be [[local]] and [[alive]]}} | {{Important | The unit must not be [[objNull]], must be [[local]] and [[alive]]}} | ||
| '''getSuppression''' unit | | '''getSuppression''' unit | ||
|p1= unit: [[Object]] | |p1= unit: [[Object]] | ||
| [[Number]] - from 0 to 1, or -1 if suppression is not available. | | [[Number]] - from 0 to 1, or -1 if suppression is not available. | ||
|x1= <code> [[getSuppression]] AI_unit_1; | |x1= <code> [[getSuppression]] AI_unit_1; | ||
</code> | </code> | ||
| [[setSuppression]], [[suppressFor]], [[disableAI]], [[enableAI]] | | [[setSuppression]], [[suppressFor]], [[disableAI]], [[enableAI]] | ||
| |MPBEHAVIOUR= | | |MPBEHAVIOUR= | ||
Revision as of 00:39, 18 January 2021
Description
- Description:
- Gets the suppression value for the given unit. Returns varying Number between 0 and 1, or -1 if suppression is disabled (disableAI "SUPPRESSION") or the suppression value is not available. Suppression is not calculated for player entities and is always 0, unless it is set with setSuppression. In this case the return value is the set value. Before Arma 3 v1.91.145360 this command could return nil.
- Groups:
- Object Manipulation
Syntax
- Syntax:
- getSuppression unit
- Parameters:
- unit: Object
- Return Value:
- Number - from 0 to 1, or -1 if suppression is not available.
Examples
- Example 1:
getSuppression AI_unit_1;
Additional Information
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