The shape of the volume.
Each shape has different fields controlling the size of the volume:
| Shape | Fields | Origin |
|---|---|---|
| Boundless | n/a | n/a |
| Sphere | sphereRadius | Center of the sphere |
| Box | boxSize | Center of the box |
| Cylinder | cylinderHeight, cylinderRadius | Center of the cylinder |
| SquarePrism | squarePrismHeight, squarePrismApothem | Center of the base of the prism |
Default: ForceVolumeShape.Sphere
ReadonlytypeThe numeric ID for the type of action this represents.
An object containing various functions related to conversion between games and different formats, or undefined if the action does not have any of these functions.
An object containing most of the information that is stored in the library about the action type.
Yields all unique color values in the action.
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.
Modifies all color properties using a recolor function. For some easy pre-made recolor functions, see the Recolor namespace.
A function used to remap color values.
Optionalcontext: BasicConfigModifies a single color property of the action using a recolor function. For some easy pre-made recolor functions, see the Recolor namespace.
The name of the property.
The function used to recolor the property.
Optionalcontext: BasicConfigScale the size of the action by a factor. This only does something when used with actions that have scaling properties.
The factor to scale by.
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.
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.
Optionaloptions: FXRSerializeOptions
Action 10200 - CancelForce
Slot: Appearance
Cancels all forces in a volume. This includes wind from weather, and forces from the following actions:
The name of this action is based on Elden Ring's RTTI, where it's called "ForceFieldCancelArea".