Skip to content

Externals

BassMusic_Play

Triggers an event to start a new music theme. If the player has turned off the music in the menu, the theme will not be played.

1
func void BassMusic_Play(var string id)

Parameters

  • var string id
    Symbol name of the music theme (C_MUSICTHEME) to play

BassMusic_SetFullScriptControl

Set the "Full Script Control"

1
func void BassMusic_SetFullScriptControl(int enabled) {}

Parameters

  • var int enabled
    Boolean value if full script control should be enabled.

BassMusic_OnEndEvent

Set a callback function to be called when the music ends.

1
func void BassMusic_OnEndEvent(var func callback) {}

Parameters

  • var func callback
    Callback function to be called when the music ends with signature:
    func void callback();

BassMusic_OnTransitionEvent

Set a callback function to be called when the music is close to the end and transition starts.

1
func void BassMusic_OnTransitionEvent(var func callback) {}

Parameters

  • var func callback
    Callback function to be called when the music is close to the end and transition starts:
    func void callback(var float time_left_ms);

BassMusic_OnChangeEvent

Set a callback function to be called when the music changes.

1
func void BassMusic_OnChangeEvent(var func callback) {}

Parameters

  • var func callback
    Callback function to be called when the music changes with signature:
    func void callback();

BassMusic_Opt_TransitionTime

Set [Bass].TransitionTime ini setting.

1
func void BassMusic_Opt_TransitionTime(var float time) {}

Parameters

  • var float time
    The transition time in miliseconds

BassMusic_Opt_ForceDisableReverb

Set [Bass].ForceDisableReverb ini setting.

1
func void BassMusic_Opt_ForceDisableReverb(var int enabled) {}

Parameters

  • var int enabled
    If true, the reverb effect is globally disabled

BassMusic_Opt_ForceFadeTransition

Set [Bass].ForceFadeTransition ini setting.

1
func void BassMusic_Opt_ForceFadeTransition(var int enabled) {}

Parameters

  • var int enabled
    If true, the fade transition is globally enabled

BassMusic_AddMidiFile

Add a MIDI File to a theme.

1
func void BassMusic_AddMidiFile(var string theme, var string filter, var string midiFilename) {}

Parameters

  • var string theme
    Music theme name
  • var string filter
    Transition filter
  • var string midiFilename
    Filename of a MIDI file

BassMusic_AddTransitionTimePoint

Add a time point for Timing Transition.

1
func void BassMusic_AddTransitionTimePoint(var string theme, var string filter, var float start, var float duration, var int effect, var float nextStart, var float nextDuration, var int nextEffect) {}

Parameters

  • var string theme
    Music theme name
  • var string filter
    Transition filter
  • var float start
    Transition start in seconds
  • var float duration
    Transition duration in seconds
  • var int effect
    Effect ID (NONE = 0, CROSSFADE = 0)
  • var float nextStart
    Transition start in seconds (next song)
  • var float nextDuration
    Transition duration in seconds (next song)
  • var int nextEffect
    Effect ID (NONE = 0, CROSSFADE = 0)

BassMusic_AddJingle

Add a Jingle to a theme.

1
func void BassMusic_AddJingle(var string theme, var string filter, var string jingle, var float delay) {}

Parameters

  • var string theme
    Music theme name
  • var string filter
    Transition filter
  • var string jingle
    Filename of a jingle audio file
  • var float delay Delay in seconds before the jingle starts