LuaInterface.h 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352
  1. /*
  2. EQ2Emulator: Everquest II Server Emulator
  3. Copyright (C) 2007 EQ2EMulator Development Team (http://www.eq2emulator.net)
  4. This file is part of EQ2Emulator.
  5. EQ2Emulator is free software: you can redistribute it and/or modify
  6. it under the terms of the GNU General Public License as published by
  7. the Free Software Foundation, either version 3 of the License, or
  8. (at your option) any later version.
  9. EQ2Emulator is distributed in the hope that it will be useful,
  10. but WITHOUT ANY WARRANTY; without even the implied warranty of
  11. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  12. GNU General Public License for more details.
  13. You should have received a copy of the GNU General Public License
  14. along with EQ2Emulator. If not, see <http://www.gnu.org/licenses/>.
  15. */
  16. #ifndef LUA_INTERFACE_H
  17. #define LUA_INTERFACE_H
  18. #include "Spawn.h"
  19. #include "Spells.h"
  20. #include "../common/Mutex.h"
  21. #include "Quests.h"
  22. #include "zoneserver.h"
  23. #include "client.h"
  24. #include "../LUA/lua.hpp"
  25. using namespace std;
  26. struct ConversationOption{
  27. string option;
  28. string function;
  29. };
  30. struct OptionWindowOption {
  31. string optionName;
  32. string optionDescription;
  33. string optionCommand;
  34. int32 optionIconSheet;
  35. int16 optionIconID;
  36. string optionConfirmTitle;
  37. };
  38. //Bitmask Values
  39. #define EFFECT_FLAG_STUN 1
  40. #define EFFECT_FLAG_ROOT 2
  41. #define EFFECT_FLAG_MEZ 4
  42. #define EFFECT_FLAG_STIFLE 8
  43. #define EFFECT_FLAG_DAZE 16
  44. #define EFFECT_FLAG_FEAR 32
  45. #define EFFECT_FLAG_SPELLBONUS 64
  46. #define EFFECT_FLAG_SKILLBONUS 128
  47. #define EFFECT_FLAG_STEALTH 256
  48. #define EFFECT_FLAG_INVIS 512
  49. #define EFFECT_FLAG_SNARE 1024
  50. #define EFFECT_FLAG_WATERWALK 2048
  51. #define EFFECT_FLAG_WATERJUMP 4096
  52. #define EFFECT_FLAG_FLIGHT 8192
  53. #define EFFECT_FLAG_GLIDE 16384
  54. #define EFFECT_FLAG_AOE_IMMUNE 32768
  55. #define EFFECT_FLAG_STUN_IMMUNE 65536
  56. #define EFFECT_FLAG_MEZ_IMMUNE 131072
  57. #define EFFECT_FLAG_DAZE_IMMUNE 262144
  58. #define EFFECT_FLAG_ROOT_IMMUNE 524288
  59. #define EFFECT_FLAG_STIFLE_IMMUNE 1048576
  60. #define EFFECT_FLAG_FEAR_IMMUNE 2097152
  61. #define EFFECT_FLAG_SAFEFALL 4194304
  62. struct LuaSpell{
  63. Entity* caster;
  64. int32 initial_caster_char_id;
  65. int32 initial_target;
  66. int32 initial_target_char_id;
  67. vector<int32> targets;
  68. multimap<int32, int8> char_id_targets;
  69. Spell* spell;
  70. lua_State* state;
  71. string file_name;
  72. Timer timer;
  73. bool is_recast_timer;
  74. int16 num_calls;
  75. int16 num_triggers;
  76. int8 slot_pos;
  77. int32 damage_remaining;
  78. bool resisted;
  79. bool interrupted;
  80. bool crit;
  81. bool last_spellattack_hit;
  82. bool cancel_after_all_triggers;
  83. bool had_triggers;
  84. bool had_dmg_remaining;
  85. Mutex MSpellTargets;
  86. int32 effect_bitmask;
  87. bool restored; // restored spell cross zone
  88. };
  89. class LUAUserData{
  90. public:
  91. LUAUserData();
  92. virtual ~LUAUserData(){};
  93. virtual bool IsCorrectlyInitialized();
  94. virtual bool IsConversationOption();
  95. virtual bool IsSpawnList();
  96. virtual bool IsOptionWindow();
  97. virtual bool IsSpawn();
  98. virtual bool IsQuest();
  99. virtual bool IsZone();
  100. virtual bool IsItem();
  101. virtual bool IsSkill();
  102. virtual bool IsSpell();
  103. bool correctly_initialized;
  104. Item* item;
  105. ZoneServer* zone;
  106. Spawn* spawn;
  107. vector<ConversationOption>* conversation_options;
  108. vector<OptionWindowOption>* option_window_option;
  109. vector<Spawn*>* spawn_list;
  110. Quest* quest;
  111. Skill* skill;
  112. LuaSpell* spell;
  113. };
  114. class LUAConversationOptionWrapper : public LUAUserData{
  115. public:
  116. LUAConversationOptionWrapper();
  117. bool IsConversationOption();
  118. };
  119. class LUASpawnListWrapper: public LUAUserData{
  120. public:
  121. LUASpawnListWrapper();
  122. ~LUASpawnListWrapper() { safe_delete(spawn_list); }
  123. bool IsSpawnList();
  124. };
  125. class LUAOptionWindowWrapper : public LUAUserData {
  126. public:
  127. LUAOptionWindowWrapper();
  128. bool IsOptionWindow();
  129. };
  130. class LUASpawnWrapper : public LUAUserData{
  131. public:
  132. LUASpawnWrapper();
  133. bool IsSpawn();
  134. };
  135. class LUAZoneWrapper : public LUAUserData{
  136. public:
  137. LUAZoneWrapper();
  138. bool IsZone();
  139. };
  140. class LUAQuestWrapper : public LUAUserData{
  141. public:
  142. LUAQuestWrapper();
  143. bool IsQuest();
  144. };
  145. class LUAItemWrapper : public LUAUserData{
  146. public:
  147. LUAItemWrapper();
  148. bool IsItem();
  149. };
  150. class LUASkillWrapper: public LUAUserData {
  151. public:
  152. LUASkillWrapper();
  153. bool IsSkill();
  154. };
  155. class LUASpellWrapper : public LUAUserData {
  156. public:
  157. LUASpellWrapper();
  158. bool IsSpell();
  159. };
  160. class LuaInterface {
  161. public:
  162. LuaInterface();
  163. ~LuaInterface();
  164. int GetNumberOfArgs(lua_State* state);
  165. bool LoadLuaSpell(const char* name);
  166. bool LoadLuaSpell(string name);
  167. bool LoadItemScript(string name);
  168. bool LoadItemScript(const char* name);
  169. bool LoadSpawnScript(string name);
  170. bool LoadSpawnScript(const char* name);
  171. bool LoadZoneScript(string name);
  172. bool LoadZoneScript(const char* name);
  173. bool LoadRegionScript(string name);
  174. bool LoadRegionScript(const char* name);
  175. void RemoveSpell(LuaSpell* spell, bool call_remove_function = true, bool can_delete = true, string reason = "", bool removing_all_spells = false);
  176. Spawn* GetSpawn(lua_State* state, int8 arg_num = 1);
  177. Item* GetItem(lua_State* state, int8 arg_num = 1);
  178. Quest* GetQuest(lua_State* state, int8 arg_num = 1);
  179. ZoneServer* GetZone(lua_State* state, int8 arg_num = 1);
  180. Skill* GetSkill(lua_State* state, int8 arg_num = 1);
  181. LuaSpell* GetSpell(lua_State* state, int8 arg_num = 1);
  182. vector<ConversationOption>* GetConversation(lua_State* state, int8 arg_num = 1);
  183. vector<Spawn*>* GetSpawnList(lua_State* state, int8 arg_num = 1);
  184. vector<OptionWindowOption>* GetOptionWindow(lua_State* state, int8 arg_num = 1);
  185. int8 GetInt8Value(lua_State* state, int8 arg_num = 1);
  186. int16 GetInt16Value(lua_State* state, int8 arg_num = 1);
  187. int32 GetInt32Value(lua_State* state, int8 arg_num = 1);
  188. sint32 GetSInt32Value(lua_State* state, int8 arg_num = 1);
  189. int64 GetInt64Value(lua_State* state, int8 arg_num = 1);
  190. sint64 GetSInt64Value(lua_State* state, int8 arg_num = 1);
  191. float GetFloatValue(lua_State* state, int8 arg_num = 1);
  192. string GetStringValue(lua_State* state, int8 arg_num = 1);
  193. bool GetBooleanValue(lua_State*state, int8 arg_num = 1);
  194. void Process();
  195. void SetInt32Value(lua_State* state, int32 value);
  196. void SetSInt32Value(lua_State* state, sint32 value);
  197. void SetInt64Value(lua_State* state, int64 value);
  198. void SetSInt64Value(lua_State* state, sint64 value);
  199. void SetFloatValue(lua_State* state, float value);
  200. void SetBooleanValue(lua_State* state, bool value);
  201. void SetStringValue(lua_State* state, const char* value);
  202. void SetSpawnValue(lua_State* state, Spawn* spawn);
  203. void SetSkillValue(lua_State* state, Skill* skill);
  204. void SetItemValue(lua_State* state, Item* item);
  205. void SetQuestValue(lua_State* state, Quest* quest);
  206. void SetZoneValue(lua_State* state, ZoneServer* zone);
  207. void SetSpawnListValue(lua_State* state, vector<Spawn*>* spawnList);
  208. void SetSpellValue(lua_State* state, LuaSpell* spell);
  209. void SetConversationValue(lua_State* state, vector<ConversationOption>* conversation);
  210. void SetOptionWindowValue(lua_State* state, vector<OptionWindowOption>* optionWindow);
  211. std::string AddSpawnPointers(LuaSpell* spell, bool first_cast, bool precast = false, const char* function = 0, SpellScriptTimer* timer = 0, bool passLuaSpell=false, Spawn* altTarget = 0);
  212. LuaSpell* GetCurrentSpell(lua_State* state);
  213. bool CallSpellProcess(LuaSpell* spell, int8 num_parameters, std::string functionCalled);
  214. LuaSpell* GetSpell(const char* name);
  215. void UseItemScript(const char* name, lua_State* state, bool val);
  216. void UseSpawnScript(const char* name, lua_State* state, bool val);
  217. void UseZoneScript(const char* name, lua_State* state, bool val);
  218. void UseRegionScript(const char* name, lua_State* state, bool val);
  219. lua_State* GetItemScript(const char* name, bool create_new = true, bool use = false);
  220. lua_State* GetSpawnScript(const char* name, bool create_new = true, bool use = false);
  221. lua_State* GetZoneScript(const char* name, bool create_new = true, bool use = false);
  222. lua_State* GetRegionScript(const char* name, bool create_new = true, bool use = false);
  223. Quest* LoadQuest(int32 id, const char* name, const char* type, const char* zone, int8 level, const char* description, char* script_name);
  224. const char* GetScriptName(lua_State* state);
  225. void RemoveSpawnScript(const char* name);
  226. bool RunItemScript(string script_name, const char* function_name, Item* item, Spawn* spawn = 0, sint64* returnValue = 0);
  227. bool RunItemScriptWithReturnString(string script_name, const char* function_name, Item* item, Spawn* spawn = 0, std::string* returnValue = 0);
  228. bool CallItemScript(lua_State* state, int8 num_parameters, std::string* returnValue = 0);
  229. bool CallItemScript(lua_State* state, int8 num_parameters, sint64* returnValue = 0);
  230. bool RunSpawnScript(string script_name, const char* function_name, Spawn* npc, Spawn* spawn = 0, const char* message = 0, bool is_door_open = false);
  231. bool CallSpawnScript(lua_State* state, int8 num_parameters);
  232. bool RunZoneScript(string script_name, const char* function_name, ZoneServer* zone, Spawn* spawn = 0, int32 int32_arg1 = 0, const char* str_arg1 = 0, Spawn* spawn_arg1 = 0, int32 int32_arg2 = 0, const char* str_arg2 = 0, Spawn* spawn_arg2 = 0);
  233. bool RunZoneScriptWithReturn(string script_name, const char* function_name, ZoneServer* zone, Spawn* spawn, int32 int32_arg1, int32 int32_arg2, int32 int32_arg3, int32* returnValue = 0);
  234. bool CallZoneScript(lua_State* state, int8 num_parameters, int32* returnValue = 0);
  235. bool RunRegionScript(string script_name, const char* function_name, ZoneServer* zone, Spawn* spawn = 0, sint32 int32_arg1 = 0, int32* returnValue = 0);
  236. bool CallRegionScript(lua_State* state, int8 num_parameters, int32* returnValue);
  237. void ResetFunctionStack(lua_State* state);
  238. void DestroySpells();
  239. void DestroySpawnScripts();
  240. void DestroyItemScripts();
  241. void ReloadSpells();
  242. void DestroyQuests(bool reload = false);
  243. void DestroyZoneScripts();
  244. void DestroyRegionScripts();
  245. void SimpleLogError(const char* error);
  246. void LogError(const char* error, ...);
  247. void CallQuestFunction(Quest* quest, const char* function, Spawn* player, int32 step_id = 0xFFFFFFFF);
  248. void RemoveDebugClients(Client* client);
  249. void UpdateDebugClients(Client* client);
  250. void ProcessErrorMessage(const char* message);
  251. map<Client*, int32> GetDebugClients(){ return debug_clients; }
  252. void AddUserDataPtr(LUAUserData* data);
  253. void DeleteUserDataPtrs(bool all);
  254. void DeletePendingSpells(bool all);
  255. void DeletePendingSpell(LuaSpell* spell);
  256. Mutex* GetSpawnScriptMutex(const char* name);
  257. Mutex* GetItemScriptMutex(const char* name);
  258. Mutex* GetZoneScriptMutex(const char* name);
  259. Mutex* GetRegionScriptMutex(const char* name);
  260. Mutex* GetQuestMutex(Quest* quest);
  261. void SetSpawnScriptsReloading(bool val) { spawn_scripts_reloading = val; }
  262. void AddPendingSpellDelete(LuaSpell* spell);
  263. void AddCustomSpell(LuaSpell* spell);
  264. void RemoveCustomSpell(int32 id);
  265. void FindCustomSpellLock() { MCustomSpell.readlock(); }
  266. void FindCustomSpellUnlock() { MCustomSpell.releasereadlock(); }
  267. LuaSpell* FindCustomSpell(int32 id);
  268. int32 GetFreeCustomSpellID();
  269. private:
  270. bool shutting_down;
  271. bool spawn_scripts_reloading;
  272. map<LuaSpell*, int32> spells_pending_delete;
  273. Timer* user_data_timer;
  274. Timer* spell_delete_timer;
  275. map<LUAUserData*, int32> user_data;
  276. map<Client*, int32> debug_clients;
  277. map<lua_State*, LuaSpell*> current_spells;
  278. vector<string>* GetDirectoryListing(const char* directory);
  279. lua_State* LoadLuaFile(const char* name);
  280. void RegisterFunctions(lua_State* state);
  281. map<string, LuaSpell*> spells;
  282. map<lua_State*, string> inverse_spells;
  283. map<int32, Quest*> quests;
  284. map<int32, lua_State*> quest_states;
  285. map<string, map<lua_State*, bool> > item_scripts;
  286. map<string, map<lua_State*, bool> > spawn_scripts;
  287. map<string, map<lua_State*, bool> > zone_scripts;
  288. map<string, map<lua_State*, bool> > region_scripts;
  289. map<int32, LuaSpell*> custom_spells;
  290. std::deque<int32> custom_free_spell_ids;
  291. map<lua_State*, string> item_inverse_scripts;
  292. map<lua_State*, string> spawn_inverse_scripts;
  293. map<lua_State*, string> zone_inverse_scripts;
  294. map<lua_State*, string> region_inverse_scripts;
  295. map<string, Mutex*> item_scripts_mutex;
  296. map<string, Mutex*> spawn_scripts_mutex;
  297. map<string, Mutex*> zone_scripts_mutex;
  298. map<int32, Mutex*> quests_mutex;
  299. map<string, Mutex*> region_scripts_mutex;
  300. Mutex MDebugClients;
  301. Mutex MSpells;
  302. Mutex MSpawnScripts;
  303. Mutex MItemScripts;
  304. Mutex MZoneScripts;
  305. Mutex MQuests;
  306. Mutex MLUAUserData;
  307. Mutex MLUAMain;
  308. Mutex MSpellDelete;
  309. Mutex MCustomSpell;
  310. Mutex MRegionScripts;
  311. };
  312. #endif