Class AnimationCycle

Base class for animation editing classes.

Hierarchy (View Summary)

Profiles.Animation
- AnimationCycle

Index

Constructors

Properties

animFlags category count cycles dieType duration faceMask fade gradient? intensity name type

Accessors

Methods

collectAnimations collectGradients collectPatterns duplicate toAnimation

Constructors

constructor

new AnimationCycle(
    opt?: EditAnimationParams & {
        count?: number;
        cycles?: number;
        faceMask?: number;
        fade?: number;
        gradient?: RgbGradient;
        intensity?: number;
    },
): Profiles.AnimationCycle
Parameters
- Optionalopt: EditAnimationParams & {
      count?: number;
      cycles?: number;
      faceMask?: number;
      fade?: number;
      gradient?: RgbGradient;
      intensity?: number;
  }
Returns Profiles.AnimationCycle
Overrides Animation.constructor
- Defined in packages/pixels-edit-animation/dist/src/edit/EditAnimationCycle.d.ts:13

Properties

animFlags

animFlags: number

category

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

count

count: number

cycles

cycles: number

dieType

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

duration

duration: number

Animation duration in seconds.

faceMask

faceMask: number

fade

fade: number

`Optional`gradient

gradient?: RgbGradient

intensity

intensity: number

name

name: string

`Readonly`type

type: "cycle"

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/EditAnimationCycle.d.ts:23

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/EditAnimationCycle.d.ts:22

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/EditAnimationCycle.d.ts:21