Component:EarmuffSettings

Component image 

File:EarmuffSettingsComponent.png

Earmuff Settings component as seen in the Scene Inspector

The EarmuffSettings component is used to allow a user to change the settings for the Ear muffs, which reduce the noise outside of a cone emitted from the user's head. This feature is useful in crowds or noisy places

Fields

Fields

Name	Type	Description
persistent	Bool	Determines whether or not this item will be saved to the server.
UpdateOrder	Int	Controls the order in which this component is updated.
Enabled	Bool	Controls whether or not this component is enabled. Some components stop their functionality when this field is disabled, but some don't.
EarmuffEnabled	Bool	Whether to have the earmuffs mode enabled for the local user
VolumeAttenuation	Float	How much to reduce volume based on its distance from the cone.
Directionality	Float	How much the audio is affected by how in front the audio is.
Distance	Float	How far forward from the user's head the cone should stretch
Angle	Float	The angle of the cone.
TransitionStart	Float	The start of audio reducing outside the cone.
TransitionLength	Float	The distance outside the cone that audio becomes quiet over distance from the cone.

Usage

Is used for the settings earmuffs. Is not used directly by the user.

Examples

Used in the settings tab in the dash.