Class Blocks

Represents a group of blocks.

Hierarchy

Child
Hierarchy
- Blocks

Index

Constructors

Properties

fileBlocks fileChild fileShape

Accessors

bounds color position rotation shapeId

Methods

connectTo disconnectFrom getConnectedIds getId updateValues convert create

Constructors

constructor

new Blocks(fileBlocks: FileChild & { bounds: FileVector3 }): Blocks
Parameters
- fileBlocks: FileChild & { bounds: FileVector3 }
Returns Blocks
Overrides Child.constructor
- Defined in class/blueprint.ts:228

Properties

`Readonly` fileBlocks

fileBlocks: FileChild & { bounds: FileVector3 }

`Readonly` fileChild

fileChild: FileChild

`Readonly` fileShape

fileShape: FileShape

Accessors

bounds

get bounds(): Vector3
The bounds of the group of blocks.

Returns Vector3
- Defined in class/blueprint.ts:272
set bounds(value: Vector3): void
Parameters
- value: Vector3
Returns void
- Defined in class/blueprint.ts:275

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): undefined | Blocks
Attempts to convert a Child to Blocks. Only returns if the Child's file object is Blocks.

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

`Static` create

create(shapeId: string, position: Vector3, bounds?: Vector3, color?: string): Blocks
Creates a group of blocks.

Returns
The created group of blocks.
Parameters
- shapeId: string
  
  The shapeId of the group of blocks.
- position: Vector3
  
  The position of the group of blocks.
- bounds: Vector3 = ...
  
  The bounds of the group of blocks.
- Optional color: string
  
  The color of the group of blocks. Fallbacks to the block's default color.
Returns Blocks
- Defined in class/blueprint.ts:243

Generated using TypeDoc