Class Player

Defined in: Player.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	Player() A class to represent the player on the screen

Field Summary
Field Attributes	Field Name and Description
	fallMultiplyer The rate to fall at
	grounded True when the player is on the ground, false otherwise
	halfPI The constant or half PI
	jumpHangTime The amount of time to spend in the air when jumping
	jumpHeight The maximum height of the jump
	jumpSinWavePos The current position on the sine wave that defines the jump arc
	jumpSinWaveSpeed The speed to progress alone the sine wave that defines the jumping arc
	left True if the player is moving left, false otherwise
	level A reference to the level object
	right True if the player is moving right, false otherwise
	screenBorder The distance between the player and the edge of the screen
	speed the players running speed

Method Summary
Method Attributes	Method Name and Description
	keyDown(event) Called when a key is pressed
	keyUp(event) Called when a key is pressed
	startupPlayer(level) Initialises this object
	update(dt, context, xScroll, yScroll) Updates the object
	updateAnimation() Updates the current animation depending on the movement of the player.

Class Detail

Player()

A class to represent the player on the screen
Author: Matthew Casperson.

Field Detail

{Number} fallMultiplyer

The rate to fall at

{Boolean} grounded

True when the player is on the ground, false otherwise

{Number} halfPI

The constant or half PI

{Number} jumpHangTime

The amount of time to spend in the air when jumping

{Number} jumpHeight

The maximum height of the jump

{Number} jumpSinWavePos

The current position on the sine wave that defines the jump arc

{Number} jumpSinWaveSpeed

The speed to progress alone the sine wave that defines the jumping arc

{Boolean} left

True if the player is moving left, false otherwise

{Level} level

A reference to the level object

{Boolean} right

True if the player is moving right, false otherwise

{Number} screenBorder

The distance between the player and the edge of the screen

{Number} speed

the players running speed

Method Detail

keyDown(event)

Called when a key is pressed

Parameters:
event: Event Object

keyUp(event)

Called when a key is pressed

Parameters:
event: Event Object

startupPlayer(level)

Initialises this object

Parameters:
level

update(dt, context, xScroll, yScroll)

Updates the object

Parameters:
{Number} dt: The time since the last frame in seconds
{CanvasRenderingContext2D} context: The drawing context
{Number} xScroll: The global scrolling value of the x axis
{Number} yScroll: The global scrolling value of the y axis

updateAnimation()

Updates the current animation depending on the movement of the player. This accounts for the fact that both the left and right arrow keys can be pressed at the same time.

Classes

Class Player