Namespace: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Added serverNamespace, overhauled a little bit)
(Finished overhaul)
Line 3: Line 3:




A [[Namespace]] is a container for [[Variables]]. Any [[Variables#Scopes|global]] variable is always part of exactly one namespace - another namespace may contain a variable with the same [[Identifier]], but they remain two distinct independent variables. Scripts and functions are always executed in the context of some namespace. The default namespace is the [[missionNamespace]].
A [[Namespace]] is a container for [[Variables]]. Any [[Variables#Scopes|global]] variable is always part of exactly one namespace - another namespace may contain a variable with the same [[Identifier]], but they remain two distinct independent variables. Scripts and functions are always executed in the context of some namespace.
 
The default namespace is the [[missionNamespace]].




== Namespaces ==
== Namespaces ==
The following commands return the [[Namespace]] type:
{| class="wikitable"
{| class="wikitable"
! Game !! Command !! Description
! Game !! Namespace !! Description !! Lifetime
|-
| {{GVI|arma2|1.00}} || [[missionNamespace]] || returns the global namespace attached to the mission
|-
|-
| {{GVI|arma2|1.00}} || [[parsingNamespace]] || returns the global namespace attached to the [[PreProcessor Commands|Config Parser]]
| {{GVI|arma2|1.00}}
| [[missionNamespace]]
| The global namespace of the mission. Every mission has its own [[missionNamespace]].
| style="background-color: lightgreen" | Mission duration
|-
|-
| {{GVI|arma2|1.00}} || [[uiNamespace]]     || returns the global namespace attached to the user interface
| {{GVI|arma2|1.00}}
| [[parsingNamespace]]
| The global namespace attached to the [[PreProcessor Commands|Config Parser]].
| style="background-color: lightyellow" | Game session
|-
|-
| {{GVI|tkoh|1.00}} || [[profileNamespace]] || returns the global namespace attached to the user profile
| {{GVI|arma2|1.00}}
| [[uiNamespace]]
| The global namespace attached to the user interface.
| style="background-color: lightyellow" | Game session
|-
|-
| {{GVI|arma3|1.48}} || [[currentNamespace]] || returns the namespace which the calling script is running in
| {{GVI|tkoh|1.00}}
| [[profileNamespace]]
| The global namespace attached to the user profile.
| style="background-color: lightskyblue" | [[Profile]] lifetime
|-
|-
| {{GVI|arma3|2.00}} || [[localNamespace]] || returns the local namespace
| {{GVI|arma3|2.00}}
| [[localNamespace]]
| This namespace is like the [[missionNamespace]], except that its variables can not be broadcast (e.g. with [[publicVariable]]) or serialized.
| style="background-color: lightgreen" | Mission duration
|-
|-
| {{GVI|arma3|2.06}} || [[serverNamespace]] || returns the server namespace
| {{GVI|arma3|2.06}}
| [[serverNamespace]]
| The namespace used by [[ArmA: Armed Assault: Server Side Scripting|Server Event Handlers]]. This namespace is only available on servers.
| style="background-color: lightyellow" | Game session
|}
|}




== Get namespace data == <!-- Remove? -->
== Namespace Serialization ==
 
Only the [[missionNamespace]] is serialized, i.e. only the variables from this namespace are saved when the game is saved (e.g. with [[saveGame]]) and loaded when the game is loaded (e.g. with [[loadGame]]). This is also the reason the game will complain that one should use [[disableSerialization]] when storing UI variables in [[missionNamespace]] - UI elements are temporary and therefore exempt from serialization by default.
You can use the above with [[getVariable]] to get data.
 
 
== Set namespace data == <!-- Remove? -->
 
To set data to a namespace, there're two methods to do:
<code>'''namespace''' [[setVariable]] ["variableName", ''value''];</code>
 
<code>[[with]] '''namespace''' do {
variableName = ''value'';
};</code>


[[missionNamespace]] is the default global namespace, so just {{ic|VariableName {{=}} ''value'';}} will store data to [[missionNamespace]].
== Namespace Lifetimes == <!-- TODO: Transform to a table -->
=== missionNamespace ===
The missionNamespace is the main default partition that exists for the duration of a mission. All variables defined in the missionNamespace will cease to exist when the mission ends. To make variables last longer than a mission, use different namespaces.
=== uiNamespace and parsingNamespace ===
These are two different namespaces which have similar scope. Variables defined in these namespaces exist for the duration of the game executable running and are lost when the game is shut down.
=== profileNamespace ===
This namespace holds variables for a very long time and is attached to the user profile. Different profiles will have own set of variables stored with them. The saving of the profileNamespace can be forced with the [[saveProfileNamespace]] command, but in {{arma3}} this command is executed by vanilla game scripts already, so saving is done automatically.
=== localNamespace ===
Same lifetime as [[missionNamespace]] but variables cannot be broadcast or serialized.
== Namespace Serialization ==


Only the [[missionNamespace]] is serialized. This means that all variables in this namespace will be saved when the game is saved and loaded when the game is loaded. This is also the reason the game will complain that one should use [[disableSerialization]] when storing UI variables in [[missionNamespace]]. UI elements are temporary and therefore exempt from serialization by default.
== Scripting with Namespaces ==
Interacting with namespaces is not difficult:
* The [[getVariable]] and [[setVariable]] commands can be used to work with variables from different namespaces.
* The [[with]]-do-construct can be used to switch the context of an entire code block to another namespace.
* The [[currentNamespace]] command can be used to obtain the namespace which the calling script is running in.




[[Category: Data Types]]
[[Category: Data Types]]
[[Category: Introduced with Arma 2 version 1.00]]
[[Category: Introduced with Arma 2 version 1.00]]

Revision as of 16:02, 26 February 2022

Logo A2.png1.00


A Namespace is a container for Variables. Any global variable is always part of exactly one namespace - another namespace may contain a variable with the same Identifier, but they remain two distinct independent variables. Scripts and functions are always executed in the context of some namespace.

The default namespace is the missionNamespace.


Namespaces

Game Namespace Description Lifetime
Logo A2.png1.00 missionNamespace The global namespace of the mission. Every mission has its own missionNamespace. Mission duration
Logo A2.png1.00 parsingNamespace The global namespace attached to the Config Parser. Game session
Logo A2.png1.00 uiNamespace The global namespace attached to the user interface. Game session
tkoh logo small.png1.00 profileNamespace The global namespace attached to the user profile. Profile lifetime
Arma 3 logo black.png2.00 localNamespace This namespace is like the missionNamespace, except that its variables can not be broadcast (e.g. with publicVariable) or serialized. Mission duration
Arma 3 logo black.png2.06 serverNamespace The namespace used by Server Event Handlers. This namespace is only available on servers. Game session


Namespace Serialization

Only the missionNamespace is serialized, i.e. only the variables from this namespace are saved when the game is saved (e.g. with saveGame) and loaded when the game is loaded (e.g. with loadGame). This is also the reason the game will complain that one should use disableSerialization when storing UI variables in missionNamespace - UI elements are temporary and therefore exempt from serialization by default.


Scripting with Namespaces

Interacting with namespaces is not difficult:

  • The getVariable and setVariable commands can be used to work with variables from different namespaces.
  • The with-do-construct can be used to switch the context of an entire code block to another namespace.
  • The currentNamespace command can be used to obtain the namespace which the calling script is running in.
Retrieved from "https://community.bistudio.com/wiki?title=Namespace&oldid=308374"