local: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "[[Category:Scripting_Commands_Take_On_Helicopters" to "[[Category:Scripting Commands Take On Helicopters") |
Lou Montana (talk | contribs) (Add Arma 2 → Arma 3 v1.54 "private" syntax) |
||
| Line 9: | Line 9: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Check if given unit is local on the computer in Multiplayer games | | 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= | |||
|mp= A few things to note [[Multiplayer Scripting#General information about locality|amongst others]]: | |||
* A game logic / module is always local to the server | |||
* Terrain objects are local to every machine |Multiplayer= | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| | | [[local]] object |SYNTAX= | ||
|p1= object: [[Object]] or [[Group]] (since Arma 3 v1.31.127204) |PARAMETER1= | |p1= object: [[Object]] or [[Group]] (since Arma 3 v1.31.127204) |PARAMETER1= | ||
| Line 23: | Line 23: | ||
| [[Boolean]] |RETURNVALUE= | | [[Boolean]] |RETURNVALUE= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| | |s2= [[local]] variable = value <span style="margin-left: 7em">{{Color|red|From {{arma2}} until {{arma3}} v1.54}} - see '''[[private]]''' for later versions</span> |SYNTAX2= | ||
| | |r2= [[Nothing]] |RETURNVALUE2= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| | |x1= <code>[[if]] ([[not]] [[local]] _unit) [[then]] { | ||
[[hint]] [[format]] ["%1 is remote", [[name]] _unit]; | |||
};</code> |EXAMPLE1= | |||
|x2= <code>_isLocalGroup = [[local]] [[group]] _unit;</code> |EXAMPLE2= | |||
|x3= Sets variable's [[Variables#Scopes|scope]]:<code>{{cc|From {{arma2}} until {{arma3}} v1.54}} | |||
[[local]] _myVariable = 42; | |||
| [[ | {{cc|Since {{arma3}} v1.54}} | ||
[[private]] _myVariable = 42;</code> |EXAMPLE3= | |||
____________________________________________________________________________________________ | |||
| [[Arma 3: Event Handlers#Local|"Local" Event Handler]], [[owner]], [[setOwner]] |SEEALSO= | |||
}} | }} | ||
| Line 42: | Line 48: | ||
<dl class="command_description"> | <dl class="command_description"> | ||
<!-- Note Section BEGIN --> | <!-- Note Section BEGIN --> | ||
<!-- Note Section END --> | <!-- Note Section END --> | ||
| Line 54: | Line 54: | ||
<h3 style="display:none">Bottom Section</h3> | <h3 style="display:none">Bottom Section</h3> | ||
[[Category:Scripting Commands| | [[Category:Scripting Commands OFP 1.46|{{uc:{{PAGENAME}}}}]] | ||
[[Category:Scripting Commands OFP 1.96|{{uc:{{PAGENAME}}}}]] | |||
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]] | [[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]] | ||
[[Category:Scripting Commands ArmA|{{uc:{{PAGENAME}}}}]] | |||
[[Category:Scripting Commands ArmA | |||
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]] | [[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]] | ||
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]] | [[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]] | ||
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]] | [[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]] | ||
[[Category:Command Group: Multiplayer|{{uc:{{PAGENAME}}}}]] | |||
[[Category:Command Group: Object Information|{{uc:{{PAGENAME}}}}]] | |||
Revision as of 23:29, 13 May 2020
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:
- Uncategorised
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
Notes
Bottom Section
Categories:
- Scripting Commands
- Introduced with Operation Flashpoint version 1.00
- Operation Flashpoint: New Scripting Commands
- Operation Flashpoint: Scripting Commands
- Command Group: Uncategorised
- Scripting Commands OFP 1.46
- Scripting Commands OFP 1.96
- Scripting Commands OFP 1.99
- Scripting Commands ArmA
- Scripting Commands Arma 2
- Scripting Commands Arma 3
- Scripting Commands Take On Helicopters
- Command Group: Multiplayer
- Command Group: Object Information