Event Chase Stealth (YEP)

From Yanfly.moe Wiki
Jump to navigation Jump to search


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.

Download

Required Plugins

The following plugins are required in order to use this plugin.

Place the following plugins above this plugin located in the Plugin Manager.

Yanfly Engine Plugins

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

Click here if you want to help support Team Yanfly on Patreon.

Introduction

This plugin requires YEP_EventChasePlayer. Make sure this plugin is located
under YEP_EventChasePlayer in the plugin list. Make sure it is the most
updated version of Event Chase Player.

Grants your player the ability to go Stealth Mode for either a limited set
amount of time or an unlimited amount of time. While in Stealth Mode, the
player will not alert any events set by the Event Chase Player plugin. This
plugin also includes region areas that are considered stealth regions.

Instructions

Stealth Regions

Stealth Regions are places on the map that you can mark using RPG Maker MV's
region ID's. You can decide which of the regions will be considered Stealth
Regions within the Plugin Parameters or by using the following notetags
inside of a map's notebox:

<Stealth Regions: x>
<Stealth Regions: x, x, x>
<Stealth Regions: x to y>
This will set regions x (or x to y) as Stealth Regions.

While the player is inside of the Stealth Region, any event that is outside
of the Stealth Region cannot detect the player. However, if the player is
inside of the Stealth Region and the enemy is also inside the very same
Stealth Region with the matching Region ID, the enemy can detect the player.

However, if the player is inside of a Stealth Region with a different ID
than the Stealth Region the enemy is in, the enemy will not detect the
the player.

Once the player is detected, Stealth Regions stop applying and the alerted
event will chase the player (or flee from) even if the player runs into
another Stealth Region. The Stealth Regions remain disabled until the event
is no longer chasing (or fleeing from) the player.

Stealth Mode

To enter Stealth Mode, you'll have to utilize the plugin commands found in
the plugin commands section a bit lower. While in Stealth Mode, if enabled,
the Stealth Gauge will appear to alert the player how much longer the player
will remain in Stealth Mode before it automatically disappears.

Plugin Commands

PluginCommandsMV.png

Plugin Commands are event commands that are used to call upon functions added by a plugin that aren't inherently a part of RPG Maker MV.

Here is a list of Plugin Command(s) that you may use:

You can use the following Plugin Commands to adjust Stealth Mode in your
game mid-game!

Plugin Command:

  StealthTime x
  - Puts the player character into Stealth Mode for x frames. Once the
  timer is up, the player exits Stealth Mode.

  StealthMode On
  - Puts the player character into Stealth Mode. There is no timer for this.

  StealthMode Off
  - Puts the player character out of Stealth Mode. This also resets the
  Stealth Timer to 0.

  EnableStealthDash
  - Enables the player to be able to dash while in Stealth Mode.

  DisableStealthDash
  - Disables the player from being able to dash while in Stealth Mode.

  SetStealthMoveSpeed x
  - Sets the move speed while in Stealth Mode to x.

  HideStealthGauge
  - This prevents the Stealth Gauge from being shown at all.

  ShowStealthGauge
  - This will show the Stealth Gauge whenever the player is in Stealth Mode.

  EnableDifferentStealthSpeed
  - Sets the player to have a different move speed when in Stealth Mode.

  DisableDifferentStealthSpeed
  - The player won't have a different move speed when in Stealth Mode.

Script Calls

ScriptCallsMV.png

Script Calls are event commands that are used to run JavaScript code during an event to call upon unique functions, usually added by the related plugin.

Here is a list of Script Call(s) that you may use:

For those who wish to use Script Calls for Conditional Branches and/or
adjust Stealth Mode with Script Calls, you can use these new functions:

$gamePlayer.isStealthMode()
- This checks if the player is in Stealth Mode. If the player is, this will
return true. If the player isn't, this will return false.

$gamePlayer.setStealthMode(true)
$gamePlayer.setStealthMode(false)
- This will set the player to unlimited Stealth Mode if true. If false, this
will remove Stealth Mode from the player even if the player is on a Stealth
Mode timer.

$gamePlayer.setStealthTimer(x)
- This sets the amount of frames the player will be in Stealth Mode for.
Replace x with the desired number of frames.

$gameMap.isStealthRegion(x)
- This will check if region x is a Stealth Region. If it is, this will
return true. If it isn't, this will return false.

Changelog

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

Version 1.02:
- Fixed a bug where changing the stealth movement speed would affect all
events on the map.

Version 1.01:
- Added 'EnableDifferentStealthSpeed' and 'DisableDifferentStealthSpeed'
plugin commands to enable different stealth movement speed adjustments.

Version 1.00:
- Finished Plugin!