Documentation GitHub npm

Class

ScheduledPlaylistItem

ScheduledPlaylistItem(itemData, playlist)

A PlaylistItem with a designated start and end time.

Constructor

# new ScheduledPlaylistItem(itemData, playlist)

Parameters:
Name Type Description
itemData object

object containing item data
mapName string

the name of the map
mapDuration number

the duration of the map in milliseconds
startTime Date

the time this map rotation starts
playlist Playlist

the parent playlist of this item

View Source classes/ScheduledPlaylistItem.js, line 9

Extends

Members

number

# duration

Returns the duration of this map rotation in milliseconds.

Overrides:

View Source classes/PlaylistItem.js, line 44

Date

# endTime

When this map rotation ends

View Source classes/ScheduledPlaylistItem.js, line 31

boolean

# LTM Optional

Whether this item is from a playlist which is an LTM. The property only exists when its value is true.

Overrides:

View Source classes/PlaylistItem.js, line 57

string

# map

Returns the name of the map for this item (e.g. King's Canyon).

Overrides:

View Source classes/PlaylistItem.js, line 38

string

# mode

Returns the mode of the Playlist to which this item belongs (e.g. Play Apex, Ranked Leagues)

Overrides:

View Source classes/PlaylistItem.js, line 32

boolean

# ranked Optional

Whether the Playlist this item is from is ranked. The property only exists when its value is true.

Overrides:

View Source classes/PlaylistItem.js, line 46

string

# replaces Optional

When the item's parent Playlist is a 'takeover LTM'-type playlist, this property returns the name of the playlist this item replaces. This property only exists if the parent playlist has the replaces property.

Overrides:

View Source classes/PlaylistItem.js, line 77

Date

# startTime

When this map rotation starts

View Source classes/ScheduledPlaylistItem.js, line 25

boolean

# takeover Optional

Whether the playlist this item belongs to is a takeover LTM. This property only exists when its value is true.

Overrides:

View Source classes/PlaylistItem.js, line 67

number

# readonly timeRemaining

The time until (or since the end of) this map rotation. Returns a negative value if the end of this rotation has already passed when called.

View Source classes/ScheduledPlaylistItem.js, line 42