@cccode/fxr - v31.0.0
    Preparing search index...

    Class RichModel

    Slot: Appearance

    Defines a particle with a 3D model. Similar to Model, but with some different options.

    Some models only work properly with this action and not with the Model action for some unknown reason. A good example of this is the Carian greatsword model in Elden Ring (88300), which gets horribly stretched and distorted when used with the other action, but it works fine with this one.

    The name is from Elden Ring's RTTI, where it is named "GXFfxAppearanceRichModel".

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    alphaMultiplier angularSpeedMultiplierX angularSpeedMultiplierY angularSpeedMultiplierZ angularSpeedX angularSpeedY angularSpeedZ anibnd animation animationSpeed bloomColor color1 color2 color3 dither loopAnimation maxDistance maxDistanceThreshold maxFadeDistance minDistance minDistanceThreshold minFadeDistance model offsetUV orientation rgbMultiplier rgbMultiplier2 rotationX rotationY rotationZ scaleVariationX scaleVariationY scaleVariationZ sizeX sizeY sizeZ speedMultiplierUV speedUV type uniformScale unk_ac6_f1_24 unk_ac6_f1_25 unk_ac6_f1_26 unk_ac6_f1_27 unk_ac6_f1_28 unk_ac6_f1_29 unk_ac6_f1_30 unk_ac6_f1_31 unk_ac6_f1_32 unk_ac6_f1_33 unk_ac6_f1_34 unk_er_f1_14 unk_er_f1_15 unk_er_f1_16 unk_er_f1_17 unk_er_f1_18 unk_er_f1_19 unk_er_f1_20 unk_er_f1_21 unk_er_f1_22 unk_er_f1_24 unk_er_f1_25 unk_er_f1_5 unk_er_f1_6 unk_er_f1_8 unk_er_f1_9 unk_er_f2_0 unk_er_f2_1 unk_er_f2_10 unk_er_f2_11 unk_er_f2_12 unk_er_f2_13 unk_er_f2_2 unk_er_f2_20 unk_er_f2_21 unk_er_f2_22 unk_er_f2_23 unk_er_f2_24 unk_er_f2_27 unk_er_f2_28 unk_er_f2_29 unk_er_f2_3 unk_er_f2_30 unk_er_f2_31 unk_er_f2_32 unk_er_f2_33 unk_er_f2_34 unk_er_f2_35 unk_er_f2_36 unk_er_f2_37 unk_er_f2_8 unk_er_f2_9 unk_er_p1_16 unk_er_p1_17 unk_er_p1_19 unk_er_p1_20 unk_er_p2_2 unk_er_p2_3 unk_er_p2_4 unk_er_p2_5 unk_er_p2_6 unk_nr_f1_35 unk_nr_f1_36 unk_nr_f1_37 unk_nr_f1_38 unk_nr_f1_39 unk_nr_f1_40 unk_nr_f1_41 unk_nr_f1_42 unk_nr_f1_43 unk_nr_f1_44 unk_nr_f1_45 unk_nr_f1_46 unk_nr_f1_47 unk_nr_f1_48 unk_nr_f1_49 unk_nr_f1_50 unk_nr_f1_51 unk_nr_f1_52 unk_nr_f1_53 unk_nr_f1_54 unk_nr_p1_24 unk_nr_p1_25 unk_nr_p1_26 unk_nr_p1_27 unk_nr_p1_28 unk_nr_p1_29 unk_nr_p1_30 unk_nr_p1_31 unk_nr_p1_32 unk_nr_p1_33 unk_nr_p1_34 unk_nr_p1_35 unk_nr_p1_36 unk_nr_p1_37 unk_nr_p1_38 unk_nr_p1_39 unk_nr_p1_40 unk_nr_p1_41 unk_nr_p1_42 unk_nr_p1_43 unk_nr_s10_0 unk_nr_s10_1 unk_nr_s10_2 unk_nr_s10_3 unkBlendMode unkDepthBlend1 unkDepthBlend2

    Accessors

    Methods

    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:

    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:

    dither: boolean

    If enabled, this allows control of the model's opacity regardless of its material by using dithered transparency. If disabled, changes to the alpha values that affect the particle will not have any effect unless the material allows it, but it will look better than the dithered transparency.

    Default: false

    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

    offsetUV: Vector2Value

    Offset for the UV coordinates of the model.

    Default: [0, 0]

    Argument: Constant 0

    See also:

    Rich model orientation mode. See RichModelOrientationMode for more information.

    Default: RichModelOrientationMode.ParticleDirection

    rgbMultiplier: ScalarValue

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

    Default: 1

    Argument: Active time

    rgbMultiplier2: ScalarValue

    Seemingly identical to rgbMultiplier?

    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:

    speedMultiplierUV: Vector2Value

    Multiplier for speedUV

    Default: [1, 1]

    Argument: Particle age

    speedUV: Vector2Value

    Scroll speed for the model's texture.

    Default: [0, 0]

    Argument: Particle age

    See also:

    type: RichModel

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

    Unknown float.

    Default: 0

    unk_ac6_f1_25: number

    Unknown float.

    Default: -1

    unk_ac6_f1_26: number

    Unknown float.

    Default: -1

    unk_ac6_f1_27: number

    Unknown float.

    Default: -1

    unk_ac6_f1_28: number

    Unknown float.

    Default: -1

    unk_ac6_f1_29: number

    Unknown integer.

    Default: 0

    unk_ac6_f1_30: number

    Unknown integer.

    Default: 0

    unk_ac6_f1_31: number

    Unknown float.

    Default: 0

    unk_ac6_f1_32: number

    Unknown integer.

    Default: 0

    unk_ac6_f1_33: number

    Unknown integer.

    Default: 1

    unk_ac6_f1_34: number

    Unknown integer.

    Default: 0

    unk_er_f1_14: number

    Unknown float.

    Default: 0

    unk_er_f1_15: number

    Unknown integer.

    Default: 0

    unk_er_f1_16: number

    Unknown integer.

    Default: 0

    unk_er_f1_17: number

    Unknown integer.

    Default: 0

    unk_er_f1_18: number

    Unknown integer.

    Default: 0

    unk_er_f1_19: number

    Unknown integer.

    Default: 0

    unk_er_f1_20: number

    Unknown integer.

    Default: 0

    unk_er_f1_21: number

    Unknown integer.

    Default: 0

    unk_er_f1_22: number

    Unknown integer.

    Default: 0

    unk_er_f1_24: number

    Unknown float.

    Default: 0

    unk_er_f1_25: number

    Unknown integer.

    Default: 1

    unk_er_f1_5: number

    Unknown integer.

    Default: 1

    unk_er_f1_6: number

    Unknown integer.

    Default: 1

    unk_er_f1_8: number

    Unknown integer.

    Default: -2

    unk_er_f1_9: number

    Unknown integer.

    Default: -2

    unk_er_f2_0: number

    Unknown integer.

    Default: 0

    unk_er_f2_1: number

    Unknown integer.

    Default: 0

    unk_er_f2_10: number

    Unknown integer.

    Default: 0

    unk_er_f2_11: number

    Unknown integer.

    Default: 0

    unk_er_f2_12: number

    Unknown integer.

    Default: 0

    unk_er_f2_13: number

    Unknown integer.

    Default: 0

    unk_er_f2_2: number

    Unknown integer.

    Default: 8

    unk_er_f2_20: number

    Unknown integer.

    Default: 0

    unk_er_f2_21: number

    Unknown integer.

    Default: 0

    unk_er_f2_22: number

    Unknown integer.

    Default: 0

    unk_er_f2_23: number

    Unknown integer.

    Default: 0

    unk_er_f2_24: number

    Unknown integer.

    Default: 0

    unk_er_f2_27: number

    Unknown integer.

    Default: 0

    unk_er_f2_28: number

    Unknown integer.

    Default: 1

    unk_er_f2_29: number

    Unknown integer.

    Default: 0

    unk_er_f2_3: number

    Unknown integer.

    Default: 0

    unk_er_f2_30: number

    Unknown integer.

    Default: 0

    unk_er_f2_31: number

    Unknown float.

    Default: 1

    unk_er_f2_32: number

    Unknown integer.

    Default: 0

    unk_er_f2_33: number

    Unknown integer.

    Default: 0

    unk_er_f2_34: number

    Unknown float.

    Default: 0.5

    unk_er_f2_35: number

    Unknown integer.

    Default: -2

    unk_er_f2_36: number

    Unknown integer.

    Default: -2

    unk_er_f2_37: number

    Unknown integer.

    Default: 0

    unk_er_f2_8: number

    Unknown integer.

    Default: 0

    unk_er_f2_9: number

    Unknown integer.

    Default: 0

    unk_er_p1_16: ScalarValue

    Unknown scalar.

    Default: 0

    unk_er_p1_17: ScalarValue

    Unknown scalar.

    Default: 0

    unk_er_p1_19: ScalarValue

    Unknown scalar.

    Default: 0

    unk_er_p1_20: ScalarValue

    Unknown scalar.

    Default: 0

    unk_er_p2_2: ScalarValue

    Unknown scalar.

    Default: 0

    unk_er_p2_3: Vector4Value

    Unknown vector4.

    Default: [1, 1, 1, 1]

    unk_er_p2_4: Vector4Value

    Unknown vector4.

    Default: [1, 1, 1, 1]

    unk_er_p2_5: Vector4Value

    Unknown vector4.

    Default: [1, 1, 1, 1]

    unk_er_p2_6: ScalarValue

    Unknown scalar.

    Default: 0

    unk_nr_f1_35: number

    Unknown integer.

    Default: 0

    unk_nr_f1_36: number

    Unknown integer.

    Default: 0

    unk_nr_f1_37: number

    Unknown integer.

    Default: 0

    unk_nr_f1_38: number

    Unknown integer.

    Default: 0

    unk_nr_f1_39: number

    Unknown integer.

    Default: 0

    unk_nr_f1_40: number

    Unknown integer.

    Default: 0

    unk_nr_f1_41: number

    Unknown integer.

    Default: 0

    unk_nr_f1_42: number

    Unknown integer.

    Default: 0

    unk_nr_f1_43: number

    Unknown integer.

    Default: 0

    unk_nr_f1_44: number

    Unknown integer.

    Default: 0

    unk_nr_f1_45: number

    Unknown integer.

    Default: 0

    unk_nr_f1_46: number

    Unknown integer.

    Default: 0

    unk_nr_f1_47: number

    Unknown integer.

    Default: 0

    unk_nr_f1_48: number

    Unknown integer.

    Default: 0

    unk_nr_f1_49: number

    Unknown integer.

    Default: 0

    unk_nr_f1_50: number

    Unknown integer.

    Default: 0

    unk_nr_f1_51: number

    Unknown integer.

    Default: 0

    unk_nr_f1_52: number

    Unknown integer.

    Default: 0

    unk_nr_f1_53: number

    Unknown integer.

    Default: 0

    unk_nr_f1_54: number

    Unknown integer.

    Default: 0

    unk_nr_p1_24: ScalarValue

    Unknown scalar.

    Default: 0

    unk_nr_p1_25: ScalarValue

    Unknown scalar.

    Default: 0

    unk_nr_p1_26: ScalarValue

    Unknown scalar.

    Default: 0

    unk_nr_p1_27: ScalarValue

    Unknown scalar.

    Default: 0

    unk_nr_p1_28: ScalarValue

    Unknown scalar.

    Default: 0

    unk_nr_p1_29: ScalarValue

    Unknown scalar.

    Default: 0

    unk_nr_p1_30: ScalarValue

    Unknown scalar.

    Default: 0

    unk_nr_p1_31: ScalarValue

    Unknown scalar.

    Default: 0

    unk_nr_p1_32: ScalarValue

    Unknown scalar.

    Default: 0

    unk_nr_p1_33: ScalarValue

    Unknown scalar.

    Default: 0

    unk_nr_p1_34: ScalarValue

    Unknown scalar.

    Default: 0

    unk_nr_p1_35: ScalarValue

    Unknown scalar.

    Default: 0

    unk_nr_p1_36: ScalarValue

    Unknown scalar.

    Default: 0

    unk_nr_p1_37: ScalarValue

    Unknown scalar.

    Default: 0

    unk_nr_p1_38: ScalarValue

    Unknown scalar.

    Default: 0

    unk_nr_p1_39: ScalarValue

    Unknown scalar.

    Default: 0

    unk_nr_p1_40: ScalarValue

    Unknown scalar.

    Default: 0

    unk_nr_p1_41: ScalarValue

    Unknown scalar.

    Default: 0

    unk_nr_p1_42: ScalarValue

    Unknown scalar.

    Default: 0

    unk_nr_p1_43: ScalarValue

    Unknown scalar.

    Default: 0

    unk_nr_s10_0: number[]

    Unknown section10.

    Default: []

    unk_nr_s10_1: number[]

    Unknown section10.

    Default: []

    unk_nr_s10_2: number[]

    Unknown section10.

    Default: []

    unk_nr_s10_3: number[]

    Unknown section10.

    Default: []

    unkBlendMode: number

    Unknown integer.

    This is somewhat similar to the blendMode property of other appearance actions, but the values do not match the ones in BlendMode.

    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 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 RichModel