IsMusicPlaying

From GECK
Jump to: navigation, search


A function added by the JIP NVSE Plugin.

Description

Returns the playback state of the game's current background music:

0	Not Playing
1	Paused
2	Playing

The musicType argument may be either a Music Type form, a Media Location Controller form, or it may be entirely omitted.

  • If specified, the function will return the playback state of that particular music type.
  • If omitted, the function will return the state of the currently playing music (if any).

Syntax

[help]
(musicState:int) IsMusicPlaying musicType:form

Example

set iMusicState to IsMusicPlaying
set iMusicState to IsMusicPlaying DefaultExplore
set iMusicState to IsMusicPlaying musCtrlGnrcSubtleRural 

See Also