Class PistonJoint

Represents a piston joint.

Hierarchy

Joint
Hierarchy
- PistonJoint

Index

Constructors

constructor

new PistonJoint(fileJoint: FileJoint & { controller: PistonControllerData }): PistonJoint
Parameters
- fileJoint: FileJoint & { controller: PistonControllerData }
Returns PistonJoint
Overrides Joint.constructor
- Defined in class/blueprint.ts:364

Properties

`Readonly` fileJoint

fileJoint: FileJoint & { controller: PistonControllerData }

`Readonly` fileShape

fileShape: FileShape

Accessors

color

get color(): string
The color of this shape.

Returns string
Inherited from Joint.color
- Defined in class/blueprint.ts:57
set color(value: string): void
Parameters
- value: string
Returns void
Inherited from Joint.color
- Defined in class/blueprint.ts:60

length

get length(): number
The length of the piston joint.

Returns number
- Defined in class/blueprint.ts:434
set length(value: number): void
Parameters
- value: number
Returns void
- Defined in class/blueprint.ts:437

position

get position(): Vector3
The position of this joint.

Returns Vector3
Inherited from Joint.position
- Defined in class/blueprint.ts:329
set position(value: Vector3): void
Parameters
- value: Vector3
Returns void
Inherited from Joint.position
- Defined in class/blueprint.ts:332

rotation

get rotation(): Axis
The rotation of this joint.

Returns Axis
Inherited from Joint.rotation
- Defined in class/blueprint.ts:340
set rotation(value: Axis): void
Parameters
- value: Axis
Returns void
Inherited from Joint.rotation
- Defined in class/blueprint.ts:343

shapeId

get shapeId(): string
The shapeId of this shape. Determines the model and behavior in-game.

Returns string
Inherited from Joint.shapeId
- Defined in class/blueprint.ts:67
set shapeId(value: string): void
Parameters
- value: string
Returns void
Inherited from Joint.shapeId
- Defined in class/blueprint.ts:70

speed

get speed(): number
The speed of the piston joint.

Returns number
- Defined in class/blueprint.ts:444
set speed(value: number): void
Parameters
- value: number
Returns void
- Defined in class/blueprint.ts:447

Methods

getId

getId(): number
Gets the ID of this joint.

Returns
The ID.

Returns number
Inherited from Joint.getId
- Defined in class/blueprint.ts:355

`Protected` updateValues

updateValues(): void
Returns void
Overrides Joint.updateValues
- Defined in class/blueprint.ts:422

`Static` _internalCreate

_internalCreate(shapeId: string, position: Vector3, rotation: Axis, childA: Child, childB?: Child, color?: string): Joint
Parameters
- shapeId: string
- position: Vector3
- rotation: Axis
- childA: Child
- Optional childB: Child
- Optional color: string
Returns Joint
Inherited from Joint._internalCreate
- Defined in class/blueprint.ts:291

`Static` convert

convert(potential: Joint): undefined | PistonJoint
Attempts to convert a Joint to PistonJoint. Only returns if the Joint's file object is a PistonJoint.

Returns
The converted PistonJoint, or undefined if the Joint was not a PistonJoint.
Parameters
- potential: Joint
  
  The Joint to convert.
Returns undefined | PistonJoint
- Defined in class/blueprint.ts:416

`Static` create

create(position: Vector3, rotation: Axis, childA: Child, childB?: Child, color?: string, length?: number, speed?: number): PistonJoint
Creates a piston joint.

Returns
The created piston joint.
Parameters
- position: Vector3
  
  The position of the piston joint.
- rotation: Axis
  
  The rotation of the piston joint.
- childA: Child
  
  The first child of the piston joint.
- Optional childB: Child
  
  The second child of the piston joint. Optional.
- Optional color: string
  
  The color of the piston joint. Fallbacks to the piston's default color.
- length: number = 1
  
  The length of the piston joint. Unused if the piston is connected to a controller. Defaults to 1.
- speed: number = 1
  
  The speed of the piston joint. Unused if the piston is connected to a controller. Defaults to 1.
Returns PistonJoint
- Defined in class/blueprint.ts:382

Class PistonJoint

Hierarchy

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

fileJoint: FileJoint & { controller: PistonControllerData }

Returns PistonJoint

Properties

Readonly fileJoint

Readonly fileShape

Accessors

color

Returns string

Parameters

value: string

Returns void

length

Returns number

Parameters

value: number

Returns void

position

Returns Vector3

Parameters

value: Vector3

Returns void

rotation

Returns Axis

Parameters

value: Axis

Returns void

shapeId

Returns string

Parameters

value: string

Returns void

speed

Returns number

Parameters

value: number

Returns void

Methods

getId

Returns

Returns number

Protected updateValues

Returns void

Static _internalCreate

Parameters

shapeId: string

position: Vector3

rotation: Axis

childA: Child

Optional childB: Child

Optional color: string

Returns Joint

Static convert

Returns

Parameters

potential: Joint

Returns undefined | PistonJoint

Static create

Returns

Parameters

position: Vector3

rotation: Axis

childA: Child

Optional childB: Child

Optional color: string

length: number = 1

speed: number = 1

Returns PistonJoint

Settings

Member Visibility

`Readonly` fileJoint

`Readonly` fileShape

`Protected` updateValues

`Static` _internalCreate

`Optional` childB: Child

`Optional` color: string

`Static` convert

`Static` create

`Optional` childB: Child

`Optional` color: string