Skip to main content

env_player_surface_trigger

Point Entity

An entity that monitors the material of the surface the player is standing on, and fires outputs whenever it changes to/from a specific material.

Keyvalues

  • Entity Scripts (vscripts) <ScriptList>
    Name(s) of script files that are executed after all entities have spawned.

  • Name (targetname) <TargetSource>
    The name that other entities refer to this entity by.

  • 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.

    • None (player's in the air) (0)
    • Concrete (67)
    • Metal (77)
    • Dirt (68)
    • Vent (86)
    • Grate (71)
    • Tile (84)
    • Slosh (83)
    • Wood (87)
    • Computer (80)
    • Glass (89)
    • Flesh (70)
    • Clip (73)
    • Foliage (79)
    • Sand (78)

Inputs

  • RunScriptFile <String>
    Load and execute a script file

  • RunScriptCode <String>
    Execute a fragment of script code

  • CallScriptFunction <String>
    Call a script function

  • CallPrivateScriptFunction <String>
    Calls a script function from this entity's private script scope.

  • CallGlobalScriptFunction <String>
    Calls a script function in the global script scope.

  • Kill <Void>
    Removes this entity from the world.

  • KillHierarchy <Void>
    Removes this entity and all its children from the world.

  • AddOutput <String>
    Adds an entity I/O connection to this entity. Parameter format: outputname>targetname>inputname>parameter>delay>max times to fire (-1 == infinite). Very dangerous, use with care.

  • FireUser1 <Void>
    Causes this entity's OnUser1 output to be fired.

  • FireUser2 <Void>
    Causes this entity's OnUser2 output to be fired.

  • FireUser3 <Void>
    Causes this entity's OnUser3 output to be fired.

  • FireUser4 <Void>
    Causes this entity's OnUser4 output to be fired.

  • Enable <Void>
    Start watching the player's surface.

  • Disable <Void>
    Stop watching the player's surface.

Outputs

  • OnUser1 <Void>
    Fired in response to FireUser1 input.

  • OnUser2 <Void>
    Fired in response to FireUser2 input.

  • OnUser3 <Void>
    Fired in response to FireUser3 input.

  • OnUser4 <Void>
    Fired in response to FireUser4 input.

  • OnKilled <Void>
    Fired when the entity is killed and removed from the game.

  • OnSurfaceChangedToTarget <Void>
    Fired when the player moves onto the specified game material.

  • OnSurfaceChangedFromTarget <Void>
    Fired when the player moves off the specified game material.