Class BasicConfig

constructor

• new BasicConfig(
      actions?: AnyAction[] | Partial<Props<BasicConfig>>,
  ): BasicConfig

  Parameters

  • actions: AnyAction[] | Partial<Props<BasicConfig>> = []

  Returns BasicConfig

appearance

directionSpread

emissionAudio

emitter

emitterShape

nodeAttributes

nodeAudio

nodeForceMovement

nodeMovement

nodeTransform

particleAttributes

particleForceMovement

particleModifier

particleMovement

slot12

Readonlytype

clone

• clone(): BasicConfig

  Create a deep copy of this config.

  Returns BasicConfig

getActionCount

• getActionCount(game: Game): number

  Returns the number of actions this config will contain if written to the given game's structure.

  Parameters

  • game: Game

  Returns number

getActions

• getActions(game: Game): AnyAction[]

  Returns and array of the actions this config will contain if written to the given game's structure.

  Parameters

  • game: Game

  Returns AnyAction[]

minify

• minify(): BasicConfig

  Returns BasicConfig

recolor

• recolor(func: RecolorFunction): this

  Recolors the config 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.

  Returns this
• recolor(palette: ColorPalette): this

  Recolors the config to fit a given color palette.

  Parameters

  • palette: ColorPalette

    The color palette to apply. This can be generated from existing FXR branches using the Node.generateColorPalette method.

  Returns this
• recolor(
      funcOrPalette: RecolorFunction | ColorPalette,
      __durationFallback?: (action: any, secondary?: any) => () => any,
      __proc?: <T>(
          paletteProp: AnyValue,
          c: T,
          k: keyof T,
          durationFallback?: () => number,
      ) => void,
  ): this
  Internal

  Parameters

  • funcOrPalette: RecolorFunction | ColorPalette
  • Optional__durationFallback: (action: any, secondary?: any) => () => any
  • Optional__proc: <T>(
        paletteProp: AnyValue,
        c: T,
        k: keyof T,
        durationFallback?: () => number,
    ) => void

  Returns this

scale

• scale(factor: number, options?: { mode?: ScalingMode }): BasicConfig

  Scale the config by the given factor. This can be used to change the size of effect created by the config.

  Parameters

  • factor: number
  • options: { mode?: ScalingMode } = {}

  Returns BasicConfig

serialize

• serialize(options?: FXRSerializeOptions): any

  Parameters

  • Optionaloptions: FXRSerializeOptions

  Returns any

toJSON

• toJSON(): any

  Returns any

walkActions

• walkActions(): Generator<
      | ParticleModifier
      | Action
      | NodeSpin
      | NodeAcceleration
      | NodeAccelerationRandomTurns
      | NodeAccelerationPartialFollow
      | NodeAccelerationSpin
      | NodeSpeed
      | NodeSpeedRandomTurns
      | NodeSpeedPartialFollow
      | NodeSpeedSpin
      | StaticNodeTransform
      | RandomNodeTransform
      | ParticleAcceleration
      | ParticleAccelerationRandomTurns
      | ParticleAccelerationPartialFollow
      | ParticleSpeed
      | ParticleSpeedRandomTurns
      | ParticleSpeedPartialFollow
      | PointSprite
      | Line
      | QuadLine
      | BillboardEx
      | MultiTextureBillboardEx
      | Model
      | LegacyTracer
      | Distortion
      | RadialBlur
      | PointLight
      | GPUStandardParticle
      | GPUStandardCorrectParticle
      | LightShaft
      | GPUSparkParticle
      | GPUSparkCorrectParticle
      | Tracer
      | WaterInteraction
      | LensFlare
      | RichModel
      | CancelForce
      | WindForce
      | GravityForce
      | ForceCollision
      | TurbulenceForce
      | SpotLight
      | NoSpread
      | CircularSpread
      | EllipticalSpread
      | RectangularSpread
      | EmissionSound
      | PeriodicEmitter
      | EqualDistanceEmitter
      | OneTimeEmitter
      | PointEmitterShape
      | DiskEmitterShape
      | RectangleEmitterShape
      | SphereEmitterShape
      | BoxEmitterShape
      | CylinderEmitterShape
      | NodeAttributes
      | NodeSound
      | NodeForceSpeed
      | NodeForceAcceleration
      | NodeTranslation
      | NodeAttachToCamera
      | ParticleAttributes
      | ParticleForceSpeed
      | ParticleForceAcceleration
      | ParticleForceCollision
      | Unk130,
      void,
      unknown,
  >

  Returns Generator<
      | ParticleModifier
      | Action
      | NodeSpin
      | NodeAcceleration
      | NodeAccelerationRandomTurns
      | NodeAccelerationPartialFollow
      | NodeAccelerationSpin
      | NodeSpeed
      | NodeSpeedRandomTurns
      | NodeSpeedPartialFollow
      | NodeSpeedSpin
      | StaticNodeTransform
      | RandomNodeTransform
      | ParticleAcceleration
      | ParticleAccelerationRandomTurns
      | ParticleAccelerationPartialFollow
      | ParticleSpeed
      | ParticleSpeedRandomTurns
      | ParticleSpeedPartialFollow
      | PointSprite
      | Line
      | QuadLine
      | BillboardEx
      | MultiTextureBillboardEx
      | Model
      | LegacyTracer
      | Distortion
      | RadialBlur
      | PointLight
      | GPUStandardParticle
      | GPUStandardCorrectParticle
      | LightShaft
      | GPUSparkParticle
      | GPUSparkCorrectParticle
      | Tracer
      | WaterInteraction
      | LensFlare
      | RichModel
      | CancelForce
      | WindForce
      | GravityForce
      | ForceCollision
      | TurbulenceForce
      | SpotLight
      | NoSpread
      | CircularSpread
      | EllipticalSpread
      | RectangularSpread
      | EmissionSound
      | PeriodicEmitter
      | EqualDistanceEmitter
      | OneTimeEmitter
      | PointEmitterShape
      | DiskEmitterShape
      | RectangleEmitterShape
      | SphereEmitterShape
      | BoxEmitterShape
      | CylinderEmitterShape
      | NodeAttributes
      | NodeSound
      | NodeForceSpeed
      | NodeForceAcceleration
      | NodeTranslation
      | NodeAttachToCamera
      | ParticleAttributes
      | ParticleForceSpeed
      | ParticleForceAcceleration
      | ParticleForceCollision
      | Unk130,
      void,
      unknown,
  >