@cccode/fxr - v22.0.0

    Class ForceCollision

    Slot: Appearance

    Controls the volume used to detect whether or not the node is inside a force volume.

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

    Hierarchy (View Summary, Expand)

    Index

    Constructors

    Properties

    boxSize: Vector3

    The size of the box volume.

    Default: [0, 0, 0]

    See also:

    cylinderHeight: number

    The height of the cylinder volume.

    Default: 0

    See also:

    cylinderRadius: number

    The radius of the cylinder volume.

    Default: 0

    See also:

    The shape of the volume.

    Each shape has different fields controlling the size of the volume:

    Shape Fields
    Boundless n/a
    Sphere sphereRadius
    Box boxSize
    Cylinder cylinderHeight, cylinderRadius

    Note: The SquarePrism shape is not valid for this action.

    Default: ForceVolumeShape.Sphere

    sphereRadius: number

    The radius of the sphere volume.

    Default: 10

    See also:

    The numeric ID for the type of action this represents.

    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 ForceCollision

    MMNEPVFCICPMFPCPTTAAATR