getSuppression: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "\{\{GameCategory\|(arma[0123])\|[ _]?New[ _]Scripting[ _]Commands[ _]List\}\}" to "{{GameCategory|$1|New Scripting Commands}}") |
Lou Montana (talk | contribs) m (Text replacement - "<sqf>([^ ]+) <\/sqf>" to "<sqf>$1</sqf>") |
||
| (30 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{ | {{RV|type=command | ||
| arma3 | | |game1= arma3 | ||
|version1= 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 ( | |descr= Gets the suppression value for the given unit. Returns varying [[Number]] between 0 and 1, or -1 if suppression is disabled ({{hl|[[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.92 this command could return [[nil]].<br><br> | ||
{{ | {{Feature | important | The unit must not be [[objNull]], must be [[Multiplayer Scripting#Locality|local]] and [[alive]]}} | ||
| | |s1= [[getSuppression]] unit | ||
|p1= unit: [[Object]] | |p1= unit: [[Object]] | ||
| [[Number]] - from 0 to 1, or -1 if suppression is not available. | |r1= [[Number]] - from 0 to 1, or -1 if suppression is not available. | ||
|x1= < | |x1= <sqf>getSuppression AI_unit_1;</sqf> | ||
</ | |||
|seealso= [[setSuppression]] [[suppressFor]] [[disableAI]] [[enableAI]] | |||
| [[setSuppression]] | |||
}} | }} | ||
Latest revision as of 11:04, 13 May 2022
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.92 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
- See also:
- setSuppression suppressFor disableAI enableAI
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