Keyframe rope

From Valve Developer Community

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

Table of contents

1 Entity Description

[edit]

Entity Description

A node entity that marks a point in a rope. The first node in the rope should be a move_rope entity, followed by 1 or more keyframe_ropes.

[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.

NextKey

<target_destination> Name of the next keyframe along this keyframe path. Can also be a move_rope entity.

MoveSpeed

<integer> Speed (units per second)

mindxlevel

<choices> Minimum DX Level

Literal Value	Description
0	default (lowest)
70	dx7

maxdxlevel

<choices> Maximum DX Level

Literal Value	Description
0	default (lowest)
60	dx6

Slack

<integer> How much extra length the rope has (by default it has the length between its two endpoints in the editor).

Type

Literal Value	Description
0	Rope
1	Semi-rigid
2	Rigid

Subdiv

<integer> Number of subdivisions between each rope segment. Maximum value is 8. Higher values make smoother ropes, but are slower to render.

Barbed

<boolean> Test effect that makes the rope look sharper and more barbed, like a chain.

Width

<integer> Width of the rope.

TextureScale

<float> This changes the texture resolution. The default resolution is 4 pixels per inch. Larger values stretch the texture and smaller values scrunch it up.

Collide

<boolean> If set, the rope collides with world. Ropes never collide with anything else.

Dangling

<boolean> If set, the rope starts out detached from its target endpoint.

Breakable

<boolean> If set, the rope can be detached from either endpoint when shot.

Note: If collide with world is set, the rope will not appear to break if the endpoint touches world geometry. This includes touching vertices and edges of brushes as well as being placed inside them.

RopeMaterial

<material> The material to use when rendering the rope. Suggested material: cable/cable.vmt

[edit]

Flags

1 : Auto Resize — allows the rope to "stretch" as the entity moves.

[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.