Default Shader Lua Method

Added `get_default_shaders` and `reset_shader` to easily revert a model to its vanilla shaders without the need to store default values in a table

Author: xr-lucy

gamedata/scripts/lua_help_ex.script

@@ -389,6 +389,8 @@
 		// Shader/Textures
 		function get_shaders(bool)
 		function set_shader(number, string, string, bool)
+		function get_default_shaders(bool)
+		function reset_shader(number, bool)
 
 		get_shaders(hud_mode)
 		hud_mode is optional and will default to false
@@ -406,10 +408,16 @@
 			},
 		},
 
+		get_default_shaders(hud_mode)
+		returns similar table as get_shaders but containing the default shader and texture names, even after they were changed by set_shader
+		
 		set_shader(id, shader, texture, hud_mode) can assign a new shader/texture to the submesh ID
 		id can be -1 to apply the shader/texture to all submeshes at once
 		shader/texture can be nil if you only want to apply one of them
 		hud_mode is optional and will default to false
+		
+		reset_shader(id, hud_mode)
+		same as set_shader but resets to the default shader/texture values, so you don't need to store them in a table to reset them later
     }
 
     class CArtefact : CGameObject {

src/xrGame/script_game_object.cpp

@@ -1147,6 +1147,57 @@ luabind::object CScriptGameObject::GetShaders(bool bHud)
 	return table;
 }
 
+luabind::object CScriptGameObject::GetDefaultShaders(bool bHud)
+{
+	IKinematics* k = nullptr;
+
+	if (bHud)
+	{
+		CActor* act = smart_cast<CActor*>(&object());
+		CHudItem* itm = smart_cast<CHudItem*>(&object());
+		if (itm)
+			k = itm->HudItemData()->m_model;
+		else if (act)
+			k = g_player_hud->m_model->dcast_PKinematics();
+	}
+
+	if (!k)
+		k = object().Visual()->dcast_PKinematics();
+
+	luabind::object table = luabind::newtable(ai().script_engine().lua());
+
+	if (!k)
+	{
+		table["error"] = true;
+		return table;
+	}
+
+	IRenderVisual* vis = k->dcast_RenderVisual();
+	xr_vector<IRenderVisual*>* children = vis->get_children();
+
+	if (!children)
+	{
+		luabind::object subtable = luabind::newtable(ai().script_engine().lua());
+		subtable["shader"] = vis->getDebugShaderDef();
+		subtable["texture"] = vis->getDebugTextureDef();
+		table[1] = subtable;
+		return table;
+	}
+
+	int i = 1;
+
+	for (auto* child : *children)
+	{
+		luabind::object subtable = luabind::newtable(ai().script_engine().lua());
+		subtable["shader"] = child->getDebugShaderDef();
+		subtable["texture"] = child->getDebugTextureDef();
+		table[i] = subtable;
+		++i;
+	}
+
+	return table;
+}
+
 void set_shader_tex(IRenderVisual* vis, int id, LPCSTR shader, LPCSTR texture)
 {
 	xr_vector<IRenderVisual*>* children = vis->get_children();
@@ -1172,6 +1223,31 @@ void set_shader_tex(IRenderVisual* vis, int id, LPCSTR shader, LPCSTR texture)
 		children->at(id)->SetShaderTexture(shader, texture);
 }
 
+void reset_shader_tex(IRenderVisual* vis, int id)
+{
+	xr_vector<IRenderVisual*>* children = vis->get_children();
+
+	if (!children)
+	{
+		vis->ResetShaderTexture();
+		return;
+	}
+
+	if (id == -1)
+	{
+		for (auto* child : *children)
+		{
+			child->ResetShaderTexture();
+		}
+		return;
+	}
+
+	id--;
+
+	if (id >= 0 && children->size() > id)
+		children->at(id)->ResetShaderTexture();
+}
+
 void CScriptGameObject::SetShaderTexture(int id, LPCSTR shader, LPCSTR texture, bool bHud)
 {
 	IKinematics* k = nullptr;
@@ -1197,3 +1273,29 @@ void CScriptGameObject::SetShaderTexture(int id, LPCSTR shader, LPCSTR texture,
 
 	set_shader_tex(k->dcast_RenderVisual(), id, shader, texture);
 }
+
+void CScriptGameObject::ResetShaderTexture(int id, bool bHud)
+{
+	IKinematics* k = nullptr;
+
+	if (bHud)
+	{
+		CActor* act = smart_cast<CActor*>(&object());
+		CHudItem* itm = smart_cast<CHudItem*>(&object());
+		if (itm)
+			k = itm->HudItemData()->m_model;
+		else if (act)
+		{
+			reset_shader_tex(g_player_hud->m_model->dcast_RenderVisual(), id);
+			reset_shader_tex(g_player_hud->m_model_2->dcast_RenderVisual(), id);
+			return;
+		}
+	}
+
+	if (!k)
+		k = object().Visual()->dcast_PKinematics();
+
+	if (!k) return;
+
+	reset_shader_tex(k->dcast_RenderVisual(), id);
+}

src/xrGame/script_game_object.h

@@ -1122,7 +1122,9 @@ class CScriptGameObject
 	//-Alundaio
 
 	::luabind::object GetShaders(bool bHud = false);
+	::luabind::object GetDefaultShaders(bool bHud = false);
 	void SetShaderTexture(int id, LPCSTR shader, LPCSTR texture, bool bHud = false);
+	void ResetShaderTexture(int id, bool bHud = false);
 
 	script_attachment* AddAttachment(u16 slot, LPCSTR model_name);
 	script_attachment* GetAttachment(u16 slot);

src/xrGame/script_game_object_script3.cpp

@@ -638,7 +638,9 @@ class_<CScriptGameObject>& script_register_game_object2(class_<CScriptGameObject
 		.def("remove_attachment", &CScriptGameObject::RemoveAttachment)
 
 		.def("get_shaders", &CScriptGameObject::GetShaders)
+		.def("get_default_shaders", &CScriptGameObject::GetDefaultShaders)
 		.def("set_shader", &CScriptGameObject::SetShaderTexture)
+		.def("reset_shader", &CScriptGameObject::ResetShaderTexture)
 		;
 	return (instance);
 }