Component:LegacyNumericUpDown: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
add info
 
Line 3: Line 3:
|Name=Legacy Numeric Up Down
|Name=Legacy Numeric Up Down
}}
}}
{{stub}}
The '''LegacyNumericUpDown''' component comes from Legacy migrated content. This component should not be used in new content, and should be removed when possible.


== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|Style|{{RootFieldType|RelayRef`1|[[Component:LegacyUIStyle|LegacyUIStyle]]}}|TypeAdv0=true|
|Style|{{RootFieldType|RelayRef`1|[[Component:LegacyUIStyle|LegacyUIStyle]]}}|TypeAdv0=true| {{Template:LegacyUI_Style}}
|AcceptPhysicalTouch|Bool|
|AcceptPhysicalTouch|Bool| {{Template:Touchable_AcceptPhysicalTouch}}
|AcceptRemoteTouch|Bool|
|AcceptRemoteTouch|Bool| {{Template:Touchable_AcceptRemoteTouch}}
|Color|ColorX|
|Color|ColorX| The color of the UI elements.
|Width|Float|
|Width|Float| The width of the UI.
|Height|Float|
|Height|Float| The height of the UI.
|Thickness|Float|
|Thickness|Float| The thickness of the UI.
|Slant|Float|
|Slant|Float| How beveled the UI elements should be.
|_textSlot|Slot|
|_textSlot|Slot| the slot of the text for the number this component is editing.
|_textRenderer|'''[[Component:TextRenderer|TextRenderer]]'''|TypeAdv9=true|
|_textRenderer|'''[[Component:TextRenderer|TextRenderer]]'''|TypeAdv9=true| The text renderer for the number this component is editing.
|_textEditor|'''[[Component:TextEditor|TextEditor]]'''|TypeAdv10=true|
|_textEditor|'''[[Component:TextEditor|TextEditor]]'''|TypeAdv10=true| The text editor that allows for direct editing of the number this component is editing.
|_material|{{RootFieldType|DriveRef`1|[[PBS_RimMetallic|PBS_RimMetallic]]}}|TypeAdv11=true|
|_material|{{RootFieldType|DriveRef`1|[[PBS_RimMetallic|PBS_RimMetallic]]}}|TypeAdv11=true| The material this UI is using.
|_mesh|{{RootFieldType|DriveRef`1|[[Component:BevelStripeMesh|BevelStripeMesh]]}}|TypeAdv12=true|
|_mesh|{{RootFieldType|DriveRef`1|[[Component:BevelStripeMesh|BevelStripeMesh]]}}|TypeAdv12=true| The mesh this UI is using.
|_textBounds|{{RootFieldType|FieldDrive`1|[[Type:Float2|Float2]]}}|TypeAdv13=true|
|_textBounds|{{RootFieldType|FieldDrive`1|[[Type:Float2|Float2]]}}|TypeAdv13=true| The field to drive to make the UI fit around the text.
|_colliderSize|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv14=true|
|_colliderSize|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv14=true| The field of the collider size for this UI.
|_meshLeft|{{RootFieldType|DriveRef`1|[[Component:BevelStripeMesh|BevelStripeMesh]]}}|TypeAdv15=true|
|_meshLeft|{{RootFieldType|DriveRef`1|[[Component:BevelStripeMesh|BevelStripeMesh]]}}|TypeAdv15=true| The mesh being used by this component's left button.
|_meshRight|{{RootFieldType|DriveRef`1|[[Component:BevelStripeMesh|BevelStripeMesh]]}}|TypeAdv16=true|
|_meshRight|{{RootFieldType|DriveRef`1|[[Component:BevelStripeMesh|BevelStripeMesh]]}}|TypeAdv16=true| The mesh being used by this component's right button.
|_textLeftBounds|{{RootFieldType|FieldDrive`1|[[Type:Float2|Float2]]}}|TypeAdv17=true|
|_textLeftBounds|{{RootFieldType|FieldDrive`1|[[Type:Float2|Float2]]}}|TypeAdv17=true| The field to drive to make the left button stay wrapped around its text.
|_textRightBounds|{{RootFieldType|FieldDrive`1|[[Type:Float2|Float2]]}}|TypeAdv18=true|
|_textRightBounds|{{RootFieldType|FieldDrive`1|[[Type:Float2|Float2]]}}|TypeAdv18=true| The field to drive to make the right button stay wrapped around its text.
|_leftTextRenderer|'''[[Component:TextRenderer|TextRenderer]]'''|TypeAdv19=true|
|_leftTextRenderer|'''[[Component:TextRenderer|TextRenderer]]'''|TypeAdv19=true| The text renderer for the left button.
|_rightTextRenderer|'''[[Component:TextRenderer|TextRenderer]]'''|TypeAdv20=true|
|_rightTextRenderer|'''[[Component:TextRenderer|TextRenderer]]'''|TypeAdv20=true| The text renderer for the right button.
|_colliderLeftSize|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv21=true|
|_colliderLeftSize|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv21=true| The collider size field of the left button.
|_colliderRightSize|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv22=true|
|_colliderRightSize|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv22=true| The collider size field of the right button.
|_leftOffset|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv23=true|
|_leftOffset|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv23=true| The collider offset field of the left button.
|_rightOffset|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv24=true|
|_rightOffset|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv24=true| The collider offset field of the right button.
|_leftTextPosition|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv25=true|
|_leftTextPosition|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv25=true| The text position field of the left button.
|_rightTextPosition|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv26=true|
|_rightTextPosition|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv26=true| The text position field of the right button.
|DriveField|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv27=true|
|DriveField|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv27=true| The field this component should drive with <code>Value</code>
|AllowWriteBack|Bool|
|AllowWriteBack|Bool| Whether changes to the value of the field targeted by <code>DriveField</code> should be written to this component's <code>Value</code> field instead.
|Value|Float|
|Value|Float| The value that this component currently has for the edited field.
|DecimalPoints|Int|
|DecimalPoints|Int| How many decimal places this component should keep track of.
|MinValue|Float|
|MinValue|Float| The minimum possible value for <code>Value</code>.
|MaxValue|Float|
|MaxValue|Float| The maximum possible value for <code>Value</code>.
|IncrementValue|Float|
|IncrementValue|Float| How much to increment or decrement <code>Value</code> by when pressing the left and right buttons.
|IsEnabled|Bool|
|IsEnabled|Bool| {{Template:LegacyUI_IsEnabled}}
|_textDrive|{{RootFieldType|FieldDrive`1|[[Type:String|String]]}}|TypeAdv35=true|
|_textDrive|{{RootFieldType|FieldDrive`1|[[Type:String|String]]}}|TypeAdv35=true| The string field to drive with the current <code>Value</code> for the visuals.
}}
}}


== Behavior ==
== Usage ==
Just dont.


== Examples ==
== Examples ==
{{stub}}


== See Also ==
== See Also ==
Line 53: Line 55:
[[Category:Components:UI:Physical{{#translation:}}|Legacy Numeric Up Down]]
[[Category:Components:UI:Physical{{#translation:}}|Legacy Numeric Up Down]]
[[Category:Components{{#translation:}}|Legacy Numeric Up Down]]
[[Category:Components{{#translation:}}|Legacy Numeric Up Down]]
[[Category:ComponentStubs]]

Latest revision as of 19:25, 21 January 2025

Component image 
Legacy Numeric Up Down component as seen in the Scene Inspector

The LegacyNumericUpDown component comes from Legacy migrated content. This component should not be used in new content, and should be removed when possible.

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.
Style direct RelayRef`1<LegacyUIStyle> The source of the legacy color styles for this component.
AcceptPhysicalTouch Bool Whether to allow Component:TipTouchSources to interact with/activate this component.
AcceptRemoteTouch Bool Whether this component allows interaction via the user's interaction laser.
Color ColorX The color of the UI elements.
Width Float The width of the UI.
Height Float The height of the UI.
Thickness Float The thickness of the UI.
Slant Float How beveled the UI elements should be.
_textSlot Slot the slot of the text for the number this component is editing.
_textRenderer TextRenderer The text renderer for the number this component is editing.
_textEditor TextEditor The text editor that allows for direct editing of the number this component is editing.
_material reference drive of PBS_RimMetallic The material this UI is using.
_mesh reference drive of BevelStripeMesh The mesh this UI is using.
_textBounds field drive of Float2 The field to drive to make the UI fit around the text.
_colliderSize field drive of Float3 The field of the collider size for this UI.
_meshLeft reference drive of BevelStripeMesh The mesh being used by this component's left button.
_meshRight reference drive of BevelStripeMesh The mesh being used by this component's right button.
_textLeftBounds field drive of Float2 The field to drive to make the left button stay wrapped around its text.
_textRightBounds field drive of Float2 The field to drive to make the right button stay wrapped around its text.
_leftTextRenderer TextRenderer The text renderer for the left button.
_rightTextRenderer TextRenderer The text renderer for the right button.
_colliderLeftSize field drive of Float3 The collider size field of the left button.
_colliderRightSize field drive of Float3 The collider size field of the right button.
_leftOffset field drive of Float3 The collider offset field of the left button.
_rightOffset field drive of Float3 The collider offset field of the right button.
_leftTextPosition field drive of Float3 The text position field of the left button.
_rightTextPosition field drive of Float3 The text position field of the right button.
DriveField field drive of Float The field this component should drive with Value
AllowWriteBack Bool Whether changes to the value of the field targeted by DriveField should be written to this component's Value field instead.
Value Float The value that this component currently has for the edited field.
DecimalPoints Int How many decimal places this component should keep track of.
MinValue Float The minimum possible value for Value.
MaxValue Float The maximum possible value for Value.
IncrementValue Float How much to increment or decrement Value by when pressing the left and right buttons.
IsEnabled Bool Whether this Legacy UI element is enabled and usable.
_textDrive field drive of String The string field to drive with the current Value for the visuals.

Usage

Just dont.

Examples

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


See Also