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

Classes

class  AttachmentOperationsAsset
 Attachment operations. More...
 
class  Construction
 A construction is made up of one or more parts assembled together. More...
 
class  ConstructionOperationsAsset
 Construction operations. More...
 
interface  IAttachment
 An attachment between two parts. More...
 
interface  IAttachmentOperations
 Provides access to operations that can be performed on attachments. More...
 
interface  ICheckpoint
 Provides access to a checkpoint part behaviour. More...
 
interface  IConstruction
 Provides access to a construction's properties. More...
 
interface  IConstructionOperations
 Provides access to operations that can be performed on constructions. More...
 
interface  IControllablePartBehaviour
 Provides additional information about a controllable part behaviour. More...
 
interface  IEnergyStore
 Provides access to an energy store part behaviour. More...
 
interface  IEngineCrank
 Provides access to an engine crank part behaviour. More...
 
interface  IEngineCylinder
 Provides access to an engine cylinder part behaviour. More...
 
interface  IEngineDrivenCrank
 Provides access to a driven engine crank part behaviour. More...
 
interface  IEngineHead
 Provides access to an engine head part behaviour. More...
 
interface  ILink
 A link between two part's link nodes, creating a logical connection between them. More...
 
interface  ILinkNode
 A node that can be linked to another part's node, creating a logical connection between them. More...
 
interface  IPart
 Provides access to a part's properties. More...
 
interface  IPartAttachments
 Provides access to a part's attachments. More...
 
interface  IPartBehaviour
 Provides information about a part behaviour. More...
 
interface  IPartBehaviourOperations
 Provides access to operations that can be performed on part behaviours. More...
 
interface  IPartPaint
 Provides access to a part's paint colour. More...
 
interface  IPartProperties
 Provides access to a part's material properties. More...
 
interface  IPopulateConstructions
 Provides access to methods for spawning and destroying constructions. More...
 
interface  IResizable
 Provides access to a resizable part's dimensions. More...
 
interface  ITweakables
 A part behaviour with tweakables. More...
 
class  PartBehaviourActivatableBase
 A part behaviour that can be activated / deactivated. More...
 
class  PartBehaviourBase
 A part behaviour. More...
 
class  PartBehaviourControllableBase
 A part behaviour that can be controlled. More...
 
class  PartBehaviourOperationsAsset
 Part behaviour operations. More...
 
class  PartBehaviourTriggerableBase
 A part behaviour that can be triggered. More...
 
class  PartColliderRegistry
 A registry of all part colliders in the scene. More...
 
class  PartDescriptor
 An individual component, such as a beam, wheel, or motor. More...
 
class  PartDescriptorProcedural
 A resizable procedurally generated part. More...
 
class  PopulateConstructionsAsset
 Populate constructions. More...
 

Enumerations

enum  AttachmentTypeFlags : byte {
  Fixed = 0x01 , RotaryBearing = 0x02 , LinearBearing = 0x04 , LinearRotaryBearing = 0x08 ,
  SphericalBearing = 0x10 , ConstantVelocityJoint = 0x20 , KnuckleJoint = 0x40 , Null = 0x80
}
 Attachment type. More...
 
enum  SetStageMode : byte { SetAll , Increment , Decrement }
 Stage set mode. More...
 

Enumeration Type Documentation

◆ AttachmentTypeFlags

Attachment type.

Enumerator
Fixed 

No relative movement allowed, parts are connected rigidly together. Available in Lua as attachType_Fixed.

RotaryBearing 

Allows for relative rotation around a single axis. Available in Lua as attachType_RotaryBearing.

LinearBearing 

Allows for relative translation along the sliding direction. Available in Lua as attachType_LinearBearing.

LinearRotaryBearing 

A combination of the previous two types, allows for both translation and rotation. Available in Lua as attachType_LinearRotaryBearing.

SphericalBearing 

Allows for relative rotation in multiple directions, while remaining locked in position, like a "ball and socket". Available in Lua as attachType_SphericalBearing.

ConstantVelocityJoint 

Allows for relative rotation in multiple directions, except around the primary axis. Available in Lua as attachType_ConstantVelocityJoint.

KnuckleJoint 

Allows for relative rotation around a single axis, but with a limited range of motion, like a knee or elbow joint. Available in Lua as attachType_KnuckleJoint.

Null 

Parts are not physically attached, but remain part of the same construction. Available in Lua as attachType_Null.

◆ SetStageMode

Stage set mode.

Enumerator
SetAll 

Set all parts to the specified stage index. Available in Lua as setStgMode_SetAll.

Increment 

Increment each part's stage index by one. Available in Lua as setStgMode_Increment.

Decrement 

Decrement each part's stage index by one. Available in Lua as setStgMode_Decrement.