private: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Some wiki formatting)
m (Some wiki formatting)
Line 30: Line 30:
|s1= [[private]] variableName
|s1= [[private]] variableName


|p1= variableName: [[String]] - e.g {{hl|"_myVar"}}
|p1= variableName: [[String]] - e.g <sqf inline>"_myVar"</sqf>


|r1= [[Nothing]]
|r1= [[Nothing]]
Line 36: Line 36:
|s2= [[private]] variableNameList
|s2= [[private]] variableNameList


|p21= variableNameList: [[Array]] of [[String]]s - e.g {{hl|["_target", "_damage"]}}
|p21= variableNameList: [[Array]] of [[String]]s - e.g <sqf inline>["_target", "_damage"]</sqf>


|r2= [[Nothing]]
|r2= [[Nothing]]
Line 44: Line 44:
|s3since= arma3 1.54
|s3since= arma3 1.54


|p41= _identifier: underscored [[Identifier|variable name]], for example ''_myVar''
|p41= _identifier: underscored [[Identifier|variable name]], for example <sqf inline>_myVar</sqf>


|p42= value: [[Anything]]: value to assign to the variable
|p42= value: [[Anything]]: value to assign to the variable
Line 50: Line 50:
|r3= [[Nothing]]
|r3= [[Nothing]]


|x1= <sqf>private _varname = "this is my new variable"; // since Arma 3 v1.54
|x1= <sqf>
private _varname = "this is my new variable"; // since Arma 3 v1.54


// identical, but less performant
// identical, but less performant
Line 81: Line 82:
</sqf>
</sqf>


|seealso= [[param]] [[params]] {{HashLink|Variables#Scope}}
|seealso= [[param]] [[params]] {{HashLink|Variables#Scopes}}
}}
}}



Revision as of 17:08, 14 July 2022

Hover & click on the images for description

Description

Description:
Sets a variable to the innermost scope as demonstrated in Example 3. See also param and params.
private variables must start with an underscore: private _myVar1 = "myVar"; - see Identifier.
Always make your local variables private (through private or params) in order to avoid overwriting a local variable of the same name.
Groups:
Variables

Syntax 1

Syntax:
private variableName
Parameters:
variableName: String - e.g "_myVar"
Return Value:
Nothing

Syntax 2

Syntax:
private variableNameList
Parameters:
variableNameList: Array of Strings - e.g ["_target", "_damage"]
Return Value:
Nothing

Syntax 3

Syntax:
private _identifier = value
Parameters:
_identifier: underscored variable name, for example _myVar
value: Anything: value to assign to the variable
Return Value:
Nothing

Examples

Example 1:
private _varname = "this is my new variable"; // since Arma 3 v1.54 // identical, but less performant private "_varname"; _varname = "this is my new variable";
Example 2:
private ["_varname1", "_varname2"]; _varname1 = "variable 1"; _varname2 = "variable 2";
Example 3:
_lol = 123; call { hint str [_lol] }; // [123] _lol = 123; call { private "_lol"; hint str [_lol] }; // [any]
Example 4:
_myvar = 123; systemChat str [_myvar]; // [123] call { systemChat str [_myvar]; // [123] private "_myvar"; systemChat str [_myvar]; // [any] _myvar = 345; systemChat str [_myvar]; // [345] }; systemChat str [_myvar]; // [123]

Additional Information

See also:
param params Variables - Scopes

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
Faguss - c
Posted on Aug 04, 2010 - 13:30 (UTC)
The higher scope is also the script from which the function has been called.
in script2.sqf:
_a = 2;
in script1.sqf:
_a = 1; call compile preprocessFileLineNumbers "script2.sqf"; hint format ["%1", _a];
Game will display 2.
Inserting private "_a" in the function prevents the change and so number 1 will be displayed on the screen.
DreadedEntity - c
Posted on Feb 25, 2015 - 17:06 (UTC)
Recursive loops require the use of private. Without it, your variables will be overwritten.
654wak654 - c
Posted on Jan 31, 2018 - 10:37 (UTC)
This command is similar to javascript's let keyword.
EDIT: in the way that it scopes the variable to the innermost scope. Otherwise, let and private can behave differently - Lou Montana (talk)