Creating custom weapons - VScript - Revision history

ChaoticUltimateJ: /* Table and collector method */ Added info about stacking tables, though this could be technical and may need to be cleaned up

2026-09-24T14:41:18Z

Table and collector method: Added info about stacking tables, though this could be technical and may need to be cleaned up

← Older revision		Revision as of 14:41, 24 September 2026
Line 18:		Line 18:
	Hooking can be done in two ways, a table and collector (making a table of functions and collecting them) and a direct hook to the game's events. As of writing, the writer here has no idea what the difference is.		Hooking can be done in two ways, a table and collector (making a table of functions and collecting them) and a direct hook to the game's events. As of writing, the writer here has no idea what the difference is.
	== Table and collector method ==		== Table and collector method ==
	Here's an example table that disables Medic's health regen when he's holding a weapon that has a custom, schema defined attribute.		This is the recommended method to allow other VScript mods to coexist with each other so long as they have uniquely named tables.<br>
			Here's an example table that disables Medic's health regen when he's holding a weapon that has a custom, schema defined attribute.<br>
	<pre>		<pre>
	::AttributeTable <- {		::AttributeTable <- {
Line 64:		Line 65:
	}		}
	</pre>		</pre>
	It also doesn't need an attribute class either, since the VScript only uses the attribute's name, so ideally you shouldn't have an attribute class on vscript attributes.		It also doesn't need an attribute class either, since the VScript only uses the attribute's name, so ideally you shouldn't have an attribute class on vscript attributes.<br>

			In the instance that two scripts do come with their own uniquely named tables that happen to hook on the same GameEvent, assuming multiple scripts are imported that each have their own tables, these tables will be executed in reverse order to the way they were imported, assuming you're using an importer. For example say I have table1 and table2 which both use the same <code>OnGameEvent_</code> and later we run <code>__CollectGameEventCallbacks(Table1)</code> and then <code>__CollectGameEventCallbacks(Table2)</code> after that. Table2 runs first even though the collector function was last. It's unknown ''why'' this happens, but it is something to keep in mind if you need to control the order in which each table is handled (for example you need variables to be changed before a different table starts using them)

	== Direct hook method ==		== Direct hook method ==

Rei1556: /* Direct hook method */ todo'd

2026-08-28T01:52:06Z

Direct hook method: todo'd

← Older revision		Revision as of 01:52, 28 August 2026
Line 67:		Line 67:

	== Direct hook method ==		== Direct hook method ==
	The direct hook method is the same way the official April Fools weapon pack does its VScript attributes ~~<sub>~~{{~~tooltip\|Todo~~\|should we link this?}}~~</sub>~~		The direct hook method is the same way the official April Fools weapon pack does its VScript attributes.{{InlineTodo\|should we link this?}}
	For example we're going to pick apart one of them, specifically the "mod shoot self" attribute.		For example we're going to pick apart one of them, specifically the "mod shoot self" attribute.
	<pre>		<pre>
Line 114:		Line 114:
	For a much simpler example, here's a one-line piece of code that prints to the log whenever a gun is fired. <code>::ListenToGameEvent( "player_shoot", function(event){printl("doing things")}, "didathing")</code> In this instance, the table of info is passed to "event", which isn't used but is still required because the game still calls the function with that table regardless, and can't just throw it out.		For a much simpler example, here's a one-line piece of code that prints to the log whenever a gun is fired. <code>::ListenToGameEvent( "player_shoot", function(event){printl("doing things")}, "didathing")</code> In this instance, the table of info is passed to "event", which isn't used but is still required because the game still calls the function with that table regardless, and can't just throw it out.
	will print "doing things" to the console whenever we shoot.		will print "doing things" to the console whenever we shoot.

	= See also =		= See also =
	[https://developer.valvesoftware.com/wiki/Team_Fortress_2/Docs/Scripting/Script_Functions TF2's VScript Functions]<br>		[https://developer.valvesoftware.com/wiki/Team_Fortress_2/Docs/Scripting/Script_Functions TF2's VScript Functions]<br>

ChaoticUltimateJ: /* Table and collector method */ teeny tiny spelling mistake

2026-08-09T13:09:54Z

Table and collector method: teeny tiny spelling mistake

← Older revision		Revision as of 13:09, 9 August 2026
Line 64:		Line 64:
	}		}
	</pre>		</pre>
	It also doesn't need an attribute class either, since the ~~Vscript~~ only uses the attribute's name, so ideally you shouldn't have an attribute class on vscript attributes.		It also doesn't need an attribute class either, since the VScript only uses the attribute's name, so ideally you shouldn't have an attribute class on vscript attributes.

	== Direct hook method ==		== Direct hook method ==

Static Fanatic at 15:56, 16 July 2026

2026-07-16T15:56:28Z

← Older revision		Revision as of 15:56, 16 July 2026
Line 5:		Line 5:

	Give plenty of examples that each go through multiple new things		Give plenty of examples that each go through multiple new things


			Add explanations for detecting actions like attack, attack2 and reload
	}}		}}

Static Fanatic: Fixed some minor errors

2026-07-15T15:12:48Z

Fixed some minor errors

← Older revision		Revision as of 15:12, 15 July 2026
Line 1:		Line 1:
	{{stub}}		{{stub}}
	{{todo\| ~~write an actual~~ page~~, and maybe make it~~ more beginner friendly~~? Also I'm sorry Static for writing this page for you out of the blue but I was hit with a wave~~ of ~~"autistic inspiration" I guess.~~}}		{{todo\|Make the page more beginner friendly:

			Start simple

			Give plenty of examples that each go through multiple new things
			}}

	TF2C extends TF2 and MapBase's VScripting, making anything possible in either of them mostly possible in TF2C.		TF2C extends TF2 and MapBase's VScripting, making anything possible in either of them mostly possible in TF2C.

	~~Vscript~~ in TF2C uses [https://en.wikipedia.org/wiki/Squirrel_(programming_language) Squirrel] <sup>{{tooltip\|Note\|as of writing the actual squirrel website is inaccessible for whatever reason, so the ~~wikipedia~~ page will have to do for now I suppose}}</sup>, which is also used by TF2 and MapBase for their ~~Vscripting~~ as well.		VScript in TF2C uses [https://en.wikipedia.org/wiki/Squirrel_(programming_language) Squirrel] <sup>{{tooltip\|Note\|as of writing the actual squirrel website is inaccessible for whatever reason, so the Wikipedia page will have to do for now I suppose}}</sup>, which is also used by TF2 and MapBase for their VScripting as well.

	= Hooks =		= Hooks =
	A hook in modding is when you get the game to run a function, so you can perform custom behavior or replace existing behavior. We can't actually replace TF2C's code directly of course, so instead we use a tool provided to us by Valve and the TF2C team called ~~Vscript~~.<br>		A hook in modding is when you get the game to run a function, so you can perform custom behavior or replace existing behavior. We can't actually replace TF2C's code directly of course, so instead we use a tool provided to us by Valve and the TF2C team called VScript.<br>
	Hooking can be done in two ways, a table and collector (making a table of functions and collecting them) and a direct hook to the game's events. As of writing, the writer here has no idea what the difference is.		Hooking can be done in two ways, a table and collector (making a table of functions and collecting them) and a direct hook to the game's events. As of writing, the writer here has no idea what the difference is.
	== Table and collector method ==		== Table and collector method ==
	~~Heres~~ an example table that disables ~~medic~~'s health regen when he's holding a weapon that has a custom, schema defined attribute.		Here's an example table that disables Medic's health regen when he's holding a weapon that has a custom, schema defined attribute.
	<pre>		<pre>
	::AttributeTable <- {		::AttributeTable <- {
Line 59:		Line 64:

	== Direct hook method ==		== Direct hook method ==
	The direct hook method is the same way the ~~Official~~ April Fools ~~Mod~~ does ~~it's~~ VScript attributes <sub>{{tooltip\|Todo\|should we link this?}}</sub>		The direct hook method is the same way the official April Fools weapon pack does its VScript attributes <sub>{{tooltip\|Todo\|should we link this?}}</sub>
	For example we're going to pick apart one of them, specifically the "mod shoot self" attribute.		For example we're going to pick apart one of them, specifically the "mod shoot self" attribute.
	<pre>		<pre>

ChaoticUltimateJ: /* Table and collector method */

2026-07-15T14:41:03Z

Table and collector method

← Older revision		Revision as of 14:41, 15 July 2026
Line 36:		Line 36:
	}		}
	</pre>		</pre>
	And later we can do <code>__CollectGameEventCallbacks(AttributeTable)</code> which collects all of our functions in the table and acts on them.		And later we can do <code>__CollectGameEventCallbacks(AttributeTable)</code> which collects all of our functions in the table and acts on them.<br>

	While there is no such thing as a "medic no heal" attribute, we can just make one up in our item schema like this:		While there is no such thing as a "medic no heal" attribute, we can just make one up in our item schema like this:
	<pre>		<pre>

ChaoticUltimateJ: I did a lot.

2026-07-15T14:39:58Z

I did a lot.

← Older revision		Revision as of 14:39, 15 July 2026
Line 1:		Line 1:
	{{stub}}		{{stub}}
			{{todo\| write an actual page, and maybe make it more beginner friendly? Also I'm sorry Static for writing this page for you out of the blue but I was hit with a wave of "autistic inspiration" I guess.}}

			TF2C extends TF2 and MapBase's VScripting, making anything possible in either of them mostly possible in TF2C.

			Vscript in TF2C uses [https://en.wikipedia.org/wiki/Squirrel_(programming_language) Squirrel] <sup>{{tooltip\|Note\|as of writing the actual squirrel website is inaccessible for whatever reason, so the wikipedia page will have to do for now I suppose}}</sup>, which is also used by TF2 and MapBase for their Vscripting as well.

			= Hooks =
			A hook in modding is when you get the game to run a function, so you can perform custom behavior or replace existing behavior. We can't actually replace TF2C's code directly of course, so instead we use a tool provided to us by Valve and the TF2C team called Vscript.<br>
			Hooking can be done in two ways, a table and collector (making a table of functions and collecting them) and a direct hook to the game's events. As of writing, the writer here has no idea what the difference is.
			== Table and collector method ==
			Heres an example table that disables medic's health regen when he's holding a weapon that has a custom, schema defined attribute.
			<pre>
			::AttributeTable <- {
			// when a player heals
			function OnGameEvent_player_healed(params)
			{
			if (params.patient == params.healer) // if we heal ourselves
			{
			// get ourselves
			local player = GetPlayerFromUserID(params.patient)

			local activeweapon = player.GetActiveWeapon()

			// check the weapons attributes and "disable" healing if they have a specific attribute
			if ( activeweapon.GetAttribute("medic no heal", 0) == 1 )
			{
			if (player.GetPlayerClass() == Constants.ETFClass.TF_CLASS_MEDIC)
			{
			// unheal... basically
			player.SetHealth(player.GetHealth() - params.amount)
			}
			}
			}
			}
			}
			</pre>
			And later we can do <code>__CollectGameEventCallbacks(AttributeTable)</code> which collects all of our functions in the table and acts on them.
			While there is no such thing as a "medic no heal" attribute, we can just make one up in our item schema like this:
			<pre>
			"items_game"
			{
			<...>
			"attributes"
			{
			"7000"
			{
			"name" "medic no heal"
			"description_string" "While Active: No longer passively heal"
			"description_format" "value_is_additive"
			"hidden" "0"
			"effect_type" "negative"
			}
			}
			}
			</pre>
			It also doesn't need an attribute class either, since the Vscript only uses the attribute's name, so ideally you shouldn't have an attribute class on vscript attributes.

			== Direct hook method ==
			The direct hook method is the same way the Official April Fools Mod does it's VScript attributes <sub>{{tooltip\|Todo\|should we link this?}}</sub>
			For example we're going to pick apart one of them, specifically the "mod shoot self" attribute.
			<pre>
			::ListenToGameEvent( "player_shoot", function( hEvent )
			{
			// Get the player and throw away the event if the event isn't from the player
			local hPlayer = GetPlayerFromUserID( hEvent.userid );
			if ( !hPlayer )
			{
			return;
			}

			// Get the weapon and throw away the event if the event isn't from the weapon
			local hWeapon = hPlayer.GetActiveWeapon()
			if ( !hWeapon \|\| !hWeapon.GetAttribute( "mod shoot self", 0 ) )
			{
			return;
			}

			// Take damage equal to your health, plus 10
			hPlayer.TakeDamage( hPlayer.GetMaxHealth() + 10, Constants.FDmgType.DMG_PREVENT_PHYSICS_FORCE, hPlayer );

			// For the sound to not get cut off from dying we need to emit it from the ragdoll.
			local hRagdoll = NetProps.GetPropEntity( hPlayer, "m_hRagdoll" );
			if ( hRagdoll )
			{
			hRagdoll.EmitSound( "Weapon_Scatter_Gun.Single" );
			}

			// Turn the player's head around so the shots are fired behind him.
			local angEyeAngles = hPlayer.EyeAngles()

			angEyeAngles.x = -angEyeAngles.x;
			angEyeAngles.y += 180;
			if ( angEyeAngles.y > 180 )
			{
			angEyeAngles.y -= 360;
			}

			hPlayer.SnapEyeAngles( angEyeAngles );
			}, "mod_shoot_self" );
			</pre>
			We can actually easily condense the whole script into one line so it's easier to understand how the hook works and how it modifies the game behavior.<br>
			<code>::ListenToGameEvent( <GameEvent>, function(args){behavior}, <String>)</code><br>
			Now that we have it all condensed down into one line, this is basically how hooking a game event works. We run a function when a game event happens, which passes a table of information through args, and runs behavior.
			For a much simpler example, here's a one-line piece of code that prints to the log whenever a gun is fired. <code>::ListenToGameEvent( "player_shoot", function(event){printl("doing things")}, "didathing")</code> In this instance, the table of info is passed to "event", which isn't used but is still required because the game still calls the function with that table regardless, and can't just throw it out.
			will print "doing things" to the console whenever we shoot.
			= See also =
			[https://developer.valvesoftware.com/wiki/Team_Fortress_2/Docs/Scripting/Script_Functions TF2's VScript Functions]<br>
			[https://developer.valvesoftware.com/wiki/Team_Fortress_2/Docs/Scripting/Game_Events TF2's Game Events (used for hooks)]<br>

			[https://developer.valvesoftware.com/wiki/Mapbase/Scripting/Script_Functions MapBase's VScript Functions]<br>
			[https://developer.valvesoftware.com/wiki/Team_Fortress_2/Docs/Scripting/Script_Functions MapBase's Game Events (used for hooks)]<br>

			[https://developer.valvesoftware.com/wiki/Source_2013_MP/Scripting/Game_Events Source 2013's Game Events (used for hooks)]<br>

	[[category:guides]]		[[category:guides]]

Static Fanatic: Created page with "{{stub}} category:guides"

2026-07-06T08:11:00Z

Created page with "{{stub}} category:guides"

New page

{{stub}}

[[category:guides]]