@cccode/fxr - v22.0.0

    Class GravityForce

    Slot: Appearance

    Creates a radial force in a volume. This pulls things towards itself, or pushes away if the force is negative.

    The name of this action is based on Elden Ring's RTTI, where it's called "ForceFieldGravityArea".

    Hierarchy (View Summary, Expand)

    Index

    Constructors

    Properties

    boxSize: Vector3

    The size of the box where the force is active.

    Default: [0, 0, 0]

    See also:

    cylinderHeight: number

    The height of the cylinder where the force is active.

    Default: 0

    See also:

    cylinderRadius: number

    The radius of the cylinder where the force is active.

    Default: 0

    See also:

    fadeOutTime: number

    The time it takes for the force to fade out after the action has deactivated in seconds. Due to the way this value is stored, the time will be rounded to the nearest 1/30s.

    Default: 0

    The strength of the force applied in the volume.

    Default: 1

    Argument: Active time

    See also:

    forceMultiplier: number

    A multiplier for force.

    This is multiplicative with both the base force and the "random" multiplier.

    Default: 1

    See also:

    forceRandomMultiplierMax: number

    The maximum "random" multiplier for force. This looks very similar to the same set of fields in the WindForce action, but this one doesn't seem to actually be random. It seems more like it will always just be the average of this and forceRandomMultiplierMin.

    This is multiplicative with both the base force and the other multiplier.

    Default: 1

    See also:

    forceRandomMultiplierMin: number

    The minimum "random" multiplier for force. This looks very similar to the same set of fields in the WindForce action, but this one doesn't seem to actually be random. It seems more like it will always just be the average of this and forceRandomMultiplierMax.

    This is multiplicative with both the base force and the other multiplier.

    Default: 1

    See also:

    The shape of the volume.

    Each shape has different fields controlling the size of the volume, and they also change where it scales from and what point things are being pulled towards:

    Shape Fields Origin Center of mass
    Boundless n/a n/a Node position
    Sphere sphereRadius Center of the sphere Center of the sphere
    Box boxSize Center of the box Center of the box
    Cylinder cylinderHeight, cylinderRadius Slightly +Z of the center of the cylinder? Slightly +Z of the origin?
    SquarePrism squarePrismHeight, squarePrismApothem Center of the base of the prism Center of the prism

    Default: ForceVolumeShape.Sphere

    sphereRadius: number

    The radius of the sphere where the force is active.

    Default: 10

    See also:

    squarePrismApothem: number

    The apothem of the square prism where the force is active.

    Default: 0

    See also:

    squarePrismHeight: number

    The height of the square prism where the force is active.

    Default: 0

    See also:

    The numeric ID for the type of action this represents.

    unk_ds3_f1_10: number

    Unknown integer.

    Default: 0

    unk_ds3_f1_11: number

    Unknown integer.

    Default: 0

    unk_ds3_f1_12: number

    Unknown integer.

    Default: 0

    unk_ds3_f1_13: number

    Unknown integer.

    Default: 0

    unk_ds3_f1_14: number

    Unknown integer.

    Default: 0

    unk_ds3_f1_15: number

    Unknown integer.

    Default: 0

    unk_ds3_f1_16: number

    Unknown integer.

    Default: 0

    unk_ds3_f1_17: number

    Unknown integer.

    Default: 0

    unk_ds3_f1_18: number

    Unknown integer.

    Default: 0

    unk_ds3_f1_19: number

    Unknown integer.

    Default: 0

    unk_ds3_f1_20: number

    Unknown integer.

    Default: 0

    unk_ds3_f1_21: number

    Unknown integer.

    Default: 0

    unk_ds3_f1_22: number

    Unknown integer.

    Default: 0

    unk_ds3_f1_23: number

    Unknown integer.

    Default: 0

    unk_ds3_f1_24: number

    Unknown integer.

    Default: 0

    unk_ds3_f1_25: number

    Unknown integer.

    Default: 0

    unk_ds3_f1_26: number

    Unknown integer.

    Default: 0

    unk_ds3_f1_27: number

    Unknown integer.

    Default: 0

    unk_ds3_f1_30: number

    Unknown float.

    Default: 1

    unk_ds3_f1_31: number

    Unknown integer.

    Default: 0

    unk_ds3_f1_32: number

    Unknown integer.

    Default: 0

    unk_ds3_f1_33: number

    Unknown float.

    Default: 1

    unk_ds3_f1_34: number

    Unknown integer.

    Default: 3

    unk_ds3_f1_36: number

    Unknown float.

    Default: 1

    unk_ds3_f1_37: number

    Unknown float.

    Default: 1

    unk_ds3_f1_9: number

    Unknown integer.

    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 GravityForce

    MMNEPVFCICPMFPCPTTAAATR