Struct AnimatedTexture

Proxy texture for simple frame-based animations.

struct AnimatedTexture ;

AnimatedTexture is a resource format for frame-based animations, where multiple textures can be chained automatically with a predefined delay for each frame. Unlike AnimationPlayer or AnimatedSprite, it isn't a Node, but has the advantage of being usable anywhere a Texture resource can be used, e.g. in a TileSet. The playback of the animation is controlled by the fps property as well as each frame's optional delay (see setFrameDelay). The animation loops, i.e. it will restart at frame 0 automatically after playing the last frame. AnimatedTexture currently requires all frame textures to have the same size, otherwise the bigger ones will be cropped to match the smallest one. Also, it doesn't support AtlasTexture. Each frame needs to be separate image.

Properties

NameTypeDescription
fps[get, set] doubleAnimation speed in frames per second. This value defines the default time interval between two frames of the animation, and thus the overall duration of the animation loop based on the frames property. A value of 0 means no predefined number of frames per second, the animation will play according to each frame's frame delay (see setFrameDelay). For example, an animation with 8 frames, no frame delay and a fps value of 2 will run for 4 seconds, with each frame lasting 0.5 seconds.
frame0DelaySec[get, set] double
frame0Texture[get, set] Texture
frame100DelaySec[get, set] double
frame100Texture[get, set] Texture
frame101DelaySec[get, set] double
frame101Texture[get, set] Texture
frame102DelaySec[get, set] double
frame102Texture[get, set] Texture
frame103DelaySec[get, set] double
frame103Texture[get, set] Texture
frame104DelaySec[get, set] double
frame104Texture[get, set] Texture
frame105DelaySec[get, set] double
frame105Texture[get, set] Texture
frame106DelaySec[get, set] double
frame106Texture[get, set] Texture
frame107DelaySec[get, set] double
frame107Texture[get, set] Texture
frame108DelaySec[get, set] double
frame108Texture[get, set] Texture
frame109DelaySec[get, set] double
frame109Texture[get, set] Texture
frame10DelaySec[get, set] double
frame10Texture[get, set] Texture
frame110DelaySec[get, set] double
frame110Texture[get, set] Texture
frame111DelaySec[get, set] double
frame111Texture[get, set] Texture
frame112DelaySec[get, set] double
frame112Texture[get, set] Texture
frame113DelaySec[get, set] double
frame113Texture[get, set] Texture
frame114DelaySec[get, set] double
frame114Texture[get, set] Texture
frame115DelaySec[get, set] double
frame115Texture[get, set] Texture
frame116DelaySec[get, set] double
frame116Texture[get, set] Texture
frame117DelaySec[get, set] double
frame117Texture[get, set] Texture
frame118DelaySec[get, set] double
frame118Texture[get, set] Texture
frame119DelaySec[get, set] double
frame119Texture[get, set] Texture
frame11DelaySec[get, set] double
frame11Texture[get, set] Texture
frame120DelaySec[get, set] double
frame120Texture[get, set] Texture
frame121DelaySec[get, set] double
frame121Texture[get, set] Texture
frame122DelaySec[get, set] double
frame122Texture[get, set] Texture
frame123DelaySec[get, set] double
frame123Texture[get, set] Texture
frame124DelaySec[get, set] double
frame124Texture[get, set] Texture
frame125DelaySec[get, set] double
frame125Texture[get, set] Texture
frame126DelaySec[get, set] double
frame126Texture[get, set] Texture
frame127DelaySec[get, set] double
frame127Texture[get, set] Texture
frame128DelaySec[get, set] double
frame128Texture[get, set] Texture
frame129DelaySec[get, set] double
frame129Texture[get, set] Texture
frame12DelaySec[get, set] double
frame12Texture[get, set] Texture
frame130DelaySec[get, set] double
frame130Texture[get, set] Texture
frame131DelaySec[get, set] double
frame131Texture[get, set] Texture
frame132DelaySec[get, set] double
frame132Texture[get, set] Texture
frame133DelaySec[get, set] double
frame133Texture[get, set] Texture
frame134DelaySec[get, set] double
frame134Texture[get, set] Texture
frame135DelaySec[get, set] double
frame135Texture[get, set] Texture
frame136DelaySec[get, set] double
frame136Texture[get, set] Texture
frame137DelaySec[get, set] double
frame137Texture[get, set] Texture
frame138DelaySec[get, set] double
frame138Texture[get, set] Texture
frame139DelaySec[get, set] double
frame139Texture[get, set] Texture
frame13DelaySec[get, set] double
frame13Texture[get, set] Texture
frame140DelaySec[get, set] double
frame140Texture[get, set] Texture
frame141DelaySec[get, set] double
frame141Texture[get, set] Texture
frame142DelaySec[get, set] double
frame142Texture[get, set] Texture
frame143DelaySec[get, set] double
frame143Texture[get, set] Texture
frame144DelaySec[get, set] double
frame144Texture[get, set] Texture
frame145DelaySec[get, set] double
frame145Texture[get, set] Texture
frame146DelaySec[get, set] double
frame146Texture[get, set] Texture
frame147DelaySec[get, set] double
frame147Texture[get, set] Texture
frame148DelaySec[get, set] double
frame148Texture[get, set] Texture
frame149DelaySec[get, set] double
frame149Texture[get, set] Texture
frame14DelaySec[get, set] double
frame14Texture[get, set] Texture
frame150DelaySec[get, set] double
frame150Texture[get, set] Texture
frame151DelaySec[get, set] double
frame151Texture[get, set] Texture
frame152DelaySec[get, set] double
frame152Texture[get, set] Texture
frame153DelaySec[get, set] double
frame153Texture[get, set] Texture
frame154DelaySec[get, set] double
frame154Texture[get, set] Texture
frame155DelaySec[get, set] double
frame155Texture[get, set] Texture
frame156DelaySec[get, set] double
frame156Texture[get, set] Texture
frame157DelaySec[get, set] double
frame157Texture[get, set] Texture
frame158DelaySec[get, set] double
frame158Texture[get, set] Texture
frame159DelaySec[get, set] double
frame159Texture[get, set] Texture
frame15DelaySec[get, set] double
frame15Texture[get, set] Texture
frame160DelaySec[get, set] double
frame160Texture[get, set] Texture
frame161DelaySec[get, set] double
frame161Texture[get, set] Texture
frame162DelaySec[get, set] double
frame162Texture[get, set] Texture
frame163DelaySec[get, set] double
frame163Texture[get, set] Texture
frame164DelaySec[get, set] double
frame164Texture[get, set] Texture
frame165DelaySec[get, set] double
frame165Texture[get, set] Texture
frame166DelaySec[get, set] double
frame166Texture[get, set] Texture
frame167DelaySec[get, set] double
frame167Texture[get, set] Texture
frame168DelaySec[get, set] double
frame168Texture[get, set] Texture
frame169DelaySec[get, set] double
frame169Texture[get, set] Texture
frame16DelaySec[get, set] double
frame16Texture[get, set] Texture
frame170DelaySec[get, set] double
frame170Texture[get, set] Texture
frame171DelaySec[get, set] double
frame171Texture[get, set] Texture
frame172DelaySec[get, set] double
frame172Texture[get, set] Texture
frame173DelaySec[get, set] double
frame173Texture[get, set] Texture
frame174DelaySec[get, set] double
frame174Texture[get, set] Texture
frame175DelaySec[get, set] double
frame175Texture[get, set] Texture
frame176DelaySec[get, set] double
frame176Texture[get, set] Texture
frame177DelaySec[get, set] double
frame177Texture[get, set] Texture
frame178DelaySec[get, set] double
frame178Texture[get, set] Texture
frame179DelaySec[get, set] double
frame179Texture[get, set] Texture
frame17DelaySec[get, set] double
frame17Texture[get, set] Texture
frame180DelaySec[get, set] double
frame180Texture[get, set] Texture
frame181DelaySec[get, set] double
frame181Texture[get, set] Texture
frame182DelaySec[get, set] double
frame182Texture[get, set] Texture
frame183DelaySec[get, set] double
frame183Texture[get, set] Texture
frame184DelaySec[get, set] double
frame184Texture[get, set] Texture
frame185DelaySec[get, set] double
frame185Texture[get, set] Texture
frame186DelaySec[get, set] double
frame186Texture[get, set] Texture
frame187DelaySec[get, set] double
frame187Texture[get, set] Texture
frame188DelaySec[get, set] double
frame188Texture[get, set] Texture
frame189DelaySec[get, set] double
frame189Texture[get, set] Texture
frame18DelaySec[get, set] double
frame18Texture[get, set] Texture
frame190DelaySec[get, set] double
frame190Texture[get, set] Texture
frame191DelaySec[get, set] double
frame191Texture[get, set] Texture
frame192DelaySec[get, set] double
frame192Texture[get, set] Texture
frame193DelaySec[get, set] double
frame193Texture[get, set] Texture
frame194DelaySec[get, set] double
frame194Texture[get, set] Texture
frame195DelaySec[get, set] double
frame195Texture[get, set] Texture
frame196DelaySec[get, set] double
frame196Texture[get, set] Texture
frame197DelaySec[get, set] double
frame197Texture[get, set] Texture
frame198DelaySec[get, set] double
frame198Texture[get, set] Texture
frame199DelaySec[get, set] double
frame199Texture[get, set] Texture
frame19DelaySec[get, set] double
frame19Texture[get, set] Texture
frame1DelaySec[get, set] double
frame1Texture[get, set] Texture
frame200DelaySec[get, set] double
frame200Texture[get, set] Texture
frame201DelaySec[get, set] double
frame201Texture[get, set] Texture
frame202DelaySec[get, set] double
frame202Texture[get, set] Texture
frame203DelaySec[get, set] double
frame203Texture[get, set] Texture
frame204DelaySec[get, set] double
frame204Texture[get, set] Texture
frame205DelaySec[get, set] double
frame205Texture[get, set] Texture
frame206DelaySec[get, set] double
frame206Texture[get, set] Texture
frame207DelaySec[get, set] double
frame207Texture[get, set] Texture
frame208DelaySec[get, set] double
frame208Texture[get, set] Texture
frame209DelaySec[get, set] double
frame209Texture[get, set] Texture
frame20DelaySec[get, set] double
frame20Texture[get, set] Texture
frame210DelaySec[get, set] double
frame210Texture[get, set] Texture
frame211DelaySec[get, set] double
frame211Texture[get, set] Texture
frame212DelaySec[get, set] double
frame212Texture[get, set] Texture
frame213DelaySec[get, set] double
frame213Texture[get, set] Texture
frame214DelaySec[get, set] double
frame214Texture[get, set] Texture
frame215DelaySec[get, set] double
frame215Texture[get, set] Texture
frame216DelaySec[get, set] double
frame216Texture[get, set] Texture
frame217DelaySec[get, set] double
frame217Texture[get, set] Texture
frame218DelaySec[get, set] double
frame218Texture[get, set] Texture
frame219DelaySec[get, set] double
frame219Texture[get, set] Texture
frame21DelaySec[get, set] double
frame21Texture[get, set] Texture
frame220DelaySec[get, set] double
frame220Texture[get, set] Texture
frame221DelaySec[get, set] double
frame221Texture[get, set] Texture
frame222DelaySec[get, set] double
frame222Texture[get, set] Texture
frame223DelaySec[get, set] double
frame223Texture[get, set] Texture
frame224DelaySec[get, set] double
frame224Texture[get, set] Texture
frame225DelaySec[get, set] double
frame225Texture[get, set] Texture
frame226DelaySec[get, set] double
frame226Texture[get, set] Texture
frame227DelaySec[get, set] double
frame227Texture[get, set] Texture
frame228DelaySec[get, set] double
frame228Texture[get, set] Texture
frame229DelaySec[get, set] double
frame229Texture[get, set] Texture
frame22DelaySec[get, set] double
frame22Texture[get, set] Texture
frame230DelaySec[get, set] double
frame230Texture[get, set] Texture
frame231DelaySec[get, set] double
frame231Texture[get, set] Texture
frame232DelaySec[get, set] double
frame232Texture[get, set] Texture
frame233DelaySec[get, set] double
frame233Texture[get, set] Texture
frame234DelaySec[get, set] double
frame234Texture[get, set] Texture
frame235DelaySec[get, set] double
frame235Texture[get, set] Texture
frame236DelaySec[get, set] double
frame236Texture[get, set] Texture
frame237DelaySec[get, set] double
frame237Texture[get, set] Texture
frame238DelaySec[get, set] double
frame238Texture[get, set] Texture
frame239DelaySec[get, set] double
frame239Texture[get, set] Texture
frame23DelaySec[get, set] double
frame23Texture[get, set] Texture
frame240DelaySec[get, set] double
frame240Texture[get, set] Texture
frame241DelaySec[get, set] double
frame241Texture[get, set] Texture
frame242DelaySec[get, set] double
frame242Texture[get, set] Texture
frame243DelaySec[get, set] double
frame243Texture[get, set] Texture
frame244DelaySec[get, set] double
frame244Texture[get, set] Texture
frame245DelaySec[get, set] double
frame245Texture[get, set] Texture
frame246DelaySec[get, set] double
frame246Texture[get, set] Texture
frame247DelaySec[get, set] double
frame247Texture[get, set] Texture
frame248DelaySec[get, set] double
frame248Texture[get, set] Texture
frame249DelaySec[get, set] double
frame249Texture[get, set] Texture
frame24DelaySec[get, set] double
frame24Texture[get, set] Texture
frame250DelaySec[get, set] double
frame250Texture[get, set] Texture
frame251DelaySec[get, set] double
frame251Texture[get, set] Texture
frame252DelaySec[get, set] double
frame252Texture[get, set] Texture
frame253DelaySec[get, set] double
frame253Texture[get, set] Texture
frame254DelaySec[get, set] double
frame254Texture[get, set] Texture
frame255DelaySec[get, set] double
frame255Texture[get, set] Texture
frame25DelaySec[get, set] double
frame25Texture[get, set] Texture
frame26DelaySec[get, set] double
frame26Texture[get, set] Texture
frame27DelaySec[get, set] double
frame27Texture[get, set] Texture
frame28DelaySec[get, set] double
frame28Texture[get, set] Texture
frame29DelaySec[get, set] double
frame29Texture[get, set] Texture
frame2DelaySec[get, set] double
frame2Texture[get, set] Texture
frame30DelaySec[get, set] double
frame30Texture[get, set] Texture
frame31DelaySec[get, set] double
frame31Texture[get, set] Texture
frame32DelaySec[get, set] double
frame32Texture[get, set] Texture
frame33DelaySec[get, set] double
frame33Texture[get, set] Texture
frame34DelaySec[get, set] double
frame34Texture[get, set] Texture
frame35DelaySec[get, set] double
frame35Texture[get, set] Texture
frame36DelaySec[get, set] double
frame36Texture[get, set] Texture
frame37DelaySec[get, set] double
frame37Texture[get, set] Texture
frame38DelaySec[get, set] double
frame38Texture[get, set] Texture
frame39DelaySec[get, set] double
frame39Texture[get, set] Texture
frame3DelaySec[get, set] double
frame3Texture[get, set] Texture
frame40DelaySec[get, set] double
frame40Texture[get, set] Texture
frame41DelaySec[get, set] double
frame41Texture[get, set] Texture
frame42DelaySec[get, set] double
frame42Texture[get, set] Texture
frame43DelaySec[get, set] double
frame43Texture[get, set] Texture
frame44DelaySec[get, set] double
frame44Texture[get, set] Texture
frame45DelaySec[get, set] double
frame45Texture[get, set] Texture
frame46DelaySec[get, set] double
frame46Texture[get, set] Texture
frame47DelaySec[get, set] double
frame47Texture[get, set] Texture
frame48DelaySec[get, set] double
frame48Texture[get, set] Texture
frame49DelaySec[get, set] double
frame49Texture[get, set] Texture
frame4DelaySec[get, set] double
frame4Texture[get, set] Texture
frame50DelaySec[get, set] double
frame50Texture[get, set] Texture
frame51DelaySec[get, set] double
frame51Texture[get, set] Texture
frame52DelaySec[get, set] double
frame52Texture[get, set] Texture
frame53DelaySec[get, set] double
frame53Texture[get, set] Texture
frame54DelaySec[get, set] double
frame54Texture[get, set] Texture
frame55DelaySec[get, set] double
frame55Texture[get, set] Texture
frame56DelaySec[get, set] double
frame56Texture[get, set] Texture
frame57DelaySec[get, set] double
frame57Texture[get, set] Texture
frame58DelaySec[get, set] double
frame58Texture[get, set] Texture
frame59DelaySec[get, set] double
frame59Texture[get, set] Texture
frame5DelaySec[get, set] double
frame5Texture[get, set] Texture
frame60DelaySec[get, set] double
frame60Texture[get, set] Texture
frame61DelaySec[get, set] double
frame61Texture[get, set] Texture
frame62DelaySec[get, set] double
frame62Texture[get, set] Texture
frame63DelaySec[get, set] double
frame63Texture[get, set] Texture
frame64DelaySec[get, set] double
frame64Texture[get, set] Texture
frame65DelaySec[get, set] double
frame65Texture[get, set] Texture
frame66DelaySec[get, set] double
frame66Texture[get, set] Texture
frame67DelaySec[get, set] double
frame67Texture[get, set] Texture
frame68DelaySec[get, set] double
frame68Texture[get, set] Texture
frame69DelaySec[get, set] double
frame69Texture[get, set] Texture
frame6DelaySec[get, set] double
frame6Texture[get, set] Texture
frame70DelaySec[get, set] double
frame70Texture[get, set] Texture
frame71DelaySec[get, set] double
frame71Texture[get, set] Texture
frame72DelaySec[get, set] double
frame72Texture[get, set] Texture
frame73DelaySec[get, set] double
frame73Texture[get, set] Texture
frame74DelaySec[get, set] double
frame74Texture[get, set] Texture
frame75DelaySec[get, set] double
frame75Texture[get, set] Texture
frame76DelaySec[get, set] double
frame76Texture[get, set] Texture
frame77DelaySec[get, set] double
frame77Texture[get, set] Texture
frame78DelaySec[get, set] double
frame78Texture[get, set] Texture
frame79DelaySec[get, set] double
frame79Texture[get, set] Texture
frame7DelaySec[get, set] double
frame7Texture[get, set] Texture
frame80DelaySec[get, set] double
frame80Texture[get, set] Texture
frame81DelaySec[get, set] double
frame81Texture[get, set] Texture
frame82DelaySec[get, set] double
frame82Texture[get, set] Texture
frame83DelaySec[get, set] double
frame83Texture[get, set] Texture
frame84DelaySec[get, set] double
frame84Texture[get, set] Texture
frame85DelaySec[get, set] double
frame85Texture[get, set] Texture
frame86DelaySec[get, set] double
frame86Texture[get, set] Texture
frame87DelaySec[get, set] double
frame87Texture[get, set] Texture
frame88DelaySec[get, set] double
frame88Texture[get, set] Texture
frame89DelaySec[get, set] double
frame89Texture[get, set] Texture
frame8DelaySec[get, set] double
frame8Texture[get, set] Texture
frame90DelaySec[get, set] double
frame90Texture[get, set] Texture
frame91DelaySec[get, set] double
frame91Texture[get, set] Texture
frame92DelaySec[get, set] double
frame92Texture[get, set] Texture
frame93DelaySec[get, set] double
frame93Texture[get, set] Texture
frame94DelaySec[get, set] double
frame94Texture[get, set] Texture
frame95DelaySec[get, set] double
frame95Texture[get, set] Texture
frame96DelaySec[get, set] double
frame96Texture[get, set] Texture
frame97DelaySec[get, set] double
frame97Texture[get, set] Texture
frame98DelaySec[get, set] double
frame98Texture[get, set] Texture
frame99DelaySec[get, set] double
frame99Texture[get, set] Texture
frame9DelaySec[get, set] double
frame9Texture[get, set] Texture
frames[get, set] longNumber of frames to use in the animation. While you can create the frames independently with setFrameTexture, you need to set this value for the animation to take new frames into account. The maximum number of frames is constant MAX_FRAMES.

Methods

NameDescription
_updateProxy
getFps
getFrameDelay Returns the given frame's delay value.
getFrames
getFrameTexture Returns the given frame's Texture.
setFps
setFrameDelay Sets an additional delay (in seconds) between this frame and the next one, that will be added to the time interval defined by fps. By default, frames have no delay defined. If a delay value is defined, the final time interval between this frame and the next will be 1.0 / fps + delay. For example, for an animation with 3 frames, 2 FPS and a frame delay on the second frame of 1.2, the resulting playback will be:
setFrames
setFrameTexture Assigns a Texture to the given frame. Frame IDs start at 0, so the first frame has ID 0, and the last frame of the animation has ID frames - 1. You can define any number of textures up to constant MAX_FRAMES, but keep in mind that only frames from 0 to frames - 1 will be part of the animation.

Enums

NameDescription
Constants