EQ2Emulator - User contributions [en]

LUA:GetServerVariable

2016-08-09T02:34:57Z

Patrikpatrik: /* Notes */

{{PageHeaderChild|LUA|GetServerVariable}}

== GetServerVariable() ==
Gets the value of the server variable only set by lua via [[LUA:SetServerVariable|SetServerVariable()]]. When using this function, ignore adding the 'lua_' prefix to your parameter.

== Syntax ==
var = GetServerVariable(param1)

== Parameters ==
; Required - ''param1'' (String)
: ''param1'' is the name of the server variable to get

== Returns ==
; String

== Usage ==
<pre>
function hailed(NPC, Spawn)
local var = tonumber(GetServerVariable("Quest1_Global_Complete_Count"))

if var == nil or var <= 4000 then
OfferQuest(Spawn, Quest1)
else
OfferQuest(Spawn, Quest2)
end
end
</pre>

This will offer the player a different quest if the server variable Quest1_Global_Complete_Count is less then or equal to 4000

== Notes ==
If the server variable is not a number then tonumber returns nil, hence the check for nil.

Also, if the value is a string, for example a 'motd' variable, or an existing non 'lua_' prefix variable_name, it will return as NULL. Use [[LUA:GetVariableValue|GetVariableValue()]] instead for these conditions.

LUA:GetServerVariable

2016-08-09T02:34:26Z

Patrikpatrik: /* Notes */

{{PageHeaderChild|LUA|GetServerVariable}}

== GetServerVariable() ==
Gets the value of the server variable only set by lua via [[LUA:SetServerVariable|SetServerVariable()]]. When using this function, ignore adding the 'lua_' prefix to your parameter.

== Syntax ==
var = GetServerVariable(param1)

== Parameters ==
; Required - ''param1'' (String)
: ''param1'' is the name of the server variable to get

== Returns ==
; String

== Usage ==
<pre>
function hailed(NPC, Spawn)
local var = tonumber(GetServerVariable("Quest1_Global_Complete_Count"))

if var == nil or var <= 4000 then
OfferQuest(Spawn, Quest1)
else
OfferQuest(Spawn, Quest2)
end
end
</pre>

This will offer the player a different quest if the server variable Quest1_Global_Complete_Count is less then or equal to 4000

== Notes ==
If the server variable is not a number then tonumber returns nil, hence the check for nil.

Also, if the value is a string, for example a 'motd' variable, or an existing non 'LUA_' prefix variable_name, it will return as NULL. Use [[LUA:GetVariableValue|GetVariableValue()]] instead for these conditions.

LUA:GetVariableValue

2016-08-09T02:33:08Z

Patrikpatrik: /* Notes */

= LUA Functions: GetVariableValue() =
Gets the value of the given variable

==== Syntax ====
var = GetVariableValue(param1)

==== Parameters ====
; Required - ''param1'' (string)
: ''param1'' is the name of the variable

==== Usage ====
<pre>
function hailed(NPC, Spawn)
Say(NPC, "Level cap is set to " .. GetVariableValue("level_cap"))
end
</pre>

The NPC will respond with the level cap for the server

== Notes ==
Returns a string

This gets the values for variables in the `variables` table.

Also, if you want to return values set by [[LUA:SetServerVariable|SetServerVariable()]], make sure to include the 'lua_' prefix, slightly different from [[LUA:GetServerVariable|GetServerVariable()]].

LUA:SetServerVariable

2016-08-09T02:28:00Z

Patrikpatrik: /* SetServerVariable() */

{{PageHeaderChild|LUA|SetServerVariable}}

== SetServerVariable() ==
Sets the server variable. This will persist when you zone etc., use this in conjunction with [[LUA:GetServerVariable|GetServerVariable()]]. Use sparingly as to prevent clutter in variables table.

== Syntax ==
SetServerVariable(param1, param2, param3)

== Parameters ==
; Required - ''param1'' (String), ''param2'' (String)
: ''param1'' is the variable name
: ''param2'' is the value to set the variable to
; Optional - ''param3'' (String)
: ''param3'' is the comment for the variable

== Usage ==
<pre>
function CompleteQuest(Quest, QuestGiver, Player)
GiveQuestReward(Quest, Player)

local var = tonumber(GetServerVariable("Quest1_Global_Complete_Count"))
if var == nil then
SetServerVariable("Quest1_Global_Complete_Count", "1", "Number of times Quest 1 has been completed across the server")
else
var = var + 1
SetServerVariable("Quest1_Global_Complete_Count", var)
end
end
</pre>

Every time this quest is completed it will increment the server variable, if it hasn't been completed yet it will create a new server variable

== Notes ==
In the server core "lua_" will automatically be added to the front of the name, you only need to know this if you plan to look the variable up in the DB

LUA:GetServerVariable

2016-08-09T02:26:46Z

Patrikpatrik: /* GetServerVariable() */

{{PageHeaderChild|LUA|GetServerVariable}}

== GetServerVariable() ==
Gets the value of the server variable only set by lua via [[LUA:SetServerVariable|SetServerVariable()]]. When using this function, ignore adding the 'lua_' prefix to your parameter.

== Syntax ==
var = GetServerVariable(param1)

== Parameters ==
; Required - ''param1'' (String)
: ''param1'' is the name of the server variable to get

== Returns ==
; String

== Usage ==
<pre>
function hailed(NPC, Spawn)
local var = tonumber(GetServerVariable("Quest1_Global_Complete_Count"))

if var == nil or var <= 4000 then
OfferQuest(Spawn, Quest1)
else
OfferQuest(Spawn, Quest2)
end
end
</pre>

This will offer the player a different quest if the server variable Quest1_Global_Complete_Count is less then or equal to 4000

== Notes ==
If the server variable is not a number then tonumber returns nil, hence the check for nil.

Also, if the value is a string, for example a 'motd' variable, or an existing non 'LUA_' prefix variable_name, it will return as NULL. Use [[LUA:GetVariableValue|GetVariableValue()]] for those criteria instead.

LUA:GetServerVariable

2016-08-09T02:26:05Z

Patrikpatrik: /* GetServerVariable() */

{{PageHeaderChild|LUA|GetServerVariable}}

== GetServerVariable() ==
Gets the value of the server variable only set by lua via [[LUA:SetServerVariable|SetServerVariable()]]. When using this function, ignore adding the 'lua_' prefix.

== Syntax ==
var = GetServerVariable(param1)

== Parameters ==
; Required - ''param1'' (String)
: ''param1'' is the name of the server variable to get

== Returns ==
; String

== Usage ==
<pre>
function hailed(NPC, Spawn)
local var = tonumber(GetServerVariable("Quest1_Global_Complete_Count"))

if var == nil or var <= 4000 then
OfferQuest(Spawn, Quest1)
else
OfferQuest(Spawn, Quest2)
end
end
</pre>

This will offer the player a different quest if the server variable Quest1_Global_Complete_Count is less then or equal to 4000

== Notes ==
If the server variable is not a number then tonumber returns nil, hence the check for nil.

Also, if the value is a string, for example a 'motd' variable, or an existing non 'LUA_' prefix variable_name, it will return as NULL. Use [[LUA:GetVariableValue|GetVariableValue()]] for those criteria instead.

LUA:GetServerVariable

2016-08-09T02:17:00Z

Patrikpatrik: /* Notes */

{{PageHeaderChild|LUA|GetServerVariable}}

== GetServerVariable() ==
Gets the value of the server variable

== Syntax ==
var = GetServerVariable(param1)

== Parameters ==
; Required - ''param1'' (String)
: ''param1'' is the name of the server variable to get

== Returns ==
; String

== Usage ==
<pre>
function hailed(NPC, Spawn)
local var = tonumber(GetServerVariable("Quest1_Global_Complete_Count"))

if var == nil or var <= 4000 then
OfferQuest(Spawn, Quest1)
else
OfferQuest(Spawn, Quest2)
end
end
</pre>

This will offer the player a different quest if the server variable Quest1_Global_Complete_Count is less then or equal to 4000

== Notes ==
If the server variable is not a number then tonumber returns nil, hence the check for nil.

Also, if the value is a string, for example a 'motd' variable, or an existing non 'LUA_' prefix variable_name, it will return as NULL. Use [[LUA:GetVariableValue|GetVariableValue()]] for those criteria instead.

LUA:SetServerVariable

2016-08-09T02:12:12Z

Patrikpatrik: /* SetServerVariable() */

{{PageHeaderChild|LUA|SetServerVariable}}

== SetServerVariable() ==
Sets the server variable. This will persist when you zone etc., use this in conjunction with [[LUA:GetServerVariable|GetServerVariable()]].

== Syntax ==
SetServerVariable(param1, param2, param3)

== Parameters ==
; Required - ''param1'' (String), ''param2'' (String)
: ''param1'' is the variable name
: ''param2'' is the value to set the variable to
; Optional - ''param3'' (String)
: ''param3'' is the comment for the variable

== Usage ==
<pre>
function CompleteQuest(Quest, QuestGiver, Player)
GiveQuestReward(Quest, Player)

local var = tonumber(GetServerVariable("Quest1_Global_Complete_Count"))
if var == nil then
SetServerVariable("Quest1_Global_Complete_Count", "1", "Number of times Quest 1 has been completed across the server")
else
var = var + 1
SetServerVariable("Quest1_Global_Complete_Count", var)
end
end
</pre>

Every time this quest is completed it will increment the server variable, if it hasn't been completed yet it will create a new server variable

== Notes ==
In the server core "lua_" will automatically be added to the front of the name, you only need to know this if you plan to look the variable up in the DB

LUA:SetServerVariable

2016-08-09T02:07:58Z

Patrikpatrik: /* SetServerVariable() */

{{PageHeaderChild|LUA|SetServerVariable}}

== SetServerVariable() ==
Sets the server variable. This will persist when you zone etc., use this in conjunction with GetServerVariable().

== Syntax ==
SetServerVariable(param1, param2, param3)

== Parameters ==
; Required - ''param1'' (String), ''param2'' (String)
: ''param1'' is the variable name
: ''param2'' is the value to set the variable to
; Optional - ''param3'' (String)
: ''param3'' is the comment for the variable

== Usage ==
<pre>
function CompleteQuest(Quest, QuestGiver, Player)
GiveQuestReward(Quest, Player)

local var = tonumber(GetServerVariable("Quest1_Global_Complete_Count"))
if var == nil then
SetServerVariable("Quest1_Global_Complete_Count", "1", "Number of times Quest 1 has been completed across the server")
else
var = var + 1
SetServerVariable("Quest1_Global_Complete_Count", var)
end
end
</pre>

Every time this quest is completed it will increment the server variable, if it hasn't been completed yet it will create a new server variable

== Notes ==
In the server core "lua_" will automatically be added to the front of the name, you only need to know this if you plan to look the variable up in the DB