Reference library

Lua functions

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

FunctionHistorical signatureCurrent bindingExample review
GetOrigZGetOrigZ(Spawn)EQ2Emu_lua_GetOrigZChecked call
GetOwnerGetOwner(spawn)EQ2Emu_lua_GetOwnerUnder review
GetPassengerSpawnListGetPassengerSpawnList(spawn)EQ2Emu_lua_GetPassengerSpawnListUnder review
GetPCTOfHPGetPCTOfHP(spawn, pct)EQ2Emu_lua_GetPCTOfHPChecked call
GetPCTOfPowerGetPCTOfPower(spawn, pct)EQ2Emu_lua_GetPCTOfPowerChecked call
GetPetGetPet(Spawn)EQ2Emu_lua_GetPetChecked call
GetPickupItemIDGetPickupItemID(…) via current bindingEQ2Emu_lua_GetPickupItemIDUnder review
GetPlayerHistoryGetPlayerHistory(Player, HistoryID)EQ2Emu_lua_GetPlayerHistoryChecked call
GetPlayersInZoneGetPlayersInZone(Zone)EQ2Emu_lua_GetPlayersInZoneChecked call
GetPowerGetPower(…) via current bindingEQ2Emu_lua_GetCurrentPowerChecked call
GetQuestGetQuest(player, quest_id)EQ2Emu_lua_GetQuestChecked call
GetQuestCompleteCountGetQuestCompleteCount(Spawn, QuestID)EQ2Emu_lua_GetQuestCompleteCountChecked call
GetQuestFlagsGetQuestFlags(Quest)EQ2Emu_lua_GetQuestFlagsChecked call
GetQuestStepGetQuestStep(player, quest_id)EQ2Emu_lua_GetQuestStepChecked call
GetQuestStepProgressGetQuestStepProgress(player, quest_id, step_id)EQ2Emu_lua_GetQuestStepProgressChecked call
GetRaceGetRace(spawn)EQ2Emu_lua_GetRaceChecked call
GetRaceBaseTypeGetRaceBaseType(Spawn)EQ2Emu_lua_GetRaceBaseTypeChecked call
GetRaceNameGetRaceName(spawn)EQ2Emu_lua_GetRaceNameUnder review
GetRaceTypeGetRaceType(Spawn)EQ2Emu_lua_GetRaceTypeChecked call
GetRaidGetRaid(…) via current bindingEQ2Emu_lua_GetRaidUnder review
GetRandomSpawnByIDGetRandomSpawnByID(spawnref, spawn_id)EQ2Emu_lua_GetRandomSpawnByIDChecked call
GetRuleFlagBoolGetRuleFlagBool(category, name)EQ2Emu_lua_GetRuleFlagBoolChecked call
GetRuleFlagFloatGetRuleFlagFloat(category, name)EQ2Emu_lua_GetRuleFlagFloatChecked call
GetRuleFlagInt32GetRuleFlagInt32(category, name)EQ2Emu_lua_GetRuleFlagInt32Checked call
GetRunbackDistanceGetRunbackDistance(spawn)EQ2Emu_lua_GetRunbackDistanceChecked call
GetRuntimeSpawnCollisionEnabledGetRuntimeSpawnCollisionEnabled(…) via current bindingEQ2Emu_lua_GetSpawnCollisionEnabledUnder review
GetServerVariableGetServerVariable(name)EQ2Emu_lua_GetServerVariableUnder review
GetShardCharIDGetShardCharID(ShardID)EQ2Emu_lua_GetShardCharIDChecked call
GetShardCreatedTimestampGetShardCreatedTimestamp(ShardID)EQ2Emu_lua_GetShardCreatedTimestampChecked call
GetShardIDGetShardID(npc)EQ2Emu_lua_GetShardIDChecked call
GetSkillGetSkill(spawn, name)EQ2Emu_lua_GetSkillChecked call
GetSkillIDByNameGetSkillIDByName(name)EQ2Emu_lua_GetSkillIDByNameChecked call
GetSkillMaxValueGetSkillMaxValue(skill)EQ2Emu_lua_GetSkillMaxValueUnder review
GetSkillNameGetSkillName(skill)EQ2Emu_lua_GetSkillNameUnder review
GetSkillValueGetSkillValue(skill)EQ2Emu_lua_GetSkillValueUnder review
GetSocialRadiusGetSocialRadius(…) via current bindingEQ2Emu_lua_GetSocialRadiusUnder review
GetSpawnGetSpawn(spawn, spawn_id)EQ2Emu_lua_GetSpawnChecked call
GetSpawnByGroupIDGetSpawnByGroupID(zone, group_id)EQ2Emu_lua_GetSpawnByGroupIDChecked call
GetSpawnByLocationIDGetSpawnByLocationID(zone, location_id)EQ2Emu_lua_GetSpawnByLocationIDChecked call
GetSpawnByRailIDGetSpawnByRailID(zone, rail_id)EQ2Emu_lua_GetSpawnByRailIDUnder review
GetSpawnCollisionEnabledGetSpawnCollisionEnabled(…) via current bindingEQ2Emu_lua_GetSpawnCollisionEnabledUnder review
GetSpawnFromListGetSpawnFromList(spawns, position)EQ2Emu_lua_GetSpawnFromListChecked call
GetSpawnGroupIDGetSpawnGroupID(spawn)EQ2Emu_lua_GetSpawnGroupIDChecked call
GetSpawnIDGetSpawnID(spawn)EQ2Emu_lua_GetSpawnIDChecked call
GetSpawnListByRailIDGetSpawnListByRailID(spawn, rail_id)EQ2Emu_lua_GetSpawnListByRailIDUnder review
GetSpawnListBySpawnIDGetSpawnListBySpawnID(spawn, spawn_id)EQ2Emu_lua_GetSpawnListBySpawnIDChecked call
GetSpawnListSizeGetSpawnListSize(…) via current bindingEQ2Emu_lua_GetSpawnListSizeUnder review
GetSpawnLocationIDGetSpawnLocationID(spawn)EQ2Emu_lua_GetSpawnLocationIDChecked call
GetSpawnLocationPlacementIDGetSpawnLocationPlacementID(spawn)EQ2Emu_lua_GetSpawnLocationPlacementIDUnder review
GetSpeedGetSpeed(spawn)EQ2Emu_lua_GetSpeedChecked call
GetSpellGetSpell(spell_id, spell_tier, custom_lua_script)EQ2Emu_lua_GetSpellChecked call
GetSpellCasterGetSpellCaster(spell)EQ2Emu_lua_GetSpellCasterChecked call
GetSpellDataGetSpellData(spell, field)EQ2Emu_lua_GetSpellDataUnder review
GetSpellDataIndexGetSpellDataIndex(spell, idx, secondfield)EQ2Emu_lua_GetSpellDataIndexUnder review
GetSpellDisplayEffectGetSpellDisplayEffect(spell, idx, field)EQ2Emu_lua_GetSpellDisplayEffectUnder review
GetSpellIDGetSpellID()EQ2Emu_lua_GetSpellIDChecked call
GetSpellInitialTargetGetSpellInitialTarget(spell)EQ2Emu_lua_GetSpellInitialTargetUnder review
GetSpellNameGetSpellName(spell)EQ2Emu_lua_GetSpellNameChecked call
GetSpellRequiredLevelGetSpellRequiredLevel(spell)EQ2Emu_lua_GetSpellRequiredLevelChecked call
GetSpellTargetsGetSpellTargets(spell)EQ2Emu_lua_GetSpellTargetsChecked call
GetSpellTierGetSpellTier()EQ2Emu_lua_GetSpellTierChecked call
GetSpellTriggerCountGetSpellTriggerCount(spell)EQ2Emu_lua_GetSpellTriggerCountUnder review
GetStaGetSta(spawn)EQ2Emu_lua_GetStaChecked call
GetStaBaseGetStaBase(spawn)EQ2Emu_lua_GetStaBaseChecked call
GetStrGetStr(spawn)EQ2Emu_lua_GetStrChecked call
GetStrBaseGetStrBase(spawn)EQ2Emu_lua_GetStrBaseUnder review
GetTargetGetTarget(spawn)EQ2Emu_lua_GetTargetChecked call
GetTaskGroupStepGetTaskGroupStep(player, quest_id)EQ2Emu_lua_GetTaskGroupStepUnder review
GetTemporaryTransportIDGetTemporaryTransportID(player)EQ2Emu_lua_GetTemporaryTransportIDUnder review
GetTempVariableGetTempVariable(spawn, var)EQ2Emu_lua_GetTempVariableChecked call
GetTradeskillClassGetTradeskillClass(spawn)EQ2Emu_lua_GetTradeskillClassChecked call
GetTradeskillClassNameGetTradeskillClassName(spawn)EQ2Emu_lua_GetTradeskillClassNameChecked call
GetTradeskillLevelGetTradeskillLevel(spawn)EQ2Emu_lua_GetTradeskillLevelChecked call
GetTSArrowColorGetTSArrowColor(player, level)EQ2Emu_lua_GetTSArrowColorUnder review
GetTutorialStepGetTutorialStep(player)EQ2Emu_lua_GetTutorialStepChecked call
GetVariableValueGetVariableValue(variable_name)EQ2Emu_lua_GetVariableValueChecked call
GetWardAmountLeftGetWardAmountLeft(spell)EQ2Emu_lua_GetWardAmountLeftChecked call
GetWardValueGetWardValue(spell, type)EQ2Emu_lua_GetWardValueUnder review
GetWisGetWis(spawn)EQ2Emu_lua_GetWisChecked call
GetWisBaseGetWisBase(spawn)EQ2Emu_lua_GetWisBaseUnder review
GetWorldTimeHourGetWorldTimeHour(…) via current bindingEQ2Emu_lua_GetWorldTimeHourUnder review
GetWorldTimeMinuteGetWorldTimeMinute(…) via current bindingEQ2Emu_lua_GetWorldTimeMinuteUnder review
GetWorldTimeMonthGetWorldTimeMonth(…) via current bindingEQ2Emu_lua_GetWorldTimeMonthUnder review
GetWorldTimeYearGetWorldTimeYear(…) via current bindingEQ2Emu_lua_GetWorldTimeYearUnder review
GetXGetX(spawn)EQ2Emu_lua_GetXChecked call
GetYGetY(spawn)EQ2Emu_lua_GetYChecked call
GetZGetZ(spawn)EQ2Emu_lua_GetZChecked call
GetZoneGetZone(zone_id|zone_name|spawn)EQ2Emu_lua_GetZoneChecked call
GetZoneExpansionFlagGetZoneExpansionFlag(zone)EQ2Emu_lua_GetZoneExpansionFlagUnder review
GetZoneHolidayFlagGetZoneHolidayFlag(zone)EQ2Emu_lua_GetZoneHolidayFlagUnder review
GetZoneIDGetZoneID(zone)EQ2Emu_lua_GetZoneIDChecked call
GetZoneLockoutTimerGetZoneLockoutTimer(player, zoneID, displayClient)EQ2Emu_lua_GetZoneLockoutTimerUnder review
GetZoneNameGetZoneName(zone)EQ2Emu_lua_GetZoneNameUnder review
GetZonePlayerAvgLevelGetZonePlayerAvgLevel(zone)EQ2Emu_lua_GetZonePlayerAvgLevelUnder review
GetZonePlayerFirstLevelGetZonePlayerFirstLevel(zone)EQ2Emu_lua_GetZonePlayerFirstLevelUnder review
GetZonePlayerMaxLevelGetZonePlayerMaxLevel(zone)EQ2Emu_lua_GetZonePlayerMaxLevelUnder review
GetZonePlayerMinLevelGetZonePlayerMinLevel(zone)EQ2Emu_lua_GetZonePlayerMinLevelChecked call
GetZoneTypeGetZoneType(…) via current bindingEQ2Emu_lua_GetZoneTypeUnder review
GiveExpGiveExp(player, amount)EQ2Emu_lua_GiveExpChecked call
GiveLootGiveLoot(entity, player, coins, item_id)EQ2Emu_lua_GiveLootChecked call

Historical source: ZekLabs AllLUAFunctions. Current source: WorldServer/Lua/LuaInterface.cpp.