Recruiting Board (Irina)

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

Atelier Irina

IrinaAvatar.png

This is a plugin created by Atelier Irina.

You can also follow Atelier Irina on itch.io.

Support e-mail: rpgmakerplugins+Irina@gmail.com

RPG Maker Version

This plugin is made for and tested on RPG Maker MV with version 1.6.2. I cannot guarantee if it works on lower versions. Some of the plugin parameters require the later updates of RPG Maker MV for you to be able to use their entries so please update RPG Maker MV to the latest version if you want the best experience in using this plugin.

Terms of Use

You are only allowed to use the plugins made by Atelier Irina if you agree to all of the following:

  1. These plugins may be used in free or commercial games.
  2. 'RPG Maker Irina' must be given credit in your games.
  3. You are allowed to edit the code.
  4. Do NOT change the filename, parameters, and information of the plugin.
  5. You are NOT allowed to redistribute these Plugins.
  6. You may NOT take code for your own released Plugins.

Introduction

This is a RPG Maker MV plugin that lets you create a recruiting board for actors. Actors can be hired to enter your team at a cost and can be retired for some of the deposit back. The recruiting board will be made into an in-game scene which displays a list of the actors you can recruit, their current stats, and a list of available skills.

Plugin Parameters

This plugin has plugin parameters that can be set to custom the text and formulas used in the in-game Recruiting Board scene.

Vocabulary
- The in-game vocabulary used for specific words like recruitment, retirement, and leaving the scene.
Text Format
- This determines how certain things are shown and displayed in-game like the lists for actor names and how classes appear in the upper status.
Mechanics
- Adjust the default mechanics of how things occur in-game from gold cost to retirement refund.
JavaScript
- For advanced JavaScript-proficient users, these are global functions that add on extra effects and conditional ways of listing/enabling actors that would otherwise be available for recruiting/retiring.

Notetags

NotetagsMV.png

RPG Maker MV's editor is unable to allow for custom traits/properties that a game dev may wish to associate with a database object, event, map, etc. Notetags are used to work around such limitations by allowing the game dev to tag certain traits/properties using specific Notetags declared by the related plugin.

Here is a list of Notetag(s) that you may use.

Insert the following notetags to make actors recruitable or change their recruitment properties:

Recruit Notetags

  <Recruitable>
  - Makes the actor recruitable. This is absolutely required to make the
  actor appear inside the Recruiting Board scene.
  <Recruit Cost: x>
  - Replace 'x' with a number or formula on how much the actor should cost.
  - If this notetag isn't used, it will use the Plugin Parameters formula.

Retire Notetags

  <Cannot Retire>
  - Makes the actor unable to be retired, even if you've hired them and even
  if they have a retire value.
  <Retire Value: x>
  - Replace 'x' with a number or formula on how much the actor should return.
  - If this notetag isn't used, it will use the Plugin Parameters formula.

Lunatic Mode

JavaScript.png

For advanced users who have an understanding of JavaScript, you can use the following features added by the plugin to further enhance what you can do with your game project.

Those who understand JavaScript can customize the recruiting and retire process further using JavaScript code. The following are notetags that you may use to make your ideal recruiting and retiring process possible.

Recruit Notetags

  <Custom Recruit Effect>
   JavaScript Code
   JavaScript Code
   JavaScript Code
  </Custom Recruit Effect>
  - Replace the JavaScript Code inside the notetags with JavaScript.
  This code will run once the actor is recruited.
  - 'actor' variable will refer to the actor being recruited.
  <Custom Recruit Show>
   JavaScript Code
   JavaScript Code
   show = JavaScript Code
  </Custom Recruit Show>
  - Replace the JavaScript Code inside the notetags with JavaScript.
  This code will determine custom show requirements for the recruit list.
  - 'actor' variable will refer to the actor being recruited.
  - 'show' variable is a true/false that determines if the actor is listed.
  <Custom Recruit Enable>
   JavaScript Code
   JavaScript Code
   enable = JavaScript Code
  </Custom Recruit Enable>
  - Replace the JavaScript Code inside the notetags with JavaScript.
  This code will determine custom enable requirements for the recruit list.
  - 'actor' variable will refer to the actor being recruited.
  - 'enable' variable is a true/false that determines if recruiting is enabled.

Retire Notetags

  <Custom Retire Effect>
   JavaScript Code
   JavaScript Code
   JavaScript Code
  </Custom Retire Effect>
  - Replace the JavaScript Code inside the notetags with JavaScript.
  This code will run once the actor is retired.
  - 'actor' variable will refer to the actor being retired.
  <Custom Retire Show>
   JavaScript Code
   JavaScript Code
   show = JavaScript Code
  </Custom Retire Show>
  - Replace the JavaScript Code inside the notetags with JavaScript.
  This code will determine custom show requirements for the retire list.
  - 'actor' variable will refer to the actor being retired.
  - 'show' variable is a true/false that determines if the actor is listed.
  <Custom Retire Enable>
   JavaScript Code
   JavaScript Code
   enable = JavaScript Code
  </Custom Retire Enable>
  - Replace the JavaScript Code inside the notetags with JavaScript.
  This code will determine custom enable requirements for the retire list.
  - 'actor' variable will refer to the actor being retired.
  - 'enable' variable is a true/false that determines if retiring is enabled.

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:

Use the following Script Call to open up the recruiting board in-game.

  var actors = [1, 2, 3, 4, 5, 6, 7];
  var allowRetire = true;
  $OpenRecruitingBoard(actors, allowRetire);
  - Replace 'actors' with an array of the Actor ID's that the player can
  recruit into his/her party.
  - Replace 'allowRetire' with 'true' or 'false' (without the quotes) to
  determine if this scene allows for retiring actors.

Changelog

  • Version 1.00
    • Plugin released!

Help File