add info, but info could use a touchup later |
fix sentence |
||
Line 3: | Line 3: | ||
|Name=Distance Meter | |Name=Distance Meter | ||
}} | }} | ||
The '''DistanceMeter''' component is used by the [[Meter Tool]] to display the distance between slots. | The '''DistanceMeter''' component is used by the [[Meter Tool]] to display the distance between slots placed by it. | ||
== Usage == | == Usage == |
Latest revision as of 20:06, 22 December 2024
Component image
The DistanceMeter component is used by the Meter Tool to display the distance between slots placed by it.
Usage
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. |
Anchors
|
list of Slot | List of points being used to measure right now. |
_legacyAnchor0
|
Slot | Legacy, unused. For when the tool only measured two points. |
_legacyAnchor1
|
Slot | Legacy, unused. For when the tool only measured two points. |
FormatUnit
|
String | The formatting string to use when formatting the distance number |
FormatNumber
|
String | How to format the distance number |
CompoundFormatUnits
|
direct SyncFieldList`1<String> | The format string to format compound measurement units with. |
CompoundUseLongNames
|
Bool | Whether to use long name of distance (Ex: cm vs Centimeter) |
CompoundOverrideNames
|
Bool | Whether to use compound measurements or not. |
CompoundDiscardLastFraction
|
Bool | Whether to discard small distances like Millimeters. |
CompoundSeparator
|
String | What to separate compound measurements with (like spaces or commas) |
CompoundZeroHandling
|
CompoundZeroHandling | How to handle compound measurements (1 meter 1cm 10mm) |
MeasurementSpace
|
direct RootSpace | The transform space to measure in. |
DistanceText
|
field drive of String | The field to drive when displaying the total amount of distance. |
Usage
See Meter Tool.
Examples
See Meter Tool.