Updates

Add missing functions, support for lua modules toggling

Author: rasikhq

README.md

@@ -4,14 +4,17 @@ As the name suggests, this plugin provides a scripting API for VCMP in Lua (yay!
 about the structure of the plugin (its quite easy!)
 
 ## Purpose of this project
+
 The purpose of this project is mainly that I love Lua, and I also love C++, therefore to keep my practice in C++ I decided to work on this plugin with one of my
 favorite scripting languages (Lua).
 
 # The Lua config file
+
 In your server directory you should place a **luaconfig.ini** file which will allow you to specify some settings the plugin can use. Some of these settings are
 optional while some (like specifying atleast 1 script file) is compulsory.
 
 The file structure is as of right now very simple:
+
 ```ini
 [config]
 # Sets experimental mode ON (1) or OFF (0) | Intended for beta-testing and development only. Do not rely for stability
@@ -21,21 +24,32 @@ loglevel=0
 # Sets the log file. This log file will be used to create daily logs and it will log everything logged by Logger class, regardless of level
 logfile=DailyLogs.logs
 
+[modules]
+# This is the modules section, here you can opt in to use external modules that the plugin provides. They can be listed and toggled by setting them to a boolean
+
+#moduleName=[true/false]
+lanes=false
+
 [scripts]
 # This is the scripts section, here you can specify all your script files that you want to run.
 
+# script=path/to/file.lua
 script=lua/script.lua
 ```
 
 # Building the plugin
+
 ## Windows
+
 To build on Windows, just download the repository and run the win-build.bat file in the premake folder. You should be getting a Visual Studio 2019 solution file
 
 **NOTE: You can only build x64 of Lua plugin on Windows for now. Why? Cuz I'm too lazy to setup my environment to compile mariadb for x32 :D**
 
 ## Linux
+
 To build on Linux:
-* Download/Clone the repository
-* Download premake and build it
-* Inside the repository, call premake: `path/to/premake5 gmake`
-* Now use `make` with your desired `config`: `make config=release` OR `make config=release32`
+
+-   Download/Clone the repository
+-   Download premake and build it
+-   Inside the repository, call premake: `path/to/premake5 gmake`
+-   Now use `make` with your desired `config`: `make config=release` OR `make config=release32`

VCMP-LUA/Core.cpp

@@ -12,6 +12,7 @@ sol::state Lua;
 static std::vector<std::string> s_ScriptFiles;
 
 void reload_scripts();
+void LoadLuaModule(std::string);
 
 int my_exception_handler(lua_State* L, sol::optional<const std::exception&> maybe_exception, sol::string_view description) {
 	std::cout << "An exception occurred in a function ";
@@ -33,7 +34,7 @@ extern "C" EXPORT unsigned int VcmpPluginInit(PluginFuncs * pluginFuncs, PluginC
 	g_Calls = pluginCalls;
 	g_Info = pluginInfo;
 
-	pluginInfo->pluginVersion = 0x2300;
+	pluginInfo->pluginVersion = 0x2400;
 	pluginInfo->apiMajorVersion = PLUGIN_API_MAJOR;
 	pluginInfo->apiMinorVersion = PLUGIN_API_MINOR;
 
@@ -61,9 +62,10 @@ extern "C" EXPORT unsigned int VcmpPluginInit(PluginFuncs * pluginFuncs, PluginC
 
 	Lua.open_libraries();
 
-	Logger::Init(&Lua, spdlog::level::debug); // Set level to info to avoid debug messages or trace to get internal debug messages
+	Logger::Init(&Lua, spdlog::level::info); // Set level to info to avoid debug messages or trace to get internal debug messages
+
+	//luaopen_lanes_embedded(Lua.lua_state(), NULL);
 
-	luaopen_lanes_embedded(Lua.lua_state(), NULL);
 	//Lua.set_exception_handler(&my_exception_handler);
 
 	bool experimental_mode = false;
@@ -102,6 +104,17 @@ extern "C" EXPORT unsigned int VcmpPluginInit(PluginFuncs * pluginFuncs, PluginC
 	RegisterClasses(&Lua);
 	RegisterVCMPCallbacks();
 
+	// Load Modules
+	{
+		std::list<CSimpleIniA::Entry> modules;
+		if(conf.GetAllKeys("modules", modules) && modules.size() > 0) {
+			for(const auto& module : modules)
+				if(std::string(conf.GetValue("modules", module.pItem)) == "true")
+					LoadLuaModule(module.pItem);
+		}
+		else spdlog::info("No lua modules defined");
+	}
+
 	// Load Scripts
 	{
 		std::list<CSimpleIniA::Entry> scripts;
@@ -142,4 +155,25 @@ void reload_scripts()
 
 	// Re-trigger some crucial events which simulate a 'restart'
 	EventManager::Trigger("onServerInit");
+}
+
+enum LuaModules {
+	Invalid = 0,
+	Lanes
+};
+
+static std::unordered_map<std::string, LuaModules> s_LuaModules = {
+	{"lanes", LuaModules::Lanes}
+};
+
+void LoadLuaModule(std::string name) {
+	LuaModules module = s_LuaModules.find(name) != s_LuaModules.end() ? s_LuaModules[name] : LuaModules::Invalid;
+	
+	spdlog::info("Loading Lua module: {}", name);
+
+	switch(module) {
+		case Lanes:
+		luaopen_lanes_embedded(Lua.lua_state(), NULL);
+		break;
+	}
 }

VCMP-LUA/vcmpWrap/Classes/Player.cpp

@@ -69,6 +69,14 @@ void Player::announce(const std::string& msg, sol::variadic_args args)
 	g_Funcs->SendGameMessage(m_ID, type, msg.c_str());
 }
 
+int32_t Player::getAlpha() const {
+	return g_Funcs->GetPlayerAlpha(m_ID);
+}
+
+void Player::setAlpha(int32_t alpha, uint32_t fadeTime) {
+	g_Funcs->SetPlayerAlpha(m_ID, alpha, fadeTime);
+}
+
 bool Player::getOption(vcmpPlayerOption option) const {
 	return g_Funcs->GetPlayerOption(m_ID, option);
 }
@@ -519,6 +527,8 @@ void Player::Init(sol::state* L) {
 	/*** METHODS ***/
 	userdata["msg"] = &Player::msg;
 	userdata["announce"] = &Player::announce;
+	userdata["getAlpha"] = &Player::getAlpha;
+	userdata["setAlpha"] = &Player::setAlpha;
 	userdata["getOption"] = &Player::getOption;
 	userdata["setOption"] = &Player::setOption;
 	userdata["isPlayerStreamed"] = &Player::isPlayerStreamed;
@@ -553,6 +563,7 @@ void Player::Init(sol::state* L) {
 	userdata.set("isSpawned", &Player::isSpawned);
 	userdata.set("isTyping", &Player::isTyping);
 	userdata.set("isCrouching", &Player::isCrouching);
+	userdata.set("isAway", &Player::isAway);
 	userdata.set("getPing", &Player::getPing);
 	userdata.set("getFPS", &Player::getFPS);
 	userdata.set("getModules", &Player::getModules);

VCMP-LUA/vcmpWrap/Classes/Player.h

@@ -28,8 +28,9 @@ class Player {
 
 	/*** METHODS ***/
 	void msg(const std::string&, sol::variadic_args);
-	void announce
-	(const std::string&, sol::variadic_args);
+	void announce(const std::string&, sol::variadic_args);
+	int32_t getAlpha() const;
+	void setAlpha(int32_t, uint32_t);
 	bool getOption(vcmpPlayerOption) const;
 	void setOption(vcmpPlayerOption, bool);
 	bool isPlayerStreamed(Player*) const;

VCMP-LUA/vcmpWrap/Classes/Vehicle.cpp

@@ -287,13 +287,24 @@ void Vehicle::setRadio(int32_t radioID) {
 	g_Funcs->SetVehicleRadio(m_ID, radioID);
 }
 
-uint32_t Vehicle::getDamage() const { return g_Funcs->GetVehicleDamageData(m_ID); }
+uint32_t Vehicle::getDamage() const { 
+	return g_Funcs->GetVehicleDamageData(m_ID);
+}
+
+uint32_t Vehicle::getImmunity() const {
+	return g_Funcs->GetVehicleImmunityFlags(m_ID);
+}
+
 void Vehicle::setDamage(uint32_t data) { 
 	if (getDamage() == data)
 		return;
 	g_Funcs->SetVehicleDamageData(m_ID, data); 
 }
 
+void Vehicle::setImmunity(uint32_t flags) {
+	g_Funcs->SetVehicleImmunityFlags(m_ID, flags);
+}
+
 /*** COMMON PROPERTIES ***/
 sol::as_table_t<std::vector<float>> Vehicle::getPosition() const
 {
@@ -412,6 +423,7 @@ void Vehicle::Init(sol::state* L) {
 	userdata["color"] = sol::property(&Vehicle::getColor, &Vehicle::setColor);
 	userdata["radio"] = sol::property(&Vehicle::getRadio, &Vehicle::setRadio);
 	userdata["damage"] = sol::property(&Vehicle::getDamage, &Vehicle::setDamage);
+	userdata["immunity"] = sol::property(&Vehicle::getImmunity, &Vehicle::setImmunity);
 
 	/*** COMMON PROPERTIES AMONGST ENTITIES ***/
 	userdata["data"] = &Vehicle::m_LuaData;

VCMP-LUA/vcmpWrap/Classes/Vehicle.h

@@ -65,6 +65,7 @@ class Vehicle {
 	uint32_t getIdleRespawnTime() const;
 	uint32_t getLightsData() const;
 	uint32_t getDamage() const;
+	uint32_t getImmunity() const;
 	float getHealth() const;
 	sol::as_table_t<std::vector<float>> getSpawnPosition() const;
 	sol::as_table_t<std::vector<float>> getSpawnRotation() const;
@@ -75,6 +76,7 @@ class Vehicle {
 	void setIdleRespawnTime(uint32_t);
 	void setLightsData(uint32_t);
 	void setDamage(uint32_t);
+	void setImmunity(uint32_t);
 	void setHealth(float);
 	void setSpawnPosition(sol::table);
 	void setSpawnRotation(sol::table);