@cccode/fxr - v22.0.0

    Class RadialBlur

    Slot: Appearance

    A particle that applies a radial blur to anything seen through it.

    Note: This particle is not visible if the "Effects" setting is set to "Low".

    Hierarchy (View Summary, Expand)

    Index

    Constructors

    Properties

    alphaMultiplier: ScalarValue

    Alpha multiplier.

    Default: 1

    Argument: Active time

    alphaThreshold: ScalarValue

    Parts of the particle with less opacity than this threshold will be invisible. The range is 0-255.

    This threshold creates a hard cut-off between visible and not visible, which is unlike the alpha fade threshold properties in some similar actions.

    Default: 0

    Argument: Active time

    Blend mode.

    Default: BlendMode.Normal

    Argument: Constant 0

    bloomColor: Vector4

    Controls the color of the additional bloom effect. The colors of the particle will be multiplied with this color to get the final color of the bloom effect.

    Note:

    • This has no effect if the "Effects Quality" setting is set to "Low".
    • This does not affect the natural bloom effect from high color values.

    Default: [1, 1, 1, 0]

    blurRadius: ScalarValue

    Controls the amount of blur to apply. Values greater than 1 may appear glitchy.

    Default: 0.5

    Argument: Particle age

    Color multiplier.

    Values in this will be clamped to the 0-1 range. There are no unrestricted color properties in this action, but rgbMultiplier and alphaMultiplier can be used to scale the colors.

    Default: [1, 1, 1, 1]

    Argument: Particle age

    height: ScalarValue

    The height of the particle.

    If uniformScale is enabled, width also controls the height, and this property is ignored.

    Default: 1

    Argument: Particle age

    See also:

    iterations: number

    Controls how many times to apply the effect. Higher values can have a significant impact on performance.

    Default: 1

    Mask texture ID. This texture is used to control the opacity of the particle.

    Default: 1

    Argument: Constant 0

    maxDistance: number

    Minimum view distance. If a particle is farther away than this distance from the camera, it will be hidden. Can be set to -1 to disable the limit.

    This requires maxFadeDistance to be set to a positive value or 0.

    This is different from maxDistanceThreshold, as this controls the start of a distance range that has smooth transitions at each end, while the threshold value is a hard cut-off.

    Default: -1

    See also:

    maxDistanceThreshold: number

    A hard cut-off point for the distance between the camera and the particle. If a particle is farther away than this distance from the camera, it will be hidden. Can be set to -1 to disable the limit.

    Default: -1

    See also:

    maxFadeDistance: number

    This controls a point where the opacity of a particle will start to fade to 0 near the maximum view distance. At maxDistance, the opacity will be 0, and it will linearly approach 1 as the distance between the camera and the particle approaches this distance.

    This requires maxDistance to be set to a positive value or 0. This distance limit can be disabled by setting this and minDistance to -1.

    Default: -1

    See also:

    minDistance: number

    Minimum view distance. If a particle is closer than this distance from the camera, it will be hidden. Can be set to -1 to disable the limit.

    This requires minFadeDistance to be set to a positive value or 0.

    This is different from minDistanceThreshold, as this controls the start of a distance range that has smooth transitions at each end, while the threshold value is a hard cut-off.

    Default: -1

    See also:

    minDistanceThreshold: number

    A hard cut-off point for the distance between the camera and the particle. If a particle is closer than this distance from the camera, it will be hidden. Can be set to -1 to disable the limit.

    Default: -1

    See also:

    minFadeDistance: number

    This controls a point where the opacity of a particle will start to fade to 0 near the minimum view distance. At minDistance, the opacity will be 0, and it will linearly approach 1 as the distance between the camera and the particle approaches this distance.

    This requires minDistance to be set to a positive value or 0. This distance limit can be disabled by setting this and minDistance to -1.

    Default: -1

    See also:

    offsetX: ScalarValue

    X position offset.

    Default: 0

    Argument: Particle age

    See also:

    offsetY: ScalarValue

    Y position offset.

    Default: 0

    Argument: Particle age

    See also:

    offsetZ: ScalarValue

    Z position offset.

    Default: 0

    Argument: Particle age

    See also:

    rgbMultiplier: ScalarValue

    Scalar multiplier for the color that does not affect the alpha. Effectively a brightness multiplier.

    Default: 1

    Argument: Active time

    The numeric ID for the type of action this represents.

    uniformScale: boolean

    If enabled, the particle width-related properties and fields will control both the width and height of the particles, and the height counterparts will be ignored.

    Default: false

    See also:

    unk_ds3_f1_4: number

    Unknown integer.

    Default: 0

    unk_ds3_f2_0: number

    Unknown integer.

    Default: 0

    unk_ds3_f2_1: number

    Unknown integer.

    Default: 0

    unk_ds3_f2_10: number

    Unknown integer.

    Default: 0

    unk_ds3_f2_11: number

    Unknown integer.

    Default: 0

    unk_ds3_f2_12: number

    Unknown integer.

    Default: 0

    unk_ds3_f2_13: number

    Unknown integer.

    Default: 0

    unk_ds3_f2_2: number

    Unknown integer.

    Default: 8

    unk_ds3_f2_20: number

    Unknown float.

    Default: 0.5

    unk_ds3_f2_21: number

    Unknown integer.

    Default: 1

    unk_ds3_f2_22: number

    Unknown float.

    Default: 0

    unk_ds3_f2_23: number

    Unknown integer.

    Default: 0

    unk_ds3_f2_24: number

    Unknown integer.

    Default: 0

    unk_ds3_f2_27: number

    Unknown integer.

    Default: 1

    unk_ds3_f2_28: number

    Unknown integer.

    Default: 0

    unk_ds3_f2_29: number

    Unknown float.

    Default: 0

    unk_ds3_f2_3: number

    Unknown float.

    Default: 1

    unk_ds3_f2_4: number

    Unknown integer.

    Default: 0

    unk_ds3_f2_9: number

    Unknown integer.

    Default: 0

    unk_ds3_p1_6: Vector4Value

    Unknown vector4.

    Default: [1, 1, 1, 1]

    unk_ds3_p2_2: ScalarValue

    Unknown scalar.

    Default: 0

    unk_ds3_p2_3: Vector4Value

    Unknown vector4.

    Default: [1, 1, 1, 1]

    unk_ds3_p2_4: Vector4Value

    Unknown vector4.

    Default: [1, 1, 1, 1]

    unk_ds3_p2_5: Vector4Value

    Unknown vector4.

    Default: [1, 1, 1, 1]

    unk_er_f1_3: number

    Unknown integer.

    Default: 1

    unk_er_f1_4: number

    Unknown integer.

    Default: 1

    unk_sdt_f2_30: number

    Unknown float.

    Default: 0

    unkDepthBlend1: number

    Unknown float.

    Default: 1

    unkDepthBlend2: number

    Unknown float.

    Default: 0

    The width of the particle.

    If uniformScale is enabled, this also controls the height.

    Default: 1

    Argument: Particle age

    See also:

    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 RadialBlur

    MMNEPVFCICPMFPCPTTAAATR