38 KiB
38 KiB
📜 EQ2Emu Lua API Documentation
This document will detail all Lua scripting functions available within EQ2Emu.
📚 Table of Contents
AddCharacterTitle(Spawn, TitleName)AddCoin(Player, Amount)AddControlEffect(Spawn, Type, OnlyAddSpawn)AddConversationOption(param1, param2, param3)AddHate(Spawn, NPC, Amount, SendPacket)AddImmunitySpell(ImmunityType, Spawn)AddItem(Spawn, ItemID, Quantity)AddLanguage(Player, LanguageID)AddLootCoin(Spawn, Amount)AddLootItem(Spawn, ItemID, Charges)AddMasterTitle(TitleName, IsPrefix)AddMultiFloorLift(Spawn)AddOptionWindowOption(OptionWindow, OptionName, OptionDescription, OptionIconSheet, OptionIconID, OptionCommand, OptionConfirmTitle)AddPlayerMail(Spawn, FromName, SubjectName, MailBody, MailType, Copper, Silver, Gold, Platinum, ItemID, StackSize, ExpireTime, SentTime)AddPlayerMailByCharID(CharacterID, FromName, SubjectName, MailBody, MailType, Copper, Silver, Gold, Platinum, ItemID, StackSize, ExpireTime, SentTime)AddPrimaryEntityCommand(Player, Spawn, Name, Distance, Command, ErrorText, CastTime, SpellVisual, DenyListDefault)AddPrimaryEntityCommandAllSpawns(Player, SpawnID, Name, Distance, Command, ErrorText, CastTime, SpellVisual, DenyListDefault)AddProc(Spawn, Type, Chance, Item, UseAllSpellTargets)AddProcExt(Spawn, ProcType, DamageType, Chance, HPRatio, BelowHealth, TargetHealth, Item, UseAllSpellTargets)AddQuestPrereqFaction(quest, faction_id, min, max)AddQuestPrereqItem(quest, item_id, quantity)AddQuestPrereqModelType(quest, model_type)AddQuestPrereqQuest(quest, quest_id)AddQuestPrereqRace(quest, race)AddQuestPrereqTradeskillClass(quest, class_id)AddQuestPrereqTradeskillLevel(quest, level)AddQuestRewardCoin(quest, copper, silver, gold, plat)AddQuestRewardFaction(quest, faction_id, amount)AddQuestRewardItem(quest, item_id, quantity)AddQuestSelectableRewardItem(quest, item_id, quantity)AddQuestStep(quest, step, description, quantity, percentage, str_taskgroup, icon, usableitemid)AddQuestStepChat(quest, step, description, quantity, str_taskgroup, icon, npc_id)AddQuestStepCompleteAction(quest, step, action)AddQuestStepCraft(quest, step, description, quantity, percentage, str_taskgroup, icon, crafted_item_id)AddQuestStepHarvest(quest, step, description, quantity, percentage, str_taskgroup, icon, harvested_item_id)AddQuestStepLocation(quest, step, description, max_variation, str_taskgroup, icon, dest_x, dest_y, dest_z)AddQuestStepObtainItem(quest, step, description, quantity, percentage, str_taskgroup, icon, obtain_item_id)AddQuestStepProgressAction(quest, step, action)AddQuestStepSpell(quest, step, description, quantity, percentage, str_taskgroup, icon, cast_spell_id)AddQuestStepZoneLoc(quest, step, description, max_variation, str_taskgroup, icon, dest_x, dest_y, dest_z, dest_zone_id)AddQuestUsableItem(quest, step, description, max_variation, str_taskgroup, icon, dest_x, dest_y, dest_z)AddRecipeBookToPlayer(player, recipe_book_id)AddRespawn(zone, location_id, respawn_time)AddSkillBonus(spawn, skill_id, value)AddSpawnAccess(Spawn, Player)AddSpawnIDAccess(Player, spawn_id, zone)AddSpawnToGroup(spawn, new_group_id)AddSpellBonus(param1, param2, param3, param4, param5, param6, param7)AddSpellBookEntry(param1, param2, param3, param4, param5, param6)AddStepProgress(param1, param2, param3, param4)AddTimer(param1, param2, param3, param4, param5, param6, param7, param8)AddTransportSpawn(param1, param2)ApplySpellVisual(param1, param2)Attack(NPC, Target)Bind(param1, param2, param3, param4, param5, param6, param7, param8, param9)CanReceiveQuest(param1, param2, param3, param4)CastCustomSpell(spell, caster, target)CastEntityCommand(caster, target, id, command)CastSpell(param1, param2, param3, param4, param5, param6, param7, param8, param9)ChangeFaction(param1, param2, param3)ChangeHandIcon(param1, param2)ClearChoice(param1, param2, param3, param4)ClearRunningLocations(param1)CloseConversation(param1, param2)CloseItemConversation(param1, param2)CreateChoiceWindow(param1, param2, param3, param4, param5, param6, param7, param8, param9, param10, param11, param12, param13)CreateConversation(param1)CreatePersistedRespawn(location_id, spawn_type, respawn_time, zone_id)CreateWidgetRegion(zone, version, region_name, env_name, grid_id, widget_id, dist)CureByControlEffect(cure_count, cure_type, cure_name, cure_level, target)CureByType(cure_count, cure_type, cure_name, cure_level, target, caster)DamageEquippedItems(spawn, damage_amount)DamageSpawn(attacker, victim, type, dmg_type, low_damage, high_damage, spell_name, crit_mod)DeleteDBShardID(ShardID)DeleteSpellBook(player, type_selection)Despawn(spawn, delay)DespawnByLocationID(zone, location_id, delay)DismissPet(Spawn)DisplayText(player, type, text)Emote(spawn, message, spawn2, player)EnableGameEvent(player, event_name, enabled)EndAutoMount(Spawn)Evac(player, x, y, z, heading)FaceTarget(spawn, target, reset_action_state)FlashWindow(player, window_name, flash_seconds)Gate(spell)GetAAInfo(spawn, type)GetAggroRadius(spawn)GetAgi(spawn)GetAgiBase(spawn)GetAlignment(Player)GetArchetypeName(spawn)GetArrowColor(player, level)GetBaseAggroRadius(spawn)GetBoundZoneID(spawn)GetCanBind(spawn)GetCanEvac(spawn)GetCanGate(spawn)GetCasterSpellLevel(spell)GetCharacterFlag(player, flag_id)GetCharacterID(spawn)GetCharmedPet(Spawn)GetChoiceSpawnID(spawn, commandMatch, declineValue)GetClass(spawn)GetClassName(spawn)GetClientVersion(Spawn)GetCoinMessage(total_coins)GetCosmeticPet(Spawn)GetCurrentHP(spawn)GetCurrentPower(spawn)GetCurrentZoneSafeLocation(spawn)GetDeity(spawn)GetDeityPet(spawn)GetDifficulty(spawn)GetDistance(spawn, spawn2, include_radius)GetEncounter(spawn)GetEncounterSize(spawn)GetFactionAmount(player, faction_id)GetFactionID(spawn)GetFollowTarget(Spawn)GetGender(spawn)GetGroup(Spawn)GetHateList(spawn)GetHeading(spawn)GetID(spawn)GetInfoStructFloat(spawn, field)GetInfoStructSInt(spawn, field)GetInfoStructString(spawn, field)GetInfoStructUInt(spawn, field)GetInt(spawn)GetIntBase(spawn)GetItemCount(item)GetItemEffectType(item)GetItemID(item)GetItemSkillReq(item, type)GetItemType(item)GetLevel(spawn)GetLootCoin(spawn)GetLootDropType(spawn)GetLootTier(spawn)GetMaxHP(spawn)GetMaxHPBase(spawn)GetMaxPower(spawn)GetMaxPowerBase(spawn)GetModelType(spawn)GetMostHated(NPC)GetMount(spawn)GetName(spawn)GetOrigX(Spawn)GetOrigY(Spawn)GetOrigZ(Spawn)GetOwner(spawn)GetPassengerSpawnList(spawn)GetPCTOfHP(spawn, pct)GetPCTOfPower(spawn, pct)GetPet(Spawn)GetPlayerHistory(Player, HistoryID)GetPlayersInZone(Zone)GetQuest(player, quest_id)GetQuestCompleteCount(Spawn, QuestID)GetQuestFlags(Quest)GetQuestStep(player, quest_id)GetQuestStepProgress(player, quest_id, step_id)GetRace(spawn)GetRaceBaseType(Spawn)GetRaceName(spawn)GetRaceType(Spawn)GetRandomSpawnByID(spawnref, spawn_id)GetRuleFlagBool(category, name)GetRuleFlagFloat(category, name)GetRuleFlagInt32(category, name)GetRunbackDistance(spawn)GetServerVariable(name)GetShardCharID(ShardID)GetShardCreatedTimestamp(ShardID)GetShardID(npc)GetSkill(spawn, name)GetSkillIDByName(name)GetSkillMaxValue(skill)GetSkillName(skill)GetSkillValue(skill)GetSpawn(spawn, spawn_id)GetSpawnByGroupID(zone, group_id)GetSpawnByLocationID(zone, location_id)GetSpawnByRailID(zone, rail_id)GetSpawnFromList(spawns, position)GetSpawnGroupID(spawn)GetSpawnID(spawn)GetSpawnListByRailID(spawn, rail_id)GetSpawnListBySpawnID(spawn, spawn_id)GetSpawnLocationID(spawn)GetSpawnLocationPlacementID(spawn)GetSpeed(spawn)GetSpell(spell_id, spell_tier, custom_lua_script)GetSpellCaster(spell)GetSpellData(spell, field)GetSpellDataIndex(spell, idx, secondfield)GetSpellDisplayEffect(spell, idx, field)GetSpellID()GetSpellInitialTarget(spell)GetSpellName(spell)GetSpellRequiredLevel(spell)GetSpellTargets(spell)GetSpellTier()GetSpellTriggerCount(spell)GetSta(spawn)GetStaBase(spawn)GetStr(spawn)GetStrBase(spawn)GetTarget(spawn)GetTaskGroupStep(player, quest_id)GetTemporaryTransportID(player)GetTempVariable(spawn, var)GetTradeskillClass(spawn)GetTradeskillClassName(spawn)GetTradeskillLevel(spawn)GetTSArrowColor(player, level)GetTutorialStep(player)GetVariableValue(variable_name)GetWardAmountLeft(spell)GetWardValue(spell, type)GetWis(spawn)GetWisBase(spawn)GetX(spawn)GetY(spawn)GetZ(spawn)GetZone(zone_id|zone_name|spawn)GetZoneExpansionFlag(zone)GetZoneHolidayFlag(zone)GetZoneID(zone)GetZoneLockoutTimer(player, zoneID, displayClient)GetZoneName(zone)GetZonePlayerAvgLevel(zone)GetZonePlayerFirstLevel(zone)GetZonePlayerMaxLevel(zone)GetZonePlayerMinLevel(zone)GiveExp(player, amount)GiveLoot(entity, player, coins, item_id)GiveQuestReward(quest, spawn)HandInCollections(player)Harvest(player, node)HasCoin(Spawn, Value)HasCollectionsToHandIn(param1)HasCompletedQuest(param1, param2)HasControlEffect(spawn, type)HasFreeSlot(param1)HasGroup(param1, param2)HasItem(Player, ItemID, IncludeBank)HasItemEquipped(player, item_id)HasLanguage(player, language_id)HasLootItem(spawn, item_id)HasMoved(param1)HasPendingLoot(entity, player)HasPendingLootItem(entity, player, item_id)HasPendingQuest(player, quest_id)HasQuest(player, quest_id)HasQuestRewardItem(quest, item_id)HasRecipeBook(param1, param2, param3, param4)HasRecovered(spawn)HasSkill(player, skill_id)HasSpell(player, spellid, tier)HasSpellEffect(spawn, spellID, tier)HasSpellImmunity(spawn, type)IncreaseSkillCapsByType(player_spawn, skill_type, amount, more_to_increase)InFront(param1, param2, param3, param4)InLava(Spawn)InstructionWindow(player, duration, text, voice, voice_key1, voice_key2, signal, goal1, task1, goal2, task2, goal3, task3, goal4, task4)InstructionWindowClose(player)InstructionWindowGoal(player, goal_num)InWater(Spawn)IsAlive(param1)IsBehind(spawn, target)IsBindAllowed(param1)IsCasting(spawn)IsCastOnAggroComplete(param1, param2, param3)IsEntity(spawn)IsEpic(Spawn)IsFlanking(spawn, target)IsFollowing(spawn)IsGateAllowed(param1, param2)IsGroundSpawn(spawn)IsHeroic(spawn)IsInCombat(param1)IsInvis(param1, param2, param3)IsInvulnerable(spawn)IsMezzed(spawn)IsMezzedOrStunned(spawn)IsNight(Zone)IsOnAutoMount(player)IsPlayer(Player)IsRunning(spawn)IsSpawnGroupAlive(param1, param2)IsStealthed(param1, param2, param3)IsStunned(spawn)IsTransportSpawn(param1, param2)IsZoneLoading(zone)KillSpawn(param1, param2, param3)KillSpawnByDistance(param1, param2, param3, param4)Knockback(target_spawn, spawn, duration, vertical, horizontal, use_heading)LastSpellAttackHit()MakeRandomFloat(min, max)ModifyHP(spawn, value)ModifyMaxHP(spawn, value)ModifyMaxPower(spawn, value)ModifyPower(spawn, value)MovementLoopAdd(spawn, x, y, z, speed, delay, function, heading, exclude_heading, use_nav_path)MoveToLocation(spawn, x, y, z, speed, lua_function, more_points, use_nav_path)OfferQuest(npc, player, quest_id, forced)PlayAnimation(spawn, anim, target, hide_type)PlayAnimationString(spawn, name, opt_target, set_no_target, use_all_spelltargets, ignore_self)PlayFlavor(spawn, mp3_string, text_string, emote_string, key1, key2, player, language)PlayFlavorID(spawn, type, id, index, player, language)PlaySound(spawn, sound_string, x, y, z, player)PlayVoice(spawn, mp3_string, key1, key2, player)ProcDamage(caster, target, name, dmg_type, low_damage, high_damage, success_msg, effect_msg)ProcessMelee(spawn, target, distance)ProcessSpell(spawn, target, distance)ProvidesQuest(npc, quest_id)QuestIsComplete(player, quest_id)QuestReturnNPC(quest, spawn_id)QuestStepIsComplete(player, quest_id, step_id)RegisterQuest(quest, name, type, zone, level, description)RemoveCoin(Spawn, Amount)RemoveControlEffect(spawn, type, only_remove_spawn)RemoveIconValue(spawn, value)RemoveImmunitySpell(type, spawn)RemoveInvis(spawn)RemoveItem(spawn, item_id, quantity)RemoveLootItem(spawn, item_id)RemovePrimaryEntityCommand(Spawn, CommandString)RemoveProc(spawn, item)RemoveQuestStep(player, quest, step)RemoveRecipeFromPlayer(player, recipe_id)RemoveRegion(zone, version, region_name)RemoveSkill(player_spawn, skill_id, more_to_remove)RemoveSkillBonus(spawn)RemoveSpawnAccess(Spawn, Player)RemoveSpawnIDAccess(spawn, id, zone)RemoveSpellBonus(spawn)RemoveSpellBookEntry(player, spellid)RemoveStealth(spawn)RemoveThreatTransfer(spawn)RemoveTriggerFromSpell(remove_count)RemoveWard()RemoveWidgetFromSpawnMap(spawn, widget_id)RemoveWidgetFromZoneMap(zone, widget_id)ReplaceWidgetFromClient(player, widget_id, x, y, z, grid_id)ResetIllusion(spawn)ResetQuestStep(quest, step, desc, task_group)Resurrect(hp_perc, power_perc, send_window, target, heal_name, crit_mod, no_calcs, revive_spell_id, revive_spell_tier)Say(spawn, message, player, dist, language)SayOOC(spawn, message, player, dist, language)SendHearCast(spell, spell_visual_id, cast_time, caster, target)SendMessage(spawn, message, color_str)SendNewAdventureSpells(player)SendNewTradeskillSpells(player)SendOptionWindow(option_window, player, window_title, cancel_command)SendPopUpMessage(spawn, message, red, green, blue)SendStateCommand(spawn, new_state, player)SendTransporters(spawn, player, transport_id)SendUpdateDefaultCommand(Spawn, Distance, CommandString, Player)SetAAInfo(spawn, type, value)SetAccessToEntityCommand(Spawn, Player, CommandString, Allowed)SetAccessToEntityCommandByCharID(Spawn, CharID, CommandString, Allowed)SetAdventureClass(spawn, value)SetAggroRadius(spawn, distance, override_)SetAgi(spawn, value)SetAgiBase(spawn, value)SetAlignment(spawn, alignment)SetAttackable(spawn, attackable)SetBrainTick(spawn, tick)SetCanBind(spawn, canbind)SetCanEvac(spawn, canevac)SetCanGate(spawn, cangate)SetCastOnAggroComplete(spawn, value)SetCharacterTitlePrefix(spawn, titleName)SetCharacterTitleSuffix(spawn, titleName)SetCharSheetChanged(spawn, value)SetCoinTmpReward(quest, coins)SetCompletedDescription(quest, description)SetCompleteFlag(quest)SetCurrentHP(param1, param2)SetCurrentPower(param1, param2)SetDeity(spawn, value)SetFactionID(spawn, value)SetFailureTimer(spawn)SetFollowTarget(spawn, target, follow_distance)SetGridID(spawn, grid)SetHeading(spawn, value)SetIllusion(spawn, model)SetInCombat(spawn, val)SetInfoFlag(spawn)SetInfoStructFloat(spawn, field, value)SetInfoStructSInt(spawn, field, value)SetInfoStructString(spawn, field, value)SetInfoStructUInt(spawn, field, value)SetInt(spawn, value)SetIntBase(spawn, value)SetItemCount(item, owner, new_count)SetLocationProximityFunction(zone, x, y, z, max_variation, in_range_function, leaving_range_function)SetLootCoin(spawn, val)SetLootDropType(spawn, loot_drop_type)SetLootTier(spawn, loot_tier)SetLuaBrain(spawn)SetMaxHP(spawn, value)SetMaxHPBase(spawn, value)SetMaxPower(spawn, value)SetMaxPowerBase(spawn, value)SetModelType(spawn, value)SetMount(spawn, value)SetMountColor(spawn, red, green, blue, red, green, blue)SetPlayerHistory(player, event_id, value, value2)SetPlayerPOVGhost(player, spawn)SetPlayerProximityFunction(spawn, distance, in_range_function, leaving_range_function)SetPosition(spawn, x, y, z, heading)SetQuestCompleteAction(quest, action)SetQuestFeatherColor(quest, feather_color)SetQuestFlags(quest, flags)SetQuestPrereqLevel(quest, level)SetQuestRepeatable(quest)SetQuestRewardComment(quest, comment)SetQuestRewardExp(quest, exp)SetQuestRewardStatus(quest, status, min_status_earned, max_status_earned)SetQuestTimer(quest, player, step, duration, action)SetQuestTimerComplete(quest, player)SetQuestYellow(quest)SetRailID(spawn, rail_id)SetRequiredHistory(spawn, event_id, value1, value2, flag_override)SetRequiredQuest(spawn, quest_id, quest_step, flag_override)SetServerControlFlag(spawn, param, param_value, value)SetServerVariable(name, value, comment)SetSkillMaxValue(skill, value)SetSkillValue(skill, value)SetSpawnAnimation(spawn, anim_id, leeway)SetSpawnGroupID(spawn, new_group_id)SetSpeed(spawn, value)SetSpeedMultiplier(spawn, val)SetSpellData(spell, field, fieldvalue)SetSpellDataIndex(spell, idx, value, value2)SetSpellDisplayEffect(spell, idx, field, percentage)SetSpellList(spawn, primary_list, secondary_list)SetSpellSnareValue(snare, spawn)SetSpellTriggerCount(trigger_count, cancel_after_triggers)SetSta(spawn, value)SetStaBase(spawn, value)SetStatusTmpReward(quest, status)SetStepComplete(player, quest_id, step)SetStepFailed(player, quest_id, step)SetStr(spawn, value)SetStrBase(spawn, value)SetSuccessTimer(spawn)SetTemporaryTransportID(player, transport_id)SetTempVariable(spawn, var, val)SetTradeskillClass(spawn, value)SetTradeskillLevel(spawn, level)SetTutorialStep(player, step)SetVision(spawn, vision)SetVisualFlag(spawn)SetWis(spawn, value)SetWisBase(spawn, value)SetWorldTime(newYear, newMonth, newHour, newMinute)SetZoneExpansionFlag(zone, xpackFlag)SetZoneHolidayFlag(zone, holidayFlag)Shout(spawn, message, player, dist, language)ShowLootWindow(player, spawn)ShowWindow(player, window, show)Spawn(zone, spawn_id, x, y, z, heading)SpawnByLocationID(zone, location_id)SpawnGroupByID(zone, group_id, custom_level)SpawnMove(spawn, player, max_distance, type)SpawnSet(spawn, variable, value, no_update, temporary_flag, index)SpawnSetByDistance(spawn, max_distance, variable, value)SpellDamage(target, type, min_damage, max_damage, crit_mod, no_calcs, class_id)SpellDamageExt(target, type, min_damage, max_damage, crit_mod, no_calcs, override_packet_type, take_power, class_id)SpellHeal(heal_type, min_heal, max_heal, target, crit_mod, no_calcs, custom_spell_name)SpellHealPct(heal_type, percentage, current_value, caster_value, target, crit_mod, no_calcs, custom_spell_name)StartAutoMount(player, path)StartConversation(conversation, source, player, text, mp3, key1, key2, language, can_close)StartDialogConversation(conversation, type, spawn, player, text, mp3, key1, key2, language, can_close)StartHeroicOpportunity(caster, class_id)StartTransmute(spawn)Stealth(type, spawn)StopMovement(spawn)StopTimer(spawn, function)SummonCosmeticPet(spawn, pet_id)SummonDeityPet(spawn, pet_id)SummonDumbFirePet(spawn, target, pet_id, x, y, z)SummonItem(spawn, item_id, location, item_count)SummonPet(spawn, pet_id, max_level)ToggleCharacterFlag(player, flag_id)ToggleFollow(spawn)ToggleTracking(spawn)UpdateQuestDescription(quest, description)UpdateQuestStepDescription(quest, step, description)UpdateQuestTaskGroupDescription(quest, step, description)UpdateQuestZone(quest, zone)UseWidget(widget)Zone(zone, player, x, y, z, heading)