eqemu-server/zone/lua_zone.h

/*	EQEmu: EQEmulator

	Copyright (C) 2001-2026 EQEmu Development Team

	This program is free software; you can redistribute it and/or modify
	it under the terms of the GNU General Public License as published by
	the Free Software Foundation; either version 3 of the License, or
	(at your option) any later version.

	This program is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	GNU General Public License for more details.

	You should have received a copy of the GNU General Public License
	along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#pragma once

#ifdef LUA_EQEMU

#include "zone/common.h"
#include "zone/lua_client.h"
#include "zone/lua_ptr.h"
#include "zone/zone.h"

class Lua_Zone;

namespace luabind {
	struct scope;
}

luabind::scope lua_register_zone();

class Lua_Zone : public Lua_Ptr<Zone>
{
	typedef Zone NativeType;
public:
	Lua_Zone() : Lua_Ptr(nullptr) { }
	Lua_Zone(Zone* d) : Lua_Ptr(d) { }
	virtual ~Lua_Zone() { }

	operator Zone*() {
		return reinterpret_cast<Zone*>(GetLuaPtrData());
	}

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

	// data buckets
	void SetBucket(const std::string& bucket_name, const std::string& bucket_value);
	void SetBucket(const std::string& bucket_name, const std::string& bucket_value, const std::string& expiration = "");
	void DeleteBucket(const std::string& bucket_name);
	std::string GetBucket(const std::string& bucket_name);
	std::string GetBucketExpires(const std::string& bucket_name);
	std::string GetBucketRemaining(const std::string& bucket_name);

};

#endif // LUA_EQEMU