Upload

addons/tfa_base/lua/tfa/documentation/tfa_attachment_template.lua

@@ -0,0 +1,84 @@
+--[[
+| This file was obtained through the combined efforts
+| of Madbluntz & Plymouth Antiquarian Society.
+|
+| Credits: lifestorm, Gregory Wayne Rossel JR.,
+| 	Maloy, DrPepper10 @ RIP, Atle!
+|
+| Visit for more: https://plymouth.thetwilightzone.ru/
+--]]
+
+
+-- TFA Base Attachment Template by TFA Base Devs
+
+-- To the extent possible under law, the person who associated CC0 with
+-- TFA Base Template has waived all copyright and related or neighboring rights
+-- to TFA Base Template.
+
+-- You should have received a copy of the CC0 legalcode along with this
+-- work.  If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
+
+if not ATTACHMENT then
+	ATTACHMENT = {}
+end
+
+ATTACHMENT.TFADataVersion = 1 -- If it is undefined, it fallbacks to 0 and WeaponTable gets migrated like SWEPs do
+
+-- ATTACHMENT.Base = "base" -- Attachment baseclass, defaults to "base" attachment
+
+ATTACHMENT.Name = "Example Attachment"
+ATTACHMENT.ShortName = nil -- Abbreviation shown on the bottom left of the icon, generated from name if not defined
+ATTACHMENT.Description = {
+	TFA.Attachments.Colors["+"], "Does something good",
+	TFA.Attachments.Colors["-"], "Does something bad",
+	-- Color(255, 255, 255), "bottom text",
+} -- all colors are defined in lua/tfa/modules/tfa_attachments.lua
+ATTACHMENT.Icon = nil -- "entities/tfa_ammo_match.png" -- Full path to the icon, reverts to '?' by default
+
+ATTACHMENT.WeaponTable = { -- The place where you change the stats (CACHED STATS ONLY!)
+	["Primary"] = {
+		["Damage"] = 60, -- For example, you want to change SWEP.Primary.Damage value to 60
+		["ClipSize"] = function(wep, stat)
+			return wep.Primary_TFA.ClipSize_Override or stat * 1.5
+		end -- Stat functions support changing value dynamically (which is cached afterwards), SWEP.Primary_TFA contains original unchanged values
+	}
+}
+
+-- ATTACHMENT.DInv2_GridSizeX = nil -- DInventory/2 Specific. Determines attachment's width in grid.
+-- ATTACHMENT.DInv2_GridSizeY = nil -- DInventory/2 Specific. Determines attachment's height in grid.
+-- ATTACHMENT.DInv2_Volume = nil -- DInventory/2 Specific. Determines attachment's volume in liters.
+-- ATTACHMENT.DInv2_Mass = nil -- DInventory/2 Specific. Determines attachment's mass in kilograms.
+-- ATTACHMENT.DInv2_StackSize = nil -- DInventory/2 Specific. Determines attachment's maximal stack size.
+
+--[[
+-- Default behavior is always allow, override to change
+function ATTACHMENT:CanAttach(wep)
+	return true
+end
+]]--
+
+--[[
+-- These functions are called BEFORE stat cache is rebuilt
+function ATTACHMENT:Attach(wep)
+end
+
+function ATTACHMENT:Detach(wep)
+end
+]]--
+
+-- Attachment functions called from base
+--[[
+-- Called from render target code if SWEP.RTDrawEnabled is true
+function ATTACHMENT:RTCode(wep, rt_texture, w, h)
+end
+]]--
+
+--[[
+-- Called from FireBullets for each bullet trace hit; arguments are passed from bullet callback
+function ATTACHMENT:CustomBulletCallback(wep, attacker, trace, dmginfo)
+end
+]]--
+
+if not TFA_ATTACHMENT_ISUPDATING then
+	TFAUpdateAttachments()
+end