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

Env funnel: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(raw; needs cleanup)
 
 
(30 intermediate revisions by 19 users not shown)
Line 1: Line 1:
{{cleanup}}
{{languageBar}}
env_funnel
{{tabs|env_funnel|goldsrc=1|source=1|main=source}}
{{Distinguish|prop_tractor_beam|desc1= Sometimes shortened to funnel, from [[Portal 2]]}}
{{CD|CEnvFunnel|file1=effects.cpp}}
{{this is a|point entity|name=env_funnel}} It creates many sprites which move toward a point (or from a point). This effect is used in {{ent|c1a0e}}{{hl1}}. The sprite is hardcoded to be <code>sprites/flare6.vmt</code>, but some games are missing this texture.


HL1 Legacy: Large Portal Funnel
This entity must be activated with the {{ent|Use}} input. After it's <code>Use</code>d, it is deleted from the map.


KEYS
[[File:Funnel_animation.gif‎|thumb|right]]


Name targetname <target_source> The name that other entities refer to this entity by.
== Flags ==
{{fl|1|Reverse|Funnel repels sprites instead of attracting them.}}


Parent parentname <target_destination> The name of this entity's parent in the movement hierarchy. Entities with parents move with their parent.
== Keyvalues ==
{{KV Targetname}}


spawnflags spawnflags <flags>
== Inputs ==
 
{{I|[[Use]]|nofgd=1|Activates the entity}}
 
INPUTS
 
Kill Removes this entity from the world.
 
KillHierarchy Removes this entity and all its children from the world.
 
AddOutput <string> Adds an entity I/O connection to this entity. Format: <output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire (-1 == infinite)>. Very dangerous, use with care.
 
FireUser1 Causes this entity's OnUser1 output to be fired.
 
FireUser2 Causes this entity's OnUser2 output to be fired.
 
FireUser3 Causes this entity's OnUser3 output to be fired.
 
FireUser4 Causes this entity's OnUser4 output to be fired.
 
SetParent <string> Changes the entity's parent in the movement hierarchy.
 
SetParentAttachment <string> Change this entity to attach to a specific attachment point on its parent. Entities must be parented before being sent this input. The parameter passed in should be the name of the attachment.
 
ClearParent Removes this entity from the the movement hierarchy, leaving it free to move independently.
 
 
OUTPUTS
 
OnUser1 Fired in response to FireUser1 input.
 
OnUser2 Fired in response to FireUser2 input.
 
OnUser3 Fired in response to FireUser3 input.
 
OnUser4 Fired in response to FireUser4 input.

Latest revision as of 11:27, 29 October 2025

English (en)中文 (zh)Translate (Translate)
Not to be confused with prop_tractor_beam (Sometimes shortened to funnel, from Portal 2).
C++ Class hierarchy
CEnvFunnel
CBaseEntity
C++ effects.cpp

env_funnel is a point entity available in all Source Source games. It creates many sprites which move toward a point (or from a point). This effect is used in c1a0eHalf-Life. The sprite is hardcoded to be sprites/flare6.vmt, but some games are missing this texture.

This entity must be activated with the Use input. After it's Used, it is deleted from the map.

Funnel animation.gif

Flags

Reverse : [1]
Funnel repels sprites instead of attracting them.

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

Inputs

Use  !FGD
Activates the entity