Lua API Reference: Zone (138 methods)

Browse the complete Lua API documentation for the Zone class. Search through 138 methods and 247 events to find the exact function signatures, parameters, and usage examples you need for your EQ-Emulator scripts.

Methods

zone:BuffTimersSuspended() # bool
zone:BypassesExpansionCheck() # bool
zone:CanBind() # bool
zone:CanCastOutdoor() # bool
zone:CanDoCombat() # bool
zone:CanLevitate() # bool
zone:ClearSpawnTimers() # void
zone:ClearVariables() # bool
zone:DeleteBucket(std) # void
zone:DeleteVariable(std) # bool
zone:Depop() # void
zone:Depop(start_spawn_timers) # void
zone:Despawn(spawngroup_id) # void
zone:DisableRespawnTimers() # void
zone:GetAAEXPModifier(c) # float
zone:GetAAEXPModifierByCharacterID(character_id) # float
zone:GetBucket(std) # std::string
zone:GetBucketExpires(std) # std::string
zone:GetBucketRemaining(std) # std::string
zone:GetContentFlags() # std::string
zone:GetContentFlagsDisabled() # std::string
zone:GetEXPModifier(c) # float
zone:GetEXPModifierByCharacterID(character_id) # float
zone:GetExpansion() # int8
zone:GetExperienceMultiplier() # float
zone:GetFastRegenEndurance() # int
zone:GetFastRegenHP() # int
zone:GetFastRegenMana() # int
zone:GetFileName() # std::string
zone:GetFlagNeeded() # std::string
zone:GetFogBlue() # uint8
zone:GetFogBlue(slot) # uint8
zone:GetFogDensity() # float
zone:GetFogGreen(slot) # uint8
zone:GetFogGreen() # uint8
zone:GetFogMaximumClip(slot) # float
zone:GetFogMaximumClip() # float
zone:GetFogMinimumClip(slot) # float
zone:GetFogMinimumClip() # float
zone:GetFogRed(slot) # uint8
zone:GetFogRed() # uint8
zone:GetGraveyardHeading() # float
zone:GetGraveyardID() # uint32
zone:GetGraveyardX() # float
zone:GetGraveyardY() # float
zone:GetGraveyardZ() # float
zone:GetGraveyardZoneID() # uint32
zone:GetGravity() # float
zone:GetInstanceID() # uint32
zone:GetInstanceTimeRemaining() # uint32
zone:GetInstanceType() # uint8
zone:GetInstanceVersion() # uint16
zone:GetLavaDamage() # int
zone:GetLongName() # std::string
zone:GetMaxClients() # uint32
zone:GetMaximumClip() # float
zone:GetMaximumExpansion() # int8
zone:GetMaximumLevel() # uint8
zone:GetMinimumClip() # float
zone:GetMinimumExpansion() # int8
zone:GetMinimumLavaDamage() # int
zone:GetMinimumLevel() # uint8
zone:GetMinimumStatus() # uint8
zone:GetNPCMaximumAggroDistance() # int
zone:GetNote() # std::string
zone:GetPEQZone() # int8
zone:GetPausedTimers() # object
zone:GetRainChance(slot) # int
zone:GetRainChance() # int
zone:GetRainDuration(slot) # int
zone:GetRainDuration() # int
zone:GetRuleSet() # uint32
zone:GetSafeHeading() # float
zone:GetSafeX() # float
zone:GetSafeY() # float
zone:GetSafeZ() # float
zone:GetSecondsBeforeIdle() # uint32
zone:GetShortName() # std::string
zone:GetShutdownDelay() # uint64
zone:GetSky() # uint8
zone:GetSkyLock() # int8
zone:GetSnowChance() # int
zone:GetSnowChance(slot) # int
zone:GetSnowDuration(slot) # int
zone:GetSnowDuration() # int
zone:GetTimeType() # uint8
zone:GetTimeZone() # int
zone:GetTimerDuration(name) # uint32
zone:GetTimerRemainingTime(name) # uint32
zone:GetTimers() # object
zone:GetUnderworld() # float
zone:GetUnderworldTeleportIndex() # int
zone:GetVariable(std) # std::string
zone:GetWalkSpeed() # float
zone:GetZoneDescription() # std::string
zone:GetZoneID() # uint32
zone:GetZoneTotalBlockedSpells() # int
zone:GetZoneType() # uint8
zone:GetZoneZType() # uint8
zone:HasGraveyard() # bool
zone:HasMap() # bool
zone:HasTimer(name) # bool
zone:HasWaterMap() # bool
zone:HasWeather() # bool
zone:IsCity() # bool
zone:IsHotzone() # bool
zone:IsIdleWhenEmpty() # bool
zone:IsInstancePersistent() # bool
zone:IsPVPZone() # bool
zone:IsPausedTimer(name) # bool
zone:IsRaining() # bool
zone:IsSnowing() # bool
zone:IsSpecialBindLocation(x, y, z, heading) # bool
zone:IsSpellBlocked(spell_id, x, y, z) # bool
zone:IsStaticZone() # bool
zone:IsUCSServerAvailable() # bool
zone:IsWaterZone(z) # bool
zone:PauseTimer(name) # void
zone:Repop(is_forced) # void
zone:Repop() # void
zone:ResumeTimer(name) # void
zone:SendPayload(payload_id, payload_value) # void
zone:SetAAEXPModifier(c, aa_modifier) # void
zone:SetAAEXPModifierByCharacterID(character_id, aa_modifier) # void
zone:SetBucket(std) # void
zone:SetBucket(std) # void
zone:SetEXPModifier(c, exp_modifier) # void
zone:SetEXPModifierByCharacterID(character_id, exp_modifier) # void
zone:SetInstanceTimeRemaining(time_remaining) # void
zone:SetInstanceTimer(new_duration) # void
zone:SetIsHotzone(is_hotzone) # void
zone:SetTimer(name, duration) # void
zone:SetVariable(std) # void
zone:ShowZoneGlobalLoot(c) # void
zone:Signal(signal_id) # void
zone:StopAllTimers() # void
zone:StopTimer(name) # void
zone:VariableExists(std) # bool