Class

SplitPlaylist

SplitPlaylist(playlistData, seasonData)

An implementation for playlists which have two maps and change at a designated 'split time', e.g. Ranked Leagues.

Constructor

# new SplitPlaylist(playlistData, seasonData)

Create a split playlist from playlistData.

Parameters:
Name Type Description
playlistData playlistData

data for this playlist

seasonData seasonData

data for the parent season

View Source classes/SplitPlaylist.js, line 11

Extends

Members

Date

# baseTime Optional

The time to use as base for calculating rotation times. This is needed for some playlists as they appear to start at odd times that don't align with the season start, mode start, or even each other.

Overrides:

View Source classes/Playlist.js, line 64

ScheduledPlaylistItem

# readonly nullable currentMap

Gets the current map rotation, or null if none available (e.g. outside of date boundaries).

View Source classes/SplitPlaylist.js, line 61

Date

# endTime

The time at which this playlist ends.

Overrides:

View Source classes/Playlist.js, line 87

boolean

# LTM Optional

Whether this playlist is a Limited Time Mode.

Overrides:

View Source classes/Playlist.js, line 27

Array.<string>

# maps

Array of maps used in this playlist.

Overrides:

View Source classes/Playlist.js, line 95

string

# mode

The mode of the playlist (e.g. Play Apex, Ranked Leagues)

Overrides:

View Source classes/Playlist.js, line 25

ScheduledPlaylistItem

# readonly nullable nextMap

Gets the next map rotation, the first map rotation if called before the playlist startTime, or null if during the last rotation or after the playlist endTime.

View Source classes/SplitPlaylist.js, line 76

boolean

# ranked Optional

Whether this is a ranked playlist.

Overrides:

View Source classes/Playlist.js, line 55

string

# replaces Optional

The 'standard' playlist that a takeover LTM replaces.

Overrides:

View Source classes/Playlist.js, line 45

Array.<ScheduledPlaylistItem>

# rotations

Gets the map rotations available in this playlist. As the playlist will only ever have 2 maps, the values are hard-coded and can be accessed predictably using Array indexes.

View Source classes/SplitPlaylist.js, line 39

date

# splitTime

The time at which the playlist switches from the first map to the second.

View Source classes/SplitPlaylist.js, line 30

Date

# startTime

The time at which this playlist starts.

Overrides:

View Source classes/Playlist.js, line 79

boolean

# takeover Optional

Whether this playlist is a takeover-style limited time mode (i.e. that it replaces a 'regular' mode for its duration).

Overrides:

View Source classes/Playlist.js, line 36

Methods

# getMapByDate(dateopt) → (nullable) {ScheduledPlaylistItem}

Get the map rotation for a given date, or the current date if none provided, or null if outside of date boundaries.

Parameters:
Name Type Attributes Default Description
date parseableDate <optional>
new Date()

the date to query

View Source classes/SplitPlaylist.js, line 90

active map or null