TOOL:LeftClick
From GMod Wiki
| Event Hook | |
| Hook Name | LeftClick |
| Syntax | TOOL:LeftClick( TraceRes tr ) |
| Description | Called when the user left clicks. |
| Returns | Nil |
| Lua State | 
|
| BBCode | [b][url=wiki.garrysmod.com/?title=TOOL:LeftClick]TOOL:LeftClick [img]http://wiki.garrysmod.com/favicon.ico[/img][/url][/b] |
Examples
| Description | Ignite the object in front of the player for a 1 minute burn. |
|---|---|
| Used on | |
| Code | function TOOL:LeftClick( tr ) if (!tr.Entity) then return false end -- Is the trace an entity? if (!tr.Entity:IsValid() ) then return false end -- Is the entity valid? if (tr.Entity:IsPlayer()) then return false end -- Is the entity a player? We dont wanna burn players, if you want to burn them, remove this line. if (tr.Entity:IsWorld()) then return false end -- Is the entity an world entity? We dont wanna ruin the map. if ( CLIENT ) then return true end tr.Entity:Extinguish() -- Extinguish the fire on the entity, tr.Entity:Ignite( 60, 0 ) -- then add a new one for 60 seconds. return true end |
| Output | N/A |
Additional Notes
- Returning true shows the tracer beam, returning false hides it.
- Doesn't seem to be called on the client side in single-player mode, for whatever reason.
