This article's documentation is for anything that uses the Source engine. Click here for more information.

Env splash: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (Robot: fixing template case.)
m (→‎Inputs: Substituted IO templates)
 
(15 intermediate revisions by 12 users not shown)
Line 1: Line 1:
{{TOC|left}}
<!-- When this page is updated to {{langsp}} or {{langsp}} instead of {{lang}}, please move {{this is a}} to the base page, as it is automatically translated. -->{{lang}}[[File:Env splash.png|300px|thumb|right]]
{{wrongtitle|title=env_splash}}
{{CD|CEnvSplash|file1=effects.cpp}}
{{base_point}}
{{this is a|point entity|name=env_splash}} It creates a generic splash effect like the one seen when bullets fire into water, or when the player enters water.
{{clr}}
__NOTOC__
== Entity description ==
==Keyvalues==
An entity that creates splash effects when triggered, normally at its origin.
{{KV Targetname}}
{{KV|Scale of the splash|intn=scale|float|Scale of the splash.}}


== Keyvalues ==
==Flags==
* {{KV Targetname}}
{{fl|1|Automatically find water surface|place entity above water - Make sure <code>[[%compilewater]]</code> is set!}}
* {{KV Angles}}
{{fl|2|Diminish with depth|diminished completely in 10 feet of water}}
* '''scale'''
: <float> Scale of the splash


== Flags ==
==Inputs==
* 1 : Automatically find water surface (place entity above water)
{{I|Splash|Create a splash effect.}}
: If this flag is set, the env_splash will trace down below itself to find the water surface on which to apply splashes. If this flag is cleared, the entity will use its own position as the origin.
* 2 : Diminish with depth (diminished completely in 10 feet of water)


== Inputs ==
== See Also ==
* {{I Targetname}}
* {{ent|info_particle_system}}
* '''Splash'''
: Create a splash effect.
 
== Outputs ==
* {{O Targetname}}
 
[[Category:Entities]]

Latest revision as of 10:54, 21 April 2025

English (en)Translate (Translate)
Env splash.png
C++ Class hierarchy
CEnvSplash
CPointEntity
CBaseEntity
C++ effects.cpp

env_splash is a point entity available in all Source Source games. It creates a generic splash effect like the one seen when bullets fire into water, or when the player enters water.

Keyvalues

Name (targetname) <string>[ Edit ]
The name that other entities refer to this entity by, via Inputs/Outputs or other keyvalues (e.g. parentname or target).
Also displayed in Hammer's 2D views and Entity Report.
See also:  Generic Keyvalues, Inputs and Outputs available to all entities

Scale of the splash (scale) <float>
Scale of the splash.

Flags

Automatically find water surface : [1]
place entity above water - Make sure %compilewater is set!
Diminish with depth : [2]
diminished completely in 10 feet of water

Inputs

Splash
Create a splash effect.

See Also