Map Quest Window (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_QuestJournal. Make sure this plugin is located
under YEP_QuestJournal in the plugin list.

This plugin adds a new window to the map scene: a Quest Window to display
whatever quest is currently active and its unfinished objectives. This way,
the player can conveniently look at the needed quest objectives that are
needed to be completed. The player can also set or clear the currently
active quest from the Quest Journal System menu.

Instructions

Setting Up the Active Map Quest Window
The plugin parameter 'Window Settings' can also be left alone by default,
but should you wish to alter it to fit your game's settings, here's what you
need to know.

---

Word Wrap Objectives
- For those with YEP_MessageCore.js installed, you can set whether or not
you want the objectives to be word wrapped. Enabling this would set quest
objectives to become word wrapped and disabling it would not.

Default Show
- This will determine if you want this window to appear by default or not.
This will have no bearing on the player's Options menu command, but it will
allow you to disable the Active Map Quest Window from the mechanical-driven
side of the game.

---

Window Settings
- If you wish to customize the category window, you can adjust the various
settings here to adjust its properties. However, keep in mind that unless
you are familiar with JavaScript, you can make errors here that can make the
windows not work in your game.

X: Graphics.boxWidth - width
Y: 0
Scale: 0.50
Width: Graphics.boxWidth / 3
Line Height: 36
Font Face: GameFont
Font Size: 28
Standard Padding: 18
Text Padding: 6
Standard Opacity: 255
Back Opacity: 192
Window Skin: Window

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 change the behavior of the
Map Quest Window.

Plugin Commands:

  SetActiveQuest x
  - Sets the active quest to x.

  RefreshActiveQuestWindow
  - Refreshes the map quest window.

  ShowActiveQuestWindow
  HideActiveQuestWindow
  - Changes the Active Map Quest Window to be visible/hidden. This will not
  override the player's Options Menu's setting to hide the window.

Options Core Integration

To integrate options from this plugin into Yanfly's Options Core, use the settings below:

If you are using YEP_OptionsCore.js, you can add a new Option using this
plugin. Here's the following code/parameter settings you can use with it.

---------
Settings:
---------

Name:
\i[87]Quest Window

Help Description:
Show a window displaying the currently active
quest on the screen while exploring.

Symbol:
mapQuestWindow

Show/Hide:
show = Imported.YEP_X_MapQuestWindow;

Enable:
enabled = true;

Ext:
ext = 0;

----------
Functions:
----------

Make Option Code:
this.addCommand(name, symbol, enabled, ext);

Draw Option Code:
var rect = this.itemRectForText(index);
var statusWidth = this.statusWidth();
var titleWidth = rect.width - statusWidth;
this.resetTextColor();
this.changePaintOpacity(this.isCommandEnabled(index));
this.drawOptionsName(index);
this.drawOptionsOnOff(index);

Process OK Code:
var index = this.index();
var symbol = this.commandSymbol(index);
var value = this.getConfigValue(symbol);
this.changeValue(symbol, !value);

Cursor Right Code:
var index = this.index();
var symbol = this.commandSymbol(index);
var value = this.getConfigValue(symbol);
this.changeValue(symbol, true);

Cursor Left Code:
var index = this.index();
var symbol = this.commandSymbol(index);
var value = this.getConfigValue(symbol);
this.changeValue(symbol, false);

Default Config Code:
// Empty. Provided by this plugin.

Save Config Code:
// Empty. Provided by this plugin.

Load Config Code:
// Empty. Provided by this plugin.

Changelog

Version 1.01:
- Compatibility update for YEP_OptionsCore.js.

Version 1.00:
- Finished Plugin!