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
`GetOrigZ`	`GetOrigZ(Spawn)`	EQ2Emu_lua_GetOrigZ	Checked call
`GetOwner`	`GetOwner(spawn)`	EQ2Emu_lua_GetOwner	Under review
`GetPassengerSpawnList`	`GetPassengerSpawnList(spawn)`	EQ2Emu_lua_GetPassengerSpawnList	Under review
`GetPCTOfHP`	`GetPCTOfHP(spawn, pct)`	EQ2Emu_lua_GetPCTOfHP	Checked call
`GetPCTOfPower`	`GetPCTOfPower(spawn, pct)`	EQ2Emu_lua_GetPCTOfPower	Checked call
`GetPet`	`GetPet(Spawn)`	EQ2Emu_lua_GetPet	Checked call
`GetPickupItemID`	`GetPickupItemID(…) via current binding`	EQ2Emu_lua_GetPickupItemID	Under review
`GetPlayerHistory`	`GetPlayerHistory(Player, HistoryID)`	EQ2Emu_lua_GetPlayerHistory	Checked call
`GetPlayersInZone`	`GetPlayersInZone(Zone)`	EQ2Emu_lua_GetPlayersInZone	Checked call
`GetPower`	`GetPower(…) via current binding`	EQ2Emu_lua_GetCurrentPower	Checked call
`GetQuest`	`GetQuest(player, quest_id)`	EQ2Emu_lua_GetQuest	Checked call
`GetQuestCompleteCount`	`GetQuestCompleteCount(Spawn, QuestID)`	EQ2Emu_lua_GetQuestCompleteCount	Checked call
`GetQuestFlags`	`GetQuestFlags(Quest)`	EQ2Emu_lua_GetQuestFlags	Checked call
`GetQuestStep`	`GetQuestStep(player, quest_id)`	EQ2Emu_lua_GetQuestStep	Checked call
`GetQuestStepProgress`	`GetQuestStepProgress(player, quest_id, step_id)`	EQ2Emu_lua_GetQuestStepProgress	Checked call
`GetRace`	`GetRace(spawn)`	EQ2Emu_lua_GetRace	Checked call
`GetRaceBaseType`	`GetRaceBaseType(Spawn)`	EQ2Emu_lua_GetRaceBaseType	Checked call
`GetRaceName`	`GetRaceName(spawn)`	EQ2Emu_lua_GetRaceName	Under review
`GetRaceType`	`GetRaceType(Spawn)`	EQ2Emu_lua_GetRaceType	Checked call
`GetRaid`	`GetRaid(…) via current binding`	EQ2Emu_lua_GetRaid	Under review
`GetRandomSpawnByID`	`GetRandomSpawnByID(spawnref, spawn_id)`	EQ2Emu_lua_GetRandomSpawnByID	Checked call
`GetRuleFlagBool`	`GetRuleFlagBool(category, name)`	EQ2Emu_lua_GetRuleFlagBool	Checked call
`GetRuleFlagFloat`	`GetRuleFlagFloat(category, name)`	EQ2Emu_lua_GetRuleFlagFloat	Checked call
`GetRuleFlagInt32`	`GetRuleFlagInt32(category, name)`	EQ2Emu_lua_GetRuleFlagInt32	Checked call
`GetRunbackDistance`	`GetRunbackDistance(spawn)`	EQ2Emu_lua_GetRunbackDistance	Checked call
`GetRuntimeSpawnCollisionEnabled`	`GetRuntimeSpawnCollisionEnabled(…) via current binding`	EQ2Emu_lua_GetSpawnCollisionEnabled	Under review
`GetServerVariable`	`GetServerVariable(name)`	EQ2Emu_lua_GetServerVariable	Under review
`GetShardCharID`	`GetShardCharID(ShardID)`	EQ2Emu_lua_GetShardCharID	Checked call
`GetShardCreatedTimestamp`	`GetShardCreatedTimestamp(ShardID)`	EQ2Emu_lua_GetShardCreatedTimestamp	Checked call
`GetShardID`	`GetShardID(npc)`	EQ2Emu_lua_GetShardID	Checked call
`GetSkill`	`GetSkill(spawn, name)`	EQ2Emu_lua_GetSkill	Checked call
`GetSkillIDByName`	`GetSkillIDByName(name)`	EQ2Emu_lua_GetSkillIDByName	Checked call
`GetSkillMaxValue`	`GetSkillMaxValue(skill)`	EQ2Emu_lua_GetSkillMaxValue	Under review
`GetSkillName`	`GetSkillName(skill)`	EQ2Emu_lua_GetSkillName	Under review
`GetSkillValue`	`GetSkillValue(skill)`	EQ2Emu_lua_GetSkillValue	Under review
`GetSocialRadius`	`GetSocialRadius(…) via current binding`	EQ2Emu_lua_GetSocialRadius	Under review
`GetSpawn`	`GetSpawn(spawn, spawn_id)`	EQ2Emu_lua_GetSpawn	Checked call
`GetSpawnByGroupID`	`GetSpawnByGroupID(zone, group_id)`	EQ2Emu_lua_GetSpawnByGroupID	Checked call
`GetSpawnByLocationID`	`GetSpawnByLocationID(zone, location_id)`	EQ2Emu_lua_GetSpawnByLocationID	Checked call
`GetSpawnByRailID`	`GetSpawnByRailID(zone, rail_id)`	EQ2Emu_lua_GetSpawnByRailID	Under review
`GetSpawnCollisionEnabled`	`GetSpawnCollisionEnabled(…) via current binding`	EQ2Emu_lua_GetSpawnCollisionEnabled	Under review
`GetSpawnFromList`	`GetSpawnFromList(spawns, position)`	EQ2Emu_lua_GetSpawnFromList	Checked call
`GetSpawnGroupID`	`GetSpawnGroupID(spawn)`	EQ2Emu_lua_GetSpawnGroupID	Checked call
`GetSpawnID`	`GetSpawnID(spawn)`	EQ2Emu_lua_GetSpawnID	Checked call
`GetSpawnListByRailID`	`GetSpawnListByRailID(spawn, rail_id)`	EQ2Emu_lua_GetSpawnListByRailID	Under review
`GetSpawnListBySpawnID`	`GetSpawnListBySpawnID(spawn, spawn_id)`	EQ2Emu_lua_GetSpawnListBySpawnID	Checked call
`GetSpawnListSize`	`GetSpawnListSize(…) via current binding`	EQ2Emu_lua_GetSpawnListSize	Under review
`GetSpawnLocationID`	`GetSpawnLocationID(spawn)`	EQ2Emu_lua_GetSpawnLocationID	Checked call
`GetSpawnLocationPlacementID`	`GetSpawnLocationPlacementID(spawn)`	EQ2Emu_lua_GetSpawnLocationPlacementID	Under review
`GetSpeed`	`GetSpeed(spawn)`	EQ2Emu_lua_GetSpeed	Checked call
`GetSpell`	`GetSpell(spell_id, spell_tier, custom_lua_script)`	EQ2Emu_lua_GetSpell	Checked call
`GetSpellCaster`	`GetSpellCaster(spell)`	EQ2Emu_lua_GetSpellCaster	Checked call
`GetSpellData`	`GetSpellData(spell, field)`	EQ2Emu_lua_GetSpellData	Under review
`GetSpellDataIndex`	`GetSpellDataIndex(spell, idx, secondfield)`	EQ2Emu_lua_GetSpellDataIndex	Under review
`GetSpellDisplayEffect`	`GetSpellDisplayEffect(spell, idx, field)`	EQ2Emu_lua_GetSpellDisplayEffect	Under review
`GetSpellID`	`GetSpellID()`	EQ2Emu_lua_GetSpellID	Checked call
`GetSpellInitialTarget`	`GetSpellInitialTarget(spell)`	EQ2Emu_lua_GetSpellInitialTarget	Under review
`GetSpellName`	`GetSpellName(spell)`	EQ2Emu_lua_GetSpellName	Checked call
`GetSpellRequiredLevel`	`GetSpellRequiredLevel(spell)`	EQ2Emu_lua_GetSpellRequiredLevel	Checked call
`GetSpellTargets`	`GetSpellTargets(spell)`	EQ2Emu_lua_GetSpellTargets	Checked call
`GetSpellTier`	`GetSpellTier()`	EQ2Emu_lua_GetSpellTier	Checked call
`GetSpellTriggerCount`	`GetSpellTriggerCount(spell)`	EQ2Emu_lua_GetSpellTriggerCount	Under review
`GetSta`	`GetSta(spawn)`	EQ2Emu_lua_GetSta	Checked call
`GetStaBase`	`GetStaBase(spawn)`	EQ2Emu_lua_GetStaBase	Checked call
`GetStr`	`GetStr(spawn)`	EQ2Emu_lua_GetStr	Checked call
`GetStrBase`	`GetStrBase(spawn)`	EQ2Emu_lua_GetStrBase	Under review
`GetTarget`	`GetTarget(spawn)`	EQ2Emu_lua_GetTarget	Checked call
`GetTaskGroupStep`	`GetTaskGroupStep(player, quest_id)`	EQ2Emu_lua_GetTaskGroupStep	Under review
`GetTemporaryTransportID`	`GetTemporaryTransportID(player)`	EQ2Emu_lua_GetTemporaryTransportID	Under review
`GetTempVariable`	`GetTempVariable(spawn, var)`	EQ2Emu_lua_GetTempVariable	Checked call
`GetTradeskillClass`	`GetTradeskillClass(spawn)`	EQ2Emu_lua_GetTradeskillClass	Checked call
`GetTradeskillClassName`	`GetTradeskillClassName(spawn)`	EQ2Emu_lua_GetTradeskillClassName	Checked call
`GetTradeskillLevel`	`GetTradeskillLevel(spawn)`	EQ2Emu_lua_GetTradeskillLevel	Checked call
`GetTSArrowColor`	`GetTSArrowColor(player, level)`	EQ2Emu_lua_GetTSArrowColor	Under review
`GetTutorialStep`	`GetTutorialStep(player)`	EQ2Emu_lua_GetTutorialStep	Checked call
`GetVariableValue`	`GetVariableValue(variable_name)`	EQ2Emu_lua_GetVariableValue	Checked call
`GetWardAmountLeft`	`GetWardAmountLeft(spell)`	EQ2Emu_lua_GetWardAmountLeft	Checked call
`GetWardValue`	`GetWardValue(spell, type)`	EQ2Emu_lua_GetWardValue	Under review
`GetWis`	`GetWis(spawn)`	EQ2Emu_lua_GetWis	Checked call
`GetWisBase`	`GetWisBase(spawn)`	EQ2Emu_lua_GetWisBase	Under review
`GetWorldTimeHour`	`GetWorldTimeHour(…) via current binding`	EQ2Emu_lua_GetWorldTimeHour	Under review
`GetWorldTimeMinute`	`GetWorldTimeMinute(…) via current binding`	EQ2Emu_lua_GetWorldTimeMinute	Under review
`GetWorldTimeMonth`	`GetWorldTimeMonth(…) via current binding`	EQ2Emu_lua_GetWorldTimeMonth	Under review
`GetWorldTimeYear`	`GetWorldTimeYear(…) via current binding`	EQ2Emu_lua_GetWorldTimeYear	Under review
`GetX`	`GetX(spawn)`	EQ2Emu_lua_GetX	Checked call
`GetY`	`GetY(spawn)`	EQ2Emu_lua_GetY	Checked call
`GetZ`	`GetZ(spawn)`	EQ2Emu_lua_GetZ	Checked call
`GetZone`	`GetZone(zone_id\|zone_name\|spawn)`	EQ2Emu_lua_GetZone	Checked call
`GetZoneExpansionFlag`	`GetZoneExpansionFlag(zone)`	EQ2Emu_lua_GetZoneExpansionFlag	Under review
`GetZoneHolidayFlag`	`GetZoneHolidayFlag(zone)`	EQ2Emu_lua_GetZoneHolidayFlag	Under review
`GetZoneID`	`GetZoneID(zone)`	EQ2Emu_lua_GetZoneID	Checked call
`GetZoneLockoutTimer`	`GetZoneLockoutTimer(player, zoneID, displayClient)`	EQ2Emu_lua_GetZoneLockoutTimer	Under review
`GetZoneName`	`GetZoneName(zone)`	EQ2Emu_lua_GetZoneName	Under review
`GetZonePlayerAvgLevel`	`GetZonePlayerAvgLevel(zone)`	EQ2Emu_lua_GetZonePlayerAvgLevel	Under review
`GetZonePlayerFirstLevel`	`GetZonePlayerFirstLevel(zone)`	EQ2Emu_lua_GetZonePlayerFirstLevel	Under review
`GetZonePlayerMaxLevel`	`GetZonePlayerMaxLevel(zone)`	EQ2Emu_lua_GetZonePlayerMaxLevel	Under review
`GetZonePlayerMinLevel`	`GetZonePlayerMinLevel(zone)`	EQ2Emu_lua_GetZonePlayerMinLevel	Checked call
`GetZoneType`	`GetZoneType(…) via current binding`	EQ2Emu_lua_GetZoneType	Under review
`GiveExp`	`GiveExp(player, amount)`	EQ2Emu_lua_GiveExp	Checked call
`GiveLoot`	`GiveLoot(entity, player, coins, item_id)`	EQ2Emu_lua_GiveLoot	Checked call

Current source: WorldServer/Lua/LuaInterface.cpp.