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).

Function	Historical signature	Current binding	Example review
`AddCharacterTitle`	`AddCharacterTitle(Spawn, TitleName)`	EQ2Emu_lua_AddCharacterTitle	Checked call
`AddCoin`	`AddCoin(Player, Amount)`	EQ2Emu_lua_AddCoin	Checked call
`AddControlEffect`	`AddControlEffect(Spawn, Type, OnlyAddSpawn)`	EQ2Emu_lua_AddControlEffect	Checked call
`AddConversationOption`	`AddConversationOption(ConversationOption, Message, FunctionName)`	EQ2Emu_lua_AddConversationOption	Checked call
`AddHate`	`AddHate(Spawn, NPC, Amount, SendPacket)`	EQ2Emu_lua_AddHate	Checked call
`AddIconValue`	`AddIconValue(…) via current binding`	EQ2Emu_lua_AddIconValue	Under review
`AddImmunitySpell`	`AddImmunitySpell(ImmunityType, Spawn)`	EQ2Emu_lua_AddImmunitySpell	Checked call
`AddItem`	`AddItem(Spawn, ItemID, Quantity)`	EQ2Emu_lua_AddItem	Checked call
`AddLanguage`	`AddLanguage(Player, LanguageID)`	EQ2Emu_lua_AddLanguage	Checked call
`AddLootCoin`	`AddLootCoin(Spawn, Amount)`	EQ2Emu_lua_AddLootCoin	Under review
`AddLootItem`	`AddLootItem(Spawn, ItemID, Charges)`	EQ2Emu_lua_AddLootItem	Checked call
`AddMasterTitle`	`AddMasterTitle(TitleName, IsPrefix)`	EQ2Emu_lua_AddMasterTitle	Checked call
`AddMultiFloorLift`	`AddMultiFloorLift(Spawn)`	EQ2Emu_lua_AddMultiFloorLift	Checked call
`AddOptionWindowOption`	`AddOptionWindowOption(OptionWindow, OptionName, OptionDescription, OptionIconSheet, OptionIconID, OptionCommand, OptionConfirmTitle)`	EQ2Emu_lua_AddOptionWindowOption	Checked call
`AddPersistentSpellVisual`	`AddPersistentSpellVisual(…) via current binding`	EQ2Emu_lua_AddPersistentSpellVisual	Checked call
`AddPlayerMail`	`AddPlayerMail(Spawn, FromName, SubjectName, MailBody, MailType, Copper, Silver, Gold, Platinum, ItemID, StackSize, ExpireTime, SentTime)`	EQ2Emu_lua_AddPlayerMail	Under review
`AddPlayerMailByCharID`	`AddPlayerMailByCharID(CharacterID, FromName, SubjectName, MailBody, MailType, Copper, Silver, Gold, Platinum, ItemID, StackSize, ExpireTime, SentTime)`	EQ2Emu_lua_AddPlayerMailByCharID	Under review
`AddPrimaryEntityCommand`	`AddPrimaryEntityCommand(Player, Spawn, Name, Distance, Command, ErrorText, CastTime, SpellVisual, DenyListDefault)`	EQ2Emu_lua_AddPrimaryEntityCommand	Checked call
`AddPrimaryEntityCommandAllSpawns`	`AddPrimaryEntityCommandAllSpawns(Player, SpawnID, Name, Distance, Command, ErrorText, CastTime, SpellVisual, DenyListDefault)`	EQ2Emu_lua_AddPrimaryEntityCommandAllSpawns	Under review
`AddProc`	`AddProc(Spawn, Type, Chance, Item, UseAllSpellTargets)`	EQ2Emu_lua_AddProc	Checked call
`AddProcExt`	`AddProcExt(Spawn, ProcType, DamageType, Chance, HPRatio, BelowHealth, TargetHealth, Item, UseAllSpellTargets)`	EQ2Emu_lua_AddProcExt	Checked call
`AddQuestPrereqClass`	`AddQuestPrereqClass(…) via current binding`	EQ2Emu_lua_AddQuestPrereqClass	Under review
`AddQuestPrereqFaction`	`AddQuestPrereqFaction(quest, faction_id, min, max)`	EQ2Emu_lua_AddQuestPrereqFaction	Under review
`AddQuestPrereqItem`	`AddQuestPrereqItem(quest, item_id, quantity)`	EQ2Emu_lua_AddQuestPrereqItem	Under review
`AddQuestPrereqModelType`	`AddQuestPrereqModelType(quest, model_type)`	EQ2Emu_lua_AddQuestPrereqModelType	Under review
`AddQuestPrereqQuest`	`AddQuestPrereqQuest(quest, quest_id)`	EQ2Emu_lua_AddQuestPrereqQuest	Checked call
`AddQuestPrereqRace`	`AddQuestPrereqRace(quest, race)`	EQ2Emu_lua_AddQuestPrereqRace	Under review
`AddQuestPrereqTradeskillClass`	`AddQuestPrereqTradeskillClass(quest, class_id)`	EQ2Emu_lua_AddQuestPrereqTradeskillClass	Under review
`AddQuestPrereqTradeskillLevel`	`AddQuestPrereqTradeskillLevel(quest, level)`	EQ2Emu_lua_AddQuestPrereqTradeskillLevel	Under review
`AddQuestRewardCoin`	`AddQuestRewardCoin(quest, copper, silver, gold, plat)`	EQ2Emu_lua_AddQuestRewardCoin	Checked call
`AddQuestRewardFaction`	`AddQuestRewardFaction(quest, faction_id, amount)`	EQ2Emu_lua_AddQuestRewardFaction	Under review
`AddQuestRewardItem`	`AddQuestRewardItem(quest, item_id, quantity)`	EQ2Emu_lua_AddQuestRewardItem	Checked call
`AddQuestSelectableRewardItem`	`AddQuestSelectableRewardItem(quest, item_id, quantity)`	EQ2Emu_lua_AddQuestSelectableRewardItem	Under review
`AddQuestStep`	`AddQuestStep(quest, step, description, quantity, percentage, str_taskgroup, icon, usableitemid)`	EQ2Emu_lua_AddQuestStep	Checked call
`AddQuestStepChat`	`AddQuestStepChat(quest, step, description, quantity, str_taskgroup, icon, npc_id)`	EQ2Emu_lua_AddQuestStepChat	Checked call
`AddQuestStepCompleteAction`	`AddQuestStepCompleteAction(quest, step, action)`	EQ2Emu_lua_AddQuestStepCompleteAction	Checked call
`AddQuestStepCraft`	`AddQuestStepCraft(quest, step, description, quantity, percentage, str_taskgroup, icon, crafted_item_id)`	EQ2Emu_lua_AddQuestStepCraft	Checked call
`AddQuestStepFailureAction`	`AddQuestStepFailureAction(…) via current binding`	EQ2Emu_lua_AddQuestStepFailureAction	Checked call
`AddQuestStepHarvest`	`AddQuestStepHarvest(quest, step, description, quantity, percentage, str_taskgroup, icon, harvested_item_id)`	EQ2Emu_lua_AddQuestStepHarvest	Checked call
`AddQuestStepKill`	`AddQuestStepKill(…) via current binding`	EQ2Emu_lua_AddQuestStepKill	Checked call
`AddQuestStepKillByRace`	`AddQuestStepKillByRace(…) via current binding`	EQ2Emu_lua_AddQuestStepKillByRace	Checked call
`AddQuestStepKillSelfUpdate`	`AddQuestStepKillSelfUpdate(…) via current binding`	EQ2Emu_lua_AddQuestStepKillSelfUpdate	Under review
`AddQuestStepLocation`	`AddQuestStepLocation(quest, step, description, max_variation, str_taskgroup, icon, dest_x, dest_y, dest_z)`	EQ2Emu_lua_AddQuestStepLocation	Checked call
`AddQuestStepObtainItem`	`AddQuestStepObtainItem(quest, step, description, quantity, percentage, str_taskgroup, icon, obtain_item_id)`	EQ2Emu_lua_AddQuestStepObtainItem	Checked call
`AddQuestStepProgressAction`	`AddQuestStepProgressAction(quest, step, action)`	EQ2Emu_lua_AddQuestStepProgressAction	Checked call
`AddQuestStepSpell`	`AddQuestStepSpell(quest, step, description, quantity, percentage, str_taskgroup, icon, cast_spell_id)`	EQ2Emu_lua_AddQuestStepSpell	Checked call
`AddQuestStepZoneLoc`	`AddQuestStepZoneLoc(quest, step, description, max_variation, str_taskgroup, icon, dest_x, dest_y, dest_z, dest_zone_id)`	EQ2Emu_lua_AddQuestStepZoneLoc	Checked call
`AddQuestUsableItem`	`AddQuestUsableItem(quest, step, description, max_variation, str_taskgroup, icon, dest_x, dest_y, dest_z)`	Not registered	Not registered
`AddRecipeBookToPlayer`	`AddRecipeBookToPlayer(player, recipe_book_id)`	EQ2Emu_lua_AddRecipeBookToPlayer	Under review
`AddRespawn`	`AddRespawn(zone, location_id, respawn_time)`	EQ2Emu_lua_AddRespawn	Under review
`AddSkill`	`AddSkill(…) via current binding`	EQ2Emu_lua_AddSkill	Checked call
`AddSkillBonus`	`AddSkillBonus(spawn, skill_id, value)`	EQ2Emu_lua_AddSkillBonus	Checked call
`AddSpawnAccess`	`AddSpawnAccess(Spawn, Player)`	EQ2Emu_lua_AddSpawnAccess	Checked call
`AddSpawnIDAccess`	`AddSpawnIDAccess(Player, spawn_id, zone)`	EQ2Emu_lua_AddSpawnIDAccess	Under review
`AddSpawnProximity`	`AddSpawnProximity(…) via current binding`	EQ2Emu_lua_AddSpawnProximity	Checked call
`AddSpawnSpellBonus`	`AddSpawnSpellBonus(…) via current binding`	EQ2Emu_lua_AddSpawnSpellBonus	Checked call
`AddSpawnToGroup`	`AddSpawnToGroup(spawn, new_group_id)`	EQ2Emu_lua_AddSpawnToGroup	Checked call
`AddSpellBonus`	`AddSpellBonus(Spawn, type, value)`	EQ2Emu_lua_AddSpellBonus	Checked call
`AddSpellBookEntry`	`AddSpellBookEntry(player, spellid, tier, add_silently, add_to_hotbar)`	EQ2Emu_lua_AddSpellBookEntry	Checked call
`AddSpellTimer`	`AddSpellTimer(…) via current binding`	EQ2Emu_lua_AddSpellTimer	Checked call
`AddStepProgress`	`AddStepProgress(player, quest_id, step, progress)`	EQ2Emu_lua_AddStepProgress	Checked call
`AddTemporaryImmunity`	`AddTemporaryImmunity(…) via current binding`	EQ2Emu_lua_AddTemporaryImmunity	Checked call
`AddThreatTransfer`	`AddThreatTransfer(…) via current binding`	EQ2Emu_lua_AddThreatTransfer	Checked call
`AddTimer`	`AddTimer(spawn, time, function, max_count, player)`	EQ2Emu_lua_AddTimer	Checked call
`AddToWard`	`AddToWard(…) via current binding`	EQ2Emu_lua_AddToWard	Checked call
`AddTransportSpawn`	`AddTransportSpawn(spawn)`	EQ2Emu_lua_AddTransportSpawn	Checked call
`AddWard`	`AddWard(…) via current binding`	EQ2Emu_lua_AddWard	Checked call
`AddWaypoint`	`AddWaypoint(…) via current binding`	EQ2Emu_lua_AddWaypoint	Under review
`AdjustHatePosition`	`AdjustHatePosition(…) via current binding`	EQ2Emu_lua_AdjustHatePosition	Checked call
`ApplySpellVisual`	`ApplySpellVisual(target, spell_visual)`	EQ2Emu_lua_ApplySpellVisual	Checked call
`Attack`	`Attack(NPC, Target)`	EQ2Emu_lua_Attack	Checked call
`AttackAllowed`	`AttackAllowed(…) via current binding`	EQ2Emu_lua_AttackAllowed	Under review
`Bind`	`Bind(spawn, zone_id, x, y, z, h)`	EQ2Emu_lua_Bind	Checked call
`BlurVision`	`BlurVision(…) via current binding`	EQ2Emu_lua_BlurVision	Checked call
`BreatheUnderwater`	`BreatheUnderwater(…) via current binding`	EQ2Emu_lua_BreatheUnderwater	Checked call
`CancelSpell`	`CancelSpell(…) via current binding`	EQ2Emu_lua_CancelSpell	Checked call
`CanHarvest`	`CanHarvest(…) via current binding`	EQ2Emu_lua_CanHarvest	Checked call
`CanReceiveQuest`	`CanReceiveQuest(spawn, quest_id)`	EQ2Emu_lua_CanReceiveQuest	Checked call
`CanSeeInvis`	`CanSeeInvis(…) via current binding`	EQ2Emu_lua_CanSeeInvis	Under review
`CanUseBotFeature`	`CanUseBotFeature(…) via current binding`	EQ2Emu_lua_CanUseBotFeature	Under review
`CastCustomSpell`	`CastCustomSpell(spell, caster, target)`	EQ2Emu_lua_CastCustomSpell	Checked call
`CastEntityCommand`	`CastEntityCommand(caster, target, id, command)`	EQ2Emu_lua_CastEntityCommand	Checked call
`CastSpell`	`CastSpell(target, spell_id, spell_tier, caster, custom_cast_time)`	EQ2Emu_lua_CastSpell	Checked call
`ChangeFaction`	`ChangeFaction(spawn, faction_id, increase_or_decrease)`	EQ2Emu_lua_ChangeFaction	Checked call
`ChangeHandIcon`	`ChangeHandIcon(spawn, displayHandIcon)`	EQ2Emu_lua_ChangeHandIcon	Checked call
`Charm`	`Charm(…) via current binding`	EQ2Emu_lua_Charm	Checked call
`CheckLOS`	`CheckLOS(…) via current binding`	EQ2Emu_lua_CheckLOS	Under review
`CheckLOSByCoordinates`	`CheckLOSByCoordinates(…) via current binding`	EQ2Emu_lua_CheckLOSByCoordinates	Under review
`CheckRaceType`	`CheckRaceType(…) via current binding`	EQ2Emu_lua_CheckRaceType	Checked call
`ClearChoice`	`ClearChoice(spawn, commandToClear, clearDecline)`	EQ2Emu_lua_ClearChoice	Checked call
`ClearEncounter`	`ClearEncounter(…) via current binding`	EQ2Emu_lua_ClearEncounter	Checked call
`ClearHate`	`ClearHate(…) via current binding`	EQ2Emu_lua_ClearHate	Checked call
`ClearHateForSpawn`	`ClearHateForSpawn(…) via current binding`	EQ2Emu_lua_ClearHateForSpawn	Checked call
`ClearRunback`	`ClearRunback(…) via current binding`	EQ2Emu_lua_ClearRunback	Under review
`ClearRunningLocations`	`ClearRunningLocations(spawn)`	EQ2Emu_lua_ClearRunningLocations	Checked call
`ClearSpellVisualState`	`ClearSpellVisualState(…) via current binding`	EQ2Emu_lua_ClearSpellVisualState	Checked call
`CloseConversation`	`CloseConversation(npc, player)`	EQ2Emu_lua_CloseConversation	Checked call
`CloseDoor`	`CloseDoor(…) via current binding`	EQ2Emu_lua_CloseDoor	Checked call
`CloseItemConversation`	`CloseItemConversation(item, player)`	EQ2Emu_lua_CloseItemConversation	Checked call
`CompareSpawns`	`CompareSpawns(…) via current binding`	EQ2Emu_lua_CompareSpawns	Checked call

Current source: WorldServer/Lua/LuaInterface.cpp.