Reference library

Lua functions

612 matching entries. Names and bindings reflect this WorldServer checkout. Historical parameter details are under review.

Lua script modules

Shared helpers defined by Lua scripts, available after explicitly loading their modules.

NPCModule → NPC initialization, orc clan appearances, and common orc equipment presets.

DialogModule → NPC conversations, response callbacks, voiceovers, emotes, and player requirements.

MovementModule → Waypoint routes, formation following, and location-based random movement.

NPC appearance examples: Bloodskull(NPC) and OrcArmorCommon(NPC).

FunctionHistorical signatureCurrent bindingExample review
RandomMovementRandomMovement(…) via current bindingEQ2Emu_lua_RandomMovementChecked call
RandomMovementFlightRandomMovementFlight(…) via current bindingEQ2Emu_lua_RandomMovementFlightChecked call
RegisterQuestRegisterQuest(quest, name, type, zone, level, description)EQ2Emu_lua_RegisterQuestUnder review
RemoveCharacterPropertyRemoveCharacterProperty(…) via current bindingEQ2Emu_lua_RemoveCharacterPropertyUnder review
RemoveCoinRemoveCoin(Spawn, Amount)EQ2Emu_lua_RemoveCoinChecked call
RemoveControlEffectRemoveControlEffect(spawn, type, only_remove_spawn)EQ2Emu_lua_RemoveControlEffectChecked call
RemoveIconValueRemoveIconValue(spawn, value)EQ2Emu_lua_RemoveIconValueUnder review
RemoveImmunitySpellRemoveImmunitySpell(type, spawn)EQ2Emu_lua_RemoveImmunitySpellChecked call
RemoveInvisRemoveInvis(spawn)EQ2Emu_lua_RemoveInvisChecked call
RemoveItemRemoveItem(spawn, item_id, quantity)EQ2Emu_lua_RemoveItemChecked call
RemoveLootItemRemoveLootItem(spawn, item_id)EQ2Emu_lua_RemoveLootItemChecked call
RemovePersistentSpellVisualRemovePersistentSpellVisual(…) via current bindingEQ2Emu_lua_RemovePersistentSpellVisualChecked call
RemovePrimaryEntityCommandRemovePrimaryEntityCommand(Spawn, CommandString)EQ2Emu_lua_RemovePrimaryEntityCommandChecked call
RemoveProcRemoveProc(spawn, item)EQ2Emu_lua_RemoveProcChecked call
RemoveQuestStepRemoveQuestStep(player, quest, step)EQ2Emu_lua_RemoveQuestStepUnder review
RemoveRecipeFromPlayerRemoveRecipeFromPlayer(player, recipe_id)EQ2Emu_lua_RemoveRecipeFromPlayerUnder review
RemoveRegionRemoveRegion(zone, version, region_name)EQ2Emu_lua_RemoveRegionUnder review
RemoveSkillRemoveSkill(player_spawn, skill_id, more_to_remove)EQ2Emu_lua_RemoveSkillChecked call
RemoveSkillBonusRemoveSkillBonus(spawn)EQ2Emu_lua_RemoveSkillBonusChecked call
RemoveSpawnAccessRemoveSpawnAccess(Spawn, Player)EQ2Emu_lua_RemoveSpawnAccessChecked call
RemoveSpawnIDAccessRemoveSpawnIDAccess(spawn, id, zone)EQ2Emu_lua_RemoveSpawnIDAccessUnder review
RemoveSpawnSpellBonusRemoveSpawnSpellBonus(…) via current bindingEQ2Emu_lua_RemoveSpawnSpellBonusUnder review
RemoveSpellRemoveSpell(…) via current bindingEQ2Emu_lua_RemoveSpellUnder review
RemoveSpellBonusRemoveSpellBonus(spawn)EQ2Emu_lua_RemoveSpellBonusChecked call
RemoveSpellBookEntryRemoveSpellBookEntry(player, spellid)EQ2Emu_lua_RemoveSpellBookEntryChecked call
RemoveStealthRemoveStealth(spawn)EQ2Emu_lua_RemoveStealthChecked call
RemoveThreatTransferRemoveThreatTransfer(spawn)EQ2Emu_lua_RemoveThreatTransferChecked call
RemoveTriggerFromSpellRemoveTriggerFromSpell(remove_count)EQ2Emu_lua_RemoveTriggerFromSpellChecked call
RemoveWardRemoveWard()EQ2Emu_lua_RemoveWardChecked call
RemoveWaypointRemoveWaypoint(…) via current bindingEQ2Emu_lua_RemoveWaypointUnder review
RemoveWidgetFromSpawnMapRemoveWidgetFromSpawnMap(spawn, widget_id)EQ2Emu_lua_RemoveWidgetFromSpawnMapUnder review
RemoveWidgetFromZoneMapRemoveWidgetFromZoneMap(zone, widget_id)EQ2Emu_lua_RemoveWidgetFromZoneMapChecked call
ReplaceWidgetFromClientReplaceWidgetFromClient(player, widget_id, x, y, z, grid_id)EQ2Emu_lua_ReplaceWidgetFromClientUnder review
ResetCharacterTitlePrefixResetCharacterTitlePrefix(…) via current bindingEQ2Emu_lua_ResetCharacterTitlePrefixUnder review
ResetCharacterTitleSuffixResetCharacterTitleSuffix(…) via current bindingEQ2Emu_lua_ResetCharacterTitleSuffixUnder review
ResetIllusionResetIllusion(spawn)EQ2Emu_lua_ResetIllusionChecked call
ResetQuestStepResetQuestStep(quest, step, desc, task_group)EQ2Emu_lua_ResetQuestStepUnder review
ResurrectResurrect(hp_perc, power_perc, send_window, target, heal_name, crit_mod, no_calcs, revive_spell_id, revive_spell_tier)EQ2Emu_lua_ResurrectChecked call
RunbackRunback(…) via current bindingEQ2Emu_lua_RunbackChecked call
SaySay(spawn, message, player, dist, language)EQ2Emu_lua_SayChecked call
SayOOCSayOOC(spawn, message, player, dist, language)EQ2Emu_lua_SayOOCUnder review
SendBookSendBook(…) via current bindingEQ2Emu_lua_SendBookUnder review
SendHearCastSendHearCast(spell, spell_visual_id, cast_time, caster, target)EQ2Emu_lua_SendHearCastUnder review
SendMessageSendMessage(spawn, message, color_str)EQ2Emu_lua_SendMessageChecked call
SendNewAdventureSpellsSendNewAdventureSpells(player)EQ2Emu_lua_SendNewAdventureSpellsChecked call
SendNewTradeskillSpellsSendNewTradeskillSpells(player)EQ2Emu_lua_SendNewTradeskillSpellsUnder review
SendOptionWindowSendOptionWindow(option_window, player, window_title, cancel_command)EQ2Emu_lua_SendOptionWindowChecked call
SendPopUpMessageSendPopUpMessage(spawn, message, red, green, blue)EQ2Emu_lua_SendPopUpMessageChecked call
SendStateCommandSendStateCommand(spawn, new_state, player)EQ2Emu_lua_SendStateCommandChecked call
SendTimeUpdateSendTimeUpdate(…) via current bindingEQ2Emu_lua_SendTimeUpdateUnder review
SendTransportersSendTransporters(spawn, player, transport_id)EQ2Emu_lua_SendTransportersUnder review
SendUpdateDefaultCommandSendUpdateDefaultCommand(Spawn, Distance, CommandString, Player)EQ2Emu_lua_SendUpdateDefaultCommandChecked call
SendWaypointsSendWaypoints(…) via current bindingEQ2Emu_lua_SendWaypointsUnder review
SetAAInfoSetAAInfo(spawn, type, value)EQ2Emu_lua_SetAAInfoUnder review
SetAccessToEntityCommandSetAccessToEntityCommand(Spawn, Player, CommandString, Allowed)EQ2Emu_lua_SetAccessToEntityCommandChecked call
SetAccessToEntityCommandByCharIDSetAccessToEntityCommandByCharID(Spawn, CharID, CommandString, Allowed)EQ2Emu_lua_SetAccessToEntityCommandByCharIDChecked call
SetAdventureClassSetAdventureClass(spawn, value)EQ2Emu_lua_SetAdventureClassChecked call
SetAggroRadiusSetAggroRadius(spawn, distance, override_)EQ2Emu_lua_SetAggroRadiusChecked call
SetAgiSetAgi(spawn, value)EQ2Emu_lua_SetAgiUnder review
SetAgiBaseSetAgiBase(spawn, value)EQ2Emu_lua_SetAgiBaseChecked call
SetAlignmentSetAlignment(spawn, alignment)EQ2Emu_lua_SetAlignmentChecked call
SetAttackableSetAttackable(spawn, attackable)EQ2Emu_lua_SetAttackableChecked call
SetBotAccessModeSetBotAccessMode(…) via current bindingEQ2Emu_lua_SetBotAccessModeUnder review
SetBrainTickSetBrainTick(spawn, tick)EQ2Emu_lua_SetBrainTickChecked call
SetCanBindSetCanBind(spawn, canbind)EQ2Emu_lua_SetCanBindUnder review
SetCanEvacSetCanEvac(spawn, canevac)EQ2Emu_lua_SetCanEvacUnder review
SetCanGateSetCanGate(spawn, cangate)EQ2Emu_lua_SetCanGateUnder review
SetCastOnAggroCompleteSetCastOnAggroComplete(spawn, value)EQ2Emu_lua_SetCastOnAggroCompleteUnder review
SetCharacterTitlePrefixSetCharacterTitlePrefix(spawn, titleName)EQ2Emu_lua_SetCharacterTitlePrefixChecked call
SetCharacterTitleSuffixSetCharacterTitleSuffix(spawn, titleName)EQ2Emu_lua_SetCharacterTitleSuffixUnder review
SetCharSheetChangedSetCharSheetChanged(spawn, value)EQ2Emu_lua_SetCharSheetChangedChecked call
SetCoinTmpRewardSetCoinTmpReward(quest, coins)EQ2Emu_lua_SetCoinTmpRewardUnder review
SetCompletedDescriptionSetCompletedDescription(quest, description)EQ2Emu_lua_SetCompletedDescriptionUnder review
SetCompleteFlagSetCompleteFlag(quest)EQ2Emu_lua_SetCompleteFlagChecked call
SetCurrentHPSetCurrentHP(spawn, value)Not registeredNot registered
SetCurrentPowerSetCurrentPower(spawn, value)Not registeredNot registered
SetDeitySetDeity(spawn, value)EQ2Emu_lua_SetDeityUnder review
SetEquipmentSetEquipment(…) via current bindingEQ2Emu_lua_SetEquipmentChecked call
SetEquippedItemSetEquippedItem(…) via current bindingEQ2Emu_lua_SetEquippedItemUnder review
SetEquippedItemByIDSetEquippedItemByID(…) via current bindingEQ2Emu_lua_SetEquippedItemByIDUnder review
SetFactionIDSetFactionID(spawn, value)EQ2Emu_lua_SetFactionIDUnder review
SetFailureTimerSetFailureTimer(spawn)EQ2Emu_lua_SetFailureTimerChecked call
SetFollowTargetSetFollowTarget(spawn, target, follow_distance)EQ2Emu_lua_SetFollowTargetChecked call
SetGridIDSetGridID(spawn, grid)EQ2Emu_lua_SetGridIDChecked call
SetHeadingSetHeading(spawn, value)EQ2Emu_lua_SetHeadingChecked call
SetHouseCharacterIDSetHouseCharacterID(…) via current bindingEQ2Emu_lua_SetHouseCharacterIDChecked call
SetHPSetHP(…) via current bindingEQ2Emu_lua_SetCurrentHPChecked call
SetIllusionSetIllusion(spawn, model)EQ2Emu_lua_SetIllusionChecked call
SetInCombatSetInCombat(spawn, val)EQ2Emu_lua_SetInCombatChecked call
SetInfoFlagSetInfoFlag(spawn)EQ2Emu_lua_SetInfoFlagChecked call
SetInfoStructFloatSetInfoStructFloat(spawn, field, value)EQ2Emu_lua_SetInfoStructFloatChecked call
SetInfoStructSIntSetInfoStructSInt(spawn, field, value)EQ2Emu_lua_SetInfoStructSIntChecked call
SetInfoStructStringSetInfoStructString(spawn, field, value)EQ2Emu_lua_SetInfoStructStringChecked call
SetInfoStructUIntSetInfoStructUInt(spawn, field, value)EQ2Emu_lua_SetInfoStructUIntChecked call
SetIntSetInt(spawn, value)EQ2Emu_lua_SetIntUnder review
SetIntBaseSetIntBase(spawn, value)EQ2Emu_lua_SetIntBaseChecked call
SetInvulnerableSetInvulnerable(…) via current bindingEQ2Emu_lua_SetInvulnerableChecked call
SetItemCountSetItemCount(item, owner, new_count)EQ2Emu_lua_SetItemCountUnder review
SetLocationProximityFunctionSetLocationProximityFunction(zone, x, y, z, max_variation, in_range_function, leaving_range_function)EQ2Emu_lua_SetLocationProximityFunctionChecked call
SetLootCoinSetLootCoin(spawn, val)EQ2Emu_lua_SetLootCoinUnder review

Current source: WorldServer/Lua/LuaInterface.cpp.