31 KiB
31 KiB
📜 EQ2Emu Lua API Documentation
This document will detail all Lua scripting functions available within EQ2Emu.
📚 Table of Contents
- AddCharacterTitle
- AddCoin
- AddControlEffect
- AddConversationOption
- AddHate
- AddIconValue
- AddImmunitySpell
- AddItem
- AddLanguage
- AddLootCoin
- AddLootItem
- AddMasterTitle
- AddMultiFloorLift
- AddOptionWindowOption
- AddPlayerMail
- AddPlayerMailByCharID
- AddPrimaryEntityCommand
- AddPrimaryEntityCommandAllSpawns
- AddProc
- AddProcExt
- AddQuestPrereqClass
- AddQuestPrereqFaction
- AddQuestPrereqItem
- AddQuestPrereqModelType
- AddQuestPrereqQuest
- AddQuestPrereqRace
- AddQuestPrereqTradeskillClass
- AddQuestPrereqTradeskillLevel
- AddQuestRewardCoin
- AddQuestRewardFaction
- AddQuestRewardItem
- AddQuestSelectableRewardItem
- AddQuestStep
- AddQuestStepChat
- AddQuestStepCompleteAction
- AddQuestStepCraft
- AddQuestStepFailureAction
- AddQuestStepHarvest
- AddQuestStepKill
- AddQuestStepKillByRace
- AddQuestStepLocation
- AddQuestStepObtainItem
- AddQuestStepProgressAction
- AddQuestStepSpell
- AddQuestStepZoneLoc
- AddQuestUsableItem
- AddRecipeBookToPlayer
- AddRespawn
- AddSkill
- AddSkillBonus
- AddSpawnAccess
- AddSpawnIDAccess
- AddSpawnProximity
- AddSpawnSpellBonus
- AddSpawnToGroup
- AddSpellBonus
- AddSpellBookEntry
- AddSpellTimer
- AddStepProgress
- AddThreatTransfer
- AddTimer
- AddToWard
- AddTransportSpawn
- AddWard
- AddWaypoint
- ApplySpellVisual
- Attack
- Bind
- BlurVision
- BreatheUnderwater
- CancelSpell
- CanHarvest
- CanReceiveQuest
- CanSeeInvis
- CastCustomSpell
- CastEntityCommand
- CastSpell
- ChangeFaction
- ChangeHandIcon
- Charm
- CheckLOS
- CheckLOSByCoordinates
- CheckRaceType
- ClearChoice
- ClearEncounter
- ClearHate
- ClearRunback
- ClearRunningLocations
- CloseConversation
- CloseDoor
- CloseItemConversation
- CompareSpawns
- CompleteTransmute
- CopySpawnAppearance
- CreateChoiceWindow
- CreateConversation
- CreateOptionWindow
- CreatePersistedRespawn
- CreateWidgetRegion
- CureByControlEffect
- CureByType
- DamageEquippedItems
- DamageSpawn
- DeleteDBShardID
- DeleteSpellBook
- Despawn
- DespawnByLocationID
- DismissPet
- DisplayText
- Emote
- EnableGameEvent
- EndAutoMount
- Evac
- FaceTarget
- FlashWindow
- Gate
- GetAAInfo
- GetAggroRadius
- GetAgi
- GetAgiBase
- GetAlignment
- GetArchetypeName
- GetArrowColor
- GetBaseAggroRadius
- GetBoundZoneID
- GetCanBind
- GetCanEvac
- GetCanGate
- GetCasterSpellLevel
- GetCharacterFlag
- GetCharacterID
- GetCharmedPet
- GetChoiceSpawnID
- GetClass
- GetClassName
- GetClientVersion
- GetCoinMessage
- GetCosmeticPet
- GetCurrentHP
- GetCurrentPower
- GetCurrentZoneSafeLocation
- GetDeity
- GetDeityPet
- GetDifficulty
- GetDistance
- GetEncounter
- GetEncounterSize
- GetFactionAmount
- GetFactionID
- GetFollowTarget
- GetGender
- GetGroup
- GetHateList
- GetHeading
- GetID
- GetInfoStructFloat
- GetInfoStructSInt
- GetInfoStructString
- GetInfoStructUInt
- GetInt
- GetIntBase
- GetItemCount
- GetItemEffectType
- GetItemID
- GetItemSkillReq
- GetItemType
- GetLevel
- GetLootCoin
- GetLootDropType
- GetLootTier
- GetMaxHP
- GetMaxHPBase
- GetMaxPower
- GetMaxPowerBase
- GetModelType
- GetMostHated
- GetMount
- GetName
- GetOrigX
- GetOrigY
- GetOrigZ
- GetOwner
- GetPassengerSpawnList
- GetPCTOfHP
- GetPCTOfPower
- GetPet
- GetPlayerHistory
- GetPlayersInZone
- GetQuest
- GetQuestCompleteCount
- GetQuestFlags
- GetQuestStep
- GetQuestStepProgress
- GetRace
- GetRaceBaseType
- GetRaceName
- GetRaceType
- GetRandomSpawnByID
- GetRuleFlagBool
- GetRuleFlagFloat
- GetRuleFlagInt32
- GetRunbackDistance
- GetServerVariable
- GetShardCharID
- GetShardCreatedTimestamp
- GetShardID
- GetSkill
- GetSkillIDByName
- GetSkillMaxValue
- GetSkillName
- GetSkillValue
- GetSpawn
- GetSpawnByGroupID
- GetSpawnByLocationID
- GetSpawnByRailID
- GetSpawnFromList
- GetSpawnGroupID
- GetSpawnID
- GetSpawnListByRailID
- GetSpawnListBySpawnID
- GetSpawnListSize
- GetSpawnLocationID
- GetSpawnLocationPlacementID
- GetSpeed
- GetSpell
- GetSpellCaster
- GetSpellData
- GetSpellDataIndex
- GetSpellDisplayEffect
- GetSpellID
- GetSpellInitialTarget
- GetSpellName
- GetSpellRequiredLevel
- GetSpellTargets
- GetSpellTier
- GetSpellTriggerCount
- GetSta
- GetStaBase
- GetStr
- GetStrBase
- GetTarget
- GetTaskGroupStep
- GetTemporaryTransportID
- GetTempVariable
- GetTradeskillClass
- GetTradeskillClassName
- GetTradeskillLevel
- GetTSArrowColor
- GetTutorialStep
- GetVariableValue
- GetWardAmountLeft
- GetWardValue
- GetWis
- GetWisBase
- GetWorldTimeHour
- GetWorldTimeMinute
- GetWorldTimeMonth
- GetWorldTimeYear
- GetX
- GetY
- GetZ
- GetZone
- GetZoneExpansionFlag
- GetZoneHolidayFlag
- GetZoneID
- GetZoneLockoutTimer
- GetZoneName
- GetZonePlayerAvgLevel
- GetZonePlayerFirstLevel
- GetZonePlayerMaxLevel
- GetZonePlayerMinLevel
- GiveExp
- GiveLoot
- GiveQuestItem
- GiveQuestReward
- HandInCollections
- Harvest
- HasCoin
- HasCollectionsToHandIn
- HasCompletedQuest
- HasControlEffect
- HasFreeSlot
- HasGroup
- HasItem
- HasItemEquipped
- HasLanguage
- HasLootItem
- HasMoved
- HasPendingLoot
- HasPendingLootItem
- HasPendingQuest
- HasQuest
- HasQuestRewardItem
- HasRecipeBook
- HasRecovered
- HasSkill
- HasSpell
- HasSpellEffect
- HasSpellImmunity
- IncreaseSkillCapsByType
- InFront
- InLava
- InstructionWindow
- InstructionWindowClose
- InstructionWindowGoal
- Interrupt
- InWater
- IsAlive
- IsBehind
- IsBindAllowed
- IsCasting
- IsCastOnAggroComplete
- IsEntity
- IsEpic
- IsFlanking
- IsFollowing
- IsGateAllowed
- IsGroundSpawn
- IsHeroic
- IsInCombat
- IsInvis
- IsInvulnerable
- IsMezzed
- IsMezzedOrStunned
- IsNight
- IsOnAutoMount
- IsOpen
- IsPet
- IsPlayer
- IsRunning
- IsSpawnGroupAlive
- IsStealthed
- IsStunned
- IsTransportSpawn
- IsZoneLoading
- KillSpawn
- KillSpawnByDistance
- Knockback
- LastSpellAttackHit
- MakeRandomFloat
- MakeRandomInt
- ModifyHP
- ModifyMaxHP
- ModifyMaxPower
- ModifyPower
- MovementLoopAdd
- MoveToLocation
- OfferQuest
- OpenDoor
- PauseMovement
- PlayAnimation
- PlayAnimationString
- PlayFlavor
- PlayFlavorID
- PlaySound
- PlayVoice
- ProcDamage
- ProcessMelee
- ProcessSpell
- ProcHate
- ProvidesQuest
- QuestIsComplete
- QuestReturnNPC
- QuestStepIsComplete
- RegisterQuest
- RemoveCoin
- RemoveControlEffect
- RemoveIconValue
- RemoveImmunitySpell
- RemoveInvis
- RemoveItem
- RemoveLootItem
- RemovePrimaryEntityCommand
- RemoveProc
- RemoveQuestStep
- RemoveRecipeFromPlayer
- RemoveRegion
- RemoveSkill
- RemoveSkillBonus
- RemoveSpawnAccess
- RemoveSpawnIDAccess
- RemoveSpawnSpellBonus
- RemoveSpellBonus
- RemoveSpellBookEntry
- RemoveStealth
- RemoveThreatTransfer
- RemoveTriggerFromSpell
- RemoveWard
- RemoveWaypoint
- RemoveWidgetFromSpawnMap
- RemoveWidgetFromZoneMap
- ReplaceWidgetFromClient
- ResetCharacterTitlePrefix
- ResetCharacterTitleSuffix
- ResetIllusion
- ResetQuestStep
- Resurrect
- Runback
- Say
- SayOOC
- SendHearCast
- SendMessage
- SendNewAdventureSpells
- SendNewTradeskillSpells
- SendOptionWindow
- SendPopUpMessage
- SendStateCommand
- SendTimeUpdate
- SendTransporters
- SendUpdateDefaultCommand
- SendWaypoints
- SetAAInfo
- SetAccessToEntityCommand
- SetAccessToEntityCommandByCharID
- SetAdventureClass
- SetAggroRadius
- SetAgi
- SetAgiBase
- SetAlignment
- SetAttackable
- SetBrainTick
- SetCanBind
- SetCanEvac
- SetCanGate
- SetCastOnAggroComplete
- SetCharacterTitlePrefix
- SetCharacterTitleSuffix
- SetCharSheetChanged
- SetCoinTmpReward
- SetCompletedDescription
- SetCompleteFlag
- SetCurrentHP
- SetCurrentPower
- SetDeity
- SetFactionID
- SetFailureTimer
- SetFollowTarget
- SetGridID
- SetHeading
- SetIllusion
- SetInCombat
- SetInfoFlag
- SetInfoStructFloat
- SetInfoStructSInt
- SetInfoStructString
- SetInfoStructUInt
- SetInt
- SetIntBase
- SetInvulnerable
- SetItemCount
- SetLocationProximityFunction
- SetLootCoin
- SetLootDropType
- SetLootTier
- SetLuaBrain
- SetMaxHP
- SetMaxHPBase
- SetMaxPower
- SetMaxPowerBase
- SetModelType
- SetMount
- SetMountColor
- SetPlayerHistory
- SetPlayerLevel
- SetPlayerPOVGhost
- SetPlayerProximityFunction
- SetPosition
- SetQuestCompleteAction
- SetQuestFeatherColor
- SetQuestFlags
- SetQuestPrereqLevel
- SetQuestRepeatable
- SetQuestRewardComment
- SetQuestRewardExp
- SetQuestRewardStatus
- SetQuestTimer
- SetQuestTimerComplete
- SetQuestYellow
- SetRailID
- SetRequiredHistory
- SetRequiredQuest
- SetSeeHide
- SetSeeInvis
- SetServerControlFlag
- SetServerVariable
- SetSkillMaxValue
- SetSkillValue
- SetSpawnAnimation
- SetSpawnGroupID
- SetSpeed
- SetSpeedMultiplier
- SetSpellData
- SetSpellDataIndex
- SetSpellDisplayEffect
- SetSpellList
- SetSpellSnareValue
- SetSpellTriggerCount
- SetSta
- SetStaBase
- SetStatusTmpReward
- SetStepComplete
- SetStepFailed
- SetStr
- SetStrBase
- SetSuccessTimer
- SetTarget
- SetTemporaryTransportID
- SetTempVariable
- SetTradeskillClass
- SetTradeskillLevel
- SetTutorialStep
- SetVision
- SetVisualFlag
- SetWis
- SetWisBase
- SetWorldTime
- SetZoneExpansionFlag
- SetZoneHolidayFlag
- Shout
- ShowLootWindow
- ShowWindow
- Spawn
- SpawnByLocationID
- SpawnGroupByID
- SpawnMove
- SpawnSet
- SpawnSetByDistance
- SpellDamage
- SpellDamageExt
- SpellHeal
- SpellHealPct
- StartAutoMount
- StartConversation
- StartDialogConversation
- StartHeroicOpportunity
- StartTransmute
- Stealth
- StopMovement
- StopTimer
- SummonCosmeticPet
- SummonDeityPet
- SummonDumbFirePet
- SummonItem
- SummonPet
- ToggleCharacterFlag
- ToggleFollow
- ToggleTracking
- UpdateQuestDescription
- UpdateQuestStepDescription
- UpdateQuestTaskGroupDescription
- UpdateQuestZone
- UseWidget
- Zone
✨ Introduction
EQ2Emu allows scripting of quests, spawns, spells, regions, and zones using Lua. This guide will document all exposed Lua functions, expected parameters, and example usages.
📌 Notes
- Lua scripting engine is integrated natively into the EQ2World server.
- More detailed breakdowns will be added as the API documentation is expanded.