compileFinal: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Add v2.14's alternative syntax)
mNo edit summary
 
(6 intermediate revisions by 3 users not shown)
Line 6: Line 6:
|gr1= Strings
|gr1= Strings


|descr= Compiles an expression and makes it final, preventing it from:
|descr= Compiles an expression / takes an existing [[HashMap]] and makes it final, preventing it from being modified or overwritten (by [[=]] assignation, [[publicVariable]], [[set]] or any other command).
* being modified by [[compile]] or [[compileFinal]]
* being removed with [[nil]]
* being modified by [[publicVariable]], [[publicVariableClient]] or [[publicVariableServer]]
{{Feature|informative|This feature is only available in the retail version of {{arma3}}.}}
{{Feature|informative|This feature is only available in the retail version of {{arma3}}.}}


|s1= [[compileFinal]] expression
|s1= [[compileFinal]] expression


|p1= expression: [[String]], {{GVI|arma3|2.14|size= 0.75}} [[Code]] or {{GVI|arma3|2.14|size= 0.75}} [[HashMap]]
|p1= expression: [[String]], {{GVI|arma3|2.14|size= 0.75}} [[Code]] or [[HashMap]]


|r1= [[Code]]
|r1= [[Code]] or [[HashMap]]


|x1= <sqf>
|x1= <sqf>
MyCode = compileFinal "a = a + 1";
_myCode = compileFinal "a = a + 1";
call MyCode;
call _myCode;
   
   
// repeated compile won't have any effect
// repeated compile won't have any effect
MyCode = compileFinal "a = a + 2";
_myCode = compileFinal "a = a + 2";
</sqf>


|x2= <sqf>
// duplicate code will be final as well
// duplicate code will be final as well
MyDuplicateCode = MyCode;
_myDuplicateCode = _myCode;
 
// an alternative is to copy str'd code (since Arma 3 v2.02)
private _myNonFinalCopy = compile toString _myCode;
</sqf>
</sqf>


|x2= <sqf>
|x3= <sqf>
MyCode = compileFinal {
// since {{arma3}} v2.14
systemChat "Hello World!";
private _readonlyCode = compileFinal { systemChat "Hello World!"; };
};
private _readonlyHashMap = compileFinal _myHashMap;
</sqf>
</sqf>
|x3= <sqf>private _readonlyHashMap = compileFinal _myHashMap;</sqf>


|seealso= [[compile]] [[compileScript]] [[isFinal]] [[call]] [[spawn]]
|seealso= [[compile]] [[compileScript]] [[isFinal]] [[call]] [[spawn]]
Line 48: Line 48:


{{Note
{{Note
|user= IT07
|user= Nelis.75733126
|timestamp= 20170527115800
|timestamp= 20170527115800
|text= in {{arma3}} v1.70.141838, [[compileFinal]] also works for [[profileNamespace]] and [[uiNamespace]]. But be careful with that.
|text= in {{arma3}} v1.70.141838, [[compileFinal]] also works for [[profileNamespace]] and [[uiNamespace]]. But be careful with that.
Line 57: Line 57:
|timestamp= 20201023103900
|timestamp= 20201023103900
|text= Change with {{arma3}} {{Link|https://dev.arma3.com/post/spotrep-00095|patch 2.00}}, [[compileFinal]] is now '''unable''' to store code type variables in [[profileNamespace]]!
|text= Change with {{arma3}} {{Link|https://dev.arma3.com/post/spotrep-00095|patch 2.00}}, [[compileFinal]] is now '''unable''' to store code type variables in [[profileNamespace]]!
}}
{{Note
|user= Hypoxic125
|timestamp= 20240622234127
|text= Making a base class read only using HashMapObjects
<sqf>
Class_Dog = compileFinal createHashMapObject [
    // Properties
    ["#type", "Dog"],
    ["owner", objNull],
    ["legs", 4],
    ["health", 100],
    ["vehicleclass", "Dog_Base_F"],
    ["vehicle", objNull],
// Constructor
    ["#create", {
        params [["_owner", objNull], ["_vehicle", objNull]];
        if ([_owner, _vehicle] findIf {isNull _x} != -1) exitWith {};
        _self set ["owner", _owner];
        _self set ["vehicle", _vehicle]
    }]
];
NewDog = createHashMapObject [
    [["#base", Class_Dog]],
    [player_1, createVehicle [Class_Dog get "vehicleclass", [0,0,0], 0, [], "NONE"]]
];
NewDog set ["owner", player_2];
NewDog get "owner";                // returns player_2
Class_Dog set ["owner", player_1];  // Error: Read Only
</sqf>
}}
}}

Latest revision as of 01:42, 23 June 2024

Hover & click on the images for description

Description

Description:
Compiles an expression / takes an existing HashMap and makes it final, preventing it from being modified or overwritten (by = assignation, publicVariable, set or any other command).
This feature is only available in the retail version of Arma 3.
Groups:
Strings

Syntax

Syntax:
compileFinal expression
Parameters:
expression: String, Arma 3 logo black.png2.14 Code or HashMap
Return Value:
Code or HashMap

Examples

Example 1:
_myCode = compileFinal "a = a + 1"; call _myCode; // repeated compile won't have any effect _myCode = compileFinal "a = a + 2";
Example 2:
// duplicate code will be final as well _myDuplicateCode = _myCode; // an alternative is to copy str'd code (since Arma 3 v2.02) private _myNonFinalCopy = compile toString _myCode;
Example 3:
// since Arma 3 v2.14 private _readonlyCode = compileFinal { systemChat "Hello World!"; }; private _readonlyHashMap = compileFinal _myHashMap;

Additional Information

See also:
compile compileScript isFinal call spawn

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
AgentRev01 - c
Posted on Aug 15, 2013 - 00:35 (UTC)
When broadcasting a compileFinal'ed variable using publicVariable or its variants, the variable also becomes final on the other client(s) and/or the server. Also, compileFinal does not prevent event handlers from being removed or overwritten.
Nelis.75733126 - c
Posted on May 27, 2017 - 11:58 (UTC)
in Arma 3 v1.70.141838, compileFinal also works for profileNamespace and uiNamespace. But be careful with that.
Dscha - c
Posted on Oct 23, 2020 - 10:39 (UTC)
Change with Arma 3 patch 2.00, compileFinal is now unable to store code type variables in profileNamespace!
Hypoxic125 - c
Posted on Jun 22, 2024 - 23:41 (UTC)
Making a base class read only using HashMapObjects
Class_Dog = compileFinal createHashMapObject [ // Properties ["#type", "Dog"], ["owner", objNull], ["legs", 4], ["health", 100], ["vehicleclass", "Dog_Base_F"], ["vehicle", objNull], // Constructor ["#create", { params [["_owner", objNull], ["_vehicle", objNull]]; if ([_owner, _vehicle] findIf {isNull _x} != -1) exitWith {}; _self set ["owner", _owner]; _self set ["vehicle", _vehicle] }] ]; NewDog = createHashMapObject [ [["#base", Class_Dog]], [player_1, createVehicle [Class_Dog get "vehicleclass", [0,0,0], 0, [], "NONE"]] ]; NewDog set ["owner", player_2]; NewDog get "owner"; // returns player_2 Class_Dog set ["owner", player_1]; // Error: Read Only