getSuppression

From Bohemia Interactive Community
Revision as of 12:04, 13 May 2022 by Lou Montana (talk | contribs) (Text replacement - "<sqf>([^ ]+) <\/sqf>" to "<sqf>$1</sqf>")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
Hover & click on the images for description

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.

The unit must not be objNull, must be local and alive
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