@cccode/fxr - v22.0.0

    Class MultiTextureBillboardEx

    Slot: Appearance

    Particle with multiple textures that can scroll.

    Hierarchy (View Summary, Expand)

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    Properties

    alphaFadeThreshold: ScalarValue

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

    Values above this threshold will be stretched to fill the alpha range, so values near the threshold will be less visible, creating a smooth transition between the parts that have been hidden by the threshold and the ones that are still visible.

    Default: 0

    Argument: Particle age

    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 alphaFadeThreshold.

    Default: 0

    Argument: Active time

    angularSpeedMultiplierX: ScalarValue

    Multiplier for angularSpeedX.

    Default: 1

    Argument: Particle age

    See also:

    angularSpeedMultiplierY: ScalarValue

    Multiplier for angularSpeedY.

    Default: 1

    Argument: Particle age

    See also:

    angularSpeedMultiplierZ: ScalarValue

    Multiplier for angularSpeedZ.

    Default: 1

    Argument: Particle age

    See also:

    angularSpeedX: ScalarValue

    Angular speed around the X-axis in degrees per second.

    Default: 0

    Argument: Particle age

    See also:

    angularSpeedY: ScalarValue

    Angular speed around the Y-axis in degrees per second.

    Default: 0

    Argument: Particle age

    See also:

    angularSpeedZ: ScalarValue

    Angular speed around the Z-axis in degrees per second.

    Default: 0

    Argument: Particle age

    See also:

    Blend mode.

    Default: BlendMode.Normal

    Argument: Constant 0

    bloom: boolean

    Controls whether or not the particles have an additional bloom effect controlled by bloomColor.

    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: true

    See also:

    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]

    See also:

    color1: Vector4Value

    Color multiplier for the particle.

    Values in this will be clamped to the 0-1 range. To use values outside of this range, see color3.

    Default: [1, 1, 1, 1]

    Argument: Particle age

    See also:

    color2: Vector4Value

    Color multiplier for the particle.

    Values in this will be clamped to the 0-1 range. There is no equivalent property with unrestricted values based on the emission time of the particle, but color3 is still multiplicative with this and can be used to scale the values indirectly.

    Default: [1, 1, 1, 1]

    Argument: Emission time

    See also:

    color3: Vector4Value

    Color multiplier for the particle.

    Values in this are unrestricted and can go above 1. If you want values to be clamped to the 0-1 range, see color1.

    Default: [1, 1, 1, 1]

    Argument: Particle age

    See also:

    columns: number

    To split the texture into multiple animation frames, this value must be set to the number of columns in the texture. It should equal textureWidth / frameWidth.

    Default: 1

    See also:

    depthBlend: boolean

    Controls how the particles should render when behind something else. If disabled, the particles will simply be drawn behind anything they are behind in the world. If enabled, they will instead display in front of the object if they are close enough, and will fade out with distance from the object's surface that is blocking the view of the particle.

    Default: true

    frameIndex: ScalarValue

    The index of the frame to show from the texture atlas. Can be animated using a linear property or similar.

    Seemingly identical to frameIndexOffset? The sum of these two properties is the actual frame index that gets used.

    Default: 0

    Argument: Particle age

    frameIndexOffset: ScalarValue

    Seemingly identical to frameIndex? The sum of these two properties is the actual frame index that gets used.

    Default: 0

    Argument: Particle age

    glossiness: number

    Controls how sharp the specular highlights are.

    Default: 0.25

    See also:

    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

    interpolateFrames: boolean

    If enabled, the texture animation will use linear interpolation to mix frames when the frame index is not a whole number. For example, if the frame index is 0.5, enabling this will cause the average of the first two frames to be shown instead of just the first frame.

    If disabled, the frame index will be truncated to get a whole number.

    Default: true

    See also:

    layer1: number

    Layer 1 texture ID.

    Default: 1

    layer1Color: Vector4Value

    Color multiplier for Layer 1.

    Values in this will be clamped to the 0-1 range.

    Default: [1, 1, 1, 1]

    Argument: Particle age

    layer1OffsetU: ScalarValue

    Horizontal offset for the UV coordinates of Layer 1.

    Default: 0

    Argument: Constant 0

    layer1OffsetV: ScalarValue

    Vertical offset for the UV coordinates of Layer 1.

    Default: 0

    Argument: Constant 0

    layer1ScaleU: ScalarValue

    Horizontal scale for the UV coordinates of Layer 1.

    Default: 1

    Argument: Particle age

    layer1ScaleV: ScalarValue

    Vertical scale for the UV coordinates of Layer 1.

    Default: 1

    Argument: Particle age

    layer1SpeedU: ScalarValue

    Horiztonal scroll speed for Layer 1.

    Default: 0

    Argument: Particle age

    layer1SpeedV: ScalarValue

    Vertical scroll speed for Layer 1.

    Default: 0

    Argument: Particle age

    layer2: number

    Layer 2 texture ID.

    Default: 1

    layer2Color: Vector4Value

    Color multiplier for Layer 2.

    Values in this will be clamped to the 0-1 range.

    Default: [1, 1, 1, 1]

    Argument: Particle age

    layer2OffsetU: ScalarValue

    Horizontal offset for the UV coordinates of Layer 2.

    Default: 0

    Argument: Constant 0

    layer2OffsetV: ScalarValue

    Vertical offset for the UV coordinates of Layer 2.

    Default: 0

    Argument: Constant 0

    layer2ScaleU: ScalarValue

    Horizontal scale for the UV coordinates of Layer 2.

    Default: 1

    Argument: Particle age

    layer2ScaleV: ScalarValue

    Vertical scale for the UV coordinates of Layer 2.

    Default: 1

    Argument: Particle age

    layer2SpeedU: ScalarValue

    Horiztonal scroll speed for Layer 2.

    Default: 0

    Argument: Particle age

    layer2SpeedV: ScalarValue

    Vertical scroll speed for Layer 2.

    Default: 0

    Argument: Particle age

    layer3: number

    Layer 3 texture ID.

    Default: 1

    layer3Color: Vector4Value

    Color multiplier for Layer 3.

    Values in this will be clamped to the 0-1 range.

    Default: [1, 1, 1, 1]

    Argument: Particle age

    layer3OffsetU: ScalarValue

    Horizontal offset for the UV coordinates of Layer 3.

    Default: 0

    Argument: Constant 0

    layer3OffsetV: ScalarValue

    Vertical offset for the UV coordinates of Layer 3.

    Default: 0

    Argument: Constant 0

    layer3ScaleU: ScalarValue

    Horizontal scale for the UV coordinates of Layer 3.

    Default: 1

    Argument: Particle age

    layer3ScaleV: ScalarValue

    Vertical scale for the UV coordinates of Layer 3.

    Default: 1

    Argument: Particle age

    layer3SpeedU: ScalarValue

    Horiztonal scroll speed for Layer 3.

    Default: 0

    Argument: Particle age

    layer3SpeedV: ScalarValue

    Vertical scroll speed for Layer 3.

    Default: 0

    Argument: Particle age

    lighting: number

    Controls how the particles are lit. See LightingMode for more information.

    Default: -1

    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:

    octagonal: boolean

    Controls the shape of the particles. If disabled, the particles will be rectangular. If enabled, they will be octagonal.

    Default: false

    offsetX: ScalarValue

    X position offset.

    Default: 0

    Argument: Particle age

    offsetY: ScalarValue

    Y position offset.

    Default: 0

    Argument: Particle age

    offsetZ: ScalarValue

    Z position offset.

    Default: 0

    Argument: Particle age

    orientation: OrientationMode

    Controls the orientation mode for the particles. See OrientationMode for more information.

    Default: OrientationMode.CameraPlane

    rgbMultiplier: ScalarValue

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

    Default: 1

    Argument: Active time

    rotationX: ScalarValue

    Rotation around the X-axis in degrees.

    Default: 0

    Argument: Constant 0

    See also:

    rotationY: ScalarValue

    Rotation around the Y-axis in degrees.

    Default: 0

    Argument: Constant 0

    See also:

    rotationZ: ScalarValue

    Rotation around the Z-axis in degrees.

    Default: 0

    Argument: Constant 0

    See also:

    scaleBeforeRotation: boolean

    When true, scaling is applied before rotation for the particle, which allows non-square particles to maintain their shape when rotated. When false, scaling is applied after rotation, which allows particles to be skewed, for example a square rotated 45 degrees and then made thinner will turn into a diamond shape.

    Default: true

    shadowDarkness: number

    Controls how dark shaded parts of the particle are.

    Default: 0

    specular: number

    Specular texture ID.

    Default: 0

    See also:

    totalFrames: number

    To split the texture into multiple animation frames, this value must be set to the total number of frames in the texture.

    Default: 1

    See also:

    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_ac6_f2_46: number

    Unknown integer.

    Default: 0

    unk_ds3_f1_10: number

    Unknown integer.

    Default: -2

    unk_ds3_f1_11: number

    Unknown integer.

    Default: -2

    unk_ds3_f1_14: 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
    Value Behavior
    0 All layers may have colors, and the layer textures are all multiplied when blending. The opacity is based only on the alpha of the layer1 texture.
    1 Removes all color from layers 2 and 3, and makes the brightness of the pixels in the texture of those layers affect the opacity.
    2 Removes all color from layer 2 only, and makes the brightness of the pixels in the texture of that layer affect the opacity.

    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, however it seems to affect the blending of the layers and color multipliers in some way.

    Default: 0

    unk_ds3_f2_2: number

    Unknown integer.

    Default: 8

    unk_ds3_f2_20: number

    Unknown integer.

    Default: 0

    unk_ds3_f2_21: number

    Unknown integer.

    Default: 0

    unk_ds3_f2_22: number

    Unknown integer.

    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.

    This seems to be some sort of distance threshold. When the camera is within this distance, some things will look different in some ways. For example, when within the distance and the blend mode is set to BlendMode.Subtract, the opacity doesn't work the way it normally does. Other effects have been found as well, but what exactly this threshold is for is unknown.

    Default: 0

    unk_ds3_f2_3: number

    Unknown float.

    Default: 0

    unk_ds3_f2_9: number

    Unknown float.

    Default: 0

    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_14: number

    Unknown integer.

    Default: 1

    unk_er_f1_15: number

    Unknown integer.

    Default: 1

    unk_er_f1_16: number

    Unknown integer.

    Default: 0

    unk_er_f2_42: number

    Unknown integer.

    Default: 0

    unk_er_f2_43: number

    Unknown integer.

    Default: 0

    unk_er_f2_44: number

    Unknown float.

    Default: 0

    unk_er_f2_45: number

    Unknown integer.

    Default: 0

    unk_sdt_f2_31: number

    Unknown integer.

    Default: 0

    unk_sdt_f2_32: number

    Unknown integer.

    When set to 1, it seems to stop unk_ds3_f2_29 from doing whatever it is doing, and it can also cause some ugly "outline" effects on things seen through particles.

    Default: 0

    unk_sdt_f2_36: number

    Unknown integer.

    Default: -2

    unk_sdt_f2_37: number

    Unknown integer.

    Default: 0

    unk_sdt_f2_38: number

    Unknown integer.

    Default: 1

    unk_sdt_f2_39: number

    Unknown integer.

    Default: 1

    unk_sdt_f2_40: number

    Unknown integer.

    Default: 0

    unk_sdt_f2_41: number

    Unknown integer.

    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

    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 MultiTextureBillboardEx

    MMNEPVFCICPMFPCPTTAAATR