Env player surface trigger: Difference between revisions
Jump to navigation
Jump to search
Note:This entity is designed with single player in mind so might not work as expected in multiplayer games
Example:Used in 
d2_coast_11 to detect player touching the sand causing antlions to be spawned
No edit summary |
(position in the world irrelevant so it's logical entity) |
||
| Line 1: | Line 1: | ||
{{LanguageBar}} | {{LanguageBar}} | ||
{{CD|CEnvPlayerSurfaceTrigger|file1=env_player_surface_trigger.cpp}} | {{CD|CEnvPlayerSurfaceTrigger|file1=env_player_surface_trigger.cpp}} | ||
{{This is a| | {{This is a|logical entity|name=env_player_surface_trigger}} It monitors the material of the surface the player is standing on, and fires outputs whenever it changes to/from a specific material. | ||
{{note|This entity is designed with single player in mind so might not work as expected in multiplayer games}} | {{note|This entity is designed with single player in mind so might not work as expected in multiplayer games}} | ||
{{Example|Used in {{hl2}} <kbd>d2_coast_11</kbd> to detect player touching the sand causing [[npc_antlion|antlions]] to be spawned}} | {{Example|Used in {{hl2}} <kbd>d2_coast_11</kbd> to detect player touching the sand causing [[npc_antlion|antlions]] to be spawned}} | ||
Revision as of 04:26, 29 April 2025
 Class hierarchy
|
|---|
| CEnvPlayerSurfaceTrigger |
| env_player_surface_trigger.cpp
|
env_player_surface_trigger is a logical entity available in all 
Source games. It monitors the material of the surface the player is standing on, and fires outputs whenever it changes to/from a specific material.
Note:This entity is designed with single player in mind so might not work as expected in multiplayer gamesExample:Used in d2_coast_11 to detect player touching the sand causing antlions to be spawnedKeyvalues
- Name (targetname) <string>[ Edit ]
- The name that other entities refer to this entity by, via Inputs/Outputs or other keyvalues (e.g.
parentnameortarget).
Also displayed in Hammer's 2D views and Entity Report.See also: Generic Keyvalues, Inputs and Outputs available to all entities
- Game Material to Watch (gamematerial) <choices>
- The material to watch. When the player stands on/off this material, this entity's outputs will be fired.
Literal value Description 0 None (player's in the air) 67 Concrete 77 Metal 68 Dirt 86 Vent 71 Grate 84 Tile 83 Slosh 87 Wood 80 Computer 89 Glass 70 Flesh 73 Clip 79 Foliage 78 Sand
"Slosh" Type does not to work to detect players in volumetric water, only on solid surfaces marked with "water" or "slime" surface properties.
Inputs
- Enable
- Start watching the player's surface.
- Disable
- Stop watching the player's surface.
Outputs
- OnSurfaceChangedToTarget
- Fired when the player moves onto the specified game material.
- OnSurfaceChangedFromTarget
- Fired when the player moves off the specified game material.