BuildToolProps

What BuildTool takes.

Properties

Property	Type	Default value	Description
aimDistance?	number	60	Metres the aim reaches from the camera.
colors?	BuildToolColors	undefined	-
mode	BuildToolMode	undefined	-
onCancel?	() => void	undefined	Called as the player cancels, by X, a right click or the Cancel button: after the tool puts down a piece a move holds, so a game leaves build mode here.
piece?	PieceHandle	undefined	The piece in hand, for Place.
showAreas?	boolean	true	Draws the areas while the tool is mounted, coloured by what the player may do in each: red where nobody builds, blue where anyone adds, green where the player builds, grey where the player may not.
store?	boolean	true where the plugin keeps storage	For Remove, whether the piece goes into storage rather than away for good.
variant?	string	its own look	One of the piece’s variants.