with: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " \| *(game[0-9]|version[0-9]|gr[0-9]|serverExec|mp|pr|descr|s[0-9]|p[0-9]{1,3}|r[0-9]|x1?[0-9]|seealso) *= +" to " |$1= ")
m (Some wiki formatting)
 
(15 intermediate revisions by 3 users not shown)
Line 14: Line 14:


|gr1= Program Flow
|gr1= Program Flow
|gr2= Namespaces


|descr= Creates a [[With Type]] that is used inside a [[do]] construct in order to execute code inside a given namespace.  
|descr= Creates a [[With Type]] that is used inside a [[do]] construct in order to execute code inside a given namespace.
{{Feature | Warning | when used in a do-construct in scripts with allowed suspension, an unexpected namespace switch could happen (see note below)}}
{{Feature|important|To avoid the below-mentioned issue error (whether in [[Scheduler#Scheduled Environment|scheduled]] or [[Scheduler#Unscheduled Environment|unscheduled]] environment) use [[setVariable]]/[[getVariable]] with the desired [[Namespace]].}}
'''NOTE''' for the reasons unknown, namespace switching might unexpectedly occur inside some scopes ([[for]], [[if]], [[try]], [[call]]) started in [[Scheduler#Scheduled_Environment|scheduled]] scripts ([[canSuspend]] true) after small suspension if [[with]] was not the main scope. For example:  
 
<code>[] [[spawn]]
|pr= When used in a do-construct in scripts with allowed suspension, a namespace switching might unexpectedly occur inside some scopes ([[for]], [[if]], [[try]], [[call]]) started in a [[Scheduler#Scheduled Environment|scheduled]] environment after small suspension if [[with]] was not the main scope; however, the issue does not arise if [[with]] is used in the parent scope:
{{{!}} class="wikitable"
! namespace switch risk
! namespace switch safe
{{!}}-
{{!}}
<sqf>
0 spawn
{
{
[[with]] [[uiNamespace]] do  
with uiNamespace do
{
{
[[for]] "_i" [[from]] 1 [[to]] 1 [[do]]
for "_i" from 1 to 1 do  
{
{
[[systemChat]] [[str]] [
systemChat str [
[[currentNamespace]] [[isEqualTo]] [[uiNamespace]],  
currentNamespace isEqualTo uiNamespace,  
[[currentNamespace]] [[isEqualTo]] [[missionNamespace]]
currentNamespace isEqualTo missionNamespace
];  
];
// result [true, false]
// result [true, false]
[[sleep]] 0.05; //<-- small suspension
sleep 0.05; // <-- small suspension
[[systemChat]] [[str]] [
systemChat str [
[[currentNamespace]] [[isEqualTo]] [[uiNamespace]],  
currentNamespace isEqualTo uiNamespace,  
[[currentNamespace]] [[isEqualTo]] [[missionNamespace]]
currentNamespace isEqualTo missionNamespace
];  
];
// result [false, true] <-- switching
// result [false, true] <-- switching
};
};
};
};
};</code>
};
However if [[with]] used in parent scope, everything works correctly:
</sqf>
<code>[[with]] [[uiNamespace]] do
{{!}}
<sqf>
with uiNamespace do
{
{
[] [[spawn]]
0 spawn
{
{
[[for]] "_i" [[from]] 1 [[to]] 1 [[do]]
for "_i" from 1 to 1 do  
{
{
[[systemChat]] [[str]] [
systemChat str [
[[currentNamespace]] [[isEqualTo]] [[uiNamespace]],  
currentNamespace isEqualTo uiNamespace,  
[[currentNamespace]] [[isEqualTo]] [[missionNamespace]]
currentNamespace isEqualTo missionNamespace
];  
];
// result [true, false]
// result [true, false]
[[sleep]] 0.05; //<-- small suspension
sleep 0.05; // <-- small suspension
[[systemChat]] [[str]] [
systemChat str [
[[currentNamespace]] [[isEqualTo]] [[uiNamespace]],  
currentNamespace isEqualTo uiNamespace,  
[[currentNamespace]] [[isEqualTo]] [[missionNamespace]]
currentNamespace isEqualTo missionNamespace
];  
];
// result [true, false] <-- NO switching
// result [true, false] <-- NO switching
};
};
};
};
};</code>
};
To eliminate possibility of error you can also use [[setVariable]] or [[getVariable]] with desired [[Namespace]], which is also [[Scheduler#Scheduled_Environment|scheduled environment]] safe.
</sqf>
{{!}}}


|s1= [[with]] namespace
|s1= [[with]] namespace
Line 65: Line 76:
|p1= namespace: [[Namespace]]
|p1= namespace: [[Namespace]]


|r1=[[With Type]]
|r1= [[With Type]]
 
|x1= <sqf>_myWithType = with uiNamespace;</sqf>
 
|x2= <sqf>with missionNamespace do { global = global + 1 };</sqf>
 
|seealso= [[missionNamespace]] [[uiNamespace]] [[parsingNamespace]] [[currentNamespace]]
}}


|x1= <code>_myWithType = [[with]] [[uiNamespace]];</code>
{{Note
|x2= <code>[[with]] [[missionNamespace]] [[do]] {global = global + 1};</code>
|user= Hypoxic125
|timestamp= 20230223070505
|text= '''Using with:'''
<sqf>
with profileNamespace do {
myVariable = "Hello!";
};
</sqf>
'''is the same as:'''
<sqf>
profileNamespace setVariable ["myVariable", "Hello!"];
</sqf>


|seealso= ‎[[ArmA:_Editing#Forward_Compatibility|Forward Compatibility]], [[missionNamespace]], [[uiNamespace]], [[parsingNamespace]]
This allows you to quickly modify/use variables within a namespace without using '''get/setvariable''' every time.
}}
}}

Latest revision as of 15:58, 26 August 2024

Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
Creates a With Type that is used inside a do construct in order to execute code inside a given namespace.
⚠
To avoid the below-mentioned issue error (whether in scheduled or unscheduled environment) use setVariable/getVariable with the desired Namespace.
Problems:
When used in a do-construct in scripts with allowed suspension, a namespace switching might unexpectedly occur inside some scopes (for, if, try, call) started in a scheduled environment after small suspension if with was not the main scope; however, the issue does not arise if with is used in the parent scope:
namespace switch risk namespace switch safe

0 spawn { with uiNamespace do { for "_i" from 1 to 1 do { systemChat str [ currentNamespace isEqualTo uiNamespace, currentNamespace isEqualTo missionNamespace ]; // result [true, false] sleep 0.05; // <-- small suspension systemChat str [ currentNamespace isEqualTo uiNamespace, currentNamespace isEqualTo missionNamespace ]; // result [false, true] <-- switching }; }; };

with uiNamespace do { 0 spawn { for "_i" from 1 to 1 do { systemChat str [ currentNamespace isEqualTo uiNamespace, currentNamespace isEqualTo missionNamespace ]; // result [true, false] sleep 0.05; // <-- small suspension systemChat str [ currentNamespace isEqualTo uiNamespace, currentNamespace isEqualTo missionNamespace ]; // result [true, false] <-- NO switching }; }; };

Groups:
Program FlowNamespaces

Syntax

Syntax:
with namespace
Parameters:
namespace: Namespace
Return Value:
With Type

Examples

Example 1:
_myWithType = with uiNamespace;
Example 2:
with missionNamespace do { global = global + 1 };

Additional Information

See also:
missionNamespace uiNamespace parsingNamespace currentNamespace

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
Hypoxic125 - c
Posted on Feb 23, 2023 - 07:05 (UTC)
Using with:
with profileNamespace do { myVariable = "Hello!"; };
is the same as:
profileNamespace setVariable ["myVariable", "Hello!"];
This allows you to quickly modify/use variables within a namespace without using get/setvariable every time.
Retrieved from "https://community.bistudio.com/wiki?title=with&oldid=369023"