Class Part

Represents any non-block part.

Hierarchy

Child
Hierarchy
- Part

Index

Constructors

Properties

fileChild filePart fileShape

Accessors

color position rotation shapeId

Methods

connectTo disconnectFrom getConnectedIds getId updateValues convert create

Constructors

constructor

new Part(filePart: FileChild): Part
Parameters
- filePart: FileChild
Returns Part
Overrides Child.constructor
- Defined in class/blueprint.ts:186

Properties

`Readonly` fileChild

fileChild: FileChild

`Readonly` filePart

filePart: FileChild

`Readonly` fileShape

fileShape: FileShape

Accessors

color

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

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

position

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

Returns Vector3
Inherited from Child.position
- Defined in class/blueprint.ts:111
set position(value: Vector3): void
Parameters
- value: Vector3
Returns void
Inherited from Child.position
- Defined in class/blueprint.ts:114

rotation

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

Returns Axis
Inherited from Child.rotation
- Defined in class/blueprint.ts:122
set rotation(value: Axis): void
Parameters
- value: Axis
Returns void
Inherited from Child.rotation
- Defined in class/blueprint.ts:125

shapeId

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

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

Methods

connectTo

connectTo(other: number | Child): void
Connects this child to another child. Both children must be interactable.
Parameters
- other: number | Child
  
  The Child object or the ID of the child to connect to.
Returns void
Inherited from Child.connectTo
- Defined in class/blueprint.ts:141

disconnectFrom

disconnectFrom(other: number | Child): void
Disconnects this child from another child.
Parameters
- other: number | Child
  
  The Child object or the ID of the child to disconnect from.
Returns void
Inherited from Child.disconnectFrom
- Defined in class/blueprint.ts:153

getConnectedIds

getConnectedIds(): number[]
Gets a list of the IDs of the children this child is connected to.

Returns
The list of IDs.

Returns number[]
Inherited from Child.getConnectedIds
- Defined in class/blueprint.ts:175

getId

getId(): number
Gets the ID of the child.

Returns
The ID of the child.

Returns number
Inherited from Child.getId
- Defined in class/blueprint.ts:167

`Protected` updateValues

updateValues(): void
Returns void
Inherited from Child.updateValues
- Defined in class/blueprint.ts:100

`Static` convert

convert(potential: Child): Part
Attempts to convert a Child to a Part. Only returns if the Child's file object is a Part.

Returns
The converted Part, or undefined if the Child was not a Part.
Parameters
- potential: Child
  
  The Child to convert.
Returns Part
Overrides Child.convert
- Defined in class/blueprint.ts:219

`Static` create

create(shapeId: string, position: Vector3, rotation: Axis, color?: string): Part
Creates a part.

Returns
The created part.
Parameters
- shapeId: string
  
  The shapeId of the part.
- position: Vector3
  
  The position of the part.
- rotation: Axis
  
  The rotation of the part.
- Optional color: string
  
  The color of the part. Fallbacks to the part's default color.
Returns Part
- Defined in class/blueprint.ts:197

Generated using TypeDoc