env_terrainmorph
... 
This entity is Obsolete. Its use is discouraged, and it may only exist/function in older engine branches.
Animated example of several env_terrainmorphs in the E3 tech demo.
env_terrainmorph is a point entity available in the Half-Life 2 series. It dynamically morphs displacements by pulling vertices along a normal, similar to the Paint Geometry tool in Hammer.
Place this entity the desired distance from a displacement surface and set Angles (manually, with SmartEdit turned off and three angle values in place, e.g. 90 0 0) to the normal along which you want to pull the vertices of the surface.
Note:This entity has been removed as of Source 2007, and is only available in Source 2006.
Bug:The collision hull will not be updated. See Morphing Terrain Issues to fix the problem.Contents
Keyvalues
- Start Radius <integer>
- Radius of the effect when morphing begins. Only this value is used
- Goal Radius <integer>
- Radius of the effect at the end of morphing. The radius of this effect will change from Start Radius to Goal Radius over the duration of this effect. Ignored if the Instant flag is set.
- Duration <integer>
- The morph will take place over this period of time (seconds). Ignored if the Instant flag is set.
- Displacement Fraction <integer>
- If set to
1, the terrain surface will be pulled exactly to this entity's position. If set to0.5, the surface will be pulled exactly half way to this entity's position. If set to2, the surface will be pulled to an imaginary point twice as far away as this entity. (Any fraction value greater than1.0will result in clipping. The surface cannot be pulled beyond this entity's position and any vertices attempting will clip to this entity's position. You may use this feature to create mesas.)
Targetname:
- Name
(targetname)<string> - The targetname that other entities refer to this entity by.
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 : Instant
- If set, the morph will take place instantly instead of over time.
Inputs
BeginMorph- Begin terrain morph
Base:
AddContext<string>- Adds to the entity's list of response contexts. See Context.
AddOutput<string>- Assigns a new keyvalue/output on this entity. For keyvalues, some rely on extra necessary code to be ran and won't work if its simply just changed through this input. There is a strict format that must be followed:
// Format of changing KeyValues: "AddOutput [key] [value]"
//// Raw text:
"OnUser1" "!self,AddOutput,targetname new_name"
// Format of adding an Output: "AddOutput {targetname}:{inputname}:{parameter}:{delay}:{max times to fire, -1 means infinite}"
//// Raw text:
"OnUser1" "!self,AddOutput,OnUser1:SetParent:!activator:0.0:-1"
// Arguments can be left blank, but the empty blank should still be contained.
//// Raw text:
"OnUser1" "!self,AddOutput,OnUser1:ClearParent::0.0:-1"
|
ClearContext- Removes all contexts from this entity's list.
ClearParent- Removes this entity from the the movement hierarchy, leaving it free to move independently.
FireUser1toFireUser4- Fires the respective
OnUseroutputs; see User Inputs and Outputs.
Kill- Removes this entity and any entities parented to it from the world.
KillHierarchy- Functions the same as
Kill, although this entity and any entities parented to it are killed on the same frame, being marginally faster thanKillinput.
RemoveContext<string>- Remove a context from this entity's list. The name should match the key of an existing context.
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.
DispatchResponse<string> !FGD- Dispatches a response to the entity. See Response and Concept.
DispatchEffect<string> (removed since
) !FGD- Dispatches a special effect from the entity's origin; see also List of Client Effects. Replaced by the particle system since .
RunScriptFile<script> (in all games since
) (also in 
)- Execute a VScript file from disk, without file extension. The script contents are merged with the script scope of the receiving entity.
RunScriptCode<string> (in all games since) (also in )- Execute a string of VScript source code in the scope of the entity receiving the input. String quotation may be needed when fired via console. Bug:In Hammer, using string arguments will corrupt the VMF file's structure, making the file unviewable for the next Hammer session.Fix:Remove the string argument manually with a text editor.Note: Backtick characters ` are replaced with quotation marks at runtime, allowing quotation marks to be used when normally not possible.
CallScriptFunction<string> (in all games since) (also in ) !FGD- Calls a VScript function defined in the scope of the receiving entity.
TerminateScriptScope(only in) !FGD- Destroys the script scope of the receving entity.
SetLocalOrigin<coordinates> (in all games since
) !FGD- Send this entity to a spot in the map. If the entity is parented to something, it will be offset from the parent by this amount.
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.
Outputs
Targetname:
OnUser1toOnUser4- These outputs each fire in response to the firing of the like-numbered
FireUser1toFireUser4Input; see User Inputs and Outputs.
OnKilled(only in)- This output fires when the entity is killed and removed from the game.
