Class EnginePart

Represents an engine.

Hierarchy

Child
Hierarchy
- EnginePart

Index

Constructors

constructor

new EnginePart(fileEngine: FileChild & { controller: EngineControllerData }): EnginePart
Parameters
- fileEngine: FileChild & { controller: EngineControllerData }
Returns EnginePart
Overrides Child.constructor
- Defined in class/blueprint.ts:950

Properties

`Readonly` fileChild

fileChild: 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

level

get level(): number
The level of the engine.

Note
Attempting to get this property from an engine in a blueprint saved in-game, without first setting it with this API, has a chance to return 0 instead of the actual level. This is due to some shenanigans with the way engine levels are stored within serialized Lua data.

Returns number
- Defined in class/blueprint.ts:1001
set level(value: number): void
Parameters
- value: number
Returns void
- Defined in class/blueprint.ts:1007

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

disconnectBearing

disconnectBearing(bearing: number | BearingJoint): void
Removes a connection to a bearing.
Parameters
- bearing: number | BearingJoint
  
  The bearing to disconnect from. Can be an ID.
Returns void
- Defined in class/blueprint.ts:1029

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

getConnectedBearingIds

getConnectedBearingIds(): number[]
Gets a list of IDs for any bearings connected to this engine.

Returns

Returns number[]
- Defined in class/blueprint.ts:1041

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

setBearing

setBearing(bearing: number | BearingJoint, reversed?: boolean): void
Adds or updates a connection to a bearing.
Parameters
- bearing: number | BearingJoint
  
  The bearing to connect to. Can be an ID.
- reversed: boolean = false
  
  Whether the bearing spins counter-clockwise looking from the front. Defaults to false.
Returns void
- Defined in class/blueprint.ts:1016

`Protected` updateValues

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

`Static` convert

convert(potential: Child): undefined | EnginePart
Attempts to convert a Child to an EnginePart. Only returns if the Child's file object is an EnginePart.
Parameters
- potential: Child
Returns undefined | EnginePart
Overrides Child.convert
- Defined in class/blueprint.ts:991

`Static` create

create(position: Vector3, rotation: Axis, color?: string, level?: number, electric?: boolean): EnginePart
Creates an engine.

Returns
The created engine.
Parameters
- position: Vector3
  
  The position of the engine.
- rotation: Axis
  
  The rotation of the engine.
- Optional color: string
  
  The color of the engine. Fallbacks to the engine's default color.
- level: number = 0
  
  The level of the engine. Defaults to 0.
- electric: boolean = false
  
  Whether the engine is electric. Defaults to false.
Returns EnginePart
- Defined in class/blueprint.ts:966

Class EnginePart

Hierarchy

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

fileEngine: FileChild & { controller: EngineControllerData }

Returns EnginePart

Properties

Readonly fileChild

Readonly fileShape

Accessors

color

Returns string

Parameters

value: string

Returns void

level

Note

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

Methods

connectTo

Parameters

other: number | Child

Returns void

disconnectBearing

Parameters

bearing: number | BearingJoint

Returns void

disconnectFrom

Parameters

other: number | Child

Returns void

getConnectedBearingIds

Returns

Returns number[]

getConnectedIds

Returns

Returns number[]

getId

Returns

Returns number

setBearing

Parameters

bearing: number | BearingJoint

reversed: boolean = false

Returns void

Protected updateValues

Returns void

Static convert

Parameters

potential: Child

Returns undefined | EnginePart

Static create

Returns

Parameters

position: Vector3

`Readonly` fileChild

`Readonly` fileShape

`Protected` updateValues

`Static` convert

`Static` create

`Optional` color: string