Sprite

(Called internally) Default animation routine

@param wait — The animation coroutine's wait function

See: Object.canDebugSelect

Starts a cross-fade from the current sprite to a new texture

@param texture — The texture to fade into

@param time — The time, in seconds, that the cross-fade should take (Defaults to 1)

@param fade_out — Whether the current sprite texture should fade out during the cross-fade (if false, it disappears at the end)

@param after — The function to run when the cross-fade is complete

Starts a cross-fade from the current sprite to a new texture

@param texture — The texture to fade into

@param speed — The speed at which the alpha of both sprites change, meaasured as the alpha value change per frame at 30FPS (Defaults to 0.04)

@param fade_out — Whether the current sprite texture should fade out during the cross-fade (if false, it disappears at the end)

@param after — The function to run when the cross-fade is complete

@param offset_x — The x-offset of the flash sprite

@param offset_y — The y-offset of the flash sprite

@param layer — (Defaults to 100)

(Called internally) Gets the full path to the texture this sprite should use
given a path by Sprite:setSprite(). If this sprite's path is not empty,
it will be prepended to the given path.

@param name — The relative path of the sprite to get the full path of.

@return texture — The current texture of the sprite, if it exists.

@param texture — The texture to check the existence of, relative to this sprite's path.

@return exists — Whether the given texture exists.

@param texture — The texture to check against this sprite's current texture, relative to this sprite's path.

@return equal — Whether the textures are equal.

(Called internally) Parses animation frame data into a table of frame numbers

@param frames — Input animation: Can use num (frame numbers), ("num1-num2" sequential frames from num1 to num2), and "num1*num2" (repeat frame num1 num2 times)

@return anim — Output animation: Uses only frame numbers

Starts animating the sprite's current texture

@param speed — The speed of the animation as the number of seconds between frames (Defaults to 1/30)

@param loop — Whether the animation should loop (Defautls to false)

@param on_finished — A function to run when the animation finishes

Stops the cross-fade on the current sprite

Sets the sprite to either a texture or an animation.
If the given texture is a string or image, it will be passed into Sprite:setSprite().
If the given texture is a table, it will be passed into Sprite:setAnimation().

@param texture — The texture or animation to set the sprite to.

Sets the animation of the current sprite.
The animation specified in anim can take on multiple forms:

• fun(wait: fun(time: number)) - The animation routine. Receives the animation coroutine's wait function. See Sprite:_basicAnimation(wait) for an example of an animation routine
• table - A table of animation data, in one of these three formats:
• • string|table - The name of the sprite, or a table of frames of the animation,
    number - The time, in seconds, between each frame,
    boolean - Whether the animation should loop
• • string|table - The name of the sprite, or a table of frames of the animation,
    fun(wait: fun(time: number)) - An animation routine
• • fun(wait: fun(time: number)) - An animation routine

Additionally, these keys can be defined in the anim table for further customisation:

• duration: number - The time, in seconds, that the animation will run for
• callback: fun(self: Sprite) - A callback that will run when the sprite stops animating. Receives the sprite as an argument
• frames: (number|string)[] - A custom sequence of frame numbers to use for the aniamtion:
  Can use special notation: num (frame numbers), "num1-num2" (sequential frames from num1 to num2), and "num1*num2" (repeat frame num1 num2 times).
  Only takes effect when not using a custom animation routine
• next: string|table - Another animation to play when the current one finishes. If this is a table, a random entry will be selected as the next animation

(Called internally) Sets the target texture for the current cross-fade

Sets the frame of the current sprite.
If the sprite has no frames, this will do nothing.

@param frame — The frame to set the sprite to. If this is outside of the range of frames, it will wrap around.

(Called internally) Sets the current sprite to a list of frames, and updates the texture.
Note: Ignores path and single-frame textures. Use Sprite:setSprite() instead.

@param frames — The frames to set the sprite to.

@param keep_anim — If true, this will not interrupt the current animation. Otherwise, any animation will be stopped.

Sets the current frame to a percentage between 0 - 1.
If progress is outside of this range, it will wrap around.

@param progress — The percentage (0 - 1) of the animation to set the frame to.

Sets the current sprite.

@param texture — The texture to set the sprite to. If this is a string, it will be relative to this sprite's path.

@param keep_anim — If true, this will not interrupt the current animation. Otherwise, any animation will be stopped.

(Called internally) Sets the current sprite to a single texture.
Note: Ignores path and frames. Use Sprite:setSprite() instead.

@param texture — The texture to set the sprite to.

@param keep_anim — If true, this will not interrupt the current animation. Otherwise, any animation will be stopped.

(Called internally) Sets the current sprite to a single texture.
Note: Only for internal overrides. Use Sprite:setSprite() instead.

Sets the wrapping mode of the sprite.
The texture will repeat across the whole screen in the direction(s) specified.

@param x — Whether the texture should repeat horizontally.

@param y — Whether the texture should repeat vertically. If not specified, this will be the same as x.

Stops the animation of the current sprite

@param keep_frame — Whether to keep the current frame of the sprite. If false, the sprite sets back to the first frame

(Called internally) Updates the sprite's texture to its current frame.
If the sprite has no frames, this will do nothing.

A function that is called when the current animation finishes.

(Read-only) The delay between frames in the current animation.

(Read-only) The duration of the current animation. If greater than 0, the animation will stop after this many seconds.

(Read-only) A list of frame indexes the current animation loops through. If nil, the animation loops through all frames.

(Read-only) The coroutine of the current sprite animation.

(Read-only) The function of the current sprite animation.

A multiplier for how fast the sprite animates. (Defaults to 1)

(Read-only) The name of the sprite used in the current animation.

(Read-only) The function used to wait for the next frame of the animation.

(Read-only) Set by the wait function of an animation routine. The amount of time left until the animation continues.

(Read-only) The current frame of the sprite. Set with Sprite:setFrame().

(Read-only) The animation frames of the sprite, or nil if the texture has no frames.

Whether the sprite will continuously loop its animation. (Defaults to false)

The base path of the sprite.
Any calls to Sprite:setSprite() will have this path prepended to them,
only checking for textures inside this folder.
Note: This path is still relative to assets/sprites/!

(Read-only) Whether an animation is currently playing.

(Read-only) The current texture of the sprite, if it exists.

(Read-only) The string ID of the current texture, if it exists.

Whether this sprite's width and height will be updated to the size of the texture.
Defaults to true if a width and height is not specified in the constructor.

If enabled, the texture will repeat horizontally across the screen.

If enabled, the texture will repeat vertically across the screen.