@cccode/fxr - v22.0.0

    Class WaterInteraction

    Slot: Appearance

    Simulates an interaction with water, allowing effects to create ripples in nearby water. The interaction basically pushes water in a shape controlled by a texture down to a given depth and holds it there for a duration before releasing it.

    Hierarchy (View Summary, Expand)

    Index

    Constructors

    Properties

    depth: number

    Controls how deep to push the water, or how intense the ripples caused by the interaction are.

    Default: 1

    descent: number

    The time it takes for the water to be pushed down to the depth in seconds.

    Default: 0.15

    duration: number

    The duration of the interaction in seconds. Basically how long to hold the water pressed down.

    Default: 0.15

    size: number

    Controls the size of the interaction area. Ripples caused by the interaction may go outside of the area.

    Default: 1

    texture: number

    The ID for a texture that controls the shape of the interaction.

    Default: 50004

    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 WaterInteraction

    MMNEPVFCICPMFPCPTTAAATR