Entity.WaterLevel
From GMod Wiki
Revision as of 00:53, 27 March 2010 by Unrealomega (Talk | contribs)
| Function | |
| Syntax | Entity:WaterLevel( ) |
| Description: | |
| Returns the amount of water level an entity has. | |
| Returns: | Number |
| In Object: | Entity |
| Realm: |
 |
| BBCode Link: | [b][url=http://wiki.garrysmod.com/?title=Entity.WaterLevel]Entity.WaterLevel [img]http://wiki.garrysmod.com/favicon.ico[/img][/url][/b] |
Examples
| Description | Extinguish fires when in water. |
|---|---|
| Used on |  |
| Code | if ( ent:WaterLevel() > 0 and ent:IsOnFire() ) then ent:Extinguish(); end |
| Output | This will make an entity stop burning if it falls in water. This is already included in Garry's Mod. |
Return Values
- 0 = Not in water
- 1 = Feet in water
- 2 = Majority of body in water
- 3 = Fully submerged
Additional Notes
- It appears that this function only works properly with players. Other entities seem to register either a 0, 1(If below half), and 3(If above half); 2 does not appear to be returned.
