Component:RandomEventGenerator: Difference between revisions

Revision as of 15:19, 20 October 2024

Component image

**Random Event Generator** component as seen in the Scene Inspector

This article or section is a Stub. You can help the Resonite Wiki by expanding it.

Random event generator is a component that is used to generate random events and point events given a minimum and maximum delay between events.

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.
`MinInterval`	Float	The minimum time in seconds before another event is generated
`MaxInterval`	Float	The maximum time in seconds before another event is generated
`RandomPointGenerator`	IPointGenerator	a point generator component that is used as the limiter on where random point events can be located.
`Events`	list of SyncDelegate`1<Action>	Random events that when calling a Sync Delegate provide no data to it's arguments.
`PointEvents`	list of SyncDelegate`1<Action`1<Float3>>	Random events that when calling a Sync Delegate provide a Float3 to it's arguments.

Behavior

Generates random events and sends them to the lists of Events and PointEvents.

Examples

Can be used with a RandomAudioClipPlayer PlayAtPoint(Float3 point) sync delegate to play noises randomly at random points from RandomPointGenerator without using ProtoFlux.

@@ Line 4: / Line 4: @@
 }}
 {{stub}}
+Random event generator is a component that is used to generate random events and point events given a minimum and maximum delay between events.
 == Usage ==
 {{Table ComponentFields
-|MinInterval|Float|
+|MinInterval|Float| The minimum time in seconds before another event is generated
-|MaxInterval|Float|
+|MaxInterval|Float| The maximum time in seconds before another event is generated
-|RandomPointGenerator|IPointGenerator|
+|RandomPointGenerator|IPointGenerator| a point generator component that is used as the limiter on where random point events can be located.
-|Events|{{RootFieldType|SyncList`1|[[Type:SyncDelegate`1|SyncDelegate`1]]&lt;[[Type:Action|Action]]&gt;}}|TypeAdv3=true|
+|Events|{{RootFieldType|SyncList`1|[[Type:SyncDelegate`1|SyncDelegate`1]]&lt;[[Type:Action|Action]]&gt;}}|TypeAdv3=true| Random events that when calling a [[Sync Delegates|Sync Delegate]] provide no data to it's arguments.
-|PointEvents|{{RootFieldType|SyncList`1|[[Type:SyncDelegate`1|SyncDelegate`1]]&lt;[[Type:Action`1|Action`1]]&lt;[[Type:Float3|Float3]]&gt;&gt;}}|TypeAdv4=true|
+|PointEvents|{{RootFieldType|SyncList`1|[[Type:SyncDelegate`1|SyncDelegate`1]]&lt;[[Type:Action`1|Action`1]]&lt;[[Type:Float3|Float3]]&gt;&gt;}}|TypeAdv4=true| Random events that when calling a [[Sync Delegates|Sync Delegate]] provide a [[Type:Float3|Float3]] to it's arguments.
 }}
 == Behavior ==
+Generates random events and sends them to the lists of <code>Events</code> and <code>PointEvents</code>.
 == Examples ==
+Can be used with a [[Component:RandomAudioClipPlayer|RandomAudioClipPlayer]] <code>PlayAtPoint(Float3 point)</code> sync delegate to play noises randomly at random points from <code>RandomPointGenerator</code> without using [[ProtoFlux]].
 == See Also ==
@@ Line 22: / Line 25: @@
 [[Category:Components:Utility{{#translation:}}|Random Event Generator]]
 [[Category:Components{{#translation:}}|Random Event Generator]]
-[[Category:ComponentStubs]]