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

Env bubbles: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (Robot: fixing template case.)
No edit summary
 
(36 intermediate revisions by 20 users not shown)
Line 1: Line 1:
{{wrongtitle|title=env_bubbles}}
<!-- 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|Env bubbles}}{{tabs|env_bubbles|goldsrc=1|source=1|main=source}}
{{base_brush}}
{{CD|CBubbling|file1=effects.cpp}}
[[File:Env bubbles.gif|frame|right|280px|<code>env_bubbles</code> in game, with density set to 6 and frequency set to 2.]]
{{this is a|brush entity|name=env_bubbles}} It is used to create a volume in which to spawn rising bubbles. The number and frequency of bubbles can be adjusted.


==Entity Description==
<code>env_bubbles</code> is obviously intended for use in water, but it can be used outside of water if such an effect is desired.
An entity used to create a volume in which to spawn bubbles.


{{sfx_brush}}
{{note|Tying a [[Triggers#Level design|toolstrigger]] brush to this entity will result in the entity being rendered in-game as a raw brush of said material, unless VBSP was compiled with {{code|-nodrawtriggers}}. It should be set to Nodraw or Invisible instead.}}
{{Note|Used bubble sprite: <code>sprites/bubble.vmt</code>}}
{{note|In order to make it work in {{portal2|1}}, the bubble sprite material (<code>sprites/bubble.vmt</code>) and texture (<code>sprites/bubble.vtf</code>) must be located in the /material/sprites folder and the [[TeamSpen's Hammer Addons]] installed, or at least its portal2.fgd located in the /Portal 2/bin folder.}}
__NOTOC__
==Keyvalues==
{{KV|Bubble density|intn=density|integer|Bubble Count in Volume.}}
{{KV|Bubble frequency|intn=frequency|integer|Bubble emission frequency, in bubbles per second, values include negative numbers E.G. -10}}
{{KV|Speed of Current|intn=current|integer|The speed of the water current in the volume, used to move the bubbles.}}


==Availability==
==Inputs==
{{in game|brush}} {{game-base}}.
{{I|Activate|Activates the bubbles.}}
In code it is represented by class CBubbling, defined in effects.cpp.
{{I|Deactivate|Deactivates the bubbles.}}
 
{{I|Toggle|Toggles the bubbles on and off.}}
==Keyvalues==
{{I|SetDensity|Sets the bubble density.|param=integer}}
*{{kv targetname}}
{{I|SetFrequency|Sets bubble emission rate in bubbles per second.|param=integer}}
*{{KV Parentname}}
{{I|SetCurrent|Sets current speed in inches per second.|param=integer}}
*'''density'''
:<integer> Bubble Count in Volume
*'''frequency'''
:<integer> Bubble emission frequency, in bubbles per second.
*'''current'''
:<integer> The speed of the water current in the volume, in inches per second. Used to move the bubbles.


==Flags==
==Flags==
*1 : Start Off
{{fl|1|Start Off}}


==Inputs==
==See also==
*{{I Targetname}}
*{{ent|env_embers}} - A similar entity.
*{{I Parentname}}
*'''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.


==Outputs==
[[category:SFX_Brush_Entities]]
*{{o targetname}}

Latest revision as of 11:07, 1 November 2025

English (en)中文 (zh)Translate (Translate)
C++ Class hierarchy
CBubbling
↳CBaseEntity
C++ effects.cpp
env_bubbles in game, with density set to 6 and frequency set to 2.

env_bubbles is a brush entity available in all Source Source games. It is used to create a volume in which to spawn rising bubbles. The number and frequency of bubbles can be adjusted.

env_bubbles is obviously intended for use in water, but it can be used outside of water if such an effect is desired.

Note.pngNote:Tying a toolstrigger brush to this entity will result in the entity being rendered in-game as a raw brush of said material, unless VBSP was compiled with -nodrawtriggers. It should be set to Nodraw or Invisible instead.
Note.pngNote:Used bubble sprite: sprites/bubble.vmt
Note.pngNote:In order to make it work in Portal 2, the bubble sprite material (sprites/bubble.vmt) and texture (sprites/bubble.vtf) must be located in the /material/sprites folder and the TeamSpen's Hammer Addons installed, or at least its portal2.fgd located in the /Portal 2/bin folder.

Keyvalues

Bubble density (density) <integer>
Bubble Count in Volume.
Bubble frequency (frequency) <integer>
Bubble emission frequency, in bubbles per second, values include negative numbers E.G. -10
Speed of Current (current) <integer>
The speed of the water current in the volume, used to move the bubbles.

Inputs

Activate
Activates the bubbles.
Deactivate
Deactivates the bubbles.
Toggle
Toggles the bubbles on and off.
SetDensity <integerRedirectInput/integer>
Sets the bubble density.
SetFrequency <integerRedirectInput/integer>
Sets bubble emission rate in bubbles per second.
SetCurrent <integerRedirectInput/integer>
Sets current speed in inches per second.

Flags

Start Off : [1]

See also

Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Env_bubbles&oldid=491724"