Differences

This shows you the differences between two versions of the page.

--- 4rpl:commands:getscriptvar [2022/09/20 17:01] – [Description] init_var mention Vertu
+++ 4rpl:commands:getscriptvar [2025/02/14 14:57] (current) – external edit 127.0.0.1
@@ Line 11: / Line 11: @@
 ===== Description =====
-Gets the named variable on the specified unit and script.
+Gets the named variable on the specified unit and script.\\
-The script is referenced by name. If the name is an empty string, the first (possibly only) script on the unit will be referenced.
+The script is referenced by name. If the name is an empty string, the first (possibly only) script on the unit will be referenced. The extention ".4rpl" must be included.\\
-The value returned will be a direct instance of the var held by the unit.
+The value returned will be a direct instance of the var held by the unit. If the unit or var does not exit, a null value (equivalent to 0) is returned.
-If the unit or var does not exit, a null value (equivalent to 0) is returned.
-:NOTE: Although input/init variables ($varName:<VARIABLE TYPE>) are technically the unit settings of a custom unit, they are still variables and applicable to this API.
 ===== Examples =====
 <code 4rpl>
-GetScriptVar(<-someUnitUID "MyScript" "test") ->val
+GetScriptVar(<-someUnitUID "MyScript.4rpl" "test") ->val
 </code>
 <=[[4rpl:start| Index]]

Knuckle Cracker Wiki