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
`CompleteTransmute`	`CompleteTransmute(…) via current binding`	EQ2Emu_lua_CompleteTransmute	Checked call
`CopySpawnAppearance`	`CopySpawnAppearance(…) via current binding`	EQ2Emu_lua_CopySpawnAppearance	Checked call
`CreateChoiceWindow`	`CreateChoiceWindow(npc, spawn, windowTextPrompt, acceptText, acceptCommand, declineText, declineCommand, time, textBox, textBoxRequired, maxLength)`	EQ2Emu_lua_CreateChoiceWindow	Checked call
`CreateConversation`	`CreateConversation()`	EQ2Emu_lua_CreateConversation	Checked call
`CreateOptionWindow`	`CreateOptionWindow(…) via current binding`	EQ2Emu_lua_CreateOptionWindow	Checked call
`CreatePersistedRespawn`	`CreatePersistedRespawn(location_id, spawn_type, respawn_time, zone_id)`	EQ2Emu_lua_CreatePersistedRespawn	Under review
`CreateWidgetRegion`	`CreateWidgetRegion(zone, version, region_name, env_name, grid_id, widget_id, dist)`	EQ2Emu_lua_CreateWidgetRegion	Checked call
`CureByControlEffect`	`CureByControlEffect(cure_count, cure_type, cure_name, cure_level, target)`	EQ2Emu_lua_CureByControlEffect	Checked call
`CureByType`	`CureByType(cure_count, cure_type, cure_name, cure_level, target, caster)`	EQ2Emu_lua_CureByType	Checked call
`DamageEquippedItems`	`DamageEquippedItems(spawn, damage_amount)`	EQ2Emu_lua_DamageEquippedItems	Under review
`DamageSpawn`	`DamageSpawn(attacker, victim, type, dmg_type, low_damage, high_damage, spell_name, crit_mod)`	EQ2Emu_lua_DamageSpawn	Checked call
`DeleteAllQuests`	`DeleteAllQuests(…) via current binding`	EQ2Emu_lua_DeleteAllQuests	Under review
`DeleteDBShardID`	`DeleteDBShardID(ShardID)`	EQ2Emu_lua_DeleteDBShardID	Checked call
`DeleteQuest`	`DeleteQuest(…) via current binding`	EQ2Emu_lua_DeleteQuest	Checked call
`DeleteSpellBook`	`DeleteSpellBook(player, type_selection)`	EQ2Emu_lua_DeleteSpellBook	Checked call
`Despawn`	`Despawn(spawn, delay)`	EQ2Emu_lua_Despawn	Checked call
`DespawnByLocationID`	`DespawnByLocationID(zone, location_id, delay)`	EQ2Emu_lua_DespawnByLocationID	Under review
`DismissPet`	`DismissPet(Spawn)`	EQ2Emu_lua_DismissPet	Checked call
`DisplayText`	`DisplayText(player, type, text)`	EQ2Emu_lua_DisplayText	Checked call
`Emote`	`Emote(spawn, message, spawn2, player)`	EQ2Emu_lua_Emote	Checked call
`EnableGameEvent`	`EnableGameEvent(player, event_name, enabled)`	EQ2Emu_lua_EnableGameEvent	Under review
`EndAutoMount`	`EndAutoMount(Spawn)`	EQ2Emu_lua_EndAutoMount	Checked call
`Evac`	`Evac(player, x, y, z, heading)`	EQ2Emu_lua_Evac	Under review
`FaceTarget`	`FaceTarget(spawn, target, reset_action_state)`	EQ2Emu_lua_FaceTarget	Checked call
`FlashWindow`	`FlashWindow(player, window_name, flash_seconds)`	EQ2Emu_lua_FlashWindow	Checked call
`FormationFollow`	`FormationFollow(…) via current binding`	EQ2Emu_lua_FormationFollow	Checked call
`Gate`	`Gate(spell)`	EQ2Emu_lua_Gate	Checked call
`GetAAInfo`	`GetAAInfo(spawn, type)`	EQ2Emu_lua_GetAAInfo	Under review
`GetAggroRadius`	`GetAggroRadius(spawn)`	EQ2Emu_lua_GetAggroRadius	Under review
`GetAgi`	`GetAgi(spawn)`	EQ2Emu_lua_GetAgi	Checked call
`GetAgiBase`	`GetAgiBase(spawn)`	EQ2Emu_lua_GetAgiBase	Under review
`GetAlignment`	`GetAlignment(Player)`	EQ2Emu_lua_GetAlignment	Checked call
`GetArchetypeName`	`GetArchetypeName(spawn)`	EQ2Emu_lua_GetArchetypeName	Checked call
`GetArrowColor`	`GetArrowColor(player, level)`	EQ2Emu_lua_GetArrowColor	Under review
`GetBaseAggroRadius`	`GetBaseAggroRadius(spawn)`	EQ2Emu_lua_GetBaseAggroRadius	Under review
`GetBaseSocialRadius`	`GetBaseSocialRadius(…) via current binding`	EQ2Emu_lua_GetBaseSocialRadius	Under review
`GetBotAccessMode`	`GetBotAccessMode(…) via current binding`	EQ2Emu_lua_GetBotAccessMode	Under review
`GetBotCount`	`GetBotCount(…) via current binding`	EQ2Emu_lua_GetBotCount	Under review
`GetBoundZoneID`	`GetBoundZoneID(spawn)`	EQ2Emu_lua_GetBoundZoneID	Checked call
`GetCanBind`	`GetCanBind(spawn)`	EQ2Emu_lua_GetCanBind	Checked call
`GetCanEvac`	`GetCanEvac(spawn)`	EQ2Emu_lua_GetCanEvac	Checked call
`GetCanGate`	`GetCanGate(spawn)`	EQ2Emu_lua_GetCanGate	Checked call
`GetCasterSpellLevel`	`GetCasterSpellLevel(spell)`	EQ2Emu_lua_GetCasterSpellLevel	Checked call
`GetCharacterFlag`	`GetCharacterFlag(player, flag_id)`	EQ2Emu_lua_GetCharacterFlag	Under review
`GetCharacterID`	`GetCharacterID(spawn)`	EQ2Emu_lua_GetCharacterID	Checked call
`GetCharmedPet`	`GetCharmedPet(Spawn)`	EQ2Emu_lua_GetCharmedPet	Checked call
`GetChoiceSpawnID`	`GetChoiceSpawnID(spawn, commandMatch, declineValue)`	EQ2Emu_lua_GetChoiceSpawnID	Under review
`GetClass`	`GetClass(spawn)`	EQ2Emu_lua_GetClass	Checked call
`GetClassName`	`GetClassName(spawn)`	EQ2Emu_lua_GetClassName	Under review
`GetClientVersion`	`GetClientVersion(Spawn)`	EQ2Emu_lua_GetClientVersion	Checked call
`GetCoinMessage`	`GetCoinMessage(total_coins)`	EQ2Emu_lua_GetCoinMessage	Checked call
`GetCosmeticPet`	`GetCosmeticPet(Spawn)`	EQ2Emu_lua_GetCosmeticPet	Checked call
`GetCurrentHP`	`GetCurrentHP(spawn)`	EQ2Emu_lua_GetCurrentHP	Checked call
`GetCurrentPower`	`GetCurrentPower(spawn)`	EQ2Emu_lua_GetCurrentPower	Under review
`GetCurrentZoneSafeLocation`	`GetCurrentZoneSafeLocation(spawn)`	EQ2Emu_lua_GetCurrentZoneSafeLocation	Under review
`GetDeity`	`GetDeity(spawn)`	EQ2Emu_lua_GetDeity	Checked call
`GetDeityPet`	`GetDeityPet(spawn)`	EQ2Emu_lua_GetDeityPet	Checked call
`GetDifficulty`	`GetDifficulty(spawn)`	EQ2Emu_lua_GetDifficulty	Checked call
`GetDistance`	`GetDistance(spawn, spawn2, include_radius)`	EQ2Emu_lua_GetDistance	Checked call
`GetEncounter`	`GetEncounter(spawn)`	EQ2Emu_lua_GetEncounter	Checked call
`GetEncounterSize`	`GetEncounterSize(spawn)`	EQ2Emu_lua_GetEncounterSize	Under review
`GetEquippedItemByID`	`GetEquippedItemByID(…) via current binding`	EQ2Emu_lua_GetEquippedItemByID	Checked call
`GetEquippedItemBySlot`	`GetEquippedItemBySlot(…) via current binding`	EQ2Emu_lua_GetEquippedItemBySlot	Checked call
`GetExpRequiredByLevel`	`GetExpRequiredByLevel(…) via current binding`	EQ2Emu_lua_GetExpRequiredByLevel	Checked call
`GetFactionAmount`	`GetFactionAmount(player, faction_id)`	EQ2Emu_lua_GetFactionAmount	Checked call
`GetFactionID`	`GetFactionID(spawn)`	EQ2Emu_lua_GetFactionID	Checked call
`GetFollowTarget`	`GetFollowTarget(Spawn)`	EQ2Emu_lua_GetFollowTarget	Under review
`GetGender`	`GetGender(spawn)`	EQ2Emu_lua_GetGender	Checked call
`GetGroup`	`GetGroup(Spawn)`	EQ2Emu_lua_GetGroup	Checked call
`GetHateList`	`GetHateList(spawn)`	EQ2Emu_lua_GetHateList	Under review
`GetHeading`	`GetHeading(spawn)`	EQ2Emu_lua_GetHeading	Checked call
`GetHouseCharacterID`	`GetHouseCharacterID(…) via current binding`	EQ2Emu_lua_GetHouseCharacterID	Under review
`GetHP`	`GetHP(…) via current binding`	EQ2Emu_lua_GetCurrentHP	Checked call
`GetID`	`GetID(spawn)`	EQ2Emu_lua_GetID	Checked call
`GetInfoStructFloat`	`GetInfoStructFloat(spawn, field)`	EQ2Emu_lua_GetInfoStructFloat	Checked call
`GetInfoStructSInt`	`GetInfoStructSInt(spawn, field)`	EQ2Emu_lua_GetInfoStructSInt	Checked call
`GetInfoStructString`	`GetInfoStructString(spawn, field)`	EQ2Emu_lua_GetInfoStructString	Checked call
`GetInfoStructUInt`	`GetInfoStructUInt(spawn, field)`	EQ2Emu_lua_GetInfoStructUInt	Checked call
`GetInt`	`GetInt(spawn)`	EQ2Emu_lua_GetInt	Checked call
`GetIntBase`	`GetIntBase(spawn)`	EQ2Emu_lua_GetIntBase	Under review
`GetItemByID`	`GetItemByID(…) via current binding`	EQ2Emu_lua_GetItemByID	Under review
`GetItemCount`	`GetItemCount(item)`	EQ2Emu_lua_GetItemCount	Checked call
`GetItemEffectType`	`GetItemEffectType(item)`	EQ2Emu_lua_GetItemEffectType	Under review
`GetItemID`	`GetItemID(item)`	EQ2Emu_lua_GetItemID	Checked call
`GetItemSkillReq`	`GetItemSkillReq(item, type)`	EQ2Emu_lua_GetItemSkillReq	Checked call
`GetItemType`	`GetItemType(item)`	EQ2Emu_lua_GetItemType	Checked call
`GetLevel`	`GetLevel(spawn)`	EQ2Emu_lua_GetLevel	Checked call
`GetLootCoin`	`GetLootCoin(spawn)`	EQ2Emu_lua_GetLootCoin	Under review
`GetLootDropType`	`GetLootDropType(spawn)`	EQ2Emu_lua_GetLootDropType	Under review
`GetLootTier`	`GetLootTier(spawn)`	EQ2Emu_lua_GetLootTier	Under review
`GetMaxHP`	`GetMaxHP(spawn)`	EQ2Emu_lua_GetMaxHP	Checked call
`GetMaxHPBase`	`GetMaxHPBase(spawn)`	EQ2Emu_lua_GetMaxHPBase	Under review
`GetMaxPower`	`GetMaxPower(spawn)`	EQ2Emu_lua_GetMaxPower	Checked call
`GetMaxPowerBase`	`GetMaxPowerBase(spawn)`	EQ2Emu_lua_GetMaxPowerBase	Checked call
`GetModelType`	`GetModelType(spawn)`	EQ2Emu_lua_GetModelType	Checked call
`GetMostHated`	`GetMostHated(NPC)`	EQ2Emu_lua_GetMostHated	Checked call
`GetMount`	`GetMount(spawn)`	EQ2Emu_lua_GetMount	Checked call
`GetName`	`GetName(spawn)`	EQ2Emu_lua_GetName	Checked call
`GetOrigX`	`GetOrigX(Spawn)`	EQ2Emu_lua_GetOrigX	Checked call
`GetOrigY`	`GetOrigY(Spawn)`	EQ2Emu_lua_GetOrigY	Under review

Current source: WorldServer/Lua/LuaInterface.cpp.