Skip to content

Transfer Plus v1.1

Choose a tag to compare

@jondevarthur jondevarthur released this 29 Sep 21:36
30aa335

You know the default Pokemon Fire Red / Leaf Green transfer splashes? You can make those happen in Essentials with the Show Picture functions already, but this lets you simplify things down to the bare minimum number of calls.

VERSIONS:

  • Version 1.1: adds support for CaveEntrance calls.
  • Version 1.0.1: bugfixes and Feral Camera updates.
  • Version 1.0: release version.

COMPATIBILITY:​

Overwrites class Scene_Map > transfer_player; will not be compatible with plugins that also change this, however it is almost entirely additive so as long as another plugin does not totally restructure this section, it should be easy for a confident user to merge the two.

FUNCTIONS:

  • tPlusImage("filename") - an image to show the next time you transfer. It's as simple as adding tPlusImage("cave") just before your in-game teleport at your cave entrance!
  • tPlusMapName(true/false) - turns showing location name badges over the top of the transfer image on and off.
  • transferPlusCaveEntrance("filename") - runs the pbCaveEntrance script, slightly adjusted to seamlessly blend into your transfer image. You can pass the filename of the transfer image directly in this script; this is optional, you can just pass transferPlusCaveEntrance if you have already defined it.
    • Just use pbCaveEntrance if your event isn't showing transfer images.
  • transferPlusCaveExit("filename") - same as transferPlusCaveEntrance.
    • Just use pbCaveExit if your event isn't showing transfer images.
    • Note: it is totally safe to mix and match events. transferPlusCaveEntrance("cave") on one side and pbCaveExit on another is perfectly kosher, for example.

SETTINGS:

  • TRANSFERIMAGE_WAITTIME - Time in seconds to show the default transfer image splash.
  • TRANSFERIMAGE_SHOWNAME - Shows the location name badge if true. This is the default setting - you can turn it on and off with tPlusMapName(true/false).
  • TRANSFERIMAGE_WAITTIME_NAMEBADGE - Alternate length to use if showing the location name badge; if this is shorter than the name badge show time (which by default is 0.4 + 1.6 + 0.4 = 2.4 seconds) then the fade in/out will play over the top of it before it disappears. TL;DR make sure to set this to the length of your location name badges.
  • FERALCAMERA_USESUBFOLDER - this plugin uses the Feral Camera File Structure to avoid repeated and redundant images. If 0, then only \pluginFeralCamera\ will be checked. If 1, it will only check \pluginFeralCamera\TransferPlus. If 2, it will check \pluginFeralCamera\TransferPlus\ first and \pluginFeralCamera\ second if no image can be found (i.e. it will 'dig' for an image in both folders, preferencing the \transferplus\ folder).

HOW TO USE:

  1. Put your images into the Feral Camera File Structure.
  2. Set your image with tPlusImage("filename") or set it at the same time you call the cave animation with transferPlusCaveEntrance("filename") / transferPlusCaveExit("filename").
    a. Your transfer image will only display when this is set. After it is shown once, it resets to blank.
  3. Make sure to turn on 'Fading' in your Teleport option settings.
    a. The Screen Tone fade in / out that many demo essentials teleport events use is perfectly compatible and can still be safely used. 'Fading' must be on, however, as to ensure smooth display, the transfer images are built into the fading version of the transfer event.
  4. Operate your teleport event as normal.
    a. If using e.g. transferPlusCaveEntrance("filename"), make sure it and the teleport command directly follow one another.
    b. You can add simple screen tone fades at either end of the the image and teleport calls for the smoothest possible transition.

Example of how to set up a transfer event to show an image. "camera_ROCK" is the name of the image in the \pluginFeralCamera\TransferPlus\ folder. This is the exact event as used in this example video.
transfer plus event

possible cave commands