disableSerialization: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Fix wording)
m (Text replacement - "[] spawn" to "0 spawn")
 
(57 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma2 |Game name=
|game1= arma2
|version1= 1.00


|1.00|Game version=
|game2= arma2oa
____________________________________________________________________________________________
|version2= 1.50


| Disable saving of script containing this command. After this, the script can work with data types which do not support serialization (UI types). See [[Namespace#Namespace serialization|Namespace serialization]] for more information.
|game3= tkoh
|version3= 1.00


{{Important | '''In {{arma2}}''' and up to a certain version of {{arma3}}, <!--
|game4= arma3
-->giving a [[Display]] or [[Control]] to [[spawn]]ed code would raise an error due to the usage of the then non-serializable <tt>[[Magic Variables#this|_this]]</tt> variable. <!--
|version4= 0.50
-->Using [[disableSerialization]] or [[uiNamespace]] wouldn't help; the trick here is to pass the argument inside an array:
 
<code>_display {{=}} [[findDisplay]] 46;<br><!--
|gr1= Namespaces
-->&nbsp;_display&nbsp; [[spawn]] { [[hint]] [[str]] _this; }; {{cc|would raise a serialization error}}<br><!--
|gr2= GUI Control
-->[_display] [[spawn]] { [[hint]] [[str]] (_this [[select]] 0); }; {{cc|OK}}</code>}} |DESCRIPTION=
____________________________________________________________________________________________


| [[disableSerialization]] |SYNTAX=
|descr= Disable saving of script containing this command. After this, the script can work with data types which do not support serialization (UI types).
{{Feature|informative|See [[Namespace#Namespace serialization|Namespace serialization]] for more information.}}


| [[Nothing]] |RETURNVALUE=  
{{Feature|important|
'''In {{arma2}}''' and up to a certain version of {{arma3}}, <!--
-->giving a [[Display]] or [[Control]] to [[spawn]]ed code would raise an error due to the usage of the then non-serializable {{hl|[[Magic Variables#this|_this]]}} variable. <!--
-->Using [[disableSerialization]] or [[uiNamespace]] wouldn't help; the trick here is to pass the argument inside an array:
<sqf>
_display = findDisplay 46;
_display  spawn { hint str _this; }; // would raise a serialization error
[_display] spawn { hint str (_this select 0); }; // OK</sqf>
}}


|x1= <code>[[disableSerialization]];
|s1= [[disableSerialization]]
_display = [[findDisplay]] 46;</code> |EXAMPLE1=


____________________________________________________________________________________________
|r1= [[Nothing]]


| [[Display]], [[displayAddEventHandler]], [[displayRemoveAllEventHandlers]], [[displayRemoveEventHandler]], [[uiSleep]] |SEEALSO=  
|x1= <sqf>
disableSerialization;
private _display = findDisplay 46;
</sqf>


| |MPBEHAVIOUR=
|seealso= [[Display]] [[displayAddEventHandler]] [[displayRemoveAllEventHandlers]] [[displayRemoveEventHandler]] [[uiSleep]]
}}
}}


<h3 style='display:none'>Notes</h3>
{{Note
<dl class='command_description'>
|user= Str
<!-- Note Section BEGIN -->
|timestamp= 20100619102600
<dd class="notedate">Posted on 19 June, 2010
|text= Can be used to detecting load. Scope with disabled serialization is discontinued after load, even if there's endless loop inside.
<dt class="note">[[User:Str|Str]]
<sqf>
<dd class="note">
0 spawn { disableSerialization; waitUntil { false }; hint "Game was loaded!";};
Can be used to detecting load. Scope with disabled serialization is discontinued after load, even if there's endless loop inside.
</sqf>
<code>_loaded = [] [[spawn]] { [[disableSerialization]]; [[waitUntil]] { [[false]] }; };
[[waitUntil]] { [[scriptDone]] _loaded; };
[[hint]] "Game was loaded!";</code>
Works for all possible load types - loading user save, loading autosave and resuming mission from main menu.
Works for all possible load types - loading user save, loading autosave and resuming mission from main menu.


Use with caution, as it handles two threads in memory, having impact at overall [[Code_Optimisation#Threads|scripting time]].
Use with caution, as it creates an infinite loop, having impact at overall [[Code_Optimisation#Threads|scripting time]].
}}


<dd class="notedate">Posted on 23 October, 2013
{{Note
<dt class="note">[[User:Killzone_Kid|Killzone_Kid]]
|user= Killzone_Kid
<dd class="note">
|timestamp= 20131023025700
|text= If you do not store UI elements ([[Display]], [[Control]]) in variables, you do not need [[disableSerialization]]; UI elements are usually returned by scripting commands such as [[findDisplay]] or passed as params in UI event handler scripts ([[displayAddEventHandler]], [[ctrlAddEventHandler]]).


If you do not store UI elements ([[Display]], [[Control]]) in variables, you do not need [[disableSerialization]]; UI elements are usually returned by scripting commands such as [[findDisplay]] or passed as params in UI event handler scripts ([[displayAddEventHandler]], [[ctrlAddEventHandler]]).
This code will require [[disableSerialization]]:
<sqf>
disableSerialization;
_display = findDisplay 123;
_ctrl = _display displayCtrl -1;
_ctrl ctrlSetText "LOL";
</sqf>
This code will not:
<sqf>findDisplay 123 displayCtrl -1 ctrlSetText "LOL";</sqf>
}}


This code will require [[disableSerialization]]: <code>[[disableSerialization]];
{{Note
_display = [[findDisplay]] 123;
|user= Nelis75733126
_ctrl = _display [[displayCtrl]] -1;
|timestamp= 20170625181500
_ctrl [[ctrlSetText]] "LOL";</code>
|text= In {{arma3}} 1.74, a scripted FSM is somehow incompatible with <sqf inline>disableSerialization</sqf>.<br>
This code will not: <code>[[findDisplay]] 123 [[displayCtrl]] -1 [[ctrlSetText]] "LOL";</code>
As a workaround, store a display inside an array. Example:
 
<sqf>_display = [findDisplay idd];</sqf>
<dd class="notedate">Posted on July 25, 2017 - 18:15 (UTC)</dd>
}}
<dt class="note">[[User:IT07|IT07]]</dt>
<dd class="note">
In Arma 3 1.72.142223, a scripted FSM does somehow not work with [[disableSerialization]]. As a workaround, store a display inside an array.
Example: <code>_d = [findDisplay idd];</code>
 
<!-- Note Section END -->
</dl>
 
<h3 style='display:none'>Bottom Section</h3>
 
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]

Latest revision as of 21:24, 2 September 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:
Disable saving of script containing this command. After this, the script can work with data types which do not support serialization (UI types).
ⓘ
See Namespace serialization for more information.
⚠
In Arma 2 and up to a certain version of Arma 3, giving a Display or Control to spawned code would raise an error due to the usage of the then non-serializable _this variable. Using disableSerialization or uiNamespace wouldn't help; the trick here is to pass the argument inside an array:
_display = findDisplay 46; _display spawn { hint str _this; }; // would raise a serialization error [_display] spawn { hint str (_this select 0); }; // OK
Groups:
NamespacesGUI Control

Syntax

Syntax:
disableSerialization
Return Value:
Nothing

Examples

Example 1:
disableSerialization; private _display = findDisplay 46;

Additional Information

See also:
Display displayAddEventHandler displayRemoveAllEventHandlers displayRemoveEventHandler uiSleep

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
Str - c
Posted on Jun 19, 2010 - 10:26 (UTC)
Can be used to detecting load. Scope with disabled serialization is discontinued after load, even if there's endless loop inside.
0 spawn { disableSerialization; waitUntil { false }; hint "Game was loaded!";};
Works for all possible load types - loading user save, loading autosave and resuming mission from main menu. Use with caution, as it creates an infinite loop, having impact at overall scripting time.
Killzone_Kid - c
Posted on Oct 23, 2013 - 02:57 (UTC)
If you do not store UI elements (Display, Control) in variables, you do not need disableSerialization; UI elements are usually returned by scripting commands such as findDisplay or passed as params in UI event handler scripts (displayAddEventHandler, ctrlAddEventHandler). This code will require disableSerialization:
disableSerialization; _display = findDisplay 123; _ctrl = _display displayCtrl -1; _ctrl ctrlSetText "LOL";
This code will not:
findDisplay 123 displayCtrl -1 ctrlSetText "LOL";
Nelis75733126 - c
Posted on Jun 25, 2017 - 18:15 (UTC)
In Arma 3 1.74, a scripted FSM is somehow incompatible with disableSerialization.
As a workaround, store a display inside an array. Example:
_display = [findDisplay idd];
Retrieved from "https://community.bistudio.com/wiki?title=disableSerialization&oldid=369064"