Env terrainmorph

From Valve Developer Community

The title given to this article is incorrect due to technical limitations. The correct title is env_terrainmorph.

Table of contents

1 Entity Description

[edit]

Entity Description

An entity which dynamically morphs terrain by pulling vertices along a normal. (Collision hull is not updated!)

Place this entity the desired distance from a terrain surface and set Angles ( To do: Non-FGD keyvalue? It isn't in the FGD, so please clearify.) to the normal along which you want to pull the vertices of the surface.

[edit]

Keyvalues

targetname <target_source>

Defines the name that other entities refer to this entity by.

hammerid [Episode Two Update]

<integer readonly> This id is used for debugging purposes in Hammer.

parentname <target_destination>

Specifies the targetname of this entity's Parent in a movement hierarchy. Child entities move with their Parent.

startradius

<integer> Radius of the effect when morphing begins. Only this value is used if the effect is flagged to occur instantly.

goalradius

<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. This value is ignored if the effect is flagged to occur instantly.

duration

<integer> The morph will take place over this period of time (seconds). Ignored if the Instant flag is set.

fraction

<integer> Displacement Fraction - If set to 1, the terrain surface will be pulled exactly to this entity's position. If set to 0.5, the surface will be pulled exactly half way to this entity's position. If set to 2, the surface will be pulled to an imaginary point twice as far away as this entity. (Any fraction value greater than 1.0 will result in clipping. The surface cannot be pulled beyond this entity's position and any vertices attemping will clip to this entity's position. You may use this feature to create mesas.)

[edit]

Flags

1 : Instant

If set, the morph will take place instantly instead of over time.

[edit]

Inputs

Kill

Removes this entity from the world.

KillHierarchy

Removes this entity and all its children from the world.

AddOutput <string>

Evaluates a keyvalue/output on this entity. It can be potentially very dangerous, use with care.

Format: <key> <value>

Format: <output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire (-1 == infinite)>

FireUser1-4

Causes this entity's OnUser1-4 outputs to be fired. See User Inputs and Outputs.

SetParent <target_destination>

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.

SetParentAttachmentMaintainOffset <string> [Episode One Update]

Change this entity to attach to a specific attachment point on it's parent. Entities must be parented before being sent this input. The parameter passed in should be the name of the attachment. The entity will maintain it's position relative to the Parent's Origin and Angles at the time it is attached.