Class AnimationGradient

Base class for animation editing classes.

Hierarchy (view full)

Profiles.Animation
- AnimationGradient

Index

Constructors

Properties

animFlags category dieType duration faceMask gradient? name type

Accessors

Methods

collectAnimations collectGradients collectPatterns duplicate toAnimation

Constructors

constructor

new AnimationGradient(opt?): Profiles.AnimationGradient
Parameters
- Optionalopt: EditAnimationParams & {
  faceMask?: number;
  gradient?: RgbGradient;
  }
Returns Profiles.AnimationGradient
Overrides Animation.constructor
- Defined in packages/pixels-edit-animation/dist/src/edit/EditAnimationGradient.d.ts:9

Properties

animFlags

animFlags: number

category

category:
    | "system"
    | "uniform"
    | "colorful"
    | "flashy"
    | "animated"

dieType

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

duration

duration: number

Animation duration in seconds.

faceMask

faceMask: number

`Optional`gradient

gradient?: RgbGradient

name

name: string

`Readonly`type

type = "gradient"

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/EditAnimationGradient.d.ts:15

collectPatterns

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

duplicate

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

toAnimation

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