sound_mix_layer

From Valve Developer Community
Jump to: navigation, search

<Left 4 Dead 2> sound_mix_layer is a point entity available in Left 4 Dead 2. It is an entity used to set a mix layer to a specific value.

Note:Developers seeking how to manage priorities of specific sounds should refer to mixgroups found in pak01_dir.vpk: /scripts/soundmixers.txt

Keyvalues

Mix Layer Name <string>
Name of the mix layer to be setting the level of.
Level <float>
Set the Mix Layer Level

Targetname:

Name <string>
The targetname that other entities refer to this entity by.
Entity Scripts <scriptlist> (New with Left 4 Dead 2)
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.
Script think function <string> (New with Left 4 Dead 2)
Name of a function in this entity's script which will be called automatically every 100 milliseconds (ten times a second) for the duration of the script. It can be used to create timers or to simulate autonomous behavior. The return value (if present) will set the time until the next call.
Note:Try to avoid expensive operations in this function, as it may cause performance problems.

Inputs

Level  <float>
Set the Mix Layer Level

Targetname:

Kill
Removes this entity and any entities parented to it from the world.
KillHierarchy
Functions the same as Kill, although entities with a large number of children are killed marginally faster.
AddOutput  <string>
Evaluates a keyvalue/output on this entity. It can be potentially very dangerous, use with care.
Format: <key> <value>
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.
Use  !FGD
Same as a player invoking +use; may not do anything. Can also be invoked by creating an output that does not specify an input.
This input is not included in Valve's FGDs.
RunScriptFile  <script> (New with Left 4 Dead 2)
Execute a VScript file from disk, without file extension. The script contents are merged with the script scope of the receiving entity.
RunScriptCode  <string> (New with Left 4 Dead 2)
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.
Bug:  In <Left 4 Dead 2>, the code is executed in the script scope of the entity that fires the output, not the one receiving the input.
Warning: Never try to pass string parameters to a script function with this input. It will corrupt the VMF structure because of the nested quotation marks, which then must be removed manually with a text editor.
CallScriptFunction  <string> (New with Left 4 Dead 2) !FGD
Execute a VScript function in the scope of the receiving entity.
Note:This input is missing from some games FGD files.
SetLocalOrigin  <origin> (New with Alien Swarm) !FGD
Set this entity's origin in the map.
Note:This input is missing from some games FGD files.
SetLocalAngles  <angles> (New with Alien Swarm) !FGD
Set this entity's angles in the map.
Note:This input is missing from some games FGD files.

Outputs

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  (New with Left 4 Dead)
This Output fires when the entity is killed and removed from the game.

Mix layers

More information regarding MixLayers can be found in pak01_dir.vpk: /scripts/soundmixers.txt

These are listed in the dev console commmand snd_list_mixers

  • mobBeatingLayer
  • mobRulesLayer
  • zombatMusicLayer
  • zombatMusic2Layer
  • zombatMusic3Layer
  • witchRageLayer
  • safeRoomLayer
  • unaliveLayer
  • PZVOWarnLayer
  • chargerAttackLayer
  • commentaryLayer
  • undeathLayer
  • adrenalineLayer
  • fluMusicLayer
  • rainLayer
  • stormLayer
  • voipLayer

Entries listed under the dev console command snd_list_mix_groups may work with a "Layer" post-fix, but need further testing.

External links

Audio Mixing (recorded music) - Wikipedia article regarding technical aspects of audio mixing