Point angularvelocitysensor: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (Robot: fixing template case.)
(Cleanup)
Line 1: Line 1:
{{wrongtitle|title=point_angularvelocitysensor}}
{{base point|point_angularvelocitysensor}} It detects whether another entity's angular velocity meets or exceeds a threshold value.  
{{base_point}}
 
==Entity Description==
An entity that detects whether another entity's angular velocity meets or exceeds a threshold value.  


{{in code|class=class_c_point_angular_velocity_sensor.html CPointAngularVelocitySensor|file=_point_angular_velocity_sensor_8cpp-source.html PointAngularVelocitySensor.cpp}}
{{in code|class=class_c_point_angular_velocity_sensor.html CPointAngularVelocitySensor|file=_point_angular_velocity_sensor_8cpp-source.html PointAngularVelocitySensor.cpp}}


==Keyvalues==
== Keyvalues ==
*{{KV Targetname}}
{{KV|Target Entity Name|target_destination|Name of the entity whose angular velocity will be sensed.}}
*'''target'''
{{KV|Threshold Velocity|float|The threshold angular velocity to compare against, in degrees per second.}}
:<target_destination> Name of the entity whose angular velocity will be sensed.
{{KV|Fire Interval|float|Angular velocity must cross the threshold for at least this long to fire.}}
*'''threshold'''
{{KV|Axis|vecline}}
:<float> The threshold angular velocity to compare against, in degrees per second.
{{KV|Use Axis Helper|boolean|Use axis helper to determine rotation values (clockwise/counter-clockwise).}}
* '''{{EP1 add|axis}}'''
{{KV Targetname}}
: <vecline> Axis
* '''{{EP1 add|usehelper}}'''
: {{boolean}} Use axis helper to determine rotation values (clockwise/counter-clockwise).


==Inputs==
== Inputs ==
*{{I Targetname}}
{{IO|Test|Checks to see if the Target Entity's angular velocity meets or exceeds the Threshold Velocity, firing either the <code>OnGreaterThan</code>OrEqualTo or <code>OnLessThan</code> output based on the result.}}
*'''Test'''
{{IO|TestWithInterval|Checks to see if the Target Entity's angular velocity meets or exceeds the Threshold Velocity. Once the Fire Interval expires, fires the appropriate test result output if the result is stable throughout the Fire Interval.}}
:Checks to see whether the Target Entity's angular velocity meets or exceeds the Threshold Velocity, firing either the '''OnGreaterThanOrEqualTo''' or '''OnLessThan''' output based on the result.
{{I Targetname}}
*'''{{EP2 add|TestWithInterval}}'''
:Checks to see if the Target Entity's angular velocity meets or exceeds the Threshold Velocity. Once the Fire Interval expires, fires the appropriate test result output if the result is stable throughout the Fire Interval.


==Outputs==
== Outputs ==
*{{O Targetname}}
{{IO|AngularVelocity|Fired when the Target's Angular Velocity changes, passing the new magnitude of the angular velocity.|param=float}}
*'''AngularVelocity <float>'''
{{IO|OnGreaterThan|Fired when the Target Entity goes from slower than the threshold angular velocity to faster than the threshold angular velocity.}}
:Fired when the Target's Angular Velocity changes, passing the new magnitude of the angular velocity.
{{IO|OnGreaterThanOrEqualTo|Fired when the Target Entity goes from slower than the threshold angular velocity to faster than the threshold angular velocity.}}
*'''OnGreaterThanOrEqualTo'''
{{IO|OnLessThan|Fired when the Target Entity goes from faster than the threshold angular velocity to slower than the threshold angular velocity.}}
:Fired when the Target Entity goes from slower than the threshold angular velocity to faster than the threshold angular velocity.
{{IO|OnLessThanOrEqualTo|Fired when the Target Entity goes from faster than the threshold angular velocity to slower than the threshold angular velocity.}}
*'''OnLessThan'''
{{IO|OnEqualTo|Fired when the Target Entity reaches the threshold angular velocity from a different velocity.}}
:Fired when the Target Entity goes from faster than the threshold angular velocity to slower than the threshold angular velocity.
{{O Targetname}}
*'''OnLessThanOrEqualTo'''
:Fired when the Target Entity goes from faster than the threshold angular velocity to slower than the threshold angular velocity.
*'''OnEqualTo'''
:Fired when the Target Entity reaches the threshold angular velocity from a different velocity.

Revision as of 03:30, 28 July 2011

Template:Base point It detects whether another entity's angular velocity meets or exceeds a threshold value.

Template:In code

Keyvalues

Target Entity Name ([todo internal name (i)]) <targetname>
Name of the entity whose angular velocity will be sensed.
Threshold Velocity ([todo internal name (i)]) <float>
The threshold angular velocity to compare against, in degrees per second.
Fire Interval ([todo internal name (i)]) <float>
Angular velocity must cross the threshold for at least this long to fire.
Axis ([todo internal name (i)]) <vector>
Use Axis Helper ([todo internal name (i)]) <boolean>
Use axis helper to determine rotation values (clockwise/counter-clockwise).
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

Inputs

Test
Checks to see if the Target Entity's angular velocity meets or exceeds the Threshold Velocity, firing either the OnGreaterThanOrEqualTo or OnLessThan output based on the result.
TestWithInterval
Checks to see if the Target Entity's angular velocity meets or exceeds the Threshold Velocity. Once the Fire Interval expires, fires the appropriate test result output if the result is stable throughout the Fire Interval.


Outputs

AngularVelocity <floatRedirectInput/float>
Fired when the Target's Angular Velocity changes, passing the new magnitude of the angular velocity.
OnGreaterThan
Fired when the Target Entity goes from slower than the threshold angular velocity to faster than the threshold angular velocity.
OnGreaterThanOrEqualTo
Fired when the Target Entity goes from slower than the threshold angular velocity to faster than the threshold angular velocity.
OnLessThan
Fired when the Target Entity goes from faster than the threshold angular velocity to slower than the threshold angular velocity.
OnLessThanOrEqualTo
Fired when the Target Entity goes from faster than the threshold angular velocity to slower than the threshold angular velocity.
OnEqualTo
Fired when the Target Entity reaches the threshold angular velocity from a different velocity.