Keyframe rope: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
mNo edit summary
m (clean up, replaced: {{ModernTip| → {{tip|, {{ModernNote| → {{note| (2))
Line 1: Line 1:
{{Langsp}}It is an entity that marks a point in a [[Cables and Ropes|rope]]. This entity can be shown as <code>keyframe_rope</code> or <code>move_rope</code>, but the two are completely identical in code and interchangable, hence why they are grouped together in this article.
{{Langsp}}It is an entity that marks a point in a [[Cables and Ropes|rope]]. This entity can be shown as <code>keyframe_rope</code> or <code>move_rope</code>, but the two are completely identical in code and interchangable, hence why they are grouped together in this article.
{{ModernTip|Holding {{key|Shift}} while moving a properly named keyframe_rope will create a new keyframe_rope entity that is automatically connected to the previous keyframe. Also, deleting a keyframe_rope within a connected series will update the other entities to re-connect to the next entity in the series.}}
{{tip|Holding {{key|Shift}} while moving a properly named keyframe_rope will create a new keyframe_rope entity that is automatically connected to the previous keyframe. Also, deleting a keyframe_rope within a connected series will update the other entities to re-connect to the next entity in the series.}}
{{ModernNote|In {{tf2}} and {{csgo}}, this entity will automatically have festive lights applied to its model during the winter holiday season. These lights are purely cosmetic and do not emit [[Lighting|light]].  
{{note|In {{tf2}} and {{csgo}}, this entity will automatically have festive lights applied to its model during the winter holiday season. These lights are purely cosmetic and do not emit [[Lighting|light]].  
  This can be disabled in {{tf2}} via [[tf_gamerules]].}}
  This can be disabled in {{tf2}} via [[tf_gamerules]].}}
:{{ModernTodo|See if this can also be disabled in {{csgo}}}}
:{{ModernTodo|See if this can also be disabled in {{csgo}}}}
Line 11: Line 11:
:* 1 : Catmull-Rom Spline
:* 1 : Catmull-Rom Spline
:* 2 : Rope
:* 2 : Rope
{{ModernNote|This is only in the FGD for move_rope, but is functional on both entities.}}
{{note|This is only in the FGD for move_rope, but is functional on both entities.}}
{{Note|This keyvalue is shown, but is locked in all games with {{tsha|4.1}} installed}}
{{Note|This keyvalue is shown, but is locked in all games with {{tsha|4.1}} installed}}
{{KV|UseWind|since=AS|nofgd=1|boolean|When set to yes, the rope sways with the settings specified in the env_wind entity. Replaces "Disable Wind" in games post Alien Swarm.}}
{{KV|UseWind|since=AS|nofgd=1|boolean|When set to yes, the rope sways with the settings specified in the env_wind entity. Replaces "Disable Wind" in games post Alien Swarm.}}

Revision as of 00:13, 4 January 2024

English (en)中文 (zh)Translate (Translate)

It is an entity that marks a point in a rope. This entity can be shown as keyframe_rope or move_rope, but the two are completely identical in code and interchangable, hence why they are grouped together in this article.

Tip.pngTip:Holding Shift while moving a properly named keyframe_rope will create a new keyframe_rope entity that is automatically connected to the previous keyframe. Also, deleting a keyframe_rope within a connected series will update the other entities to re-connect to the next entity in the series.
Note.pngNote:In Team Fortress 2 and Counter-Strike: Global Offensive, this entity will automatically have festive lights applied to its model during the winter holiday season. These lights are purely cosmetic and do not emit light. This can be disabled in Team Fortress 2 via tf_gamerules.
Template:ModernTodo


Keyvalues

Position Interpolator ([todo internal name (i)]) <choices> !FGD
Curve Type. Currently only type 2 (Rope) is fully supported.
  • 0 : Linear
  • 1 : Catmull-Rom Spline
  • 2 : Rope
Note.pngNote:This is only in the FGD for move_rope, but is functional on both entities.
Note.pngNote:This keyvalue is shown, but is locked in all games with TeamSpen's Hammer Addons TeamSpen's Hammer Addons installed
UseWind ([todo internal name (i)]) <boolean> (in all games since Alien Swarm) !FGD
When set to yes, the rope sways with the settings specified in the env_wind entity. Replaces "Disable Wind" in games post Alien Swarm.
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

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.
KeyFrame:
Next KeyFrame (NextKey) <targetname>
Name of the next keyframe along this keyframe path.
Speed (units per second) (MoveSpeed) <integer>
KeyFrame moving speed.

Template:KV RopekeyFrame

Flags

Template:Fl RopekeyFrame

Inputs

Parentname:
SetParent <stringRedirectInput/string>
Move with this entity. See Entity Hierarchy (parenting).
SetParentAttachment <stringRedirectInput/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 <stringRedirectInput/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.

Template:I RopeKeyframe

Outputs