template |
add info |
||
| Line 3: | Line 3: | ||
|Name=Meter Tool | |Name=Meter Tool | ||
}} | }} | ||
See [[Meter Tool]]. | |||
== | == Fields == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|_equipLink|{{RootFieldType|LinkTarget`1|[[Type:ITool|ITool]]}}|TypeAdv0=true| {{Template:ITool _equipLink}} | |_equipLink|{{RootFieldType|LinkTarget`1|[[Type:ITool|ITool]]}}|TypeAdv0=true| {{Template:ITool _equipLink}} | ||
| Line 14: | Line 14: | ||
|_overrideActiveTool|'''[[Component:InteractionHandler|InteractionHandler]]'''|TypeAdv5=true| {{Template:ITool _overrideActiveTool}} | |_overrideActiveTool|'''[[Component:InteractionHandler|InteractionHandler]]'''|TypeAdv5=true| {{Template:ITool _overrideActiveTool}} | ||
|_gripPosesGenerated|Bool| {{Template:ITool _gripPosesGenerated}} | |_gripPosesGenerated|Bool| {{Template:ITool _gripPosesGenerated}} | ||
|_indicationColor|'''[[Type:IField`1|IField`1]]<[[Type:ColorX|ColorX]]>'''|TypeAdv7=true| | |_indicationColor|'''[[Type:IField`1|IField`1]]<[[Type:ColorX|ColorX]]>'''|TypeAdv7=true| The field to change the color value for when doing status indications. | ||
|MeterMode|'''[[#Mode|Mode]]'''|TypeAdv8=true| | |MeterMode|'''[[#Mode|Mode]]'''|TypeAdv8=true| The mode the tool is currently in. | ||
|MeasureInObjectSpace|Bool| | |MeasureInObjectSpace|Bool| If measurements should be done in global space or parent space. | ||
|RaycastIgnoresUsers|Bool| | |RaycastIgnoresUsers|Bool| Whether the tool raycast ignores colliders with an active user. | ||
|MultiPoint|Bool| | |MultiPoint|Bool| Measure between two points, or any amount of points. | ||
|_lastPoint|Slot| | |_lastPoint|Slot| The slot of the last point placed by the tool. | ||
|_currentMeter|'''[[Component:DistanceMeter|DistanceMeter]]'''|TypeAdv13=true| | |_currentMeter|'''[[Component:DistanceMeter|DistanceMeter]]'''|TypeAdv13=true| The current object displaying the distance between | ||
|_currentLineTransform|'''[[Component:LineTransform|LineTransform]]'''|TypeAdv14=true| | |_currentLineTransform|'''[[Component:LineTransform|LineTransform]]'''|TypeAdv14=true| | ||
|FormatNumber|String| | |FormatNumber|String| How to format the numbers. | ||
|FormatUnit|String| | |FormatUnit|String| How to format the units. | ||
}} | |||
== Mode == | |||
{{Table EnumValues | |||
|Ray|0|Shoots a ray from the tip of the tool and places a point wherever it hits. | |||
|Perpendicular|1|Shoots a ray up from where the first point is placed. | |||
|Drag|2|Puts points between where you start and stop dragging. | |||
}} | }} | ||
== | == Usage == | ||
See [[Meter Tool]]. | |||
== Examples == | == Examples == | ||
See [[Meter Tool]]. | |||
== See Also == | == See Also == | ||
* [[Meter Tool]] | |||
[[Category:Components:Tools{{#translation:}}|Meter Tool]] | [[Category:Components:Tools{{#translation:}}|Meter Tool]] | ||
[[Category:Components{{#translation:}}|Meter Tool]] | [[Category:Components{{#translation:}}|Meter Tool]] | ||
[[Category:Components With Nested Enums{{#translation:}}|Meter Tool]] | [[Category:Components With Nested Enums{{#translation:}}|Meter Tool]] | ||
Revision as of 20:11, 22 December 2024
Component image 
Meter Tool component as seen in the Scene Inspector
See Meter Tool.
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. |
_equipLink
|
direct LinkTarget`1<ITool> | This is Internal, and is used by the engine to retrieve the component this field is a part of. It cannot be assigned to. |
TipReference
|
Slot | The slot to use as the tool's tip, instead of the component's slot. |
BlockGripEquip
|
Bool | Whether to prevent legacy double grip equipping from equipping this tooltip. |
BlockRemoteEquip
|
Bool | Whether to prevent equipping by clicking via laser |
EquipName
|
String | The name of the tool in the context menu when equipping via context menu. |
_overrideActiveTool
|
InteractionHandler | The interaction handler to use instead of this tool as an interaction handler. |
_gripPosesGenerated
|
Bool | Whether the Grip Pose Reference components and slots have been generated for this tool. |
_indicationColor
|
IField`1<ColorX> | The field to change the color value for when doing status indications. |
MeterMode
|
Mode | The mode the tool is currently in. |
MeasureInObjectSpace
|
Bool | If measurements should be done in global space or parent space. |
RaycastIgnoresUsers
|
Bool | Whether the tool raycast ignores colliders with an active user. |
MultiPoint
|
Bool | Measure between two points, or any amount of points. |
_lastPoint
|
Slot | The slot of the last point placed by the tool. |
_currentMeter
|
DistanceMeter | The current object displaying the distance between |
_currentLineTransform
|
LineTransform | |
FormatNumber
|
String | How to format the numbers. |
FormatUnit
|
String | How to format the units. |
Mode
| Name | Value | Description |
|---|---|---|
Ray
|
0 | Shoots a ray from the tip of the tool and places a point wherever it hits. |
Perpendicular
|
1 | Shoots a ray up from where the first point is placed. |
Drag
|
2 | Puts points between where you start and stop dragging. |
Usage
See Meter Tool.
Examples
See Meter Tool.