- 1,509
- Posts
- 10
- Years
- Seen today
Enhanced UI for v20.1
NOTICE:
This plugin is now deprecated, and no longer supported. The contents of this plugin have been updated and improved upon for Essentials v21.1, and split up into two different plugins. For the "Pokemon UI" content, you may install the Enhanced Pokemon UI plugin for v21.1. For the "Battle UI" content, you may install the Enhanced Battle UI plugin for v21.1 as an add-on to the Deluxe Battle Kit. Use these versions instead, if possible. I will leave the download link and installation instructions for this version below for the time being. I may remove these at a later date, however.
-DOWNLOAD LINK-
Installation
Spoiler:
- Download and install the Essentials Deluxe plugin. To reiterate, this is required for this plugin to work.
- Download this plugin using the link provided, and extract its contents to your root Essentials folder.
- Use the Settings file located in this plugin's folder to adjust things to your liking.
Tutorials
Pokemon UISpoiler:Party Ball Icons
Spoiler:
In base Essentials, the party screen will always display a generic Poke Ball icon next to each Pokemon. With this plugin however, each Pokemon will now have a graphic displayed matching the particular Poke Ball type that it was caught in. The graphics for each Poke Ball type is stored inGraphics/Plugins/Enhanced UI/Party Ball
. If you'd like to add graphics for new ball types, or replace the provided graphics with something else, you may do so here. This plugin comes with graphics for all of the Poke Ball types that are defined in base Essentials - including the Beast Ball. There is also a graphic included for the Park Ball, which only appeared once in the series for use in the Pal Park in Gen 4. This ball isn't found in Essentials by default, but it's there if you want to use it.
If you decide that you'd rather not display these Party Ball icons, or you'd prefer to keep it the way it functions normally in base Essentials, you may turn this feature off by simply opening the Settings file in the plugin folder, and settingSHOW_PARTY_BALL
to false.
This feature is also compatible with the (broken link removed) plugin, and will display the Party Ball icons exactly as it does in base Essentials, as seen below:
IV Ratings
Spoiler:The quality of a Pokemon's IV's may now be displayed in both the Summary and Storage screens. However, this isn't displayed with exact numbers. Instead a graphic is displayed to indicate the general quality of the stat. There's two different styles in which this may be done.
The default style uses different colored stars to indicate quality, ranging from bronze to gold. The second style uses a letter grading system instead, from "F" up to "S". Here's what both styles look like in-game:
Here's a breakdown of what each IV Rating indicates:
- Empty Star, or "F" Grade
Indicates this stat has an IV of 0.
- Bronze Star, or "D" Grade
Indicates this stat has an IV in the range of 1-15.
- Silver Star, or "C" Grade
Indicates this stat has an IV in the range of 16-24.
- Gold Star, or "B" Grade
Indicates this stat has an IV in the range of 25-29.
- Large Gold Star, or "A" Grade
Indicates this stat has an IV of 30.
- Large Orange Star, or "S" Grade
Indicates this stat has an IV of 31.
To control which style displays in your game, you may do so by settingIV_DISPLAY_STYLE
in the plugin settings to 0 for the star layout, or 1 for letters. If you'd prefer not to show IV Ratings in the Summary screen at all, you may toggle this off by settingSUMMARY_IV_RATINGS
to "false" in the plugin settings.
In addition to the Summary display, IV Ratings may also display in the Pokemon Storage screen. Here, the star or letter graphics will be displayed in the bottom left corner of the display window of the Pokemon's sprite. They will be listed in the order that the Pokemon's stats are listed in the Summary. If you'd prefer not to show IV Ratings in the Storage screen, you may toggle this off by settingSTORAGE_IV_RATINGS
to "false" in the plugin settings.
If you want to call this IV Rating display to be used in another UI, you can do so by simply using
Where the arguments require the following:Code:pbDisplayIVRatings(pokemon, overlay, xpos, ypos, horizontal)
- A Pokemon object.
- The bitmap that this display should be drawn over (usually an overlay bitmap in most UI's).
- The X and Y positions for this display.
- Whether or not the display should align horizontally, like in the Storage screen (true), or vertically, like in the Summary screen (false).
Finally, if you have the (broken link removed) or (broken link removed) plugins installed, this plugin will automatically compensate for this and will display properly on either of these displays, as shown in the examples below:
Spoiler:
Happiness Meter
Spoiler:Usually, a Pokemon's happiness levels are hidden from the player, and they must visit an NPC to gauge this information. This plugin eliminates that need by implementing a feature in Page 1 of each Pokemon's Summary that displays a meter that indicates each Pokemon's happiness levels. This "meter" is a row of three heart icons. The more happy the Pokemon is, the more these hearts will fill up. Each full heart is the equivalent of roughly 80-85 happiness points, so three full hearts would mean the Pokemon has 240+ happiness points.
If you want to call this Happiness meter to be used in another UI, you can do so by simply using
Where the arguments require the following:Code:pbDisplayHappiness(pokemon, overlay, xpos, ypos)
- A Pokemon object.
- The bitmap that this display should be draw over (usually an overlay bitmap in most UI's).
- The X and Y positions for this display.
If you want to disable this meter from appearing, you may simply setSUMMARY_HAPPINESS_METER
to false in the plugin settings.
This functionality is also compatible with the (broken link removed) plugin, and will display Egg Groups in the Summary screen as such:
Egg Group Displays
Spoiler:Egg Groups are usually hidden from the player, but this plugins makes this information available in both the Summary and Pokedex screens. This plugin comes with a set of icons that are used for each Egg Group, similar to how type icons work. Every existing Egg Group has its own icon, and I've even included additional icons for compatibility with my Legendary Breeding plugin. Here's how this may look in-game:
If you'd prefer not to display this information in the Summary or Pokedex screens, you may disable either or both of these by settingSUMMARY_EGG_GROUPS
andPOKEDEX_EGG_GROUPS
to "false", respectively. These are found in the plugin Settings. Note that with Egg Groups displayed in the Pokedex, this information is only displayed for caught species. Species that have only been seen will not display Egg Group data.
The names used on each icon may not necessarily match up with how that Egg Group is named under the hood. This is because frankly, some of the official Egg Group names are just bad or confusing, and overlap with existing type or species names (Fairy, Ditto...) or aren't descriptive enough (Water1, Water2, Water3...). To address this, I've given each Egg Group a new name where I felt it was necessary. Note that these name changes are purely cosmetic, and only appear on the icons. Nothing is actually renamed in the code, so you can freely make up your own icons with different names if you'd prefer to call them something else.
Here's a breakdown of each Egg Group and what the display names will be on the icons:
- Monster => Displays as "Monster"
- Water1 => Displays as "Aquatic"
- Bug => Displays as "Insect"
- Flying => Displays as "Aerial"
- Field => Displays as "Field"
- Fairy => Displays as "Pixie"
- Grass => Displays as "Plant"
- Humanlike => Displays as "Humanoid"
- Water3 => Displays as "Shellbody"
- Mineral => Displays as "Mineral"
- Amorphous => Displays as "Enigma"
- Water2 => Displays as "Marine"
- Ditto => Displays as "Mimic"
- Dragon => Displays as "Draco"
- Undiscovered => Displays as "No Eggs"
- Genderless => Displays as "????"
Some species belong to one or more Egg Groups, but are incapable of breeding in that Egg Group due to lacking a gender. Because of this, Ditto is the only species that they may breed with. For these specific cases, I decided to display "????" as their Egg Group, since it may be misleading to list their real Egg Groups when they can't even breed with species in those groups. Here's an example of this:
If you want to call this Egg Group display to be used in another UI, you can do so by simply using
Where the arguments require the following:Code:pbDisplayEggGroups(pokemon, overlay, xpos, ypos, showDisplay, vertical)
- A Pokemon object or species ID.
- The bitmap that this display should be drawn over (usually an overlay bitmap in most UI's).
- The X and Y positions for this display.
- Whether you want to show the "Egg Group" background image behind the group icons that is used in the Pokedex display (true), or a string of text next to the icons like in the Summary screen (whatever string you want). Otherwise, leave this as nil or false.
- Whether or not you want the group icons to align vertically, like in the BW Summary screen (true), or horizontally, like in the vanilla Summary screen/Pokedex (false).
This functionality is also compatible with the (broken link removed) plugin, and will display Egg Groups in the Summary screen as such:
HGSS Shiny Leaf
Spoiler:HGSS introduced an often overlooked mechanic that allowed your follower Pokemon to rarely discover a "shiny leaf" while walking. Each shiny leaf the Pokemon found would be displayed in its Summary. Once the Pokemon found 6 shiny leaves, it would be fashioned into a crown that would be displayed instead. This is pretty much entirely just a fun little cosmetic feature, but there's no reason why it couldn't be reworked into something more meaningful. Regardless of how you choose to implement it - if at all - this plugin provides all the basic mechanics for its implementation, as well as all the necessary UI displays.
In both the Summary and Storage screens, the number of shiny leaves a Pokemon has accrued will be displayed. If the Pokemon has collected enough shiny leaves to make a crown, this crown will also be displayed. If you would like to hide either display, you may do so by settingSUMMARY_SHINY_LEAF
andSTORAGE_SHINY_LEAF
to "false", respectively. These may be found in the plugin Settings.
To set a shiny leaf on a Pokemon, a Debug tool has been provided to allow you to manually set the number of leaves that you want. This can be found within "Deluxe Options..." in the Pokemon's debug menu.
Setting shiny leaves on a pokemon through a script is as easy as just settingPokemon#shiny_leaf
equal to a number. If set to a number equal to or greater than 6, the Pokemon will be given a shiny crown. Note that all this plugin does is allow for the possibility of shiny leaves to be set and displayed. No mechanics are in place to actually give Pokemon shiny leaves through gameplay (such as followers finding them while walking). How to implement these shiny leaves is up for you to decide.
If you want to call this Shiny Leaf display to be used in another UI, you can do so by simply using
Where the arguments require the following:Code:pbDisplayShinyLeaf(pokemon, overlay, xpos, ypos, vertical)
- A Pokemon object.
- The bitmap that this display should be drawn over (usually an overlay bitmap in most UI's).
- The X and Y positions for this display.
- Whether or not you want the shiny leaf icons to align vertically (true), or horizontally, like in the Summary screen/Pokedex (false). Note that this doesn't have any effect on how the shiny crown is displayed.
Compatibility with the (broken link removed) or (broken link removed) plugins is also included for shiny leaf displays, and may appear on these screens as such:
Habitat Icons
Spoiler:Habitats is a feature added in FRLG that displays the type of environment that the species is typically found in when viewing them in the Pokedex, such as "Grassland", "Forest", "Cave", etc, accompanied by a graphic that illustrates that type of habitat. Essentials contains this data as well, but doesn't utilize it normally. However, this plugin introduces a feature that uses this habitat data to display the graphics associated with the habitat each species is normally found in, similar to FRLG. This can be seen while scrolling through each species in the Pokedex. Images for all of the habitats introduced in FRLG are included here.
If a Pokemon isn't found in any known habitat, or no graphic exists for the type of habitat that its found in, a question mark graphic will be displayed instead, to indicate that this species is found in an unknown habitat. If you don't want Habitat Icons to appear in the Pokedex like this, you may disable this by settingPOKEDEX_HABITAT_ICONS
to false in the plugin settings.
If you want to call this Habitat Icon display to be used in another UI, you can do so by simply using
Where the arguments require the following:Code:pbDisplayHabitat(pokemon, overlay, xpos, ypos, showDisplay)
- A Pokemon object or species ID.
- The bitmap that this display should be drawn over (usually an overlay bitmap in most UI's).
- The X and Y positions for this display.
- Whether you want to show the background image behind the habitat icons that is used in the Pokedex display (0 for red, 1 for blue). Otherwise, set it as false.
Body Shapes
Spoiler:Categorizing Pokemon by their body shape is a feature that was introduced in Gen 4, where a series of icons were created to indicate the type of body style each species has. While this feature is used by Essentials, the only time you can even see which body style a species has is while using the search feature of the Pokedex, and specifically choose to filter by a particular body shape. This plugin adds a feature to make this body shape icon visible in the Pokedex data of each species at all times, similar to how the species footprint is displayed. This gives the body shape feature a more visible presence, instead of being tucked away somewhere that is hardly ever seen by the player.
By default, this plugin uses the modern body shape icons utilized by the most recent games. However, if you would like to instead use the retro icons that look most similar to the ones Essentials already uses (based on the Gen 4 icons), then you may toggle those icons to be displayed instead by using theSHAPE_DISPLAY_STYLE
plugin setting, where setting it to 1 will use the retro icons, and 0 will use the modern ones. If you would instead like to hide this display from appearing at all, you may toggle it off by settingPOKEDEX_BODY_SHAPES
to false in the plugin settings. Here's an example of the retro icon style:
If you want to call this Body Shape Icon display to be used in another UI, you can do so by simply using
Where the arguments require the following:Code:pbDisplayBodyShape(pokemon, overlay, xpos, ypos, showDisplay)
- A Pokemon object or species ID.
- The bitmap that this display should be drawn over (usually an overlay bitmap in most UI's).
- The X and Y positions for this display.
- Whether you want to show the background image behind the body shape icons that is used in the Pokedex display (true). Otherwise, set it as false.
Battle UISpoiler:Move Info Display
Spoiler:This is a window that you can open during move selection in battle, and grants you in-depth info about each highlighted move, as well as the effectiveness of the selected move on your current opponents. To toggle the menu in battle, you just have to press the key thatMOVE_MENU_KEY
is set to in the plugin Settings. This key is set toM
by default.
Move Data
- Pow: The power of the move. Moves that have variable power will be displayed as "???", and status moves will be displayed as "---",
- Acc: The accuracy of the move. Moves that don't rely on accuracy to hit will be displayed as "---".
- Effct: The added effect chance of the move. Moves that don't have an added effect will be displayed as "---".
Move Flags
Below a move's name, there is a field that may display a row of icons which indicate a variety of special properties this specific move may have. Here are all of the icons that may appear on a move, and what they represent:
Spoiler:
Z-Move
This icon indicates that this move is a Z-Move. Only relevant when the ZUD Plugin is installed.
Max Move
This icon indicates that this move is a Max Move or G-Max Move. Only relevant when the ZUD Plugin is installed.
Bypasses Protect
This icon indicates that this move does not have the "CanProtect" flag, and thus can ignore the effects of Protect. This icon only appears on moves that are capable of targeting an opponent.
Cannot be copied/Mirror Moved
This icon indicates that this move does not have the "CanMirrorMove" flag, and thus isn't capable of being copied by the effects of Mirror Move. This icon only appears on moves that are capable of targeting an opponent.
Contact Move
This icon indicates that this move has the "Contact" flag.
Tramples Minimize
This icon indicates that this move has the "TrampleMinimize" flag.
High Critical Hit Ratio
This icon indicates that this move has the "HighCriticalHitRate" flag.
Thawing Move
This icon indicates that this move has the "ThawsUser" flag.
Sound Move
This icon indicates that this move has the "Sound" flag.
Punching Move
This icon indicates that this move has the "Punching" flag.
Biting Move
This icon indicates that this move has the "Biting" flag.
Bomb Move
This icon indicates that this move has the "Bomb" flag.
Pulse Move
This icon indicates that this move has the "Pulse" flag.
Powder Move
This icon indicates that this move has the "Powder" flag.
Dance Move
This icon indicates that this move has the "Dance" flag.
Slicing Move
This icon indicates that this move has the "Slicing" flag. This is a new flag introduced in Gen 9, and thus will only appear if you have the Gen 9 Pack installed, or manually implemented this flag yourself.
Wind Move
This icon indicates that this move has the "Wind" flag. This is a new flag introduced in Gen 9, and thus will only appear if you have the Gen 9 Pack installed, or manually implemented this flag yourself.
Type Effectiveness
If you're highlighting a damaging move, there will appear a section above the top right corner of the window which displays the icon of each of the opposing Pokemon on the field. Each of these icons will be contained in a colored box. The color and symbol found on this box indicates what the type effectiveness will be of your currently highlighted move if used against each opposing target. Here are the following indicators:
Spoiler:
Immune
A black box with a cross sign indicates that this specific Pokemon is immune to your selected move.
Not Very Effective
A red box with a minus sign indicates that this specific Pokemon will take not very effective damage from your selected move.
Effective
A blue box with a circle indicates that this specific Pokemon will take neutral damage from your selected move.
Super Effective
A green box with a plus sign indicates that this specific Pokemon will take super effective damage from your selected move.
Unknown
A white box with a question mark indicates that this specific Pokemon species has not yet been captured, battled, or owned by the player, and thus the effectiveness of your selected move is unknown.
Plugin Bonuses
Additional text will display when certain other plugins are installed. For example, if you're using the ZUD Plugin, your Z-Powered status moves will now also display the bonus effects the move will gain from its Z-Power. If the PLA Battle Styles plugin is installed, then the effects of your selected style will be displayed instead.
Battle Info Display
Spoiler:This is a new battle UI feature that replicates the info menu that may be pulled up during battle in SwSh. In this menu, you may view general info about each battler on the field, as well as the number of stages each of their stats may have been raised/lowered, and any effects that are in play that may be affecting the field. To toggle this menu, you may simply press whatever key thatBATTLE_INFO_KEY
was set to in the plugin Settings. This key is set toN
by default.
When pressed, you will first bring up the battler selection menu. This will display each battler currently on the field. The name of each Pokemon's trainer will be displayed as well, unless of course it's a wild Pokemon. Once a Pokemon has been selected, the battle info page for that Pokemon will be displayed.
This page will show all the relevant battle information for this Pokemon. Only Pokemon owned by you will have their Ability, Item, and HP totals shown. The typing of the Pokemon will also be displayed here, but only if you have already caught or registered that species. On the bar below the Pokemon's icon, its level and status will be displayed, as well as the name of the last move this Pokemon used. On the top right corner, a turn counter is displayed to show what the current turn number is.
On the bottom left, a chart will be displayed that shows all of the Pokemon's current stat stages. If the Pokemon is owned by you, then the stats affected by the user's nature will be color coated. To the right of this, a list of every field effect currently in play that affects the Pokemon is shown here, as well as the number of remaining turns until each effect expires. Only up to 8 effects will be displayed here. Any more than that will not be shown.
If you have the Terastal Phenomenon plugin installed, the Pokemon's Tera Type will also be displayed on this page.
Last edited: