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

RB.PackedSpriteGet

Method  -  Static

public static PackedSprite PackedSpriteGet(PackedSpriteID spriteID)
public static PackedSprite PackedSpriteGet(PackedSpriteID spriteID, SpriteSheetAsset spriteSheet)
public static PackedSprite PackedSpriteGet(string spriteName)
public static PackedSprite PackedSpriteGet(string spriteName, SpriteSheetAsset spriteSheet)
public static PackedSprite PackedSpriteGet(FastString spriteName)
public static PackedSprite PackedSpriteGet(FastString spriteName, SpriteSheetAsset spriteSheet)

Parameters

spriteID PackedSpriteID Sprite ID
spriteSheet SpriteSheetAsset Sprite sheet
spriteName string Sprite name

Returns

PackedSprite

Packed sprite info

Description

Gets detailed sprite info for the given sprite in the current sprite sheet, or one specified by spriteSheet.

See Demo Reel for example usage of sprite packs.

Example

PackedSprite hero;
PackedSprite shadow;

void Initialize() {
    hero = PackedSprite("characters/hero_idle");
    shadow = PackedSprite("other/drop_shadow");
}

void Render() {
   // Calculate hero shadow offset position based on sprite sizes. The calculated offset will place
   // the shadow underneat the heros feet.
   var shadowOffset =
       new Vector2i(hero.Size.width / 2 - shadow.width / 2, hero.Size.height - shadow.height / 2);

   RB.DrawSprite(shadow.id, pos + shadowOffset);
   RB.DrawSprite(hero.id, pos);
}

See Also

RB.DrawSprite
SpriteSheetAsset
PackedSprite

See Docs

Features - Sprite Packs
Features - Drawing