AudioAsset
Ease
FastString
FontAsset
NineSlice
PackedSprite
PackedSpriteID
RB
   HardwareSettings
   IRetroBlitGame
RBAsset
Rect2i
ShaderAsset
SoundReference
SpriteGrid
SpriteSheetAsset
TMXMapAsset
   TMXLayer
   TMXLayerLoadState
   TMXObject
   TMXObjectGroup
   TMXProperties
Vector2i

RB.SpriteIndex

Method  -  Static

public static int SpriteIndex(int column, int row)
public static int SpriteIndex(SpriteSheetAsset spriteSheet, int column, int row)
public static int SpriteIndex(SpriteSheetAsset spriteSheet, Vector2i cell)

Parameters

column int Column
row int Row
spriteSheet SpriteSheetAsset Spritesheet for which to get sprite index for
cell Vector2i Cell in sprite sheet where Vector2i.x is the column and Vector2i.y is the row.

Returns

int

Sprite index

Description

A simple helper function for calculating sprite index given the sprite sheet column and row. A sprite index is used when rendering sprites using the RB.DrawSprite method.

The sprite index is calculated using the RB.SpriteSize of the current sprite sheet, or the sprite sheet given by spriteSheetIndex.

RB.SpriteIndex does not perform error checking, invalid column or row will produce an invalid sprite index.

Example

void Render() {
   // Draw an animated sprite using frames in column 0-7, and row 5
   RB.DrawSprite(RB.SpriteIndex((int)(RB.Ticks % 8), 5), pos);
}

See Also

RB.DrawSprite

See Docs

Features - Sprite Sheets
Features - Drawing