# Class "Sprite"

## Constructors

### [Sprite](https://github.com/wofsauge/IsaacDocs/tree/420a6aaa54ea230461fb26e61297c068492684de/beta/Sprite/README.md) () {: aria-label='Constructors' }

[ ](/ab_p/beta/docs/sprite.md){: .abp .tooltip .badge }

#### void [Sprite](https://github.com/wofsauge/IsaacDocs/tree/420a6aaa54ea230461fb26e61297c068492684de/beta/Sprite/README.md) ( void ) {: .copyable aria-label='Constructors' }

## Functions

### GetDefaultAnimation () {: aria-label='Functions' }

[ ](/ab_p/beta/docs/sprite.md){: .abp .tooltip .badge }

#### string GetDefaultAnimation ( ) {: .copyable aria-label='Functions' }

### GetDefaultAnimationName () {: aria-label='Functions' }

[ ](/ab_p/beta/docs/sprite.md){: .abp .tooltip .badge }

#### string GetDefaultAnimationName ( ) {: .copyable aria-label='Functions' }

### GetFilename () {: aria-label='Functions' }

[ ](/ab_p/beta/docs/sprite.md){: .abp .tooltip .badge }

#### string GetFilename ( ) {: .copyable aria-label='Functions' }

### GetFrame () {: aria-label='Functions' }

[ ](/ab_p/beta/docs/sprite.md){: .abp .tooltip .badge }

#### int GetFrame ( ) {: .copyable aria-label='Functions' }

### GetLayerCount () {: aria-label='Functions' }

[ ](/ab_p/beta/docs/sprite.md){: .abp .tooltip .badge }

#### int GetLayerCount ( ) {: .copyable aria-label='Functions' }

### GetOverlayFrame () {: aria-label='Functions' }

[ ](/ab_p/beta/docs/sprite.md){: .abp .tooltip .badge }

#### int GetOverlayFrame ( ) {: .copyable aria-label='Functions' }

### GetTexel () {: aria-label='Functions' }

[ ](/ab_p/beta/docs/sprite.md){: .abp .tooltip .badge }

#### [Color](https://github.com/wofsauge/IsaacDocs/tree/420a6aaa54ea230461fb26e61297c068492684de/beta/Color/README.md) GetTexel ( [Vector](https://github.com/wofsauge/IsaacDocs/tree/420a6aaa54ea230461fb26e61297c068492684de/beta/Vector/README.md) SamplePos, [Vector](https://github.com/wofsauge/IsaacDocs/tree/420a6aaa54ea230461fb26e61297c068492684de/beta/Vector/README.md) RenderPos, float AlphaThreshold ) {: .copyable aria-label='Functions' }

### IsEventTriggered () {: aria-label='Functions' }

[ ](/ab_p/beta/docs/sprite.md){: .abp .tooltip .badge }

#### boolean IsEventTriggered ( string EventName ) {: .copyable aria-label='Functions' }

### IsFinished () {: aria-label='Functions' }

[ ](/ab_p/beta/docs/sprite.md){: .abp .tooltip .badge }

#### boolean IsFinished ( string AnimationName ) {: .copyable aria-label='Functions' }

### IsLoaded () {: aria-label='Functions' }

[ ](/ab_p/beta/docs/sprite.md){: .abp .tooltip .badge }

#### boolean IsLoaded ( ) {: .copyable aria-label='Functions' }

### IsOverlayFinished () {: aria-label='Functions' }

[ ](/ab_p/beta/docs/sprite.md){: .abp .tooltip .badge }

#### boolean IsOverlayFinished ( string AnimationName ) {: .copyable aria-label='Functions' }

### IsOverlayPlaying () {: aria-label='Functions' }

[ ](/ab_p/beta/docs/sprite.md){: .abp .tooltip .badge }

#### boolean IsOverlayPlaying ( string AnimationName ) {: .copyable aria-label='Functions' }

### IsPlaying () {: aria-label='Functions' }

[ ](/ab_p/beta/docs/sprite.md){: .abp .tooltip .badge }

#### boolean IsPlaying ( string AnimationName ) {: .copyable aria-label='Functions' }

### Load () {: aria-label='Functions' }

[ ](/ab_p/beta/docs/sprite.md){: .abp .tooltip .badge }

#### void Load ( string Filename, boolean LoadGraphics ) {: .copyable aria-label='Functions' }

### LoadGraphics () {: aria-label='Functions' }

[ ](/ab_p/beta/docs/sprite.md){: .abp .tooltip .badge }

#### void LoadGraphics ( ) {: .copyable aria-label='Functions' }

### Play () {: aria-label='Functions' }

[ ](/ab_p/beta/docs/sprite.md){: .abp .tooltip .badge }

#### void Play ( string AnimationName, boolean Force ) {: .copyable aria-label='Functions' }

### PlayOverlay () {: aria-label='Functions' }

[ ](/ab_p/beta/docs/sprite.md){: .abp .tooltip .badge }

#### void PlayOverlay ( string AnimationName, boolean Force ) {: .copyable aria-label='Functions' }

### PlayRandom () {: aria-label='Functions' }

[ ](/ab_p/beta/docs/sprite.md){: .abp .tooltip .badge }

#### void PlayRandom ( int Seed ) {: .copyable aria-label='Functions' }

### Reload () {: aria-label='Functions' }

[ ](/ab_p/beta/docs/sprite.md){: .abp .tooltip .badge }

#### void Reload ( ) {: .copyable aria-label='Functions' }

### RemoveOverlay () {: aria-label='Functions' }

[ ](/ab_p/beta/docs/sprite.md){: .abp .tooltip .badge }

#### void RemoveOverlay ( ) {: .copyable aria-label='Functions' }

### Render () {: aria-label='Functions' }

[ ](/ab_p/beta/docs/sprite.md){: .abp .tooltip .badge }

#### void Render ( [Vector](https://github.com/wofsauge/IsaacDocs/tree/420a6aaa54ea230461fb26e61297c068492684de/beta/Vector/README.md) Pos, [Vector](https://github.com/wofsauge/IsaacDocs/tree/420a6aaa54ea230461fb26e61297c068492684de/beta/Vector/README.md) TopLeftClamp, [Vector](https://github.com/wofsauge/IsaacDocs/tree/420a6aaa54ea230461fb26e61297c068492684de/beta/Vector/README.md) BottomRightClamp ) {: .copyable aria-label='Functions' }

### RenderLayer () {: aria-label='Functions' }

[ ](/ab_p/beta/docs/sprite.md){: .abp .tooltip .badge }

#### void RenderLayer ( int LayerId, [Vector](https://github.com/wofsauge/IsaacDocs/tree/420a6aaa54ea230461fb26e61297c068492684de/beta/Vector/README.md) Pos ) {: .copyable aria-label='Functions' }

### ReplaceSpritesheet () {: aria-label='Functions' }

[ ](/ab_p/beta/docs/sprite.md){: .abp .tooltip .badge }

#### void ReplaceSpritesheet ( int LayerId, string PngFilename ) {: .copyable aria-label='Functions' }

### Reset () {: aria-label='Functions' }

[ ](/ab_p/beta/docs/sprite.md){: .abp .tooltip .badge }

#### void Reset ( ) {: .copyable aria-label='Functions' }

### SetAnimation () {: aria-label='Functions' }

[ ](/ab_p/beta/docs/sprite.md){: .abp .tooltip .badge }

#### boolean SetAnimation ( string AnimationName ) {: .copyable aria-label='Functions' }

### SetFrame () {: aria-label='Functions' }

[ ](/ab_p/beta/docs/sprite.md){: .abp .tooltip .badge }

#### void SetFrame ( string AnimationName, int FrameNum ) {: .copyable aria-label='Functions' }

### SetLastFrame () {: aria-label='Functions' }

[ ](/ab_p/beta/docs/sprite.md){: .abp .tooltip .badge }

#### void SetLastFrame ( ) {: .copyable aria-label='Functions' }

### SetLayerFrame () {: aria-label='Functions' }

[ ](/ab_p/beta/docs/sprite.md){: .abp .tooltip .badge }

#### void SetLayerFrame ( int LayerId, int FrameNum ) {: .copyable aria-label='Functions' }

### SetOverlayAnimation () {: aria-label='Functions' }

[ ](/ab_p/beta/docs/sprite.md){: .abp .tooltip .badge }

#### boolean SetOverlayAnimation ( string AnimationName ) {: .copyable aria-label='Functions' }

### SetOverlayFrame () {: aria-label='Functions' }

[ ](/ab_p/beta/docs/sprite.md){: .abp .tooltip .badge }

#### void SetOverlayFrame ( string AnimationName, int FrameNum ) {: .copyable aria-label='Functions' }

### SetOverlayRenderPriority () {: aria-label='Functions' }

[ ](/ab_p/beta/docs/sprite.md){: .abp .tooltip .badge }

#### void SetOverlayRenderPriority ( boolean RenderFirst ) {: .copyable aria-label='Functions' }

### Stop () {: aria-label='Functions' }

[ ](/ab_p/beta/docs/sprite.md){: .abp .tooltip .badge }

#### void Stop ( ) {: .copyable aria-label='Functions' }

### Update () {: aria-label='Functions' }

[ ](/ab_p/beta/docs/sprite.md){: .abp .tooltip .badge }

#### void Update ( ) {: .copyable aria-label='Functions' }

### WasEventTriggered () {: aria-label='Functions' }

[ ](/ab_p/beta/docs/sprite.md){: .abp .tooltip .badge }

#### boolean WasEventTriggered ( string EventName ) {: .copyable aria-label='Functions' }

## Variables

### FlipX {: aria-label='Variables' }

[ ](/ab_p/beta/docs/sprite.md){: .abp .tooltip .badge }

#### boolean FlipX  {: .copyable aria-label='Variables' }

### FlipY {: aria-label='Variables' }

[ ](/ab_p/beta/docs/sprite.md){: .abp .tooltip .badge }

#### boolean FlipY  {: .copyable aria-label='Variables' }

### [Color](https://github.com/wofsauge/IsaacDocs/tree/420a6aaa54ea230461fb26e61297c068492684de/beta/Color/README.md) {: aria-label='Variables' }

[ ](/ab_p/beta/docs/sprite.md){: .abp .tooltip .badge }

#### [Color](https://github.com/wofsauge/IsaacDocs/tree/420a6aaa54ea230461fb26e61297c068492684de/beta/Color/README.md) [Color](https://github.com/wofsauge/IsaacDocs/tree/420a6aaa54ea230461fb26e61297c068492684de/beta/Color/README.md)  {: .copyable aria-label='Variables' }

### Offset {: aria-label='Variables' }

[ ](/ab_p/beta/docs/sprite.md){: .abp .tooltip .badge }

#### [Vector](https://github.com/wofsauge/IsaacDocs/tree/420a6aaa54ea230461fb26e61297c068492684de/beta/Vector/README.md) Offset  {: .copyable aria-label='Variables' }

### PlaybackSpeed {: aria-label='Variables' }

[ ](/ab_p/beta/docs/sprite.md){: .abp .tooltip .badge }

#### float PlaybackSpeed  {: .copyable aria-label='Variables' }

### Rotation {: aria-label='Variables' }

[ ](/ab_p/beta/docs/sprite.md){: .abp .tooltip .badge }

#### float Rotation  {: .copyable aria-label='Variables' }

### Scale {: aria-label='Variables' }

[ ](/ab_p/beta/docs/sprite.md){: .abp .tooltip .badge }

#### [Vector](https://github.com/wofsauge/IsaacDocs/tree/420a6aaa54ea230461fb26e61297c068492684de/beta/Vector/README.md) Scale  {: .copyable aria-label='Variables' }


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.moddingofisaac.com/ab_p/beta/docs/sprite.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.