Header menu logo BaboonAPI

TrackLookup Module

Public hooks to look up registered tracks

Types

Type Description

SavedTrackScore

Highest rank & most recent 5 high scores for a track

Functions and values

Function or value Description

allTracks ()

Full Usage: allTracks ()

Parameters:
    () : unit

Returns: TromboneTrack list

Get a list of every track currently loaded

() : unit
Returns: TromboneTrack list

lookup trackref

Full Usage: lookup trackref

Parameters:
    trackref : string

Returns: TromboneTrack

Look up a track by trackref

trackref : string
Returns: TromboneTrack

lookupScore trackref

Full Usage: lookupScore trackref

Parameters:
    trackref : string

Returns: SavedTrackScore option None if there is no saved data for the trackref, Some otherwise.

Get the current high scores for a track.

trackref : string
Returns: SavedTrackScore option

None if there is no saved data for the trackref, Some otherwise.

reload ()

Full Usage: reload ()

Parameters:
    () : unit

Reload the list of tracks

() : unit

reloadAsync ()

Full Usage: reloadAsync ()

Parameters:
    () : unit

Returns: IEnumerator<YieldInstruction> A Unity coroutine that must be started using StartCoroutine.

Reload the list of tracks asynchronously.

() : unit
Returns: IEnumerator<YieldInstruction>

A Unity coroutine that must be started using StartCoroutine.

toTrackData track

Full Usage: toTrackData track

Parameters:
Returns: SingleTrackData

Convert a TromboneTrack into a SingleTrackData

track : TromboneTrack
Returns: SingleTrackData

tryLookup trackref

Full Usage: tryLookup trackref

Parameters:
    trackref : string

Returns: TromboneTrack option

Look up a track by trackref, returning None if the track doesn't exist.

trackref : string
Returns: TromboneTrack option

Type something to start searching.