Garry's Mod Wiki

Home / GM:PlayerUse

GM:PlayerUse

  boolean GM:PlayerUse( Player ply, Entity ent )
Search Github

Description

Triggered when the player presses use on an object. Continuously runs until USE is released but will not activate other Entities until the USE key is released; dependent on activation type of the Entity.

Arguments

1 Player ply
The player pressing the "use" key.
2 Entity ent
The entity which the player is looking at / activating USE on.

Returns

1 boolean
Return false if the player is not allowed to USE the entity.

Do not return true if using a hook, otherwise other mods may not get a chance to block a player's use.

Example

The arguments will continue to be output as long as the user holds their USE key. If the user activates one object, say a door, and looks at a different object, say a different door, then the print statement will reflect the new Entity, however even when true is returned the new Entity will not be activated until the user lets go of USE and depresses it once again; this is dependent on the USE TYPE of the Entity.

hook.Add( "PlayerUse", "some_unique_name2", function( ply, ent ) print( ply, ent ) end )
Output: After holding it for a VERY brief moment looking at one door in a way that I would look at the other door once the first opens.
Player [1][Example_User_Name] Entity [369][func_door_rotating] Player [1][Example_User_Name] Entity [369][func_door_rotating] Player [1][Example_User_Name] Entity [368][func_door_rotating] Player [1][Example_User_Name] Entity [368][func_door_rotating]

Example

Prevent users from using the ammo cache on the back of a Jeep.

hook.Add( "PlayerUse", "some_unique_name", function( ply, ent ) if ( !IsValid( ent ) or !ent:IsVehicle() ) then return end if ( ply:GetEyeTrace().HitGroup == 5 ) then return false end end )

Account Management

Special Pages

Wiki List