Garry's Mod Wiki

Home / GM:FindUseEntity

GM:FindUseEntity

  Entity GM:FindUseEntity( Player ply, Entity defaultEnt )
View Source Search Github

Description

This hook polls the entity the player use action should be applied to.

Use Player:GetUseEntity to get the final result of this hook.

The default behavior of this hook is in CBasePlayer::FindUseEntity. Despite CBasePlayer::FindUseEntity being defined shared, it is only called serverside in practice, so this hook will be only called serverside, as well. It is possible for modules to call it clientside, so the Lua code should still be treated as shared.

Arguments

1 Player ply
The player who initiated the use action.
2 Entity defaultEnt
The entity that was chosen by the engine.

Returns

1 Entity
The entity to use instead of default entity

Account Management

Special Pages

Wiki List