Component:NumericUserOverrideGather: Difference between revisions

Revision as of 18:17, 27 January 2025

Component image

**Numeric User Override Gather`1** component as seen in the Scene Inspector

The NumericOverrideGather component acts the same as a Component:ValueUserOverride`1 with the key difference being it can get the average, minimum, maximum, and sum of all the values users picked that are still in the session.

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.
`Default`	T	The default value to drive `Target` with on the user's local machine if they don't have an override in the list of `_overrides`.
`CreateOverrideOnWrite`	Bool	Whether changes to `Target` creates a new override or updates the overrides value for that user.
`PersistentOverrides`	Bool	Whether the `_overrides` list contents are saved when this component is saved.
`_overrides`	unordered list of Override<T>	A list of overrides for different users.
`Target`	field drive of T	The field to drive with different values for each user's local machine using the `_overrides` list.
`Min`	raw output of T	The minimum value of all the `_overrides` for currently in session users. If a user doesnt have an entry, they are considered to have an entry of `Default`.
`Max`	raw output of T	The maximum value of all the `_overrides` for currently in session users. If a user doesnt have an entry, they are considered to have an entry of `Default`.
`Sum`	raw output of T	The value for if of all the `_overrides` were added together for currently in session users. If a user doesnt have an entry, they are considered to have an entry of `Default`.
`Average`	raw output of T	The average value of all the `_overrides` for currently in session users. If a user doesnt have an entry, they are considered to have an entry of `Default`.

Usage

Can be used to check if all users are using the same setting (like saying they're ready for a game round to start) or check the average of what people say the number of jellybeans in a jar is (so that someone can guess the average and get the closest to the answer)

Examples

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

@@ Line 3: / Line 3: @@
 |Name=Numeric User Override Gather`1
 }}
-{{stub}}
+The '''NumericOverrideGather''' component acts the same as a [[Component:ValueUserOverride`1]] with the key difference being it can get the average, minimum, maximum, and sum of all the values users picked that are still in the session.
-== Usage ==
+== Fields ==
 {{Table ComponentFields
-|Default|'''T'''|TypeAdv0=true|
+|Default|'''T'''|TypeAdv0=true| The default value to drive <code>Target</code> with on the user's local machine if they don't have an override in the list of <code>_overrides</code>.
-|CreateOverrideOnWrite|Bool|
+|CreateOverrideOnWrite|Bool| Whether changes to <code>Target</code> creates a new override or updates the overrides value for that user.
-|PersistentOverrides|Bool|
+|PersistentOverrides|Bool| Whether the <code>_overrides</code> list contents are saved when this component is saved.
-|_overrides|{{RootFieldType|SyncBag`1|[[Type:Override|Override]]&lt;T&gt;}}|TypeAdv3=true|
+|_overrides|{{RootFieldType|SyncBag`1|[[Type:Override|Override]]&lt;T&gt;}}|TypeAdv3=true| A list of overrides for different users.
-|Target|{{RootFieldType|FieldDrive`1|T}}|TypeAdv4=true|
+|Target|{{RootFieldType|FieldDrive`1|T}}|TypeAdv4=true| The field to drive with different values for each user's local machine using the <code>_overrides</code> list.
-|Min|{{RootFieldType|RawOutput`1|T}}|TypeAdv5=true|
+|Min|{{RootFieldType|RawOutput`1|T}}|TypeAdv5=true| The minimum value of all the <code>_overrides</code> for currently in session users. If a user doesnt have an entry, they are considered to have an entry of <code>Default</code>.
-|Max|{{RootFieldType|RawOutput`1|T}}|TypeAdv6=true|
+|Max|{{RootFieldType|RawOutput`1|T}}|TypeAdv6=true| The maximum value of all the <code>_overrides</code> for currently in session users. If a user doesnt have an entry, they are considered to have an entry of <code>Default</code>.
-|Sum|{{RootFieldType|RawOutput`1|T}}|TypeAdv7=true|
+|Sum|{{RootFieldType|RawOutput`1|T}}|TypeAdv7=true| The value for if of all the <code>_overrides</code> were added together for currently in session users. If a user doesnt have an entry, they are considered to have an entry of <code>Default</code>.
-|Average|{{RootFieldType|RawOutput`1|T}}|TypeAdv8=true|
+|Average|{{RootFieldType|RawOutput`1|T}}|TypeAdv8=true| The average value of all the <code>_overrides</code> for currently in session users. If a user doesnt have an entry, they are considered to have an entry of <code>Default</code>.
 }}
-== Behavior ==
+== Usage ==
+Can be used to check if all users are using the same setting (like saying they're ready for a game round to start) or check the average of what people say the number of jellybeans in a jar is (so that someone can guess the average and get the closest to the answer)
 == Examples ==
+{{stub}}
 == See Also ==
+* [[Component:ValueUserOverride`1]]
 [[Category:Components:Transform:Drivers{{#translation:}}|Numeric User Override Gather`1]]
 [[Category:Components{{#translation:}}|Numeric User Override Gather`1]]
 [[Category:Generic Components{{#translation:}}|Numeric User Override Gather`1]]
-[[Category:ComponentStubs]]