Extended Location Preview Settings

Settings for the Extended Location Preview Feature.

Table of Contents

Function of the Setting

The Extended Preview Settings Section includes various Settings to change the behavior and layout of the Extended Location Preview for a Location on the Region Map.
It allows you to:

  • Set the toggle buttons.
  • Modify layout elements.
  • Add an Offset to Text elements.
  • Change the Text Colors of elements.

UseExtendedPreview

Use this Setting to enable or disable the Extended Location Preview Feature on the Region Map. This does require no additional setup but UseLocationPreview must be enabled. You can check Extended Preview Setup for more information about the different pages this Feature provides.

Possible Values

  • true = The Extended Preview can be used.
  • false = The Extended Preview cannot be used.

ShowExtendedButton

Use this Setting to set which button needs to be pressed to show the Extended Location Preview for a location on the Region Map. Opening the Extended Location Preview is only possible when the Location Preview for a Location is already open.

Possible Values

  • Input::USE = The Game Button
Hint

This time you can set this to the same button as for ShowLocationButton since it's a follow up feature on the Location Preview.

ShowExtendedSubButton

Use this Setting to set which button needs to be pressed to show the sub Page of the Extended Location preview.

Possible Values

  • Input::USE = The Game Button.
Hint

Here as well you can set it to the same button as for [#ShowExtendedButton] since it's a follow up page of the Extended Location Preview.

RevealAllSeenSpeciesButton

Use this Setting to set which button needs to be pressed to reveal all seen species that could also be found and have been seen on other locations.

Possible Values

  • Input::SPECIAL = All seen species will only be revealed or hidden once this button is pressed.
  • nil = All seen species will be revealed from the start.

SelectSpeciesButton

Use this Setting to set which button needs to be pressed to select a species on the Sub Page of the Extended Location Preview and view additional information about this species.

Possible Values

  • Input::USE = The Game Button.
Hint

Once again, there's no problem with setting this to the same button as for ShowExtendedButton and/or ShowExtendedSubButton as it's another follow up section of the Extended Location Preview.

ExtendedMainInfoFixed

Use this setting to whether or not have the different Progress Counter Texts a fixed position of the Main page of the Extended Preview.

Possible Values

  • true = The Counter Text on the Main Page will have a fixed position and won't change when one of the Counters have no Data.
  • false = The Counter Text will show more compact depending on the Counters having data or not.

ExtendedMainTextWildOffset

Use these Settings to add a small offset to the X and/or Y Position of the Wild Encounter Text on the Extended Preview Main Page.

Possible Values

The offset value may as well be negative as positive depending on your needs. Only round numbers are allowed.

ExtendedMainTextTrainerOffset

Use these Settings to add a small offset to the X and/or Y Position of the Trainer Text on the Extended Preview Main Page.

Possible Values

The offset value may as well be negative as positive depending on your needs. Only round numbers are allowed.

ExtendedMainTextItemOffset

Use these Settings to add a small offset to the X and/or Y Position of the Item Encounter Text on the Extended Preview Main Page.

Possible Values

The offset value may as well be negative as positive depending on your needs. Only round numbers are allowed.

ExtendedMainTextColor

Use these Settings to change the main and shadow color of the Wild Encounter, Trainer and Item Text on the Extended Preview Main Page.

Possible Values

The 3 arguments passed to Color.new() must have a value between 0 and 255 and represent Red, Green and Blue respectivly.

ExcludeMapsWithNoData

Use this Setting to whether or not exclude maps with no available Data (No wild encounter, no trainers and no items) to be shown on the Extended Preview Main Pages.

Possible Values

  • true = Game Maps that would display "No data for this location" will be hidden on the Extended Preview.
  • false = All Game Maps will be shown on the Extended Preview.
Hint
  • You can exclude a Game Map from being hidden by giving it the enExtPrev flag in the map_metadata.txt PBS file. (Only when ExcludeMapsWithNoData is true.)
  • You can exclude a Game Map from being shown by giving it the disExtPrev flag in the map_metadata.txt PBS file. (Only when ExcludeMapsWithNoData is false.)

CountItemsToMainMap

Use this Setting to link Game Maps with the same Map Position to the "Main" Game Map. This way the Extended Preview Main Page for the "Main" Game Map will show the total Items to find accross all Game Maps on the current Location on the Region Map.

Possible Values

Each Item exist out of the Game ID of the Main Map followed by an array of the Game IDs of the Game Maps with the same Map Position.

Hint

There's no additional validation so if you link Game Maps with a different Map Position, it'll work just fine

EncounterTypes

Use this Setting to set a name for each Encounter Type in the Game. The default Encounter Types have already been defined for you so feel free to add your custom Encounter Types if you have any.

Possible Values

Each Encounter Type you add here must exist out of the hash name of the Encounter Type followed by the Display Name for this Encounter Type in the Extended Location Preview.

ChangeExtBoxOnEncounterType

Use this Setting to whether or not you want the mapExtBoxMain Graphic to change depending on the Encounter Type. This Graphic is located in the /UI/preview/extended folder.

Possible Values

  • true = The mapExtBoxMain Graphic will be replaced by a Encounter Type specific one if found.
  • false = The mapExtBoxMain Graphic will always be used for every Encounter Type.

ChangeEncBoxOnEncounterType

Use this Setting to whether or not you want the mapEncBox Graphic to change depending on the Encounter Type. This Graphic is located in the /UI/preview/extended folder.

Possible Values

  • true = The mapEncBox Graphic will be replaced by a Encounter Type specific one if found.
  • false = The mapEncBox Graphic will always be used for every Encounter Type.

ExtendedSubTextOffset

Use these Settings to add a small offset to the X and/or Y Position of the Text on the Extended Preview Sub pages.

Possible Values

The offset value may as well be negative as positive depending on your needs. Only round numbers are allowed.

ExtendedSubTextColor

Use these Settings to change the main and shadow color of the Text on the Extended Preview Sub Pages.

Possible Values

The 3 arguments passed to Color.new() must have a value between 0 and 255 and represent Red, Green and Blue respectivly.

UseSpritesForUnseenSpecies

Use this Setting to whether or not have the Sprite of the Species be used for those unseen on a Location on the Extended Preview Sub Page.

Possible Values

  • true = The Sprite for unseen Species will be used.
  • false = The ? Sprite for unseen Species will be used.

UnseenSpeciesColor

Use this Setting to set the Color of Unseen Species Sprites. This Setting has only effect when UseSpritesForUnseenSpecies is enabled.

Possible Values

The 3 arguments passed to Color.new() must have a value between 0 and 255 and represent Red, Green and Blue respectivly.

UncaughtSpeciesTone

Use this Setting to set the Tone of uncaught Species Sprites.

Possible Values

The 4 arguments passed to Tone.new() must have a value between 0 and 255 and represent Red, Green, Blue and Alpha (Opacity) respectivly.