Func water analog: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(added Moving Water article link)
mNo edit summary
Line 1: Line 1:
{{wrongtitle|title=func_water_analog}}
{{wrongtitle|title=func_water_analog}}
==Entity Description==
==Entity Description==
A water brush entity that moves linearly along a given distance, in a given direction.
A water brush entity that moves linearly along a given distance, in a given direction.
Only two materials are known to render correctly across all systems, these are <code>nature/water_movingplane</code> and <code>nature/water_dx70</code>. This is ostensibly because of how the material effects on the more complex water shaders require static brushes, so they can optimize what's visible to the water surface. A moving water surface would break this effect, so therefore full water shaders are unusable on a moving surface.
Only two materials are known to render correctly across all systems, these are <code>nature/water_movingplane</code> and <code>nature/water_dx70</code>. This is ostensibly because of how the material effects on the more complex water shaders require static brushes, so they can optimize what's visible to the water surface. A moving water surface would break this effect, so therefore full water shaders are unusable on a moving surface.


Line 20: Line 22:
* '''stopsound'''
* '''stopsound'''
: <sound> Sound played when the water brush stops moving.
: <sound> Sound played when the water brush stops moving.
==Flags==
None.
==Inputs==
==Inputs==
* {{i targetname}}
* {{i targetname}}
Line 29: Line 35:
* '''SetPosition <float>'''
* '''SetPosition <float>'''
: Move the water brush to a specific position between 0.0 and 1.0, where 0 is the starting position and 1 is the starting position + (move direction * move distance).
: Move the water brush to a specific position between 0.0 and 1.0, where 0 is the starting position and 1 is the starting position + (move direction * move distance).
==Outputs==
==Outputs==
* {{o targetname}}
* {{o targetname}}
Line 35: Line 42:
* '''OnFullyClosed'''
* '''OnFullyClosed'''
: Fired when the water brush reaches the starting position.
: Fired when the water brush reaches the starting position.
==See Also==
==See Also==
* [[Moving Water]]
* [[Moving Water]]
[[Category:Entities]]
 
[[Category:Entities]][[Category:Brush Entities]]

Revision as of 13:44, 6 March 2006

Template:Wrongtitle

Entity Description

A water brush entity that moves linearly along a given distance, in a given direction.

Only two materials are known to render correctly across all systems, these are nature/water_movingplane and nature/water_dx70. This is ostensibly because of how the material effects on the more complex water shaders require static brushes, so they can optimize what's visible to the water surface. A moving water surface would break this effect, so therefore full water shaders are unusable on a moving surface.

Keyvalues

<angle> The direction the water will move, when told to 'Open'.
  • startposition
<float> Position of the water brush when spawned. The range is a value between 0.0 and 1.0, where 0 is the starting position and 1 is the starting position + (move direction * move distance).
  • speed
<integer> The speed that the water brush moves, in inches per second.
  • movedistance
<float> The distance from the starting point that the water brush should move, in inches.
  • startsound
<sound> Sound played when the water brush starts moving.
  • stopsound
<sound> Sound played when the water brush stops moving.

Flags

None.

Inputs

Move the water brush to the end position (starting position + (move direction * move distance)).
  • Close
Move the water brush to the starting position.
  • SetPosition <float>
Move the water brush to a specific position between 0.0 and 1.0, where 0 is the starting position and 1 is the starting position + (move direction * move distance).

Outputs

Fired when the water brush reaches the end position (starting position + (move direction * move distance)).
  • OnFullyClosed
Fired when the water brush reaches the starting position.

See Also