Automated: create new component page |
add info |
||
| Line 3: | Line 3: | ||
|Name=Footstep Sound Player | |Name=Footstep Sound Player | ||
}} | }} | ||
The '''FootstepSoundPlayer''' component triggers a list of [[Type:IFootstepSoundMaterial|IFootstepSoundMaterials]] when a player walks on a collider on the same slot. | |||
== | == Fields == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|SoundMaterials|{{RootFieldType|SyncRefList`1|[[Type:IFootstepSoundMaterial|IFootstepSoundMaterial]]}}|TypeAdv0=true| | |SoundMaterials|{{RootFieldType|SyncRefList`1|[[Type:IFootstepSoundMaterial|IFootstepSoundMaterial]]}}|TypeAdv0=true| usually a list of [[Component:FootstepSoundDefinition|FootstepSoundDefinitions]]. | ||
}} | }} | ||
== | == Usage == | ||
Used to make an entire collider like a tile floor play sounds when a player walks on it. | |||
== Examples == | == Examples == | ||
Can be used for tile floors or grid spaces. | |||
== See Also == | == See Also == | ||
| Line 18: | Line 20: | ||
[[Category:Components:Locomotion:Footsteps{{#translation:}}|Footstep Sound Player]] | [[Category:Components:Locomotion:Footsteps{{#translation:}}|Footstep Sound Player]] | ||
[[Category:Components{{#translation:}}|Footstep Sound Player]] | [[Category:Components{{#translation:}}|Footstep Sound Player]] | ||
Latest revision as of 06:09, 19 January 2025
Component image File:FootstepSoundPlayerComponent.pngFootstep Sound Player component as seen in the Scene Inspector
The FootstepSoundPlayer component triggers a list of IFootstepSoundMaterials when a player walks on a collider on the same slot.
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. |
SoundMaterials
|
list of IFootstepSoundMaterial | usually a list of FootstepSoundDefinitions. |
Usage
Used to make an entire collider like a tile floor play sounds when a player walks on it.
Examples
Can be used for tile floors or grid spaces.