snd_event_param is a point entity available in
Half-Life: Alyx. It is used to set a public parameter of a playing soundevent.
The snd_event_param seems to be an entity devoted to changing the basic variables of an active snd_event_point or snd_event_alignedbox using the IO System.
Todo: Does it work with a soundscape as well?
A short list of variables used for many events are as follows.
- volume
- pitch
- delay
- use_hrtf
- volume_falloff_min
- volume_falloff_max
- fade_in
- fade_out
See Adding Sound for a full list.
Properties
- Parameter Name (parameterName) <string>
- Name of the parameter to set
- Float Value (floatValue) <float>
- Single float value to set on parameter.
Source 2 Targetname
- Name (targetname) <string>
- The targetname that other entities refer to this entity by.
- Entity Scripts (vscripts) <scriptlist>
- 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.
- Create Client-Only Entity (clientSideEntity) <choices>
- No
- Yes
|
Source 2 Hierarchy
- Parent (parentname) <targetname>
- Specifies a movement parent. An entity will maintain its initial offset from its parent.
- Parent Model Bone/Attachment Name (parentAttachmentName) <string>
- The name of the bone or attachment to attach to on the entity's parent in the movement hierarchy. Use !bonemerge to use bone-merge style attachment.
- Model Attachment position offset (local.origin) <coordinates>
- Offset in the local space of the parent model's attachment/bone to use in hierarchy. Not used if you are not using parent attachment.
- Model Attachment angular offset (local.angles) <angles>
- Angular offset in the local space of the parent model's attachment/bone to use in hierarchy. Not used if you are not using parent attachment.
- Model Attachment scale (local.scales) <vector>
- Scale in the local space of the parent model's attachment/bone to use in hierarchy. Not used if you are not using parent attachment.
- Use Model Attachment Offset (useLocalOffset) <boolean>
- Whether to respect the specified local offset when doing the initial hierarchical attachment to its parent.
|
Source 2 Transform
Note: These are "Embedded Properties" which are hard-coded to appear on every entity in Hammer, regardless of their presence in any FGD files.
- Origin (origin) <coordinates>
- The world space origin of the entity.
- Angles (angles) <angles>
- The pitch, yaw, roll orientation of the entity.
- Scale (scales) <vector>
- The x, y, z scales of the entity. Not all entities can use this.
- Transform Locked (transformLocked) <boolean>
- Lock the transform at its current value, preventing the transform of the node from being modified. Only applies within Hammer.
- Force Hidden (force_hidden) <boolean>
- Visually hides the entity from the viewports. The Outliner pane will still list hidden entities.
- Editor Only (editorOnly) <boolean>
- Entity is only displayed in Hammer and will not appear in game.
|
Inputs
- SetParamName
- Set the name of the parameter to set on the soundevent.
- SetFloatValue
- Set the name of the sound event to play.
Note: Probably a bad description
- SetSoundEventGUID
- Start the sound event using a snd_event_point and pass its guid output to this.
Source 2 Targetname
- Kill
- Removes this entity from the world.
- KillHierarchy
- Removes this entity and all its children from the world.
Note: Entities already remove orphaned children upon being removed, but this input removes all children on the same frame, being marginally faster than Kill.
- AddOutput <stringRedirectInput/string>
- Evaluates a keyvalue/output on this entity. It can be potentially very dangerous, use with care.
KV Format: <key> <value> I/O Format: <output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire, -1 means infinite>
- FireUser1 to FireUser4
- Fire the
OnUser outputs; see User Inputs and Outputs.
- RunScriptFile <stringRedirectInput/string>
- Execute a VScript file from disk, without file extension. The script contents are merged with the script scope of the receiving entity.
- RunScriptCode <stringRedirectInput/string>
- 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.
- CallScriptFunction <stringRedirectInput/string>
- Execute a VScript function in the scope of the receiving entity.
- CallPrivateScriptFunction <stringRedirectInput/string>
- Calls a script function from this entity's private script scope.
- CallGlobalScriptFunction <stringRedirectInput/string>
- Calls a script function in the global script scope.
|
Source 2 Hierarchy
- Parent (parentname) <targetname>
- Specifies a movement parent. An entity will maintain its initial offset from its parent.
- Parent Model Bone/Attachment Name (parentAttachmentName) <string>
- The name of the bone or attachment to attach to on the entity's parent in the movement hierarchy. Use !bonemerge to use bone-merge style attachment.
- Model Attachment position offset (local.origin) <coordinates>
- Offset in the local space of the parent model's attachment/bone to use in hierarchy. Not used if you are not using parent attachment.
- Model Attachment angular offset (local.angles) <angles>
- Angular offset in the local space of the parent model's attachment/bone to use in hierarchy. Not used if you are not using parent attachment.
- Model Attachment scale (local.scales) <vector>
- Scale in the local space of the parent model's attachment/bone to use in hierarchy. Not used if you are not using parent attachment.
- Use Model Attachment Offset (useLocalOffset) <boolean>
- Whether to respect the specified local offset when doing the initial hierarchical attachment to its parent.
|
Outputs
Source 2 Targetname
- OnUser1 to OnUser4
- These Outputs each fire in response to the firing of the like-numbered
FireUser1 to FireUser4 Input; see User Inputs and Outputs.
- OnKilled
- This Output fires when the entity is killed and removed from the game.
|
See also