Improved Battlebacks (YEP)

From Yanfly.moe Wiki
Revision as of 18:09, 20 June 2019 by Yanfly (talk | contribs) (Created page with "{{MvPlugin |preview=<youtube>https://www.youtube.com/watch?v=xg0T2gk8Gng</youtube> |link1=<html><iframe src="https://itch.io/embed/398469" height="167" width="552" frameborder...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Welcome to the wiki! This is where you can find resources from Yanfly.moe, Ækashics.moe,
VisuStella, Caz Wolf, Fallen Angel Olivia, Atelier Irina, and other affiliated content creators.



Download

System

This is a plugin created for RPG Maker MV.

For help on how to install plugins, click here.

For help on how to update plugins, click here.

Got errors with your RPG Maker MV plugin? Click here.


Masterarbeit Writer

Yanfly Engine Plugins

This plugin is a part of the Yanfly Engine Plugins library.


Help File

============================================================================
Introduction
============================================================================

This plugin remakes how RPG Maker MV handles battlebacks. By default, all
battlebacks are handled in a hard-structured fashion making them hard to
modify and alter to behave dynamically. This plugin reworks the way RPG
Maker MV's battlebacks behave using a more automatic and flexible means of
handling them, allowing battlebacks to added, removed, change its image,
fade in/out, adjust opacity settings, and scroll in various directions!

If you are using YEP_CoreEngine and YEP_BattleEngineCore, place this plugin
under both of those plugins in the plugin list to ensure compatibility. The
action sequences provided by this plugin can only be used if the plugin
YEP_BattleEngineCore is installed in the plugin list above this plugin.

============================================================================
Plugin Commands
============================================================================

You can use the following plugin commands to alter how battlebacks behave in
your game. Keep in mind that these plugin commands must be used while the
party is in battle.

---

BATTLEBACK id ADD: folder, filename
BATTLEBACK id ADD: folder, filename, hue
- Replace 'id' with the battleback you wish to alter as a number larger than
2 (i.e. 3 or above). Replace 'folder' with the exact folder name in your
project's 'img' folder (case sensitive). Replace 'filename' with the image
filename without the file extension (case sensitive). If 'hue' is used,
replace 'hue' with a number between 0 and 360 to change the hue of the image
used. This will add a new battleback stacked on top of battlebacks 1 and 2
with higher ID's being on top. When newly added, the new battleback will
start at opacity 0 and fade in with a duration of 20 frames.

BATTLEBACK id REMOVE
- Replace 'id' with the battleback you wish to alter as a number larger than
2 (i.e. 3 or above). This will remove the battleback from being shown. When
this command is used, the battleback will fade with a duration of 20 frames.
Once it reaches 0 opacity, the battleback will be removed from the battle.

BATTLEBACK id CHANGE TO: folder, filename
BATTLEBACK id CHANGE TO: folder, filename, hue
- Replace 'id' with the battleback you wish to alter. Replace 'folder' with
the exact folder name in your project's 'img' folder (case sensitive).
Replace 'filename' with the image filename without the file extension (case
sensitive). This will change the designated battleback's image to use the
desired image depicted by the folder and filename. If 'hue' is used, replace
'hue' with a number between 0 and 360 to change the hue of the image used.

BATTLEBACK id FADE OUT
BATTLEBACK id FADE OUT: duration
BATTLEBACK id FADE IN
BATTLEBACK id FADE IN: duration
- Replace 'id' with the battleback you wish to alter. This will cause the
designated battleback to fade out/in. If 'duration' is used, replace it with
a number to indicate how many frames will be used for the fade out/in. If
no duration is specified, it will default to 20 frames.

BATTLEBACK id OPACITY: n
BATTLEBACK id OPACITY: n%
- Replace 'id' with the battleback you wish to alter. Replace 'n' with the
opacity value you wish to achieve (from 0 to 255) or replace 'n%' with the
opacity rate you wish to set the battleback to (from 0% to 100%). This will
set the designated battleback's opacity to that value. If there are any fade
in or out commands occurring as this command is issued, they'll be disabled.

BATTLEBACK id SCROLL SPEED X: +n
BATTLEBACK id SCROLL SPEED X: -n
BATTLEBACK id SCROLL SPEED Y: +n
BATTLEBACK id SCROLL SPEED Y: -n
- Replace 'id' with the battleback you wish to alter. Replace 'n' with the
value you wish to change the scroll speed X or scroll speed Y of. The higher
the 'n' value, the faster it scrolls.

BATTLEBACK id RESET SCROLL SPEED
- Replace 'id' with the battleback you wish to alter. Resets the scroll
speeds for X and Y back to 0.

============================================================================
Yanfly Engine Plugins - Battle Engine Extension - Action Sequence Commands
============================================================================

If you have YEP_BattleEngineCore.js installed with this plugin located
underneath it in the Plugin Manager, you can make use of these extra
damage related action sequences.

=============================================================================
BATTLEBACK id ADD: folder, filename
BATTLEBACK id ADD: folder, filename, hue
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Replace 'id' with the battleback you wish to alter as a number larger than 2
(i.e. 3 or above). Replace 'folder' with the exact folder name in your
project's 'img' folder (case sensitive). Replace 'filename' with the image
filename without the file extension (case sensitive). If 'hue' is used,
replace 'hue' with a number between 0 and 360 to change the hue of the image
used. This will add a new battleback stacked on top of battlebacks 1 and 2
with higher ID's being on top. When newly added, the new battleback will
start at opacity 0 and fade in with a duration of 20 frames.
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Usage Example: battleback 3 add: battlebacks1, GrassMazePool
               battleback 4 add: battlebacks2, GrassMaze, 180
=============================================================================

=============================================================================
BATTLEBACK id REMOVE
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Replace 'id' with the battleback you wish to alter as a number larger than
2 (i.e. 3 or above). This will remove the battleback from being shown. When
this command is used, the battleback will fade with a duration of 20 frames.
Once it reaches 0 opacity, the battleback will be removed from the battle.
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Usage Example: battleback 3 remove
               battleback 4 remove
=============================================================================

=============================================================================
BATTLEBACK id CHANGE TO: folder, filename
BATTLEBACK id CHANGE TO: folder, filename, hue
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Replace 'id' with the battleback you wish to alter. Replace 'folder' with
the exact folder name in your project's 'img' folder (case sensitive).
Replace 'filename' with the image filename without the file extension (case
sensitive). This will change the designated battleback's image to use the
desired image depicted by the folder and filename. If 'hue' is used, replace
'hue' with a number between 0 and 360 to change the hue of the image used.
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Usage Example: battleback 1 change to: parallaxes, SeaofClouds
               battleback 2 change to: battlebacks2, Ship, 180
=============================================================================

=============================================================================
BATTLEBACK id FADE OUT
BATTLEBACK id FADE OUT: duration
BATTLEBACK id FADE IN
BATTLEBACK id FADE IN: duration
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Replace 'id' with the battleback you wish to alter. This will cause the
designated battleback to fade out/in. If 'duration' is used, replace it with
a number to indicate how many frames will be used for the fade out/in. If
no duration is specified, it will default to 20 frames.
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Usage Example: battleback 1 fade out
               battleback 2 fade out: 120
               battleback 1 fade in
               battleback 2 fade in: 180
=============================================================================

=============================================================================
BATTLEBACK id OPACITY: n
BATTLEBACK id OPACITY: n%
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Replace 'id' with the battleback you wish to alter. Replace 'n' with the
opacity value you wish to achieve (from 0 to 255) or replace 'n%' with the
opacity rate you wish to set the battleback to (from 0% to 100%). This will
set the designated battleback's opacity to that value. If there are any fade
in or out commands occurring as this command is issued, they'll be disabled.
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Usage Example: battleback 1 opacity: 127
               battleback 2 opacity: 50%
=============================================================================

=============================================================================
BATTLEBACK id SCROLL SPEED X: +n
BATTLEBACK id SCROLL SPEED X: -n
BATTLEBACK id SCROLL SPEED Y: +n
BATTLEBACK id SCROLL SPEED Y: -n
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Replace 'id' with the battleback you wish to alter. Replace 'n' with the
value you wish to change the scroll speed X or scroll speed Y of. The higher
the 'n' value, the faster it scrolls.
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Usage Example: battleback 1 scroll speed x: +1
               battleback 1 scroll speed y: +2
               battleback 2 scroll speed x: -3
               battleback 2 scroll speed y: -4
=============================================================================

=============================================================================
BATTLEBACK id RESET SCROLL SPEED
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Replace 'id' with the battleback you wish to alter. Resets the scroll
speeds for X and Y back to 0.
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Usage Example: battleback 1 reset scroll speed
=============================================================================

============================================================================
Changelog
============================================================================

Version 1.02:
- Updated for RPG Maker MV version 1.5.0.

Version 1.01:
- Fixed a bug that wasn't returning the proper sequence checks with action
sequences.

Version 1.00:
- Finished Plugin!