private: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(add. ArmA2 classification)
m (merged variations)
Line 1: Line 1:
This scripting command has to variants:
{{Command|= Comments
____________________________________________________________________________________________


* [[private variableName]]
| ofp |= Game name
* [[private variableNameList]]


{{Disambig}}
|1.00|= Game version
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
____________________________________________________________________________________________
 
| Sets a variable to the innermost scope. The variable has to be [[Variables#Local_Variables|local]]. |= Description
____________________________________________________________________________________________
 
| '''private''' variableName |= Syntax
|p1= variableName: [[String]] |= Parameter 1
| [[Nothing]] |= Return value
 
|s2= '''private''' variableNameList |=Syntax
|p21= variableNameList: [[Array]] |= Parameter 1
|r2= [[Nothing]] |= Return value
____________________________________________________________________________________________
|x1= <code>private "_varname";</code> |= Example 1
|x2= <code>private ["_varname1", "_varname2"];</code> |= Example 2
 
| [http://community.bistudio.com/wiki/Variables#Scope Scope] |= See also
 
}}
 
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
 
 
 
 
<dt class="note">'''[[User:ColonelSandersLite|ColonelSandersLite]]'''</dt>
<dd class="note"><br>
The example provided is fairly worthless without a context.<br>
Using the private command allows you to declare a variable in the current scope, without regards to variables in a higher scope with the same name.  Note that if you try to declare a variable without an underscore (meaning it's global) with the private command, it will cause an error.  Specifically: "Error Local variable in global space".<br>
Here's a code example with output for your benefit.<br>
_foo = 10;
if (true) then
{
    private ["_foo"];
    _foo = 5;
    player sideChat format ["%1", _foo];
};
player sideChat format ["%1", _foo];
<br>
In this example, the first sidechat (innermost) returns 5 while the second sidechat (outermost) returns 10.<br>
<br>
if (true) then
{
    private ["_bar"];
    _bar = 5;
    player sideChat format ["%1", _bar];
};
<br>
In this example, the private command does nothing and is simply a waste of code, assuming there is no higher level code to interfere with the if statement.<br>
</dd>
 
 
 
<!-- Note Section END -->
</dl>
 
<h3 style="display:none">Bottom Section</h3>
 
[[Category:Scripting Commands|PRIVATE]]
[[Category:Scripting Commands OFP 1.96|PRIVATE]]
[[Category:Scripting Commands ArmA|PRIVATE]]

Revision as of 17:04, 24 September 2009

Hover & click on the images for description

Description

Description:
Sets a variable to the innermost scope. The variable has to be local.
Groups:
Uncategorised

Syntax

Syntax:
private variableName
Parameters:
variableName: String
Return Value:
Nothing

Alternative Syntax

Syntax:
private variableNameList
Parameters:
variableNameList: Array
Return Value:
Nothing

Examples

Example 1:
private "_varname";
Example 2:
private ["_varname1", "_varname2"];

Additional Information

See also:
Scope

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

ColonelSandersLite

The example provided is fairly worthless without a context.
Using the private command allows you to declare a variable in the current scope, without regards to variables in a higher scope with the same name. Note that if you try to declare a variable without an underscore (meaning it's global) with the private command, it will cause an error. Specifically: "Error Local variable in global space".
Here's a code example with output for your benefit.
_foo = 10; if (true) then { private ["_foo"]; _foo = 5; player sideChat format ["%1", _foo]; }; player sideChat format ["%1", _foo];
In this example, the first sidechat (innermost) returns 5 while the second sidechat (outermost) returns 10.

if (true) then { private ["_bar"]; _bar = 5; player sideChat format ["%1", _bar]; };
In this example, the private command does nothing and is simply a waste of code, assuming there is no higher level code to interfere with the if statement.

Bottom Section