API Docs for:
Show:

MaskToPrimitiveAnimationDescriptor Class

Describes a masking animation.

Item Index

Properties

duration

Number

The duration in frames.

easing

String

The easing-type to use. Has no effect on "sound", "wait" and "playAnimation". Possible types are:

  • linear_in/linear_out/linear_inout - Linear movement without any smoothing
  • quad_in/quad_out/quad_inout - Quadratic Easing
  • quart_in/quart_out/quart_inout - Quartic Easing
  • sine_in/sine_out/sine_inout - Sinusoidal Easing
  • cubic_in/cubic_out/cubic_inout - Cubic Easing
  • expo_in/expo_out/expo_inout - Exponential Easing
  • circ_in/circ_out/circ_inout - Circual Easing

Default: "linear_inout"

mask

String

The mask-image to use. That is an grey-scaled image in regular.

repeat

Boolean

Indicates if the animation should be played again with the next run of the animation-flow.

Default: true

type

String

Defines the kind of animation to execute. Supported types are:

  • changeTo
  • moveTo
  • blendTo
  • zoomTo
  • maskTo
  • shake
  • playAnimation
  • changeImages
  • sound
  • wait

Check the different primitive animation descriptors to get more information.

vague

Number

The smoothness(vague) of the edges. If 0 edges are sharp which is useful for for retro-like games while 255 is very smooth.

value

Number

The target-value to reach (0 - 255).

wait

Boolean

Indicates if the animation-flow wait for the animation to finish before playing the next. If set to false multiple animation can be played in parallel.

Default: false