Component:SimplexNoiseClip: Difference between revisions

Latest revision as of 09:09, 25 March 2025

Component image

**Simplex Noise Clip** component as seen in the Scene Inspector

The SimplexNoiseClip component samples from simplex noise in order to get a pseudo-random frequency chart. Like a constantly random smooth changing whistle pitch.

This component takes time to change it's pitch and loudness when it's properties are changed. When doing real time adjustments, It is recommended to make the audio loud and low pitched by default and then adjust the speed and volume of the audio player to adjust in real time.

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.
`HighPriorityIntegration`	Bool	If true, integrating this asset (e.g. processing procedural assets) gets higher priority than assets with this flag off. An example is user laser procedural meshes.
`Frequency`	Float	The pitch of the clip.
`Amplitude`	Float	The loudness of the clip.
`Duration`	Float	How long the clip is and its duration of how much of simplex noise it samples.
`Offset`	Float	Where in the simplex noise algorithm this clip starts sampling from.

Sync Delegates

Triggers
Method Name	Method type and Arguments.	Is the method hidden?	Description
`BakeClip:Action`	Action	X	Turns the audio into a Component:StaticAudioClip.

Usage

Attach to a slot and provide a Frequency and Amplitude, then insert into a Component:AudioClipPlayer to hear it.

@@ Line 7: / Line 7: @@
 |Name=Simplex Noise Clip
 }}
+The '''SimplexNoiseClip''' component samples from simplex noise in order to get a pseudo-random frequency chart. Like a constantly random smooth changing whistle pitch.
+{{Note|This component takes time to change it's pitch and loudness when it's properties are changed. When doing real time adjustments, It is recommended to make the audio loud and low pitched by default and then adjust the speed and volume of the audio player to adjust in real time.|warning}}
 <!--T:2-->
 == Fields ==
 {{Table ComponentFields
-|HighPriorityIntegration|Bool|
+|HighPriorityIntegration|Bool|{{Asset HighPriorityIntegration Field}}
-|Frequency|Float|
+|Frequency|Float| The pitch of the clip.
-|Amplitude|Float|
+|Amplitude|Float| The loudness of the clip.
-|Duration|Float|
+|Duration|Float| How long the clip is and its duration of how much of simplex noise it samples.
-|Offset|Float|
+|Offset|Float| Where in the simplex noise algorithm this clip starts sampling from.
+}}
+== Sync Delegates ==
+{{Table ComponentTriggers
+|BakeClip:[[Type:Action|Action]]|[[Type:Action|Action]]|false| Turns the audio into a [[Component:StaticAudioClip]].
 }}
 <!--T:3-->
 == Usage ==
+Attach to a slot and provide a <code>Frequency</code> and <code>Amplitude</code>, then insert into a [[Component:AudioClipPlayer]] to hear it.
 <!--T:4-->
 == Examples ==
+{{stub}}
 <!--T:5-->
-== Related Components ==
+== See Also ==
+{{Template:AudioClip_SeeAlso}}
 </translate>
-[[Category:ComponentStubs]]
 [[Category:Components{{#translation:}}|Simplex Noise Clip]]
 [[Category:Components:Assets:Procedural Audio Clips{{#translation:}}|Simplex Noise Clip]]