isNil: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(formatting, added see also)
m (2.16 -> 2.18)
 
(82 intermediate revisions by 10 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma |= Game name
|game1= arma1
|version1= 1.00


|1.00|= Game version
|game2= arma2
____________________________________________________________________________________________
|version2= 1.00


| Tests whether the variable defined by the [[String]] argument is undefined, or whether an expression result passed as [[Code]] is undefined.
|game3= arma2oa
<br>The command returns [[true]] if the variable or the expression result is undefined (i.e. the expression result is [[Void]]), and [[false]] in all other cases. |= Description
|version3= 1.50
____________________________________________________________________________________________


| '''isnil''' variable |= Syntax
|game4= tkoh
|version4= 1.00


|p1= variable: [[String]] or [[Code]]|= Parameter 1
|game5= arma3
|version5= 0.50


| [[Boolean]] |= Return value
|gr1= Variables
____________________________________________________________________________________________


|x1 = <code>[[if]] ([[isNil]] "_pokus") [[then]] {
|descr= Tests whether a variable is [[nil]] or undefined from its [[Identifier|identifier]], or whether the given expression evaluates to [[nil]] or [[Nothing]].
    _pokus = 0;
{{Feature|arma0|This command does not exist in {{ofp}}/{{arma0}} but can be emulated (see {{Link|#Example 5}}).}}
};</code>|= Example1
____________________________________________________________________________________________


| [[nil]], [[Variables]] |= See also
|s1= [[isNil]] variableName


}}
|p1= variableName: '''[[String]]''' - [[missionNamespace]]'s or local [[Variables|variable]]'s [[Identifier|identifier]] (e.g "globalVariable", "_localVariable")


<h3 style="display:none">Notes</h3>
|r1= [[Boolean]] - [[true]] if variable is [[nil]] or undefined
<dl class="command_description">
<!-- Note Section BEGIN -->


|s2= [[isNil]] code


<dt class="note">'''[[User:ColonelSandersLite|ColonelSandersLite]]'''
|p21= code: [[Code]] - code to evaluate:
<dd class="note"><br>
* the code '''will''' be executed; <sqf inline>isNil { player setDamage 1 };</sqf> ''will'' kill the player
I recently had a strange experience with this command.  I forgot to wrap the name of the variable with quotes, and it returned the opposite of the true null status of the variable.  Just something to watch out for.
* the code will not be allowed to [[canSuspend|suspend]] while expression is evaluated, even if the parent scope allows it (see {{Link|#Example 4}}).


|r2= [[Boolean]] - [[true]] if ''code'' returns [[Nothing]], [[false]] otherwise


<dt class="note">'''[[User:General_Barron|General Barron]]'''
|s3= namespace [[isNil]] variableName
<dd class="note"><br>
|s3since= arma3 2.18
^ If you don't wrap the name of the variable in quotes, then it will instead read the value of the variable itself. If that variable is a string or code, then the command will use that string or code held by the variable. Example:
|p41= namespace: [[Namespace]], [[Object]], [[Group]] or [[HashMap]]
|p42= variableName: [[String]]  
|r3= [[Boolean]] - [[true]] if variable is [[nil]] or undefined


<pre>_myvar = "_hisvar";
|x1= <sqf>
isnil _myvar;
if (isNil "TAG_globalVariable") then { TAG_globalVariable = 0 };
//will return true if _hisvar is null
if (isNil "_localVariable") then { hint "_localVariable is nil" };
_myvar = {tank1};
</sqf>
sleep (random 50);
isnil _myvar;
//will return if tank1 is nil, at the time the isnil command is checked (not at the time _myvar is established)
</pre>
--[[User:General Barron|General Barron]] 10:37, 30 December 2009 (CET)


|x2= <sqf>isNil { player getVariable "someVar" };</sqf>


<dt class="note">'''[[User:Igneous01|Igneous01]]'''
|x3= <sqf>
<dd class="note"><br>
_myArray = [0, 1];
isNil is also able to check if an expression is undefined. As such, an alternative way to check variables would be:
isNil { _myArray select 0 }; // returns false
<pre>
isNil { _myArray select 1 }; // returns false
isNil {variable}
isNil { _myArray select 2 }; // returns true
</pre>
isNil { _myArray select 3 }; // throws a script error. only length+1 select is allowed
</sqf>


you can use this method to also check if variables defined using setVariable exist as well:
|x4= This trick forces executing something in [[Scheduler|Unscheduled Environment]]:
<pre>
<sqf>
isNil {player getVariable "Something"}
0 spawn {
</pre>
systemChat str canSuspend; // chat shows true
 
isNil { hint str canSuspend }; // hint shows false
As well as testing if a function returns a value
<pre>
func_ChangeVehicleName =
{
  _this setVehicleVarName "newName";
};
};
</sqf>


if (isNil {player call func_ChangeVehicleName})   // returns true, because this function does not return anything
|x5= {{ofp}} [[String]] comparison workaround<br>
</pre>
[[SQS Syntax]]:
<sqs>
_nil = format ["%1", _undefinedVariable]
? (format ["%1", variableToTest] == _nil) : hint "variableToTest is nil"
</sqs>


[[SQF Syntax]]:
<!-- Note Section END -->
<sqf>
</dl>
_nil = format ["%1", _undefinedVariable];
if (format ["%1", variableToTest] == _nil) then { hint "variableToTest is nil" };
</sqf>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[nil]] [[Variables]] [[Scheduler]]
[[Category:Scripting Commands|ISNIL]]
}}
[[Category:Scripting Commands ArmA|ISNIL]]
[[Category:Command_Group:_Object_Information|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Variables|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]

Latest revision as of 15:03, 8 February 2024

Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
Tests whether a variable is nil or undefined from its identifier, or whether the given expression evaluates to nil or Nothing.
Operation Flashpoint
This command does not exist in Operation Flashpoint/Arma: Cold War Assault but can be emulated (see Example 5).
Groups:
Variables

Syntax 1

Syntax:
isNil variableName
Parameters:
variableName: String - missionNamespace's or local variable's identifier (e.g "globalVariable", "_localVariable")
Return Value:
Boolean - true if variable is nil or undefined

Syntax 2

Syntax:
isNil code
Parameters:
code: Code - code to evaluate:
  • the code will be executed; isNil { player setDamage 1 }; will kill the player
  • the code will not be allowed to suspend while expression is evaluated, even if the parent scope allows it (see Example 4).
Return Value:
Boolean - true if code returns Nothing, false otherwise

Syntax 3

Syntax:
namespace isNil variableName
Parameters:
namespace: Namespace, Object, Group or HashMap
variableName: String
Return Value:
Boolean - true if variable is nil or undefined

Examples

Example 1:
if (isNil "TAG_globalVariable") then { TAG_globalVariable = 0 }; if (isNil "_localVariable") then { hint "_localVariable is nil" };
Example 2:
isNil { player getVariable "someVar" };
Example 3:
_myArray = [0, 1]; isNil { _myArray select 0 }; // returns false isNil { _myArray select 1 }; // returns false isNil { _myArray select 2 }; // returns true isNil { _myArray select 3 }; // throws a script error. only length+1 select is allowed
Example 4:
This trick forces executing something in Unscheduled Environment:
0 spawn { systemChat str canSuspend; // chat shows true isNil { hint str canSuspend }; // hint shows false };
Example 5:
Operation Flashpoint String comparison workaround
SQS Syntax:
_nil = format ["%1", _undefinedVariable] ? (format ["%1", variableToTest] == _nil) : hint "variableToTest is nil"
SQF Syntax:
_nil = format ["%1", _undefinedVariable]; if (format ["%1", variableToTest] == _nil) then { hint "variableToTest is nil" };

Additional Information

See also:
nil Variables Scheduler

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
Retrieved from "https://community.bistudio.com/wiki?title=isNil&oldid=352350"