@cccode/fxr - v22.0.0

    Class RectangularSpread

    Slot: DirectionSpread

    Gives each emitted instance a random initial direction offset within a rectangular cone. See InitialDirection for more information.

    Hierarchy (View Summary, Expand)

    Index

    Constructors

    Properties

    angleX: ScalarValue

    The maximum change in direction in degrees, one of the angles of the elliptical cone.

    Default: 30

    Argument: Active time

    See also:

    angleY: ScalarValue

    The maximum change in direction in degrees, one of the angles of the elliptical cone.

    Default: 30

    Argument: Active time

    See also:

    distribution: ScalarValue

    Controls the distribution of the random directions that can be chosen.

    • At 0, all directions within the cone have an equal chance of being chosen.
    • At 1, the default direction is guaranteed to be chosen.
    • At -1, the maximum change in direction is guaranteed, meaning the chosen direction will always be a fixed number of degrees away from the default direction based on angleX and angleY.
    • Values between these values smoothly blend between them.
    • Values outside of the -1 to 1 range also work, but may do some unexpected things.

    Default: 0

    Argument: Active time

    The numeric ID for the type of action this represents.

    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 RectangularSpread

    MMNEPVFCICPMFPCPTTAAATR