Entity.GetGroundEntity
From GMod Wiki
| Function | |
| Syntax | Entity:GetGroundEntity( ) |
| Description: | |
| Returns the entity that the entity is resting on top of. Make sure to use Entity:IsValid on the returned entity. If the returned entity isn't valid, the original entity wasn't sitting on anything. | |
| Returns: | Entity |
| In Object: | Entity |
| Realm: |
 |
| BBCode Link: | [b][url=http://wiki.garrysmod.com/?title=Entity.GetGroundEntity]Entity.GetGroundEntity [img]http://wiki.garrysmod.com/favicon.ico[/img][/url][/b] |
Examples
| Description | If a player falls on the world, kill them |
|---|---|
| Used on | |
| Code | function TheFloorIsLava( ply ) local ent = ply:GetGroundEntity() if ent:IsWorld() then ply:Kill() ply:ChatPrint( "The floor is lava!" ) end end hook.Add( "OnPlayerHitGround", "TheFloorIsLava", TheFloorIsLava) |
| Output | Kills a player if the object they fall on is the world. |
Additional Notes
- if it is sitting on the world it will return the world entity
- this only works with the player entity all other entities seem to just return NULL
