@cccode/fxr - v31.0.0
    Preparing search index...

    Class NodeSound

    Slot: NodeAudio

    Plays a sound effect when the node activates.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    sound: number

    The ID of the sound event to play.

    Default: 0

    type: NodeSound

    The numeric ID for the type of action this represents.

    unk_ds3_f1_1: number

    Volume multiplier in Dark Souls 3 and possibly Sekiro, and seemingly does nothing in later games.

    Default: 1

    unk_ds3_f1_2: boolean

    Controls whether the sound will repeat or not in Dark Souls 3 and possibly Sekiro, and seemingly does nothing in later games.

    Default: false

    Accessors

    Methods

    • Creates a minified version of this action.

      Some actions can be minified to make the output smaller. This is done by creating a simpler action that is functionally equivalent to this action.

      Actions that can not be minified will not be changed.

      Returns any

    • Scale the rate of time for the action.

      This method's main purpose is to serve as a fallback for changing the rate of time for Dark Souls 3 effects, which doesn't support the rateOfTime property. The rate of time is automatically scaled when writing effects for DS3, you do not need to do this yourself. As such, this method is only useful if you want to scale the rate of time for individual parts of an effect, or if you need the extra options available for this method.

      Parameters

      • factor: number

        The factor to scale the rate of time by. Setting this to 2 will make the action play twice as fast. Setting it to 0.5 will make it play half as fast.

      • Optionaloptions: { scaleTracerDuration?: boolean } = {}

        Extra options for changing how the scaling is applied to different properties.

      Returns NodeSound