Latest revision as of 12:36, 22 November 2013

LUA Functions: SetSkillValue()

Sets the current value of the given skill

SetSkillValue(param1, param2)

Required - param1 (Skill), param2 (int16): param1 is the skill who's value we want to set; param2 is the value we want to set it to

function respec(Player)
    skill = GetSkill(Player, "Offence")
    if skill ~= nil then
        SetSkillValue(skill, 35)
    end
end

When this function is called the players offence skill value will be set to 35

If the value exceeds the skill's max value it will be set to max value instead

@@ Line 1: / Line 1: @@
-= LUA Functions: GetSkillValue() =
+= LUA Functions: SetSkillValue() =
-Gets the current value of the given skill
+Sets the current value of the given skill
 ==== Syntax ====
-GetSkillValue(param1)
+SetSkillValue(param1, param2)
 ==== Parameters ====
-; Required - ''param1'' (Skill)
+; Required - ''param1'' (Skill), ''param2'' (int16)
-: ''param1'' is the skill who's current value we want
+: ''param1'' is the skill who's value we want to set
+: ''param2'' is the value we want to set it to
 ==== Usage ====
 <pre>
-function hailed(NPC, Spawn)
+function respec(Player)
-     skill = GetSkill(Spawn, "Offence")
+     skill = GetSkill(Player, "Offence")
      if skill ~= nil then
-         Say(NPC, "Your offence is at " .. GetSkillValue(skill))
+         SetSkillValue(skill, 35)
-    else
-        Say(NPC, "You do not have the offence skill")
      end
 end
 </pre>
-The hailed NPC will respond with the players skill value
+When this function is called the players offence skill value will be set to 35
+== Note ==
+If the value exceeds the skill's max value it will be set to max value instead