Gamemode.CanTool
From GMod Wiki
Revision as of 18:38, 27 September 2011 by TheFreeman193 (Talk | contribs)
| Event Hook | |
| Hook Name | CanTool |
| Syntax | GM:CanTool( Player ply, TraceRes tr, String toolmode ) |
| Description | Determines whether or not a player is allowed to use a tool. |
| Returns | Boolean |
| Lua State | 
|
| BBCode | [b][url=wiki.garrysmod.com/?title=Gamemode.CanTool]Gamemode.CanTool [img]http://wiki.garrysmod.com/favicon.ico[/img][/url][/b] |
Examples
| Description | Stops non-admins from using the Remover, Ignite, and RT Camera tools. |
|---|---|
| Used on | |
| Code | function UseTool(pl, _, toolmode) //NOTE: The _ (underscore) can be used to ignore certain arguments passed to a function //If the current tool is the remover, ignite, or rt camera if toolmode == "remover" or toolmode == "ignite" or toolmode == "rtcamera" then if pl:IsAdmin() then -- If the player is an admin/superadmin return true -- Allow usage of the tools else return false -- Otherwise, disallow usage end end end hook.Add("CanTool", "UseTool", UseTool) |
| Output | N/A |
| Description | Prevents players from removing physics props. |
|---|---|
| Used on | |
| Code | function StopRemovalOfProps(_, trace, tool) local ent = trace.Entity //If the current tool is the remover, and the entity is a physics prop if tool == "remover" and ent:GetClass() == "prop_physics" then //Disallow Tool Usage return false end end hook.Add("CanTool", "Stop Prop Removal", StopRemovalOfProps) |
| Output | N/A |
Toolgun Modes
The toolmode parameter is the filename of the tool (e.g. ignite.lua) without the .lua extenstion. The built in Garry's Mod toolgun modes are listed below:
|
|
|
Here are the wire tools:
|
|
|
Additional Notes
- Return true to allow usage of the toolmode, false for not allowing it.
- toolmode is derived from the STool's filename, with the .lua extension removed.
