Class AnimationFlashes

Base class for animation editing classes.

Hierarchy (view full)

Profiles.Animation
- AnimationFlashes

Index

Constructors

Properties

animFlags category color count dieType duration faces fade name type

Accessors

Methods

collectAnimations collectGradients collectPatterns duplicate toAnimation

Constructors

constructor

new AnimationFlashes(opt?): AnimationFlashes
Parameters
- Optional opt: EditAnimationParams & {
      color?: Color | FaceColor;
      count?: number;
      faces?: number;
      fade?: number;
  }
Returns AnimationFlashes
Overrides Animation.constructor
- Defined in packages/pixels-edit-animation/dist/src/edit/EditAnimationSimple.d.ts:11

Properties

animFlags

animFlags: number

category

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

color

color: FaceColor

count

count: number

dieType

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

duration

duration: number

Animation duration in seconds.

faces

faces: number

fade

fade: number

name

name: string

`Readonly` type

type: "simple" = "simple"

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[]
Inherited from Animation.collectGradients
- Defined in packages/pixels-edit-animation/dist/src/edit/EditAnimation.d.ts:36

collectPatterns

collectPatterns(): {
grayscale?: Profiles.Pattern[];
rgb?: Profiles.Pattern[];
}
Returns {
grayscale?: Profiles.Pattern[];
rgb?: Profiles.Pattern[];
}
- Optional grayscale?: Profiles.Pattern[]
- Optional rgb?: 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
- Optional uuid: string
Returns Profiles.Animation
Overrides Animation.duplicate
- Defined in packages/pixels-edit-animation/dist/src/edit/EditAnimationSimple.d.ts:18

toAnimation

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