classafFantomMappy::AnimBlock

sys::Obj
  afFantomMappy::AnimBlock

@Js

Represents a AnimBlock as used by Mappy.

animFunc

Source

|AnimBlock animFunc := AnimFunc.<ctor>().none

The function that defines the animation frame sequence. Defaults to AnimFunc.none

decFrameIndex

Source

Void decFrameIndex(|->Void clipFunc)

Decrements the frame index. Should the index drop below zero then the given clipFunc is called.

delay

Source

Int delay

The delayis the number of times AnimBlock.updateAnimation needs to be called before the currentFrameIndex changes. In effect this controls the speed of the animation.

delayCountdown

Source

Int delayCountdown

Returns the number of times AnimBlock.updateAnimation has to be called before the current frame is changed to the next in sequence.

If delayCountdown == 0 the current frame will change on the next call to AnimBlock.updateAnimation and delayCountdown will reset to delay.

frame

Source

Int frame { private set }

Returns the current frame (image index). If this AnimBlock has no frames then 0 is returned

frameIndex

Source

Int frameIndex

The current frame index.

frames

Source

Int[] frames := Int[,]

An array of frames (image indexes) that represent the animation sequence

incFrameIndex

Source

Void incFrameIndex(|->Void clipFunc)

Increments the frame index. Should the index exceed the maximum ( frames.size ) then the given clipFunc is called.

updateAnimation

Source

Void updateAnimation()

Counts down the delay and updates the current frame to the next in the animation sequence.

userData

Source

Int? userData

User data.