RSX Code Reference
    Preparing search index...
    • rsx
    • SpriteSheetGridAnimation

    Class SpriteSheetGridAnimation

    Descriptor that describes a simple sprite sheet animation. The parent texture is split into a grid of RowCount x ColumnCount, each representing one frame of the animation. Every frame is of equal size. Frames are sequentially evaluated starting from the top-most row, iterating over all columns in a row and then moving to next row, up to FrameCount frames. Frames in rows/colums past FrameCount. FramesPerSecond frames are evaluated every second, allowing you to control animation speed.

    Index
    • Parameters

      • OptionalrowCount: number
      • OptionalcolumnCount: number
      • OptionalframeCount: number
      • OptionalframesPerSecond: number

      Returns SpriteSheetGridAnimation

    _columnCount: number
    _frameCount: number
    _framesPerSecond: number
    _rowCount: number
    • get columnCount(): number

      Number of columns to divide the parent's texture area. Determines column of the individual frame (depends on parent texture size).

      Returns number

    • set columnCount(value: number): void

      Parameters

      • value: number

      Returns void

    • get frameCount(): number

      Number of frames in the animation. Must be less or equal than RowCount * ColumnCount.

      Returns number

    • set frameCount(value: number): void

      Parameters

      • value: number

      Returns void

    • get framesPerSecond(): number

      How many frames to evaluate each second. Determines the animation speed.

      Returns number

    • set framesPerSecond(value: number): void

      Parameters

      • value: number

      Returns void

    • get rowCount(): number

      Number of rows to divide the parent's texture area. Determines height of the individual frame (depends on parent texture size).

      Returns number

    • set rowCount(value: number): void

      Parameters

      • value: number

      Returns void