GearBlocks
The GearBlocks Lua scripting API
Classes | Enumerations
SmashHammer.GearBlocks.Toolbox Namespace Reference

Classes

class  BuilderTool
 The builder tool. More...
 
class  GrabberTool
 The grabber tool. More...
 
interface  IBuilder
 Provides access to the builder tool's properties. More...
 
interface  ICommand
 A command in the undo / redo history. More...
 
interface  ICommandHistory
 A toolbox's undo / redo command history. More...
 
interface  IGrabber
 Provides access to the grabber tool's properties. More...
 
interface  IInventory
 Provides access to a player's inventory. More...
 
interface  ILinker
 Provides access to the linker tool's properties. More...
 
interface  IManipulator
 Provides access to a manipulator's properties. More...
 
interface  IMaterialApplier
 Provides access to the material tool's properties. More...
 
interface  IPainter
 Provides access to the painter tool's properties. More...
 
interface  IPartSelection
 Provides access to a toolbox's part selection. More...
 
interface  IPivotTargeter
 Provides access to the builder tool's targeted pivot. More...
 
interface  ISelectionManipulator
 Provides access to the builder tool's selection manipulators. More...
 
interface  ITargeter
 Provides access to a player's targeter. More...
 
interface  ITool
 Provides access to a tool's properties. More...
 
interface  IToolbox
 Provides access to a player's toolbox. More...
 
class  LinkerTool
 The linker tool. More...
 
class  MaterialTool
 The material tool. More...
 
class  PainterTool
 The painter tool. More...
 
class  ToolBase
 A tool. More...
 

Enumerations

enum  InventoryMode : byte { Normal , InfiniteParts }
 Player inventory mode. More...
 
enum  SelectMode : byte { ClearAdd , Add , Remove }
 Select mode. More...
 
enum  PivotClampMode : byte { ToBounds , ToGround , Off }
 Pivot clamp mode. More...
 

Enumeration Type Documentation

◆ InventoryMode

Player inventory mode.

Enumerator
Normal 

Limited parts. Available in Lua as invMode_Normal.

InfiniteParts 

Unlimited parts, HasPart / HasParts always return true in this mode. Available in Lua as invMode_InfiniteParts.

◆ SelectMode

Select mode.

Enumerator
ClearAdd 

Clear the selection first, then add to it. Available in Lua as selMode_ClearAdd.

Add 

Add to the selection. Available in Lua as selMode_Add.

Remove 

Remove from the selection. Available in Lua as selMode_Remove.

◆ PivotClampMode

Pivot clamp mode.

Enumerator
ToBounds 

Clamp to specified bounds. Available in Lua as pivClmpMode_ToBounds.

ToGround 

Clamp to the ground. Available in Lua as pivClmpMode_ToGround.

Off 

Don't clamp. Available in Lua as pivClmpMode_Off.