Hooks - Revision history

Outerbeast: /* Player Hooks */

2026-02-04T16:44:29Z

Player Hooks

Outerbeast: /* Monster Hooks */

2025-07-25T19:07:05Z

Monster Hooks

← Older revision		Revision as of 21:07, 25 July 2025
Line 223:		Line 223:
	\| <code>MonsterKilledHook		\| <code>MonsterKilledHook
	\| <code>HookReturnCode Function( CBaseMonster@ pMonster, CBaseEntity@ pAttacker, int iGib )		\| <code>HookReturnCode Function( CBaseMonster@ pMonster, CBaseEntity@ pAttacker, int iGib )
	\| Called when a monster is killed (This hook isn’t called for monster_sentry/monster_barnacle).<br />This hook may have spam issues.		\| Called when a monster is killed (This hook isn’t called for grenade entities/monster_sentry/monster_barnacle).<br />This hook may have spam issues.
	\| <code>ON_HANDLED		\| <code>ON_HANDLED
	\| All		\| All

Outerbeast: /* Monster Hooks */

2025-03-13T11:40:45Z

Monster Hooks

← Older revision		Revision as of 13:40, 13 March 2025
Line 212:		Line 212:
	<code>Hooks::Monster::</code>		<code>Hooks::Monster::</code>

	'''Note:''' ~~Player~~ are technically CBaseMonster instances, so player TakeDamage and Killed events will also be hooked. Ensure the function code accommodates for this.		'''Note:''' Players are technically CBaseMonster instances, so player TakeDamage and Killed events will also be hooked. Ensure the function code accommodates for this.
	{\| class="wikitable"		{\| class="wikitable"
	\|-		\|-

Outerbeast: /* Monster Hooks */

2025-03-13T11:40:35Z

Monster Hooks

← Older revision		Revision as of 13:40, 13 March 2025
Line 211:		Line 211:
	=== Monster Hooks ===		=== Monster Hooks ===
	<code>Hooks::Monster::</code>		<code>Hooks::Monster::</code>

	'''Note:''' Player are technically CBaseMonster instances, so player TakeDamage and Killed events will also be hooked. Ensure the function code accommodates for this.		'''Note:''' Player are technically CBaseMonster instances, so player TakeDamage and Killed events will also be hooked. Ensure the function code accommodates for this.
	{\| class="wikitable"		{\| class="wikitable"

Outerbeast: /* Monster Hooks */

2025-03-13T11:40:26Z

Monster Hooks

← Older revision		Revision as of 13:40, 13 March 2025
Line 211:		Line 211:
	=== Monster Hooks ===		=== Monster Hooks ===
	<code>Hooks::Monster::</code>		<code>Hooks::Monster::</code>
			'''Note:''' Player are technically CBaseMonster instances, so player TakeDamage and Killed events will also be hooked. Ensure the function code accommodates for this.
	{\| class="wikitable"		{\| class="wikitable"
	\|-		\|-

Outerbeast: /* Weapon Hooks */

2025-03-08T18:50:08Z

Weapon Hooks

← Older revision		Revision as of 20:50, 8 March 2025
Line 261:		Line 261:
	\| All		\| All
	\|-		\|-
	\| <code>~~WeaponReloadHook~~		\| <code>WeaponReload
	\| <code>HookReturnCode Function( CBasePlayer@ pPlayer, CBasePlayerWeapon@ pWeapon )		\| <code>HookReturnCode Function( CBasePlayer@ pPlayer, CBasePlayerWeapon@ pWeapon )
	\| Called a player reloads a weapon (or calls BaseClass::Reload()).		\| Called a player reloads a weapon (or calls BaseClass::Reload()).

Outerbeast: /* Registering hooks */

2025-02-26T20:09:17Z

Registering hooks

← Older revision		Revision as of 22:09, 26 February 2025
Line 39:		Line 39:

	If you are trying to register a method to a hook, you need to pass the method handle in via a delegate, this is done as follows:		If you are trying to register a method to a hook, you need to pass the method handle in via a delegate, this is done as follows:
	<pre>g_Hooks.RegisterHook( Hooks::Game::MapChange, MapChangeHook( obj.MapChange ) )</pre		<pre>g_Hooks.RegisterHook( Hooks::Game::MapChange, MapChangeHook( obj.MapChange ) )</pre>

	It is also possible to remove all of the hook functions registered for a particular hook in the current script by calling RemoveHook with just the hook ID parameter:		It is also possible to remove all of the hook functions registered for a particular hook in the current script by calling RemoveHook with just the hook ID parameter:

Outerbeast: /* Hook definition and usage */

2025-02-26T20:08:59Z

Hook definition and usage

← Older revision		Revision as of 22:08, 26 February 2025
Line 33:		Line 33:
	}		}

	g_Hooks.RegisterHook( Hooks::Game::MapChange, @MapChange );</pre>		g_Hooks.RegisterHook( Hooks::Game::MapChange, MapChange );</pre>
	Removing a hook is done much like registering it:		Removing a hook is done much like registering it:

	<pre>g_Hooks.RemoveHook( Hooks::Game::MapChange, @MapChange );</pre>		<pre>g_Hooks.RemoveHook( Hooks::Game::MapChange, MapChange );</pre>

			If you are trying to register a method to a hook, you need to pass the method handle in via a delegate, this is done as follows:
			<pre>g_Hooks.RegisterHook( Hooks::Game::MapChange, MapChangeHook( obj.MapChange ) )</pre

	It is also possible to remove all of the hook functions registered for a particular hook in the current script by calling RemoveHook with just the hook ID parameter:		It is also possible to remove all of the hook functions registered for a particular hook in the current script by calling RemoveHook with just the hook ID parameter:

	<pre>g_Hooks.RemoveHook( Hooks::Game::MapChange );</pre>		<pre>g_Hooks.RemoveHook( Hooks::Game::MapChange );</pre>

	~~If you are trying to register a method to a hook, you need to pass the method handle in via a delegate, this is done as follows:~~
	~~<code>g_Hooks.RegisterHook( Hooks::Game::MapChange, MapChangeHook( obj.MapChange ) )</code>~~

	=== Stop Modes ===		=== Stop Modes ===

Outerbeast: /* Pickup Hooks */

2025-02-26T20:07:35Z

Pickup Hooks

← Older revision		Revision as of 22:07, 26 February 2025
Line 278:		Line 278:
	! Availability		! Availability
	\|- style="border-color:inherit;"		\|- style="border-color:inherit;"
	\| Materialize		\| <code>Materialize
	\| HookReturnCode Function( CBaseEntity@ pPickup )		\| <code>HookReturnCode Function( CBaseEntity@ pPickup )
	\| Called when a pickup object materializes.		\| Called when a pickup object materializes.
	\| CALL_ALL		\| <code>CALL_ALL
	\| All		\| All
	\|-		\|-
	\| style="border-color:inherit;" \| CanCollect		\| style="border-color:inherit;" \| <code>CanCollect
	\| style="border-color:inherit;" \| HookReturnCode Function( CBaseEntity@ pPickup, CBaseEntity@ pOther, bool& out bResult )		\| style="border-color:inherit;" \| <code>HookReturnCode Function( CBaseEntity@ pPickup, CBaseEntity@ pOther, bool& out bResult )
	\| style="border-color:inherit;" \| Called when a pickup object is about to be collected by a player. Note that basic checks are done before this hook is called. Set bResult to false if the player shouldn’t be able to pick up the object.		\| style="border-color:inherit;" \| Called when a pickup object is about to be collected by a player. Note that basic checks are done before this hook is called. Set bResult to false if the player shouldn’t be able to pick up the object.
	\| ON_HANDLED		\| <code>ON_HANDLED
	\| style="border-color:inherit;" \| All		\| style="border-color:inherit;" \| All
	\|- style="border-color:inherit;"		\|- style="border-color:inherit;"
	\| Collected		\| <code>Collected
	\| HookReturnCode Function( CBaseEntity@ pPickup, CBaseEntity@ pOther )		\| <code>HookReturnCode Function( CBaseEntity@ pPickup, CBaseEntity@ pOther )
	\| Called when a pickup object is collected by a player.		\| Called when a pickup object is collected by a player.
	\| CALL_ALL		\| <code>CALL_ALL
	\| All		\| All
	\|}		\|}

	[[Category:Scripting]]		[[Category:Scripting]]

Outerbeast: /* Weapon Hooks */

2025-02-26T20:07:13Z

Weapon Hooks

← Older revision		Revision as of 22:07, 26 February 2025
Line 243:		Line 243:
	! Availability		! Availability
	\|-		\|-
	\| WeaponPrimaryAttack		\| <code>WeaponPrimaryAttack
	\| HookReturnCode Function( CBasePlayer@ pPlayer, CBasePlayerWeapon@ pWeapon )		\| <code>HookReturnCode Function( CBasePlayer@ pPlayer, CBasePlayerWeapon@ pWeapon )
	\| Called when a player fires a weapon's primary attack.		\| Called when a player fires a weapon's primary attack.
	\| ON_HANDLED		\| <code>ON_HANDLED
	\| All		\| All
	\|-		\|-
	\| WeaponSecondaryAttack		\| <code>WeaponSecondaryAttack
	\| HookReturnCode Function( CBasePlayer@ pPlayer, CBasePlayerWeapon@ pWeapon )		\| <code>HookReturnCode Function( CBasePlayer@ pPlayer, CBasePlayerWeapon@ pWeapon )
	\| Called when a player fires a weapon's secondary attack.		\| Called when a player fires a weapon's secondary attack.
	\| ON_HANDLED		\| <code>ON_HANDLED
	\| All		\| All
	\|-		\|-
	\| WeaponTertiaryAttack		\| <code>WeaponTertiaryAttack
	\| HookReturnCode Function( CBasePlayer@ pPlayer, CBasePlayerWeapon@ pWeapon )		\| <code>HookReturnCode Function( CBasePlayer@ pPlayer, CBasePlayerWeapon@ pWeapon )
	\| Called when a player fires a weapon's tertiary attack.		\| Called when a player fires a weapon's tertiary attack.
	\| ON_HANDLED		\| <code>ON_HANDLED
	\| All		\| All
	\|-		\|-
	\| WeaponReloadHook		\| <code>WeaponReloadHook
	\| HookReturnCode Function( CBasePlayer@ pPlayer, CBasePlayerWeapon@ pWeapon )		\| <code>HookReturnCode Function( CBasePlayer@ pPlayer, CBasePlayerWeapon@ pWeapon )
	\| Called a player reloads a weapon (or calls BaseClass::Reload()).		\| Called a player reloads a weapon (or calls BaseClass::Reload()).
	\| CALL_ALL		\| <code>CALL_ALL
	\| All		\| All
	\|}		\|}

← Older revision		Revision as of 18:44, 4 February 2026
Line 176:		Line 176:
	\| Called when the player is processing pre think events. uiFlags is used to skip pre think processing after the hook returns. Setting the flag PlrHook_SkipVehicles will skip vehicle processing.		\| Called when the player is processing pre think events. uiFlags is used to skip pre think processing after the hook returns. Setting the flag PlrHook_SkipVehicles will skip vehicle processing.
	\| style="border-color:inherit;" \|		\| style="border-color:inherit;" \|
	\| style="border-color:inherit;" \|		\| style="border-color:inherit;" \| All
	\|-		\|-
	\| style="border-color:inherit;" \| <code>PlayerPostThink		\| style="border-color:inherit;" \| <code>PlayerPostThink
Line 182:		Line 182:
	\| Called when the player is processing post think events.		\| Called when the player is processing post think events.
	\| style="border-color:inherit;" \|		\| style="border-color:inherit;" \|
	\| style="border-color:inherit;" \|		\| style="border-color:inherit;" \| All
	\|-		\|-
	\| <code>PlayerPreDecal		\| <code>PlayerPreDecal
Line 188:		Line 188:
	\| Called when a player attempts to spraypaint a decal onto a surface. The given trace result contains the surface information. Set bResult to false if the player shouldn’t be able to spray.		\| Called when a player attempts to spraypaint a decal onto a surface. The given trace result contains the surface information. Set bResult to false if the player shouldn’t be able to spray.
	\| style="border-color:inherit;" \|		\| style="border-color:inherit;" \|
	\| style="border-color:inherit;" \|		\| style="border-color:inherit;" \| Plugins only
	\|-		\|-
	\| <code>PlayerDecal		\| <code>PlayerDecal
Line 194:		Line 194:
	\| Called when a player is spraypainting a decal onto a surface. The given trace result contains the surface information.		\| Called when a player is spraypainting a decal onto a surface. The given trace result contains the surface information.
	\| style="border-color:inherit;" \|		\| style="border-color:inherit;" \|
	\| style="border-color:inherit;" \|		\| style="border-color:inherit;" \| Plugins only
	\|-		\|-
	\| <code>PlayerEnteredObserver		\| <code>PlayerEnteredObserver
Line 200:		Line 200:
	\| Called when a player enters observer mode.		\| Called when a player enters observer mode.
	\| style="border-color:inherit;" \|		\| style="border-color:inherit;" \|
	\| style="border-color:inherit;" \|		\| style="border-color:inherit;" \| All
	\|-		\|-
	\| <code>PlayerLeftObserver		\| <code>PlayerLeftObserver
Line 206:		Line 206:
	\| Called when a player leaves observer mode.		\| Called when a player leaves observer mode.
	\| style="border-color:inherit;" \|		\| style="border-color:inherit;" \|
	\| style="border-color:inherit;" \|		\| style="border-color:inherit;" \| All
	\|}		\|}