Asw env shake: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
No edit summary
(Cleanup)
Line 1: Line 1:
== asw_env_shake ==
{{as point|asw_env_shake}}


{{as}} Creates a point entity available in [[Alien Swarm]]. When triggered,this entity will cause the screen off players in a given radius to shake.
== Entity description ==
[[File:env_shake.png|left|link=]]
An entity to control screen shake on marines. When triggered, this entity will cause the screen off players in a given radius to shake.
{{clr}}


== Keyvalues ==
== Keyvalues ==
 
{{KV|Amplitude (0-16)|float|The amount of noise in the screen shake. Should be a range between 0 and 16.}}
;Name:
{{KV|Effect Radius|float|The radius around this entity in which to affect players.}}
:The name that other entities refer to this entity by.
{{KV|Duration (seconds)|float|The length of time in which to shake the player's screens.}}
 
{{KV|Frequency|float|The frequency used to apply the screen shake. Should be a value between 0 and 255, where 0.1 {{=}} jerk, and 255.0 {{=}} rumble.}}
;Entity Scripts:
{{KV Targetname}}
:Name(s) of script files that are executed after all entities have spawned.
{{KV Parentname}}
 
;Script think function:
:Name of a function in this entity's script scope which will be called automatically.
 
;Parent:
:The name of this entity's parent in the movement hierarchy. Entities with parents move with their parent.
 
 
;Amplitude:
:The amount of noise in the screen shake. Should be a range between 0 and 16.
 
;Frequency:
:The frequency used to apply the screen shake. Should be a value between 0 and 255, where 0.1 = jerk, and 255.0 = rumble.
 
;Duration:
:The length of time in which to shake the player's screens.
 
;Effect Radius:
:The radius around this entity in which to affect players.
 


== Flags ==
== Flags ==
 
* 1 : GlobalShake
;GlobalShake:
* 4 : In Air
:If set, the shake will shake will affect the whole level.
* 8 : Physics
 
* 16 : Ropes
;InAir:
:Unknown effect.
 
;Physics:
:If set, the shake will affect physic objects [?].
 
;Ropes:
:If set, the shake will affect ropes [?].
 


== Inputs ==
== Inputs ==
 
{{IO|Amplitude|Set the amplitude (0-16)|param=string}}
;<code>AddOutput</code>
{{IO|Frequency|Set the frequence. Should be a value between 0 and 255, where 0.1 {{=}} jerk, and 255.0 {{=}} rumble.|param=string}}
:Evaluates a keyvalue/output on this entity. It can be potentially very dangerous, use with care.  
{{IO|StartShake|Start the shake.}}
:Format: <key> <value>
{{IO|StopShake|Stop the shake.}}
:Format: <output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire, -1 means infinite>
{{I Targetname}}
 
{{I Parentname}}
;<code>FireUser1-4</code>
:Fire the OnUser outputs; see User Inputs and Outputs.  
 
;<code>Kill</code>
:Removes this entity from the world.  
 
 
;<code>StartShake</code>
:Starts shaking.
 
;<code>StopShake</code>
:Stops shaking.
 
;<code>Amplitude</code>
:Redefines the Amplitude keyvalue.
 
;<code>Frequency</code>
:Redefines the Frequency keyvalue.
 


== Outputs ==
== Outputs ==
 
{{O Targetname}}
;<code>OnUser1-4</code>
:Fired in response to the FireUser inputs; see User Inputs and Outputs.
 
 
== See Also ==
 
;[[List of Alien Swarm entities]]
 
[[Category:Alien Swarm Entities]]

Revision as of 06:51, 27 June 2011

Template:As point

Entity description

Env shake.png

An entity to control screen shake on marines. When triggered, this entity will cause the screen off players in a given radius to shake.

Keyvalues

Amplitude (0-16) ([todo internal name (i)]) <float>
The amount of noise in the screen shake. Should be a range between 0 and 16.
Effect Radius ([todo internal name (i)]) <float>
The radius around this entity in which to affect players.
Duration (seconds) ([todo internal name (i)]) <float>
The length of time in which to shake the player's screens.
Frequency ([todo internal name (i)]) <float>
The frequency used to apply the screen shake. Should be a value between 0 and 255, where 0.1 = jerk, and 255.0 = rumble.
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.

Flags

  • 1 : GlobalShake
  • 4 : In Air
  • 8 : Physics
  • 16 : Ropes

Inputs

Amplitude <stringRedirectInput/string>
Set the amplitude (0-16)
Frequency <stringRedirectInput/string>
Set the frequence. Should be a value between 0 and 255, where 0.1 = jerk, and 255.0 = rumble.
StartShake
Start the shake.
StopShake
Stop the shake.


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.

Outputs

Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Asw_env_shake&oldid=153550"