Skip to content

Definition Fields

Ashley Bennett edited this page Sep 16, 2023 · 29 revisions

ToolType

What type(s) of tool this is - if multiple, the user will be able to switch between modes.
Valid values: Drill - Grind - GrindDrill - Weld - WeldDrill - WeldGrind - Multi


EffectShape

Shape of the volume affected by the tool.
Valid values: Sphere - Cylinder - Cuboid - Line - Ray
Note: Line will hit everything along its path, Ray will only hit the first item in its path.


WorkOrder

Order in which blocks/voxels are worked on in the tool volume.
Valid values:
Uniform - All objects are worked on simultaneously
InsideOut - Objects nearest to the centre of the volume are worked on first
OutsideIn - Objects farthest from the centre of the volume are worked on first
Forward - Objects are worked on starting from the back of the volume and moving forward
Backward - Objects are worked on starting from the front of the volume and moving backward


WorkOrigin

The location the tool volume should be centred at.
Valid values:
Centre - The volume will be centred on the centre of the block
Dummy - The volume will be centred on the specified model dummy
Hit - The volume will be centred on the first object hit directly in front of the tool


Emitter

(Optional) The name of the dummy to centre the tool volume on, if applicable.
(If this is a subpart, include the "subpart_" in the name.)


Offset

(Optional) The vector by which to offset the centre of the volume from the location specified in WorkOrigin.


HalfExtent

Required only for Cuboid shape: the dimensions of the volume.


Radius

Required for Sphere and Cylinder shape, and for drills using Line and Ray shape: the radius of the volume.


Length

Required for Cylinder, Line, and Ray shapes, or when using the Hit setting for WorkOrigin:
The length of the volume, or max distance from the emitter.


Speed

The working speed of the tool - a value of 1 equates to normal weld/grind speed, or one meter of voxel per pass.

Clone this wiki locally