Class TotebotPart

Represents a totebot head.

Hierarchy

Child
Hierarchy
- TotebotPart

Index

Constructors

constructor

new TotebotPart(fileTotebot: FileChild & { controller: TotebotControllerData }): TotebotPart
Parameters
- fileTotebot: FileChild & { controller: TotebotControllerData }
Returns TotebotPart
Overrides Child.constructor
- Defined in class/blueprint.ts:1428

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

dance

get dance(): boolean
Whether the totebot's sounds are in dance mode.

Returns boolean
- Defined in class/blueprint.ts:1507
set dance(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in class/blueprint.ts:1510

headType

get headType(): TotebotType
The type of the totebot head.

Returns TotebotType
- Defined in class/blueprint.ts:1517
set headType(value: TotebotType): void
Parameters
- value: TotebotType
Returns void
- Defined in class/blueprint.ts:1520

pitch

get pitch(): number
The pitch of the totebot head (0-1).

Returns number
- Defined in class/blueprint.ts:1487
set pitch(value: number): void
Parameters
- value: number
Returns void
- Defined in class/blueprint.ts:1490

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

volume

get volume(): number
The volume of the totebot head (0-100).

Returns number
- Defined in class/blueprint.ts:1497
set volume(value: number): void
Parameters
- value: number
Returns void
- Defined in class/blueprint.ts:1500

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

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

`Static` create

create(position: Vector3, rotation: Axis, color?: string, headType?: TotebotType, pitch?: number, volume?: number, dance?: boolean): TotebotPart
Creates a totebot head.

Returns
Parameters
- position: Vector3
  
  The position of the totebot head.
- rotation: Axis
  
  The rotation of the totebot head.
- Optional color: string
  
  The color of the totebot head. Fallbacks to the totebot head's default color.
- headType: TotebotType = "Synth Voice"
  
  The type of the totebot head. Defaults to "Synth Voice".
- pitch: number = 0.48
  
  The pitch of the totebot head (0-1). Defaults to 0.48.
- volume: number = 100
  
  The volume of the totebot head (0-100). Defaults to 100.
- dance: boolean = false
  
  Whether the totebot's sounds are in dance mode. Defaults to false.
Returns TotebotPart
- Defined in class/blueprint.ts:1446

Class TotebotPart

Hierarchy

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

fileTotebot: FileChild & { controller: TotebotControllerData }

Returns TotebotPart

Properties

Readonly fileChild

Readonly fileShape

Accessors

color

Returns string

Parameters

value: string

Returns void

dance

Returns boolean

Parameters

value: boolean

Returns void

headType

Returns TotebotType

Parameters

value: TotebotType

Returns void

pitch

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

volume

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[]

getId

Returns

Returns number

Protected updateValues

Returns void

Static convert

Returns

Parameters

potential: Child

Returns undefined | TotebotPart

Static create

`Readonly` fileChild

`Readonly` fileShape

`Protected` updateValues

`Static` convert

`Static` create

`Optional` color: string