@cccode/fxr - v22.0.0

    Class CylinderEmitterShape

    Slot: EmitterShape

    Makes the emitter cylindrical.

    Hierarchy (View Summary, Expand)

    Index

    Constructors

    Properties

    direction: InitialDirection

    Controls the initial direction for particles. See InitialDirection for more information.

    Default: InitialDirection.Emitter

    emitInside: boolean

    If true, particles will be emitted from anywhere within the cylinder. Otherwise the particles will be emitted only from the surface of the cylinder, excluding the ends.

    Default: true

    height: ScalarValue

    The height of the cylinder.

    Default: 1

    Argument: Active time

    radius: ScalarValue

    The radius of the cylinder.

    Default: 1

    Argument: Active time

    The numeric ID for the type of action this represents.

    yAxis: boolean

    If true, the cylinder will be aligned with the Y-axis instead of the Z-axis.

    Default: true

    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 CylinderEmitterShape

    MMNEPVFCICPMFPCPTTAAATR