[17.2] B2W2 Style Habitat List

[Boonzeet]

Habitats

A B2W2-alike Habitat List for Essentials, showing players a list of explored areas and the Pokémon available in them with Pokédex and Region Map integration.

Steps to Setup

Download this ZIP file. Extract this and move the Habitats folder to Graphics/Pictures.

Copy and add the script Habitats.rb above main (edit with Notepad if you don't have a script editor).

Then make these changes to PScreen_RegionMap:

Spoiler:

UNDER this line:

@sprites["mapbottom"].mapdetails  = pbGetMapDetails(@mapX,@mapY)

Add this

# HABITAT START
    @sprites["habitat_button"] = IconSprite.new(Graphics.width-164, 2, @viewport)
    @sprites["habitat_button"].setBitmap("Graphics/Pictures/Habitats/menu_button")
    @sprites["habitat_button"].visible = $Trainer.pokedex && $Trainer.habitatData && $Trainer.habitatData.size > 0
# END

ABOVE this line

 elsif Input.trigger?(Input::C) && mode==1 # Choosing an area to fly to

Add this

elsif Input.trigger?(Input::F5) && $Trainer.habitatData && $Trainer.pokedex
        playerpos = (!$game_map) ? nil : pbGetMetadata($game_map.map_id,MetadataMapPosition)
        if !playerpos
          mapindex = 0
        elsif @region>=0 && @region!=playerpos[0] && @mapdata[@region]
          mapindex = @region
        else
          mapindex = playerpos[0]
        end
        if $DEBUG && Input.trigger?(Input::CTRL)
          Kernel.pbMessage("Location: [#{mapindex}, #{@mapX}, #{@mapY}]")
        else
          find = HabitatConfig::RegionOverride.find { |key, value| key[0] == mapindex && key[1] == @mapX && key[2] == @mapY}
          if find.nil?
            hab = Habitats.getIndexByRegionCoords(@mapX,@mapY,mapindex,@mapdata)
          else
            hab = Habitats.getIndexByMapID(find[1])
          end
          if hab > -1
            pbPlayDecisionSE
            oldsprites = pbFadeOutAndHide(@sprites)
            ret = -1
            scene = HabitatDetailScene.new
            screen = HabitatDetailScreen.new(scene)
            ret = screen.pbStartScreenSingle(hab)
            pbFadeInAndShow(@sprites, oldsprites)
          else
            pbPlayBuzzerSE
          end
        end

Then lastly, make these changes to PScreen_PokedexMain

Spoiler:

UNDER these lines

@sprites["searchcursor"] = PokedexSearchSelectionSprite.new(@viewport)
@sprites["searchcursor"].visible = false

Add this:

# HABITAT START
    @sprites["habitat_button"] = IconSprite.new(Graphics.width-58, 6, @viewport)
    @sprites["habitat_button"].setBitmap("Graphics/Pictures/Habitats/menu_button")
    @sprites["habitat_button"].visible = $Trainer.habitatData && $Trainer.habitatData.size > 0
    # END

Then ABOVE these lines:

elsif Input.trigger?(Input::C)
          if $Trainer.seen[@sprites["pokedex"].species]

Add this:

elsif Input.trigger?(Input::F5) && $Trainer.habitatData  && $Trainer.habitatData.size > 0
          pbLoadHabitatList

Config
There are 3 places at the top of the file to configure Habitats.

HabitatConfig::Types
These should not change much, unless you have other non-standard encounter types to enclude. These are groups of Encounter Types to include in each Habitat.

HabitatConfig::Habitats

[[49,50], [:grass,:surf,:fish]]

This is a an array with two arrays inside it. The first part is a list of Map IDs associated with the area. Please include all of them! The second is the list of Habitat Encounter types defined above. It's best not to mix Place and Grass as they use the same icon.

HabitatConfig::RegionOverride

[0,15,6] => 34,    # Ice Cave

A hash of overrides for the region map. This is for places that appear along a route, like Ice Cave in the demo project. The left hand side of the hash key is an array [regionNumber, regionMapX, regionMapY] and the right hand side is any one map from the Habitat.

To get the left hand side value quickly, press CTRL+F while on the region map view.

How to Use
Using is quite simple. Once the Trainer has been given the Pokedex, they can press F from the Pokedex List screen or on a square in the region map to view Habitat data if they have visited that area. Enjoy!

IMPORTANT: When changes have been made to the Habitat data, you'll need to add an NPC with a script command Habitats.setup for existing saves. This will refresh all the Habitats data, but reset the 'viewed' status for Habitats that have been viewed.

The only way to retain the viewed data for existing saves is to run Habitats.update - but the order of Habitats must be the same as it was before, otherwise errors will occur. New Habitats can be added onto the end of the list.

Customisation
This script supports extensions with Phenomenon. To use, just uncomment the lines associated.

Each region gets a unique thumbnail. These graphics are located in Graphics/Pictures/Habitats/mapthumbRegionX.png.

Credit must be given if used.

Possible Bugs

Some users are reporting "Incorrect kRGB chunk" errors. This appears to be an error in older versions of RGSS DLL and RMXP handling PNG files. Please post your error log from C:/Users/{your username}/Saved Games/{your project}/errorlog.txt so I can see more detail if this does occur.

 

[Boonzeet]

Still getting to grips with Mega. The file link was outdated but has been updated now. Please download THIS zip file to use, or the one now linked in the post.

 

[HarmonyConcept]

Hey, thank you for this!

Two quick remarks:
- Line 53 of the main script (#EncounterTypes::PhenomenonGrass) should be commented out if you're not using Phenomena;
- Folder "Habitats" in Pictures should be renamed to "Habitat"

 

[Boonzeet]

Hey, thank you for this!

Two quick remarks:
- Line 53 of the main script (#EncounterTypes::PhenomenonGrass) should be commented out if you're not using Phenomena;
- Folder "Habitats" in Pictures should be renamed to "Habitat"

Neither of these need doing anymore - I uploaded an outdated script.

All references have been fixed and the Phenomenon line commented out. Sorry for the mistake!

 

[ArchyTheArc]

this is a fantastic script and recreation; so one minor bug or issue, is if i add more habitat types, the habitat list doesnt stop at 3 or if i dont define all of them in color it crashes.

anyway to stop it on each habitat at the 3 as you have it? besides that it works fantastic, i do get incorrect kGRD (something along the lines of that) but thats just how i probably copied it across, and probably not on your side (first time i've ever encountered it besides on my own custom stuff)

 

[Zeak6464]

i'm getting "incorrect kGRD chunk index value" errors

 

[Boonzeet]

this is a fantastic script and recreation; so one minor bug or issue, is if i add more habitat types, the habitat list doesnt stop at 3 or if i dont define all of them in color it crashes.

anyway to stop it on each habitat at the 3 as you have it? besides that it works fantastic, i do get incorrect kGRD (something along the lines of that) but thats just how i probably copied it across, and probably not on your side (first time i've ever encountered it besides on my own custom stuff)

The script is only configured to support 3 habitat types at once. If you need more, you'll need to make some scripting changes. What do you mean by define them in color?

On the kGRD, I've never encountered this. I've just tested this on a fresh version of Essentials and it's fine - are you using 17.2 and legit RMXP, and what other scripts do you have?

i'm getting "incorrect kGRD chunk index value" errors

I've never seen this issue with RMXP before. Where are you getting these errors, and how did you copy the script across? What version of RMXP are you using?

BOTH USERS: Please upload your error log file if you have one as this is not a standard Essentials or Ruby error.
This will be located at C:\Users\{your username}\Saved Games\{your game}\errorlog.txt

 

[TheBIGFriv]

Hi! Is there a way to make this compatible with Marins Better Region Map? And how would I make it so that you have to talk to an event to open the Habitat Menu, instead of doing it through the dex?

Found out how to do the last part actually!
Seems to work fairly well so far even with the Better Region Map thing.
Havent tested it through the dex or the region map directly, but thats fine, as I wanted to use it through an event from the start. :)

 

[Boonzeet]

Hi! Is there a way to make this compatible with Marins Better Region Map? And how would I make it so that you have to talk to an event to open the Habitat Menu, instead of doing it through the dex?

Found out how to do the last part actually!
Seems to work fairly well so far even with the Better Region Map thing.
Havent tested it through the dex or the region map directly, but thats fine, as I wanted to use it through an event from the start. :)

It *should* work with Marin's map, let me know if you encounter any issues with it. It should be fairly easy to tweak it to work otherwise.

I think you've said you've already solved it, but any script tag calling pbLoadHabitatList will work!

 

[Richard PT]

i'm getting "incorrect kGRD chunk index value" errors too like zeak. My rpg maker xp v102 and essentials v17.2. And i don't have any script that messes with the Dex, but, i have advance dex by FL, but i don't think that they are "clashing with each other".

 

[juliorain]

We've chatted on RC, but again, highly recommend this! Works like a charm!

 

[ArchyTheArc]

The script is only configured to support 3 habitat types at once. If you need more, you'll need to make some scripting changes. What do you mean by define them in color?]

Hmm thought so, the colour was about the boxes on the habitat screen but i figured a fix;
in "def drawItem(index, count, rect)"

HabitatConfig::TypeOrder.each do |n|

Under that i added;

next if n==:

then any of my added types with || after each one. worked like a charm.

also in regard to kRGD (along those lines) its down to the files colors and only happens on the ones you've got set to a certain amount (the background, habitat icons etc.) simply just making a new file without color limitations fixes it. probably has an issue with zips too, only ideas though.

 

[CharizardThree3]

This Script is Cool! Would love if it had a BW Styled Graphical Overhaul,(I have a resource for the BW pokedex Entry)

 

[Boonzeet]

Hmm thought so, and its not exactly color but the bit where it changes the habitat tile color based on the type (on the habitat list under the ! and pokeballs) if not defined there its crashes but clearly not the bug here. (in "def drawEncounterIcon(i, type, encounter, rect)") Mid righting this i figured a fix;
in "def drawItem(index, count, rect)"

HabitatConfig::TypeOrder.each do |n|

Under that i added;

break if n==:

then any of my added types with || after each one. worked like a charm.

also in regard to kRGD (along those lines) its down to the files colors and only happens on the ones you've got set to a certain amount (the background, habitat icons etc.) simply just making a new file without color limitations fixes it. probably has an issue with zips too, only ideas though.

Instead of doing this, just add your custom types to HabitatConfig::TypeOrder

 

[Boonzeet]

i'm getting "incorrect kGRD chunk index value"

also in regard to kRGD (along those lines) its down to the files colors

i'm getting "incorrect kGRD chunk index value" errors

What a bizarre error. It appears to be to do with how some editions of RMXP handle PNG indexing.

Please can you download v1.1 here and see if this resolves the issue.

 

[ArchyTheArc]

Instead of doing this, just add your custom types to HabitatConfig::TypeOrder

Strange they were already there which is what i thought was breaking it (i did edit my message but you had posted, i changed break to next just incase any after that i wanted to show they wouldnt) it works fine like this.

Did ask it in the past post (ill remove it from it since i dont wanna repeat myself) in the town map/region some sections wont show (map extras) or even with fly wont let you until you've been there, the script seems to just show all so is there a way to hide areas until say a switch or a new metadata is on?

 

[Boonzeet]

in the town map/region some sections wont show (map extras) or even with fly wont let you until you've been there, the script seems to just show all so is there a way to hide areas until say a switch or a new metadata is on?

This is the same behaviour as Gen 5 - Habitats are only visible once one map belonging to the habitat has been visited. The determining code for this is in two places: self.getHabitatList for the Pokedex and self.getIndexByRegionCoords for the region map. The first script filters out options for the menu list based on 'Habitat.visited?' and the second returns -1 (not found) index for region map if the maps aren't visited. Feel free to add if statements instead.

 

[felidaex]

Do you intend to do it for 16.2?
it's pretty good

 

[ArchyTheArc]

Do you intend to do it for 16.2?
it's pretty good

i already use it for 16.2; minus finding where to put it in the pokedex the rest is all compatible.

 

[Ulithium_Dragon]

i already use it for 16.2; minus finding where to put it in the pokedex the rest is all compatible.

I've made enough edits to this script that I'm having trouble figuring out where to put it.
Where did you put the Pokedex section on 16.2? I tried putting it below @sprites["searchbg"].visible=false in the PScreen_Pokedex section, but I'm not sure that's the right place.