Momentary rot button: Difference between revisions
Jump to navigation
Jump to search
(Automatically toggles if ''returnspeed'' is 0.) |
m (typo & tidy) |
||
| Line 1: | Line 1: | ||
{{wrongtitle|title=momentary_rot_button}} | {{wrongtitle|title=momentary_rot_button}} | ||
==Entity | == Entity description == | ||
A [[brush entity]] that is designed to be used for rotating wheels, where the player can rotate them to arbitrary positions before stopping. | A [[brush entity]] that is designed to be used for rotating wheels, where the player can rotate them to arbitrary positions before stopping. | ||
==Keyvalues== | == Keyvalues == | ||
* {{kv targetname}} | * {{kv targetname}} | ||
* {{kv parentname}} | * {{kv parentname}} | ||
| Line 54: | Line 54: | ||
: <float> The minimum level of ambient light that hits this brush. | : <float> The minimum level of ambient light that hits this brush. | ||
* '''startposition''' | * '''startposition''' | ||
: <float> | : <float> Position when spawned. The value is a range between 0.0 and 1.0, where 0 is the unrotated position and 1 is the rotated position + 'Distance'. | ||
* '''startdirection''' | * '''startdirection''' | ||
: <choices> | : <choices> | ||
| Line 67: | Line 67: | ||
: {{boolean}} | : {{boolean}} | ||
==Flags== | == Flags == | ||
* 1 : Not Solid | * 1 : Not Solid | ||
* 32 : Toggle (Disable Auto Return) - Toggle the direction of the rotation each time it is pressed. If set, overrides the ''returnspeed'' keyvalue. (This entity automatically toggles if ''returnspeed'' is set to ''0''.) | * 32 : Toggle (Disable Auto Return) - Toggle the direction of the rotation each time it is pressed. If set, overrides the ''returnspeed'' keyvalue. (This entity automatically toggles if ''returnspeed'' is set to ''0''.) | ||
| Line 76: | Line 76: | ||
* 8192 : Jiggle when used while locked | * 8192 : Jiggle when used while locked | ||
==Inputs== | == Inputs == | ||
* {{i targetname}} | * {{i targetname}} | ||
* {{i renderfields}} | * {{i renderfields}} | ||
| Line 89: | Line 89: | ||
: Immediately teleport to a position. The parameter must be a value between 0 and 1, where 0 is the unrotated position and 1 is the rotated position + 'Distance'. | : Immediately teleport to a position. The parameter must be a value between 0 and 1, where 0 is the unrotated position and 1 is the rotated position + 'Distance'. | ||
==Outputs== | == Outputs == | ||
* {{o targetname}} | * {{o targetname}} | ||
* '''Position <integer>''' | * '''Position <integer>''' | ||
| Line 104: | Line 104: | ||
: Fired whenever the button reaches a goal position: i.e. when it becomes open, becomes closed, or reaches the point specified by a 'SetPosition' input. | : Fired whenever the button reaches a goal position: i.e. when it becomes open, becomes closed, or reaches the point specified by a 'SetPosition' input. | ||
==See | == See also == | ||
* [[func_button]] | * [[func_button]] | ||
* [[func_rot_button]] | * [[func_rot_button]] | ||
[[Category:Entities]][[Category:Brush Entities]] | [[Category:Entities]] | ||
[[Category:Brush Entities]] | |||
Revision as of 12:39, 5 February 2008
Entity description
A brush entity that is designed to be used for rotating wheels, where the player can rotate them to arbitrary positions before stopping.
Keyvalues
- Template:Kv targetname
- Template:Kv parentname
- Template:Kv origin
- Template:Kv angles
- Template:Kv renderfields
- speed
- <integer> The amount, in degrees, that the button turns per second.
- sounds
- <choices>
Literal Value Description 0 None 1 Big zap & Warmup 2 Access Denied 3 Access Granted 4 Quick Combolock 5 Power Deadbolt 1 6 Power Deadbolt 2 7 Plunger 8 Small zap 9 Keycard Sound 21 Squeaky 22 Squeaky Pneumatic 23 Ratchet Groan 24 Clean Ratchet 25 Gas Clunk
- distance
- <integer> The maximum amount, in degrees, that the button is allowed to rotate.
- returnspeed
- <integer> If the Toggle spawnflag is not set, the speed at which the button auto-returns when left alone, in degrees per second. If set to 0, the entity automatically toggles.
- _minlight
- <float> The minimum level of ambient light that hits this brush.
- startposition
- <float> Position when spawned. The value is a range between 0.0 and 1.0, where 0 is the unrotated position and 1 is the rotated position + 'Distance'.
- startdirection
- <choices>
Literal Value Description -1 Forward 1 Backward
- solidbsp
- <boolean>
Flags
- 1 : Not Solid
- 32 : Toggle (Disable Auto Return) - Toggle the direction of the rotation each time it is pressed. If set, overrides the returnspeed keyvalue. (This entity automatically toggles if returnspeed is set to 0.)
- 64 : X Axis - Rotate around the X axis.
- 128 : Y Axis - Rotate around the Y axis.
- 1024 : Use Activates
- 2048 : Starts locked
- 8192 : Jiggle when used while locked
Inputs
- Lock the button, preventing it from functioning.
- Unlock
- Unlock the button, allowing it to function.
- SetPosition <float>
- Move to a position. The parameter must be a value between 0 and 1, where 0 is the unrotated position and 1 is the rotated position + 'Distance'.
- SetPositionImmediately <float>
- Immediately teleport to a position. The parameter must be a value between 0 and 1, where 0 is the unrotated position and 1 is the rotated position + 'Distance'.
Outputs
- Template:O targetname
- Position <integer>
- Fired whenever the button moves. The output is the position of button from 0 to 1, where 0 is the unrotated position and 1 is the rotated position + 'Distance'.
- OnPressed
- Fired when the button is first pressed. Template:Plact
- OnUnpressed
- Fired when the button is first released from being pressed. Template:Plact
- OnFullyClosed
- Fired when the button has reached position 1, the rotated position + 'Distance'.
- OnFullyOpen
- Fired when the button has reached position 0, the unrotated starting position.
- OnReachedPosition
- Fired whenever the button reaches a goal position: i.e. when it becomes open, becomes closed, or reaches the point specified by a 'SetPosition' input.