[Essentials Tutorial] Multiple Surf Themes

NonGlobalTypes={
     "Outdoor"=>[MetadataOutdoor,"b"],
     "ShowArea"=>[MetadataShowArea,"b"],
     "Bicycle"=>[MetadataBicycle,"b"],
     "BicycleAlways"=>[MetadataBicycleAlways,"b"],
     "HealingSpot"=>[MetadataHealingSpot,"uuu"],
     "Weather"=>[MetadataWeather,"eu",:PBFieldWeather],
     "MapPosition"=>[MetadataMapPosition,"uuu"],
     "DiveMap"=>[MetadataDiveMap,"u"],
     "DarkMap"=>[MetadataDarkMap,"b"],
     "SafariMap"=>[MetadataSafariMap,"b"],
     "SnapEdges"=>[MetadataSnapEdges,"b"],
     "Dungeon"=>[MetadataDungeon,"b"],
     "BattleBack"=>[MetadataBattleBack,"s"],
     "WildBattleBGM"=>[MetadataMapWildBattleBGM,"s"],
     "TrainerBattleBGM"=>[MetadataMapTrainerBattleBGM,"s"],
     "WildVictoryME"=>[MetadataMapWildVictoryME,"s"],
     "TrainerVictoryME"=>[MetadataMapTrainerVictoryME,"s"],
     "MapSize"=>[MetadataMapSize,"us"],
     [S-HIGHLIGHT]"SurfTheme"=>[MetadataSurfTheme,"s"],[/S-HIGHLIGHT]
  }

LOCALMAPS=[
   ["Outdoor",BooleanProperty,
        _INTL("If true, this map is an outdoor map and will be tinted according to time of day.")],
   ["ShowArea",BooleanProperty,
       _INTL("If true, the game will display the map's name upon entry.")],
   ["Bicycle",BooleanProperty,
       _INTL("If true, the bicycle can be used on this map.")],
   ["BicycleAlways",BooleanProperty,
       _INTL("If true, the bicycle will be mounted automatically on this map and cannot be dismounted.")],
   ["HealingSpot",MapCoordsProperty,
        _INTL("Map ID of this Pokemon Center's town, and X and Y coordinates of its entrance within that town.")],
   ["Weather",WeatherEffectProperty,
       _INTL("Weather conditions in effect for this map.")],
   ["MapPosition",RegionMapCoordsProperty,
       _INTL("Identifies the point on the regional map for this map.")],
   ["DiveMap",MapProperty,
       _INTL("Specifies the underwater layer of this map. Use only if this map has deep water.")],
   ["DarkMap",BooleanProperty,
       _INTL("If true, this map is dark and a circle of light appears around the player. Flash can be used to expand the circle.")],
   ["SafariMap",BooleanProperty,
       _INTL("If true, this map is part of the Safari Zone (both indoor and outdoor). Not to be used in the reception desk.")],
   ["SnapEdges",BooleanProperty,
       _INTL("If true, when the player goes near this map's edge, the game doesn't center the player as usual.")],
   ["Dungeon",BooleanProperty,
       _INTL("If true, this map has a randomly generated layout. See the wiki for more information.")],
   ["BattleBack",StringProperty,
       _INTL("PNG files named 'battlebgXXX', 'enemybaseXXX', 'playerbaseXXX' in Battlebacks folder, where XXX is this property's value.")],
   ["WildBattleBGM",BGMProperty,
       _INTL("Default BGM for wild Pokémon battles on this map.")],
   ["TrainerBattleBGM",BGMProperty,
       _INTL("Default BGM for trainer battles on this map.")],
   ["WildVictoryME",MEProperty,
       _INTL("Default ME played after winning a wild Pokémon battle on this map.")],
   ["TrainerVictoryME",MEProperty,
       _INTL("Default ME played after winning a Trainer battle on this map.")],
   ["MapSize",MapSizeProperty,
       _INTL("The width of the map in Town Map squares, and a string indicating which squares are part of this map.")],
[S-HIGHLIGHT]   ["SurfTheme",BGMProperty,
       _INTL("Default Surf theme on this map.")],[/S-HIGHLIGHT]
]

def pbGetWildBattleBGM(species)
  if $PokemonGlobal.nextBattleBGM
    return $PokemonGlobal.nextBattleBGM.clone
  end
  ret=nil
  if !ret && $game_map
    # Check map-specific metadata
    music=pbGetMetadata($game_map.map_id,MetadataMapWildBattleBGM)
    if music && music!=""
      ret=pbStringToAudioFile(music)
    end
  end
  if !ret
    # Check global metadata
    music=pbGetMetadata(0,MetadataWildBattleBGM)
    if music && music!=""
      ret=pbStringToAudioFile(music)
    end
  end
  ret=pbStringToAudioFile("002-Battle02") if !ret
  return ret
end

[S-HIGHLIGHT]def pbGetSurfTheme
  ret=nil
  if !ret && $game_map
    # Check map-specific metadata
    music=pbGetMetadata($game_map.map_id,MetadataSurfTheme)
    if music && music!=""
      ret=pbStringToAudioFile(music)
    end
  end
  if !ret
    # Check global metadata
    music=pbGetMetadata(0,MetadataSurfBGM)
    if music && music!=""
      ret=pbStringToAudioFile(music)
    end
  end
  ret=pbStringToAudioFile("002-Battle02") if !ret
  return ret
end[/S-HIGHLIGHT]

def pbGetWildVictoryME

def Kernel.pbSurf
  if $game_player.pbHasDependentEvents?
    return false
  end
  if $DEBUG ||
    (HIDDENMOVESCOUNTBADGES ? $Trainer.numbadges>=BADGEFORSURF : $Trainer.badges[BADGEFORSURF])
    movefinder=Kernel.pbCheckMove(:SURF)
    if $DEBUG || movefinder
      if Kernel.pbConfirmMessage(_INTL("The water is a deep blue...\nWould you like to surf on it?"))
        speciesname=!movefinder ? $Trainer.name : movefinder.name
        Kernel.pbMessage(_INTL("{1} used Surf!",speciesname))
        pbHiddenMoveAnimation(movefinder)
        [S-HIGHLIGHT]#surfbgm=pbGetMetadata(0,MetadataSurfBGM)
        surfbgm=pbGetSurfTheme[/S-HIGHLIGHT]
        pbCueBGM(surfbgm,0.5) if surfbgm
        pbStartSurfing()
        return true
      end
    end
  end
  return false
end

def pbAutoplayOnTransition
  [S-HIGHLIGHT]#surfbgm=pbGetMetadata($game_map.map_id,MetadataSurfTheme)
  surfbgm=pbGetSurfTheme[/S-HIGHLIGHT]
  if $PokemonGlobal.surfing && surfbgm
    pbBGMPlay(surfbgm)
  else
    $game_map.autoplayAsCue
  end
end

def pbAutoplayOnSave
  [S-HIGHLIGHT]#surfbgm=pbGetMetadata($game_map.map_id,MetadataSurfTheme)
  surfbgm=pbGetSurfTheme[/S-HIGHLIGHT]
  if $PokemonGlobal.surfing && surfbgm
    pbBGMPlay(surfbgm)
  else
    $game_map.autoplay
  end
end