LUA:GetTempVariable - Revision history

Jabantiz at 20:33, 25 May 2013

2013-05-25T20:33:16Z

Jabantiz at 20:32, 25 May 2013

2013-05-25T20:32:59Z

Jabantiz: Created page with "= LUA Functions: GetTempVariable() = Gets the value the given spawn has for the given variable ==== Syntax ==== var = GetTempVariable(param1, param2) ==== Parameters ==== ; R..."

2013-05-25T01:56:18Z

Created page with "= LUA Functions: GetTempVariable() = Gets the value the given spawn has for the given variable ==== Syntax ==== var = GetTempVariable(param1, param2) ==== Parameters ==== ; R..."

New page

= LUA Functions: GetTempVariable() =
Gets the value the given spawn has for the given variable

==== Syntax ====
var = GetTempVariable(param1, param2)

==== Parameters ====
; Required - ''param1'' (Spawn), ''param2'' (String)
: ''param1'' is the spawn who's temp variable we are checking
: ''param2'' is the variable we are checking

==== Returns ====
; String
: Value for the given variable

==== Usage ====
<pre>
function hailed(NPC, Spawn)
Say(NPC, "FOO = " .. GetTempVariable(NPC, "FOO") .. "!")
end
</pre>

When hailed the spawn will say the value it has for the variable FOO

==== Notes ====
If the variable is not set it will return ""

@@ Line 29: / Line 29: @@
 ==== Notes ====
 If the variable is not set it will return nil
 It is important that the scripter knows the type of the value stored in the variable

@@ Line 14: / Line 14: @@
 ==== Returns ====
-; String
+; String, Spawn, Zone, Item, or Quest
 : Value for the given variable
@@ Line 28: / Line 28: @@
 ==== Notes ====
-If the variable is not set it will return ""
+If the variable is not set it will return nil