snd_event_alignedbox is a point entity available in
Half-Life: Alyx and
Counter-Strike 2.
The snd_event_alignedbox plays a sound event from a point, passes along the min and max positions of its AABB. The point can be this entity or a specified entity's position.
It is similar to a snd_event_point with the distinction of being able to use the bounds of its volume to modify variables tied to each sound event. How it interacts with the aabb system is yet to be determined though the snd_opvar_set_aabb is the most likely means of doing so. It functions identically to snd_event_point without the use of the system.
Todo: Test this entity for its intended uses and update this page with use-cases
Investigate: The snd_opvar_set_aabb has many parameters relating to volumetric occlusion
Properties
- Box Mins (box_mins) <coordinates>
- The minimum bounds for the volume, can be dragged out in the 3d view or entered manually.
- Box Maxs (box_maxs) <coordinates>
- The maximumbounds for the volume, can be dragged out in the 3d view or entered manually.
snd_event_point:
- Sound Event Name (soundName) <string>
- Name of the sound event to play
- Source Entity Name (sourceEntityName) <string>
- Name of the entity the sound should emit from.
- Start On Spawn (startOnSpawn) <boolean>
- Play the sound immediately upon spawning
- To Local Player (toLocalPlayer) <boolean>
- Play the sound directly to the local player
- Re-trigger Stops Last (stopOnNew) <boolean>
- Stop a previously playing event when a new one is started
- Save/Restore (saveAndRestore) <boolean>
- This soundevent should be saved and restored.
- Entity Attachment Name (sourceEntityAttachment) <string>
- If set, will play the soundevent from this attachment point.
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>
|
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
snd_event_point:
- SetSourceEntity
- Set the name of the entity to play the sound from. The sound will follow the entity as it moves.
- SetSoundEventName
- Set the name of the sound event to play.
- StartSound
- Start the sound event. If an entity name is provided, the sound will originate from that entity.
- PauseSound
- Pause the sound event.
- UnPauseSound
- UnPause the sound event.
- StopSound
- Stop the sound event
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
- SetParent <stringRedirectInput/string>
- Changes the entity's parent in the movement hierarchy.
- SetParentAttachment <stringRedirectInput/string>
- Change this entity to attach to a specific attachment point on its parent. Entities must be parented before being sent this input. The parameter passed in should be the name of the attachment.
- SetParentAttachmentMaintainOffset <stringRedirectInput/string>
- Change this entity to attach to a specific attachment point on it's parent. Entities must be parented before being sent this input. The parameter passed in should be the name of the attachment. The entity will maintain it's position relative to the parent at the time it is attached.
- ClearParent
- Removes this entity from the the movement hierarchy, leaving it free to move independently.
|
Outputs
snd_event_point:
- SoundEventGuid
- Sound Event Guid
- OnSoundFinished
- Fired when the sound finished playing
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