template |
add info |
||
| Line 3: | Line 3: | ||
|Name=Shape Tool | |Name=Shape Tool | ||
}} | }} | ||
See [[Shape 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}} | ||
|activeShape|'''[[#Shape|Shape]]'''|TypeAdv7=true| | |activeShape|'''[[#Shape|Shape]]'''|TypeAdv7=true| The shape to draw. | ||
|shapes|{{RootFieldType|SyncList`1|[[Type:SyncRef`1|SyncRef`1]]<[[Type:Slot|Slot]]>}}|TypeAdv8=true| | |shapes|{{RootFieldType|SyncList`1|[[Type:SyncRef`1|SyncRef`1]]<[[Type:Slot|Slot]]>}}|TypeAdv8=true| A list of shapes to switch between depending on <code>activeShape</code> for the tool tips visual. | ||
|Material|{{RootFieldType|AssetRef`1|[[Type:Material|Material]]}}|TypeAdv9=true| | |Material|{{RootFieldType|AssetRef`1|[[Type:Material|Material]]}}|TypeAdv9=true| The material to use when drawing shapes. | ||
}} | }} | ||
== | == Shape == | ||
{{Table EnumValues | |||
|Cube|0| Draw a cube. | |||
|Sphere|1| Draw a smooth sphere. | |||
|Cylinder|2| Draw a cylinder. | |||
|Cone|3| Draw a cone. | |||
|Quad|4| Draw a 2d square. | |||
|FlatSphere|5| Draw a flat shaded icosphere. | |||
}} | |||
== See Also == | == See Also == | ||
* [[Shape Tool]] | |||
[[Category:Components:Tools{{#translation:}}|Shape Tool]] | [[Category:Components:Tools{{#translation:}}|Shape Tool]] | ||
[[Category:Components{{#translation:}}|Shape Tool]] | [[Category:Components{{#translation:}}|Shape Tool]] | ||
[[Category:Components With Nested Enums{{#translation:}}|Shape Tool]] | [[Category:Components With Nested Enums{{#translation:}}|Shape Tool]] | ||
Latest revision as of 19:31, 2 February 2025
Component image 
Shape Tool component as seen in the Scene Inspector
See Shape 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. Some components stop their functionality when this field is disabled, but some don't. |
_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. |
activeShape
|
Shape | The shape to draw. |
shapes
|
list of SyncRef`1<Slot> | A list of shapes to switch between depending on activeShape for the tool tips visual.
|
Material
|
Material | The material to use when drawing shapes. |
Shape
| Name | Value | Description |
|---|---|---|
Cube
|
0 | Draw a cube. |
Sphere
|
1 | Draw a smooth sphere. |
Cylinder
|
2 | Draw a cylinder. |
Cone
|
3 | Draw a cone. |
Quad
|
4 | Draw a 2d square. |
FlatSphere
|
5 | Draw a flat shaded icosphere. |