local: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments( \("local" or "global"\))?|Effects|Multiplayer Effects( \("local" or "global"\))?|Multiplayer Exe...)
Line 1: Line 1:
{{Command|Comments=
{{Command


| ofp |Game name=
| ofp


|1.00|Game version=
|1.00


|gr1 = Multiplayer |GROUP1=
|gr1 = Multiplayer






|arg= global |Multiplayer Arguments=
|arg= global


| Check if given unit is local on the computer in Multiplayer games - see [[Multiplayer Scripting#Locality|Multiplayer Scripting - Locality]].<br>
| Check if given unit is local on the computer in Multiplayer games - see [[Multiplayer Scripting#Locality|Multiplayer Scripting - Locality]].<br>
This can be used to determine on which computer some code must be run. In Single player all objects are local. |DESCRIPTION=
This can be used to determine on which computer some code must be run. In Single player all objects are local.


|mp= A few things to note [[Multiplayer Scripting#General information about locality|amongst others]]:
|mp= A few things to note [[Multiplayer Scripting#General information about locality|amongst others]]:
Line 18: Line 18:
* Terrain objects are local to every machine |Multiplayer=
* Terrain objects are local to every machine |Multiplayer=


| [[local]] object |SYNTAX=
| [[local]] object


|p1= object: [[Object]] or [[Group]] (since Arma 3 v1.31.127204) |PARAMETER1=
|p1= object: [[Object]] or [[Group]] (since Arma 3 v1.31.127204)


| [[Boolean]] |RETURNVALUE=
| [[Boolean]]


|s2= [[local]] variable = value <span style="margin-left: 7em">{{Color|red|From {{arma2}} until {{arma3}} v1.54}} - see '''[[private]]''' for later versions</span> |SYNTAX2=
|s2= [[local]] variable = value <span style="margin-left: 7em">{{Color|red|From {{arma2}} until {{arma3}} v1.54}} - see '''[[private]]''' for later versions</span>


|r2= [[Nothing]] |RETURNVALUE2=
|r2= [[Nothing]]


|x1= <code>[[if]] ([[not]] [[local]] _unit) [[then]] {
|x1= <code>[[if]] ([[not]] [[local]] _unit) [[then]] {
[[hint]] [[format]] ["%1 is remote", [[name]] _unit];
[[hint]] [[format]] ["%1 is remote", [[name]] _unit];
};</code> |EXAMPLE1=
};</code>


|x2= <code>_isLocalGroup = [[local]] [[group]] _unit;</code> |EXAMPLE2=
|x2= <code>_isLocalGroup = [[local]] [[group]] _unit;</code>


|x3= Sets variable's [[Variables#Scopes|scope]]:<code>{{cc|From {{arma2}} until {{arma3}} v1.54}}
|x3= Sets variable's [[Variables#Scopes|scope]]:<code>{{cc|From {{arma2}} until {{arma3}} v1.54}}
Line 38: Line 38:


{{cc|Since {{arma3}} v1.54}}
{{cc|Since {{arma3}} v1.54}}
[[private]] _myVariable = 42;</code> |EXAMPLE3=
[[private]] _myVariable = 42;</code>


| [[Arma 3: Event Handlers#Local|"Local" Event Handler]], [[owner]], [[setOwner]] |SEEALSO=
| [[Arma 3: Event Handlers#Local|"Local" Event Handler]], [[owner]], [[setOwner]]
}}
}}



Revision as of 01:03, 18 January 2021

Hover & click on the images for description

Description

Description:
Check if given unit is local on the computer in Multiplayer games - see Multiplayer Scripting - Locality.
This can be used to determine on which computer some code must be run. In Single player all objects are local.
Multiplayer:
A few things to note amongst others:
  • A game logic / module is always local to the server
  • Terrain objects are local to every machine
Groups:
Multiplayer

Syntax

Syntax:
local object
Parameters:
object: Object or Group (since Arma 3 v1.31.127204)
Return Value:
Boolean

Alternative Syntax

Syntax:
local variable = value From Arma 2 until Arma 3 v1.54 - see private for later versions
Return Value:
Nothing

Examples

Example 1:
if (not local _unit) then { hint format ["%1 is remote", name _unit]; };
Example 2:
_isLocalGroup = local group _unit;
Example 3:
Sets variable's scope:// From Arma 2 until Arma 3 v1.54 local _myVariable = 42; // Since Arma 3 v1.54 private _myVariable = 42;

Additional Information

See also:
"Local" Event HandlerownersetOwner

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

Bottom Section