Class RootNode

Readonlytype

colors

• colors(recurse?: boolean): Generator<Vector4, void, unknown>

  Yields all unique color values in the branch, or optionally only ones in the node.

  Parameters

  • Optionalrecurse: boolean = true

    Controls whether or not to yield colors in descendant nodes. Defaults to true.

  Returns Generator<Vector4, void, unknown>

generateColorPalette

• generateColorPalette(mode?: PaletteMode): ColorPalette

  Generates a color palette that can be used to recolor other nodes based on the colors in this branch.

  Parameters

  • mode: PaletteMode = PaletteMode.Average

    Controls the behavior of the color sampler. See PaletteMode for more information.

  Returns ColorPalette

getResources

• getResources(
      recurse?: boolean,
  ): {
      anibnds: number[];
      models: number[];
      sounds: number[];
      textures: { resource: number; type: string }[];
  }

  Lists all resources (textures, models, animations, sounds) used in the node. Useful for finding out what resources must exist for the effect to work correctly, which is often needed when converting from one game to another.

  Parameters

  • recurse: boolean = true

    Controls whether resources from descendant nodes should be listed or not. Defaults to true.

  Returns {
      anibnds: number[];
      models: number[];
      sounds: number[];
      textures: { resource: number; type: string }[];
  }

recolor

• recolor(func: RecolorFunction, recurse?: boolean): this

  Recolors the entire branch, or optionally just this node, by modifying color properties and fields using a given function.

  Parameters

  • func: RecolorFunction

    A function used to remap color values. For some easy pre-made recolor functions, see the Recolor namespace.
  • Optionalrecurse: boolean

    Controls whether or not the recoloring should be applied to all descendant nodes. Defaults to true.

  Returns this
• recolor(palette: ColorPalette, recurse?: boolean): this

  Recolors the entire branch, or optionally just this node, to fit a given color palette.

  Parameters

  • palette: ColorPalette

    The color palette to apply. This can be generated from existing FXR branches using the generateColorPalette method.
  • Optionalrecurse: boolean

    Controls whether or not the recoloring should be applied to all descendant nodes. Defaults to true.

  Returns this

remapResources

• remapResources(
      func: (
          type: ResourceType,
          resource: number,
          textureType?: string,
      ) => number,
      recurse?: boolean,
  ): void

  Remaps all resource IDs in the entire branch.

  Parameters

  • func: (type: ResourceType, resource: number, textureType?: string) => number

    The function that is used to map the old resource IDs to the new ones.
  • recurse: boolean = true

    Controls whether or not the remapping should be applied to all descendant nodes. Defaults to true.

  Returns void

scale

• scale(
      factor: number,
      options?: { mode?: ScalingMode; recurse?: boolean },
  ): RootNode

  Scales the entire branch by a factor. This updates all sizes, offsets, lengths, and radii of the actions in the branch, except certain multiplicative fields and properties.

  Parameters

  • factor: number

    The factor to scale the branch with.
  • options: { mode?: ScalingMode; recurse?: boolean } = {}

    • Optionalmode?: ScalingMode

    • Optionalrecurse?: boolean

      Controls whether or not the scaling should be applied to all descendant nodes. Defaults to true.

  Returns RootNode

scaleRateOfTime

• scaleRateOfTime(
      factor: number,
      options?: { recurse?: boolean; scaleTracerDuration?: boolean },
  ): RootNode

  Scale the rate of time for the branch, or optionally just the node.

  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 node play twice as fast. Setting it to 0.5 will make it play half as fast.
  • Optionaloptions: { recurse?: boolean; scaleTracerDuration?: boolean } = {}

    Extra options for changing how the scaling is applied to different properties and descendant nodes.

  Returns RootNode

walk

• walk(): Generator<Node>

  Yields all nodes in this branch, including this node.

  Returns Generator<Node>

walkActions

• walkActions(recurse?: boolean): Generator<DataAction | Action, void, any>

  Yields all actions in this branch, excluding node actions from nodes with configs, as those are not stored as actions internally.

  Parameters

  • recurse: boolean = true

    Controls whether or not to yield actions in descendant nodes. Defaults to true.

  Returns Generator<DataAction | Action, void, any>

walkConfigs

• walkConfigs(recurse?: boolean): Generator<IConfig, void, unknown>

  Yields all configs in this branch.

  Parameters

  • recurse: boolean = true

    Controls whether or not to yield configs in descendant nodes. Defaults to true.

  Returns Generator<IConfig, void, unknown>

walkProperties

• walkProperties(recurse?: boolean): Generator<AnyProperty, void, undefined>

  Yields all properties in this branch, excluding properties inside modifiers and properties in the form of PropertyValues in DataActions.

  Parameters

  • recurse: boolean = true

    Controls whether or not to yield properties in descendant nodes. Defaults to true.

  Returns Generator<AnyProperty, void, undefined>