disableSerialization: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Text replacement - "[] spawn" to "0 spawn")
 
(76 intermediate revisions by 11 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 script can work with the data types which do not support serialization (UI types).  |= Description
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| '''disableSerialization''' |= Syntax
|game4= arma3
|version4= 0.50


|p1= |= PARAMETER1
|gr1= Namespaces
|gr2= GUI Control


|p2= |= PARAMETER2
|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.}}


|p3= |= PARAMETER3
{{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>
}}


| Nothing |= RETURNVALUE
|s1= [[disableSerialization]]


|r1= [[Nothing]]


|x1= <code>disableSerialization;
|x1= <sqf>
_display <nowiki>=</nowiki> [[findDisplay]] 46;</code>|= EXAMPLE1
disableSerialization;
private _display = findDisplay 46;
</sqf>


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


| [[Display]], [[displayAddEventHandler]], [[displayRemoveAllEventHandlers]], [[displayRemoveEventHandler]] |= SEEALSO
{{Note
|user= Str
|timestamp= 20100619102600
|text= Can be used to detecting load. Scope with disabled serialization is discontinued after load, even if there's endless loop inside.
<sqf>
0 spawn { disableSerialization; waitUntil { false }; hint "Game was loaded!";};
</sqf>
Works for all possible load types - loading user save, loading autosave and resuming mission from main menu.


| |= MPBEHAVIOUR
Use with caution, as it creates an infinite loop, having impact at overall [[Code_Optimisation#Threads|scripting time]].
____________________________________________________________________________________________
}}
}}


<h3 style='display:none'>Notes</h3>
{{Note
<dl class='command_description'>
|user= Killzone_Kid
<!-- Note Section BEGIN -->
|timestamp= 20131023025700
<dd class="notedate">Posted on 19 June, 2010</dd>
|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]]).  
<dt class="note">[[User:Str|Str]]</dt>
<dd class="note">
Can be used to detecting load. Scope with disabled serialization is discontinued after load, even if there's endless loop inside.
_loaded = [] [[spawn]] {[[disableSerialization]]; [[waitUntil]] {[[false]]};};
waitUntil {[[scriptDone]] _loaded;};
[[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 handles two threads in memory, having impact at overall [[Code_Optimisation#Threads|scripting time]].
This code will require [[disableSerialization]]:
</dd>
<sqf>
<!-- Note Section END -->
disableSerialization;
</dl>
_display = findDisplay 123;
_ctrl = _display displayCtrl -1;
_ctrl ctrlSetText "LOL";
</sqf>
This code will not:
<sqf>findDisplay 123 displayCtrl -1 ctrlSetText "LOL";</sqf>
}}


<h3 style='display:none'>Bottom Section</h3>
{{Note
[[Category:ArmA 2: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
|user= Nelis75733126
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
|timestamp= 20170625181500
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
|text= In {{arma3}} 1.74, a scripted FSM is somehow incompatible with <sqf inline>disableSerialization</sqf>.<br>
As a workaround, store a display inside an array. Example:
<sqf>_display = [findDisplay idd];</sqf>
}}

Latest revision as of 21:24, 2 September 2024

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:
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];