SIMPLE QUEST SYSTEM + UI 1.0.1

[derFischae]

SIMPLE QUEST SYSTEM + UI 1.0.1

Use https://www.pokecommunity.com/showthread.php?p=10371854#post10371854 for Pokemon Essentials V19

Now, it is UPDATED FOR POKEMON ESSENTIALS 17.2 and 18.1. There are some bug fixes and I included the integration to pause menu.

for managing quests in your fangame. This script is based on SIMPLE QUEST SYSTEM + UI 1.0 by mej 71, which was a fairly comprehensive, yet easy to use system + UI

Features, Installation and How to Use is as in the original version SIMPLE QUEST SYSTEM + UI 1.0. So I just cite mej 71:

Features

• Support for up to 10 stages per quest
• Complex rewards
• Very detailed compiler errors, tells you exactly what you've messed up
• Doesn't save quest data for player (similar to how other objects are handled in Essentials, non-specific data is stored in a separate data file so that quest info is updated for old saves)
• Plug and play
• Won't break old save files by adding this script
• Easy to edit and create new quests

Installation

1. Download View attachment quests.zip and unzip.
2. Add quests.txt to your PBS folder.
   
   Spoiler:

   
   [1]
   Name="I wanna be the best"
   Stage1="Go do a thing at your house"
   Stage2="Do somethign else"
   Reward="$Trainer.money+=200"
   RewardDescription="A description 4"
   StageLocation1="nil"
   StageLocation2="nil"
   QuestDescription="This is a really good quest. This is also a really long description. What, an even longer description? How long will this go? This is a really good quest. This is also a really long description. What, an even longer description? How long will this go? This is a really good quest. This is also a really long description. What, an even longer description? How long will this go?"
   CompletedMessage="You completed this quest"
   FailedMessage="You failed this quest"
   [2]
   Name="Test2"
   Stage1="Go do a thing at your house"
   Stage2="Do somethign else"
   Reward="$Trainer.money+=200"
   RewardDescription="A description 4"
   StageLocation1="nil"
   StageLocation2="nil"
   QuestDescription="This is a really good quest?"
   CompletedMessage="You completed this quest"
   FailedMessage="You failed this quest"
   [3]
   Name="Test3"
   Stage1="Go do a thing at your house"
   Stage2="Do somethign else"
   Reward="$Trainer.money+=200"
   RewardDescription="A description 4"
   StageLocation1="nil"
   StageLocation2="nil"
   QuestDescription="This is a quest."
   CompletedMessage="You completed this quest"
   FailedMessage="You failed this quest"
   [4]
   Name="Test4"
   Stage1="Go do a thing at your house"
   Stage2="Do somethign else"
   Reward="$Trainer.money+=200"
   RewardDescription="A description 4"
   StageLocation1="nil"
   StageLocation2="nil"
   QuestDescription="This is a quest."
   CompletedMessage="You completed this quest"
   FailedMessage="You failed this quest"
   
   
   
3. Add the 'Quest UI' folder to Graphics/Pictures (be sure to include the folder itself, not just the contents)
   
4. ONLY FOR POKEMON ESSENTIALS 18 AND 18.1: Create a new script section (denoted by "Compiling") right above "Main". Then cut and paste the first line "pbCompiler" from the script section "Main" into "Complining".
5. Add the following code into a new script section (called "Quest UI") above "Main" but below "Compiler" for Pokemon Essentials v17.2 or "Compiling" for Pokemon Essentials v18/18.1 respectively.
   FOR POKEMON ESSENTIALS 17.2
   
   Spoiler:

   
   

   ##########################################################################
   #                   SIMPLE QUEST SYSTEM + UI 1.0
   #                           by mej 71
   #
   # updated for pokemon essentials 17.2, bug fixes
   # and integration to pause menu by derFischae
   ##########################################################################
   =begin
   This is a fairly comprehensive, yet easy to use system + UI
   for managing quests in your fangame
   
   Features
       Support for up to 10 stages per quest
       Complex rewards
       Very detailed compiler errors, tells you exactly what you've messed up
       Doesn't save quest data for player (similar to how other objects are handled in Essentials, non-specific data is stored in a separate data file so that quest info is updated for old saves)
       Plug and play
       Won't break old save files by adding this script
       Easy to edit and create new quests
   
   Installation:
   Add quests.txt to your PBS folder
   Add the 'Quest UI' folder to Graphics/Pictures (be sure to include the folder itself, not just the contents)
   Add this text from questScript.txt into a new section above the Main but below the Compiler section
   And that's all there is to the installation
   
   How to Use
   Start of a new game is not required,
   should integrate into old saves files
   
   There's a few methods you will need to know to use the quest system
   (you will activate/complete/fail quests within your events,
   only you know in which context to do so)
   Code:
       activateQuest(id)
       completeQuest(id)
       failQuest(id)
       advanceQuestToStage(questID, stageNum)
   In all of these, 'id' and 'questID' refer to the ID of the desired quest,
   which is defined in quests.txt, the file you added to your PBS folder.
   The name of the quest can also be used in as the 'id' for these methods,
   since quest names are unique.
   The 'stageNum' refers to the desired stage number of that quest.
   Be sure the id you input exists,
   as there is currently no check against it
   
   Editing the Quest PBS file:
   There's only 8 types of lines in the PBS that you need to know
       Name - This is the name of the quest that will be displayed. Names must be unique (two quests cannot share a name)
       Stage1 - This is the description of the current task of the quests. Each quest can have up to 10 stages (so Stage2, Stage9, etc are also valid). Stages must be listed in order, no skipping numbers.
       Reward - This is the reward given to the player upon completion. When completion is triggered, it will read the string assigned and evaluate it as code. So if you make your reward "Kernel.pbMessage('Hello')", upon completion it will display a message saying "Hello". This reward is fairly simple, but keep in mind any type of code can be run here, so you can give items, set variables, or pretty much anything else you can code. Note that this code is not tested, so test all your rewards to ensure you didn't make errors. (Pro tip: semi-colons can be used to separate multiple instructions in a single line of code)
       RewardDescription - A description of the reward, so they player may determine whether or not to pursue
       QuestDescription - A description of the quest
       StageLocation1 - Same as with Stage1, there are up to 10 locations supported. This tells the player where to go for the next task. Can either be the desired map name or map id. These are checked upon compile time to ensure the map exists. "nil" can be used if you don't want to specify a map
       CompleteMessage - The "Result" description displayed in the UI for a completed quest.
       FailedMessage - The "Result" description displayed in the UI for a failed quest.
   =end
   
   #========================================================
   #This class holds the information for an individual quest
   #========================================================
   class Quest
     attr_reader   :id
     attr_reader   :stage
   
     def stage=(value)
       if value>$quest_data.getMaxStagesForQuest(@id)
         value = $quest_data.getMaxStagesForQuest(@id)
       end
       @stage = value
     end
     
     def initialize(id)
       @id         = id
       @stage      = 1
     end
   end
   
   #========================================================
   #This class holds all the trainers quests
   #========================================================
   class Player_Quests
     attr_accessor :active_quests
     attr_accessor :completed_quests
     attr_accessor :failed_quests
     attr_accessor :selected_quest_id
     
     def initialize
       @active_quests =[]
       @completed_quests = []
       @failed_quests = []
       @selected_quest_id = 0
     end
     
     #questID can either be the internal ID number, or the quest name
     def activateQuest(questID)
       if questID.is_a?(String)
         questID = $quest_data.getIDFromName(questID)
       end
       for i in 0...@active_quests.length
         if @active_quests[i].id==questID
           Kernel.pbMessage("You have already started this quest")
           return
         end
       end
       for i in 0...@completed_quests.length
         if @completed_quests[i].id==questID
           Kernel.pbMessage("You have already complete this quest")
           return
         end
       end
       for i in 0...@failed_quests.length
         if @failed_quests[i].id==questID
           Kernel.pbMessage("You have already failed this quest")
           return
         end
       end
       @active_quests.push(Quest.new(questID))
     end
     
     def failQuest(questID)
       if questID.is_a?(String)
         questID = $quest_data.getIDFromName(questID)
       end
       found = false
       for i in 0...@completed_quests.length
         if @completed_quests[i].id==questID
           Kernel.pbMessage("You have already complete this quest")
           return
         end
       end
       for i in 0...@failed_quests.length
         if @failed_quests[i].id==questID
           Kernel.pbMessage("You have already failed this quest")
           return
         end
       end 
       for i in 0...@active_quests.length
          if @active_quests[i].id==questID
            @failed_quests.push(@active_quests[i])
            @active_quests.delete_at(i)
            found=true
            break
          end
       end
       if !found
         @failed_quests.push(Quest.new(questID))
       end
     end
     
     def completeQuest(questID)
       if questID.is_a?(String)
         questID = $quest_data.getIDFromName(questID)
       end
       found = false
       for i in 0...@completed_quests.length
         if @completed_quests[i].id==questID
           Kernel.pbMessage("You have already complete this quest")
           return
         end
       end
       for i in 0...@failed_quests.length
         if @failed_quests[i].id==questID
           Kernel.pbMessage("You have already failed this quest")
           return
         end
       end  
       for i in 0...@active_quests.length
          if @active_quests[i].id==questID
            @completed_quests.push(@active_quests[i])
            @active_quests.delete_at(i)
            found = true
            break
          end
       end
       if !found
         @completed_quests.push(Quest.new(questID))
       end
       rewardString = $quest_data.getQuestReward(questID)
       eval(rewardString)
     end
     
     def advanceQuestToStage(questID,stageNum)
       if questID.is_a?(String)
         questID = $quest_data.getIDFromName(questID)
       end
       found = false
       for i in 0...@active_quests.length
          if @active_quests[i].id==questID
            @active_quests[i].stage=stageNum
            found = true
          end
          return if found
       end
       if !found
         quest = Quest.new(questID)
         quest.stage = stageNum
         @active_quests.push(quest)
       end
     end
   end
   
   class PokemonGlobalMetadata  
     def quests
       @quests = Player_Quests.new if !@quests
       return @quests
     end
     
     alias quest_init initialize
     def initialize
       quest_init
       @quests = Player_Quests.new
     end
   end
   
   def activateQuest(id)
     return if !$PokemonGlobal
     $PokemonGlobal.quests.activateQuest(id)
   end
   
   def completeQuest(id)
     return if !$PokemonGlobal
     $PokemonGlobal.quests.completeQuest(id)
   end
   
   def failQuest(id)
     return if !$PokemonGlobal
     $PokemonGlobal.quests.failQuest(id)
   end
   
   def advanceQuestToStage(questID,stageNum)
     return if !$PokemonGlobal
     $PokemonGlobal.quests.advanceQuestToStage(questID,stageNum)
   end
   
   QUEST_FILE_NAME = "quests.txt"  #the name of the file to read from
   
   #========================================================
   #a module use during compilation of the quest file
   #========================================================
   module QuestsData
     NeededInfo={
        "Name"=>[1,"s"],
        "Stage1"=>[2,"s"],
        "Stage2"=>[3,"s"],
        "Stage3"=>[4,"s"],
        "Stage4"=>[5,"s"],
        "Stage5"=>[6,"s"],
        "Stage6"=>[7,"s"],
        "Stage7"=>[8,"s"],
        "Stage8"=>[9,"s"],
        "Stage9"=>[10,"s"],
        "Stage10"=>[11,"s"],
        "Reward"=>[12,"s"],
        "RewardDescription"=>[13,"s"],
        "QuestDescription"=>[14,"s"],
        "StageLocation1" => [15,"v|s"],
        "StageLocation2" => [16,"v|s"],
        "StageLocation3" => [17,"v|s"],
        "StageLocation4" => [18,"v|s"],
        "StageLocation5" => [19,"v|s"],
        "StageLocation6" => [20,"v|s"],
        "StageLocation7" => [21,"v|s"],
        "StageLocation8" => [22,"v|s"],
        "StageLocation9" => [23,"v|s"],
        "StageLocation10" => [24,"v|s"],
        "CompletedMessage"=>[25,"s"],
        "FailedMessage"=>[26,"s"],
     }  
   end
   
   #========================================================
   #Pseudo class to read quest info from
   #========================================================
   class QuestInfo
     attr_reader :id
     attr_reader :name
     attr_reader :stages
     attr_reader :rewardString
     attr_reader :rewardDesc
     attr_reader :questDesc
     attr_reader :locations
     attr_reader :completedMessage
     attr_reader :failedMessage
     
     def initialize(id,questName,stages,rewardString,rewardDesc,
                     questDesc,locations,completedMessage,failedMessage)
       @id = id
       @name = questName
       @stages = stages
       @rewardString = rewardString
       @rewardDesc = rewardDesc
       @questDesc = questDesc
       @locations = locations
       @completedMessage = completedMessage
       @failedMessage = failedMessage
     end
   end
   
   #=====================================================================
   #This class loads/reads all data for all quests.  Updates at the start
   #of every game session will use this class to determine their values,
   #and this is used for deciding updates/rewards, etc
   #=====================================================================
   class Game_Quests
     def initialize
       needCompile = false
       latestdatatime = 0
       latesttexttime = 0
       if !safeExists?("Data/Quests.rxdata")
         needCompile = true
       else
           File.open("Data/Quests.rxdata"){|file|
                  latestdatatime=[latestdatatime,file.mtime.to_i].max
           }
           File.open("PBS/#{QUEST_FILE_NAME}"){|file|
                latesttexttime=[latesttexttime,file.mtime.to_i].max
           }
           needCompile=true if latesttexttime>=latestdatatime
           needCompile=true if Input.press?(Input::CTRL)
       end
       if $DEBUG && safeExists?("PBS/#{QUEST_FILE_NAME}") && needCompile
         compileAllQuests
       else
         begin
           @all_quests = load_data("Data/Quests.rxdata")
         rescue
           @all_quests = []
           Kernel.pbMessage("No quests data found")
         end
       end    
     end
     
     def compileAllQuests
       #names and IDs must be unique
       checkQuestIDs=[]
       checkQuestNames=[]
       @all_quests = []
       currentQuest = 0
       name = ""
       stages = []
       rewardString = ""
       rewardDesc = ""
       questDesc = ""
       completedMessage = ""
       failedMessage = ""
       locations = []
       lineCount = 0
       #check order of stages
       curStage = 0
       curLocation = 0
       pbCompilerEachCommentedLine("PBS/"+QUEST_FILE_NAME) {|line,lineno|
        lineCount+=1
        if line[/^\s*\[\s*(\d+)\s*\]\s*$/]
          if currentQuest>0
            if stages.length==0
              raise _INTL("Expected at least one stage for quest {1}\r\n{2}",currentQuest,FileLineData.linereport)
            end
            if locations.length!=stages.length
              raise _INTL("Expected the number of locations to match the number of stages for quest {1}\r\n{2}",currentQuest,FileLineData.linereport)
            end
            if questDesc.nil? || questDesc==""
              raise _INTL("Expected a quest description for quest {1}\r\n{2}",currentQuest,FileLineData.linereport)
            end
            if rewardString.nil? || rewardString==""
              raise _INTL("Expected a reward for quest {1}\r\n{2}",currentQuest,FileLineData.linereport)
            end
            if rewardDesc.nil? || rewardDesc==""
              raise _INTL("Expected a reward description for quest {1}\r\n{2}",currentQuest,FileLineData.linereport)
            end
            if completedMessage.nil? || completedMessage==""
              raise _INTL("Expected a completed message for quest {1}\r\n{2}",currentQuest,FileLineData.linereport)
            end
            if failedMessage.nil? || failedMessage==""
              raise _INTL("Expected a failed message for quest {1}\r\n{2}",currentQuest,FileLineData.linereport)
            end
            @all_quests.push(QuestInfo.new(currentQuest,name,stages,rewardString,rewardDesc,
                            questDesc,locations,completedMessage,failedMessage))
            curStage = 0
            curLocation = 0
            name = ""
            stages = []
            locations = []
            rewardString = ""
            rewardDesc = ""
            questDesc = ""
            completedMessage = ""
            failedMessage = ""
          end
          sectionname=$~[1]
          if checkQuestIDs.include?(sectionname.to_i)
              raise _INTL("Quest numbers must be unique! {1} already used\r\n{2}",sectionname,FileLineData.linereport)
          end
          currentQuest=sectionname.to_i
          checkQuestIDs.push(currentQuest)
        else
          if currentQuest==0
            raise _INTL("Expected a section at the beginning of the file\r\n{1}",FileLineData.linereport)
          end
          if !line[/^\s*(\w+)\s*=\s*(.*)$/]
            raise _INTL("Bad line syntax (expected syntax like XXX=YYY)\r\n{1}",FileLineData.linereport)
          end
          matchData=$~
          schema=nil
          FileLineData.setSection(currentQuest,matchData[1],matchData[2])
          schema=QuestsData::NeededInfo[matchData[1]]
          schemaValues = schema[1]
          if schema
            schemaValues = schema[1].split('|')
          end
          if schema
            for i in 0...schemaValues.length
              schema[1] = schemaValues[i]
              record=pbGetCsvRecord(matchData[2],lineno,schema) rescue next
              case schema
              when QuestsData::NeededInfo["Name"]
                if checkQuestNames.include?(record)
                    raise _INTL("Quest names must be unique! {1} already used\r\n{2}",record,FileLineData.linereport)
                end
                name = record
                checkQuestNames.push(name)
                break
              when QuestsData::NeededInfo["Reward"]
                rewardString = record
                break
              when QuestsData::NeededInfo["RewardDescription"]
                rewardDesc = record
                break
              when QuestsData::NeededInfo["QuestDescription"]
                questDesc = record           
                break
              when QuestsData::NeededInfo["CompletedMessage"]
                completedMessage = record
                break
              when QuestsData::NeededInfo["FailedMessage"]
                failedMessage = record
                break
              else
                if matchData[1].include?("StageLocation")
                  if ((matchData[1][/\d+/]).to_i)!=curLocation+1
                    raise _INTL("Locations need to be in order.  Expecting location {1}\r\n{2}",curLocation+1,FileLineData.linereport)
                  end
                  if record.is_a?(String) && record.downcase=="nil"
                    curLocation+=1
                    locations.push(record)
                    break
                  elsif record !~ /\D/ #only numbers
                    mapname = pbGetMessage(MessageTypes::MapNames,record.to_i) rescue nil
                    if mapname.nil?
                      raise _INTL("Invalid map id for quest {1}, at stage {2}",sectionname,curLocation)
                    end
                    curLocation+=1
                    locations.push(nil)
                    break
                  else
                    mapid = MessageTypes.getFromMapHashValue(MessageTypes::MapNames,record)
                    if mapid.nil?
                      raise _INTL("Invalid map id for quest {1}, at stage {2}",sectionname,curLocation)
                    end
                    curLocation+=1
                    locations.push(mapid)
                    break
                  end
                elsif matchData[1].include?("Stage")
                  if ((matchData[1][/\d+/]).to_i)!=curStage+1
                    raise _INTL("Stages need to be in order.  Expecting stage {1}\r\n{2}",curStage+1,FileLineData.linereport)
                  end
                  curStage+=1
                  stages.push(record)
                  break
                else
                  raise _INTL("Unexpected field {1} for quest {2}",matchData[1],sectionname)
                end
              end
             end
          end
        end
       }
       if stages.length==0
         raise _INTL("Expected at least one stage for quest {1}\r\n{2}",currentQuest,FileLineData.linereport)
       end
       if locations.length!=stages.length
         raise _INTL("Expected the number of locations to match the number of stages for quest {1}\r\n{2}",currentQuest,FileLineData.linereport)
       end
       if questDesc.nil? || questDesc==""
         raise _INTL("Expected a quest description for quest {1}\r\n{2}",currentQuest,FileLineData.linereport)
       end
       if rewardString.nil? || rewardString==""
         raise _INTL("Expected a reward for quest {1}\r\n{2}",currentQuest,FileLineData.linereport)
       end
       if rewardDesc.nil? || rewardDesc==""
         raise _INTL("Expected a reward description for quest {1}\r\n{2}",currentQuest,FileLineData.linereport)
       end
       if completedMessage.nil? || completedMessage==""
         raise _INTL("Expected a completed message for quest {1}\r\n{2}",currentQuest,FileLineData.linereport)
       end
       if failedMessage.nil? || failedMessage==""
         raise _INTL("Expected a failed message for quest {1}\r\n{2}",currentQuest,FileLineData.linereport)
       end
       @all_quests.push(QuestInfo.new(currentQuest,name,stages,rewardString,
         rewardDesc,questDesc,locations,completedMessage,failedMessage)) if lineCount>0
       save_data(@all_quests,"Data/Quests.rxdata")
     end
     
     def nameAllQuests
       for i in 0...@all_quests.length
         Kernel.pbMessage("#{@all_quests[i].id}")
         Kernel.pbMessage("#{@all_quests[i].name}")
         for j in 0...@all_quests[i].stages.length
           Kernel.pbMessage("#{@all_quests[i].stages[j]}")
         end
         Kernel.pbMessage("#{@all_quests[i].rewardString}")
         Kernel.pbMessage("#{@all_quests[i].rewardDesc}")
         Kernel.pbMessage("#{@all_quests[i].questDesc}")
       end
     end
     
     def getIDFromName(name)
       for i in 0...@all_quests.length
         return @all_quests[i].id if @all_quests[i].name==name
       end
     end
     
     def getNameFromID(id)
       for i in 0...@all_quests.length
         return @all_quests[i].name if @all_quests[i].id==id
       end
     end
     
     def getQuestStages(questID)
       if questID.is_a?(String)
         questID = getIDFromName(questID)
       end
       for i in 0...@all_quests.length
         return @all_quests[i].stages if @all_quests[i].id==questID
       end
     end
     
     def getQuestReward(questID)
       if questID.is_a?(String)
         questID = getIDFromName(questID)
       end
       for i in 0...@all_quests.length
         return @all_quests[i].rewardString if @all_quests[i].id==questID
       end
     end
     
     def getQuestRewardDescription(questID)
       if questID.is_a?(String)
         questID = getIDFromName(questID)
       end
       for i in 0...@all_quests.length
         return @all_quests[i].rewardDesc if @all_quests[i].id==questID
       end
     end
     
     def getQuestDescription(questID)
       if questID.is_a?(String)
         questID = getIDFromName(questID)
       end
       for i in 0...@all_quests.length
         return @all_quests[i].questDesc if @all_quests[i].id==questID
       end
     end  
     
     def getStageLocation(questID,stage)
       if questID.is_a?(String)
         questID = getIDFromName(questID)
       end
       for i in 0...@all_quests.length
         return @all_quests[i].locations[stage-1] if @all_quests[i].id==questID
       end
     end  
     
     def getMaxStagesForQuest(questID)
       if questID.is_a?(String)
         questID = getIDFromName(questID)
       end
       quests = getQuestStages(questID)
       return quests.length
     end
     
     def getCompletedMessage(questID)
       if questID.is_a?(String)
         questID = getIDFromName(questID)
       end
       for i in 0...@all_quests.length
         return @all_quests[i].completedMessage if @all_quests[i].id==questID
       end
     end 
     
     def getFailedMessage(questID)
       if questID.is_a?(String)
         questID = getIDFromName(questID)
       end
       for i in 0...@all_quests.length
         return @all_quests[i].failedMessage if @all_quests[i].id==questID
       end
     end 
   end
   
   #========================================================
   #modify messages to check for a map name among the maps
   #========================================================
   class Messages
     def getFromMapHashValue(type,key)
       delayedLoad
       return nil if !@messages
       return nil if !@messages[0]
       return nil if !@messages[0][type] && !@messages[0][0]
       key.sub!("e^","é")
       id=Messages.stringToKey(key)
       if @messages[type] && @messages[type].include?(id)
           return @messages[type].index(id)
       elsif @messages[0] && @messages[0].include?(id)
         return @messages[0].index(id)
       end
       return nil
     end
   end
   
   module MessageTypes
     def self.getFromMapHashValue(type,key)
       @@messages.getFromMapHashValue(type,key)
     end
   end
   
   $quest_data = Game_Quests.new
   #$quest_data.nameAllQuests
   
   QUEST_GRAPHICS_PATH = "Graphics/Pictures/Quest UI/"
   
   class QuestScene 
     @@viewingActive = 0
     @@viewingComplete = 0
     @@viewingFailed  = 0
     
     def update
       pbUpdateSpriteHash(@sprites)
     end
     
     def pbStartScene
       @yOffsetInfo=0
       @yOffsetList=0
       @curNumLines=0
       @sprites={} 
       @viewport=Viewport.new(0,0,Graphics.width,Graphics.height)
       @viewport.z=99999
       @viewport_text=Viewport.new(0,0,Graphics.width,Graphics.height)
       @viewport_text.z=99999+1
       @sprites["background"]=IconSprite.new(0,0,@viewport)
       @sprites["background"].setBitmap(QUEST_GRAPHICS_PATH+"quest_bg")
       @sprites["background"].zoom_x = Graphics.width/(@sprites["background"].bitmap.width)
       @sprites["background"].zoom_y = Graphics.height/(@sprites["background"].bitmap.height)
       @sprites["overlay"]=BitmapSprite.new(Graphics.width,Graphics.height,@viewport)
       @sprites["sections_text_overlay"]=BitmapSprite.new(Graphics.width,Graphics.height,@viewport_text)
       @sprites["quests_list_overlay"]=BitmapSprite.new(Graphics.width,Graphics.height*4/5,@viewport_text)
       @sprites["quests_list_overlay"].x=5
       @sprites["quests_list_overlay"].y=35
       @sprites["quest_info_overlay"]=BitmapSprite.new(Graphics.width,Graphics.height*4/5-8,@viewport_text)
       @sprites["quest_info_overlay"].y=38
       @sprites["quest_info_overlay"].x=202
       @sprites["navigation_info_overlay"]=BitmapSprite.new(Graphics.width,Graphics.height,@viewport_text)
       pbSetSmallFont(@sprites["overlay"].bitmap)
       pbSetSmallFont(@sprites["sections_text_overlay"].bitmap)
       pbSetSmallFont(@sprites["quests_list_overlay"].bitmap)
       pbSetSmallFont(@sprites["quest_info_overlay"].bitmap)
       pbSetSmallFont(@sprites["navigation_info_overlay"].bitmap)
       pbDrawSections
       pbDrawNavigationInfo
     end
     
     def pbDrawNavigationInfo
       overlay=@sprites["navigation_info_overlay"].bitmap
       overlay.clear
       @sprites["navigation_info_overlay"].bitmap.font.size=20
       baseColor=Color.new(72,72,72)
       shadowColor=Color.new(160,160,160)
       textPositions = [
         ["Arrows - Change Quest/Section",2,Graphics.height-40,0,baseColor,shadowColor],
         ["A,S - Scroll Info",Graphics.width-235,Graphics.height-40,0,baseColor,shadowColor],
         ["X - Exit",Graphics.width-60,Graphics.height-40,0,baseColor,shadowColor],
       ]
       pbDrawTextPositions(overlay,textPositions)
     end
   
     def pbDrawSections
       @activeQuests=$PokemonGlobal.quests.active_quests
       @completedQuests=$PokemonGlobal.quests.completed_quests
       @failedQuests=$PokemonGlobal.quests.failed_quests
       @sections=[]
       @sections.push([0,_INTL("Active")]) #if @activeQuests.length>0
       @sections.push([1,_INTL("Completed")]) #if @completedQuests.length>0
       @sections.push([2,_INTL("Failed")]) #if @failedQuests.length>0
       @@viewingActive = @activeQuests[0].id if @activeQuests!=[] && @@viewingActive<=0
       @@viewingComplete = @completedQuests[0].id if @completedQuests!=[] && @@viewingComplete<=0
       @@viewingFailed  = @failedQuests[0].id if @failedQuests!=[] && @@viewingFailed<=0
       baseColor=Color.new(72,72,72)
       selectedColor=Color.new(0,0,139)
       shadowColor=Color.new(160,160,160)
       selectedShadowColor=Color.new(160,160,160)
       bitmap = @sprites["sections_text_overlay"].bitmap
       bitmap.clear
       textPositions=[]
       for i in [email protected]
         @sprites["section_icon_#{i}"]=IconSprite.new(0,0,@viewport)
         @sprites["section_icon_#{i}"].setBitmap(QUEST_GRAPHICS_PATH+"section_bar")
         @sprites["section_icon_#{i}"].x=20+(160*i)
         @sprites["section_icon_#{i}"].y=12
         @sprites["section_icon_#{i}"].zoom_x=2
         @sprites["section_icon_#{i}"].zoom_y=2
         if @sections[i][0]==$PokemonGlobal.selectedSection
           @sprites["section_icon_#{i}"].src_rect.set(@sprites["section_icon_#{i}"].bitmap.width/2,0,@sprites["section_icon_#{i}"].bitmap.width/2,@sprites["section_icon_#{i}"].bitmap.height)
         else 
           @sprites["section_icon_#{i}"].src_rect.set(0,0,@sprites["section_icon_#{i}"].bitmap.width/2,@sprites["section_icon_#{i}"].bitmap.height)
         end
         if @sections[i][0]==$PokemonGlobal.selectedSection
           textPositions.push([@sections[i][1],85+(160*i),10,2,selectedColor,selectedShadowColor])
         else
           textPositions.push([@sections[i][1],85+(160*i),10,2,baseColor,shadowColor])
         end
       end
       pbDrawTextPositions(bitmap,textPositions)
       pbDrawQuestsList
     end
     
     def getSelectedID
       questOptions=[@activeQuests,@completedQuests,@failedQuests]
       quests = questOptions[$PokemonGlobal.selectedSection]
       selectionOptions=[@@viewingActive,@@viewingComplete,@@viewingFailed]
       questFound = false
       for i in 0...quests.length
         if quests[i].id==selectionOptions[$PokemonGlobal.selectedSection]
           questFound = true 
           break
         end
       end
       if selectionOptions[$PokemonGlobal.selectedSection]<0
         questFound = false
       end
       if !questFound
         case $PokemonGlobal.selectedSection
         when 0
           @@viewingActive = quests[0].id
           selectedID = @@viewingActive
         when 1
           @@viewingComplete = quests[0].id
           selectedID = @@viewingComplete
         when 2
           @@viewingFailed = quests[0].id
           selectedID = @@viewingFailed
         end
       else
         selectedID = selectionOptions[$PokemonGlobal.selectedSection]
       end
       return [quests,selectedID]
     end
     
     def pbDrawQuestsList
       overlay=@sprites["quests_list_overlay"].bitmap
       overlay.clear 
       ret = getSelectedID
       quests = ret[0]
       selectedID = ret[1]
       textPositions = []
       baseColor=Color.new(72,72,72)
       selectedColor=Color.new(0,0,139)
       shadowColor=Color.new(160,160,160)
       selectedShadowColor=Color.new(160,160,160)
       for i in 0...quests.length
         if quests[i].id==selectedID
           textPositions.push([$quest_data.getNameFromID(quests[i].id),0,@yOffsetList+2+(i*31),0,selectedColor,selectedShadowColor])
         else
           textPositions.push([$quest_data.getNameFromID(quests[i].id),0,@yOffsetList+2+(i*31),0,baseColor,shadowColor])
         end
       end
       pbDrawTextPositions(overlay,textPositions)
       pbDrawQuestInfo
     end
     
     def pbDrawQuestInfo
       overlay=@sprites["quest_info_overlay"].bitmap 
       overlay.clear
       ret = getSelectedID
       quests = ret[0]
       selectedID = ret[1]
       textPositions = []
       baseColor=Color.new(12,12,12)
       shadowColor=Color.new(72,72,72)
       titleColor = Color.new(135,206,250)
       titleShadow = Color.new(0,0,0, 100)
       selectedColor=Color.new(200,200,200)
       @curNumLines=1
       for i in 0...quests.length
         if quests[i].id==selectedID
           questDescArr = $quest_data.getQuestDescription(quests[i].id).wordwrap(33)
           stages = $quest_data.getQuestStages(quests[i].id)
           if stages[quests[i].stage-1]
             stageDescArr = (stages[quests[i].stage-1]).wordwrap(30)
           else 
             stageDescArr=[]
           end
           textPositions.push([$quest_data.getNameFromID(quests[i].id),(Graphics.width-200)/2,@yOffsetInfo,2,titleColor,titleShadow])
           @curNumLines+=1
           for j in 0...questDescArr.length
             textPositions.push([_INTL("{1}",questDescArr[j]),0,@yOffsetInfo+20+20*j,0,baseColor,shadowColor])
             @curNumLines+=1
           end
            #What's draw depends on if completed, failed, or active
           if $PokemonGlobal.selectedSection==2
             textPositions.push([_INTL("Result:"),0,@yOffsetInfo+20+20*questDescArr.length,0,selectedColor,shadowColor])
             textPositions.push([_INTL(" {1}",$quest_data.getFailedMessage(quests[i].id)),0,@yOffsetInfo+40+20*questDescArr.length,0,baseColor,shadowColor])
             @curNumLines+=1
             break
           elsif $PokemonGlobal.selectedSection==1 
             textPositions.push([_INTL("Result:"),0,@yOffsetInfo+20+20*questDescArr.length,0,selectedColor,shadowColor])
             textPositions.push([_INTL(" {1}",$quest_data.getCompletedMessage(quests[i].id)),0,@yOffsetInfo+40+20*questDescArr.length,0,baseColor,shadowColor])
             @curNumLines+=1
             break       
           else
             textPositions.push([_INTL("Reward:"),0,@yOffsetInfo+20+20*questDescArr.length,0,selectedColor,shadowColor])
             textPositions.push([_INTL("{1}",$quest_data.getQuestRewardDescription(quests[i].id)),65,@yOffsetInfo+20+20*questDescArr.length,0,baseColor,shadowColor])
             @curNumLines+=1
             textPositions.push([_INTL("Next Task:"),0,@yOffsetInfo+20+20*(questDescArr.length+1),0,selectedColor,shadowColor])
             @curNumLines+=1
             textPositions.push([_INTL(" {1}",stageDescArr[0]),0,@yOffsetInfo+40+20*(questDescArr.length+1),0,baseColor,shadowColor])
             @curNumLines+=1
             for k in 1...stageDescArr.length
               textPositions.push([_INTL("{1}",stageDescArr[k]),0,@yOffsetInfo+40+20*(questDescArr.length+1)+20*k,0,baseColor,shadowColor])
               @curNumLines+=1
             end
             if $quest_data.getStageLocation(quests[i].id,quests[i].stage).to_s=="nil"
               locationText = "No location available"
             else
               ret=pbGetMessage(MessageTypes::MapNames,$quest_data.getStageLocation(quests[i].id,quests[i].stage))
               if $Trainer
                 ret.gsub!(/\\PN/,$Trainer.name)
               end
               locationText = ret
             end
             textPositions.push([_INTL("Next Location:"),0,@yOffsetInfo+40+20*(questDescArr.length)+20*(stageDescArr.length+1),0,selectedColor,shadowColor])
             @curNumLines+=1
             textPositions.push([_INTL(" {1}",locationText),0,@yOffsetInfo+60+20*(questDescArr.length)+20*(stageDescArr.length+1),0,baseColor,shadowColor])
             @curNumLines+=1
             break
           end
         end
       end
       pbDrawTextPositions(overlay,textPositions)
     end
   
     def pbMain
       loop do
         Graphics.update
         Input.update
         self.update
         if Input.trigger?(Input::B) #X, exit from scene
           break
         end
         #change selected list
         if Input.trigger?(Input::LEFT)
           @yOffsetInfo=0
           @yOffsetList=0
           for i in [email protected]
             if $PokemonGlobal.selectedSection==@sections[i][0]
               pos = i
               break
             end
           end          
           pos-=1
           if pos<0
             pos = @sections.length-1
           end
           $PokemonGlobal.selectedSection = @sections[pos][0]
           pbDrawSections
         elsif Input.trigger?(Input::RIGHT)
           @yOffsetInfo=0
           @yOffsetList=0
           for i in [email protected]
             if $PokemonGlobal.selectedSection==@sections[i][0]
               pos = i
               break
             end
           end 
           pos+=1
           if pos>[email protected]
             pos = 0
           end
           $PokemonGlobal.selectedSection = @sections[pos][0]
           pbDrawSections
         #Scroll quest info up/down
         elsif Input.trigger?(Input::R)  #S
           if (@yOffsetInfo/-20)<(@curNumLines-14)
             @yOffsetInfo-=20
             pbDrawQuestInfo
           end
         elsif Input.trigger?(Input::L) #A
           if @yOffsetInfo<0
             @yOffsetInfo+=20
             pbDrawQuestInfo
           end
         #move up/down list of quests
         elsif Input.trigger?(Input::DOWN)
           @yOffsetInfo=0
           nextQuest = -1
           #if nextQuest remains -1, then there are no quests to list
           case $PokemonGlobal.selectedSection
           when 0
             for i in [email protected]
                if @activeQuests[i].id==@@viewingActive
                  nextQuest = i+1
                  break
                end
             end
             if nextQuest>-1
               if nextQuest>[email protected]
                 @@viewingActive=@activeQuests[0].id
                 @yOffsetList=0
               else
                 @@viewingActive = @activeQuests[nextQuest].id
                 if (@yOffsetList/-31)<@activeQuests.length-10
                   @yOffsetList-=31
                 end
               end
             end
           when 1
             for i in [email protected]
                if @completedQuests[i].id==@@viewingComplete
                  nextQuest = i+1
                  break
                end
             end
             if nextQuest>-1
               if nextQuest>[email protected]
                 @@viewingComplete=@completedQuests[0].id
                 @yOffsetList=0
               else
                 @@viewingComplete = @completedQuests[nextQuest].id
                 if (@yOffsetList/-31)<@completedQuests.length-6
                   @yOffsetList-=31
                 end
               end
             end
           when 2
             for i in [email protected]
                if @failedQuests[i].id==@@viewingFailed
                  nextQuest = i+1
                  break
                end
             end
             if nextQuest>-1
               if nextQuest>[email protected]
                 @@viewingFailed=@failedQuests[0].id
                 @yOffsetList=0
               else
                 @@viewingFailed = @failedQuests[nextQuest].id
                 if (@yOffsetList/-31)<@failedQuests.length-6
                   @yOffsetList-=31
                 end
               end
             end
           end
           pbDrawQuestsList
         elsif Input.trigger?(Input::UP)
           @yOffsetInfo=0
           nextQuest = -2
           #if nextQuest remains -2, then there are no quests to list
           case $PokemonGlobal.selectedSection
           when 0
             for i in [email protected]
                if @activeQuests[i].id==@@viewingActive
                  nextQuest = i-1
                  break
                end
             end
             if nextQuest!=-2 
               if nextQuest<0
                 @@viewingActive=@activeQuests[@activeQuests.length-1].id
                 if @activeQuests.length>10
                   @yOffsetList=(@activeQuests.length-10)*-31
                 end
               else
                 @@viewingActive = @activeQuests[nextQuest].id
                 if @yOffsetList<0
                   @yOffsetList+=31
                 end
               end
             end
           when 1
             for i in [email protected]
                if @completedQuests[i].id==@@viewingComplete
                  nextQuest = i-1
                  break
                end
             end
             if nextQuest!=-2 
               if nextQuest<0
                 @@viewingComplete=@completedQuests[@completedQuests.length-1].id
                 if @completedQuests.length>10
                   @yOffsetList=(@completedQuests.length-10)*-31
                 end
               else
                 @@viewingComplete = @completedQuests[nextQuest].id
                 if @yOffsetList<0
                   @yOffsetList+=31
                 end
               end
             end
           when 2
             for i in [email protected]
                if @failedQuests[i].id==@@viewingFailed
                  nextQuest = i-1
                  break
                end
             end
             if nextQuest!=-2 
               if nextQuest<0
                 @@viewingFailed=@failedQuests[@failedQuests.length-1].id
                 if @failedQuests.length>10
                   @yOffsetList=(@failedQuests.length-10)*-31
                 end
               else
                 @@viewingFailed = @failedQuests[nextQuest].id
                 if @yOffsetList<0
                   @yOffsetList+=31
                 end
               end
             end
           end
           pbDrawQuestsList
         end
       end 
     end
   
     def pbEndScene
       pbFadeOutAndHide(@sprites) { update }
       pbDisposeSpriteHash(@sprites)
       @viewport.dispose
     end
   end
   
   class QuestScreen 
     def initialize(scene)
       @scene=scene
     end
   
     def pbStartScreen
       @scene.pbStartScene
       @scene.pbMain
       @scene.pbEndScene
     end
   end
   
   def pbViewQuests
     if !hasAnyQuests?
       Kernel.pbMessage(_INTL("You haven't discovered any quests yet"))
       return false
     end
     scene=QuestScene.new
     screen=QuestScreen.new(scene)
     screen.pbStartScreen()
   end
   
   #=============================================
   #Store currently selected section
   #=============================================
   class PokemonGlobalMetadata
     attr_writer :selectedSection
   
     def selectedSection
       @selectedSection = 0 if !@selectedSection
       return @selectedSection
     end
     
     alias quest_ui_init initialize
     def initialize
       quest_ui_init
       @selectedSection = 0
     end
   end
   
   def hasAnyQuests?
     if $PokemonGlobal.quests.active_quests.length >0 || 
         $PokemonGlobal.quests.completed_quests.length>0 ||
         $PokemonGlobal.quests.failed_quests.length>0
       return true
     end
     return false      
   end
   
   #=============================================
   #word wrapping (returns an array of sentence fragments, broken by length)
   #words kept together
   #requires monospaced font to work properly
   #=============================================
   class String
     def wordwrap(width)
       return self.scan(/\S.{0,#{width-2}}\S(?=\s|$)|\S+/)
     end
   end
   
   #======================================
   #adding questmenu to the pause menu
   #by replacing old method with this one
   #
   #added by derFischae
   #======================================
   class PokemonPauseMenu
       def pbStartPokemonMenu
       pbSetViableDexes
       @scene.pbStartScene
       endscene = true
       commands = []
       cmdPokedex  = -1
       cmdPokemon  = -1
       cmdBag      = -1
       #===============
       #added for questmenu
       cmdQuests   = -1
       #end of changes
       #===============
       cmdTrainer  = -1
       cmdSave     = -1
       cmdOption   = -1
       cmdPokegear = -1
       cmdDebug    = -1
       cmdQuit     = -1
       cmdEndGame  = -1
       if !$Trainer
         if $DEBUG
           Kernel.pbMessage(_INTL("The player trainer was not defined, so the menu can't be displayed."))
           Kernel.pbMessage(_INTL("Please see the documentation to learn how to set up the trainer player."))
         end
         return
       end
       commands[cmdPokedex = commands.length]  = _INTL("Pokédex") if $Trainer.pokedex && $PokemonGlobal.pokedexViable.length>0
       commands[cmdPokemon = commands.length]  = _INTL("Pokémon") if $Trainer.party.length>0
       commands[cmdBag = commands.length]      = _INTL("Bag") if !pbInBugContest?
       #=================================================
       #added for questmenu (quest menu point not visible
       #in pause menu while having no quest)
       commands[cmdQuests = commands.length]   = _INTL("Quests") if hasAnyQuests?
       #end of changes
       #=================================================
       commands[cmdPokegear = commands.length] = _INTL("Pokégear") if $Trainer.pokegear
       commands[cmdTrainer = commands.length]  = $Trainer.name
       if pbInSafari?
         if SAFARISTEPS<=0
           @scene.pbShowInfo(_INTL("Balls: {1}",pbSafariState.ballcount))
         else
           @scene.pbShowInfo(_INTL("Steps: {1}/{2}\nBalls: {3}",
              pbSafariState.steps,SAFARISTEPS,pbSafariState.ballcount))
         end
         commands[cmdQuit = commands.length]   = _INTL("Quit")
       elsif pbInBugContest?
         if pbBugContestState.lastPokemon
           @scene.pbShowInfo(_INTL("Caught: {1}\nLevel: {2}\nBalls: {3}",
              PBSpecies.getName(pbBugContestState.lastPokemon.species),
              pbBugContestState.lastPokemon.level,
              pbBugContestState.ballcount))
         else
           @scene.pbShowInfo(_INTL("Caught: None\nBalls: {1}",pbBugContestState.ballcount))
         end
         commands[cmdQuit = commands.length]   = _INTL("Quit Contest")
       else
         commands[cmdSave = commands.length]   = _INTL("Save") if $game_system && !$game_system.save_disabled
       end
       commands[cmdOption = commands.length]   = _INTL("Options")
       commands[cmdDebug = commands.length]    = _INTL("Debug") if $DEBUG
       commands[cmdEndGame = commands.length]  = _INTL("Quit Game")
       loop do
         command = @scene.pbShowCommands(commands)
         if cmdPokedex>=0 && command==cmdPokedex
           if DEXDEPENDSONLOCATION
             pbFadeOutIn(99999){
               scene = PokemonPokedex_Scene.new
               screen = PokemonPokedexScreen.new(scene)
               screen.pbStartScreen
               @scene.pbRefresh
             }
           else
             if $PokemonGlobal.pokedexViable.length==1
               $PokemonGlobal.pokedexDex = $PokemonGlobal.pokedexViable[0]
               $PokemonGlobal.pokedexDex = -1 if $PokemonGlobal.pokedexDex==$PokemonGlobal.pokedexUnlocked.length-1
               pbFadeOutIn(99999){
                 scene = PokemonPokedex_Scene.new
                 screen = PokemonPokedexScreen.new(scene)
                 screen.pbStartScreen
                 @scene.pbRefresh
               }
             else
               pbFadeOutIn(99999){
                 scene = PokemonPokedexMenu_Scene.new
                 screen = PokemonPokedexMenuScreen.new(scene)
                 screen.pbStartScreen
                 @scene.pbRefresh
               }
             end
           end
         elsif cmdPokemon>=0 && command==cmdPokemon
           hiddenmove = nil
           pbFadeOutIn(99999){ 
             sscene = PokemonParty_Scene.new
             sscreen = PokemonPartyScreen.new(sscene,$Trainer.party)
             hiddenmove = sscreen.pbPokemonScreen
             (hiddenmove) ? @scene.pbEndScene : @scene.pbRefresh
           }
           if hiddenmove
             $game_temp.in_menu = false
             Kernel.pbUseHiddenMove(hiddenmove[0],hiddenmove[1])
             return
           end
         elsif cmdBag>=0 && command==cmdBag
           item = 0
           pbFadeOutIn(99999){ 
             scene = PokemonBag_Scene.new
             screen = PokemonBagScreen.new(scene,$PokemonBag)
             item = screen.pbStartScreen 
             (item>0) ? @scene.pbEndScene : @scene.pbRefresh
           }
           if item>0
             Kernel.pbUseKeyItemInField(item)
             return
           end
         #===========================================
         #added for questmenu (quest menu point in 
         #pause menu leads to quest menu)
         elsif cmdQuests>=0 && command==cmdQuests
           pbFadeOutIn(99999){ 
             scene = QuestScene.new
             screen = QuestScreen.new(scene)
             screen.pbStartScreen
             @scene.pbRefresh
           }
         #end of changes
         #===========================================
         elsif cmdPokegear>=0 && command==cmdPokegear
           pbFadeOutIn(99999){
             scene = PokemonPokegear_Scene.new
             screen = PokemonPokegearScreen.new(scene)
             screen.pbStartScreen
             @scene.pbRefresh
           }
         elsif cmdTrainer>=0 && command==cmdTrainer
           pbFadeOutIn(99999){ 
             scene = PokemonTrainerCard_Scene.new
             screen = PokemonTrainerCardScreen.new(scene)
             screen.pbStartScreen
             @scene.pbRefresh
           }
         elsif cmdQuit>=0 && command==cmdQuit
           @scene.pbHideMenu
           if pbInSafari?
             if Kernel.pbConfirmMessage(_INTL("Would you like to leave the Safari Game right now?"))
               @scene.pbEndScene
               pbSafariState.decision = 1
               pbSafariState.pbGoToStart
               return
             else
               pbShowMenu
             end
           else
             if Kernel.pbConfirmMessage(_INTL("Would you like to end the Contest now?"))
               @scene.pbEndScene
               pbBugContestState.pbStartJudging
               return
             else
               pbShowMenu
             end
           end
         elsif cmdSave>=0 && command==cmdSave
           @scene.pbHideMenu
           scene = PokemonSave_Scene.new
           screen = PokemonSaveScreen.new(scene)
           if screen.pbSaveScreen
             @scene.pbEndScene
             endscene = false
             break
           else
             pbShowMenu
           end
         elsif cmdOption>=0 && command==cmdOption
           pbFadeOutIn(99999){
             scene = PokemonOption_Scene.new
             screen = PokemonOptionScreen.new(scene)
             screen.pbStartScreen
             pbUpdateSceneMap
             @scene.pbRefresh
           }
         elsif cmdDebug>=0 && command==cmdDebug
           pbFadeOutIn(99999){
             pbDebugMenu
             @scene.pbRefresh
           }
         elsif cmdEndGame>=0 && command==cmdEndGame
           @scene.pbHideMenu
           if Kernel.pbConfirmMessage(_INTL("Are you sure you want to quit the game?"))
             scene = PokemonSave_Scene.new
             screen = PokemonSaveScreen.new(scene)
             if screen.pbSaveScreen
               @scene.pbEndScene
             end
             @scene.pbEndScene
             $scene = nil
             return
           else
             pbShowMenu
           end
         else
           break
         end
       end
       @scene.pbEndScene if endscene
     end
   end

   
   FOR POKEMON ESSENTIALS V18.1
   
   Spoiler:

   
   

   ##########################################################################
   #                   SIMPLE QUEST SYSTEM + UI 1.0
   #                           by mej 71
   #
   # updated for pokemon essentials 18.1, bug fixes
   # and integration to pause menu by derFischae
   ##########################################################################
   =begin
   This is a fairly comprehensive, yet easy to use system + UI
   for managing quests in your fangame
   
   Features
       Support for up to 10 stages per quest
       Complex rewards
       Very detailed compiler errors, tells you exactly what you've messed up
       Doesn't save quest data for player (similar to how other objects are handled in Essentials, non-specific data is stored in a separate data file so that quest info is updated for old saves)
       Plug and play
       Won't break old save files by adding this script
       Easy to edit and create new quests
   
   Installation:
   Add quests.txt to your PBS folder
   Add the 'Quest UI' folder to Graphics/Pictures (be sure to include the folder itself, not just the contents)
   Add this text from questScript.txt into a new section above the Main but below the Compiler section
   And that's all there is to the installation
   
   How to Use
   Start of a new game is not required,
   should integrate into old saves files
   
   There's a few methods you will need to know to use the quest system
   (you will activate/complete/fail quests within your events,
   only you know in which context to do so)
   Code:
       activateQuest(id)
       completeQuest(id)
       failQuest(id)
       advanceQuestToStage(questID, stageNum)
   In all of these, 'id' and 'questID' refer to the ID of the desired quest,
   which is defined in quests.txt, the file you added to your PBS folder.
   The name of the quest can also be used in as the 'id' for these methods,
   since quest names are unique.
   The 'stageNum' refers to the desired stage number of that quest.
   Be sure the id you input exists,
   as there is currently no check against it
   
   Editing the Quest PBS file:
   There's only 8 types of lines in the PBS that you need to know
       Name - This is the name of the quest that will be displayed. Names must be unique (two quests cannot share a name)
       Stage1 - This is the description of the current task of the quests. Each quest can have up to 10 stages (so Stage2, Stage9, etc are also valid). Stages must be listed in order, no skipping numbers.
       Reward - This is the reward given to the player upon completion. When completion is triggered, it will read the string assigned and evaluate it as code. So if you make your reward "Kernel.pbMessage('Hello')", upon completion it will display a message saying "Hello". This reward is fairly simple, but keep in mind any type of code can be run here, so you can give items, set variables, or pretty much anything else you can code. Note that this code is not tested, so test all your rewards to ensure you didn't make errors. (Pro tip: semi-colons can be used to separate multiple instructions in a single line of code)
       RewardDescription - A description of the reward, so they player may determine whether or not to pursue
       QuestDescription - A description of the quest
       StageLocation1 - Same as with Stage1, there are up to 10 locations supported. This tells the player where to go for the next task. Can either be the desired map name or map id. These are checked upon compile time to ensure the map exists. "nil" can be used if you don't want to specify a map
       CompleteMessage - The "Result" description displayed in the UI for a completed quest.
       FailedMessage - The "Result" description displayed in the UI for a failed quest.
   =end
   
   #========================================================
   #This class holds the information for an individual quest
   #========================================================
   class Quest
     attr_reader   :id
     attr_reader   :stage
   
     def stage=(value)
       if value>$quest_data.getMaxStagesForQuest(@id)
         value = $quest_data.getMaxStagesForQuest(@id)
       end
       @stage = value
     end
     
     def initialize(id)
       @id         = id
       @stage      = 1
     end
   end
   
   #========================================================
   #This class holds all the trainers quests
   #========================================================
   class Player_Quests
     attr_accessor :active_quests
     attr_accessor :completed_quests
     attr_accessor :failed_quests
     attr_accessor :selected_quest_id
     
     def initialize
       @active_quests =[]
       @completed_quests = []
       @failed_quests = []
       @selected_quest_id = 0
     end
     
     #questID can either be the internal ID number, or the quest name
     def activateQuest(questID)
       if questID.is_a?(String)
         questID = $quest_data.getIDFromName(questID)
       end
       for i in 0...@active_quests.length
         if @active_quests[i].id==questID
           Kernel.pbMessage("You have already started this quest")
           return
         end
       end
       for i in 0...@completed_quests.length
         if @completed_quests[i].id==questID
           Kernel.pbMessage("You have already complete this quest")
           return
         end
       end
       for i in 0...@failed_quests.length
         if @failed_quests[i].id==questID
           Kernel.pbMessage("You have already failed this quest")
           return
         end
       end
       @active_quests.push(Quest.new(questID))
     end
     
     def failQuest(questID)
       if questID.is_a?(String)
         questID = $quest_data.getIDFromName(questID)
       end
       found = false
       for i in 0...@completed_quests.length
         if @completed_quests[i].id==questID
           Kernel.pbMessage("You have already complete this quest")
           return
         end
       end
       for i in 0...@failed_quests.length
         if @failed_quests[i].id==questID
           Kernel.pbMessage("You have already failed this quest")
           return
         end
       end 
       for i in 0...@active_quests.length
          if @active_quests[i].id==questID
            @failed_quests.push(@active_quests[i])
            @active_quests.delete_at(i)
            found=true
            break
          end
       end
       if !found
         @failed_quests.push(Quest.new(questID))
       end
     end
     
     def completeQuest(questID)
       if questID.is_a?(String)
         questID = $quest_data.getIDFromName(questID)
       end
       found = false
       for i in 0...@completed_quests.length
         if @completed_quests[i].id==questID
           Kernel.pbMessage("You have already complete this quest")
           return
         end
       end
       for i in 0...@failed_quests.length
         if @failed_quests[i].id==questID
           Kernel.pbMessage("You have already failed this quest")
           return
         end
       end  
       for i in 0...@active_quests.length
          if @active_quests[i].id==questID
            @completed_quests.push(@active_quests[i])
            @active_quests.delete_at(i)
            found = true
            break
          end
       end
       if !found
         @completed_quests.push(Quest.new(questID))
       end
       rewardString = $quest_data.getQuestReward(questID)
       eval(rewardString)
     end
     
     def advanceQuestToStage(questID,stageNum)
       if questID.is_a?(String)
         questID = $quest_data.getIDFromName(questID)
       end
       found = false
       for i in 0...@active_quests.length
          if @active_quests[i].id==questID
            @active_quests[i].stage=stageNum
            found = true
          end
          return if found
       end
       if !found
         quest = Quest.new(questID)
         quest.stage = stageNum
         @active_quests.push(quest)
       end
     end
   end
   
   class PokemonGlobalMetadata  
     def quests
       @quests = Player_Quests.new if !@quests
       return @quests
     end
     
     alias quest_init initialize
     def initialize
       quest_init
       @quests = Player_Quests.new
     end
   end
   
   def activateQuest(id)
     return if !$PokemonGlobal
     $PokemonGlobal.quests.activateQuest(id)
   end
   
   def completeQuest(id)
     return if !$PokemonGlobal
     $PokemonGlobal.quests.completeQuest(id)
   end
   
   def failQuest(id)
     return if !$PokemonGlobal
     $PokemonGlobal.quests.failQuest(id)
   end
   
   def advanceQuestToStage(questID,stageNum)
     return if !$PokemonGlobal
     $PokemonGlobal.quests.advanceQuestToStage(questID,stageNum)
   end
   
   QUEST_FILE_NAME = "quests.txt"  #the name of the file to read from
   
   #========================================================
   #a module use during compilation of the quest file
   #========================================================
   module QuestsData
     NeededInfo={
        "Name"=>[1,"s"],
        "Stage1"=>[2,"s"],
        "Stage2"=>[3,"s"],
        "Stage3"=>[4,"s"],
        "Stage4"=>[5,"s"],
        "Stage5"=>[6,"s"],
        "Stage6"=>[7,"s"],
        "Stage7"=>[8,"s"],
        "Stage8"=>[9,"s"],
        "Stage9"=>[10,"s"],
        "Stage10"=>[11,"s"],
        "Reward"=>[12,"s"],
        "RewardDescription"=>[13,"s"],
        "QuestDescription"=>[14,"s"],
        "StageLocation1" => [15,"s"],
        "StageLocation2" => [16,"s"],
        "StageLocation3" => [17,"s"],
        "StageLocation4" => [18,"s"],
        "StageLocation5" => [19,"s"],
        "StageLocation6" => [20,"s"],
        "StageLocation7" => [21,"s"],
        "StageLocation8" => [22,"s"],
        "StageLocation9" => [23,"s"],
        "StageLocation10" => [24,"s"],
        "CompletedMessage"=>[25,"s"],
        "FailedMessage"=>[26,"s"],
     }  
   end
   
   #========================================================
   #Pseudo class to read quest info from
   #========================================================
   class QuestInfo
     attr_reader :id
     attr_reader :name
     attr_reader :stages
     attr_reader :rewardString
     attr_reader :rewardDesc
     attr_reader :questDesc
     attr_reader :locations
     attr_reader :completedMessage
     attr_reader :failedMessage
     
     def initialize(id,questName,stages,rewardString,rewardDesc,
                     questDesc,locations,completedMessage,failedMessage)
       @id = id
       @name = questName
       @stages = stages
       @rewardString = rewardString
       @rewardDesc = rewardDesc
       @questDesc = questDesc
       @locations = locations
       @completedMessage = completedMessage
       @failedMessage = failedMessage
     end
   end
   
   #=====================================================================
   #This class loads/reads all data for all quests.  Updates at the start
   #of every game session will use this class to determine their values,
   #and this is used for deciding updates/rewards, etc
   #=====================================================================
   class Game_Quests
     def initialize
       needCompile = false
       latestdatatime = 0
       latesttexttime = 0
       if !safeExists?("Data/Quests.rxdata")
         needCompile = true
       else
           File.open("Data/Quests.rxdata"){|file|
                  latestdatatime=[latestdatatime,file.mtime.to_i].max
           }
           File.open("PBS/#{QUEST_FILE_NAME}"){|file|
                latesttexttime=[latesttexttime,file.mtime.to_i].max
           }
           needCompile=true if latesttexttime>=latestdatatime
           needCompile=true if Input.press?(Input::CTRL)
       end
       if $DEBUG && safeExists?("PBS/#{QUEST_FILE_NAME}") && needCompile
         compileAllQuests
       else
         begin
           @all_quests = load_data("Data/Quests.rxdata")
         rescue
           @all_quests = []
           Kernel.pbMessage("No quests data found")
         end
       end    
     end
     
     def compileAllQuests
       #names and IDs must be unique
       checkQuestIDs=[]
       checkQuestNames=[]
       @all_quests = []
       currentQuest = 0
       name = ""
       stages = []
       rewardString = ""
       rewardDesc = ""
       questDesc = ""
       completedMessage = ""
       failedMessage = ""
       locations = []
       lineCount = 0
       #check order of stages
       curStage = 0
       curLocation = 0
       pbCompilerEachCommentedLine("PBS/"+QUEST_FILE_NAME) {|line,lineno|
        lineCount+=1
        if line[/^\s*\[\s*(\d+)\s*\]\s*$/]
          if currentQuest>0
            if stages.length==0
              raise _INTL("Expected at least one stage for quest {1}\r\n{2}",currentQuest,FileLineData.linereport)
            end
            if locations.length!=stages.length
              raise _INTL("locs= {1}" ,locations)
   
              raise _INTL("locs= {1} & stages= {2}",locations.length,stages.length)
              raise _INTL("Expected the number of locations to match the number of stages for quest {1}\r\n{2}",currentQuest,FileLineData.linereport)
               
            end
            if questDesc.nil? || questDesc==""
              raise _INTL("Expected a quest description for quest {1}\r\n{2}",currentQuest,FileLineData.linereport)
            end
            if rewardString.nil? || rewardString==""
              raise _INTL("Expected a reward for quest {1}\r\n{2}",currentQuest,FileLineData.linereport)
            end
            if rewardDesc.nil? || rewardDesc==""
              raise _INTL("Expected a reward description for quest {1}\r\n{2}",currentQuest,FileLineData.linereport)
            end
            if completedMessage.nil? || completedMessage==""
              raise _INTL("Expected a completed message for quest {1}\r\n{2}",currentQuest,FileLineData.linereport)
            end
            if failedMessage.nil? || failedMessage==""
              raise _INTL("Expected a failed message for quest {1}\r\n{2}",currentQuest,FileLineData.linereport)
            end
            @all_quests.push(QuestInfo.new(currentQuest,name,stages,rewardString,rewardDesc,
                            questDesc,locations,completedMessage,failedMessage))
            curStage = 0
            curLocation = 0
            name = ""
            stages = []
            locations = []
            rewardString = ""
            rewardDesc = ""
            questDesc = ""
            completedMessage = ""
            failedMessage = ""
          end
          sectionname=$~[1]
          if checkQuestIDs.include?(sectionname.to_i)
              raise _INTL("Quest numbers must be unique! {1} already used\r\n{2}",sectionname,FileLineData.linereport)
          end
          currentQuest=sectionname.to_i
          checkQuestIDs.push(currentQuest)
        else
          if currentQuest==0
            raise _INTL("Expected a section at the beginning of the file\r\n{1}",FileLineData.linereport)
          end
          if !line[/^\s*(\w+)\s*=\s*(.*)$/]
            raise _INTL("Bad line syntax (expected syntax like XXX=YYY)\r\n{1}",FileLineData.linereport)
          end
          matchData=$~
          schema=nil
          FileLineData.setSection(currentQuest,matchData[1],matchData[2])
          schema=QuestsData::NeededInfo[matchData[1]]
          schemaValues = schema[1]
          if schema
            schemaValues = schema[1].split('|')
          end
          if schema
            for i in 0...schemaValues.length
              schema[1] = schemaValues[i]
              record=pbGetCsvRecord(matchData[2],lineno,schema) rescue next
              case schema
              when QuestsData::NeededInfo["Name"]
                if checkQuestNames.include?(record)
                    raise _INTL("Quest names must be unique! {1} already used\r\n{2}",record,FileLineData.linereport)
                end
                name = record
                checkQuestNames.push(name)
                break
              when QuestsData::NeededInfo["Reward"]
                rewardString = record
                break
              when QuestsData::NeededInfo["RewardDescription"]
                rewardDesc = record
                break
              when QuestsData::NeededInfo["QuestDescription"]
                questDesc = record           
                break
              when QuestsData::NeededInfo["CompletedMessage"]
                completedMessage = record
                break
              when QuestsData::NeededInfo["FailedMessage"]
                failedMessage = record
                break
              else
                if matchData[1].include?("StageLocation")
                  if ((matchData[1][/\d+/]).to_i)!=curLocation+1
                    raise _INTL("Locations need to be in order.  Expecting location {1}\r\n{2}",curLocation+1,FileLineData.linereport)
                  end
                  if record.is_a?(String) && record.downcase=="nil"
                    curLocation+=1
                    locations.push("nil")
                    break
                  elsif record !~ /\D/ #only numbers
                    mapname = pbGetMessage(MessageTypes::MapNames,record.to_i) rescue nil
                    if mapname.nil?
                      raise _INTL("Invalid map id for quest {1}, at stage {2}",sectionname,curLocation)
                    end
                    curLocation+=1
                    locations.push(record)
                    break
                  else
                    Kernel.pbMessage(_INTL("{1}", record))
                    #Kernel.pbMessage(_INTL("5={1}", MessageTypes.getFromMapHashValue(MessageTypes::MapNames,"Route 1")))
                    mapid = MessageTypes.getFromMapHashValue(MessageTypes::MapNames,record)
                    if mapid.nil?
                      raise _INTL("Invalid map id for quest {1}, at stage {2}",sectionname,curLocation)
                    end
                    curLocation+=1
                    locations.push(mapid)
                    break
                  end
                elsif matchData[1].include?("Stage")
                  if ((matchData[1][/\d+/]).to_i)!=curStage+1
                    raise _INTL("Stages need to be in order.  Expecting stage {1}\r\n{2}",curStage+1,FileLineData.linereport)
                  end
                  curStage+=1
                  stages.push(record)
                  break
                else
                  raise _INTL("Unexpected field {1} for quest {2}",matchData[1],sectionname)
                end
              end
             end
          end
        end
       }
       if stages.length==0
         raise _INTL("Expected at least one stage for quest {1}\r\n{2}",currentQuest,FileLineData.linereport)
       end
       if locations.length!=stages.length
         raise _INTL("Expected the number of locations to match the number of stages for quest {1}\r\n{2}",currentQuest,FileLineData.linereport)
       end
       if questDesc.nil? || questDesc==""
         raise _INTL("Expected a quest description for quest {1}\r\n{2}",currentQuest,FileLineData.linereport)
       end
       if rewardString.nil? || rewardString==""
         raise _INTL("Expected a reward for quest {1}\r\n{2}",currentQuest,FileLineData.linereport)
       end
       if rewardDesc.nil? || rewardDesc==""
         raise _INTL("Expected a reward description for quest {1}\r\n{2}",currentQuest,FileLineData.linereport)
       end
       if completedMessage.nil? || completedMessage==""
         raise _INTL("Expected a completed message for quest {1}\r\n{2}",currentQuest,FileLineData.linereport)
       end
       if failedMessage.nil? || failedMessage==""
         raise _INTL("Expected a failed message for quest {1}\r\n{2}",currentQuest,FileLineData.linereport)
       end
       @all_quests.push(QuestInfo.new(currentQuest,name,stages,rewardString,
         rewardDesc,questDesc,locations,completedMessage,failedMessage)) if lineCount>0
       save_data(@all_quests,"Data/Quests.rxdata")
     end
     
     def nameAllQuests
       for i in 0...@all_quests.length
         Kernel.pbMessage("#{@all_quests[i].id}")
         Kernel.pbMessage("#{@all_quests[i].name}")
         for j in 0...@all_quests[i].stages.length
           Kernel.pbMessage("#{@all_quests[i].stages[j]}")
         end
         Kernel.pbMessage("#{@all_quests[i].rewardString}")
         Kernel.pbMessage("#{@all_quests[i].rewardDesc}")
         Kernel.pbMessage("#{@all_quests[i].questDesc}")
       end
     end
     
     def getIDFromName(name)
       for i in 0...@all_quests.length
         return @all_quests[i].id if @all_quests[i].name==name
       end
     end
     
     def getNameFromID(id)
       for i in 0...@all_quests.length
         return @all_quests[i].name if @all_quests[i].id==id
       end
     end
     
     def getQuestStages(questID)
       if questID.is_a?(String)
         questID = getIDFromName(questID)
       end
       for i in 0...@all_quests.length
         return @all_quests[i].stages if @all_quests[i].id==questID
       end
     end
     
     def getQuestReward(questID)
       if questID.is_a?(String)
         questID = getIDFromName(questID)
       end
       for i in 0...@all_quests.length
         return @all_quests[i].rewardString if @all_quests[i].id==questID
       end
     end
     
     def getQuestRewardDescription(questID)
       if questID.is_a?(String)
         questID = getIDFromName(questID)
       end
       for i in 0...@all_quests.length
         return @all_quests[i].rewardDesc if @all_quests[i].id==questID
       end
     end
     
     def getQuestDescription(questID)
       if questID.is_a?(String)
         questID = getIDFromName(questID)
       end
       for i in 0...@all_quests.length
         return @all_quests[i].questDesc if @all_quests[i].id==questID
       end
     end  
     
     def getStageLocation(questID,stage)
       if questID.is_a?(String)
         questID = getIDFromName(questID)
       end
       for i in 0...@all_quests.length
         return @all_quests[i].locations[stage-1] if @all_quests[i].id==questID
       end
     end  
     
     def getMaxStagesForQuest(questID)
       if questID.is_a?(String)
         questID = getIDFromName(questID)
       end
       quests = getQuestStages(questID)
       return quests.length
     end
     
     def getCompletedMessage(questID)
       if questID.is_a?(String)
         questID = getIDFromName(questID)
       end
       for i in 0...@all_quests.length
         return @all_quests[i].completedMessage if @all_quests[i].id==questID
       end
     end 
     
     def getFailedMessage(questID)
       if questID.is_a?(String)
         questID = getIDFromName(questID)
       end
       for i in 0...@all_quests.length
         return @all_quests[i].failedMessage if @all_quests[i].id==questID
       end
     end 
   end
   
   #========================================================
   #modify messages to check for a map name among the maps
   #========================================================
   class Messages
     def getFromMapHashValue(type,key)
       Kernel.pbMessage("Hi")
       delayedLoad
       #Kernel.pbMessage(_INTL("Hi2 {1}",@messages))
       return nil if !@messages
       #Kernel.pbMessage(_INTL("Hi3 {1}",@messages[0]))
       return nil if !@messages[0]
       #Kernel.pbMessage(_INTL("Hi4 {1}, {2}",@messages[0][type],@messages[0][0]))
       return nil if !@messages[0][type] && !@messages[0][0]
       Kernel.pbMessage("Hi5")
       key.sub!("e^","é")
       id=Messages.stringToKey(key)
       if @messages[type] && @messages[type].include?(id)
           return @messages[type].index(id)
       elsif @messages[0] && @messages[0].include?(id)
         return @messages[0].index(id)
       end
       return nil
     end
   end
   
   module MessageTypes
     def self.getFromMapHashValue(type,key)
       @@messages.getFromMapHashValue(type,key)
     end
   end
   
   $quest_data = Game_Quests.new
   #$quest_data.nameAllQuests
   
   QUEST_GRAPHICS_PATH = "Graphics/Pictures/Quest UI/"
   
   class QuestScene 
     @@viewingActive = 0
     @@viewingComplete = 0
     @@viewingFailed  = 0
     
     def update
       pbUpdateSpriteHash(@sprites)
     end
     
     def pbStartScene
       @yOffsetInfo=0
       @yOffsetList=0
       @curNumLines=0
       @sprites={} 
       @viewport=Viewport.new(0,0,Graphics.width,Graphics.height)
       @viewport.z=99999
       @viewport_text=Viewport.new(0,0,Graphics.width,Graphics.height)
       @viewport_text.z=99999+1
       @sprites["background"]=IconSprite.new(0,0,@viewport)
       @sprites["background"].setBitmap(QUEST_GRAPHICS_PATH+"quest_bg")
       @sprites["background"].zoom_x = Graphics.width/(@sprites["background"].bitmap.width)
       @sprites["background"].zoom_y = Graphics.height/(@sprites["background"].bitmap.height)
       @sprites["overlay"]=BitmapSprite.new(Graphics.width,Graphics.height,@viewport)
       @sprites["sections_text_overlay"]=BitmapSprite.new(Graphics.width,Graphics.height,@viewport_text)
       @sprites["quests_list_overlay"]=BitmapSprite.new(Graphics.width,Graphics.height*4/5,@viewport_text)
       @sprites["quests_list_overlay"].x=5
       @sprites["quests_list_overlay"].y=35
       @sprites["quest_info_overlay"]=BitmapSprite.new(Graphics.width,Graphics.height*4/5-8,@viewport_text)
       @sprites["quest_info_overlay"].y=38
       @sprites["quest_info_overlay"].x=202
       @sprites["navigation_info_overlay"]=BitmapSprite.new(Graphics.width,Graphics.height,@viewport_text)
       pbSetSmallFont(@sprites["overlay"].bitmap)
       pbSetSmallFont(@sprites["sections_text_overlay"].bitmap)
       pbSetSmallFont(@sprites["quests_list_overlay"].bitmap)
       pbSetSmallFont(@sprites["quest_info_overlay"].bitmap)
       pbSetSmallFont(@sprites["navigation_info_overlay"].bitmap)
       pbDrawSections
       pbDrawNavigationInfo
     end
     
     def pbDrawNavigationInfo
       overlay=@sprites["navigation_info_overlay"].bitmap
       overlay.clear
       @sprites["navigation_info_overlay"].bitmap.font.size=20
       baseColor=Color.new(72,72,72)
       shadowColor=Color.new(160,160,160)
       textPositions = [
         ["Arrows - Change Quest/Section",2,Graphics.height-40,0,baseColor,shadowColor],
         ["A,S - Scroll Info",Graphics.width-235,Graphics.height-40,0,baseColor,shadowColor],
         ["X - Exit",Graphics.width-60,Graphics.height-40,0,baseColor,shadowColor],
       ]
       pbDrawTextPositions(overlay,textPositions)
     end
   
     def pbDrawSections
       @activeQuests=$PokemonGlobal.quests.active_quests
       @completedQuests=$PokemonGlobal.quests.completed_quests
       @failedQuests=$PokemonGlobal.quests.failed_quests
       @sections=[]
       @sections.push([0,_INTL("Active")]) #if @activeQuests.length>0
       @sections.push([1,_INTL("Completed")]) #if @completedQuests.length>0
       @sections.push([2,_INTL("Failed")]) #if @failedQuests.length>0
       @@viewingActive = @activeQuests[0].id if @activeQuests!=[] && @@viewingActive<=0
       @@viewingComplete = @completedQuests[0].id if @completedQuests!=[] && @@viewingComplete<=0
       @@viewingFailed  = @failedQuests[0].id if @failedQuests!=[] && @@viewingFailed<=0
       baseColor=Color.new(72,72,72)
       selectedColor=Color.new(0,0,139)
       shadowColor=Color.new(160,160,160)
       selectedShadowColor=Color.new(160,160,160)
       bitmap = @sprites["sections_text_overlay"].bitmap
       bitmap.clear
       textPositions=[]
       for i in [email protected]
         @sprites["section_icon_#{i}"]=IconSprite.new(0,0,@viewport)
         @sprites["section_icon_#{i}"].setBitmap(QUEST_GRAPHICS_PATH+"section_bar")
         @sprites["section_icon_#{i}"].x=20+(160*i)
         @sprites["section_icon_#{i}"].y=12
         @sprites["section_icon_#{i}"].zoom_x=2
         @sprites["section_icon_#{i}"].zoom_y=2
         if @sections[i][0]==$PokemonGlobal.selectedSection
           @sprites["section_icon_#{i}"].src_rect.set(@sprites["section_icon_#{i}"].bitmap.width/2,0,@sprites["section_icon_#{i}"].bitmap.width/2,@sprites["section_icon_#{i}"].bitmap.height)
         else 
           @sprites["section_icon_#{i}"].src_rect.set(0,0,@sprites["section_icon_#{i}"].bitmap.width/2,@sprites["section_icon_#{i}"].bitmap.height)
         end
         if @sections[i][0]==$PokemonGlobal.selectedSection
           textPositions.push([@sections[i][1],85+(160*i),10,2,selectedColor,selectedShadowColor])
         else
           textPositions.push([@sections[i][1],85+(160*i),10,2,baseColor,shadowColor])
         end
       end
       pbDrawTextPositions(bitmap,textPositions)
       pbDrawQuestsList
     end
     
     def getSelectedID
       questOptions=[@activeQuests,@completedQuests,@failedQuests]
       quests = questOptions[$PokemonGlobal.selectedSection]
       selectionOptions=[@@viewingActive,@@viewingComplete,@@viewingFailed]
       questFound = false
       for i in 0...quests.length
         if quests[i].id==selectionOptions[$PokemonGlobal.selectedSection]
           questFound = true 
           break
         end
       end
       if selectionOptions[$PokemonGlobal.selectedSection]<0
         questFound = false
       end
       if !questFound
         case $PokemonGlobal.selectedSection
         when 0
           @@viewingActive = quests[0].id
           selectedID = @@viewingActive
         when 1
           @@viewingComplete = quests[0].id
           selectedID = @@viewingComplete
         when 2
           @@viewingFailed = quests[0].id
           selectedID = @@viewingFailed
         end
       else
         selectedID = selectionOptions[$PokemonGlobal.selectedSection]
       end
       return [quests,selectedID]
     end
     
     def pbDrawQuestsList
       overlay=@sprites["quests_list_overlay"].bitmap
       overlay.clear 
       ret = getSelectedID
       quests = ret[0]
       selectedID = ret[1]
       textPositions = []
       baseColor=Color.new(72,72,72)
       selectedColor=Color.new(0,0,139)
       shadowColor=Color.new(160,160,160)
       selectedShadowColor=Color.new(160,160,160)
       for i in 0...quests.length
         if quests[i].id==selectedID
           textPositions.push([$quest_data.getNameFromID(quests[i].id),0,@yOffsetList+2+(i*31),0,selectedColor,selectedShadowColor])
         else
           textPositions.push([$quest_data.getNameFromID(quests[i].id),0,@yOffsetList+2+(i*31),0,baseColor,shadowColor])
         end
       end
       pbDrawTextPositions(overlay,textPositions)
       pbDrawQuestInfo
     end
     
     def pbDrawQuestInfo
       overlay=@sprites["quest_info_overlay"].bitmap 
       overlay.clear
       ret = getSelectedID
       quests = ret[0]
       selectedID = ret[1]
       textPositions = []
       baseColor=Color.new(12,12,12)
       shadowColor=Color.new(72,72,72)
       titleColor = Color.new(135,206,250)
       titleShadow = Color.new(0,0,0, 100)
       selectedColor=Color.new(200,200,200)
       @curNumLines=1
       for i in 0...quests.length
         if quests[i].id==selectedID
           questDescArr = $quest_data.getQuestDescription(quests[i].id).wordwrap(33)
           stages = $quest_data.getQuestStages(quests[i].id)
           if stages[quests[i].stage-1]
             stageDescArr = (stages[quests[i].stage-1]).wordwrap(30)
           else 
             stageDescArr=[]
           end
           textPositions.push([$quest_data.getNameFromID(quests[i].id),(Graphics.width-200)/2,@yOffsetInfo,2,titleColor,titleShadow])
           @curNumLines+=1
           for j in 0...questDescArr.length
             textPositions.push([_INTL("{1}",questDescArr[j]),0,@yOffsetInfo+20+20*j,0,baseColor,shadowColor])
             @curNumLines+=1
           end
            #What's draw depends on if completed, failed, or active
           if $PokemonGlobal.selectedSection==2
             textPositions.push([_INTL("Result:"),0,@yOffsetInfo+20+20*questDescArr.length,0,selectedColor,shadowColor])
             textPositions.push([_INTL(" {1}",$quest_data.getFailedMessage(quests[i].id)),0,@yOffsetInfo+40+20*questDescArr.length,0,baseColor,shadowColor])
             @curNumLines+=1
             break
           elsif $PokemonGlobal.selectedSection==1 
             textPositions.push([_INTL("Result:"),0,@yOffsetInfo+20+20*questDescArr.length,0,selectedColor,shadowColor])
             textPositions.push([_INTL(" {1}",$quest_data.getCompletedMessage(quests[i].id)),0,@yOffsetInfo+40+20*questDescArr.length,0,baseColor,shadowColor])
             @curNumLines+=1
             break       
           else
             textPositions.push([_INTL("Reward:"),0,@yOffsetInfo+20+20*questDescArr.length,0,selectedColor,shadowColor])
             textPositions.push([_INTL("{1}",$quest_data.getQuestRewardDescription(quests[i].id)),65,@yOffsetInfo+20+20*questDescArr.length,0,baseColor,shadowColor])
             @curNumLines+=1
             textPositions.push([_INTL("Next Task:"),0,@yOffsetInfo+20+20*(questDescArr.length+1),0,selectedColor,shadowColor])
             @curNumLines+=1
             textPositions.push([_INTL(" {1}",stageDescArr[0]),0,@yOffsetInfo+40+20*(questDescArr.length+1),0,baseColor,shadowColor])
             @curNumLines+=1
             for k in 1...stageDescArr.length
               textPositions.push([_INTL("{1}",stageDescArr[k]),0,@yOffsetInfo+40+20*(questDescArr.length+1)+20*k,0,baseColor,shadowColor])
               @curNumLines+=1
             end
             if $quest_data.getStageLocation(quests[i].id,quests[i].stage).to_s=="nil"
               locationText = "No location available"
             else
               ret=pbGetMessage(MessageTypes::MapNames,$quest_data.getStageLocation(quests[i].id,quests[i].stage).to_i)
               if $Trainer
                 ret.gsub!(/\\PN/,$Trainer.name)
               end
               locationText = ret
             end
             textPositions.push([_INTL("Next Location:"),0,@yOffsetInfo+40+20*(questDescArr.length)+20*(stageDescArr.length+1),0,selectedColor,shadowColor])
             @curNumLines+=1
             textPositions.push([_INTL(" {1}",locationText),0,@yOffsetInfo+60+20*(questDescArr.length)+20*(stageDescArr.length+1),0,baseColor,shadowColor])
             @curNumLines+=1
             break
           end
         end
       end
       pbDrawTextPositions(overlay,textPositions)
     end
   
     def pbMain
       loop do
         Graphics.update
         Input.update
         self.update
         if Input.trigger?(Input::B) #X, exit from scene
           break
         end
         #change selected list
         if Input.trigger?(Input::LEFT)
           @yOffsetInfo=0
           @yOffsetList=0
           for i in [email protected]
             if $PokemonGlobal.selectedSection==@sections[i][0]
               pos = i
               break
             end
           end          
           pos-=1
           if pos<0
             pos = @sections.length-1
           end
           $PokemonGlobal.selectedSection = @sections[pos][0]
           pbDrawSections
         elsif Input.trigger?(Input::RIGHT)
           @yOffsetInfo=0
           @yOffsetList=0
           for i in [email protected]
             if $PokemonGlobal.selectedSection==@sections[i][0]
               pos = i
               break
             end
           end 
           pos+=1
           if pos>[email protected]
             pos = 0
           end
           $PokemonGlobal.selectedSection = @sections[pos][0]
           pbDrawSections
         #Scroll quest info up/down
         elsif Input.trigger?(Input::R)  #S
           if (@yOffsetInfo/-20)<(@curNumLines-14)
             @yOffsetInfo-=20
             pbDrawQuestInfo
           end
         elsif Input.trigger?(Input::L) #A
           if @yOffsetInfo<0
             @yOffsetInfo+=20
             pbDrawQuestInfo
           end
         #move up/down list of quests
         elsif Input.trigger?(Input::DOWN)
           @yOffsetInfo=0
           nextQuest = -1
           #if nextQuest remains -1, then there are no quests to list
           case $PokemonGlobal.selectedSection
           when 0
             for i in [email protected]
                if @activeQuests[i].id==@@viewingActive
                  nextQuest = i+1
                  break
                end
             end
             if nextQuest>-1
               if nextQuest>[email protected]
                 @@viewingActive=@activeQuests[0].id
                 @yOffsetList=0
               else
                 @@viewingActive = @activeQuests[nextQuest].id
                 if (@yOffsetList/-31)<@activeQuests.length-10
                   @yOffsetList-=31
                 end
               end
             end
           when 1
             for i in [email protected]
                if @completedQuests[i].id==@@viewingComplete
                  nextQuest = i+1
                  break
                end
             end
             if nextQuest>-1
               if nextQuest>[email protected]
                 @@viewingComplete=@completedQuests[0].id
                 @yOffsetList=0
               else
                 @@viewingComplete = @completedQuests[nextQuest].id
                 if (@yOffsetList/-31)<@completedQuests.length-6
                   @yOffsetList-=31
                 end
               end
             end
           when 2
             for i in [email protected]
                if @failedQuests[i].id==@@viewingFailed
                  nextQuest = i+1
                  break
                end
             end
             if nextQuest>-1
               if nextQuest>[email protected]
                 @@viewingFailed=@failedQuests[0].id
                 @yOffsetList=0
               else
                 @@viewingFailed = @failedQuests[nextQuest].id
                 if (@yOffsetList/-31)<@failedQuests.length-6
                   @yOffsetList-=31
                 end
               end
             end
           end
           pbDrawQuestsList
         elsif Input.trigger?(Input::UP)
           @yOffsetInfo=0
           nextQuest = -2
           #if nextQuest remains -2, then there are no quests to list
           case $PokemonGlobal.selectedSection
           when 0
             for i in [email protected]
                if @activeQuests[i].id==@@viewingActive
                  nextQuest = i-1
                  break
                end
             end
             if nextQuest!=-2 
               if nextQuest<0
                 @@viewingActive=@activeQuests[@activeQuests.length-1].id
                 if @activeQuests.length>10
                   @yOffsetList=(@activeQuests.length-10)*-31
                 end
               else
                 @@viewingActive = @activeQuests[nextQuest].id
                 if @yOffsetList<0
                   @yOffsetList+=31
                 end
               end
             end
           when 1
             for i in [email protected]
                if @completedQuests[i].id==@@viewingComplete
                  nextQuest = i-1
                  break
                end
             end
             if nextQuest!=-2 
               if nextQuest<0
                 @@viewingComplete=@completedQuests[@completedQuests.length-1].id
                 if @completedQuests.length>10
                   @yOffsetList=(@completedQuests.length-10)*-31
                 end
               else
                 @@viewingComplete = @completedQuests[nextQuest].id
                 if @yOffsetList<0
                   @yOffsetList+=31
                 end
               end
             end
           when 2
             for i in [email protected]
                if @failedQuests[i].id==@@viewingFailed
                  nextQuest = i-1
                  break
                end
             end
             if nextQuest!=-2 
               if nextQuest<0
                 @@viewingFailed=@failedQuests[@failedQuests.length-1].id
                 if @failedQuests.length>10
                   @yOffsetList=(@failedQuests.length-10)*-31
                 end
               else
                 @@viewingFailed = @failedQuests[nextQuest].id
                 if @yOffsetList<0
                   @yOffsetList+=31
                 end
               end
             end
           end
           pbDrawQuestsList
         end
       end 
     end
   
     def pbEndScene
       pbFadeOutAndHide(@sprites) { update }
       pbDisposeSpriteHash(@sprites)
       @viewport.dispose
     end
   end
   
   class QuestScreen 
     def initialize(scene)
       @scene=scene
     end
   
     def pbStartScreen
       @scene.pbStartScene
       @scene.pbMain
       @scene.pbEndScene
     end
   end
   
   def pbViewQuests
     if !hasAnyQuests?
       Kernel.pbMessage(_INTL("You haven't discovered any quests yet"))
       return false
     end
     scene=QuestScene.new
     screen=QuestScreen.new(scene)
     screen.pbStartScreen()
   end
   
   #=============================================
   #Store currently selected section
   #=============================================
   class PokemonGlobalMetadata
     attr_writer :selectedSection
   
     def selectedSection
       @selectedSection = 0 if !@selectedSection
       return @selectedSection
     end
     
     alias quest_ui_init initialize
     def initialize
       quest_ui_init
       @selectedSection = 0
     end
   end
   
   def hasAnyQuests?
     if $PokemonGlobal.quests.active_quests.length >0 || 
         $PokemonGlobal.quests.completed_quests.length>0 ||
         $PokemonGlobal.quests.failed_quests.length>0
       return true
     end
     return false      
   end
   
   #=============================================
   #word wrapping (returns an array of sentence fragments, broken by length)
   #words kept together
   #requires monospaced font to work properly
   #=============================================
   class String
     def wordwrap(width)
       return self.scan(/\S.{0,#{width-2}}\S(?=\s|$)|\S+/)
     end
   end
   
   #======================================
   #adding questmenu to the pause menu
   #by replacing old method with this one
   #
   #added by derFischae
   #======================================
   class PokemonPauseMenu
     def pbStartPokemonMenu
       if !$Trainer
         if $DEBUG
           pbMessage(_INTL("The player trainer was not defined, so the pause menu can't be displayed."))
           pbMessage(_INTL("Please see the documentation to learn how to set up the trainer player."))
         end
         return
       end
       pbSetViableDexes
       @scene.pbStartScene
       endscene = true
       commands = []
       cmdPokedex  = -1
       cmdPokemon  = -1
       cmdBag      = -1
       #===============
       #added for questmenu
       cmdQuests   = -1
       #end of changes
       #===============
       cmdTrainer  = -1
       cmdSave     = -1
       cmdOption   = -1
       cmdPokegear = -1
       cmdDebug    = -1
       cmdQuit     = -1
       cmdEndGame  = -1
       commands[cmdPokedex = commands.length]  = _INTL("Pokédex") if $Trainer.pokedex && $PokemonGlobal.pokedexViable.length>0
       commands[cmdPokemon = commands.length]  = _INTL("Pokémon") if $Trainer.party.length>0
       commands[cmdBag = commands.length]      = _INTL("Bag") if !pbInBugContest?
       #=================================================
       #added for questmenu (quest menu point not visible in pause menu while having no quest)
       commands[cmdQuests = commands.length]   = _INTL("Quests") if hasAnyQuests?
       #end of changes
       #=================================================
       commands[cmdPokegear = commands.length] = _INTL("Pokégear") if $Trainer.pokegear
       commands[cmdTrainer = commands.length]  = $Trainer.name
       if pbInSafari?
         if SAFARI_STEPS<=0
           @scene.pbShowInfo(_INTL("Balls: {1}",pbSafariState.ballcount))
         else
           @scene.pbShowInfo(_INTL("Steps: {1}/{2}\nBalls: {3}",
              pbSafariState.steps,SAFARI_STEPS,pbSafariState.ballcount))
         end
         commands[cmdQuit = commands.length]   = _INTL("Quit")
       elsif pbInBugContest?
         if pbBugContestState.lastPokemon
           @scene.pbShowInfo(_INTL("Caught: {1}\nLevel: {2}\nBalls: {3}",
              PBSpecies.getName(pbBugContestState.lastPokemon.species),
              pbBugContestState.lastPokemon.level,
              pbBugContestState.ballcount))
         else
           @scene.pbShowInfo(_INTL("Caught: None\nBalls: {1}",pbBugContestState.ballcount))
         end
         commands[cmdQuit = commands.length]   = _INTL("Quit Contest")
       else
         commands[cmdSave = commands.length]   = _INTL("Save") if $game_system && !$game_system.save_disabled
       end
       commands[cmdOption = commands.length]   = _INTL("Options")
       commands[cmdDebug = commands.length]    = _INTL("Debug") if $DEBUG
       commands[cmdEndGame = commands.length]  = _INTL("Quit Game")
       loop do
         command = @scene.pbShowCommands(commands)
         if cmdPokedex>=0 && command==cmdPokedex
           if USE_CURRENT_REGION_DEX
             pbFadeOutIn {
               scene = PokemonPokedex_Scene.new
               screen = PokemonPokedexScreen.new(scene)
               screen.pbStartScreen
               @scene.pbRefresh
             }
           else
             if $PokemonGlobal.pokedexViable.length==1
               $PokemonGlobal.pokedexDex = $PokemonGlobal.pokedexViable[0]
               $PokemonGlobal.pokedexDex = -1 if $PokemonGlobal.pokedexDex==$PokemonGlobal.pokedexUnlocked.length-1
               pbFadeOutIn {
                 scene = PokemonPokedex_Scene.new
                 screen = PokemonPokedexScreen.new(scene)
                 screen.pbStartScreen
                 @scene.pbRefresh
               }
             else
               pbFadeOutIn {
                 scene = PokemonPokedexMenu_Scene.new
                 screen = PokemonPokedexMenuScreen.new(scene)
                 screen.pbStartScreen
                 @scene.pbRefresh
               }
             end
           end
         elsif cmdPokemon>=0 && command==cmdPokemon
           hiddenmove = nil
           pbFadeOutIn {
             sscene = PokemonParty_Scene.new
             sscreen = PokemonPartyScreen.new(sscene,$Trainer.party)
             hiddenmove = sscreen.pbPokemonScreen
             (hiddenmove) ? @scene.pbEndScene : @scene.pbRefresh
           }
           if hiddenmove
             $game_temp.in_menu = false
             pbUseHiddenMove(hiddenmove[0],hiddenmove[1])
             return
           end
         elsif cmdBag>=0 && command==cmdBag
           item = 0
           pbFadeOutIn {
             scene = PokemonBag_Scene.new
             screen = PokemonBagScreen.new(scene,$PokemonBag)
             item = screen.pbStartScreen
             (item>0) ? @scene.pbEndScene : @scene.pbRefresh
           }
           if item>0
             $game_temp.in_menu = false
             pbUseKeyItemInField(item)
             return
           end
         #===========================================
         #added for questmenu (quest menu point in pause menu leads to quest menu)
         elsif cmdQuests>=0 && command==cmdQuests
           pbFadeOutIn(99999){ 
             scene = QuestScene.new
             screen = QuestScreen.new(scene)
             screen.pbStartScreen
             @scene.pbRefresh
           }
         #end of changes
         #===========================================
         elsif cmdPokegear>=0 && command==cmdPokegear
           pbFadeOutIn {
             scene = PokemonPokegear_Scene.new
             screen = PokemonPokegearScreen.new(scene)
             screen.pbStartScreen
             @scene.pbRefresh
           }
         elsif cmdTrainer>=0 && command==cmdTrainer
           pbFadeOutIn {
             scene = PokemonTrainerCard_Scene.new
             screen = PokemonTrainerCardScreen.new(scene)
             screen.pbStartScreen
             @scene.pbRefresh
           }
         elsif cmdQuit>=0 && command==cmdQuit
           @scene.pbHideMenu
           if pbInSafari?
             if pbConfirmMessage(_INTL("Would you like to leave the Safari Game right now?"))
               @scene.pbEndScene
               pbSafariState.decision = 1
               pbSafariState.pbGoToStart
               return
             else
               pbShowMenu
             end
           else
             if pbConfirmMessage(_INTL("Would you like to end the Contest now?"))
               @scene.pbEndScene
               pbBugContestState.pbStartJudging
               return
             else
               pbShowMenu
             end
           end
         elsif cmdSave>=0 && command==cmdSave
           @scene.pbHideMenu
           scene = PokemonSave_Scene.new
           screen = PokemonSaveScreen.new(scene)
           if screen.pbSaveScreen
             @scene.pbEndScene
             endscene = false
             break
           else
             pbShowMenu
           end
         elsif cmdOption>=0 && command==cmdOption
           pbFadeOutIn {
             scene = PokemonOption_Scene.new
             screen = PokemonOptionScreen.new(scene)
             screen.pbStartScreen
             pbUpdateSceneMap
             @scene.pbRefresh
           }
         elsif cmdDebug>=0 && command==cmdDebug
           pbFadeOutIn {
             pbDebugMenu
             @scene.pbRefresh
           }
         elsif cmdEndGame>=0 && command==cmdEndGame
           @scene.pbHideMenu
           if pbConfirmMessage(_INTL("Are you sure you want to quit the game?"))
             scene = PokemonSave_Scene.new
             screen = PokemonSaveScreen.new(scene)
             if screen.pbSaveScreen
               @scene.pbEndScene
             end
             @scene.pbEndScene
             $scene = nil
             return
           else
             pbShowMenu
           end
         else
           break
         end
       end
       @scene.pbEndScene if endscene
     end
   end

6. If you want to use Luka J.S.'s Modular Pause Menu then follow the instructions in this spoiler section
   
   Spoiler:

   
   

   Follow these steps.
   1.) Install Luka J.S's Modular Pause Menu from Luka. J.S.'s homepage and follow the instructions carefully there. When adding the code of the Modular Pause Menu in a new script section above Main, then make sure that it is below the Quest UI script section.
   2.) Open the Script Editor and add this code
   

   # Quest Menü
   MenuHandlers.addEntry(:QUESTS,_INTL("Quests"),"menuQuests",proc{|menu|
       scene = QuestScene.new
       screen = QuestScreen.new(scene)
       pbFadeOutIn(99999) { 
         screen.pbStartScreen
     }
   },proc{ return true })

   right above this code snippet
   

   # PokeGear

   in the script section, where you had copied the script of Luka J.S's Modular Pause Menu in step 1.).
   
   If this didn't worked, then add this code instead
   

   Spoiler:

   # Quest Menü
   MenuHandlers.addEntry(:QUESTS,_INTL("Quests"),"menuQuests",proc{|menu|
     pbFadeOutIn(99999){ 
       scene = QuestScene.new
       screen = QuestScreen.new(scene)
       screen.pbStartScreen
       @scene.pbRefresh
     }
   },proc{ return true })

7. And that's all there is to the installation. You can start modifying the quests.txt and your fan game for your preferences.

How to Use
Start of a new game is not required,
should integrate into old saves files

There's a few methods you will need to know to use the quest system
(you will activate/complete/fail quests within your events,
only you know in which context to do so)
Code:
activateQuest(id)
completeQuest(id)
failQuest(id)
advanceQuestToStage(questID, stageNum)
In all of these, 'id' and 'questID' refer to the ID of the desired quest,
which is defined in quests.txt, the file you added to your PBS folder.
The name of the quest can also be used in as the 'id' for these methods,
since quest names are unique.
The 'stageNum' refers to the desired stage number of that quest.
Be sure the id you input exists,
as there is currently no check against it

Editing the Quest PBS file:
There's only 8 types of lines in the PBS that you need to know
Name - This is the name of the quest that will be displayed. Names must be unique (two quests cannot share a name)
Stage1 - This is the description of the current task of the quests. Each quest can have up to 10 stages (so Stage2, Stage9, etc are also valid). Stages must be listed in order, no skipping numbers.
Reward - This is the reward given to the player upon completion. When completion is triggered, it will read the string assigned and evaluate it as code. So if you make your reward "Kernel.pbMessage('Hello')", upon completion it will display a message saying "Hello". This reward is fairly simple, but keep in mind any type of code can be run here, so you can give items, set variables, or pretty much anything else you can code. Note that this code is not tested, so test all your rewards to ensure you didn't make errors. (Pro tip: semi-colons can be used to separate multiple instructions in a single line of code)
RewardDescription - A description of the reward, so they player may determine whether or not to pursue
QuestDescription - A description of the quest
StageLocation1 - Same as with Stage1, there are up to 10 locations supported. This tells the player where to go for the next task. Can either be the desired map name or map id. These are checked upon compile time to ensure the map exists. "nil" can be used if you don't want to specify a map
CompleteMessage - The "Result" description displayed in the UI for a completed quest.
FailedMessage - The "Result" description displayed in the UI for a failed quest.

 

[NoNoNever]

Thanks for this :9

 

[#Not Important]

Compatible with Neo Pause menu:

Spoiler:

#===============================================================================
#  Neo PauseMenu (for v17.x)
#    by Luka S.J. edited by #Not Important to support derFishae's quest thingy
# ---------------- 
#  Provides only features present in the default version of the Pokedex in
#  Essentials. Mean as a new cosmetic overhaul, adhering to the UI design
#  language of the Elite Battle System: The Next Generation
#
#  Enjoy the script, and make sure to give credit!
#  (DO NOT ALTER THE NAMES OF THE INDIVIDUAL SCRIPT SECTIONS OR YOU WILL BREAK
#   YOUR SYSTEM!)
#-------------------------------------------------------------------------------
#  Main module for handling each menu item/entry
#===============================================================================
class PokemonPauseMenu
  def initialize(scene)
    @scene = scene
  end

  def pbShowMenu
    @scene.pbRefresh
    @scene.pbShowMenu
  end

  def pbStartPokemonMenu
    pbSetViableDexes
    @scene.pbStartScene
    endscene = true
    commands = []
    cmdPokedex  = -1
    cmdPokemon  = -1
    cmdBag      = -1
    cmdTrainer  = -1
    cmdSave     = -1
    cmdOption   = -1
    cmdPokegear = -1
    cmdDebug    = -1
    cmdQuit     = -1
    cmdEndGame  = -1
    if !$Trainer
      if $DEBUG
        Kernel.pbMessage(_INTL("The player trainer was not defined, so the menu can't be displayed."))
        Kernel.pbMessage(_INTL("Please see the documentation to learn how to set up the trainer player."))
      end
      return
    end
    commands[cmdPokedex = commands.length]  = _INTL("Pokédex") if $Trainer.pokedex && $PokemonGlobal.pokedexViable.length>0
    commands[cmdPokemon = commands.length]  = _INTL("Pokémon") if $Trainer.party.length>0
    commands[cmdQuests = commands.length]   = _INTL("Quests")
    commands[cmdBag = commands.length]      = _INTL("Bag") if !pbInBugContest?
    commands[cmdPokegear = commands.length] = _INTL("Pokégear") if $Trainer.pokegear
    commands[cmdTrainer = commands.length]  = $Trainer.name
    if pbInSafari?
      if SAFARISTEPS<=0
        @scene.pbShowInfo(_INTL("Balls: {1}",pbSafariState.ballcount))
      else
        @scene.pbShowInfo(_INTL("Steps: {1}/{2}\nBalls: {3}",
           pbSafariState.steps,SAFARISTEPS,pbSafariState.ballcount))
      end
      commands[cmdQuit = commands.length]   = _INTL("Quit")
    elsif pbInBugContest?
      if pbBugContestState.lastPokemon
        @scene.pbShowInfo(_INTL("Caught: {1}\nLevel: {2}\nBalls: {3}",
           PBSpecies.getName(pbBugContestState.lastPokemon.species),
           pbBugContestState.lastPokemon.level,
           pbBugContestState.ballcount))
      else
        @scene.pbShowInfo(_INTL("Caught: None\nBalls: {1}",pbBugContestState.ballcount))
      end
      commands[cmdQuit = commands.length]   = _INTL("Quit Contest")
    else
      commands[cmdSave = commands.length]   = _INTL("Save") if $game_system && !$game_system.save_disabled
    end
    commands[cmdOption = commands.length]   = _INTL("Options")
    commands[cmdDebug = commands.length]    = _INTL("Debug") if $DEBUG
    commands[cmdEndGame = commands.length]  = _INTL("Quit Game")
    loop do
      command = @scene.pbShowCommands(commands)
      if cmdPokedex>=0 && command==cmdPokedex
        if DEXDEPENDSONLOCATION
          pbFadeOutIn(99999){
            scene = PokemonPokedex_Scene.new
            screen = PokemonPokedexScreen.new(scene)
            screen.pbStartScreen
            @scene.pbRefresh
          }
        else
          if $PokemonGlobal.pokedexViable.length==1
            $PokemonGlobal.pokedexDex = $PokemonGlobal.pokedexViable[0]
            $PokemonGlobal.pokedexDex = -1 if $PokemonGlobal.pokedexDex==$PokemonGlobal.pokedexUnlocked.length-1
            pbFadeOutIn(99999){
              scene = PokemonPokedex_Scene.new
              screen = PokemonPokedexScreen.new(scene)
              screen.pbStartScreen
              @scene.pbRefresh
            }
          else
            pbFadeOutIn(99999){
              scene = PokemonPokedexMenu_Scene.new
              screen = PokemonPokedexMenuScreen.new(scene)
              screen.pbStartScreen
              @scene.pbRefresh
            }
          end
        end
      elsif cmdPokemon>=0 && command==cmdPokemon
        hiddenmove = nil
        pbFadeOutIn(99999){ 
          sscene = PokemonParty_Scene.new
          sscreen = PokemonPartyScreen.new(sscene,$Trainer.party)
          hiddenmove = sscreen.pbPokemonScreen
          (hiddenmove) ? @scene.pbEndScene : @scene.pbRefresh
        }
        if hiddenmove
          $game_temp.in_menu = false
          Kernel.pbUseHiddenMove(hiddenmove[0],hiddenmove[1])
          return
        end
      elsif cmdBag>=0 && command==cmdBag
        item = 0
        pbFadeOutIn(99999){ 
          scene = PokemonBag_Scene.new
          screen = PokemonBagScreen.new(scene,$PokemonBag)
          item = screen.pbStartScreen 
          (item>0) ? @scene.pbEndScene : @scene.pbRefresh
        }
        if item>0
          Kernel.pbUseKeyItemInField(item)
          return
        end
      elsif cmdPokegear>=0 && command==cmdPokegear
        pbFadeOutIn(99999){
          scene = PokemonPokegear_Scene.new
          screen = PokemonPokegearScreen.new(scene)
          screen.pbStartScreen
          @scene.pbRefresh
        }
      elsif cmdTrainer>=0 && command==cmdTrainer
        pbFadeOutIn(99999){ 
          scene = PokemonTrainerCard_Scene.new
          screen = PokemonTrainerCardScreen.new(scene)
          screen.pbStartScreen
          @scene.pbRefresh
        }
      elsif cmdQuit>=0 && command==cmdQuit
        @scene.pbHideMenu
        if pbInSafari?
          if Kernel.pbConfirmMessage(_INTL("Would you like to leave the Safari Game right now?"))
            @scene.pbEndScene
            pbSafariState.decision = 1
            pbSafariState.pbGoToStart
            return
          else
            pbShowMenu
          end
        else
          if Kernel.pbConfirmMessage(_INTL("Would you like to end the Contest now?"))
            @scene.pbEndScene
            pbBugContestState.pbStartJudging
            return
          else
            pbShowMenu
          end
        end
      elsif cmdSave>=0 && command==cmdSave
        @scene.pbHideMenu
        scene = PokemonSave_Scene.new
        screen = PokemonSaveScreen.new(scene)
        if screen.pbSaveScreen
          @scene.pbEndScene
          endscene = false
          break
        else
          pbShowMenu
        end
      elsif cmdOption>=0 && command==cmdOption
        pbFadeOutIn(99999){
          scene = PokemonOption_Scene.new
          screen = PokemonOptionScreen.new(scene)
          screen.pbStartScreen
          pbUpdateSceneMap
          @scene.pbRefresh
        }
      elsif cmdDebug>=0 && command==cmdDebug
        pbFadeOutIn(99999){
          pbDebugMenu
          @scene.pbRefresh
        }
      elsif cmdEndGame>=0 && command==cmdEndGame
        @scene.pbHideMenu
        if Kernel.pbConfirmMessage(_INTL("Are you sure you want to quit the game?"))
          scene = PokemonSave_Scene.new
          screen = PokemonSaveScreen.new(scene)
          if screen.pbSaveScreen
            @scene.pbEndScene
          end
          @scene.pbEndScene
          $scene = nil
          return
        else
          pbShowMenu
        end
      else
        break
      end
    end
    @scene.pbEndScene if endscene
  end
end
#here be neo
module MenuHandlers
  # hash used to store the elements inside of the menu
  @@menuEntry = {}
  # hash used to store whether or not an element is unlocked
  @@available = {}
  # hash used to store the index of each element; for sorting
  @@indexes = {}
  @@index = 0
  # function to add a new element/entry to the menu.
  def self.addEntry(ref,name,icon,proc,conditional)
    @@menuEntry[ref] = [name,icon,proc]
    @@available[ref] = conditional
    @@indexes[ref] = @@index
    @@index += 1
  end
  # function to get the name of an element/entry
  def self.getName(ref)
    return @@menuEntry[ref][0]
  end
  # function to get the icon of an element/entry
  def self.getIcon(ref)
    return "Graphics/Icons/#{@@menuEntry[ref][1]}"
  end
  # function to get all the possible keys from the main hash
  def self.getKeys
    entries = Array.new(@@menuEntry.keys.length)
    for key in @@menuEntry.keys
      entries[@@indexes[key]] = key
    end
    return entries
  end
  # function used to invoke the stored code for each element/entry
  def self.runAction(ref,scene)
    @@menuEntry[ref][2].call(scene)
  end
  # function to check if the player has access to an element/entry
  def self.available?(ref)
    return @@available[ref].call
  end
  # function that lists all accessible menu elements/entries
  def self.elements?
    ent = self.getKeys
    items = 0
    for val in ent
      items += 1 if self.available?(val)
    end
    return items
  end
end
#-------------------------------------------------------------------------------
#  Main class used to handle the visuals
#-------------------------------------------------------------------------------
class PokemonPauseMenu_Scene
  attr_accessor :index
  attr_accessor :entries
  attr_accessor :endscene
  attr_accessor :close
  attr_accessor :hidden
  
  # retained for compatibility
  def pbShowInfo(text)
    @sprites["helpwindow"].resizeToFit(text,Graphics.height)
    @sprites["helpwindow"].text = text
    @sprites["helpwindow"].visible = true
    @helpstate = true
    pbBottomLeft(@sprites["helpwindow"])
  end
  # retained for compatibility
  def pbShowHelp(text)
    @sprites["helpwindow"].resizeToFit(text,Graphics.height)
    @sprites["helpwindow"].text = text
    @sprites["helpwindow"].visible = true
    @helpstate = true
    pbBottomLeft(@sprites["helpwindow"])
  end
  # main scene generation
  def pbStartScene
    pbSetViableDexes
    # sets the default index
    @index = $PokemonTemp.menuLastChoice.nil? ? 0 : $PokemonTemp.menuLastChoice
    @index = 0 if @index >= MenuHandlers.elements?
    @oldindex = 0
    @endscene = true
    @close = false
    @hidden = false
    # loads the visual parts of the 
    @viewport = Viewport.new(0,0,Graphics.width,Graphics.height)
    @viewport.z = 99999
    @sprites = {}
    # initializes the background graphic
    @bitmap = Graphics.snap_to_bitmap if !@bitmap
    @sprites["background"] = Sprite.new(@viewport)
    @sprites["background"].bitmap = @bitmap
    @sprites["background"].blur_sprite(3)
    @sprites["background"].bitmap.blt(0,0,pbBitmap("Graphics/Pictures/PauseMenu/bg"),Rect.new(0,0,Graphics.width,Graphics.height))
    bmp = pbBitmap("Graphics/Pictures/Common/scrollbar_bg")
    @sprites["background"].bitmap.blt(Graphics.width - 28,(Graphics.height - bmp.height)/2,bmp,Rect.new(0,0,bmp.width,bmp.height))
    # initializes the scrolling panorama
    @sprites["panorama"] = ScrollingSprite.new(@viewport)
    @sprites["panorama"].setBitmap("Graphics/Pictures/Common/panorama")
    @sprites["panorama"].speed = 1
    # retained for compatibility
    @sprites["infowindow"] = Window_UnformattedTextPokemon.newWithSize("",0,0,32,32,@viewport)
    @sprites["infowindow"].visible = false
    @sprites["helpwindow"] = Window_UnformattedTextPokemon.newWithSize("",0,0,32,32,@viewport)
    @sprites["helpwindow"].visible = false
    # draw the contest crap
    @sprites["textOverlay"] = Sprite.new(@viewport)
    @sprites["textOverlay"].bitmap = Bitmap.new(@viewport.rect.width,@viewport.rect.height)
    @sprites["textOverlay"].end_x = 0
    @sprites["textOverlay"].x = [email protected]
    pbSetSystemFont(@sprites["textOverlay"].bitmap)
    bmp = pbBitmap("Graphics/Pictures/Common/partyBar")
    content = []
    text = []
    if pbInSafari?
      content.push(_INTL("Steps: {1}/{2}",pbSafariState.steps,SAFARISTEPS)) if SAFARISTEPS > 0
      content.push(_INTL("Balls: {1}",pbSafariState.ballcount))
    elsif pbInBugContest?
      if pbBugContestState.lastPokemon
        content.push(_INTL("Caught: {1}",PBSpecies.getName(pbBugContestState.lastPokemon.species)))
        content.push(_INTL("Level: {1}",pbBugContestState.lastPokemon.level))
        content.push(_INTL("Balls: {1}",pbBugContestState.ballcount))
      else
        content.push("Caught: none")
      end
      content.push(_INTL("Balls: {1}",pbBugContestState.ballcount))
    end
    for i in 0...content.length
      text.push([content[i],16, 60 + i*50, 0, Color.new(255,255,255),Color.new(0,0,0,65)])
      @sprites["textOverlay"].bitmap.blt(-2,92 + i*50,bmp,Rect.new(0,0,bmp.width,bmp.height))
    end
    pbDrawTextPositions(@sprites["textOverlay"].bitmap,text)
    # initializes the scroll bar
    @sprites["scroll"] = Sprite.new(@viewport)
    # rendering elements on screen
    self.refresh
    self.update
    # memorizes the target opacities and sets them to 0
    @opacities = {}
    for key in @sprites.keys
      @opacities[key] = @sprites[key].opacity
      @sprites[key].opacity = 0
    end
  end

  def pbHideMenu
    # animations for closing the menu
    @sprites["textOverlay"].end_x = [email protected]
    8.times do
      for key in @sprites.keys
        next if !@sprites[key] || @sprites[key].disposed?
        @sprites[key].opacity -= 32
      end
      @sprites["textOverlay"].x += (@sprites["textOverlay"].end_x - @sprites["textOverlay"].x)*0.2
      Graphics.update
    end
  end

  def pbShowMenu
    # animations for opening the menu
    @sprites["textOverlay"].end_x = 0
    8.times do
      for key in @sprites.keys
        next if !@sprites[key] || @sprites[key].disposed?
        @sprites[key].opacity += 32 if @sprites[key].opacity < @opacities[key]
      end
      @sprites["textOverlay"].x += (@sprites["textOverlay"].end_x - @sprites["textOverlay"].x)*0.4
      Graphics.update
    end
  end
  
  def refresh
    # index safety
    @index = MenuHandlers.elements? - 1 if @index >= MenuHandlers.elements?
    @oldindex = @index
    # disposes old items in the menu
    if @entries
      for i in [email protected]
        @sprites["#{i}"].dispose if @sprites["#{i}"]
      end
    end
    # creates a new list of available items
    ent = MenuHandlers.getKeys
    @entries = []
    for val in ent
      @entries.push(val) if MenuHandlers.available?(val)
    end
    # draws individual item entries
    bmp = pbBitmap("Graphics/Pictures/PauseMenu/sel")
    for i in [email protected]
      key = @entries[i]
      @sprites["#{i}"] = Sprite.new(@viewport)
      @sprites["#{i}"].bitmap = Bitmap.new(bmp.width,bmp.height)
      pbSetSystemFont(@sprites["#{i}"].bitmap)
      @sprites["#{i}"].src_rect.set(0,0,bmp.width/2,bmp.height)
      @sprites["#{i}"].bitmap.blt(0,0,bmp,Rect.new(0,0,bmp.width,bmp.height))
      for j in 0...2
        opac = j == 0 ? 155 : 255
        icon = pbBitmap(MenuHandlers.getIcon(key))
        text = MenuHandlers.getName(key)
        text.gsub!("\\pn"){"#{$Trainer.name}"}
        text.gsub!("\\contest"){pbInSafari? ? "Quit" : "Quit Contest"}
        @sprites["#{i}"].bitmap.blt(18 + j*bmp.width/2,6,icon,Rect.new(0,0,48,48),opac)
        pbDrawOutlineText(@sprites["#{i}"].bitmap,66 + j*bmp.width/2,6,136,48,text,Color.new(255,255,255),Color.new(64,64,64),1)
      end
      @sprites["#{i}"].x = Graphics.width - bmp.width/2 - 52
      @sprites["#{i}"].y = 49 + (bmp.height + 12)*i
      @sprites["#{i}"].opacity = 128
    end
    # configures the scroll bar
    n = (@entries.length < 4 ? 1 : @entries.length - 3)
    height = 204/n
    height += 204 - (height*n)
    height += 16
    @sprites["scroll"].bitmap = Bitmap.new(16,height)
    bmp = pbBitmap("Graphics/Pictures/Common/scrollbar_kn")
    @sprites["scroll"].bitmap.blt(0,0,bmp,Rect.new(0,0,16,6))
    @sprites["scroll"].bitmap.stretch_blt(Rect.new(0,6,16,height-14),bmp,Rect.new(0,6,16,1))
    @sprites["scroll"].bitmap.blt(0,height-8,bmp,Rect.new(0,8,16,8))
    @sprites["scroll"].x = Graphics.width - 32
    @sprites["scroll"].y = (Graphics.height - 204)/2
    @sprites["scroll"].end_y = (Graphics.height - 204)/2
  end
  
  def update
    # scrolling background image
    @sprites["panorama"].update
    # calculations for updating the scrollbar position
    k = (@entries.length < 4 ? 0 : @index - 3)
    k = 0 if k < 0
    n = (@entries.length < 4 ? 1 : @entries.length - 3)
    height = 204/n
    @sprites["scroll"].end_y = (Graphics.height-204)/2 + height*k
    @sprites["scroll"].y += (@sprites["scroll"].end_y - @sprites["scroll"].y)*0.2
    # updates for each element/entry in the menu
    for i in [email protected]
      j = @entries.length < 4 ? 0 : (@index - 3)
      j = 0 if j < 0
      y = (-j)*(@sprites["#{i}"].src_rect.height + 12) + 49 + i*(@sprites["#{i}"].src_rect.height + 12)
      @sprites["#{i}"].y -= (@sprites["#{i}"].y - y)*0.1
      @sprites["#{i}"].src_rect.x = @sprites["#{i}"].src_rect.width*(@index == i ? 1 : 0)
      @sprites["#{i}"].x += 2 if @sprites["#{i}"].x < Graphics.width - @sprites["#{i}"].src_rect.width - 52
      if i.between?(j,j+3)
        @sprites["#{i}"].opacity += 15 if @sprites["#{i}"].opacity < 255
      else
        @sprites["#{i}"].opacity -= 15 if @sprites["#{i}"].opacity > 128
      end
      if @index == i
        @sprites["#{i}"].tone.gray -= 51 if @sprites["#{i}"].tone.gray > 0
      else
        @sprites["#{i}"].tone.gray += 51 if @sprites["#{i}"].tone.gray < 255
      end
    end
    # sets the index
    if @oldindex != @index
      @sprites["#{@index}"].x -= 6
      @oldindex = @index
    end
  end

  def pbEndScene
    # disposes the sprite hash
    pbHideMenu
    pbDisposeSpriteHash(@sprites)
    @viewport.dispose
  end

  def pbRefresh
  end
end
#-------------------------------------------------------------------------------
#  Main class used to handle the logic of the pause menu
#-------------------------------------------------------------------------------
class PokemonPauseMenu
  def initialize(scene)
    @scene = scene
  end

  def pbShowMenu
    #@scene.pbRefresh
    @scene.pbShowMenu
  end

  def pbStartPokemonMenu
    # loads up the scene
    @scene.pbStartScene
    @scene.pbShowMenu
    loop do
      # main loop
      Graphics.update
      Input.update
      @scene.update
      if Input.repeat?(Input::DOWN)
        @scene.index += 1
        @scene.index = 0 if @scene.index > @scene.entries.length - 1
        $PokemonTemp.menuLastChoice = @scene.index
        pbSEPlay("SE_Select1")
      elsif Input.repeat?(Input::UP)
        @scene.index -= 1
        @scene.index = @scene.entries.length - 1 if @scene.index < 0
        $PokemonTemp.menuLastChoice = @scene.index
        pbSEPlay("SE_Select1")
      elsif Input.trigger?(Input::C)
        MenuHandlers.runAction(@scene.entries[@scene.index],@scene)
      end
      break if @scene.close || Input.trigger?(Input::B)
    end
    # used to dispose of the scene
    @scene.pbEndScene if @scene.endscene
  end  
end
#-------------------------------------------------------------------------------
#  Your own entries for the pause menu
#
#  How to use
#
#  MenuHandlers.addEntry(:name,"button text","icon name",proc{|menu|
#    # code you want to run
#    # when the entry in the menu is selected
#  },proc{ # code to check if menu entry is available })
#-------------------------------------------------------------------------------
# PokeDex
MenuHandlers.addEntry(:POKEDEX,_INTL("Pokédex"),"menuPokedex",proc{|menu|
  if DEXDEPENDSONLOCATION
    pbFadeOutIn(99999){
      scene = PokemonPokedex_Scene.new
      screen = PokemonPokedexScreen.new(scene)
      screen.pbStartScreen
      menu.refresh
    }
  else
    if $PokemonGlobal.pokedexViable.length==1
      $PokemonGlobal.pokedexDex = $PokemonGlobal.pokedexViable[0]
      $PokemonGlobal.pokedexDex = -1 if $PokemonGlobal.pokedexDex==$PokemonGlobal.pokedexUnlocked.length-1
      pbFadeOutIn(99999){
        scene = PokemonPokedex_Scene.new
        screen = PokemonPokedexScreen.new(scene)
        screen.pbStartScreen
        menu.refresh
      }
    else
      pbFadeOutIn(99999){
        scene = PokemonPokedexMenu_Scene.new
        screen = PokemonPokedexMenuScreen.new(scene)
        screen.pbStartScreen
        menu.refresh
      }
    end
  end
},proc{ return $Trainer.pokedex && $PokemonGlobal.pokedexViable.length > 0 })
# Party Screen
MenuHandlers.addEntry(:POKEMON,_INTL("Pokémon"),"menuPokemon",proc{|menu|
  sscene = PokemonParty_Scene.new
  sscreen = PokemonPartyScreen.new(sscene,$Trainer.party)
  hiddenmove = nil
  pbFadeOutIn(99999) { 
    hiddenmove = sscreen.pbPokemonScreen
    if hiddenmove
      menu.pbEndScene
      menu.endscene = false
    end
  }
  if hiddenmove
    Kernel.pbUseHiddenMove(hiddenmove[0],hiddenmove[1])
    menu.close = true
  end
},proc{ return $Trainer.party.length > 0 })
# Bag Screen
MenuHandlers.addEntry(:BAG,_INTL("Bag"),"menuBag",proc{|menu|
  item = 0
  scene = PokemonBag_Scene.new
  screen = PokemonBagScreen.new(scene,$PokemonBag)
  pbFadeOutIn(99999) { 
  item = screen.pbStartScreen 
  if item > 0
    menu.pbEndScene
    menu.endscene = false
  end
  }
  if item > 0
    Kernel.pbUseKeyItemInField(item)
    menu.close = true
  end
},proc{ return true })
MenuHandlers.addEntry(:QUESTS,_INTL("Quests"),"menuQuests",proc{|menu|
  pbFadeOutIn(99999){ 
    scene = QuestScene.new
    screen = QuestScreen.new(scene)
    screen.pbStartScreen
    @scene.pbRefresh
  }
},proc{ return true })
# PokeGear
MenuHandlers.addEntry(:POKEGEAR,_INTL("Pokégear"),"menuPokegear",proc{|menu|
  scene = PokemonPokegear_Scene.new
  screen = PokemonPokegearScreen.new(scene)
  pbFadeOutIn(99999) { 
    screen.pbStartScreen
  }
},proc{ return $Trainer.pokegear })
# Trainer Card
MenuHandlers.addEntry(:TRAINER,_INTL("\\pn"),"menuTrainer",proc{|menu|
  scene = PokemonTrainerCard_Scene.new
  screen = PokemonTrainerCardScreen.new(scene)
  pbFadeOutIn(99999) { 
    screen.pbStartScreen
  }
},proc{ return true })
# Save Screen
MenuHandlers.addEntry(:SAVE,_INTL("Save"),"menuSave",proc{|menu|
  scene = PokemonSave_Scene.new
  screen = PokemonSaveScreen.new(scene)
  menu.pbEndScene
  menu.endscene = false
  if screen.pbSaveScreen
    menu.close = true
  else
    menu.pbStartScene
    menu.pbShowMenu
    menu.close = false
  end
},proc{ return !$game_system || !$game_system.save_disabled && !(pbInSafari? || pbInBugContest?)})
# Quit Safari-Zone
MenuHandlers.addEntry(:QUIT,_INTL("\\contest"),"menuQuit",proc{|menu|
  if pbInSafari?
    if Kernel.pbConfirmMessage(_INTL("Would you like to leave the Safari Game right now?"))
      menu.pbEndScene
      menu.endscene = false
      menu.close = true
      pbSafariState.decision=1
      pbSafariState.pbGoToStart
    end
  else
    if Kernel.pbConfirmMessage(_INTL("Would you like to end the Contest now?"))
      menu.pbEndScene
      menu.endscene = false
      menu.close = true
      pbBugContestState.pbStartJudging
      return
    end
  end
},proc{ return pbInSafari? || pbInBugContest? })
# Options Screen
MenuHandlers.addEntry(:OPTIONS,_INTL("Options"),"menuOptions",proc{|menu|
  scene = PokemonOption_Scene.new
  screen = PokemonOptionScreen.new(scene)
  pbFadeOutIn(99999) {
    screen.pbStartScreen
    pbUpdateSceneMap
  }
},proc{ return true })
# Debug Menu
MenuHandlers.addEntry(:DEBUG,_INTL("Debug"),"menuDebug",proc{|menu|
  pbFadeOutIn(99999) { 
    pbDebugMenu
    menu.refresh
  }
},proc{ return $DEBUG })

Replace with default neo pause menu script

 

[NoNoNever]

Found a little bug game crashing with NoMethodeerror after closing the Quest Ui (after adding Neo Pause Menu fix)

Fix: Search in the new Neo PauseMenu (for v17.x) Script for MenuHandlers.addEntry(:QUESTS,_INTL("Quests"),"menuQuests",proc{|menu|

and replace

MenuHandlers.addEntry(:QUESTS,_INTL("Quests"),"menuQuests",proc{|menu|
pbFadeOutIn(99999){
scene = QuestScene.new
screen = QuestScreen.new(scene)
screen.pbStartScreen
@scene.pbRefresh
}
},proc{ return true })

with

# Quest Menu
MenuHandlers.addEntry(:QUESTS,_INTL("Quests"),"menuQuests",proc{|menu|
scene = QuestScene.new
screen = QuestScreen.new(scene)
pbFadeOutIn(99999) {
screen.pbStartScreen
}
},proc{ return true })

 

[#Not Important]

Found a little bug game crashing with NoMethodeerror after closing the Quest Ui (after adding Neo Pause Menu fix)

Fix: Search in the new Neo PauseMenu (for v17.x) Script for MenuHandlers.addEntry(:QUESTS,_INTL("Quests"),"menuQuests",proc{|menu|

and replace

MenuHandlers.addEntry(:QUESTS,_INTL("Quests"),"menuQuests",proc{|menu|
pbFadeOutIn(99999){
scene = QuestScene.new
screen = QuestScreen.new(scene)
screen.pbStartScreen
@scene.pbRefresh
}
},proc{ return true })

with

# Quest Menu
MenuHandlers.addEntry(:QUESTS,_INTL("Quests"),"menuQuests",proc{|menu|
scene = QuestScene.new
screen = QuestScreen.new(scene)
pbFadeOutIn(99999) {
screen.pbStartScreen
}
},proc{ return true })

Thanks , fixed

 

[weezyfish123]

For me its just giving an error the instant I try and access the pause menu, with both fixes above put into the neo pause menu. It gives this error below:

Spoiler:

---------------------------
Error
---------------------------
Script 'PScreen_PauseMenu' line 48: NoMethodError occurred.

undefined method `commands=' for nil:NilClass

from 'PScreen_PauseMenu' line 48 in `pbShowCommands'
from 'SimpQuestUI' line 1172 in `pbStartPokemonMenu'
from 'SimpQuestUI' line 1171 in `loop'
from 'SimpQuestUI' line 1312 in `pbStartPokemonMenu'
from 'Scene_Map' line 127 in `call_menu'
from 'Scene_Map' line 213 in `quicksave_update'
from 'QuicksaveScript' line 4 in `update'
from 'Scene_Map' line 234 in `main'
from 'Scene_Map' line 231 in `loop'
from 'Scene_Map' line 236 in `main'
from 'MarinUtilities' line 1174 in `call'
from 'MarinUtilities' line 1174 in `main'
---------------------------
OK
---------------------------

Im gonna try and figure out whats causing this, but if anyone off the bat knows lmk. If I find the fix, ill edit this post

 

[NoNoNever]

https://pastebin.com/1XChCFaP

 

[rikked777]

Hey, I recently update my project to Essentials V.18.1, and the quest script has broken.

Gives me a Syntax Error at line 631.
Which reads: QUEST_GRAPHICS_PATH = "Graphics/Pictures/Quest UI/"

Which is weird, cause it only defines the path.

Was hoping you could shine a light on the situation, as I can' t seem to solve it myself.

 

[derFischae]

Hey, I recently update my project to Essentials V.18.1, and the quest script has broken.

Gives me a Syntax Error at line 631.
Which reads: QUEST_GRAPHICS_PATH = "Graphics/Pictures/Quest UI/"

Which is weird, cause it only defines the path.

Was hoping you could shine a light on the situation, as I can' t seem to solve it myself.

I tested it myself, but there was no syntax error. Maybe you should remove the script and copy the code and original script pbs from above again.

 

[bo4p5687]

Hey, I recently update my project to Essentials V.18.1, and the quest script has broken.

Gives me a Syntax Error at line 631.
Which reads: QUEST_GRAPHICS_PATH = "Graphics/Pictures/Quest UI/"

Which is weird, cause it only defines the path.

Was hoping you could shine a light on the situation, as I can' t seem to solve it myself.

maybe, you missed the graphics, you don't put them in this folder.

 

[rikked777]

I tested it myself, but there was no syntax error. Maybe you should remove the script and copy the code and original script pbs from above again.

Hey I seem to have fixed it, but with a slightly different approach.

I initially copied the script from quests.zip, which gave me the syntax error, so I thought, hell, perhaps if I copy it from the thread under "the script", it might function differently. And well, it did. It now fuctions as before. Many thanks.

 

[derFischae]

Hey I seem to have fixed it, but with a slightly different approach.

I initially copied the script from quests.zip, which gave me the syntax error, so I thought, hell, perhaps if I copy it from the thread under "the script", it might function differently. And well, it did. It now fuctions as before. Many thanks.

Thank you for letting me know that the code in questScript.txt contains an error. I updated the main post, so that new users will also know your remark.

 

[marquif]

I am getting this error whenever I try and open the quest menu after accepting a quest. Does any of you know how to solve it??

---------------------------
Pokemon Essentials
---------------------------
Exception: RuntimeError

Message: Script error within event 3, map 33 (M's House):

Exception: TypeError

Message: Section041:559:in `[]'no implicit conversion from nil to integer

***Full script:

pbViewQuests


Interpreter:243:in `pbExecuteScript'

Intl_Messages:559:in `get'

Intl_Messages:670:in `get'

Intl_Messages:707:in `pbGetMessage'

Quests:792:in `pbDrawQuestInfo'

Quests:751:in `each'

Quests:751:in `pbDrawQuestInfo'

Quests:735:in `pbDrawQuestsList'

Quests:681:in `pbDrawSections'

Quests:625:in `pbStartScene'



Interpreter:276:in `pbExecuteScript'

Interpreter:1606:in `command_355'

Interpreter:494:in `execute_command'

Interpreter:193:in `update'

Interpreter:106:in `loop'

Interpreter:198:in `update'

Scene_Map:103:in `follow_update'

Scene_Map:101:in `loop'

Scene_Map:114:in `follow_update'

PokemonFollowing:1551:in `update'



This exception was logged in

C:\Users\Michael\Saved Games/Pokemon Essentials/errorlog.txt.

Press Ctrl+C to copy this message to the clipboard.
---------------------------
OK
---------------------------

 

[derFischae]

I am getting this error whenever I try and open the quest menu after accepting a quest. Does any of you know how to solve it??

Spoiler:

---------------------------
Pokemon Essentials
---------------------------
Exception: RuntimeError

Message: Script error within event 3, map 33 (M's House):

Exception: TypeError

Message: Section041:559:in `[]'no implicit conversion from nil to integer

***Full script:

pbViewQuests


Interpreter:243:in `pbExecuteScript'

Intl_Messages:559:in `get'

Intl_Messages:670:in `get'

Intl_Messages:707:in `pbGetMessage'

Quests:792:in `pbDrawQuestInfo'

Quests:751:in `each'

Quests:751:in `pbDrawQuestInfo'

Quests:735:in `pbDrawQuestsList'

Quests:681:in `pbDrawSections'

Quests:625:in `pbStartScene'



Interpreter:276:in `pbExecuteScript'

Interpreter:1606:in `command_355'

Interpreter:494:in `execute_command'

Interpreter:193:in `update'

Interpreter:106:in `loop'

Interpreter:198:in `update'

Scene_Map:103:in `follow_update'

Scene_Map:101:in `loop'

Scene_Map:114:in `follow_update'

PokemonFollowing:1551:in `update'



This exception was logged in

C:\Users\Michael\Saved Games/Pokemon Essentials/errorlog.txt.

Press Ctrl+C to copy this message to the clipboard.
---------------------------
OK
---------------------------

Unfortunately, I can not reproduce your error message. We need more informations to help you. What Pokemon Essentials Version do you use? And did you copied the latest version of this script from the spoiler section in the instructions above?

Have you changed the quests pbs file? What happens if you use the original quests pbs file, which you can download above?

What Quests are active while testing? Please make also sure that you did not activate a quest with an id that does not exist.
Have you tried to view the quest with "pbViewQuests" while there are no quests active? What happens then? It should show the message "You haven't discovered any quests yet".

I personally would guess that you activated a quest with an quest id, where there is no entry in quest.txt for.

 

[Yung Rocks]

Hi, thanks a lot for this script.
I have the exact same error as the previous person. I'm using Essentials 18.1, with the latest version of this script.

This is my quests pbs file:

Spoiler:

[1]
Name="Cleffa Rescue"
QuestDescription="Find the lost Cleffa and bring it to her owner."
Stage1="Find the lost Cleffa."
StageLocation1=33
Stage2="Bring Cleffa back to her owner."
StageLocation2=33
Reward="$Trainer.money+=200"
RewardDescription="Moneys!"
CompletedMessage="Cleffa rescued!"
FailedMessage="Can't be failed"

I trigger an event in game that starts the quest, then I open the quest log and this error shows up:

Spoiler:

Exception: TypeError

Message: no implicit conversion from nil to integer

Backtrace:

Intl_Messages:559:in `[]'
Intl_Messages:559:in `get'
Intl_Messages:674:in `get'
Intl_Messages:711:in `pbGetMessage'
QuestScript:835:in `pbDrawQuestInfo'
QuestScript:794:in `each'
QuestScript:794:in `pbDrawQuestInfo'
QuestScript:778:in `pbDrawQuestsList'
QuestScript:724:in `pbDrawSections'
QuestScript:669:in `pbStartScene'

The quest log has just opened when the error happens, and I can see my quest in it.
Using pbViewQuests() without any active quest gives me the correct message that I don't have any quest yet.

I hope it's not just incompatibility between the script and 18.1 :<

Thanks in advance

Edit1: I've completed the quest then opened the log, it works fine. I have it in the completed quests section, with all its infos displayed. The issue seems to be with active quests..?

Edit2: it's because of the StageLocation. I changed them to "nil" and it works fine. I can't get them to work with either the ID or the name of the map, I get various errors.
So far it doesn't work with StageLocation1=33, StageLocation1="33", StageLocation1=Valley, StageLocation1="Valley".

Edit3: OK, I've made a good step forward by making the quest advance to stage 1 right after being activated. I assumed it would begin at stage 1 by default, but it doesn't seem to be the case. Now the last thing I'm struggling with is locations: "nil" is valid, but StageLocation1="Valley" is incorrect and StageLocation1=33 gives me the "no implicit conversion from nil to integer" error again. I don't really know what to do, is my "Valley" not defined properly despite being an existing map of my game?

 

[amberstar2604]

Is it possible for this to work in Essentials V18.1?

 

[Derxwna Kapsyla]

I can confirm that v18.1 is bugged on my end as well. I can't seem to figure out what the bug is myself, but I'm getting the same error as the above.

The only thing that works is setting the "StageLocation1=" value to "nil". I've tried various numerical values (including numbers both present and not present in my game as maps) and map names (eg. Pallet Town, New Bark Town, Coolsville, etc), but none of it worked.

 

[derFischae]

I can confirm that v18.1 is bugged on my end as well. I can't seem to figure out what the bug is myself, but I'm getting the same error as the above.

The only thing that works is setting the "StageLocation1=" value to "nil". I've tried various numerical values (including numbers both present and not present in my game as maps) and map names (eg. Pallet Town, New Bark Town, Coolsville, etc), but none of it worked.

Is it possible for this to work in Essentials V18.1?

Hi, thanks a lot for this script.
I have the exact same error as the previous person. I'm using Essentials 18.1, with the latest version of this script.

This is my quests pbs file:

Spoiler:

[1]
Name="Cleffa Rescue"
QuestDescription="Find the lost Cleffa and bring it to her owner."
Stage1="Find the lost Cleffa."
StageLocation1=33
Stage2="Bring Cleffa back to her owner."
StageLocation2=33
Reward="$Trainer.money+=200"
RewardDescription="Moneys!"
CompletedMessage="Cleffa rescued!"
FailedMessage="Can't be failed"

I trigger an event in game that starts the quest, then I open the quest log and this error shows up:

Spoiler:

Exception: TypeError

Message: no implicit conversion from nil to integer

Backtrace:

Intl_Messages:559:in `[]'
Intl_Messages:559:in `get'
Intl_Messages:674:in `get'
Intl_Messages:711:in `pbGetMessage'
QuestScript:835:in `pbDrawQuestInfo'
QuestScript:794:in `each'
QuestScript:794:in `pbDrawQuestInfo'
QuestScript:778:in `pbDrawQuestsList'
QuestScript:724:in `pbDrawSections'
QuestScript:669:in `pbStartScene'

The quest log has just opened when the error happens, and I can see my quest in it.
Using pbViewQuests() without any active quest gives me the correct message that I don't have any quest yet.

I hope it's not just incompatibility between the script and 18.1 :<

Thanks in advance

Edit1: I've completed the quest then opened the log, it works fine. I have it in the completed quests section, with all its infos displayed. The issue seems to be with active quests..?

Edit2: it's because of the StageLocation. I changed them to "nil" and it works fine. I can't get them to work with either the ID or the name of the map, I get various errors.
So far it doesn't work with StageLocation1=33, StageLocation1="33", StageLocation1=Valley, StageLocation1="Valley".

Edit3: OK, I've made a good step forward by making the quest advance to stage 1 right after being activated. I assumed it would begin at stage 1 by default, but it doesn't seem to be the case. Now the last thing I'm struggling with is locations: "nil" is valid, but StageLocation1="Valley" is incorrect and StageLocation1=33 gives me the "no implicit conversion from nil to integer" error again. I don't really know what to do, is my "Valley" not defined properly despite being an existing map of my game?

I am getting this error whenever I try and open the quest menu after accepting a quest. Does any of you know how to solve it??

Hey I seem to have fixed it, but with a slightly different approach.

I initially copied the script from quests.zip, which gave me the syntax error, so I thought, hell, perhaps if I copy it from the thread under "the script", it might function differently. And well, it did. It now fuctions as before. Many thanks.

maybe, you missed the graphics, you don't put them in this folder.

XVR is also working on the Simple Quest System. He wants to update it for Pokemon Essentials v18.1. So, I would say, you can contact him to work together, he also needs help.

His Pokecommunity profile is XVR, see https://www.pokecommunity.com/members/868386
He is also on the pokecommunity discord channel. Unfortunately, I don't know his discord account. But I maybe his name is also XVR.

 

[danimalm]

I haven't tested things extensively yet, but I'm happy to look into the issues people are having in v18.1. So far I've followed the instructions at the top (albeit I had to make a small change on line 1174 of the script from 'DEXDEPENDSONLOCATION' to 'USE_CURRENT_REGION_DEX') and it seems to be working fine. I can get the Quests option onto my menu and I can activate the basic quests defined in the quests.txt without a problem, so happy to play around with this more as my game develops and see if I can help others down the line.

 

[MessiDuvidoso]

Can you update to v18?