Difference between revisions of "Point velocitysensor"
From Valve Developer Community
m (Wrong title template added) |
(Filled in this stub) |
||
| Line 1: | Line 1: | ||
{{wrongtitle|title=point_velocitysensor}} | {{wrongtitle|title=point_velocitysensor}} | ||
{{base_point}} | {{base_point}} | ||
| − | {{ | + | |
| + | ==Entity Description== | ||
| + | An entity that detects and outputs an entity's velocity. | ||
| + | |||
| + | ==Keyvalues== | ||
| + | *{{KV Targetname}} | ||
| + | *'''Target Entity Name''' | ||
| + | :<target_destination> Name of the entity whose velocity will be sensed. | ||
| + | *'''Measurement Axis''' | ||
| + | :<vecline> | ||
| + | *'''Start Enabled''' | ||
| + | : <choices> Whether or not to start enabled and active. | ||
| + | |||
| + | ==Inputs== | ||
| + | *{{I Targetname}} | ||
| + | *{{I EnableDisable}} | ||
| + | |||
| + | ==Outputs== | ||
| + | *{{O Targetname}} | ||
| + | *'''Velocity <float>''' | ||
| + | :Fired when the Target's Velocity changes, passing the new magnitude of the velocity. | ||
Revision as of 23:05, 30 May 2011
This is a point entity available in all Source games.
Contents
Entity Description
An entity that detects and outputs an entity's velocity.
Keyvalues
Targetname:
- Name (targetname)
<string> - The targetname that other entities refer to this entity by.
- Entity Scripts (vscripts)
<scriptlist>(New with Left 4 Dead 2) - Space delimited list of VScript files (without file extension) that are executed after all entities have spawned. The scripts are all executed in the same script scope, later ones overwriting any identical variables and functions.
- Script think function (thinkfunction)
<string>(New with Left 4 Dead 2) - Name of a function in this entity's script which will be called automatically every 100 milliseconds (ten times a second) for the duration of the script. It can be used to create timers or to simulate autonomous behavior. The return value (if present) will set the time until the next call.
Note:Try to avoid expensive operations in this function, as it may cause performance problems.
- Target Entity Name
- <target_destination> Name of the entity whose velocity will be sensed.
- Measurement Axis
- <vecline>
- Start Enabled
- <choices> Whether or not to start enabled and active.
Inputs
Targetname:
-
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 thanKill. -
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 means infinite> -
FireUser1toFireUser4 - Fire the
OnUseroutputs; see User Inputs and Outputs. -
Use!FGD - Same as a player invoking +use; may not do anything. Can also be invoked by creating an output that does not specify an input.
This input is not included in Valve's FGDs. -
RunScriptFile<script>(New with Left 4 Dead 2) - Execute a VScript file from disk, without file extension. The script contents are merged with the script scope of the receiving entity.
-
RunScriptCode<string>(New with Left 4 Dead 2) - 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 
, the code is executed in the script scope of the entity that fires the output, not the one receiving the input.
Warning: Never try to pass string parameters to a script function with this input. It will corrupt the VMF structure because of the nested quotation marks, which then must be removed manually with a text editor. -
CallScriptFunction<string>(New with Left 4 Dead 2) !FGD - Execute a VScript function in the scope of the receiving entity.
-
SetLocalOrigin<coordinates>(New with Alien Swarm) !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.
-
SetLocalAngles<angles>(New with Alien Swarm) !FGD - Set this entity's angles.
- EnableDisable:
-
Enable -
Disable - Enable/disable this entity from performing its task. It might also disappear from view.
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 the Left 4 Dead series) - This Output fires when the entity is killed and removed from the game.
- Velocity <float>
- Fired when the Target's Velocity changes, passing the new magnitude of the velocity.
