# new Season(seasonData)
Parse a Season object from JSON.
Parameters:
| Name | Type | Description |
|---|---|---|
seasonData |
seasonData
|
Apex Legends season data |
Members
Array.<Playlist>
# readonly nullable currentLTMs
Array of currently-active limited time modes, or null if none found.
# readonly currentMaps
Gets an array of current maps from this instance's getMapsByDate method.
# readonly currentPlaylists
Gets an array of current playlists via this instance's getPlaylistsByDate method.
Array.<Playlist>
# readonly nullable currentTakeovers
Array of currently-active limited time modes which replace another playlist in the season, or null if none found.
Array.<Playlist>
# readonly nullable LTMs
Array of limited time modes for this season, or null if none found.
Array.<PlaylistItem>
# readonly nullable nextMaps
Gets an array containing the upcoming PlaylistItems for each
Playlist by calling the .nextMap method on each instance
(depending on playlist type, e.g. RotatingPlaylist#nextMap).
Takes into account whether a takeover LTM is about to end and will
attempt to replace this entry with the 'regular' mode map.
Array.<Playlist>
# readonly nullable takeovers
Array of limited time modes in this season which replace another mode, or null if none found.
Methods
# getMapsByDate(dateopt) → (nullable) {Array.<ScheduledPlaylistItem>}
Get an Array of maps active at a given date, or the current date if not provided. Returns null if outside of season date boundaries.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
date |
parseableDate
|
<optional> |
new Date() | the query date |
- To Do:
-
- should return null if no maps found.
an array of maps or null
Array.<ScheduledPlaylistItem>
# getPlaylistsByDate(date) → (nullable) {Array.<Playlist>}
Get an array of Playlist subclass instances active during the provided date, or the current date if not provided. Returns null if none found.
Parameters:
| Name | Type | Description |
|---|---|---|
date |
parseableDate
|
the query date |
# parsePlaylist(playlistData) → {SingleItemPlaylist|RotatingPlaylist|SplitPlaylist}
Take playlist data and parse into an instance of a Playlist subclass, determined by querying sections of the data.
Parameters:
| Name | Type | Description |
|---|---|---|
playlistData |
playlistData
|
data for this playlist |
- To Do:
-
- move into a private or static method