Introduction

This plugin allows you to apply the wave effect to the sprite or Shader Tilemap. (This works only in WebGL mode)


 





How to Use


■ Sprite

Create a sprite by loading the bitmap image and set the wave to true. The following code applies the wave effect to Sprite.


1
2
3
4
5
6
7
// Create Sprite
var bitmap = ImageManager.loadSvEnemy('Death');
var sprite = new Sprite(bitmap);
SceneManager._scene.addChild(sprite);
 
// Enable Wave
sprite.wave = true;
cs


It is possible to use the Sprite Wave Properties such as RPG Maker VX Ace.

  • wave_amp - You must set the the value is a floating point number between 0 and 1.
  • wave_length - You must set the value is a number between 0 and max-height of the sprite.
  • wave_speed - The default value is to 0.25
  • wave_phase - The default value is to 360 v

■ Picture

This plugin command would activate the wave effect to your picture:

PictureWave Start picture_id wave_speed wave_amp
   - picture_id : Specify the id of the game picture.
   - wave_speed : The speed of the wave effect. if the value is to 0, the wave speed will slow down, if the value is 1, it will make a speed is the fastest. The available value is the number between 0 and 1. The default value is to 0.25
   - wave_amp : Amplitude of the wave. if you are set the Amp value with the large value, The image may not be visible. So you must set it to the appropriate value. Likewise, The available value is the number between 0 and 1. The default value is to 0.05

 This plugin command would deactivate the wave effect of your picture:

     PictureWave Stop picture_id
   - picture_id : Specify the id of the game picture.



■ Tilemap


The following plugin commands apply the wave effect to Tilemap


This plugin contains these six types them.


This plugin commands allow you to enable or disable the wave effect.


Tilemap_Wave Enable

Tilemap_Wave Disable


This plugin command allows you to set the speed of the wave effect.  the x is a floating-point number between 0 and 1. Default value is to 0.25


Tilemap_Wave waveSpeed x


This plugin command allows you to set the amplitude of the wave effect. the x is a floating-point number between 0 and 1. Default value is to 0.02


Tilemap_Wave waveFrequency x


This plugin command allows you to set the UV speed of the wave effect. the x is a floating-point number between 0 and 1. Default value is to 0.25


Tilemap_Wave UVSpeed x


■ Event Notetags (New)




  Notetags :

 

  These note tags allow you to enable or disable the wave effect.


     <WAVE true>

     <WAVE false>

 

  This note tag allows you to set the amplitude of the wave effect.

  the x is a floating-point number between 0 and 1.

  the default value is to 0.02

 

     <WAVE_AMP x>

 

  This note tag allows you to set the speed of the wave effect.

  the x is a floating-point number between 0 and 1.

  the default value is to 0.25

 

     <WAVE_SPEED x>


■ Battleback Notetag (New)



  Notetag :


  These note tags allow you to set the wave effect.

  You have to put the note tags in the note area of the map properties.

 

<BATTLEBACK_WAVE : x y>

 

     These values must replace by a real value such as 0.02

     - x : the x value is the same as a waveFrequency.

     - y : the y value is the same as a waveSpeed.

 

     For Example :

     <BATTLEBACK_WAVE : 0.02 0.25>


  Function :

 

  When using Yanfly's Action Sequence Pack 1, you can enable its filter too.

  This function has the pointer of the Spriteset_Battle and easy to use.

 

eval: $gameTemp.setBattleBackWaveEffect(cond, waveAmp, waveSpeed);


       - cond : Specify true or false whether the wave effect is used.

       - waveAmp : the default value is to 0.02

       - waveSpeed : the default value is to 0.25


Known Issues

- There is an issue, which the speed of the wave effect speeds up when scrolling the game screen.


Download Link 

The Following link is the download-link to redefine an existing a Tile-map and Sprite. 


Github Link : https://github.com/biud436/MV/blob/master/RS_WaveFilter.js

Official Forum Link : http://forums.rpgmakerweb.com/index.php?threads/wave-filter.58874/




Compatibility with Terrax Lighting System

If you use the Teraxx Lighting System plugin, You must place my plugin below his lighting system plugin.



Change Log

 2016.01.14 (v1.0.0) - First Release.

 2016.01.16 (v1.0.1) - Added the function to remove the filter.

 2016.01.18 (v1.1.0) - Added the plugin command.

 2016.01.22 (v1.2.0) - Fixed the Save and Load bug

 2016.02.16 (v1.3.0) - Fixed Bug (After the player came back to Menu, you had to set the wave effect again)

 2016.02.26 (v1.3.1) - Fixed the default padding value of the sprite. (default value is to 512)

 2016.03.03 (v1.3.2) - Added new Sprite Properties (wave_amp, wave_speed, wave_length, wave_phase)

 2016.08.17 (v1.4.0) - Fixed the issue that is not working in RMMV 1.3.0 (This filter does not support for the time being in Tile-map)

 2016.08.18 (v1.5.0) - supports a wave filter in ShaderTilemap.

 2016.10.20 (v1.5.1) - Fixed the issue that is not working in RMMV 1.3.2

 2016.11.10 (v1.5.2) - Fixed the issue that is not working in Orange Overlay plugin.

 2016.11.18 (v1.5.3) - Fixed an issue where the original tilemap is rendered when using Orange Overlay plugin.

 2016.11.26 (v1.5.4) - Added certain code to remove the texture from memory.

 2016.11.30 (v1.5.5) - Fixed the issue that has the black border lines in a filter area.

 2017.12.10 (v1.5.6) - Added the plugin command called 'PictureWave' (it is tested on 1.6.0 beta version)

 2018.04.12 (v1.5.7) - Fixed a cutting issue.

 2018.04.15 (v1.5.7e) - Added a new feature that can apply the wave filter in the battle background images.

2018.04.25 (v1.5.7f) - Fixed the note tag error in Battle Test.

2018.05.09 (v1.5.8) - Fixed the bug that is not working the wave filter for the battleback image.

2018.11.01 (v1.5.9) :

 - Fixed the issue that is not working in the game picture.

 - Fixed the issue that the wave effect do a horizontal looping likes as Tiling Sprite.

2018.11.29 (v1.5.10) :

- Fixed the bug that causes an error when calling the event command called 'Erase Event'.

2019.02.24 (v1.5.11) :

- Fixed an issue that is not loaded a save file that you saved before using this script.

2020.08.03 (v1.6.0) :

- Performance optimization.



Terms of Use

Free for commercial and non-commercial use