Class: Medal

Constructor#

new Medal(id, name, descriptionopt, iconopt, srcopt)#

Create a medal object and adds it to the list of medals

Parameters:

Name	Type	Attributes	Default	Description
`id`	Number			The unique identifier of the medal
`name`	String			Name of the medal
`description`	String	<optional>		Description of the medal
`icon`	String	<optional>	🏆	Icon for the medal
`src`	String	<optional>		Image location for the medal

Source: engineMedals.js, line 82

Example

CODE

 // create a medal
const medal_example = new Medal(0, 'Example Medal', 'More info about the medal goes here.', '🎖️');
 
// initialize medals
medalsInit('Example Game');
 
// unlock the medal
medal_example.unlock();

Members#

description#

Properties

Type	Description
String	Description of the medal

Source: engineMedals.js, line 102

icon#

Properties

Type	Description
String	Icon for the medal

Source: engineMedals.js, line 105

id#

Properties

Type	Description
Number	The unique identifier of the medal

Source: engineMedals.js, line 96

name#

Properties

Type	Description
String	Name of the medal

Source: engineMedals.js, line 99

unlocked#

Properties

Type	Description
Boolean	Is the medal unlocked?

Source: engineMedals.js, line 108

Methods#

render(hidePercentopt)#

Render a medal

Parameters:

Name	Type	Attributes	Default	Description
`hidePercent`	Number	<optional>	0	How much to slide the medal off screen

Source: engineMedals.js, line 133

renderIcon(pos, sizeopt)#

Render the icon for a medal

Parameters:

Name	Type	Attributes	Default	Description
`pos`	Vector2			Screen space position
`size`	Number	<optional>	medalDisplayIconSize	Screen space size

Source: engineMedals.js, line 164

unlock()#

Unlocks a medal if not already unlocked

Source: engineMedals.js, line 119

	// create a medal
	const medal_example = new Medal(0, 'Example Medal', 'More info about the medal goes here.', '🎖️');

	// initialize medals
	medalsInit('Example Game');

	// unlock the medal
	medal_example.unlock();