AudioListener

Determines whether sound being heard by this AudioListener shoud automatically implement features of acoustic simulation, such as occlusion (being muffled through walls), diffraction (bending around corners), and reverberation (echoing off of walls), when being sourced from an AudioEmitter. Note that the AudioEmitter also needs its AcousticSimulationEnabled property set to true for the effects to occur.

Represents a volume-over-angle curve that affects how loudly a AudioListener will hear the AudioEmitter, based on the angle between them and the LookVector associated with the AudioListener.

This property is internal and can't be accessed by scripts; it exists to support replication. See SetAngleAttenuation() for usage details.

Controls which AudioEmitters are audible to this AudioListener. Emitters that share an interaction group can be heard by this Listener.

Represents a volume-over-distance curve that affects how loudly the AudioListener hears any AudioEmitters, based on the distance between them.

This property is internal and can't be accessed by scripts; it exists to support replication. See SetDistanceAttenuation() for usage details.

This property is only functional when PositionType is set to ListenerPositionType.Instance. In that scenario, this property determines which Instance will be used to determine the position of the AudioListener when hearing spatial audio from AudioEmitters.

If set to an instance without a position or nil, the AudioListener will not hear anything.

The method by which the AudioListener determines its 3D location (the point from which any nearby AudioEmitters can be heard). Defaults to ListenerPositionType.Parent.

Controls how detailed the audio simulation should be for this AudioListener, similar to MeshPart.CollisionFidelity or MeshPart.RenderFidelity.

AudioListeners and AudioEmitters which disagree on the necessary level of detail will use the less-detailed option.

Returns a table mapping angle to volume. Keys are numbers between 0 and 180 (inclusive), while values are numbers between 0 and 1 (inclusive) describing how volume attenuates depending on direction. This method returns an empty table if the default angle attenuation curve is being used.

Calculates how audible an AudioEmitter is for this listener. The resulting volume, ranging from 0 to 1, accounts for distance and angle attenuation on both the emitter and listener. Use this to drive game logic that depends on perceived loudness, such as proximity UI indicators or mechanics that scale with how clearly a sound source is heard.

Returns an array of Wires that are connected to the specified pin. AudioListener has one "Output" pin.

Returns a table mapping distance to volume. Keys are numbers greater than or equal to 0, while values are numbers between 0 and 1 (inclusive) describing how volume attenuates over distance. This method returns an empty table if the default distance attenuation curve is being used.

Gets the list of pins that Wire can use in Wire.TargetName to connect to this instance via its Wire.TargetInstance property.

For AudioListener, there are none.

Returns an array of AudioEmitters that share an AudioInteractionGroup with the listener.

Gets the list of pins that Wire can use in Wire.SourceName to connect to this instance via its Wire.SourceInstance property.

For AudioListener, this is Output only.

Sets a volume-over-angle curve that affects how loudly a AudioListener will hear the AudioEmitter, based on the angle between them and the LookVector associated with the AudioListener.

The curve is represented by a table mapping angle keys to volume values. Keys are expected to be unique numbers between 0 and 180 (inclusive), while values are expected to be numbers between 0 and 1 (inclusive). Tables containing up to 400 key-value pairs are supported.

The volume of a AudioEmitter from the perspective of the AudioListener at an angle a is determined by linearly interpolating between the volume levels for the points on the curve whose angle values are directly above and below a. If there is either no point below a or no point above a, the volume level of the other point is chosen. Essentially, the curve is a sequence of points connected by straight lines, and beyond its left and right endpoints the curve extends outward at their respective volume levels.

This volume will be multiplied with the volumes from all other attenuation curves (including the ones on the sending AudioEmitter) to obtain the final audibility.

If the table is empty or nil, the AudioListener defaults to using an angle attenuation curve with the constant volume value of 1.

Sets a volume-over-distance curve that affects how loudly the AudioListener will hear any AudioEmitters, based on the distance between them. This is useful when you want a particular listener to have an extended or shortened hearing range — for example, a character with enhanced hearing — without modifying the emitting AudioEmitter or separating emitters and listeners into different interaction groups.

The curve is represented by a table mapping distance keys to volume values. Keys are expected to be unique numbers greater than or equal to 0, while values are expected to be numbers between 0 and 1 (inclusive). Tables containing up to 400 key-value pairs are supported.

The volume of a AudioEmitter from the perspective of the AudioListener at a distance d is determined by linearly interpolating between the volume levels for the points on the curve whose distance values are directly above and below d. If there is either no point below d or no point above d, the volume level of the other point is chosen. Essentially, the curve is a sequence of points connected by straight lines, and beyond its left and right endpoints the curve extends outward infinitely at their respective volume levels.

This volume will be multiplied with the volumes from all other attenuation curves (including the ones on the sending AudioEmitter) to obtain the final audibility.

If the table is empty or nil, the AudioListener defaults to applying a constant volume of 1 everywhere.

Event that fires after a Wire becomes connected or disconnected, and that Wire is now or was previously connected to a pin on the AudioListener and to some other wirable instance.