Global

Members

BGLoaded :boolean

Flag stating if the day time background image was loaded without error.
Type:
  • boolean
Source:

BGNightLoaded :boolean

Flag stating if the night time background image was loaded without error.
Type:
  • boolean
Source:

bgScrollSpeed :number

The number of pixels that the background moves every frame.
Type:
  • number
Source:

bgx :number

The current x position of the background.
Type:
  • number
Source:

endMode :number

End state for the gameMode variable.
Type:
  • number
Source:

fgScrollSpeed :number

The number of pixels that the foreground moves every frame.
Type:
  • number
Source:

fgx :number

The current x position of the foreground.
Type:
  • number
Source:

floorHeight :number

How far the floor is from the top of the window.
Type:
  • number
Source:

gameMode :number

Variable to keep track of the current game state. Can be values from 1 - 3 as defined by the mode variables 
startMode - 1
playMode  - 2
endMode   - 3
Type:
  • number
Source:

gameScore :number

Variable to store the current game score.
Type:
  • number
Source:

idle :Array.<p5.Image>

Array of idle sprite images for the ninja.
Type:
  • Array.<p5.Image>
Source:

jump :Array.<p5.Image>

Array of jumping sprite images for the ninja.
Type:
  • Array.<p5.Image>
Source:

loading :boolean

Flag to show if assets are still loading.
Type:
  • boolean
Source:

nightTime :boolean

Flag for if it is daytime of night time
Type:
  • boolean
Source:

ninja :Ninja

Ninja object.
Type:
Source:

ninjaLoadCounter :number

The number of ninja sprite images loaded without any errors.
Type:
  • number
Source:

obstacle :Obstacle

Obstacle object.
Type:
Source:

physicsHandler :intervalID

Handle for the physics loop callback.
Type:
  • intervalID
Source:

playMode :number

Play state for the gameMode variable.
Type:
  • number
Source:

run :Array.<p5.Image>

Array of running sprite images for the ninja.
Type:
  • Array.<p5.Image>
Source:

soundLoadCounter :number

Number of sound assets loaded without error.
Type:
  • number
Source:

sounds :Array.<p5.SoundFile>

Array of sounds that have loaded.
Type:
  • Array.<p5.SoundFile>
Source:

soundsLoaded :boolean

Flag stating if the sounds have loaded without error.
Type:
  • boolean
Source:

spikeImgs :Array.<p5.Image>

Array of spike obstacle images.
Type:
  • Array.<p5.Image>
Source:

spikeLoadCounter :number

The number of spike sprite images loaded without any errors.
Type:
  • number
Source:

startMode :number

Start state for the gameMode variable.
Type:
  • number
Source:

tileImgs :Array.<p5.Image>

Array of ground and water tile images.
Type:
  • Array.<p5.Image>
Source:

tileLoadCounter :number

The number of floor tile images loaded without any errors.
Type:
  • number
Source:

tilesLoaded :boolean

Flag stating if the floor tiles loaded without error.
Type:
  • boolean
Source:

totalAssets :number

The total number of expected assets.
Type:
  • number
Source:

totalNinjaAssets :number

Expected number of ninja sprite images to load.
Type:
  • number
Source:

totalSoundAssets :number

Number of expected sound assets.
Type:
  • number
Source:

totalSpikeAssets :number

Expected number of spike sprite images to load.
Type:
  • number
Source:

totalTileAssets :number

Number of expected floor tiles images to load.
Type:
  • number
Source:

Methods

draw()

p5.js draw function, used to draw the animation to the canvas depending on the current game mode.
Source:

endGame()

Ends a game by destroying the physics loop and switching the game mode to endMode
Source:

endScreen()

Draws an end screen on the canvas with the final score information.
Source:

gameLoop()

Draws the position of all the elements in the game. Adds 1 point to the game score for every frame of animation.
Source:

keyPressed()

p5.js keyPressed function used to control the ninja and also to switch game modes at the start screen and end screen. 
"w" - Jump
"S" - Drop
"K" - Kill
Source:

loadingAnimation()

Shows a loading bar whilst all of the game assets are being loaded.
Source:

loadNinjaSprites()

Loads all ninja sprite images.
Source:

loadSounds()

Loads sounds for ninja jumping. Contains internal functions for success and error handling.
Source:

loadSpikes()

Loads spikes sprite image. Contains internal functions for success and error handling.
Source:

loadSprite()

Loads single ninja sprite image. Contains internal functions for success and error handling.
Source:

loadTiles()

Loads all tile sprite image. This includes the background tile. Contains internal functions for success and error handling.
Source:

loadTileSprite()

Loads single tile sprite image. Contains internal functions for success and error handling.
Source:

mousePressed()

p5.js mousePressed function used to control the ninja and also to switch game modes at the start screen and end screen.
Source:

physicsUpdate()

The physics update function is called once every 20ms and calculates the game physics on the ninja and obstacle. It will also check for collisions with the ninja object.
Source:

resetGame()

Resets the game mode, game score, ninja and obstacles back to the beginning of the game
Source:

setup()

p5.js setup function, used to create a canvas and instantiate the ninja and obstacle objects. Also loads the various assets needed for drawing the game.
Source:

startGame()

Starts a game by initialising the physics loop and switching the game mode to playMode
Source:

startScreen()

Draws a start screen on the canvas with information about key controls for the ninja character.
Source:

windowResized()

p5.js windowResized function, used to update the size of the canvas when the window is adjusted.
Source:

Documentation generated by JSDoc 3.6.3 on Sun Jun 05 2022 20:34:43 GMT+0100 (BST)