Displays an animation.

In p5.game groups are collections of sprites with similar behavior. For example a group may contain all the sprites in the background or all the sprites that "kill" the player.

Groups are "extended" arrays and inherit all their properties e.g. group.length

Since groups contain only references, a sprite can be in multiple groups and deleting a group doesn't affect the sprites themselves.

Sprite.remove() will also remove the sprite from all the groups it belongs to.

A Sprite is the main building block of p5.game: an element able to store images or animations with a set of properties such as position and visibility.

A Sprite can have a collider that defines the active area to detect collisions or overlappings with other sprites and mouse interactions.

Sprites created using createSprite (the preferred way) are added to the allSprites group and given a depth value that puts it in front of all other sprites.

Once you create a sprite, you must then draw the sprite in the draw() function. See drawSprite() and drawSprites()

Alternatively, you can pass a width, height instead of an image as the first argument to create a placeholder sprite.

Displays a Sprite. To be typically used in the main draw function.

Displays a Group of sprites. If no parameter is specified, draws all sprites in the sketch. The drawing order is determined by the Sprite property "depth"

Returns all the sprites in the sketch as an array

Detects if a key is currently pressed Like p5 keyIsDown but accepts strings and codes

Detects if a key was pressed during the last cycle. It can be used to trigger events once, when a key is pressed or released. Example: Super Mario jumping.

Detects if a key was released during the last cycle. It can be used to trigger events once, when a key is pressed or released. Example: Spaceship shooting.

Loads an animation. To be typically used in the preload() function of the sketch.

An Animation object contains a series of images (p5.Image) that can be displayed sequentially.

All files must be png images. You must include the directory from the sketch root, and the extension .png

A sprite can have multiple labeled animations, see Sprite.addAnimation and Sprite.changeAnimation, however an animation can be used independently.

An animation can be created either by passing a series of file names, no matter how many or by passing the first and the last file name of a numbered sequence. p5.game will try to detect the sequence pattern.

For example if the given filenames are "data/file0001.png" and "data/file0005.png" the images "data/file0003.png" and "data/file0004.png" will be loaded as well.

Loads a Sprite Sheet. To be typically used in the preload() function of the sketch.

Returns a SpriteSheet istance which represents a sprite sheet and all it's frames. To be used with Animation, or static drawing single frames.

This is the first way to load a sprite sheet, given a width and height that will be used for every frame and the number of frames to cycle through. The sprite sheet must have a uniform grid with consistent rows and columns.

Alternative method of loading a spritesheet given an array of frame objects that define the position and dimensions of each frame. This is Flexible because you can use sprite sheets that don't have uniform rows and columns.

A JSON file containing the frame definitions might look like this:

[
  {"name":"player_walk01", "frame":{"x":0, "y": 0, "width": 70, "height": 94}},
  {"name":"player_walk02", "frame":{"x":71, "y": 0, "width": 72, "height": 94}},
  {"name":"player_walk03", "frame":{"x":142, "y": 0, "width": 71, "height": 94}}
]

Detects if a mouse button is currently down Combines mouseIsPressed and mouseButton of p5

Detects if a mouse button is currently up Combines mouseIsPressed and mouseButton of p5

Detects if a mouse button was pressed during the last cycle. It can be used to trigger events once, to be checked in the draw cycle

Detects if a mouse button was released during the last cycle. It can be used to trigger events once, to be checked in the draw cycle

Removes a Sprite from the sketch. The removed Sprite won't be drawn or updated anymore. Equivalent to Sprite.remove()

Updates all the sprites in the sketch (position, animation...) it's called automatically at every draw(). It can be paused by passing a parameter true or false; Note: it does not render the sprites.

Turns the quadTree on or off. A quadtree is a data structure used to optimize collision detection. It can improve performance when there is a large number of Sprites to be checked continuously for overlapping.

p5.game will create and update a quadtree automatically.