@cccode/fxr - v22.0.0

    Class Model

    Slot: Appearance

    Particle with a 3D model.

    Some models don't work properly with this action for some reason. For example, the Carian greatsword model in Elden Ring (88300), gets horribly stretched and distorted when used with this action. If you find a model like this that you want to use, try using the RichModel action instead.

    Hierarchy (View Summary, Expand)

    Index

    Constructors

    Properties

    alphaMultiplier: ScalarValue

    Alpha multiplier.

    Default: 1

    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:

    anibnd: number

    Anibnd ID.

    Default: 0

    See also:

    animation: number

    Controls which animation in the anibnd to play.

    Default: 0

    See also:

    animationSpeed: number

    Controls the speed at which the animation plays.

    Default: 1

    See also:

    Blend mode.

    Note that the materials used by the model may affect how the different blend modes work. Don't expect the blend modes to always work exactly like they do in other types of instances.

    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]

    color1: Vector4Value

    Color multiplier.

    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.

    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.

    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:

    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

    loopAnimation: boolean

    If disabled, the animation will only play once and then freeze on the last frame. If enabled, the animation will loop.

    Default: true

    See also:

    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:

    Model ID.

    Default: 80201

    Argument: Constant 0

    offsetU: ScalarValue

    Horizontal offset for the UV coordinates of the model.

    If the texture is an animation sheet that is split up into multiple frames using columns and/or totalFrames, this property has no effect.

    Default: 0

    Argument: Constant 0

    See also:

    offsetV: ScalarValue

    Vertical offset for the UV coordinates of the model.

    If the texture is an animation sheet that is split up into multiple frames using columns and/or totalFrames, this property has no effect.

    Default: 0

    Argument: Constant 0

    Model orientation mode. See ModelOrientationMode for more information.

    Default: ModelOrientationMode.ParticleDirection

    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:

    scaleVariationX: number

    Each particle will pick a random number between this value and 1, and the width of the particle will be multiplied by this number. For example, setting this to 0.5 will make the particles randomly thinner, down to half width. Setting it to 2 will make them randomly wider, up to double width.

    If uniformScale is enabled, this also affects the height.

    Default: 1

    See also:

    scaleVariationY: number

    Each particle will pick a random number between this value and 1, and the height of the particle will be multiplied by this number. For example, setting this to 0.5 will make the particles randomly shorter, down to half height. Setting it to 2 will make them randomly taller, up to double height.

    If uniformScale is enabled, scaleVariationX also affects the height, and this field is ignored.

    Default: 1

    See also:

    scaleVariationZ: number

    Each particle will pick a random number between this value and 1, and the depth of the particle will be multiplied by this number. For example, setting this to 0.5 will make the particles randomly shallower, down to half depth. Setting it to 2 will make them randomly deeper, up to double depth.

    If uniformScale is enabled, scaleVariationX also affects the depth, and this field is ignored.

    Default: 1

    See also:

    The width of the particle.

    If uniformScale is enabled, this also controls the height and depth.

    Default: 1

    Argument: Particle age

    See also:

    The height of the particle.

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

    Default: 1

    Argument: Particle age

    See also:

    The depth of the particle.

    If uniformScale is enabled, sizeX also controls the depth, and this property is ignored.

    Default: 1

    Argument: Particle age

    See also:

    speedMultiplierU: ScalarValue

    Multiplier for speedU.

    Default: 0

    Argument: Particle age

    speedMultiplierV: ScalarValue

    Multiplier for speedV.

    Default: 0

    Argument: Particle age

    speedU: ScalarValue

    Horiztonal scroll speed for the model's texture.

    If the texture is an animation sheet that is split up into multiple frames using columns and/or totalFrames, this property has no effect.

    Default: 0

    Argument: Particle age

    See also:

    speedV: ScalarValue

    Vertical scroll speed for the model's texture.

    If the texture is an animation sheet that is split up into multiple frames using columns and/or totalFrames, this property has no effect.

    Default: 0

    Argument: Particle age

    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:

    type: Model

    The numeric ID for the type of action this represents.

    uniformScale: boolean

    If enabled, the particle X scale-related properties and fields will control the scale in all axes, and the Y and Z counterparts will be ignored.

    Default: false

    See also:

    unk_ac6_f2_38: number

    Unknown integer.

    Default: 0

    unk_ds3_f1_10: number

    Unknown integer.

    Default: -2

    unk_ds3_f1_11: boolean

    Unknown boolean.

    Default: true

    unk_ds3_f1_12: boolean

    Unknown boolean.

    Default: true

    unk_ds3_f1_13: number

    Unknown integer.

    Default: 1

    unk_ds3_f1_18: number

    Unknown integer.

    Default: 0

    unk_ds3_f1_9: number

    Unknown integer.

    Default: -2

    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

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

    Default: 0

    unk_ds3_f2_26: number

    Unknown integer.

    Default: 1

    unk_ds3_f2_27: number

    Unknown integer.

    Default: 0

    unk_ds3_f2_28: number

    Unknown float.

    Default: 0

    unk_ds3_f2_3: number

    Unknown integer.

    Default: 0

    unk_ds3_f2_4: number

    Unknown integer.

    Default: 1

    unk_ds3_f2_9: number

    Unknown float.

    Default: 0

    unk_ds3_p1_15: ScalarValue

    Unknown scalar.

    Default: 0

    unk_ds3_p1_24: ScalarValue

    Unknown scalar.

    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_ds3_p2_6: ScalarValue

    Unknown scalar.

    Default: 0

    unk_ds3_p2_7: ScalarValue

    Unknown scalar.

    Default: 0

    unk_er_f1_17: number

    Unknown integer.

    Default: 1

    unk_er_f1_18: number

    Unknown integer.

    Default: 1

    unk_er_f1_19: number

    Unknown integer.

    Default: 0

    unk_sdt_f2_29: number

    Unknown float.

    Default: 0

    unk_sdt_f2_30: number

    Unknown float.

    Default: 0

    unk_sdt_f2_31: number

    Unknown integer.

    Default: 0

    unk_sdt_f2_32: number

    Unknown integer.

    When set to 1, it can cause some ugly "outline" effects on things seen through particles.

    Default: 0

    unk_sdt_f2_33: number

    Unknown integer.

    Default: 0

    unk_sdt_f2_34: number

    Unknown float.

    Default: 0

    unk_sdt_f2_35: number

    Unknown integer.

    Default: -2

    unk_sdt_f2_36: number

    Unknown integer.

    Default: -2

    unk_sdt_f2_37: number

    Unknown integer.

    Default: 0

    unkDepthBlend1: number

    Unknown float.

    Default: 1

    unkDepthBlend2: number

    Unknown float.

    Default: 0

    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 size of the action by a factor. This only does something when used with actions that have scaling properties.

      Parameters

      • factor: number

        The factor to scale by.

      • options: { mode?: ScalingMode } = {}

      Returns Model

    • 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 Model

    MMNEPVFCICPMFPCPTTAAATR