Class HornPart

Represents a horn.

Hierarchy

  • Child

    Hierarchy

    • HornPart

Constructors

constructor

Properties

fileChild fileShape

Accessors

color pitch position rotation shapeId

Methods

connectTo disconnectFrom getConnectedIds getId updateValues convert create

Constructors

constructor

Properties

Readonly fileChild

fileChild: FileChild

Readonly fileShape

fileShape: FileShape

Accessors

color

  • get color(): string

  • The color of this shape.

    Returns string

  • set color(value: string): void

  • Parameters

    • value: string

    Returns void

pitch

  • get pitch(): number

  • The pitch of the horn.

    Note

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

    Returns number

  • set pitch(value: number): void

  • Parameters

    • value: number

    Returns void

position

rotation

shapeId

  • get shapeId(): string

  • The shapeId of this shape. Determines the model and behavior in-game.

    Returns string

  • set shapeId(value: string): void

  • Parameters

    • value: string

    Returns void

Methods

connectTo

  • 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

disconnectFrom

  • Disconnects this child from another child.

    Parameters

    • other: number | Child

      The Child object or the ID of the child to disconnect from.

    Returns void

getConnectedIds

getId

Protected updateValues

Static convert

  • Attempts to convert a Child to a HornPart. Only returns if the Child's file object is a HornPart.

    Returns

    The converted HornPart, or undefined if the Child is not a HornPart.

    Parameters

    • potential: Child

      The Child to convert.

    Returns undefined | HornPart

Static create

  • Creates a horn.

    Returns

    The created horn.

    Parameters

    • position: Vector3

      The position of the horn.

    • rotation: Axis

      The rotation of the horn.

    • Optional color: string

      The color of the horn. Fallbacks to the horn's default color.

    • pitch: number = 0

      The pitch of the horn. Defaults to 0.

    Returns HornPart

Settings

Member Visibility

Theme

Generated using TypeDoc