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

point_playermoveconstraint

From Valve Developer Community
Jump to navigation Jump to search
Underlinked - Logo.png
This article needs more Wikipedia icon links to other articles to help Wikipedia icon integrate it into the encyclopedia. Please help improve this article by adding links Wikipedia icon that are relevant to the context within the existing text.
January 2024
English (en)Translate (Translate)
Class hierarchy
CPointPlayerMoveConstraint
CBaseEntity
point_playermoveconstraint.cpp

point_playermoveconstraint is a point entity available in all Source Source games. When given theTurnOninput, it constrains any players already within a set radius around itself, then slowing them down when they get close to the edge of the radius.

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

Radius (radius) <float>
Radius to find players to constrain. (max 16384)
Note.pngNote:Changing this via AddOutput is not supported.
When this entity spawns, this value is squared, saved elsewhere, and used for the purposes of checking when to stop constraining the player and fire the output.
Constraint Width (width) <float>
Width of the constraint edge. This is the distance in which to start slowing players down as they approach the edge of the radius.
Speed Factor (speedfactor) <float>
Factor applied to the player's max speed as they approach the radius edge.

Inputs

TurnOn
Start constraining any players already within the radius.
TurnOff
Stop constraining any players previously constrained.

Outputs

OnConstraintBroken
!activator = this entity
!caller = the player that broke through the constraint
Fired when a player breaks through the constraint.

See also