Afterbirth+ Documentation
  • README
  • beta
    • docs
      • Class "RoomConfig::Entry"
      • Class "ItemConfig::Card"
      • Class "PlayerTypes::PosVel"
      • enums
        • Enum "DoorVariant"
        • CollectibleType
        • Enum "ActionTriggers"
        • Enum "Card"
        • Enum "NpcState"
        • Enum "EffectVariant"
        • Enum "EntityGridCollisionClass"
        • Enum "EntityFlag"
        • Enum "LocustSubtypes"
        • Enum "LevelCurse"
        • Enum "GridRooms"
        • Enum "TrinketType"
        • Enum "SortingLayer"
        • Enum "ItemType"
        • Enum "GridCollisionClass"
        • Enum "ModCallbacks"
        • Enum "DoorSlot"
        • Enum "CacheFlag"
        • Enum "PillEffect"
        • Enum "EntityCollisionClass"
        • Enum "ItemPoolType"
        • Enum "PickupPrice"
        • Enum "InputHook"
        • Enum "ButtonAction"
        • Enum "PlayerSpriteLayer"
        • Enum "Keyboard"
        • Enum "GameStateFlag"
        • Enum "PillColor"
        • Enum "CoinSubType"
        • Enum "PlayerForm"
        • Enum "PickupVariant"
        • Enum "GridEntityType"
        • Enum "EntityPartition"
        • Enum "SeedEffect"
        • Enum "RoomShape"
        • Enum "Mouse"
        • Enum "TearFlags"
        • Enum "Music"
        • Enum "BabySubType"
        • Enum "BombVariant"
        • Enum "DoorState"
        • Enum "Challenge"
        • Enum "TearVariant"
        • Enum "EntityType"
        • Enum "SoundEffect"
        • Enum "FamiliarVariant"
        • Enum "PlayerType"
        • Enum "Difficulty"
        • Enum "DamageFlag"
        • Enum "Direction"
        • Enum "KeySubType"
        • Enum "LaserOffset"
        • Enum "ProjectileFlags"
        • Enum "LevelStage"
        • Enum "PlayerItemState"
        • Enum "LevelStateFlag"
        • Enum "ChestSubType"
        • Enum "ProjectileVariant"
        • Enum "WeaponType"
        • Enum "RoomType"
        • Enum "NullItemID"
        • Enum "StageType"
        • Enum "HeartSubType"
        • Enum "BombSubType"
      • Class "Isaac"
      • Class "ProjectileParams"
      • Class "Font"
      • Class "ItemPool"
      • Class "GridEntityRock"
      • tutorials
        • Class "[Tutorial]Rendertext"
        • Tutorial: Example Project
        • Class "XMLFiledocumentation"
        • Class "Writingscreenshaders"
        • Class "DebugConsole"
        • [Tutorial] Adding Costumes to items without LUA
        • Class "Usingadditional.luaFiles"
        • [Tutorial] Debugging with ZeroBrane Studio
      • Class "CppContainer::Vector::ItemConfigList"
      • Class "EntityProjectile"
      • Class "CppContainer::ArrayProxy"
      • Class "CppContainer::Vector::CardConfigList"
      • Class "PathFinder"
      • Class "ItemConfig::PillEffect"
      • Class "CppContainer::Vector::EffectList"
      • Class "RoomDescriptor"
      • Class "GridEntity"
      • Class "GridEntityPoop"
      • PLACEHOLDER
      • Class "TearParams"
      • Class "GridEntityPit"
      • Class "EntityFamiliar"
      • Class "MusicManager"
      • Class "SFXManager"
      • Lua API Documentation for The Binding of Isaac - Afterbirth+
      • Class "GridEntityTNT"
      • Class "EntityRef"
      • Class "Sprite"
      • Class "EntityBomb"
      • Class "EntityTear"
      • Class "QueueItemData"
      • Class "EntityPlayer"
      • Class "Vector"
      • Class "Entity"
      • Class "ItemConfig::Config"
      • Class "CppContainer::ArrayProxy::RoomList"
      • Class "RNG"
      • Class "EntityPtr"
      • Class "Input"
      • Class "EntityPickup"
      • Class "EntityLaser"
      • Class "GridEntityPressurePlate"
      • Class "CppContainer::Vector::VectorList"
      • Class "Room"
      • Class "CppContainer::Vector::CostumeConfigList"
      • Class "GridEntityDesc"
      • Class "Level"
      • Class "RoomConfig::Spawn"
      • Class "Color"
      • Class "KColor"
      • Class "TemporaryEffect"
      • Class "EntityKnife"
      • Class "Seeds"
      • Class "CppContainer::EntityList"
      • Class "GridEntityDoor"
      • Class "ShockwaveParams"
      • Class "ItemConfig::Costume"
      • Class "GridEntitySpikes"
      • Class "EntityEffect"
      • Class "CppContainer::Vector::PillConfigList"
      • Class "EntityNPC"
      • Class "RoomDescriptorData"
      • Class "ItemConfig::Item"
      • Class "RoomConfig::Room"
      • Class "Game"
      • Class "TemporaryEffects"
      • Class "PlayerTypes::ActiveItemDesc"
      • Class "Global Functions"
Powered by GitBook
On this page
  • Constructors
  • Sprite () {: aria-label='Constructors' }
  • Functions
  • GetDefaultAnimation () {: aria-label='Functions' }
  • GetDefaultAnimationName () {: aria-label='Functions' }
  • GetFilename () {: aria-label='Functions' }
  • GetFrame () {: aria-label='Functions' }
  • GetLayerCount () {: aria-label='Functions' }
  • GetOverlayFrame () {: aria-label='Functions' }
  • GetTexel () {: aria-label='Functions' }
  • IsEventTriggered () {: aria-label='Functions' }
  • IsFinished () {: aria-label='Functions' }
  • IsLoaded () {: aria-label='Functions' }
  • IsOverlayFinished () {: aria-label='Functions' }
  • IsOverlayPlaying () {: aria-label='Functions' }
  • IsPlaying () {: aria-label='Functions' }
  • Load () {: aria-label='Functions' }
  • LoadGraphics () {: aria-label='Functions' }
  • Play () {: aria-label='Functions' }
  • PlayOverlay () {: aria-label='Functions' }
  • PlayRandom () {: aria-label='Functions' }
  • Reload () {: aria-label='Functions' }
  • RemoveOverlay () {: aria-label='Functions' }
  • Render () {: aria-label='Functions' }
  • RenderLayer () {: aria-label='Functions' }
  • ReplaceSpritesheet () {: aria-label='Functions' }
  • Reset () {: aria-label='Functions' }
  • SetAnimation () {: aria-label='Functions' }
  • SetFrame () {: aria-label='Functions' }
  • SetLastFrame () {: aria-label='Functions' }
  • SetLayerFrame () {: aria-label='Functions' }
  • SetOverlayAnimation () {: aria-label='Functions' }
  • SetOverlayFrame () {: aria-label='Functions' }
  • SetOverlayRenderPriority () {: aria-label='Functions' }
  • Stop () {: aria-label='Functions' }
  • Update () {: aria-label='Functions' }
  • WasEventTriggered () {: aria-label='Functions' }
  • Variables
  • FlipX {: aria-label='Variables' }
  • FlipY {: aria-label='Variables' }
  • Color {: aria-label='Variables' }
  • Offset {: aria-label='Variables' }
  • PlaybackSpeed {: aria-label='Variables' }
  • Rotation {: aria-label='Variables' }
  • Scale {: aria-label='Variables' }

Was this helpful?

  1. beta
  2. docs

Class "Sprite"

PreviousClass "EntityRef"NextClass "EntityBomb"

Last updated 4 years ago

Was this helpful?

Constructors

() {: aria-label='Constructors' }

{: .abp .tooltip .badge }

void ( void ) {: .copyable aria-label='Constructors' }

Functions

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

{: .abp .tooltip .badge }

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

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

{: .abp .tooltip .badge }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Variables

FlipX {: aria-label='Variables' }

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

FlipY {: aria-label='Variables' }

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

Offset {: aria-label='Variables' }

PlaybackSpeed {: aria-label='Variables' }

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

Rotation {: aria-label='Variables' }

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

Scale {: aria-label='Variables' }

{: .abp .tooltip .badge }

{: .abp .tooltip .badge }

{: .abp .tooltip .badge }

{: .abp .tooltip .badge }

{: .abp .tooltip .badge }

GetTexel ( SamplePos, RenderPos, float AlphaThreshold ) {: .copyable aria-label='Functions' }

{: .abp .tooltip .badge }

{: .abp .tooltip .badge }

{: .abp .tooltip .badge }

{: .abp .tooltip .badge }

{: .abp .tooltip .badge }

{: .abp .tooltip .badge }

{: .abp .tooltip .badge }

{: .abp .tooltip .badge }

{: .abp .tooltip .badge }

{: .abp .tooltip .badge }

{: .abp .tooltip .badge }

{: .abp .tooltip .badge }

{: .abp .tooltip .badge }

{: .abp .tooltip .badge }

void Render ( Pos, TopLeftClamp, BottomRightClamp ) {: .copyable aria-label='Functions' }

{: .abp .tooltip .badge }

void RenderLayer ( int LayerId, Pos ) {: .copyable aria-label='Functions' }

{: .abp .tooltip .badge }

{: .abp .tooltip .badge }

{: .abp .tooltip .badge }

{: .abp .tooltip .badge }

{: .abp .tooltip .badge }

{: .abp .tooltip .badge }

{: .abp .tooltip .badge }

{: .abp .tooltip .badge }

{: .abp .tooltip .badge }

{: .abp .tooltip .badge }

{: .abp .tooltip .badge }

{: .abp .tooltip .badge }

{: .abp .tooltip .badge }

{: .abp .tooltip .badge }

{: aria-label='Variables' }

{: .abp .tooltip .badge }

{: .copyable aria-label='Variables' }

{: .abp .tooltip .badge }

Offset {: .copyable aria-label='Variables' }

{: .abp .tooltip .badge }

{: .abp .tooltip .badge }

{: .abp .tooltip .badge }

Scale {: .copyable aria-label='Variables' }

Sprite
Sprite
Color
Vector
Vector
Vector
Vector
Vector
Vector
Color
Color
Color
Vector
Vector