@cccode/fxr - v22.0.0

    Class ParticleModifier

    Slot: ParticleModifier

    Modifies particles in various ways.

    Note: This is not a property modifier, it is an action that modifies particles emitted from the same node.

    Hierarchy (View Summary, Expand)

    Index

    Constructors

    Properties

    Color multiplier for the particles emitted from this node.

    Values in this are unrestricted and can go above 1.

    Default: [1, 1, 1, 1]

    Argument: Active time

    scaleX: ScalarValue

    Multiplier for the scale along the X-axis for the particles emitted from this node.

    If uniformScale is enabled, this also affects the Y and Z axes.

    Default: 1

    Argument: Active time

    scaleY: ScalarValue

    Multiplier for the scale along the Y-axis for the particles emitted from this node.

    If uniformScale is enabled, scaleX also affects the Y-axis, and this property is ignored.

    Default: 1

    Argument: Active time

    scaleZ: ScalarValue

    Multiplier for the scale along the Z-axis for the particles emitted from this node.

    If uniformScale is enabled, scaleX also affects the Z-axis, and this property is ignored.

    Default: 1

    Argument: Active time

    Controls the speed of the particles emitted from this node, but only if the config has an action in the ParticleMovement slot that enables acceleration of particles. The direction is the particle's initial direction.

    Default: 0

    Argument: Active time

    The numeric ID for the type of action this represents.

    uniformScale: boolean

    Scales the particles emitted from this node uniformly based on scaleX. The other scale properties in this action have no effect when this is enabled.

    Default: false

    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 ParticleModifier

    MMNEPVFCICPMFPCPTTAAATR