Component:Spinner: Difference between revisions

Latest revision as of 12:35, 18 October 2025

Component image

**Spinner** component as seen in the Scene Inspector

The Spinner component is used to make something rotate on 1 or more axis at a constant rate.

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.
`Range`	Float3	how much each axis can go up to from 0 before wrapping around.
`_target`	field drive of FloatQ	The rotation field to spin.
`_offset`	FloatQ	the offset rotation to start at world start from.
`_speed`	Float3	how fast to rotate on each axis. Negative values go in reverse.

Usage

Note: While this component works very well for fixed or discrete speed steps, it might not behave as expected when the speed field is continuously changing, even a very small change can cause the component to 'jerk' on each change.

If you want to make something speed up or slow down smoothly, one option is to use rotational maths to recreate this component in flux, for example using ProtoFlux:AxisAngle

Examples

Spinner tutorial by ProbablePrime.

Related Components

@@ Line 7: / Line 7: @@
 |Name=Spinner
 }}
+The '''Spinner''' component is used to make something rotate on 1 or more axis at a constant rate.
 == Fields == <!--T:2-->
 {{Table ComponentFields
-|Range|Float3|
+|Range|Float3| how much each axis can go up to from 0 before wrapping around.
-|_target|{{RootFieldType|FieldDrive`1|[[Type:FloatQ|FloatQ]]}}|TypeAdv1=true|
+|_target|{{RootFieldType|FieldDrive`1|[[Type:FloatQ|FloatQ]]}}|TypeAdv1=true| The rotation field to spin.
-|_offset|FloatQ|
+|_offset|FloatQ| the offset rotation to start at world start from.
-|_speed|Float3|
+|_speed|Float3| how fast to rotate on each axis. Negative values go in reverse.
 }}
 == Usage == <!--T:3-->
+Note: While this component works very well for fixed or discrete speed steps, it might not behave as expected when the speed field is continuously changing, even a very small change can cause the component to 'jerk' on each change.
+If you want to make something speed up or slow down smoothly, one option is to use rotational maths to recreate this component in flux, for example using [[ProtoFlux:AxisAngle]]
 == Examples == <!--T:4-->
-* [https://www.youtube.com/watch?v=VKEzfQLNtqs Spinner tutorial] by [[User:ProbablePrime|ProbablePrime]]
+Spinner tutorial by [[User:ProbablePrime|ProbablePrime]].
+<youtube>VKEzfQLNtqs</youtube>
 == Related Components == <!--T:5-->
 </translate>
-[[Category:ComponentStubs]]
 [[Category:Components{{#translation:}}|Spinner]]
 [[Category:Components:Transform:Drivers{{#translation:}}|Spinner]]