Class NodeEmitterConfig

constructor

• new NodeEmitterConfig(
      params?: AnyAction[] | Partial<Props<NodeEmitterConfig>>,
  ): NodeEmitterConfig

  Parameters

  • params: AnyAction[] | Partial<Props<NodeEmitterConfig>> = []

  Returns NodeEmitterConfig

directionSpread

emissionAudio

emitter

emitterShape

nodeAttributes

nodeAudio

nodeForceMovement

nodeMovement

nodeSelector

nodeTransform

Readonlytype

clone

• clone(): NodeEmitterConfig

  Create a deep copy of this config.

  Returns NodeEmitterConfig

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(): NodeEmitterConfig

  Returns NodeEmitterConfig

scale

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

  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 NodeEmitterConfig

serialize

• serialize(options?: FXRSerializeOptions): any

  Parameters

  • Optionaloptions: FXRSerializeOptions

  Returns any

toJSON

• toJSON(): any

  Returns any

walkActions

• walkActions(): Generator<
      | Action
      | NodeSpin
      | NodeAcceleration
      | NodeAccelerationRandomTurns
      | NodeAccelerationPartialFollow
      | NodeAccelerationSpin
      | NodeSpeed
      | NodeSpeedRandomTurns
      | NodeSpeedPartialFollow
      | NodeSpeedSpin
      | StaticNodeTransform
      | RandomNodeTransform
      | NoSpread
      | CircularSpread
      | EllipticalSpread
      | RectangularSpread
      | EmissionSound
      | PeriodicEmitter
      | EqualDistanceEmitter
      | OneTimeEmitter
      | PointEmitterShape
      | DiskEmitterShape
      | RectangleEmitterShape
      | SphereEmitterShape
      | BoxEmitterShape
      | CylinderEmitterShape
      | NodeAttributes
      | NodeSound
      | NodeForceSpeed
      | NodeForceAcceleration
      | NodeTranslation
      | NodeAttachToCamera
      | SelectAllNodes
      | SelectRandomNode,
      void,
      unknown,
  >

  Returns Generator<
      | Action
      | NodeSpin
      | NodeAcceleration
      | NodeAccelerationRandomTurns
      | NodeAccelerationPartialFollow
      | NodeAccelerationSpin
      | NodeSpeed
      | NodeSpeedRandomTurns
      | NodeSpeedPartialFollow
      | NodeSpeedSpin
      | StaticNodeTransform
      | RandomNodeTransform
      | NoSpread
      | CircularSpread
      | EllipticalSpread
      | RectangularSpread
      | EmissionSound
      | PeriodicEmitter
      | EqualDistanceEmitter
      | OneTimeEmitter
      | PointEmitterShape
      | DiskEmitterShape
      | RectangleEmitterShape
      | SphereEmitterShape
      | BoxEmitterShape
      | CylinderEmitterShape
      | NodeAttributes
      | NodeSound
      | NodeForceSpeed
      | NodeForceAcceleration
      | NodeTranslation
      | NodeAttachToCamera
      | SelectAllNodes
      | SelectRandomNode,
      void,
      unknown,
  >