Use sprites

IntermediateProgrammer sprite component to an entity. Afterwards, you can control the sprite with a script.

Add a sprite component

• Scene Editor, select the entity you want to add a sprite to.

  Tip

  Empty entity.
• Property Grid, click Add component and select Sprite. Game Studio adds a Sprite component to the entity.
• Asset View, drag the sprite sheet to the Source field in the Sprite component: (Select an asset): Then choose a sprite sheet: Game Studio adds the sprite to the entity.

  Sprite component properties

  Property Grid.

  Use sprites in a script

  You can use scripts to render sprites at runtime. To do this, attach the script to an entity with a sprite component. Use a script.

  Code sample

  This script displays a sprite that advances to the next sprite in the index every second. After it reaches the end of the sprite index, it loops.

  using Xenko.Rendering.Sprites;public class Animation : SyncScript{   // Declared public member fields and properties are displayed in Game Studio.   private SpriteFromSheet sprite;   private DateTime lastFrame;   public override void Start()   {       // Initialize the script.       sprite = Entity.Get<SpriteComponent>().SpriteProvider as SpriteFromSheet;       lastFrame = DateTime.Now;   }   public override void Update()   {      // Do something every new frame.      if ((DateTime.Now - lastFrame) > new TimeSpan(0, 0, 1))      {         sprite.CurrentFrame += 1;         lastFrame = DateTime.Now;      }   }}

  See also

• Import sprite sheets
• Edit sprites