Class EditAnimationCycle

Base class for animation editing classes.

Hierarchy (view full)

EditAnimation
- EditAnimationCycle

Index

Constructors

Properties

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

Accessors

Methods

collectAnimations collectGradients collectPatterns duplicate toAnimation

Constructors

constructor

new EditAnimationCycle(opt?): EditAnimationCycle
Parameters
- Optional opt: EditAnimationParams & {
      count?: number;
      cycles?: number;
      faces?: number;
      fade?: number;
      gradient?: EditRgbGradient;
      intensity?: number;
  }
Returns EditAnimationCycle
Overrides EditAnimation.constructor
- Defined in pixels-edit-animation/src/edit/EditAnimationCycle.ts:52

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

faces

faces: number

fade

fade: number

`Optional` gradient

gradient?: EditRgbGradient

intensity

intensity: number

name

name: string

`Readonly` type

type: "cycle" = "cycle"

The animation type.

Accessors

uuid

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

Methods

collectAnimations

collectAnimations(): EditAnimation[]
Returns EditAnimation[]
Inherited from EditAnimation.collectAnimations
- Defined in pixels-edit-animation/src/edit/EditAnimation.ts:74

collectGradients

collectGradients(): EditRgbGradient[]
Returns EditRgbGradient[]
Overrides EditAnimation.collectGradients
- Defined in pixels-edit-animation/src/edit/EditAnimationCycle.ts:99

collectPatterns

collectPatterns(): {
grayscale?: EditPattern[];
rgb?: EditPattern[];
}
Returns {
grayscale?: EditPattern[];
rgb?: EditPattern[];
}
- Optional grayscale?: EditPattern[]
- Optional rgb?: EditPattern[]
Inherited from EditAnimation.collectPatterns
- Defined in pixels-edit-animation/src/edit/EditAnimation.ts:78

duplicate

duplicate(uuid?): EditAnimation
Parameters
- Optional uuid: string
Returns EditAnimation
Overrides EditAnimation.duplicate
- Defined in pixels-edit-animation/src/edit/EditAnimationCycle.ts:91

toAnimation

toAnimation(_editSet, _bits): AnimationPreset
Parameters
- _editSet: EditDataSet
- _bits: AnimationBits
Returns AnimationPreset
Overrides EditAnimation.toAnimation
- Defined in pixels-edit-animation/src/edit/EditAnimationCycle.ts:71

Generated using TypeDoc