From 08a2314540141f4f367ee06348152957248d5b04 Mon Sep 17 00:00:00 2001
From: YuRaNnNzZZ <medved609@yandex.ru>
Date: Tue, 20 Aug 2024 22:46:55 +0300
Subject: [PATCH] list of base's material proxies

---
 README.md                                |  1 +
 lua/tfa/documentation/tfa_matproxies.lua | 80 ++++++++++++++++++++++++
 2 files changed, 81 insertions(+)
 create mode 100644 lua/tfa/documentation/tfa_matproxies.lua

diff --git a/README.md b/README.md
index edd471b..7614c00 100644
--- a/README.md
+++ b/README.md
@@ -9,6 +9,7 @@
 - [Attachment Template](lua/tfa/documentation/tfa_attachment_template.lua) - file name is the ID of attachment that goes into `SWEP.Attachments` table, place to `<your addon>/lua/tfa/att` folder
 - [Animations Reference](lua/tfa/documentation/tfa_anims_template.lua) - list of animations that are used by the base
 - [Custom Hooks](lua/tfa/documentation/tfa_hooks_custom.lua) - list of [hooks](https://wiki.facepunch.com/gmod/hook.Add) added by the base for the addons intercompatibility
+- [Material Proxies](lua/tfa/documentation/tfa_matproxies.lua) - list of [material proxies](https://developer.valvesoftware.com/wiki/Material_proxies) added by the base
 - [Developer FAQ](faq/FOR_DEVELOPERS.md) - Common code stuff relevant to developing TFA Base addons
 
 ## Paths that are loaded by the base automatically (in load order):
diff --git a/lua/tfa/documentation/tfa_matproxies.lua b/lua/tfa/documentation/tfa_matproxies.lua
new file mode 100644
index 0000000..2ad2f64
--- /dev/null
+++ b/lua/tfa/documentation/tfa_matproxies.lua
@@ -0,0 +1,80 @@
+-- Name: PlayerWeaponColorStatic
+-- Description: Static/direct variation of PlayerWeaponColor, without any flickering.
+-- Parameters:
+--     1. resultvar - Result variable for the color (such as $color2)
+-- VMT Example:
+--[[
+	Proxies
+	{
+		PlayerWeaponColorStatic
+		{
+			resultvar	$color2
+		}
+	}
+]]
+
+
+-- Name: TFALaserColor
+-- Description: 
+-- Parameters:
+--     1. resultvar - Result variable for the color (such as $color2)
+-- VMT Example:
+--[[
+	Proxies
+	{
+		TFALaserColor
+		{
+			resultVar	$color2
+		}
+	}
+]]
+
+
+-- Name: TFAReticuleColor
+-- Description: 
+-- Parameters:
+--     1. resultvar - Result variable for the color (such as $color2)
+-- VMT Example:
+--[[
+	Proxies
+	{
+		TFAReticuleColor
+		{
+			resultVar	$color2
+		}
+	}
+]]
+
+
+-- Name: TFA_RTScope
+-- Description: Replaces $basetexture with render target texture of 3D scopes
+-- VMT Example:
+--[[
+	Proxies
+	{
+		TFA_RTScope
+		{
+		}
+	}
+]]
+
+
+-- Name: TFA_CubemapTint
+-- Description: Tints 
+-- Parameters:
+--     1. resultvar - Variable for resulting envmap tint ($envmaptint)
+--     2. multiplier - Variable for base tint multiplier (a vector)
+-- VMT Example:
+--[[
+	$envmapmultiplier	"[1 1 1]" // Lighting will be multiplied by this value
+
+	Proxies
+	{
+		TFA_CubemapTint
+		{
+			resultvar	$envmaptint // Write final output to $envmaptint
+			multiplier	$envmapmultiplier // Use our value for default envmap tint
+		}
+	}
+]]
+