1 files changed, 202 insertions, 0 deletions

diff --git a/src/PluginLua.h b/src/PluginLua.h
new file mode 100644
index 000000000..908466966
--- /dev/null
+++ b/src/PluginLua.h
@@ -0,0 +1,202 @@
+
+// PluginLua.h
+
+// Declares the cPluginLua class representing a plugin written in Lua
+
+
+
+
+
+#pragma once
+
+#include "Plugin.h"
+#include "WebPlugin.h"
+#include "LuaState.h"
+
+// Names for the global variables through which the plugin is identified in its LuaState
+#define LUA_PLUGIN_NAME_VAR_NAME     "_MCServerInternal_PluginName"
+#define LUA_PLUGIN_INSTANCE_VAR_NAME "_MCServerInternal_PluginInstance"
+
+
+
+
+// fwd: UI/Window.h
+class cWindow;
+
+
+
+
+
+// tolua_begin
+class cPluginLua :
+	public cPlugin,
+	public cWebPlugin
+{
+public:
+	// tolua_end
+	
+	cPluginLua( const AString & a_PluginDirectory );
+	~cPluginLua();
+
+	virtual void OnDisable(void) override;
+	virtual bool Initialize(void) override;
+
+	virtual void Tick(float a_Dt) override;
+
+	virtual bool OnBlockToPickups           (cWorld * a_World, cEntity * a_Digger, int a_BlockX, int a_BlockY, int a_BlockZ, BLOCKTYPE a_BlockType, NIBBLETYPE a_BlockMeta, cItems & a_Pickups) override;
+	virtual bool OnChat                     (cPlayer * a_Player, AString & a_Message) override;
+	virtual bool OnChunkAvailable           (cWorld * a_World, int a_ChunkX, int a_ChunkZ) override;
+	virtual bool OnChunkGenerated           (cWorld * a_World, int a_ChunkX, int a_ChunkZ, cChunkDesc * a_ChunkDesc) override;
+	virtual bool OnChunkGenerating          (cWorld * a_World, int a_ChunkX, int a_ChunkZ, cChunkDesc * a_ChunkDesc) override;
+	virtual bool OnChunkUnloaded            (cWorld * a_World, int a_ChunkX, int a_ChunkZ) override;
+	virtual bool OnChunkUnloading           (cWorld * a_World, int a_ChunkX, int a_ChunkZ) override;
+	virtual bool OnCollectingPickup         (cPlayer * a_Player, cPickup * a_Pickup) override;
+	virtual bool OnCraftingNoRecipe         (const cPlayer * a_Player, const cCraftingGrid * a_Grid, cCraftingRecipe * a_Recipe) override;
+	virtual bool OnDisconnect               (cPlayer * a_Player, const AString & a_Reason) override;
+	virtual bool OnExecuteCommand           (cPlayer * a_Player, const AStringVector & a_Split) override;
+	virtual bool OnExploded                 (cWorld & a_World, double a_ExplosionSize,   bool a_CanCauseFire,   double a_X, double a_Y, double a_Z, eExplosionSource a_Source, void * a_SourceData) override;
+	virtual bool OnExploding                (cWorld & a_World, double & a_ExplosionSize, bool & a_CanCauseFire, double a_X, double a_Y, double a_Z, eExplosionSource a_Source, void * a_SourceData) override;
+	virtual bool OnHandshake                (cClientHandle * a_Client, const AString & a_Username) override;
+	virtual bool OnHopperPullingItem        (cWorld & a_World, cHopperEntity & a_Hopper, int a_DstSlotNum, cBlockEntityWithItems & a_SrcEntity, int a_SrcSlotNum) override;
+	virtual bool OnHopperPushingItem        (cWorld & a_World, cHopperEntity & a_Hopper, int a_SrcSlotNum, cBlockEntityWithItems & a_DstEntity, int a_DstSlotNum) override;
+	virtual bool OnKilling                  (cEntity & a_Victim, cEntity * a_Killer) override;
+	virtual bool OnLogin                    (cClientHandle * a_Client, int a_ProtocolVersion, const AString & a_Username) override;
+	virtual bool OnPlayerAnimation          (cPlayer & a_Player, int a_Animation) override;
+	virtual bool OnPlayerBreakingBlock      (cPlayer & a_Player, int a_BlockX, int a_BlockY, int a_BlockZ, char a_BlockFace, BLOCKTYPE a_BlockType, NIBBLETYPE a_BlockMeta) override;
+	virtual bool OnPlayerBrokenBlock        (cPlayer & a_Player, int a_BlockX, int a_BlockY, int a_BlockZ, char a_BlockFace, BLOCKTYPE a_BlockType, NIBBLETYPE a_BlockMeta) override;
+	virtual bool OnPlayerEating             (cPlayer & a_Player) override;
+	virtual bool OnPlayerJoined             (cPlayer & a_Player) override;
+	virtual bool OnPlayerMoved              (cPlayer & a_Player) override;
+	virtual bool OnPlayerLeftClick          (cPlayer & a_Player, int a_BlockX, int a_BlockY, int a_BlockZ, char a_BlockFace, char a_Status) override;
+	virtual bool OnPlayerPlacedBlock        (cPlayer & a_Player, int a_BlockX, int a_BlockY, int a_BlockZ, char a_BlockFace, int a_CursorX, int a_CursorY, int a_CursorZ, BLOCKTYPE a_BlockType, NIBBLETYPE a_BlockMeta) override;
+	virtual bool OnPlayerPlacingBlock       (cPlayer & a_Player, int a_BlockX, int a_BlockY, int a_BlockZ, char a_BlockFace, int a_CursorX, int a_CursorY, int a_CursorZ, BLOCKTYPE a_BlockType, NIBBLETYPE a_BlockMeta) override;
+	virtual bool OnPlayerRightClick         (cPlayer & a_Player, int a_BlockX, int a_BlockY, int a_BlockZ, char a_BlockFace, int a_CursorX, int a_CursorY, int a_CursorZ) override;
+	virtual bool OnPlayerRightClickingEntity(cPlayer & a_Player, cEntity & a_Entity) override;
+	virtual bool OnPlayerShooting           (cPlayer & a_Player) override;
+	virtual bool OnPlayerSpawned            (cPlayer & a_Player) override;
+	virtual bool OnPlayerTossingItem        (cPlayer & a_Player) override;
+	virtual bool OnPlayerUsedBlock          (cPlayer & a_Player, int a_BlockX, int a_BlockY, int a_BlockZ, char a_BlockFace, int a_CursorX, int a_CursorY, int a_CursorZ, BLOCKTYPE a_BlockType, NIBBLETYPE a_BlockMeta) override;
+	virtual bool OnPlayerUsedItem           (cPlayer & a_Player, int a_BlockX, int a_BlockY, int a_BlockZ, char a_BlockFace, int a_CursorX, int a_CursorY, int a_CursorZ) override;
+	virtual bool OnPlayerUsingBlock         (cPlayer & a_Player, int a_BlockX, int a_BlockY, int a_BlockZ, char a_BlockFace, int a_CursorX, int a_CursorY, int a_CursorZ, BLOCKTYPE a_BlockType, NIBBLETYPE a_BlockMeta) override;
+	virtual bool OnPlayerUsingItem          (cPlayer & a_Player, int a_BlockX, int a_BlockY, int a_BlockZ, char a_BlockFace, int a_CursorX, int a_CursorY, int a_CursorZ) override;
+	virtual bool OnPostCrafting             (const cPlayer * a_Player, const cCraftingGrid * a_Grid, cCraftingRecipe * a_Recipe) override;
+	virtual bool OnPreCrafting              (const cPlayer * a_Player, const cCraftingGrid * a_Grid, cCraftingRecipe * a_Recipe) override;
+	virtual bool OnSpawnedEntity            (cWorld & a_World, cEntity & a_Entity) override;
+	virtual bool OnSpawnedMonster           (cWorld & a_World, cMonster & a_Monster) override;
+	virtual bool OnSpawningEntity           (cWorld & a_World, cEntity & a_Entity) override;
+	virtual bool OnSpawningMonster          (cWorld & a_World, cMonster & a_Monster) override;
+	virtual bool OnTakeDamage               (cEntity & a_Receiver, TakeDamageInfo & a_TakeDamageInfo) override;
+	virtual bool OnUpdatedSign              (cWorld * a_World, int a_BlockX, int a_BlockY, int a_BlockZ, const AString & a_Line1, const AString & a_Line2, const AString & a_Line3, const AString & a_Line4, cPlayer * a_Player) override;
+	virtual bool OnUpdatingSign             (cWorld * a_World, int a_BlockX, int a_BlockY, int a_BlockZ,       AString & a_Line1,       AString & a_Line2,       AString & a_Line3,       AString & a_Line4, cPlayer * a_Player) override;
+	virtual bool OnWeatherChanged           (cWorld & a_World) override;
+	virtual bool OnWeatherChanging          (cWorld & a_World, eWeather & a_NewWeather) override;
+	virtual bool OnWorldTick                (cWorld & a_World, float a_Dt) override;
+	
+	virtual bool HandleCommand(const AStringVector & a_Split, cPlayer * a_Player) override;
+	
+	virtual bool HandleConsoleCommand(const AStringVector & a_Split, cCommandOutputCallback & a_Output) override;
+
+	virtual void ClearCommands(void) override;
+	
+	virtual void ClearConsoleCommands(void) override;
+
+	/// Returns true if the plugin contains the function for the specified hook type, using the old-style registration (#121)
+	bool CanAddOldStyleHook(int a_HookType);
+	
+	// cWebPlugin override
+	virtual const AString GetWebTitle(void) const {return GetName(); }
+
+	// cWebPlugin and WebAdmin stuff
+	virtual AString HandleWebRequest(const HTTPRequest * a_Request ) override;
+	bool AddWebTab(const AString & a_Title, lua_State * a_LuaState, int a_FunctionReference);	// >> EXPORTED IN MANUALBINDINGS <<
+	
+	/// Binds the command to call the function specified by a Lua function reference. Simply adds to CommandMap.
+	void BindCommand(const AString & a_Command, int a_FnRef);
+
+	/// Binds the console command to call the function specified by a Lua function reference. Simply adds to CommandMap.
+	void BindConsoleCommand(const AString & a_Command, int a_FnRef);
+
+	cLuaState & GetLuaState(void) { return m_LuaState; }
+
+	cCriticalSection & GetCriticalSection(void) { return m_CriticalSection; }
+	
+	/// Removes a previously referenced object (luaL_unref())
+	void Unreference(int a_LuaRef);
+	
+	/// Calls the plugin-specified "cLuaWindow closing" callback. Returns true only if the callback returned true
+	bool CallbackWindowClosing(int a_FnRef, cWindow & a_Window, cPlayer & a_Player, bool a_CanRefuse);
+	
+	/// Calls the plugin-specified "cLuaWindow slot changed" callback.
+	void CallbackWindowSlotChanged(int a_FnRef, cWindow & a_Window, int a_SlotNum);
+	
+	/// Returns the name of Lua function that should handle the specified hook type in the older (#121) API
+	static const char * GetHookFnName(int a_HookType);
+	
+	/** Adds a Lua function to be called for the specified hook.
+	The function has to be on the Lua stack at the specified index a_FnRefIdx
+	Returns true if the hook was added successfully.
+	*/
+	bool AddHookRef(int a_HookType, int a_FnRefIdx);
+	
+	// The following templates allow calls to arbitrary Lua functions residing in the plugin:
+	
+	/// Call a Lua function with 0 args
+	template <typename FnT> bool Call(FnT a_Fn)
+	{
+		cCSLock Lock(m_CriticalSection);
+		return m_LuaState.Call(a_Fn);
+	}
+
+	/// Call a Lua function with 1 arg
+	template <typename FnT, typename ArgT0> bool Call(FnT a_Fn, ArgT0 a_Arg0)
+	{
+		cCSLock Lock(m_CriticalSection);
+		return m_LuaState.Call(a_Fn, a_Arg0);
+	}
+
+	/// Call a Lua function with 2 args
+	template <typename FnT, typename ArgT0, typename ArgT1> bool Call(FnT a_Fn, ArgT0 a_Arg0, ArgT1 a_Arg1)
+	{
+		cCSLock Lock(m_CriticalSection);
+		return m_LuaState.Call(a_Fn, a_Arg0, a_Arg1);
+	}
+
+	/// Call a Lua function with 3 args
+	template <typename FnT, typename ArgT0, typename ArgT1, typename ArgT2> bool Call(FnT a_Fn, ArgT0 a_Arg0, ArgT1 a_Arg1, ArgT2 a_Arg2)
+	{
+		cCSLock Lock(m_CriticalSection);
+		return m_LuaState.Call(a_Fn, a_Arg0, a_Arg1, a_Arg2);
+	}
+
+	/// Call a Lua function with 4 args
+	template <typename FnT, typename ArgT0, typename ArgT1, typename ArgT2, typename ArgT3> bool Call(FnT a_Fn, ArgT0 a_Arg0, ArgT1 a_Arg1, ArgT2 a_Arg2, ArgT3 a_Arg3)
+	{
+		cCSLock Lock(m_CriticalSection);
+		return m_LuaState.Call(a_Fn, a_Arg0, a_Arg1, a_Arg2, a_Arg3);
+	}
+
+protected:
+	/// Maps command name into Lua function reference
+	typedef std::map<AString, int> CommandMap;
+	
+	/// Provides an array of Lua function references
+	typedef std::vector<cLuaState::cRef *> cLuaRefs;
+	
+	/// Maps hook types into arrays of Lua function references to call for each hook type
+	typedef std::map<int, cLuaRefs> cHookMap;
+	
+	cCriticalSection m_CriticalSection;
+	cLuaState m_LuaState;
+	
+	CommandMap m_Commands;
+	CommandMap m_ConsoleCommands;
+	
+	cHookMap m_HookMap;
+	
+	/// Releases all Lua references and closes the LuaState
+	void Close(void);
+} ;  // tolua_export
+
+
+
+