Env bubbles: Difference between revisions
Jump to navigation
Jump to search
In code, it is represented by the
(caption) |
(Cleanup) |
||
| Line 1: | Line 1: | ||
[[File:Env bubbles.jpg|thumb|right|280px|env_bubbles in game, with density set to 35 and frequency set to 20]] | |||
{{base brush|env_bubbles}} | |||
==Entity Description== | ==Entity Description== | ||
| Line 10: | Line 8: | ||
Although env_bubbles is obviously intended for use in water, it can be used outside of water if such an effect is desired. | Although env_bubbles is obviously intended for use in water, it can be used outside of water if such an effect is desired. | ||
{{ | ==Availability== | ||
{{in game|brush}} {{game-base}} | |||
{{code class|CBubbling|effects.cpp}} | |||
{{ | |||
==Keyvalues== | ==Keyvalues== | ||
{{KV|Bubble density|integer|Bubble Count in Volume}} | |||
{{KV|Bubble frequency|integer|Bubble emission frequency, in bubbles per second.}} | |||
{{KV|Speed of Current|integer|The speed of the water current in the volume, used to move the bubbles.}} | |||
{{KV Targetname}} | |||
{{KV Parentname}} | |||
==Flags== | ==Flags== | ||
| Line 30: | Line 24: | ||
==Inputs== | ==Inputs== | ||
{{IO|Activate|Activates the bubbles.}} | |||
{{IO|Deactivate|Deactivates the bubbles.}} | |||
{{IO|Toggle|Toggles the bubbles on and off.}} | |||
{{IO|SetDensity|Sets the bubble density.|param=integer}} | |||
{{IO|SetFrequency|Sets bubble emission rate in bubbles per second.|param=integer}} | |||
{{IO|SetCurrent|Sets current speed in inches per second.|param=integer}} | |||
{{I Targetname}} | |||
{{I Parentname}} | |||
==Outputs== | ==Outputs== | ||
{{O Targetname}} | |||
{{sfx_brush}} | |||
Revision as of 00:59, 17 June 2011
Entity Description
An entity used to create a volume in which to spawn bubbles, which rise upward. The number and frequency of bubbles can be adjusted.
Although env_bubbles is obviously intended for use in water, it can be used outside of water if such an effect is desired.
Availability
Template:In game Template:Game-base
In code, it is represented by theCBubblingclass, defined in theeffects.cppfile.
Keyvalues
- Bubble frequency ([todo internal name (i)]) <integer>
- Bubble emission frequency, in bubbles per second.
- Speed of Current ([todo internal name (i)]) <integer>
- The speed of the water current in the volume, used to move the bubbles.
- 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
Parentname:
- Parent (parentname) <targetname>
- Specifies a movement parent. An entity will maintain its initial offset from its parent. An attachment point can be added to the end of the name, separated by a comma.
Flags
- 1 : Start Off
Inputs
- Activate
- Activates the bubbles.
- Deactivate
- Deactivates the bubbles.
- Toggle
- Toggles the bubbles on and off.
- SetDensity <integer>
- Sets the bubble density.
- SetFrequency <integer>
- Sets bubble emission rate in bubbles per second.
- SetCurrent <integer>
- Sets current speed in inches per second.
Parentname:
- SetParent <string>
- Move with this entity. See Entity Hierarchy (parenting).
- SetParentAttachment <string>
- Change this entity to attach to a specific attachment point on its parent. The entity will teleport so that the position of its root bone matches that of the attachment. Entities must be parented before being sent this input.
- SetParentAttachmentMaintainOffset <string>
- As above, but without teleporting. The entity retains its position relative to the attachment at the time of the input being received.
- ClearParent
- Removes this entity from the the movement hierarchy, leaving it free to move independently.