isNull

From Bohemia Interactive Community
Revision as of 21:32, 19 September 2024 by Lou Montana (talk | contribs) (Some wiki formatting)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
Hover & click on the images for description

Description

Description:
Checks whether the tested item is null.
Which null type the item has to be equal to depends on the type of game entity tested:
Type Object Group Control Display Location Task Script Config Diary Record Team Member
Null value objNull grpNull controlNull displayNull locationNull taskNull scriptNull configNull diaryRecordNull teamMemberNull
Since Logo A0.png1.00 Logo A1 black.png1.00 Logo A2.png1.00 Arma 3 logo black.png1.30 Arma 3 logo black.png1.54 Arma 3 logo black.png2.00 Arma 3 logo black.png2.10
A test via == does not work because a null value is not equal to anything, not even itself (configNull being the exception). See also isEqualTo.
Groups:
Variables

Syntax

Syntax:
isNull entity
Parameters:
entity: Object, Control, Display, Group, Location, Task, Script Handle, Config or Diary Record
Return Value:
Boolean

Examples

Example 1:
if (isNil "obj") exitWith { hint "obj variable is undefined" }; if (isNull obj) then { hint "obj variable is defined but is null"; } else { hint "obj variable is defined and is not null"; };
Example 2:
Diary Record support before Arma 3 logo black.png2.00:
private _nullRecord = objNull createDiaryRecord []; // wrong parameters = failure to create a record = null value private _createdRecord = player createDiaryRecord ["Diary", ["title", "description"]]; if (_createdRecord isEqualTo _nullRecord) then { hint "Failed" };
Team Member support before Arma 3 logo black.png2.10:
private _isNull = _teamMember isEqualTo teamMemberNull;

Additional Information

See also:
controlNull displayNull grpNull locationNull objNull taskNull teamMemberNull scriptNull configNull typeName

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