Class LightPart

Represents a light.

Hierarchy

Child
Hierarchy
- LightPart

Index

Constructors

constructor

new LightPart(fileLight: FileChild & { controller: LightControllerData }): LightPart
Parameters
- fileLight: FileChild & { controller: LightControllerData }
Returns LightPart
Overrides Child.constructor
- Defined in class/blueprint.ts:1367

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

luminance

get luminance(): number
The luminance of the light.

Returns number
- Defined in class/blueprint.ts:1416
set luminance(value: number): void
Parameters
- value: number
Returns void
- Defined in class/blueprint.ts:1419

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

Returns
The converted LightPart, or undefined if the Child is not a LightPart.
Parameters
- potential: Child
  
  The Child to convert.
Returns undefined | LightPart
Overrides Child.convert
- Defined in class/blueprint.ts:1407

`Static` create

create(position: Vector3, rotation: Axis, color?: string, luminance?: number): LightPart
Creates a light.

Returns
The created light.
Parameters
- position: Vector3
  
  The position of the light.
- rotation: Axis
  
  The rotation of the light.
- Optional color: string
  
  The color of the light. Fallbacks to the light's default color.
- luminance: number = 1
  
  The luminance of the light. Defaults to 1.
Returns LightPart
- Defined in class/blueprint.ts:1382

Class LightPart

Hierarchy

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

fileLight: FileChild & { controller: LightControllerData }

Returns LightPart

Properties

Readonly fileChild

Readonly fileShape

Accessors

color

Returns string

Parameters

value: string

Returns void

luminance

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

disconnectFrom

Parameters

other: number | Child

Returns void

getConnectedIds

Returns

Returns number[]

getId

Returns

Returns number

Protected updateValues

Returns void

Static convert

Returns

Parameters

potential: Child

Returns undefined | LightPart

Static create

Returns

Parameters

position: Vector3

rotation: Axis

Optional color: string

luminance: number = 1

Returns LightPart

Settings

Member Visibility

Theme

`Readonly` fileChild

`Readonly` fileShape

`Protected` updateValues

`Static` convert

`Static` create

`Optional` color: string