Constructor
new Medal(id, name, descriptionopt, iconopt, srcopt)
Create a medal and add 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
Example
// 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
icon
Properties| Type | Description |
|---|---|
| string | Icon for the medal |
- Source
id
Properties| Type | Description |
|---|---|
| number | The unique identifier of the medal |
- Source
image :HTMLImageElement|undefined
Type:
Properties- HTMLImageElement |
undefined
| Type | Description |
|---|---|
| HTMLImageElement | | Source image for the medal icon, if any |
- Source
name
Properties| Type | Description |
|---|---|
| string | Name of the medal |
- Source
unlocked
Properties| Type | Description |
|---|---|
| boolean | Is the medal unlocked? |
- Source
Methods
isLocal() → {boolean}
Whether the local save holds this medal, it is neither loaded nor written while a service like Newgrounds holds it
- Source
Returns:
- Type:
- boolean
render(hidePercentopt)
Render a medal
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
hidePercent | number | <optional> | 0 | How much to slide the medal off screen |
- Source
renderIcon(pos, size)
Render the icon for a medal
Parameters:
| Name | Type | Description |
|---|---|---|
pos | Vector2 | Screen space position |
size | number | Screen space size |
- Source
unlock() → {Promise.<boolean>}
Unlocks a medal if not already unlocked
- The promise is optional, for when a game wants to know the outcome
- Source
Returns:
- Whether the medal is unlocked, right away unless a service like Newgrounds has to confirm
- Type:
- Promise.<boolean>