env_microphone

From Valve Developer Community

Revision as of 03:32, 20 January 2009 by VDCBot (Talk | contribs)
(diff) ← Older revision | Current revision (diff) | Newer revision → (diff)
Jump to: navigation, search

This is a point entity available in all Source games.

Contents

Entity description

Broadcasts sound from a location for either playback or monitoring.

See Also

Keyvalues

  • Targetname:

Name <string>
The targetname other entities refer to this entity by.

  • Parentname:

Parent <targetname>
Specifies the targetname of this entity's movement parent. Entities with parents move with their parent.

  • EnableDisable:

Start Disabled <bool>
Stay dormant until activated (probably with the Enable input).
  • target
<target_destination> If the speaker is in Measuring mode, this is the name of the entity where the sound level is to be measured.
  • SpeakerName
<target_destination> The name of a speaker entity through which to play any sounds heard by this microphone. If specified, the microphone will consider itself in Speaker mode. Cannot be an env_speaker!
  • ListenFilter
<filterclass> The name of an filter entity which specifies the only entities the microphone can hear. Sounds emitted by other entities will not be heard.
  • speaker_dsp_preset
<choices> Only useful in Speaker mode. If specified, when the microphone is enabled, it'll set the global dsp_speaker preset to this value. Sounds played back through speakers will then be affected by the selected DSP.
Literal Value Description
0 Use Default
50 1 NO EFFECT
51 2 (DUPLICATE OF 1)
52 3 (DUPLICATE OF 1)
53 4 (DUPLICATE OF 1)
54 5 (DUPLICATE OF 1)
55 6 SPEAKER, LOUDER
56 7 SPEAKER VERY SMALL
57 8 LOUDSPEAKER, ECHO
58 9 SPEAKER SMALL
59 10 SPEAKER TINY
  • Sensitivity
<float> (0-10) If the speaker is being used to monitor sound levels, this keyvalue dictates its sensitivity.
Literal Value Description
0 Deaf
1 Normal
2-10 Increasing Sensitivity
  • MaxRange
<float> (0-∞) Sounds beyond this range won't be heard, irrelevant of attenuation.
Warning:setting this to zero (or a value > 1024) when the microphone is in Speaker mode can be very bad for performance!!
</dd>

Inputs

  • Targetname:

Kill
Removes this entity from the world.
KillHierarchy
Removes this entity and all its children from the world.
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.

  • Parentname:

SetParent <targetname>
Move with this entity. See Entity Hierarchy (parenting).
SetParentAttachment <string>
Attach to a named attachment on the current parent. The entity will teleport so that the position of its root bone matches that of the attachment.
SetParentAttachmentMaintainOffset <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 its current movement hierarchy.

  • EnableDisable:

Enable
Disable
Enable/disable this entity from performing its task. It might also disappear from view.
  • SetSpeakerName <target_destination>
Set the microphone to output through a different speaker entity.

Outputs

  • Targetname:

OnUser1 to OnUser4
Fired in response to the FireUser inputs; see User Inputs and Outputs.
OnKilled (New with Left 4 Dead)
Fired when the entity is killed and removed from the game.
  • SoundLevel <float>
Fired in Measuring mode whenever the sound level changes.
  • OnRoutedSound
Fired whenever a sound is routed out through the specified speaker (if any).
  • OnHeardSound
Fired whenever this microphone hears any sound it cares about.
Retrieved from "http://developer.valvesoftware.com/wiki/Env_microphone"
Personal tools