isNull: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "[[Category:Scripting Commands ArmA|" to "[[Category:Scripting Commands Armed Assault|")
(Fix description, categories, notes, add diaryRecordNull)
Line 9: Line 9:
____________________________________________________________________________________________
____________________________________________________________________________________________


|   Checks whether the tested item is Null.<br>
| Checks whether the tested item is null.<br>
Which null type the item has to be equal to depends on the type of game entity tested:<br>
Which null type the item has to be equal to depends on the type of game entity tested:
* [[Object]]s -> [[objNull]]
* [[Control]]s -> [[controlNull]]
* [[Display]]s -> [[displayNull]]
* [[Group]]s -> [[grpNull]]
* [[Location]]s -> [[locationNull]] (since ARMA 2)
* [[Task]]s -> [[taskNull]] (since ARMA 2)
* [[Script]]s -> [[scriptNull]] (since Arma 3 1.29.127075)
* [[Config]]s -> [[configNull]] (since Arma 3 1.53.133130)


Note: A test via <nowiki>==</nowiki> does not work, because, for example, [[objNull]] is not equal to anything, not even to itself. Use [[isEqualTo]]. |DESCRIPTION=
{{{!}} class{{=}}"wikitable" style{{=}}"text-align: center"
! [[:Category:Data Types|Type]]
{{!}} [[Object]]
{{!}} [[Group]]
{{!}} [[Control]]
{{!}} [[Display]]
{{!}} [[Location]]
{{!}} [[Task]]
{{!}} [[Script]]
{{!}} [[Config]]
{{!}} [[Diary Record]]
{{!}}-
! Null value
{{!}} [[objNull]]
{{!}} [[grpNull]]
{{!}} [[controlNull]]
{{!}} [[displayNull]]
{{!}} [[locationNull]]
{{!}} [[taskNull]]
{{!}} [[scriptNull]]
{{!}} [[configNull]]
{{!}} [[diaryRecordNull]]
{{!}}- style{{=}}"font-size: .85em"
! Since
{{!}} {{Name|ofp|short}} v1.00
{{!}} {{Name|ofp|short}} v1.00
{{!}} {{Name|arma|short}} v1.00
{{!}} {{Name|arma|short}} v1.00
{{!}} {{Name|arma2|short}} v1.00
{{!}} {{Name|arma2|short}} v1.00
{{!}} {{Name|arma3|short}} v1.29.127075
{{!}} {{Name|arma3|short}} v1.53.133130
{{!}} {{Name|arma3|short}} v1.99.146508
{{!}}}
 
{{Important | 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]].}} |DESCRIPTION=
 
|pr= [[teamMemberNull]] for [[Team Member]] type is '''not''' supported. Use {{Inline code|[[private]] _isNull {{=}} _teamMember [[isEqualTo]] [[teamMemberNull]]}} instead. |PROBLEMS=
____________________________________________________________________________________________
____________________________________________________________________________________________


| '''isNull''' entity |SYNTAX=
| [[isNull]] entity |SYNTAX=


|p1 = entity: [[Object]], [[Control]], [[Display]], [[Group]] (or [[Location]], [[Task]] since ARMA 2 (or [[Script]] since Arma 3 1.29.127075)) |PARAMETER1=
|p1 = entity: [[Object]], [[Control]], [[Display]], [[Group]], [[Location]], [[Task]], [[Script]], [[Config]] or [[Diary Record]] |PARAMETER1=


| [[Boolean]] |RETURNVALUE=
| [[Boolean]] |RETURNVALUE=
Line 33: Line 63:


| [[controlNull]], [[displayNull]], [[grpNull]], [[locationNull]], [[objNull]], [[taskNull]], [[teamMemberNull]], [[scriptNull]], [[configNull]], [[typeName]]|SEEALSO=
| [[controlNull]], [[displayNull]], [[grpNull]], [[locationNull]], [[objNull]], [[taskNull]], [[teamMemberNull]], [[scriptNull]], [[configNull]], [[typeName]]|SEEALSO=
}}
}}


Line 43: Line 72:


<h3 style="display:none">Bottom Section</h3>
<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands|ISNULLOBJ]]
[[Category:Scripting Commands OFP 1.46|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.96|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.96|ISNULLOBJ]]
[[Category:Scripting Commands Armed Assault|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.46|ISNULLOBJ]]
[[Category:Scripting Commands Armed Assault|ISNULLOBJ]]
[[Category:Command_Group:_Object_Information|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Variables|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
 
[[Category:Command Group: Object Information|{{uc:{{PAGENAME}}}}]]
<!-- CONTINUE Notes -->
[[Category:Command Group: Variables|{{uc:{{PAGENAME}}}}]]
<dl class="command_description">
<dd class="notedate">Posted on December 9, 2015 - 11:29 (UTC)</dd>
<dt class="note">[[User:Commy2|Commy2]]</dt>
<dd class="note">
isNull does not work with the TEAM_MEMBER type.
Use this instead:
<code>_tmember isEqualTo teamMemberNull</code>
</dd>
</dl>
<!-- DISCONTINUE Notes -->
 
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on December 9, 2015 - 11:38 (UTC)</dd>
<dt class="note">[[User:Commy2|Commy2]]</dt>
<dd class="note">
The note in the description does not apply to the CONFIG type, probably due to backwards compatibility.<br>
<code>configNull == configNull
-> true
</code>
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Revision as of 19:08, 9 July 2020

Logo A0.png1.00
GAGlobal
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
Null value objNull grpNull controlNull displayNull locationNull taskNull scriptNull configNull diaryRecordNull
Since OFP v1.00 OFP v1.00 Arma v1.00 Arma v1.00 Arma 2 v1.00 Arma 2 v1.00 Arma 3 v1.29.127075 Arma 3 v1.53.133130 Arma 3 v1.99.146508
⚠
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.
Problems:
teamMemberNull for Team Member type is not supported. Use private _isNull = _teamMember isEqualTo teamMemberNull instead.
Groups:
Uncategorised

Syntax

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

Examples

Example 1:
if (isNull obj) then {hint "doesn't exist";};

Additional Information

See also:
controlNulldisplayNullgrpNulllocationNullobjNulltaskNullteamMemberNullscriptNullconfigNulltypeName

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

Retrieved from "https://community.bistudio.com/wiki?title=isNull&oldid=155134"