Class AnimationNoise

Base class for animation editing classes.

Hierarchy (View Summary)

Profiles.Animation
- AnimationNoise

Index

Constructors

Constructors

constructor

new AnimationNoise(
    opt?: EditAnimationParams & {
        blinkDuration?: number;
        blinkFrequency?: number;
        blinkFrequencyVar?: number;
        blinkGradient?: RgbGradient;
        fade?: number;
        gradient?: RgbGradient;
        gradientColorType?: number;
        gradientColorVar?: number;
    },
): Profiles.AnimationNoise
Parameters
- Optionalopt: EditAnimationParams & {
      blinkDuration?: number;
      blinkFrequency?: number;
      blinkFrequencyVar?: number;
      blinkGradient?: RgbGradient;
      fade?: number;
      gradient?: RgbGradient;
      gradientColorType?: number;
      gradientColorVar?: number;
  }
Returns Profiles.AnimationNoise
Overrides Animation.constructor
- Defined in packages/pixels-edit-animation/dist/src/edit/EditAnimationNoise.d.ts:15

Properties

animFlags

animFlags: number

blinkDuration

blinkDuration: number

blinkFrequency

blinkFrequency: number

blinkFrequencyVar

blinkFrequencyVar: number

`Optional`blinkGradient

blinkGradient?: RgbGradient

dieType

dieType:
    | "unknown"
    | "d4"
    | "d6"
    | "d8"
    | "d10"
    | "d00"
    | "d12"
    | "d20"
    | "d6pipped"
    | "d6fudge"

duration

duration: number

Animation duration in seconds.

fade

fade: number

`Optional`gradient

gradient?: RgbGradient

gradientColorType

gradientColorType: number

gradientColorVar

gradientColorVar: number

name

name: string

`Readonly`type

type: "noise"

The animation type.

Accessors

uuid

get uuid(): string
Returns string
Inherited from EditAnimation.uuid
- Defined in packages/pixels-edit-animation/dist/src/edit/Editable.d.ts:5

Methods

collectAnimations

collectAnimations(): Profiles.Animation[]
Returns Profiles.Animation[]
Inherited from Animation.collectAnimations
- Defined in packages/pixels-edit-animation/dist/src/edit/EditAnimation.d.ts:31

collectGradients

collectGradients(): RgbGradient[]
Returns RgbGradient[]
Overrides Animation.collectGradients
- Defined in packages/pixels-edit-animation/dist/src/edit/EditAnimationNoise.d.ts:27

collectPatterns

collectPatterns(): { grayscale?: Profiles.Pattern[]; rgb?: Profiles.Pattern[] }
Returns { grayscale?: Profiles.Pattern[]; rgb?: Profiles.Pattern[] }
Inherited from Animation.collectPatterns
- Defined in packages/pixels-edit-animation/dist/src/edit/EditAnimation.d.ts:32

duplicate

duplicate(uuid?: string): Profiles.Animation
Parameters
- Optionaluuid: string
Returns Profiles.Animation
Overrides Animation.duplicate
- Defined in packages/pixels-edit-animation/dist/src/edit/EditAnimationNoise.d.ts:26

toAnimation

toAnimation(editSet: ProfileDataSet, bits: AnimationBits): AnimationPreset
Parameters
- editSet: ProfileDataSet
- bits: AnimationBits
Returns AnimationPreset
Overrides Animation.toAnimation
- Defined in packages/pixels-edit-animation/dist/src/edit/EditAnimationNoise.d.ts:25

Class AnimationNoise

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Profiles.AnimationNoise

Properties

animFlags

blinkDuration

blinkFrequency

blinkFrequencyVar

OptionalblinkGradient

category

dieType

duration

fade

Optionalgradient

gradientColorType

gradientColorVar

name

Readonlytype

Accessors

uuid

Returns string

Methods

collectAnimations

Returns Profiles.Animation[]

collectGradients

Returns RgbGradient[]

collectPatterns

Returns { grayscale?: Profiles.Pattern[]; rgb?: Profiles.Pattern[] }

duplicate

Parameters

Returns Profiles.Animation

toAnimation

Parameters

Returns AnimationPreset

Settings

On This Page

`Optional`blinkGradient

`Optional`gradient

`Readonly`type