another 113 lua functions..

docs/lua_functions/CastCustomSpell.md

@@ -1,22 +1,27 @@
-### Function: CastCustomSpell(param1, param2, param3, param4, param5, param6, param7)
+### Function: CastCustomSpell(spell, caster, target)
 
 **Description:**
-Placeholder description.
+Casts a custom spell that has been created through a Spell Script.
 
 **Parameters:**
-- `param1`: unknown - Unknown type.
+- `spell` (Spell) - Spell object representing `spell`.
-- `param2`: unknown - Unknown type.
+- `caster` (Spawn) - Spawn object representing `caster`.
-- `param3`: unknown - Unknown type.
+- `target` (Spawn) - Spawn object representing `target`.
-- `param4`: unknown - Unknown type.
-- `param5`: unknown - Unknown type.
-- `param6`: Spawn - The spawn or entity involved.
-- `param7`: Spawn - The spawn or entity involved.
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From ItemScripts/AbbatoirCoffee.lua
-CastCustomSpell(..., ..., ..., ..., ..., ..., ...)
+function cast(Item, Player)
+	Spell = GetSpell(5463)
+	Regenz = 18.0
+	newDuration = 180000
+	SetSpellData(Spell, "duration1", newDuration)
+	SetSpellData(Spell, "duration2", newDuration)
+	SetSpellDataIndex(Spell, 0, Regenz)
+	SetSpellDisplayEffect(Spell, 0, "description", "Increases Out-of-Combat Power Regeneration of target by " .. Regenz)
+	CastCustomSpell(Spell, Player, Player)
+end
 ```

docs/lua_functions/CastEntityCommand.md

@@ -1,24 +1,23 @@
-### Function: CastEntityCommand(param1, param2, param3, param4, param5, param6, param7, param8, param9)
+### Function: CastEntityCommand(caster, target, id, command)
 
 **Description:**
-Placeholder description.
+Calls an Entity Command through LUA versus the player triggering it themselves.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `caster` (Spawn) - Spawn object representing `caster`.
-- `param2`: unknown - Unknown type.
+- `target` (Spawn) - Spawn object representing `target`.
-- `param3`: unknown - Unknown type.
+- `id` (uint32) - Integer value `id`.
-- `param4`: unknown - Unknown type.
+- `command` (string) - String `command`.
-- `param5`: unknown - Unknown type.
-- `param6`: unknown - Unknown type.
-- `param7`: Spawn - The spawn or entity involved.
-- `param8`: int32 - Integer value.
-- `param9`: string - String value.
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From ItemScripts/AutomaticBook.lua
-CastEntityCommand(..., ..., ..., ..., ..., ..., ..., ..., ...)
+function obtained(Item, Spawn)    
+    target = GetTarget(Spawn)
+    if target ~= nil then
+--        CastEntityCommand(Spawn, target, 1, "Scribe")
+end
 ```

docs/lua_functions/HasCollectionsToHandIn.md

@@ -1,16 +1,24 @@
-### Function: HasCollectionsToHandIn(param1)
+### Function: HasCollectionsToHandIn(player)
 
 **Description:**
-Placeholder description.
+Return's if the player has collections to turn in.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `player` (Spawn) - Spawn object representing `player`.
 
-**Returns:** None.
+**Returns:** Return's true if there is collections complete to turn in, otherwise false.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From SpawnScripts/EastFreeport/RennyParvat.lua
-HasCollectionsToHandIn(...)
+function Dialog1(NPC, Spawn)
+	FaceTarget(NPC, Spawn)
+	Dialog.New(NPC, Spawn)
+	Dialog.AddDialog("This is a decent find, I suppose. I can give you a small reward for it.")
+	Dialog.AddOption("Thanks a lot.")
+	Dialog.Start()
+    if HasCollectionsToHandIn(Spawn) then
+    HandInCollections(Spawn) 
+    end
 ```

docs/lua_functions/HasCompletedQuest.md

@@ -1,17 +1,25 @@
-### Function: HasCompletedQuest(param1, param2)
+### Function: HasCompletedQuest(player, quest_id)
 
 **Description:**
-Placeholder description.
+Return's true if the quest_id has been previously completed by the player.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `player` (Spawn) - Spawn object representing `player`.
-- `param2`: int32 - Integer value.
+- `quest_id` (uint32) - Integer value `quest_id`.
 
-**Returns:** None.
+**Returns:** If player has completed quest_id then return's true, otherwise false.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From ItemScripts/abixieeye.lua
-HasCompletedQuest(..., ...)
+function examined(Item, Player)
+    local LnLAccept = GetRuleFlagFloat("R_World", "LoreAndLegendAccept")
+if LnLAccept > 0 and not HasQuest(Player, LoreAndLegendBixie) and not HasCompletedQuest(Player, LoreAndLegendBixie) then
+    OfferQuest(nil, Player, LoreAndLegendBixie)
+else
+    conversation = CreateConversation()    
+if  HasQuest(Player, LoreAndLegendBixie) and  GetQuestStepProgress(Player, LoreAndLegendBixie, 4)==0 then
+    AddConversationOption(conversation, "Begin to study...", "Step_Complete")
+end
 ```

docs/lua_functions/HasFreeSlot.md

@@ -1,16 +1,13 @@
-### Function: HasFreeSlot(param1)
+### Function: HasFreeSlot(player)
 
 **Description:**
-Placeholder description.
+Return's true if there is a free slot in player's inventory, otherwise false.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `player` (Spawn) - Spawn object representing `player`.
 
-**Returns:** None.
+**Returns:** True if there is an open inventory slot for the Player, otherwise false.
 
 **Example:**
 
-```lua
+Example Required
--- Example usage
-HasFreeSlot(...)
-```

docs/lua_functions/HasGroup.md

@@ -1,17 +1,13 @@
-### Function: HasGroup(param1, param2)
+### Function: HasGroup(spawn)
 
 **Description:**
-Placeholder description.
+Return's if the spawn is in a group.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
-- `param2`: unknown - Unknown type.
 
-**Returns:** None.
+**Returns:** True if the spawn is in a group, otherwise false.
 
 **Example:**
 
-```lua
+Example Required
--- Example usage
-HasGroup(..., ...)
-```

docs/lua_functions/HasItemEquipped.md

@@ -1,64 +1,21 @@
-### Function: HasItemEquipped(param1, param2, param3, param4, param5, param6, param7, param8, param9, param10, param11, param12, param13, param14, param15, param16, param17, param18, param19, param20, param21, param22, param23, param24, param25, param26, param27, param28, param29, param30, param31, param32, param33, param34, param35, param36, param37, param38, param39, param40, param41, param42, param43, param44, param45, param46, param47, param48, param49)
+### Function: HasItemEquipped(player, item_id)
 
 **Description:**
-Placeholder description.
+Return's if the player has an item equipped with the item_id.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `player` (Spawn) - Spawn object representing `player`.
-- `param2`: unknown - Unknown type.
+- `item_id` (uint32) - Integer value `item_id`.
-- `param3`: Spawn - The spawn or entity involved.
-- `param4`: unknown - Unknown type.
-- `param5`: unknown - Unknown type.
-- `param6`: unknown - Unknown type.
-- `param7`: Spawn - The spawn or entity involved.
-- `param8`: unknown - Unknown type.
-- `param9`: unknown - Unknown type.
-- `param10`: unknown - Unknown type.
-- `param11`: Spawn - The spawn or entity involved.
-- `param12`: unknown - Unknown type.
-- `param13`: unknown - Unknown type.
-- `param14`: unknown - Unknown type.
-- `param15`: Spawn - The spawn or entity involved.
-- `param16`: unknown - Unknown type.
-- `param17`: unknown - Unknown type.
-- `param18`: unknown - Unknown type.
-- `param19`: Spawn - The spawn or entity involved.
-- `param20`: unknown - Unknown type.
-- `param21`: unknown - Unknown type.
-- `param22`: unknown - Unknown type.
-- `param23`: Spawn - The spawn or entity involved.
-- `param24`: unknown - Unknown type.
-- `param25`: unknown - Unknown type.
-- `param26`: Spawn - The spawn or entity involved.
-- `param27`: unknown - Unknown type.
-- `param28`: unknown - Unknown type.
-- `param29`: unknown - Unknown type.
-- `param30`: int32 - Integer value.
-- `param31`: int8 - Small integer or boolean flag.
-- `param32`: int32 - Integer value.
-- `param33`: int8 - Small integer or boolean flag.
-- `param34`: int8 - Small integer or boolean flag.
-- `param35`: int8 - Small integer or boolean flag.
-- `param36`: int8 - Small integer or boolean flag.
-- `param37`: int32 - Integer value.
-- `param38`: int32 - Integer value.
-- `param39`: Item - An item reference.
-- `param40`: bool - Boolean value (true/false).
-- `param41`: int16 - Short integer value.
-- `param42`: int8 - Small integer or boolean flag.
-- `param43`: int8 - Small integer or boolean flag.
-- `param44`: int8 - Small integer or boolean flag.
-- `param45`: int8 - Small integer or boolean flag.
-- `param46`: int8 - Small integer or boolean flag.
-- `param47`: int8 - Small integer or boolean flag.
-- `param48`: int8 - Small integer or boolean flag.
-- `param49`: int8 - Small integer or boolean flag.
 
-**Returns:** None.
+**Returns:** Return's true if the item_id is equipped on the player, otherwise false.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From ItemScripts/Griz.lua
-HasItemEquipped(..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ...)
+function GrizChat2_1(Item, Spawn)
+	if GetQuestStep(Spawn, SometimesKnut) == 2 then
+		SetStepComplete(Spawn, SometimesKnut, 2)
+		AddSpawnAccess(GetSpawnByLocationID(Zone, 579551), Spawn)
+	end
 ```

docs/lua_functions/HasLanguage.md

@@ -1,19 +1,21 @@
-### Function: HasLanguage(param1, param2, param3, param4)
+### Function: HasLanguage(player, language_id)
 
 **Description:**
-Placeholder description.
+Return's true if the player has the language_id specified.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `player` (Spawn) - Spawn object representing `player`.
-- `param2`: unknown - Unknown type.
+- `language_id` (uint32) - Integer value `language_id`.
-- `param3`: unknown - Unknown type.
-- `param4`: int32 - Integer value.
 
-**Returns:** None.
+**Returns:** True if the language_id has been obtained by the player, otherwise false.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From ItemScripts/acarvedorcaxe.lua
-HasLanguage(..., ..., ..., ...)
+function Dialog1(Item,Player)
+    conversation = CreateConversation()
+    if CanReceiveQuest(Player,AnAxesRevenge) then
+    AddConversationOption(conversation, "[Run your fingers over the markings]", "Dialog2")
+    end
 ```

docs/lua_functions/HasQuest.md

@@ -1,19 +1,20 @@
-### Function: HasQuest(param1, param2, param3, param4)
+### Function: HasQuest(player, quest_id)
 
 **Description:**
-Placeholder description.
+Return's true if the player has the quest_id active in their journal.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `player` (Spawn) - Spawn object representing `player`.
-- `param2`: unknown - Unknown type.
+- `quest_id` (uint32) - Integer value `quest_id`.
-- `param3`: unknown - Unknown type.
-- `param4`: int32 - Integer value.
 
-**Returns:** None.
+**Returns:** Return's true if the player has an active quest (not completed/pending).
 
 **Example:**
 
 ```lua
--- Example usage
+-- From ItemScripts/abadlypolishedsteelkey.lua
-HasQuest(..., ..., ..., ...)
+function examined(Item, Player)
+if not HasQuest(Player, Polishedsteelkey) then
+OfferQuest(nil, Player, Polishedsteelkey)
+  end
 ```

docs/lua_functions/HasRecovered.md

@@ -1,18 +1,13 @@
-### Function: HasRecovered(param1, param2, param3)
+### Function: HasRecovered(spawn)
 
 **Description:**
-Placeholder description.
+If the NPC has recovered from spell casting.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
-- `param2`: unknown - Unknown type.
-- `param3`: unknown - Unknown type.
 
-**Returns:** None.
+**Returns:** True if casting again is possible, otherwise false if inbetween cast recovery.
 
 **Example:**
 
-```lua
+Example Required
--- Example usage
-HasRecovered(..., ..., ...)
-```

docs/lua_functions/HasSkill.md

@@ -1,17 +1,21 @@
-### Function: HasSkill(param1, param2)
+### Function: HasSkill(player, skill_id)
 
 **Description:**
-Placeholder description.
+Return's true if the player has the skill_id specified
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `player` (Spawn) - Spawn object representing `player`.
-- `param2`: int32 - Integer value.
+- `skill_id` (uint32) - Integer value `skill_id`.
 
-**Returns:** None.
+**Returns:** True if the player has the skill_id, otherwise false.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From ItemScripts/BardCertificationPapers.lua
-HasSkill(..., ...)
+function Class(Item, Player)
+    conversation = CreateConversation()
+    if CanReceiveQuest(Player,Quest) then
+    AddConversationOption(conversation, "[Turn in these papers for gear]","QuestStart")
+    end
 ```

docs/lua_functions/HasSpell.md

@@ -1,18 +1,15 @@
-### Function: HasSpell(param1, param2, param3)
+### Function: HasSpell(player, spellid, tier)
 
 **Description:**
-Placeholder description.
+Return's true if the player has the spellid specified of the tier.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `player` (Spawn) - Spawn object representing `player`.
-- `param2`: int32 - Integer value.
+- `spellid` (uint32) - Integer value `spellid`.
-- `param3`: int16 - Short integer value.
+- `tier` (uint16) - Integer value `tier`.
 
-**Returns:** None.
+**Returns:** Return's true if the player has the spell id with the tier (or higher tier).  Otherwise false.
 
 **Example:**
 
-```lua
+Example Required
--- Example usage
-HasSpell(..., ..., ...)
-```

docs/lua_functions/HasSpellEffect.md

@@ -1,21 +1,21 @@
-### Function: HasSpellEffect(param1, param2, param3, param4, param5, param6)
+### Function: HasSpellEffect(spawn, spellID, tier)
 
 **Description:**
-Placeholder description.
+Return's true if the spawn has an active spell effect with the spellid and tier specified.  If tier is set to 0 all tiers apply.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
-- `param2`: unknown - Unknown type.
+- `spellID` (uint32) - Integer value `spellID`.
-- `param3`: unknown - Unknown type.
+- `tier` (uint8) - Integer value `tier`.
-- `param4`: unknown - Unknown type.
-- `param5`: int32 - Integer value.
-- `param6`: int8 - Small integer or boolean flag.
 
-**Returns:** None.
+**Returns:** True if spell effect is active on the spawn with spellid and tier (if tier is 0 then all tiers apply).  Otherwise false.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From ItemScripts/aCourierCostume.lua
-HasSpellEffect(..., ..., ..., ..., ..., ...)
+function unequipped(Item, Player)
+  if HasSpellEffect(Player, 5459, 1) then
+    CastSpell(Player, 5459, 1)
+end
 ```

docs/lua_functions/HasSpellImmunity.md

@@ -1,19 +1,14 @@
-### Function: HasSpellImmunity(param1, param2, param3, param4)
+### Function: HasSpellImmunity(spawn, type)
 
 **Description:**
-Placeholder description.
+Return's if the spawn has immunity to the spell type.  See available types in https://github.com/emagi/eq2emu/blob/main/docs/data_types/immunity_types.md
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
-- `param2`: unknown - Unknown type.
+- `type` (uint8) - Integer value `type`.
-- `param3`: unknown - Unknown type.
-- `param4`: int8 - Small integer or boolean flag.
 
-**Returns:** None.
+**Returns:** True if the spawn has immunity to spell type, otherwise false.
 
 **Example:**
 
-```lua
+Example Required
--- Example usage
-HasSpellImmunity(..., ..., ..., ...)
-```

docs/lua_functions/IncreaseSkillCapsByType.md

@@ -1,21 +1,16 @@
-### Function: IncreaseSkillCapsByType(param1, param2, param3, param4, param5, param6)
+### Function: IncreaseSkillCapsByType(player_spawn, skill_type, amount, more_to_increase)
 
 **Description:**
-Placeholder description.
+Increases all skill maximums by the skill_type.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `player_spawn` (Spawn) - Spawn object representing `player_spawn`.
-- `param2`: unknown - Unknown type.
+- `skill_type` (uint8) - Integer value `skill_type`.
-- `param3`: unknown - Unknown type.
+- `amount` (uint8) - Quantity `amount`.
-- `param4`: int8 - Small integer or boolean flag.
+- `more_to_increase` (bool) - Boolean flag `more_to_increase`.
-- `param5`: int8 - Small integer or boolean flag.
-- `param6`: bool - Boolean value (true/false).
 
 **Returns:** None.
 
 **Example:**
 
-```lua
+Example Required
--- Example usage
-IncreaseSkillCapsByType(..., ..., ..., ..., ..., ...)
-```

docs/lua_functions/InstructionWindow.md

@@ -1,30 +1,30 @@
-### Function: InstructionWindow(param1, param2, param3, param4, param5, param6, param7, param8, param9, param10, param11, param12, param13, param14, param15)
+### Function: InstructionWindow(player, duration, text, voice, voice_key1, voice_key2, signal, goal1, task1, goal2, task2, goal3, task3, goal4, task4)
 
 **Description:**
-Placeholder description.
+Provides an instruction window for the player.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `player` (Spawn) - Spawn object representing `player`.
-- `param2`: float - Floating point value.
+- `duration` (float) - Float value `duration`.
-- `param3`: string - String value.
+- `text` (string) - String `text`.
-- `param4`: string - String value.
+- `voice` (string) - String `voice`.
-- `param5`: int32 - Integer value.
+- `voice_key1` (uint32) - Integer value `voice_key1`.
-- `param6`: int32 - Integer value.
+- `voice_key2` (uint32) - Integer value `voice_key2`.
-- `param7`: string - String value.
+- `signal` (string) - String `signal`.
-- `param8`: string - String value.
+- `goal1` (string) - String `goal1`.
-- `param9`: string - String value.
+- `task1` (string) - String `task1`.
-- `param10`: string - String value.
+- `goal2` (string) - String `goal2`.
-- `param11`: string - String value.
+- `task2` (string) - String `task2`.
-- `param12`: string - String value.
+- `goal3` (string) - String `goal3`.
-- `param13`: string - String value.
+- `task3` (string) - String `task3`.
-- `param14`: string - String value.
+- `goal4` (string) - String `goal4`.
-- `param15`: string - String value.
+- `task4` (string) - String `task4`.
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From Quests/FarJourneyFreeport/TasksaboardtheFarJourney.lua
-InstructionWindow(..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ...)
+	InstructionWindow(Player, -1.0, "The items are now in your inventory.", "voiceover/english/narrator/boat_06p_tutorial02/narrator_014_eaa89ef7.mp3", 361706387, 1106127199, "tutorial_stage_18", "", "continue")		
 ```

docs/lua_functions/InstructionWindowClose.md

@@ -1,16 +1,16 @@
-### Function: InstructionWindowClose(param1)
+### Function: InstructionWindowClose(player)
 
 **Description:**
-Placeholder description.
+Disables / closes he instruction window previously provided.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `player` (Spawn) - Spawn object representing `player`.
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From Quests/FarJourneyFreeport/TasksaboardtheFarJourney.lua
-InstructionWindowClose(...)
+InstructionWindowClose(Player)
 ```

docs/lua_functions/InstructionWindowGoal.md

@@ -1,17 +1,23 @@
-### Function: InstructionWindowGoal(param1, param2)
+### Function: InstructionWindowGoal(player, goal_num)
 
 **Description:**
-Placeholder description.
+Set's the players instruction window goal number.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `player` (Spawn) - Spawn object representing `player`.
-- `param2`: int8 - Small integer or boolean flag.
+- `goal_num` (uint8) - Quantity `goal_num`.
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From SpawnScripts/FarJourneyFreeport/CaptainVarlos.lua
-InstructionWindowGoal(..., ...)
+function hailed_instructions(NPC, player)	
+	if needs_selection_help then
+		InstructionWindowGoal(player,0)	
+		InstructionWindowClose(player)
+		InstructionWindow(player, -1.0, "To respond to the Captain and other characters you will meet, left click on the response text.", "voiceover/english/narrator/boat_06p_tutorial02/narrator_006_7521b625.mp3", 3936228257, 1877316160, "tutorial_stage_8", "Left click on one of the response options.", "server")
+		needs_selection_help = false
+	end
 ```

docs/lua_functions/IsBehind.md

@@ -1,20 +1,21 @@
-### Function: IsBehind(param1, param2, param3, param4, param5)
+### Function: IsBehind(spawn, target)
 
 **Description:**
-Placeholder description.
+Return's true if Spawn is behind Target.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
-- `param2`: unknown - Unknown type.
+- `target` (Spawn) - Spawn object representing `target`.
-- `param3`: unknown - Unknown type.
-- `param4`: unknown - Unknown type.
-- `param5`: Spawn - The spawn or entity involved.
 
-**Returns:** None.
+**Returns:** True if Spawn is behind Target, otherwise False.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From Spells/CaskinsRingingSwipe.lua
-IsBehind(..., ..., ..., ..., ...)
+function precast(Caster,Target)
+	if not IsFlanking(Caster, Target) and not IsBehind(Caster, Target) then
+        SendMessage(Caster, "Must be flanking or behind", "yellow")
+        return false
+	end
 ```

docs/lua_functions/IsCasting.md

@@ -1,18 +1,13 @@
-### Function: IsCasting(param1, param2, param3)
+### Function: IsCasting(spawn)
 
 **Description:**
-Placeholder description.
+Return's true if the Spawn is casting.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
-- `param2`: unknown - Unknown type.
-- `param3`: unknown - Unknown type.
 
-**Returns:** None.
+**Returns:** True if the Spawn is casting, otherwise false.
 
 **Example:**
 
-```lua
+Example Required
--- Example usage
-IsCasting(..., ..., ...)
-```

docs/lua_functions/IsEntity.md

@@ -1,17 +1,24 @@
-### Function: IsEntity(param1, param2)
+### Function: IsEntity(spawn)
 
 **Description:**
-Placeholder description.
+Return's true if the Spawn is an entity (Player/NPC/Bot).
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
-- `param2`: unknown - Unknown type.
 
-**Returns:** None.
+**Returns:** True if the spawn is an entity, otherwise false.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From ItemScripts/LaserGoggles.lua
-IsEntity(..., ...)
+function used(Item, Player)
+    local target = GetTarget(Player)
+    if target ~= nil and IsEntity(target) then
+        local encounter = GetEncounter(target)
+        if encounter ~= nil then
+            doDamage(Player, target, damage)
+        else
+            doDamage(Player, target, damage)
+        end
 ```

docs/lua_functions/IsFlanking.md

@@ -1,20 +1,21 @@
-### Function: IsFlanking(param1, param2, param3, param4, param5)
+### Function: IsFlanking(spawn, target)
 
 **Description:**
-Placeholder description.
+Return's true if Spawn is flanking Target.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
-- `param2`: unknown - Unknown type.
+- `target` (Spawn) - Spawn object representing `target`.
-- `param3`: unknown - Unknown type.
-- `param4`: unknown - Unknown type.
-- `param5`: Spawn - The spawn or entity involved.
 
-**Returns:** None.
+**Returns:** True if Spawn is flanking Target, otherwise false.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From Spells/CaskinsRingingSwipe.lua
-IsFlanking(..., ..., ..., ..., ...)
+function precast(Caster,Target)
+	if not IsFlanking(Caster, Target) and not IsBehind(Caster, Target) then
+        SendMessage(Caster, "Must be flanking or behind", "yellow")
+        return false
+	end
 ```

docs/lua_functions/IsFollowing.md

@@ -1,17 +1,21 @@
-### Function: IsFollowing(param1, param2)
+### Function: IsFollowing(spawn)
 
 **Description:**
-Placeholder description.
+Return's true if the spawn following is enabled.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
-- `param2`: unknown - Unknown type.
 
-**Returns:** None.
+**Returns:** True if the spawn following is enabled, otherwise false.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From SpawnScripts/BeggarsCourt/Ro.lua
-IsFollowing(..., ...)
+function ResetFollow(NPC)    
+    if IsFollowing(NPC) then
+        SetTarget(NPC,nil)
+        ToggleFollow(NPC)
+        AttackTimer = false
+end
 ```

docs/lua_functions/IsGroundSpawn.md

@@ -1,17 +1,19 @@
-### Function: IsGroundSpawn(param1, param2)
+### Function: IsGroundSpawn(spawn)
 
 **Description:**
-Placeholder description.
+Return's true if the spawn is a ground spawn.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
-- `param2`: unknown - Unknown type.
 
-**Returns:** None.
+**Returns:** True if the spawn is the Ground Spawn, otherwise False.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From Spells/Commoner/harvest.lua
-IsGroundSpawn(..., ...)
+function precast(Caster, Target)
+    if IsGroundSpawn(Target) then
+      return CanHarvest(Caster, Target)
+    end
 ```

docs/lua_functions/IsHeroic.md

@@ -1,17 +1,19 @@
-### Function: IsHeroic(param1, param2)
+### Function: IsHeroic(spawn)
 
 **Description:**
-Placeholder description.
+Return's true if Spawn is heroic.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
-- `param2`: unknown - Unknown type.
 
-**Returns:** None.
+**Returns:** True if Spawn is heroic otherwise False.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From SpawnScripts/Antonica/adankfurgnoll.lua
-IsHeroic(..., ...)
+function waypoints(NPC)
+    if IsHeroic(NPC) == false then
+        RandomMovement(NPC, Spawn, 8, -8, 2, 8, 15)
+    end
 ```

docs/lua_functions/IsInvulnerable.md

@@ -1,16 +1,22 @@
-### Function: IsInvulnerable(param1)
+### Function: IsInvulnerable(spawn)
 
 **Description:**
-Placeholder description.
+Return's true if spawn is set to invulnerable.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
 
-**Returns:** None.
+**Returns:** True if Spawn invulnerable otherwise false.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From RegionScripts/exp04_dun_chardok/char_p10_crossbridge_pit01_region.lua
-IsInvulnerable(...)
+function EnterRegion(Zone, Spawn, RegionType)
+    -- RegionType 2 is 'lava' or 'death' regions, RegionType 1 is water
+
+    local invul = IsInvulnerable(Spawn)
+    if invul == true then
+        return 0
+    end
 ```

docs/lua_functions/IsMezzed.md

@@ -1,18 +1,13 @@
-### Function: IsMezzed(param1, param2, param3)
+### Function: IsMezzed(spawn)
 
 **Description:**
-Placeholder description.
+Return's true if Spawn is mesmerized.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
-- `param2`: unknown - Unknown type.
-- `param3`: unknown - Unknown type.
 
-**Returns:** None.
+**Returns:** True if Spawn is mesmerized, otherwise false.
 
 **Example:**
 
-```lua
+Example Required
--- Example usage
-IsMezzed(..., ..., ...)
-```

docs/lua_functions/IsMezzedOrStunned.md

@@ -1,18 +1,13 @@
-### Function: IsMezzedOrStunned(param1, param2, param3)
+### Function: IsMezzedOrStunned(spawn)
 
 **Description:**
-Placeholder description.
+Return's true if Spawn is mesmerized or stunned.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
-- `param2`: unknown - Unknown type.
-- `param3`: unknown - Unknown type.
 
-**Returns:** None.
+**Returns:** True if Spawn is mesmerized or stunned, otherwise false.
 
 **Example:**
 
-```lua
+Example Required
--- Example usage
-IsMezzedOrStunned(..., ..., ...)
-```

docs/lua_functions/IsOnAutoMount.md

@@ -1,19 +1,19 @@
-### Function: IsOnAutoMount(param1, param2, param3, param4)
+### Function: IsOnAutoMount(player)
 
 **Description:**
-Placeholder description.
+Return's true if Player is on a auto-mount (like griffon).
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `player` (Spawn) - Spawn object representing `player`.
-- `param2`: unknown - Unknown type.
-- `param3`: unknown - Unknown type.
-- `param4`: unknown - Unknown type.
 
-**Returns:** None.
+**Returns:** True if Player is on auto mount, otherwise false.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From ZoneScripts/Antonica.lua
-IsOnAutoMount(..., ..., ..., ...)
+function GriffonTower(Zone, Spawn)
+	if IsPlayer(Spawn) and IsOnAutoMount(Spawn) then
+		EndAutoMount(Spawn)
+	end
 ```

docs/lua_functions/IsRunning.md

@@ -1,16 +1,13 @@
-### Function: IsRunning(param1)
+### Function: IsRunning(spawn)
 
 **Description:**
-Placeholder description.
+Return's true if spawn is currently running
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
 
-**Returns:** None.
+**Returns:** True if Spawn is running, otherwise false.
 
 **Example:**
 
-```lua
+Example Required
--- Example usage
-IsRunning(...)
-```

docs/lua_functions/IsStunned.md

@@ -1,18 +1,13 @@
-### Function: IsStunned(param1, param2, param3)
+### Function: IsStunned(spawn)
 
 **Description:**
-Placeholder description.
+Return's true if spawn is stunned.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
-- `param2`: unknown - Unknown type.
-- `param3`: unknown - Unknown type.
 
-**Returns:** None.
+**Returns:** True if spawn is stunned, otherwise false.
 
 **Example:**
 
-```lua
+Example Required
--- Example usage
-IsStunned(..., ..., ...)
-```

docs/lua_functions/IsZoneLoading.md

@@ -1,16 +1,13 @@
-### Function: IsZoneLoading(param1)
+### Function: IsZoneLoading(zone)
 
 **Description:**
-Placeholder description.
+Return's true if zone is currently loading.
 
 **Parameters:**
-- `param1`: ZoneServer - The zone object.
+- `zone` (Zone) - Zone object representing `zone`.
 
-**Returns:** None.
+**Returns:** True if zone is loading, otherwise false.
 
 **Example:**
 
-```lua
+Example Required
--- Example usage
-IsZoneLoading(...)
-```

docs/lua_functions/Knockback.md

@@ -1,23 +1,23 @@
-### Function: Knockback(param1, param2, param3, param4, param5, param6, param7, param8)
+### Function: Knockback(target_spawn, spawn, duration, vertical, horizontal, use_heading)
 
 **Description:**
-Placeholder description.
+Triggers a knockback on the target_spawn with spawn being the originator.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `target_spawn` (Spawn) - Spawn object representing `target_spawn`.
-- `param2`: unknown - Unknown type.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
-- `param3`: unknown - Unknown type.
+- `duration` (uint32) - Time value `duration` in seconds.
-- `param4`: Spawn - The spawn or entity involved.
+- `vertical` (float) - Float value `vertical`.
-- `param5`: int32 - Integer value.
+- `horizontal` (float) - Float value `horizontal`.
-- `param6`: float - Floating point value.
+- `use_heading` (uint8) - Integer value `use_heading`.
-- `param7`: float - Floating point value.
-- `param8`: int8 - Small integer or boolean flag.
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From SpawnScripts/houseofroachie/GnomishKnockbackDevice.lua
-Knockback(..., ..., ..., ..., ..., ..., ..., ...)
+function examined(NPC, Spawn)
+    Knockback(NPC, Spawn, 10)
+end
 ```

docs/lua_functions/LastSpellAttackHit.md

@@ -1,17 +1,22 @@
-### Function: LastSpellAttackHit(param1, param2)
+### Function: LastSpellAttackHit()
 
 **Description:**
-Placeholder description.
+Return's true if the last spell attack was a successful hit.
 
-**Parameters:**
+**Parameters:** None.
-- `param1`: unknown - Unknown type.
-- `param2`: unknown - Unknown type.
 
-**Returns:** None.
+**Returns:** True if the last hit was successful  otherwise false.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From Spells/AA/NullifyingStaff.lua
-LastSpellAttackHit(..., ...)
+function cast(Caster, Target, DmgType, MinVal, MaxVal, CombatMit, Arcane)
+	SpellDamage(Target, DmgType, MinVal, MaxVal)
+--if LastSpellAttackHit() then
+--AddSpellBonus(Target, 0, CombatMit)
+--end
+		if LastSpellAttackHit() then
+			AddSpellBonus(Target, 203, Arcane)
+				end
 ```

docs/lua_functions/MakeRandomFloat.md

@@ -1,17 +1,20 @@
-### Function: MakeRandomFloat(param1, param2)
+### Function: MakeRandomFloat(min, max)
 
 **Description:**
-Placeholder description.
+Make a random float between min and max.
 
 **Parameters:**
-- `param1`: float - Floating point value.
+- `min` (float) - Float value `min`.
-- `param2`: float - Floating point value.
+- `max` (float) - Float value `max`.
 
-**Returns:** None.
+**Returns:** Float value between min and max.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From Spells/Commoner/VerdantTrinity.lua
-MakeRandomFloat(..., ...)
+function cast(Caster, Target, Val1, Val2)
+	Percentage = MakeRandomFloat(Val1, Val2)
+	SpellHealPct("Heal", Percentage, false, false, Target, 2)
+end
 ```

docs/lua_functions/ProcDamage.md

@@ -1,28 +1,26 @@
-### Function: ProcDamage(param1, param2, param3, param4, param5, param6, param7, param8, param9, param10, param11, param12, param13)
+### Function: ProcDamage(caster, target, name, dmg_type, low_damage, high_damage, success_msg, effect_msg)
 
 **Description:**
-Placeholder description.
+Conduct proc damage against the target.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `caster` (Spawn) - Spawn object representing `caster`.
-- `param2`: unknown - Unknown type.
+- `target` (Spawn) - Spawn object representing `target`.
-- `param3`: unknown - Unknown type.
+- `name` (string) - String `name`.
-- `param4`: unknown - Unknown type.
+- `dmg_type` (uint8) - Integer value `dmg_type`.
-- `param5`: unknown - Unknown type.
+- `low_damage` (uint32) - Integer value `low_damage`.
-- `param6`: unknown - Unknown type.
+- `high_damage` (uint32) - Integer value `high_damage`.
-- `param7`: Spawn - The spawn or entity involved.
+- `success_msg` (string) - String `success_msg`.
-- `param8`: string - String value.
+- `effect_msg` (string) - String `effect_msg`.
-- `param9`: int8 - Small integer or boolean flag.
-- `param10`: int32 - Integer value.
-- `param11`: int32 - Integer value.
-- `param12`: string - String value.
-- `param13`: string - String value.
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From ItemScripts/LaserGoggles.lua
-ProcDamage(..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ...)
+function doDamage(Player, Target, damage)
+    local damage = math.floor(((GetHP(Target) / 100) * 50) + GetHP(Target))
+    ProcDamage(Player, Target, " Dev AE Slay", 4, damage)
+end
 ```

docs/lua_functions/ProcessMelee.md

@@ -1,22 +1,15 @@
-### Function: ProcessMelee(param1, param2, param3, param4, param5, param6, param7)
+### Function: ProcessMelee(spawn, target, distance)
 
 **Description:**
-Placeholder description.
+Send a LUA Brain process melee call for the Spawn against the Target based on the distance provided.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
-- `param2`: unknown - Unknown type.
+- `target` (Spawn) - Spawn object representing `target`.
-- `param3`: unknown - Unknown type.
+- `distance` (float) - Float value `distance`.
-- `param4`: unknown - Unknown type.
-- `param5`: unknown - Unknown type.
-- `param6`: Spawn - The spawn or entity involved.
-- `param7`: float - Floating point value.
 
 **Returns:** None.
 
 **Example:**
 
-```lua
+Example Required
--- Example usage
-ProcessMelee(..., ..., ..., ..., ..., ..., ...)
-```

docs/lua_functions/ProcessSpell.md

@@ -1,22 +1,15 @@
-### Function: ProcessSpell(param1, param2, param3, param4, param5, param6, param7)
+### Function: ProcessSpell(spawn, target, distance)
 
 **Description:**
-Placeholder description.
+Send a LUA Brain process spell call for the Spawn against the Target based on the distance provided.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
-- `param2`: unknown - Unknown type.
+- `target` (Spawn) - Spawn object representing `target`.
-- `param3`: unknown - Unknown type.
+- `distance` (float) - Float value `distance`.
-- `param4`: unknown - Unknown type.
-- `param5`: unknown - Unknown type.
-- `param6`: Spawn - The spawn or entity involved.
-- `param7`: float - Floating point value.
 
-**Returns:** None.
+**Returns:** True if successful, otherwise false.
 
 **Example:**
 
-```lua
+Example Required
--- Example usage
-ProcessSpell(..., ..., ..., ..., ..., ..., ...)
-```

docs/lua_functions/RemoveIconValue.md

@@ -1,18 +1,14 @@
-### Function: RemoveIconValue(param1, param2, param3)
+### Function: RemoveIconValue(spawn, value)
 
 **Description:**
-Placeholder description.
+Remove a visual icon value from the Spawn.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
-- `param2`: unknown - Unknown type.
+- `value` (uint32) - Integer value `value`.
-- `param3`: int32 - Integer value.
 
 **Returns:** None.
 
 **Example:**
 
-```lua
+Example Required
--- Example usage
-RemoveIconValue(..., ..., ...)
-```

docs/lua_functions/RemoveImmunitySpell.md

@@ -1,20 +1,19 @@
-### Function: RemoveImmunitySpell(param1, param2, param3, param4, param5)
+### Function: RemoveImmunitySpell(type, spawn)
 
 **Description:**
-Placeholder description.
+Remove an immunity spell from the Spawn.  See immunity types https://github.com/emagi/eq2emu/blob/main/docs/data_types/immunity_types.md
 
 **Parameters:**
-- `param1`: unknown - Unknown type.
+- `type` (uint8) - UInt8 value `type`.
-- `param2`: int8 - Small integer or boolean flag.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
-- `param3`: unknown - Unknown type.
-- `param4`: unknown - Unknown type.
-- `param5`: Spawn - The spawn or entity involved.
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From Spells/AA/AdvanceWarning.lua
-RemoveImmunitySpell(..., ..., ..., ..., ...)
+function remove(Caster, Target)
+    RemoveImmunitySpell(7, Target)
+end
 ```

docs/lua_functions/RemoveInvis.md

@@ -1,18 +1,23 @@
-### Function: RemoveInvis(param1, param2, param3)
+### Function: RemoveInvis(spawn)
 
 **Description:**
-Placeholder description.
+Remove invisible from the spawn.  Spawn is optional, otherwise in a spell script applies to all spell targets.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
-- `param2`: unknown - Unknown type.
-- `param3`: unknown - Unknown type.
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From SpawnScripts/Caves/acuriousrock.lua
-RemoveInvis(..., ..., ...)
+function casted_on(NPC, Spawn, Message)
+    if Message == "smash" then
+    SetAccessToEntityCommand(Spawn,NPC,"smash", 0)
+    SpawnSet(NPC, "show_command_icon", 0)
+    SpawnSet(NPC, "display_hand_icon", 0)    
+    if IsStealthed(Spawn)  then
+--    RemoveStealth(NPC,Spawn)
+    end
 ```

docs/lua_functions/RemoveProc.md

@@ -1,21 +1,20 @@
-### Function: RemoveProc(param1, param2, param3, param4, param5, param6)
+### Function: RemoveProc(spawn, item)
 
 **Description:**
-Placeholder description.
+Remove proc that was applied in a spell script or item script.  Will apply to spawn unless item is not specified, then all spell targets are applicable.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
-- `param2`: unknown - Unknown type.
+- `item` (Item) - Item object representing `item`.
-- `param3`: unknown - Unknown type.
-- `param4`: unknown - Unknown type.
-- `param5`: unknown - Unknown type.
-- `param6`: Item - An item reference.
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From Spells/BastensRunesofSurety.lua
-RemoveProc(..., ..., ..., ..., ..., ...)
+function remove(Caster, Target)
+    RemoveSpellBonus()
+    RemoveProc()
+end
 ```

docs/lua_functions/RemoveQuestStep.md

@@ -1,23 +1,15 @@
-### Function: RemoveQuestStep(param1, param2, param3, param4, param5, param6, param7, param8)
+### Function: RemoveQuestStep(player, quest, step)
 
 **Description:**
-Placeholder description.
+Remove a quest step from the Player's quest journal.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `player` (Spawn) - Spawn object representing `player`.
-- `param2`: unknown - Unknown type.
+- `quest` (Quest) - Quest object representing `quest`.
-- `param3`: unknown - Unknown type.
+- `step` (uint32) - Integer value `step`.
-- `param4`: unknown - Unknown type.
-- `param5`: unknown - Unknown type.
-- `param6`: unknown - Unknown type.
-- `param7`: unknown - Unknown type.
-- `param8`: int32 - Integer value.
 
 **Returns:** None.
 
 **Example:**
 
-```lua
+Example Required
--- Example usage
-RemoveQuestStep(..., ..., ..., ..., ..., ..., ..., ...)
-```

docs/lua_functions/RemoveSkill.md

@@ -1,20 +1,20 @@
-### Function: RemoveSkill(param1, param2, param3, param4, param5)
+### Function: RemoveSkill(player_spawn, skill_id, more_to_remove)
 
 **Description:**
-Placeholder description.
+Remove's the skill from the player's skill list.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `player_spawn` (Spawn) - Spawn object representing `player_spawn`.
-- `param2`: unknown - Unknown type.
+- `skill_id` (uint32) - Integer value `skill_id`.
-- `param3`: unknown - Unknown type.
+- `more_to_remove` (bool) - Boolean flag `more_to_remove`.
-- `param4`: int32 - Integer value.
-- `param5`: bool - Boolean value (true/false).
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From ItemScripts/BardCertificationPapers.lua
-RemoveSkill(..., ..., ..., ..., ...)
+if HasSkill(Player, 1408356869) then -- Martial/Fighter
+    RemoveSkill(Player, 1408356869)
+end
 ```

docs/lua_functions/RemoveSpawnAccess.md

@@ -1,19 +1,16 @@
-### Function: RemoveSpawnAccess(param1, param2, param3, param4)
+### Function: RemoveSpawnAccess(Spawn, Player)
 
 **Description:**
-Placeholder description.
+Removes the Player from accessing the Spawn.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
-- `param2`: unknown - Unknown type.
+- `player` (Spawn) - Spawn object representing `player`.
-- `param3`: unknown - Unknown type.
-- `param4`: Spawn - The spawn or entity involved.
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+RemoveSpawnAccess(Spawn, Player)
-RemoveSpawnAccess(..., ..., ..., ...)
 ```

docs/lua_functions/RemoveStealth.md

@@ -1,18 +1,23 @@
-### Function: RemoveStealth(param1, param2, param3)
+### Function: RemoveStealth(spawn)
 
 **Description:**
-Placeholder description.
+Remove stealth from the spawn.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
-- `param2`: unknown - Unknown type.
-- `param3`: unknown - Unknown type.
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From SpawnScripts/Caves/acuriousrock.lua
-RemoveStealth(..., ..., ...)
+function casted_on(NPC, Spawn, Message)
+    if Message == "smash" then
+    SetAccessToEntityCommand(Spawn,NPC,"smash", 0)
+    SpawnSet(NPC, "show_command_icon", 0)
+    SpawnSet(NPC, "display_hand_icon", 0)    
+    if IsStealthed(Spawn)  then
+--    RemoveStealth(NPC,Spawn)
+    end
 ```

docs/lua_functions/RemoveThreatTransfer.md

@@ -1,21 +1,18 @@
-### Function: RemoveThreatTransfer(param1, param2, param3, param4, param5, param6)
+### Function: RemoveThreatTransfer(spawn)
 
 **Description:**
-Placeholder description.
+Remove a threat transfer currently assigned to the Spawn, only inside a Spell Script.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
-- `param2`: unknown - Unknown type.
-- `param3`: unknown - Unknown type.
-- `param4`: unknown - Unknown type.
-- `param5`: unknown - Unknown type.
-- `param6`: unknown - Unknown type.
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From Spells/Fighter/Crusader/Paladin/Amends.lua
-RemoveThreatTransfer(..., ..., ..., ..., ..., ...)
+function remove(Caster, Target)
+    RemoveThreatTransfer(Caster)
+end
 ```

docs/lua_functions/RemoveTriggerFromSpell.md

@@ -1,19 +1,19 @@
-### Function: RemoveTriggerFromSpell(param1, param2, param3, param4)
+### Function: RemoveTriggerFromSpell(remove_count)
 
 **Description:**
-Placeholder description.
+Remove a spell trigger from the spell, must be ran inside Spell Script.
 
 **Parameters:**
-- `param1`: unknown - Unknown type.
+- `remove_count` (uint16) - Quantity `remove_count`.
-- `param2`: unknown - Unknown type.
-- `param3`: unknown - Unknown type.
-- `param4`: int16 - Short integer value.
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From Spells/Commoner/ArcaneEnlightenment.lua
-RemoveTriggerFromSpell(..., ..., ..., ...)
+function proc(Caster, Target, Type, Power, Triggers)
+    CastSpell(Caster, 2550391, 1)
+    RemoveTriggerFromSpell()
+end 
 ```

docs/lua_functions/RemoveWard.md

@@ -1,25 +1,20 @@
-### Function: RemoveWard(param1, param2, param3, param4, param5, param6, param7, param8, param9, param10)
+### Function: RemoveWard()
 
 **Description:**
-Placeholder description.
+Remove Ward from spell targets, must be used in spell script.
 
-**Parameters:**
+**Parameters:** None.
-- `param1`: unknown - Unknown type.
-- `param2`: unknown - Unknown type.
-- `param3`: unknown - Unknown type.
-- `param4`: Spawn - The spawn or entity involved.
-- `param5`: unknown - Unknown type.
-- `param6`: unknown - Unknown type.
-- `param7`: unknown - Unknown type.
-- `param8`: unknown - Unknown type.
-- `param9`: unknown - Unknown type.
-- `param10`: Spawn - The spawn or entity involved.
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From Spells/Commoner/CarpetDjinnMaster.lua
-RemoveWard(..., ..., ..., ..., ..., ..., ..., ..., ..., ...)
+function remove(Caster, Target)
+    RemoveSpellBonus(Caster)
+RemoveWard()
+SetMount(Caster, 0)
+  RemoveControlEffect(Caster, 12)
+end
 ```

docs/lua_functions/ResetIllusion.md

@@ -1,18 +1,18 @@
-### Function: ResetIllusion(param1, param2, param3)
+### Function: ResetIllusion(spawn)
 
 **Description:**
-Placeholder description.
+Remove the current illusion from a spawn, the spawn parameter is optional, inside spell script resets all spell targets illusion.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
-- `param2`: unknown - Unknown type.
-- `param3`: unknown - Unknown type.
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From Spells/Commoner/GenericGenderDisguise.lua
-ResetIllusion(..., ..., ...)
+function remove(Caster, Target)
+	ResetIllusion(Target)
+end
 ```

docs/lua_functions/ResetQuestStep.md

@@ -1,22 +1,16 @@
-### Function: ResetQuestStep(param1, param2, param3, param4, param5, param6, param7)
+### Function: ResetQuestStep(quest, step, desc, task_group)
 
 **Description:**
-Placeholder description.
+Resets the progress on the quest step for the quest object.
 
 **Parameters:**
-- `param1`: unknown - Unknown type.
+- `quest` (Quest) - Quest object representing `quest`.
-- `param2`: unknown - Unknown type.
+- `step` (uint32) - Integer value `step`.
-- `param3`: unknown - Unknown type.
+- `desc` (string) - String `desc`.
-- `param4`: unknown - Unknown type.
+- `task_group` (string) - String `task_group`.
-- `param5`: int32 - Integer value.
-- `param6`: string - String value.
-- `param7`: string - String value.
 
 **Returns:** None.
 
 **Example:**
 
-```lua
+Example Required
--- Example usage
-ResetQuestStep(..., ..., ..., ..., ..., ..., ...)
-```

docs/lua_functions/Resurrect.md

@@ -1,27 +1,27 @@
-### Function: Resurrect(param1, param2, param3, param4, param5, param6, param7, param8, param9, param10, param11, param12)
+### Function: Resurrect(hp_perc, power_perc, send_window, target, heal_name, crit_mod, no_calcs, revive_spell_id, revive_spell_tier)
 
 **Description:**
-Placeholder description.
+Resurrect the spell targets.
 
 **Parameters:**
-- `param1`: float - Floating point value.
+- `hp_perc` (float) - Float value `hp_perc`.
-- `param2`: unknown - Unknown type.
+- `power_perc` (float) - Float value `power_perc`.
-- `param3`: unknown - Unknown type.
+- `send_window` (uint32) - Integer value `send_window`.
-- `param4`: unknown - Unknown type.
+- `target` (Spawn) - Spawn object representing `target`.
-- `param5`: float - Floating point value.
+- `heal_name` (string) - String `heal_name`.
-- `param6`: int32 - Integer value.
+- `crit_mod` (uint32) - Integer value `crit_mod`.
-- `param7`: Spawn - The spawn or entity involved.
+- `no_calcs` (uint32) - Integer value `no_calcs`.
-- `param8`: string - String value.
+- `revive_spell_id` (uint32) - Integer value `revive_spell_id`.
-- `param9`: int32 - Integer value.
+- `revive_spell_tier` (uint32) - Integer value `revive_spell_tier`.
-- `param10`: int32 - Integer value.
-- `param11`: int32 - Integer value.
-- `param12`: int32 - Integer value.
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From Spells/Commoner/FavorofthePhoenix.lua
-Resurrect(..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ...)
+function cast(Caster, Target)
+Resurrect(15, 15, 1)
+    Say(Caster, "Summoning Sickness not implemented.")
+end
 ```

docs/lua_functions/SendOptionWindow.md

@@ -1,20 +1,25 @@
-### Function: SendOptionWindow(param1, param2, param3, param4, param5)
+### Function: SendOptionWindow(option_window, player, window_title, cancel_command)
 
 **Description:**
-Placeholder description.
+Send a option window with the previous option window arguments.
 
 **Parameters:**
-- `param1`: unknown - Unknown type.
+- `option_window` (OptionWindow) - OptionWindow object representing `option_window`.
-- `param2`: unknown - Unknown type.
+- `player` (Spawn) - Spawn object representing `player`.
-- `param3`: Spawn - The spawn or entity involved.
+- `window_title` (string) - String `window_title`.
-- `param4`: string - String value.
+- `cancel_command` (string) - String `cancel_command`.
-- `param5`: string - String value.
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From SpawnScripts/Generic/GenericCraftingTrainer.lua
-SendOptionWindow(..., ..., ..., ..., ...)
+function SendSecondaryChoice(NPC, Spawn)
+	window = CreateOptionWindow()
+    AddOptionWindowOption(window, "Craftsman", "Craftsmen become carpenters, provisioners, or woodworkers.  They make furniture and strong boxes, food, drink, bows, arrows, totems, wooden weapons, and wooden shields.", 1, 420, "select_craftsman")
+    AddOptionWindowOption(window, "Outfitter", "Outfitters become armorers, tailors, or weaponsmiths.  They make plate and chainmail armor, heavy shields, cloth and leather armor, casual clothing, backpacks, hex dolls, and metal weapons.", 1, 411, "select_outfitter")
+    AddOptionWindowOption(window, "Scholar", "Scholars become alchemists, jewelers, and sages.  They make spell and combat art upgrades for adventurers, potions, poisons, and jewelry.", 1, 396, "select_scholar")
+    SendOptionWindow(window, Spawn, "Select A Profession")
+end
 ```

docs/lua_functions/SendTransporters.md

@@ -1,19 +1,15 @@
-### Function: SendTransporters(param1, param2, param3, param4)
+### Function: SendTransporters(spawn, player, transport_id)
 
 **Description:**
-Placeholder description.
+Send the transporters list to the Player from the Spawn with the transport_id.
 
 **Parameters:**
-- `param1`: unknown - Unknown type.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
-- `param2`: Spawn - The spawn or entity involved.
+- `player` (Spawn) - Spawn object representing `player`.
-- `param3`: Spawn - The spawn or entity involved.
+- `transport_id` (uint32) - Integer value `transport_id`.
-- `param4`: int32 - Integer value.
 
 **Returns:** None.
 
 **Example:**
 
-```lua
+Example Required
--- Example usage
-SendTransporters(..., ..., ..., ...)
-```

docs/lua_functions/SetAAInfo.md

@@ -1,18 +1,15 @@
-### Function: SetAAInfo(param1, param2, param3)
+### Function: SetAAInfo(spawn, type, value)
 
 **Description:**
-Placeholder description.
+Set's the AA Info type to the value.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
-- `param2`: string - String value.
+- `type` (string) - String `type`.
-- `param3`: unknown - Unknown type.
+- `value` (int32) - Integer value `value`.
 
 **Returns:** None.
 
 **Example:**
 
-```lua
+Example Required
--- Example usage
-SetAAInfo(..., ..., ...)
-```

docs/lua_functions/SetAlignment.md

@@ -1,21 +1,19 @@
-### Function: SetAlignment(param1, param2, param3, param4, param5, param6)
+### Function: SetAlignment(spawn, alignment)
 
 **Description:**
-Placeholder description.
+Sets the alignment of the Spawn to the value.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
-- `param2`: unknown - Unknown type.
+- `alignment` (int32) - Integer value `alignment`.
-- `param3`: unknown - Unknown type.
-- `param4`: unknown - Unknown type.
-- `param5`: unknown - Unknown type.
-- `param6`: unknown - Unknown type.
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From ItemScripts/ForgeryFreeportCitizenshipPapers.lua
-SetAlignment(..., ..., ..., ..., ..., ...)
+if GetRace(Player) == 0 or GetRace(Player) == 3 or GetRace(Player) == 5 or GetRace(Player) == 6 or GetRace(Player) == 9 or GetRace(Player) == 11 or GetRace(Player) == 20 then
+SetAlignment(Player, 2)
+end   
 ```

docs/lua_functions/SetBrainTick.md

@@ -1,20 +1,24 @@
-### Function: SetBrainTick(param1, param2, param3, param4, param5)
+### Function: SetBrainTick(spawn, tick)
 
 **Description:**
-Placeholder description.
+Sets the Spawn's brain tick rate in milliseconds.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
-- `param2`: unknown - Unknown type.
+- `tick` (uint16) - Integer value `tick`.
-- `param3`: unknown - Unknown type.
-- `param4`: unknown - Unknown type.
-- `param5`: int16 - Short integer value.
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From SpawnScripts/GMHall/TrainingDummy.lua
-SetBrainTick(..., ..., ..., ..., ...)
+function spawn(NPC)
+	-- set the calls to the ai to 10 mins as there is no ai
+	SetBrainTick(NPC, 600000)
+	SetLuaBrain(NPC)
+	
+	-- give the spawn a crap load of hp so we can't one hit kill
+	SetHP(NPC, 1000000)
+end
 ```

docs/lua_functions/SetCharSheetChanged.md

@@ -1,18 +1,17 @@
-### Function: SetCharSheetChanged(param1, param2, param3)
+### Function: SetCharSheetChanged(spawn, value)
 
 **Description:**
-Placeholder description.
+Set's that the character sheet was changed (usually set to true to update the client).
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
-- `param2`: unknown - Unknown type.
+- `value` (bool) - Boolean flag `value`.
-- `param3`: bool - Boolean value (true/false).
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From SpawnScripts/Generic/SpiritShard.lua
-SetCharSheetChanged(..., ..., ...)
+SetCharSheetChanged(Spawn, true)
 ```

docs/lua_functions/SetCharacterTitlePrefix.md

@@ -1,20 +1,23 @@
-### Function: SetCharacterTitlePrefix(param1, param2, param3, param4, param5)
+### Function: SetCharacterTitlePrefix(spawn, titleName)
 
 **Description:**
-Placeholder description.
+Set's the character title prefix of the Spawn to the title name.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
-- `param2`: unknown - Unknown type.
+- `titleName` (string) - String `titleName`.
-- `param3`: unknown - Unknown type.
-- `param4`: unknown - Unknown type.
-- `param5`: string - String value.
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From SpawnScripts/IsleRefuge1/TitleBot.lua
-SetCharacterTitlePrefix(..., ..., ..., ..., ...)
+function hailed(NPC, Spawn)
+	FaceTarget(NPC, Spawn)
+	AddMasterTitle("Lord", 1) -- create new title for all players, is prefix
+	AddCharacterTitle(Spawn, "Lord") -- add title to the current player
+	SetCharacterTitlePrefix(Spawn, "Lord") -- set the characters current prefix to the newly created title
+	
+end
 ```

docs/lua_functions/SetCharacterTitleSuffix.md

@@ -1,20 +1,14 @@
-### Function: SetCharacterTitleSuffix(param1, param2, param3, param4, param5)
+### Function: SetCharacterTitleSuffix(spawn, titleName)
 
 **Description:**
-Placeholder description.
+Set's the character title suffix of the Spawn to the title name.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
-- `param2`: unknown - Unknown type.
+- `titleName` (string) - String `titleName`.
-- `param3`: unknown - Unknown type.
-- `param4`: unknown - Unknown type.
-- `param5`: string - String value.
 
 **Returns:** None.
 
 **Example:**
 
-```lua
+Example Required
--- Example usage
-SetCharacterTitleSuffix(..., ..., ..., ..., ...)
-```

docs/lua_functions/SetFailureTimer.md

@@ -1,20 +1,18 @@
-### Function: SetFailureTimer(param1, param2, param3, param4, param5)
+### Function: SetFailureTimer(spawn)
 
 **Description:**
-Placeholder description.
+Sets the failure timer on the Spawn for the current zone.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
-- `param2`: unknown - Unknown type.
-- `param3`: unknown - Unknown type.
-- `param4`: unknown - Unknown type.
-- `param5`: unknown - Unknown type.
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From ZoneScripts/BloodSkullValleyExcavationSite.lua
-SetFailureTimer(..., ..., ..., ..., ...)
+function player_entry(zone, player)
+    SetFailureTimer(player)
+end
 ```

docs/lua_functions/SetFollowTarget.md

@@ -1,19 +1,41 @@
-### Function: SetFollowTarget(param1, param2, param3, param4)
+### Function: SetFollowTarget(spawn, target, follow_distance)
 
 **Description:**
-Placeholder description.
+Set's the spawns follow target and the optional follow_distance.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
-- `param2`: unknown - Unknown type.
+- `target` (Spawn) - Spawn object representing `target`.
-- `param3`: Spawn - The spawn or entity involved.
+- `follow_distance` (uint32) - Distance `follow_distance`.
-- `param4`: int32 - Integer value.
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From SpawnScripts/BeggarsCourt/arat.lua
-SetFollowTarget(..., ..., ..., ...)
+function CatCheck(NPC,Spawn)
+    if IsAlive(NPC) then
+        AddTimer(NPC,MakeRandomInt(2000,4000),"CatCheck")
+
+        local zone = GetZone(NPC)
+        local Cat = GetSpawnByLocationID(zone,402996)
+        if not IsInCombat(NPC) and Cat~= nil and not IsInCombat(Cat)then
+        local Distance = GetDistance(NPC,Cat,1)
+        if Distance <=5 then
+            Attack(Cat,NPC)
+            Attack(NPC,Cat)
+            local x = GetX(Cat)
+            local y = GetY(Cat)
+            local z = GetZ(Cat)
+            SetFollowTarget(Cat,NPC)
+            SetFollowTarget(NPC,Cat)
+            ToggleFollow(Cat)
+            ToggleFollow(NPC)
+            SetTarget(Cat,NPC)
+            FaceTarget(Cat,NPC)
+            FaceTarget(NPC,Cat)
+            PlayFlavor(NPC,"","","attack",0,0)
+            AddTimer(NPC,MakeRandomInt(2500,4500),"kill",1,Spawn)
+      end
 ```

docs/lua_functions/SetGridID.md

@@ -1,19 +1,20 @@
-### Function: SetGridID(param1, param2, param3, param4)
+### Function: SetGridID(spawn, grid)
 
 **Description:**
-Placeholder description.
+Set's the grid id of the spawn.  See /grid for more information on the grid id.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
-- `param2`: unknown - Unknown type.
+- `grid` (uint32) - Integer value `grid`.
-- `param3`: unknown - Unknown type.
-- `param4`: int32 - Integer value.
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From SpawnScripts/FallenGate/atormentedbattlemage_A.lua
-SetGridID(..., ..., ..., ...)
+function Change_Grid_A(NPC)
+	 Say(NPC, "This is the Change_Grid_A function")
+	 SetGridID(NPC, 3104458931)
+end
 ```

docs/lua_functions/SetIllusion.md

@@ -1,19 +1,22 @@
-### Function: SetIllusion(param1, param2, param3, param4)
+### Function: SetIllusion(spawn, model)
 
 **Description:**
-Placeholder description.
+Sets the illusion of the Spawn to the model provided.  See model ids by version on https://wiki.eq2emu.com/ReferenceLists
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
-- `param2`: unknown - Unknown type.
+- `model` (uint16) - Integer value `model`.
-- `param3`: unknown - Unknown type.
-- `param4`: int16 - Short integer value.
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From Spells/Commoner/GenericGenderDisguise.lua
-SetIllusion(..., ..., ..., ...)
+function cast(Caster, Target, Male, Female)
+	if GetGender(Spawn) == 1 then
+        SetIllusion(Target, Male)
+    else
+        SetIllusion(Target, Female)
+    end
 ```

docs/lua_functions/SetInCombat.md

@@ -1,19 +1,25 @@
-### Function: SetInCombat(param1, param2, param3, param4)
+### Function: SetInCombat(spawn, val)
 
 **Description:**
-Placeholder description.
+Set's if the Spawn is in combat.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
-- `param2`: unknown - Unknown type.
+- `val` (bool) - Boolean flag `val`.
-- `param3`: unknown - Unknown type.
-- `param4`: bool - Boolean value (true/false).
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From SpawnScripts/BrawlersDojo/afirstcircleadept.lua
-SetInCombat(..., ..., ..., ...)
+function aggro(NPC,Spawn)
+    if GetTempVariable(NPC,"Reset")== nil then
+    else
+        ClearHate(NPC, Spawn)
+        SetInCombat(Spawn, false)
+        SetInCombat(NPC, false)
+        ClearEncounter(NPC)
+        SetTarget(Spawn,nil)
+    end
 ```

docs/lua_functions/SetInfoStructFloat.md

@@ -1,19 +1,23 @@
-### Function: SetInfoStructFloat(param1, param2, param3, param4)
+### Function: SetInfoStructFloat(spawn, field, value)
 
 **Description:**
-Placeholder description.
+Sets the float field to the value provided.  See https://github.com/emagi/eq2emu/blob/main/docs/data_types/info_struct.md for field types.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
-- `param2`: unknown - Unknown type.
+- `field` (string) - String `field`.
-- `param3`: string - String value.
+- `value` (float) - Float value `value`.
-- `param4`: float - Floating point value.
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From SpawnScripts/Generic/CombatModule.lua
-SetInfoStructFloat(..., ..., ..., ...)
+function attributes(NPC, Spawn)
+    -- Calculate attributes
+    if  level <= 4 then
+        baseStat = 19 else
+            baseStat = level + 15
+    end
 ```

docs/lua_functions/SetInfoStructSInt.md

@@ -1,19 +1,30 @@
-### Function: SetInfoStructSInt(param1, param2, param3, param4)
+### Function: SetInfoStructSInt(spawn, field, value)
 
 **Description:**
-Placeholder description.
+Sets the signed integer field to the value provided.  See https://github.com/emagi/eq2emu/blob/main/docs/data_types/info_struct.md for field types.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
-- `param2`: unknown - Unknown type.
+- `field` (string) - String `field`.
-- `param3`: string - String value.
+- `value` (int64) - Integer value `value`.
-- `param4`: sint64 - Large integer value.
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From SpawnScripts/Antonica/Anguis.lua
-SetInfoStructSInt(..., ..., ..., ...)
+function spawn(NPC)
+    dmgMod = math.floor(GetStr(NPC)/10)
+    HPRegenMod = math.floor(GetSta(NPC)/10)
+    PwRegenMod = math.floor(GetStr(NPC)/10)
+    SetInfoStructUInt(NPC, "override_primary_weapon", 1)        
+    SetInfoStructUInt(NPC, "primary_weapon_damage_low", math.floor(205 + dmgMod)) 
+    SetInfoStructUInt(NPC, "primary_weapon_damage_high", math.floor(355 + dmgMod))
+    SetInfoStructUInt(NPC, "hp_regen_override", 1)  
+    SetInfoStructSInt(NPC, "hp_regen", 125 + HPRegenMod)           
+    SetInfoStructUInt(NPC, "pw_regen_override", 1)  
+    SetInfoStructSInt(NPC, "pw_regen", 75 + PwRegenMod) 
+
+end
 ```

docs/lua_functions/SetInfoStructString.md

@@ -1,19 +1,22 @@
-### Function: SetInfoStructString(param1, param2, param3, param4)
+### Function: SetInfoStructString(spawn, field, value)
 
 **Description:**
-Placeholder description.
+Sets the string field to the value provided.  See https://github.com/emagi/eq2emu/blob/main/docs/data_types/info_struct.md for field types.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
-- `param2`: unknown - Unknown type.
+- `field` (string) - String `field`.
-- `param3`: string - String value.
+- `value` (string) - String `value`.
-- `param4`: string - String value.
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From SpawnScripts/Antonica/anoverlandminer.lua
-SetInfoStructString(..., ..., ..., ...)
+function spawn(NPC, Spawn)
+    NPCModule(NPC, Spawn)
+    dwarf(NPC)
+    SetInfoStructString(NPC, "action_state", "mining_digging")
+end
 ```

docs/lua_functions/SetInfoStructUInt.md

@@ -1,19 +1,20 @@
-### Function: SetInfoStructUInt(param1, param2, param3, param4)
+### Function: SetInfoStructUInt(spawn, field, value)
 
 **Description:**
-Placeholder description.
+Sets the unsigned integer field to the value provided.  See https://github.com/emagi/eq2emu/blob/main/docs/data_types/info_struct.md for field types.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
-- `param2`: unknown - Unknown type.
+- `field` (string) - String `field`.
-- `param3`: string - String value.
+- `value` (uint64) - Integer value `value`.
-- `param4`: unknown - Unknown type.
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From ItemScripts/discordimbuedroughspunhexdoll.lua
-SetInfoStructUInt(..., ..., ..., ...)
+function examined(Item, Player)
+SetInfoStructUInt(Player, "status_points", 20000)
+end
 ```

docs/lua_functions/SetItemCount.md

@@ -1,23 +1,15 @@
-### Function: SetItemCount(param1, param2, param3, param4, param5, param6, param7, param8)
+### Function: SetItemCount(item, owner, new_count)
 
 **Description:**
-Placeholder description.
+Set's the item count of the Item object.  Only applicable to Player's.
 
 **Parameters:**
-- `param1`: Item - An item reference.
+- `item` (Item) - Item object representing `item`.
-- `param2`: unknown - Unknown type.
+- `owner` (Spawn) - Spawn object representing `owner`.
-- `param3`: unknown - Unknown type.
+- `new_count` (uint32) - Quantity `new_count`.
-- `param4`: unknown - Unknown type.
-- `param5`: unknown - Unknown type.
-- `param6`: unknown - Unknown type.
-- `param7`: Spawn - The spawn or entity involved.
-- `param8`: int32 - Integer value.
 
 **Returns:** None.
 
 **Example:**
 
-```lua
+Example Required
--- Example usage
-SetItemCount(..., ..., ..., ..., ..., ..., ..., ...)
-```

docs/lua_functions/SetLuaBrain.md

@@ -1,18 +1,23 @@
-### Function: SetLuaBrain(param1, param2, param3)
+### Function: SetLuaBrain(spawn)
 
 **Description:**
-Placeholder description.
+Creates a new LUA Brain for the Spawn.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
-- `param2`: unknown - Unknown type.
-- `param3`: unknown - Unknown type.
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From SpawnScripts/GMHall/TrainingDummy.lua
-SetLuaBrain(..., ..., ...)
+function spawn(NPC)
+	-- set the calls to the ai to 10 mins as there is no ai
+	SetBrainTick(NPC, 600000)
+	SetLuaBrain(NPC)
+	
+	-- give the spawn a crap load of hp so we can't one hit kill
+	SetHP(NPC, 1000000)
+end
 ```

docs/lua_functions/SetPlayerHistory.md

@@ -1,21 +1,21 @@
-### Function: SetPlayerHistory(param1, param2, param3, param4, param5, param6)
+### Function: SetPlayerHistory(player, event_id, value, value2)
 
 **Description:**
-Placeholder description.
+Set's the players history to the value provided.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `player` (Spawn) - Spawn object representing `player`.
-- `param2`: unknown - Unknown type.
+- `event_id` (uint32) - Integer value `event_id`.
-- `param3`: unknown - Unknown type.
+- `value` (uint32) - Integer value `value`.
-- `param4`: int32 - Integer value.
+- `value2` (uint32) - Integer value `value2`.
-- `param5`: int32 - Integer value.
-- `param6`: int32 - Integer value.
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From Quests/Antonica/hunters_manifest.lua
-SetPlayerHistory(..., ..., ..., ..., ..., ...)
+function Accepted(Quest, QuestGiver, Player)
+SetPlayerHistory(Player, 8, 1)
+end 
 ```

docs/lua_functions/SetQuestFeatherColor.md

@@ -1,18 +1,22 @@
-### Function: SetQuestFeatherColor(param1, param2, param3)
+### Function: SetQuestFeatherColor(quest, feather_color)
 
 **Description:**
-Placeholder description.
+Set's the feather color of the quest.
 
 **Parameters:**
-- `param1`: unknown - Unknown type.
+- `quest` (Quest) - Quest object representing `quest`.
-- `param2`: unknown - Unknown type.
+- `feather_color` (uint8) - Integer value `feather_color`.
-- `param3`: int8 - Small integer or boolean flag.
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From Quests/Antonica/a_brass_key.lua
-SetQuestFeatherColor(..., ..., ...)
+function Init(Quest)
+	SetQuestFeatherColor(Quest, 3)
+	SetQuestRepeatable(Quest)
+	AddQuestStep(Quest, 1, "From the looks of the key and the tag, it would be safe to assume that this key can be used at a lighthouse of sorts.", 1, 100, "I need to find out what lighthouse this key goes to. The trek maybe dangerous, so I should take other hearty adventurers with me.  From the looks of the key and the tag, it would be safe to assume that this key can be used at a lighthouse of sorts.", 2176)
+	AddQuestStepCompleteAction(Quest, 1, "QuestComplete")
+end
 ```

docs/lua_functions/SetQuestFlags.md

@@ -1,18 +1,27 @@
-### Function: SetQuestFlags(param1, param2, param3)
+### Function: SetQuestFlags(quest, flags)
 
 **Description:**
-Placeholder description.
+Sets the quest flags for the quest object.
 
 **Parameters:**
-- `param1`: unknown - Unknown type.
+- `quest` (Quest) - Quest object representing `quest`.
-- `param2`: unknown - Unknown type.
+- `flags` (uint32) - Integer value `flags`.
-- `param3`: int32 - Integer value.
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From Quests/EnchantedLands/HelpingSarmaSingebellows.lua
-SetQuestFlags(..., ..., ...)
+function Accepted(Quest, QuestGiver, Player)
+	
+	if GetTempVariable(Player, "HelpingSarmaSingebellows") == "true" then
+		PlayFlavor(NPC, "voiceover/english/sarma_singebellows/enchanted/sarma_singebellows002.mp3", "", "", 2943069626, 2445316031, Spawn)
+		AddConversationOption(conversation, "I shall return when they are destroyed.")
+		StartConversation(conversation, NPC, Spawn, "Excellent!  You worked hard to kill all of those goblins, but we need to make sure they don't regain their foothold.")
+	else
+		PlayFlavor(NPC, "voiceover/english/sarma_singebellows/enchanted/sarma_singebellows002.mp3", "", "", 2943069626, 2445316031, Spawn)
+		AddConversationOption(conversation, "As you wish.")
+		StartConversation(conversation, NPC, Spawn, "Excellent! Goblins are tainting the water and withering the trees at a watermill by a nearby lake.  I want you to destroy as many of them as you can!")
+	end
 ```

docs/lua_functions/SetQuestRepeatable.md

@@ -1,17 +1,22 @@
-### Function: SetQuestRepeatable(param1, param2)
+### Function: SetQuestRepeatable(quest)
 
 **Description:**
-Placeholder description.
+Set's if the quest is repeatable.
+
 
 **Parameters:**
-- `param1`: unknown - Unknown type.
+- `quest` (Quest) - Quest object representing `quest`.
-- `param2`: unknown - Unknown type.
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From Quests/Antonica/a_brass_key.lua
-SetQuestRepeatable(..., ...)
+function Init(Quest)
+	SetQuestFeatherColor(Quest, 3)
+	SetQuestRepeatable(Quest)
+	AddQuestStep(Quest, 1, "From the looks of the key and the tag, it would be safe to assume that this key can be used at a lighthouse of sorts.", 1, 100, "I need to find out what lighthouse this key goes to. The trek maybe dangerous, so I should take other hearty adventurers with me.  From the looks of the key and the tag, it would be safe to assume that this key can be used at a lighthouse of sorts.", 2176)
+	AddQuestStepCompleteAction(Quest, 1, "QuestComplete")
+end
 ```

docs/lua_functions/SetQuestTimer.md

@@ -1,27 +1,17 @@
-### Function: SetQuestTimer(param1, param2, param3, param4, param5, param6, param7, param8, param9, param10, param11, param12)
+### Function: SetQuestTimer(quest, player, step, duration, action)
 
 **Description:**
-Placeholder description.
+Set's the player's quest timer and result action function.
 
 **Parameters:**
-- `param1`: unknown - Unknown type.
+- `quest` (Quest) - Quest object representing `quest`.
-- `param2`: unknown - Unknown type.
+- `player` (Spawn) - Spawn object representing `player`.
-- `param3`: unknown - Unknown type.
+- `step` (uint32) - Integer value `step`.
-- `param4`: unknown - Unknown type.
+- `duration` (uint32) - Time value `duration` in seconds.
-- `param5`: unknown - Unknown type.
+- `action` (string) - String `action`.
-- `param6`: unknown - Unknown type.
-- `param7`: unknown - Unknown type.
-- `param8`: unknown - Unknown type.
-- `param9`: Spawn - The spawn or entity involved.
-- `param10`: int32 - Integer value.
-- `param11`: int32 - Integer value.
-- `param12`: string - String value.
 
 **Returns:** None.
 
 **Example:**
 
-```lua
+Example Required
--- Example usage
-SetQuestTimer(..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ...)
-```

docs/lua_functions/SetQuestTimerComplete.md

@@ -1,21 +1,14 @@
-### Function: SetQuestTimerComplete(param1, param2, param3, param4, param5, param6)
+### Function: SetQuestTimerComplete(quest, player)
 
 **Description:**
-Placeholder description.
+Set's the quest timer as complete for the player.
 
 **Parameters:**
-- `param1`: unknown - Unknown type.
+- `quest` (Quest) - Quest object representing `quest`.
-- `param2`: unknown - Unknown type.
+- `player` (Spawn) - Spawn object representing `player`.
-- `param3`: unknown - Unknown type.
-- `param4`: unknown - Unknown type.
-- `param5`: unknown - Unknown type.
-- `param6`: Spawn - The spawn or entity involved.
 
 **Returns:** None.
 
 **Example:**
 
-```lua
+Example Required
--- Example usage
-SetQuestTimerComplete(..., ..., ..., ..., ..., ...)
-```

docs/lua_functions/SetRailID.md

@@ -1,19 +1,14 @@
-### Function: SetRailID(param1, param2, param3, param4)
+### Function: SetRailID(spawn, rail_id)
 
 **Description:**
-Placeholder description.
+Set's the rail id of the spawn.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
-- `param2`: unknown - Unknown type.
+- `rail_id` (int64) - Integer value `rail_id`.
-- `param3`: unknown - Unknown type.
-- `param4`: sint64 - Large integer value.
 
 **Returns:** None.
 
 **Example:**
 
-```lua
+Example Required
--- Example usage
-SetRailID(..., ..., ..., ...)
-```

docs/lua_functions/SetServerVariable.md

@@ -1,20 +1,15 @@
-### Function: SetServerVariable(param1, param2, param3, param4, param5)
+### Function: SetServerVariable(name, value, comment)
 
 **Description:**
-Placeholder description.
+Set's the server variable to the value provided.
 
 **Parameters:**
-- `param1`: string - String value.
+- `name` (string) - String `name`.
-- `param2`: unknown - Unknown type.
+- `value` (string) - String `value`.
-- `param3`: unknown - Unknown type.
+- `comment` (string) - String `comment`.
-- `param4`: string - String value.
-- `param5`: string - String value.
 
 **Returns:** None.
 
 **Example:**
 
-```lua
+Example Required
--- Example usage
-SetServerVariable(..., ..., ..., ..., ...)
-```

docs/lua_functions/SetSkillMaxValue.md

@@ -1,18 +1,22 @@
-### Function: SetSkillMaxValue(param1, param2, param3)
+### Function: SetSkillMaxValue(skill, value)
 
 **Description:**
-Placeholder description.
+Set's the maximum skill value for the skill object.
 
 **Parameters:**
-- `param1`: unknown - Unknown type.
+- `skill` (int32) - Integer value `skill`.
-- `param2`: unknown - Unknown type.
+- `value` (uint16) - Integer value `value`.
-- `param3`: int16 - Short integer value.
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From SpawnScripts/DarkBargainers/SasitSoroth.lua
-SetSkillMaxValue(..., ..., ...)
+function MaxGathering(NPC, Spawn)
+	local skill = GetSkill(Spawn, "Gathering")
+    if skill ~= nil then
+        SetSkillMaxValue(skill, 300)
+        SetSkillValue(skill, 300)
+    end
 ```

docs/lua_functions/SetSkillValue.md

@@ -1,18 +1,22 @@
-### Function: SetSkillValue(param1, param2, param3)
+### Function: SetSkillValue(skill, value)
 
 **Description:**
-Placeholder description.
+Set's the current skill value for the skill object.
 
 **Parameters:**
-- `param1`: unknown - Unknown type.
+- `skill` (int32) - Integer value `skill`.
-- `param2`: unknown - Unknown type.
+- `value` (uint16) - Integer value `value`.
-- `param3`: int16 - Short integer value.
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From SpawnScripts/DarkBargainers/SasitSoroth.lua
-SetSkillValue(..., ..., ...)
+function MaxGathering(NPC, Spawn)
+	local skill = GetSkill(Spawn, "Gathering")
+    if skill ~= nil then
+        SetSkillMaxValue(skill, 300)
+        SetSkillValue(skill, 300)
+    end
 ```

docs/lua_functions/SetSpawnAnimation.md

@@ -1,20 +1,21 @@
-### Function: SetSpawnAnimation(param1, param2, param3, param4, param5)
+### Function: SetSpawnAnimation(spawn, anim_id, leeway)
 
 **Description:**
-Placeholder description.
+Set's the spawn animation of the spawn, leeway adds a delay in milliseconds.  See appearance id's at https://wiki.eq2emu.com/ReferenceLists for animation ids.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
-- `param2`: unknown - Unknown type.
+- `anim_id` (uint32) - Integer value `anim_id`.
-- `param3`: unknown - Unknown type.
+- `leeway` (uint16) - Integer value `leeway`.
-- `param4`: int32 - Integer value.
-- `param5`: int16 - Short integer value.
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From SpawnScripts/Antonica/anearthcrawler.lua
-SetSpawnAnimation(..., ..., ..., ..., ...)
+function spawn(NPC, Spawn)
+    NPCModule(NPC, Spawn)
+    SetSpawnAnimation(NPC, 13016)
+end
 ```

docs/lua_functions/SetSpeedMultiplier.md

@@ -1,18 +1,20 @@
-### Function: SetSpeedMultiplier(param1, param2, param3)
+### Function: SetSpeedMultiplier(spawn, val)
 
 **Description:**
-Placeholder description.
+Set's the speed multiplier of the spell.  Must be in a spell script.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
-- `param2`: unknown - Unknown type.
+- `val` (float) - Float value `val`.
-- `param3`: float - Floating point value.
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From SpawnScripts/Nektropos1/ArchfiendIzzoroth.lua
-SetSpeedMultiplier(..., ..., ...)
+function spawn(NPC)
+	SetSpeedMultiplier(NPC, 0)
+	AddTimer(NPC, 6000, "MakeAttackable")
+end
 ```

docs/lua_functions/SetSpellData.md

@@ -1,19 +1,27 @@
-### Function: SetSpellData(param1, param2, param3, param4)
+### Function: SetSpellData(spell, field, fieldvalue)
 
 **Description:**
-Placeholder description.
+Set's the spell data value
 
 **Parameters:**
-- `param1`: unknown - Unknown type.
+- `spell` (Spell) - Spell object representing `spell`.
-- `param2`: unknown - Unknown type.
+- `field` (string) - String `field`.
-- `param3`: unknown - Unknown type.
+- `fieldvalue` (value) - `fieldvalue`.
-- `param4`: string - String value.
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From ItemScripts/AbbatoirCoffee.lua
-SetSpellData(..., ..., ..., ...)
+function cast(Item, Player)
+	Spell = GetSpell(5463)
+	Regenz = 18.0
+	newDuration = 180000
+	SetSpellData(Spell, "duration1", newDuration)
+	SetSpellData(Spell, "duration2", newDuration)
+	SetSpellDataIndex(Spell, 0, Regenz)
+	SetSpellDisplayEffect(Spell, 0, "description", "Increases Out-of-Combat Power Regeneration of target by " .. Regenz)
+	CastCustomSpell(Spell, Player, Player)
+end
 ```

docs/lua_functions/SetSpellDataIndex.md

@@ -1,27 +1,28 @@
-### Function: SetSpellDataIndex(param1, param2, param3, param4, param5, param6, param7, param8, param9, param10, param11, param12)
+### Function: SetSpellDataIndex(spell, idx, value, value2)
 
 **Description:**
-Placeholder description.
+Set's the spell data index value
 
 **Parameters:**
-- `param1`: unknown - Unknown type.
+- `spell` (Spell) - Spell object representing `spell`.
-- `param2`: unknown - Unknown type.
+- `idx` (uint32) - Integer value `idx`.
-- `param3`: unknown - Unknown type.
+- `value` (int32) - Integer value `value`.
-- `param4`: unknown - Unknown type.
+- `value2` (int32) - Integer value `value2`.
-- `param5`: int32 - Integer value.
-- `param6`: unknown - Unknown type.
-- `param7`: float - Floating point value.
-- `param8`: bool - Boolean value (true/false).
-- `param9`: string - String value.
-- `param10`: unknown - Unknown type.
-- `param11`: float - Floating point value.
-- `param12`: string - String value.
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From ItemScripts/AbbatoirCoffee.lua
-SetSpellDataIndex(..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ...)
+function cast(Item, Player)
+	Spell = GetSpell(5463)
+	Regenz = 18.0
+	newDuration = 180000
+	SetSpellData(Spell, "duration1", newDuration)
+	SetSpellData(Spell, "duration2", newDuration)
+	SetSpellDataIndex(Spell, 0, Regenz)
+	SetSpellDisplayEffect(Spell, 0, "description", "Increases Out-of-Combat Power Regeneration of target by " .. Regenz)
+	CastCustomSpell(Spell, Player, Player)
+end
 ```

docs/lua_functions/SetSpellDisplayEffect.md

@@ -1,24 +1,28 @@
-### Function: SetSpellDisplayEffect(param1, param2, param3, param4, param5, param6, param7, param8, param9)
+### Function: SetSpellDisplayEffect(spell, idx, field, percentage)
 
 **Description:**
-Placeholder description.
+Set's the spell display effect value.
 
 **Parameters:**
-- `param1`: unknown - Unknown type.
+- `spell` (Spell) - Spell object representing `spell`.
-- `param2`: unknown - Unknown type.
+- `idx` (uint32) - Integer value `idx`.
-- `param3`: unknown - Unknown type.
+- `field` (string) - String `field`.
-- `param4`: unknown - Unknown type.
+- `percentage` (uint8) - Integer value `percentage`.
-- `param5`: int32 - Integer value.
-- `param6`: string - String value.
-- `param7`: string - String value.
-- `param8`: int8 - Small integer or boolean flag.
-- `param9`: int8 - Small integer or boolean flag.
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From ItemScripts/AbbatoirCoffee.lua
-SetSpellDisplayEffect(..., ..., ..., ..., ..., ..., ..., ..., ...)
+function cast(Item, Player)
+	Spell = GetSpell(5463)
+	Regenz = 18.0
+	newDuration = 180000
+	SetSpellData(Spell, "duration1", newDuration)
+	SetSpellData(Spell, "duration2", newDuration)
+	SetSpellDataIndex(Spell, 0, Regenz)
+	SetSpellDisplayEffect(Spell, 0, "description", "Increases Out-of-Combat Power Regeneration of target by " .. Regenz)
+	CastCustomSpell(Spell, Player, Player)
+end
 ```

docs/lua_functions/SetSpellList.md

@@ -1,19 +1,30 @@
-### Function: SetSpellList(param1, param2, param3, param4)
+### Function: SetSpellList(spawn, primary_list, secondary_list)
 
 **Description:**
-Placeholder description.
+Set the spell list of the Spawn for primary and secondary list.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
-- `param2`: unknown - Unknown type.
+- `primary_list` (uint32) - Integer value `primary_list`.
-- `param3`: int32 - Integer value.
+- `secondary_list` (uint32) - Integer value `secondary_list`.
-- `param4`: int32 - Integer value.
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From SpawnScripts/Antonica/abloodsaberseditionist.lua
-SetSpellList(..., ..., ..., ...)
+function ChooseClass(NPC)
+    SetClass = MakeRandomInt(1,2)
+    if SetClass == 1 then
+        SpawnSet(NPC,"class", 2)
+        SetSpellList(NPC, 451)
+        IdleAggressive(NPC)
+        DervishChain(NPC)
+    elseif SetClass == 2 then
+        SpawnSet(NPC, "class", 32)
+        SetSpellList(NPC, 469)
+        IdleAlert(NPC)
+        DervishLeather(NPC)
+    end
 ```

docs/lua_functions/SetSpellSnareValue.md

@@ -1,19 +1,24 @@
-### Function: SetSpellSnareValue(param1, param2, param3, param4)
+### Function: SetSpellSnareValue(snare, spawn)
 
 **Description:**
-Placeholder description.
+Set's the spell snare value of the current spell script.
 
 **Parameters:**
-- `param1`: unknown - Unknown type.
+- `snare` (float) - Float value `snare`.
-- `param2`: float - Floating point value.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
-- `param3`: unknown - Unknown type.
-- `param4`: Spawn - The spawn or entity involved.
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From Spells/Commoner/Blind.lua
-SetSpellSnareValue(..., ..., ..., ...)
+function cast(Caster, Target, Snare)
+    if not IsEpic(Target) then
+        --Dazes the target
+        AddControlEffect(Target, 3)
+        BlurVision(Target, 1.0)
+        SetSpellSnareValue(Target, Snare) 
+        AddControlEffect(Target, 11)
+    end
 ```

docs/lua_functions/SetSpellTriggerCount.md

@@ -1,20 +1,24 @@
-### Function: SetSpellTriggerCount(param1, param2, param3, param4, param5)
+### Function: SetSpellTriggerCount(trigger_count, cancel_after_triggers)
 
 **Description:**
-Placeholder description.
+Set's the spell trigger count in a spell script, cancel_after_triggers set to 1 will remove spell after.
 
 **Parameters:**
-- `param1`: unknown - Unknown type.
+- `trigger_count` (uint16) - uint16 value `trigger_count`.
-- `param2`: unknown - Unknown type.
+- `cancel_after_triggers` (uint8) - uint8 value `cancel_after_triggers`.
-- `param3`: int16 - Short integer value.
-- `param4`: unknown - Unknown type.
-- `param5`: int8 - Small integer or boolean flag.
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From Spells/Commoner/ArcaneEnlightenment.lua
-SetSpellTriggerCount(..., ..., ..., ..., ...)
+function cast(Caster, Target, Power, Triggers)
+    MaxPow = GetMaxPower(Caster)
+    PowHeal = math.floor(MaxPow * 0.2)
+    SpellHeal("Power", PowHeal, PowHeal, Caster)
+    
+    AddProc(Caster, 15, 50)
+    SetSpellTriggerCount(Triggers, 1)
+end
 ```

docs/lua_functions/SetStepFailed.md

@@ -1,22 +1,28 @@
-### Function: SetStepFailed(param1, param2, param3, param4, param5, param6, param7)
+### Function: SetStepFailed(player, quest_id, step)
 
 **Description:**
-Placeholder description.
+Set the player's quest step as failed.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `player` (Spawn) - Spawn object representing `player`.
-- `param2`: unknown - Unknown type.
+- `quest_id` (uint32) - Integer value `quest_id`.
-- `param3`: unknown - Unknown type.
+- `step` (uint32) - Integer value `step`.
-- `param4`: unknown - Unknown type.
-- `param5`: unknown - Unknown type.
-- `param6`: int32 - Integer value.
-- `param7`: int32 - Integer value.
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From Quests/Hallmark/freeport_to_qeynos__part_2.lua
-SetStepFailed(..., ..., ..., ..., ..., ..., ...)
+function Declined(Quest, QuestGiver, Player)
+    FaceTarget(QuestGiver, Player)
+	Dialog.New(QuestGiver, Player)   
+ 	Dialog.AddDialog("I thought I smelled a coward. I want nothing to do with you until you come to your senses.")
+	Dialog.AddVoiceover("voiceover/english/watcher_kenjedeau/fprt_sewer02/watcher_kenjedeau005.mp3", 1178065540, 4141402431)
+    PlayFlavor(QuestGiver, "", "", "glare", 0, 0, Player)
+    Dialog.AddOption("Fine.")	
+	Dialog.Start()
+	if HasQuest(Player,5889) and GetQuestStep(Player,5889) ==1 then
+	    SetStepFailed(Player,5889,1)
+	end
 ```

docs/lua_functions/SetSuccessTimer.md

@@ -1,20 +1,13 @@
-### Function: SetSuccessTimer(param1, param2, param3, param4, param5)
+### Function: SetSuccessTimer(spawn)
 
 **Description:**
-Placeholder description.
+Set the success timer for the spawn in the instance.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
-- `param2`: unknown - Unknown type.
-- `param3`: unknown - Unknown type.
-- `param4`: unknown - Unknown type.
-- `param5`: unknown - Unknown type.
 
 **Returns:** None.
 
 **Example:**
 
-```lua
+Example Required
--- Example usage
-SetSuccessTimer(..., ..., ..., ..., ...)
-```

docs/lua_functions/SetTempVariable.md

@@ -1,22 +1,26 @@
-### Function: SetTempVariable(param1, param2, param3, param4, param5, param6, param7)
+### Function: SetTempVariable(spawn, var, val)
 
 **Description:**
-Placeholder description.
+Set's a temporary variable on the Spawn.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
-- `param2`: unknown - Unknown type.
+- `var` (string) - String `var`.
-- `param3`: unknown - Unknown type.
+- `val` (string) - String `val`.
-- `param4`: unknown - Unknown type.
-- `param5`: unknown - Unknown type.
-- `param6`: string - String value.
-- `param7`: string - String value.
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From ItemScripts/BowlOfTerratrodderChuck.lua
-SetTempVariable(..., ..., ..., ..., ..., ..., ...)
+function used(Item, Player)
+	if HasQuest(Player, AMindOfMyOwn) then
+		if GetZoneID(GetZone(Player)) == 108 then
+
+		    RemoveItem(Player, TerratrodderChuck)
+			local bucket = SpawnMob(GetZone(Player), 1081002, 1, GetX(Player), GetY(Player), GetZ(Player), GetHeading(Player))
+			AddSpawnAccess(bucket, Player)
+			SetTempVariable(bucket, "PlayerPointer", Player)
+		end
 ```

docs/lua_functions/SetTemporaryTransportID.md

@@ -1,17 +1,14 @@
-### Function: SetTemporaryTransportID(param1, param2)
+### Function: SetTemporaryTransportID(player, transport_id)
 
 **Description:**
-Placeholder description.
+Set's the Spawn (Player)'s temporary transport id.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `player` (Spawn) - Spawn object representing `player`.
-- `param2`: int32 - Integer value.
+- `transport_id` (uint32) - Integer value `transport_id`.
 
 **Returns:** None.
 
 **Example:**
 
-```lua
+Example Required
--- Example usage
-SetTemporaryTransportID(..., ...)
-```

docs/lua_functions/SetTradeskillLevel.md

@@ -1,18 +1,24 @@
-### Function: SetTradeskillLevel(param1, param2, param3)
+### Function: SetTradeskillLevel(spawn, level)
 
 **Description:**
-Placeholder description.
+Sets the tradeskill level on the Spawn.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
-- `param2`: unknown - Unknown type.
+- `level` (uint8) - Integer value `level`.
-- `param3`: int8 - Small integer or boolean flag.
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From Quests/Hallmark/cellar_cleanup.lua
-SetTradeskillLevel(..., ..., ...)
+function Step8Complete(Quest, QuestGiver, Player)
+	UpdateQuestStepDescription(Quest, 8, "I spoke with Assistant Dreak.")
+	UpdateQuestTaskGroupDescription(Quest, 2, "I told Assistant Dreak that the cellar is clean.")
+    UpdateQuestZone(Quest,"Mizan's Cellar")
+    if not HasItem(Player,20708,1) and GetTradeskillLevel(Player) <2  then
+    SummonItem(Player,1030001,1)
+    GiveQuestItem(Quest, Player, "", 20708,1001034,1001034,1001034,7391,7391,7391)
+    end
 ```

docs/lua_functions/SetTutorialStep.md

@@ -1,17 +1,24 @@
-### Function: SetTutorialStep(param1, param2)
+### Function: SetTutorialStep(player, step)
 
 **Description:**
-Placeholder description.
+Sets the current tutorial step for the Player.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `player` (Spawn) - Spawn object representing `player`.
-- `param2`: int8 - Small integer or boolean flag.
+- `step` (uint8) - Integer value `step`.
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From Quests/FarJourneyFreeport/TasksaboardtheFarJourney.lua
-SetTutorialStep(..., ...)
+function Step3Init(Quest, QuestGiver, Player)
+	SetTutorialStep(Player, 17)
+	UpdateQuestStepDescription(Quest, 2, "I found Waulon's hat.")
+	UpdateQuestTaskGroupDescription(Quest, 2, "I found Waulon's hat in one of the boxes.")
+
+	AddQuestStepChat(Quest, 3, "I should speak to Waulon.", 1, "Now that I found Waulon's hat, I should return it.", 258, Waulon)
+	AddQuestStepCompleteAction(Quest, 3, "Step3Complete")
+end
 ```

docs/lua_functions/SetVision.md

@@ -1,20 +1,23 @@
-### Function: SetVision(param1, param2, param3, param4, param5)
+### Function: SetVision(spawn, vision)
 
 **Description:**
-Placeholder description.
+Set's the vision mode for the Player.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
-- `param2`: unknown - Unknown type.
+- `vision` (uint32) - Integer value `vision`.
-- `param3`: unknown - Unknown type.
-- `param4`: unknown - Unknown type.
-- `param5`: int32 - Integer value.
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From Spells/Commoner/TotenoftheEnduringSpirit.lua
-SetVision(..., ..., ..., ..., ...)
+function cast(Caster, Target)
+	if (GetLevel(Caster) >= 80) 
+		then    
+	AddControlEffect(Caster, 7)
+	BreatheUnderwater(Caster, true)
+	SetVision(Caster, 4)
+	end
 ```

docs/lua_functions/SetWorldTime.md

@@ -1,19 +1,16 @@
-### Function: SetWorldTime(param1, param2, param3, param4)
+### Function: SetWorldTime(newYear, newMonth, newHour, newMinute)
 
 **Description:**
-Placeholder description.
+Set's the world time on the world server.
 
 **Parameters:**
-- `param1`: int16 - Short integer value.
+- `newYear` (uint16) - Integer value `newYear`.
-- `param2`: int16 - Short integer value.
+- `newMonth` (uint16) - Integer value `newMonth`.
-- `param3`: int16 - Short integer value.
+- `newHour` (uint16) - Integer value `newHour`.
-- `param4`: int16 - Short integer value.
+- `newMinute` (uint16) - Integer value `newMinute`.
 
 **Returns:** None.
 
 **Example:**
 
-```lua
+Example Required
--- Example usage
-SetWorldTime(..., ..., ..., ...)
-```

docs/lua_functions/SetZoneExpansionFlag.md

@@ -1,17 +1,14 @@
-### Function: SetZoneExpansionFlag(param1, param2)
+### Function: SetZoneExpansionFlag(zone, xpackFlag)
 
 **Description:**
-Placeholder description.
+Set's the current zone expansion flag.
 
 **Parameters:**
-- `param1`: ZoneServer - The zone object.
+- `zone` (Zone) - Zone object representing `zone`.
-- `param2`: int32 - Integer value.
+- `xpackFlag` (uint32) - Integer value `xpackFlag`.
 
 **Returns:** None.
 
 **Example:**
 
-```lua
+Example Required
--- Example usage
-SetZoneExpansionFlag(..., ...)
-```

docs/lua_functions/SetZoneHolidayFlag.md

@@ -1,17 +1,14 @@
-### Function: SetZoneHolidayFlag(param1, param2)
+### Function: SetZoneHolidayFlag(zone, holidayFlag)
 
 **Description:**
-Placeholder description.
+Set's the current zone's holiday flag.
 
 **Parameters:**
-- `param1`: ZoneServer - The zone object.
+- `zone` (Zone) - Zone object representing `zone`.
-- `param2`: int32 - Integer value.
+- `holidayFlag` (uint32) - Integer value `holidayFlag`.
 
 **Returns:** None.
 
 **Example:**
 
-```lua
+Example Required
--- Example usage
-SetZoneHolidayFlag(..., ...)
-```

docs/lua_functions/ShowLootWindow.md

@@ -1,19 +1,29 @@
-### Function: ShowLootWindow(param1, param2, param3, param4)
+### Function: ShowLootWindow(player, spawn)
 
 **Description:**
-Placeholder description.
+Shows the Player the Spawn's loot window.
 
 **Parameters:**
-- `param1`: Spawn - The spawn or entity involved.
+- `player` (Spawn) - Spawn object representing `player`.
-- `param2`: unknown - Unknown type.
+- `spawn` (Spawn) - Spawn object representing `spawn`.
-- `param3`: unknown - Unknown type.
-- `param4`: Spawn - The spawn or entity involved.
 
 **Returns:** None.
 
 **Example:**
 
 ```lua
--- Example usage
+-- From SpawnScripts/FarJourneyFreeport/atreasurechest.lua
-ShowLootWindow(..., ..., ..., ...)
+function open(NPC, Player)
+    SendStateCommand(NPC, 399)
+    AddTimer(NPC, 2000, "finished_open_animation")
+    if HasPendingLoot(NPC, Player) then        
+        ShowLootWindow(Player, NPC)
+        DisplayText(Player, 12, "There appears to be something inside this box.")
+        InstructionWindow(Player, -1.0, "This screen shows the contents of the box you just opened. Left click on the loot all button to take the items from the box.", "voiceover/english/narrator/boat_06p_tutorial02/narrator_013_f0780e49.mp3", 1581263773, 1569244108, "tutorial_stage_17", "Left click on the loot all button.", "server")
+        SetTutorialStep(player, 16)
+    else
+        DisplayText(Player, 12, "This box is empty.")
+        ChangeHandIcon(NPC, 0)
+        SpawnSet(NPC, "targetable", 0)
+    end
 ```