Background for Skyrim SE

The MusicType Script

    The MusicType script is a part of Skyrim SE’s Papyrus scripting ecosystem. It is included with the base game.

    For this script, the Papyrus index knows about:

    • 2 functions


    Inheritance Tree

    No indexed scripts extend this script.

    Properties

    No properties found.

      Events

        No events found.

      Functions

      • voidfunctionAdd()Native

        Adds this music type to the music stack, causing it to start playing if it's the highest priority item. If the music type is flagged as "Plays One Selection", it will automatically be removed when it finishes, and a call to MusicType.Remove() will not be required. Otherwise it will play until removed, or until something else is added to the music stack.

        Caution that a known bug with this function is the MusicType can get baked into current saved games. Upon reloading a save, even if MusicType.Remove() was invoked previously, your MusicType will still play regardless if it has higher priority. This can be mitigated by setting conditions on individual music tracks, as well as creating a cleanup script which fires OnPlayerLoadGame() to remove any possible traces that may still be present. This bug still persists in SSE.

      • voidfunctionRemove()Native

        Removes this music type to the music stack, which may change the music playing if it was the highest priority item. Music types that are flagged as "Plays One Selection" do not have to be explicitly removed, as they will go away as soon as they finish playing their piece.

      Some data provided by the Skyrim Creation Kit Wiki. Licensed under the Creative Commons Attribution-ShareAlike license.