Component:EarmuffSettings: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
get rid or bad category
 
(2 intermediate revisions by 2 users not shown)
Line 3: Line 3:
|Name=Earmuff Settings
|Name=Earmuff Settings
}}
}}
{{stub}}
This is a component that 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


== Usage ==
== Usage ==
{{Table ComponentFields
{{Table ComponentFields
|EarmuffEnabled|Bool|
|EarmuffEnabled|Bool| Whether to have the earmuffs mode enabled for the local user
|VolumeAttenuation|Float|
|VolumeAttenuation|Float|
|ConeDistance|Float|
|Directionality|Float|
|ConeAngle|Float|
|Distance|Float| How far forward from the user's head the cone should stretch
|Angle|Float|
|TransitionStart|Float|
|TransitionStart|Float|
|TransitionLength|Float|
|TransitionLength|Float|

Latest revision as of 04:19, 23 December 2024

Component image 
File:EarmuffSettingsComponent.png
Earmuff Settings component as seen in the Scene Inspector

This is a component that 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

Usage

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.
EarmuffEnabled Bool Whether to have the earmuffs mode enabled for the local user
VolumeAttenuation Float
Directionality Float
Distance Float How far forward from the user's head the cone should stretch
Angle Float
TransitionStart Float
TransitionLength Float

Behavior

Examples

See Also