Adds an animation to the sprite. The animation should be preloaded in the preload() function using loadAnimation. Animations require a identifying label (string) to change them. Animations are stored in the sprite but not necessarily displayed until Sprite.changeAnimation(label) is called.

Usage:

• sprite.addAnimation(label, animation);

Alternative usages. See Animation for more information on file sequences:

• sprite.addAnimation(label, firstFrame, lastFrame);
• sprite.addAnimation(label, frame1, frame2, frame3...);

Adds an image to the sprite. An image will be considered a one-frame animation. The image should be preloaded in the preload() function using p5 loadImage. Animations require a identifying label (string) to change them. The image is stored in the sprite but not necessarily displayed until Sprite.changeAnimation(label) is called

Usages:

• sprite.addImage(label, image);
• sprite.addImage(image);

If only an image is passed no label is specified

Pushes the sprite in a direction defined by an angle. The force is added to the current velocity.

Adds the sprite to an existing group

Pushes the sprite toward a point. The force is added to the current velocity.

Checks if the the sprite is overlapping another sprite or a group. If the overlap is positive the sprites will bounce affecting each other's trajectories depending on their .velocity, .mass and .restitution

The check is performed using the colliders. If colliders are not set they will be created automatically from the image/animation bounding box.

A callback function can be specified to perform additional operations when the collision occours. If the target is a group the function will be called for each single sprite colliding. The parameter of the function are respectively the current sprite and the colliding sprite.

Checks if the the sprite is overlapping another sprite or a group. If the overlap is positive the sprite will bounce with the target(s) treated as immovable.

The check is performed using the colliders. If colliders are not set they will be created automatically from the image/animation bounding box.

A callback function can be specified to perform additional operations when the collision occours. If the target is a group the function will be called for each single sprite colliding. The parameter of the function are respectively the current sprite and the colliding sprite.

Changes the displayed animation. See Animation for more control over the sequence.

Changes the displayed image/animation. Equivalent to changeAnimation

Checks if the the sprite is overlapping another sprite or a group. If the overlap is positive the sprite will bounce with the target(s) treated as immovable with a restitution coefficient of zero.

The check is performed using the colliders. If colliders are not set they will be created automatically from the image/animation bounding box.

A callback function can be specified to perform additional operations when the collision occours. If the target is a group the function will be called for each single sprite colliding. The parameter of the function are respectively the current sprite and the colliding sprite.

Alias for remove()

Checks if the the sprite is overlapping another sprite or a group. If the overlap is positive the current sprite will displace the colliding one to the closest non-overlapping position.

The check is performed using the colliders. If colliders are not set they will be created automatically from the image/animation bounding box.

A callback function can be specified to perform additional operations when the collision occours. If the target is a group the function will be called for each single sprite colliding. The parameter of the function are respectively the current sprite and the colliding sprite.

Manages the visuals of the sprite. It can be overridden with a custom drawing function. The 0,0 point will be the center of the sprite. Example: sprite.draw = function() { ellipse(0,0,10,10) } Will display the sprite as circle.

Wrapper to access animation.frameChanged

Returns the label of the current animation

Calculates the movement's direction in degrees.

Gets the scaled height of the sprite.

Gets the scaled width of the sprite.

Calculates the scalar speed.

Alias for overlap(), except without a callback parameter. The check is performed using the colliders. If colliders are not set they will be created automatically from the image/animation bounding box.

Returns whether or not this sprite is overlapping another sprite or group. Modifies the sprite's touching property object.

Limits the scalar speed.

Sets the sprite's horizontal mirroring. If 1 the images displayed normally If -1 the images are flipped horizontally If no argument returns the current x mirroring

Sets the sprite's vertical mirroring. If 1 the images displayed normally If -1 the images are flipped vertically If no argument returns the current y mirroring

Updates the sprite mouse states and triggers the mouse events: onMouseOver, onMouseOut, onMousePressed, onMouseReleased

Alias for animation.nextFrame()

Checks if the the sprite is overlapping another sprite or a group. The check is performed using the colliders. If colliders are not set they will be created automatically from the image/animation bounding box.

A callback function can be specified to perform additional operations when the overlap occours. If the target is a group the function will be called for each single sprite overlapping. The parameter of the function are respectively the current sprite and the colliding sprite.

Checks if the given point corresponds to a transparent pixel in the sprite's current image. It can be used to check a point collision against only the visible part of the sprite.

Checks if the given point is inside the sprite's collider.

Alias for animation.stop()

Alias for animation.play() with extra logic

Plays/resumes the sprite's current animation. If the animation is currently playing this has no effect. If the animation has stopped at its last frame, this will start it over at the beginning.

Alias for animation.previousFrame()

Removes the Sprite from the sketch. The removed Sprite won't be drawn or updated anymore.

Sets a collider for the sprite.

In p5.play a Collider is an invisible circle or rectangle that can have any size or position relative to the sprite and which will be used to detect collisions and overlapping with other sprites, or the mouse cursor.

If the sprite is checked for collision, bounce, overlapping or mouse events a rectangle collider is automatically created from the width and height parameter passed at the creation of the sprite or the from the image dimension in case of animated sprites.

Often the image bounding box is not appropriate as the active area for collision detection so you can set a circular or rectangular sprite with different dimensions and offset from the sprite's center.

There are many ways to call this method. The first argument determines the type of collider you are creating, which in turn changes the remaining arguments. Valid collider types are:

• point - A point collider with no dimensions, only a position.

  setCollider("point"[, offsetX, offsetY])

• circle - A circular collider with a set radius.

  setCollider("circle"[, offsetX, offsetY[, radius])

• rectangle - An alias for aabb, below.

• aabb - An axis-aligned bounding box - has width and height but no rotation.

  setCollider("aabb"[, offsetX, offsetY[, width, height]])

• obb - An oriented bounding box - has width, height, and rotation.

  setCollider("obb"[, offsetX, offsetY[, width, height[, rotation]]])

Creates a default collider matching the size of the placeholder rectangle or the bounding box of the image.

Rotate the sprite towards a specific position

Alias for animation.changeFrame()

Set the speed and direction of the sprite. The action overwrites the current velocity. If direction is not supplied, the current direction is maintained. If direction is not supplied and there is no current velocity, the current rotation angle used for the direction.

Alias for setSpeed()

Sets the velocity vector.

Updates the sprite. Called automatically at the beginning of the draw cycle.