Class TimerPart

Represents a timer.

Hierarchy

Child
Hierarchy
- TimerPart

Index

Constructors

constructor

new TimerPart(fileTimer: FileChild & { controller: TimerControllerData }): TimerPart
Parameters
- fileTimer: FileChild & { controller: TimerControllerData }
Returns TimerPart
Overrides Child.constructor
- Defined in class/blueprint.ts:1274

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

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

seconds

get seconds(): number
The seconds value of the timer's delay.

Returns number
- Defined in class/blueprint.ts:1345
set seconds(value: number): void
Parameters
- value: number
Returns void
- Defined in class/blueprint.ts:1348

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

ticks

get ticks(): number
The ticks value of the timer's delay.

Returns number
- Defined in class/blueprint.ts:1355
set ticks(value: number): void
Parameters
- value: number
Returns void
- Defined in class/blueprint.ts:1358

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

getDelay

getDelay(): number
Gets the number of total seconds (including decimals) the timer delays signals, using both the seconds value and the ticks value.

Returns
The number of seconds the timer delays signals.

Returns number
- Defined in class/blueprint.ts:1326

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

setDelay

setDelay(seconds: number): void
Sets the number of total seconds (including decimals) the timer delays signals, converting it to seconds and ticks.
Parameters
- seconds: number
  
  The number of seconds the timer should delay signals.
Returns void
- Defined in class/blueprint.ts:1337

`Protected` updateValues

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

`Static` convert

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

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

`Static` create

create(position: Vector3, rotation: Axis, color?: string, seconds?: number, ticks?: number): TimerPart
Creates a timer.
Parameters
- position: Vector3
  
  The position of the timer.
- rotation: Axis
  
  The rotation of the timer.
- Optional color: string
  
  The color of the timer. Fallbacks to the timer's default color.
- seconds: number = 0
  
  The number of seconds the timer should delay signals. Defaults to 0.
- ticks: number = 0
  
  The number of ticks (1/40s) the timer should delay signals. Added onto the seconds. Defaults to 0.
Returns TimerPart
- Defined in class/blueprint.ts:1289

Class TimerPart

Hierarchy

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

fileTimer: FileChild & { controller: TimerControllerData }

Returns TimerPart

Properties

Readonly fileChild

Readonly fileShape

Accessors

color

Returns string

Parameters

value: string

Returns void

position

Returns Vector3

Parameters

value: Vector3

Returns void

rotation

Returns Axis

Parameters

value: Axis

Returns void

seconds

Returns number

Parameters

value: number

Returns void

shapeId

Returns string

Parameters

value: string

Returns void

ticks

Returns number

Parameters

value: number

Returns void

Methods

connectTo

Parameters

other: number | Child

Returns void

disconnectFrom

Parameters

other: number | Child

Returns void

getConnectedIds

Returns

Returns number[]

getDelay

Returns

Returns number

getId

Returns

Returns number

setDelay

Parameters

seconds: number

Returns void

Protected updateValues

Returns void

Static convert

Returns

Parameters

potential: Child

Returns undefined | TimerPart

Static create

Parameters

position: Vector3

rotation: Axis

`Readonly` fileChild

`Readonly` fileShape

`Protected` updateValues

`Static` convert

`Static` create

`Optional` color: string