Variables
62 scripting commands. Also as Markdown for agents.
- ! aReturns the negation of a Boolean expression. This means `true` becomes `false` and vice versa.
- a != bReturns whether one value is not equal to another. String comparison is case-insensitive (e.g `"STRINGtext" != "stringTEXT" // returns false -…
- a && bReturns true only if both conditions are true. In case of the alternative syntax, lazy evaluation is used - if left operand is false, evaluation of…
- a = bAssigns the result of expression on the right to the variable on the left. Technically this is not a command and it is not listed in supportInfo;…
- a == bCheck if *a* is equal to *b*. String comparison is case-insensitive - use isEqualTo if case sensitivity is needed.
- a greater bReturns true if a is greater than b, else returns false.
- a greater= bReturns if *a* is greater than or equal to *b*.
- a hash bSelects an element from an Array, same as select command for arrays, but has higher precedence.
- a less bReturns if *a* is lesser than *b*.
- a less= bReturns true if a is less than or equal to b, else returns false.
- a or bReturns true if one or both conditions are true. In case of the alternative syntax, lazy evaluation is used. That means that if left operand is true,…
- addPublicVariableEventHandlerThis event handler will detect if a missionNamespace variable (it is attached to) has been broadcast over network with publicVariable,…
- allVariablesReturns a list of all variables from the desired namespace.
- andReturns true only if both conditions are true. In case of the alternative syntax, lazy evaluation is used - if left operand is false, evaluation of…
- configNullA non-existing Config.
- diaryRecordNullA non-existent Diary Record. To compare non-existent objects use isNull or isEqualTo:
- displayNullA non-existing Display. To compare non-existent displays use isNull or isEqualTo:
- falseAlways false.
- getFSMVariableReturn the value of variable in the variable space of given FSM. The FSM handle is the number returned by the execFSM command.
- getVariableReturns the value of variable in the variable space assigned to various data types. All available data types combinations:
- importImports one or multiple local variables from the parent scope, and defines them as private variables in the current scope. It can bypass privateAll.
- isEqualRefCompares two values by reference, returns true if equal.
- isEqualToPerforms strict comparison between var1 and var2 and returns true if equal, otherwise false. Strict means that it would check that both arguments are…
- isEqualTypeCompares two values' types. A much faster alternative to `typeName a == typeName b`.
- isEqualTypeAllCompares types of all elements of an array to the type of a single value. Since Arma 3 v2.09.149634 no additional check is needed to make sure the…
- isEqualTypeAnyCompares type of given value to every type in the given array and if match is found, true is returned.
- isEqualTypeArrayCompares types of all elements of one array to types of all elements of another array. Since Arma 3 v2.09.149634 no additional check is needed to…
- isEqualTypeParamsCompares types of all elements of input array to types of all elements of template array.
- isFinalChecks if Code or a variable was compiled final with compileFinal.
- isMissionProfileNamespaceLoadedThe missionProfileNamespace variables are loaded at the start of a mission, before 'init.sqf' is executed.
- isNilTests whether a variable is nil or undefined from its identifier, or whether the given expression evaluates to nil or Nothing.
- isNotEqualRefCompares two values by reference, returns true if not equal.
- isNotEqualToPerforms strict comparison between var1 and var2 and returns false if equal, otherwise true.
- isNullChecks whether the tested item is null.
- localNamespaceReturns local Namespace attached to the mission. Has the same lifetime as missionNamespace but variables cannot be broadcasted out of or into this…
- locationNullA non-existing Location. To compare non-existent locations use isNull or isEqualTo:
- missionNamespaceReturns the global namespace attached to mission.
- missionProfileNamespaceThis namespace has the same lifetime as profileNamespace but is also connected to the mission it is saved from. See saveMissionProfileNamespace for…
- netObjNullA non-existent NetObject. To compare non-existent objects use isNull or isEqualTo:
- nilNil value. This value can be used to undefine existing variables.
- notnot a is exactly the same as ! a.
- objNullA non-existent Object. To compare non-existent objects use isNull or isEqualTo:
- orReturns true if one or both conditions are true. In case of the alternative syntax, lazy evaluation is used. That means that if left operand is true,…
- paramExtracts a single value with given index from input argument, similar to BIS_fnc_param.
- paramsParses input argument into array of private variables. When used without argument, as shown in main syntax, internal variable _this, which is usually…
- parsingNamespaceReturns the global namespace attached to config parser.
- privateSets a variable to the innermost scope. See also param and params.
- privateAllDisables the implicit inheritance of local variables, as defined in the parent scope.
- profileNamespaceReturns the global namespace attached to the active user profile. Use setVariable and getVariable to save and load data to and from this Namespace. A…
- publicVariableReliably broadcasts missionNamespace variable and its current value to all computers (server/client).
- publicVariableClientSend the variable value to the client computer - same limitations regarding variable type as publicVariable.
- publicVariableServerSend the variable value to the server - same limitations regarding variable type as publicVariable.
- saveMissionProfileNamespacemissionProfileNamespace provides long-term storage solution for mission variables.
- saveProfileNamespaceSaves all variables stored in profileNamespace to the active Profile.
- saveVarSave variable value into the campaign space. This variable is available to all following missions in the campaign.
- scriptNullA non-existing or completed Script Handle. To compare non-existent scripts use isNull or isEqualTo:
- serverNamespaceReturns server's namespace. This namespace is only available on the server for the server's uptime duration (same as uiNamespace).
- setVariableSet variable to given value in the variable space of given element. Can be used to broadcast variables over the network.
- taskNullA non-existing Task. To compare non-existent tasks use isNull or isEqualTo:
- trueAlways true
- typeNameReturns the Data Type of an expression.
- uiNamespaceReturns the global namespace attached to user interface.