Garry's Mod Wiki

Home / SANDBOX:CanTool

SANDBOX:CanTool

  boolean SANDBOX:CanTool( Player ply, table tr, string toolname, table tool, number button )
Search Github
This hook is predicted. This means that in singleplayer, it will not be called in the Client realm.

Description

Called when a player attempts to fire their tool gun. Return true to specifically allow the attempt, false to block it.

Arguments

1 Player ply
The player who attempted to use their toolgun.
2 table with TraceResult structure tr
A trace from the players eye to where in the world their crosshair/cursor is pointing.
Returns only Entity when the 5th argument returns 4
3 string toolname
The tool mode the player currently has selected.
4 table tool
The tool mode table the player currently has selected.
5 number button
The tool button pressed.
  • 1 - left click
  • 2 - right click
  • 3 - reload
  • 4 - Menu (No interaction with the toolgun)
The number 4 is a test that Rubat is conducting to implement the CanTool in the SpawnMenu. It may disappear.

Returns

1 boolean
Can use toolgun or not.

Example

Stops players from removing doors.

hook.Add( "CanTool", "CanToolExample", function( ply, tr, toolname, tool, button ) if toolname == "remover" and IsValid( tr.Entity ) and tr.Entity:GetClass() == "prop_door_rotating" then return false end end )

Account Management

Special Pages

Wiki List