Event Title Scene VisuStella MZ

From Yanfly.moe Wiki
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 MZ.

Click here for help on how to install plugins and an explanation on the Tier Hierarchy System.


UpdatePlugins.png

Click here to learn how to update plugins.


Troubleshooting.jpg

Click here for how to troubleshoot plugins if you get an error.




VisuStella MZ

This plugin is a part of the VisuStella MZ Plugin Library.


Support VisuStella

Click here if you want to help support VisuStella on Patreon.


Introduction

VisuMZ EventTitleScreen.png

EventTitleScene Example2.gif

For those who feel compelled to create their own custom title scene using in-game maps and events, this plugin will replace Scene_Title with a new dedicated map scene to allow such a thing to happen. Customize it however you can within your abilities and utilize the full power of RPG Maker MZ's eventing system. Just don't forget to use an Autorun event to kick things off, alright?

Features include all (but not limited to) the following:

  • Dedicated map scene to use for custom map title scenes.
  • Going to the Game End screen to return to the title screen will take the player back to the dedicated map scene.
  • Customize which map to use and where on the map to display.
  • Determine the player's position, visibility, facing direction, and whether or not followers are shown, too.
  • Disable or enable movement on the title scene if you want.
  • Plugin Commands that facilitate the New Game, Continue, and Options command as seen before in the title screen.

Requirements

This plugin is made for RPG Maker MZ. This will not work in other iterations of RPG Maker.


Tier 4

This plugin is a Tier 4 plugin. Place it under other plugins of lower tier value on your Plugin Manager list (ie: 0, 1, 2, 3, 4, 5).

This is to ensure that your plugins will have the best compatibility with the rest of the VisuStella MZ Plugin library.


Major Changes

This plugin adds some new hard-coded features to RPG Maker MZ's functions. The following is a list of them.

---

Autosave

Autosaving is disabled on the event title scene map. This is to prevent any instances of the player loading into an unintended map by accident.

---

Movement Disable

Through the Plugin Parameters, you can disable input and mouse movement from the player for the dedicated event title scene.

---

Menu and Debug Disable

On the dedicated event title scene, calling the Main Menu and debug menu is disabled to prevent errors.

---

VisuStella MZ Compatibility

While this plugin is compatible with the majority of the VisuStella MZ plugin library, it is not compatible with specific plugins or specific features. This section will highlight the main plugins/features that will not be compatible with this plugin or put focus on how the make certain features compatible.

---

Core Engine VisuStella MZ

EventTitleScene TitlePictureButtons.png

Those using the VisuStella MZ Core Engine will now have the "Title Picture Buttons" imported into the Event Title Scene. They can be interacted the same way. The picture buttons will appear above all else so keep that in mind for how you position them.

---

Text Codes

ShowTextWindowMZ.png

Text Codes are used in the Show Text event command. They are used to display things that text normally can't produce on its own, such as colors, get the name of a specific actor, change icons, and more.

RPG Maker MZ already comes with text codes of its own:

\V[n] Will be replaced with the value of the nth variable.
\N[n] Will be replaced with the name of the nth actor.
\P[n] Will be replaced by the name of the nth (arranged order) party member.
\G Will be replaced by the currency unit.
\C[n] Draw the subsequent text in the nth color. Text color conforms to the contents of the [Window.png] system image.
\I[n] Draws the nth icon.
\FS[n] Changes the text font size to 'n'.
\{ Increases the text by 1 step.
\} Decreases the text by 1 step.
\\ Replaced with the backslash character.
\$ Open the gold window.
\. Wait for 1/4 second.
\| Wait for 1 second.
\! Wait for button input.
\> Display remaining text on same line all at once.
\< Cancel the effect that displays text all at once.
\^ Do not wait for input after displaying the next.


The following are text codes that you may use with this plugin.

Continue-Related Text Codes

EventTitleScene Example.gif

---

------------------   -------------------------------------------------------
Text Code            Effect (Show Choice Text Only)
------------------   -------------------------------------------------------

<Continue>           Put this text code inside of a Show Choice and it will
                     enable that choice if there is a save file available.
                     It will disable that choice if there are no saves.

---

Plugin Commands

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 MZ.

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

---


The following are Plugin Commands that come with this plugin. They can be accessed through the Plugin Command event command.

---

System-Type Plugin Commands

EventTitleScene Example2.gif

---

EventTitleScene Command1.png

System: Start New Game
- Leaves the current scene and starts a new game.

  Slow Fade Out?:
  - Use a slow fade out transition to the next scene?

---

EventTitleScene Command2.png

System: Open Load Scene
- Leaves the current scene and opens the load game scene.

  Slow Fade Out?:
  - Use a slow fade out transition to the next scene?

---

EventTitleScene Command3.png

System: Open Options Scene
- Leaves the current scene and opens the options scene.

  Slow Fade Out?:
  - Use a slow fade out transition to the next scene?

---

Script Calls

The following are Script Calls that can be used with this plugin. These are made for JavaScript proficient users. We are not responsible if you use them incorrectly or for unintended usage.

---

Continue-Related Script Calls

---

EventTitleScene ScriptCall.png

DataManager.isAnySavefileExists()

- Use this in a 'Conditional Branch' event command script check.
- This will return 'true' if there are save files to load from.
- This will return 'false' if there are no save files to load from.
- This code is available outside of this plugin.

---

Plugin Parameters

General Settings

EventTitleScene Params.png

EventTitleScene Example2.gif

These are the settings available through the plugin parameters to adjust how the map title scene plays out.

---

Title Scene Coordinates

 Map ID:
 - Select the map used for the evented title scene.
 Map X:
 - Select the X coordinate for the evented title scene.
 Map Y:
 - Select the Y coordinate for the evented title scene.
 Face Direction:
 - What direction will the player face on the title scene?
 - This is assuming the player is visible.

---

Player Character

 Transparent?:
 - Make the player transparent on the title scene?
 Can Input Move?:
 - Can the player move while on the title scene?
 Show Followers?:
 - Show player followers on the title scene?
 - This is assuming the player is visible.

---


Terms of Use

1. These plugins may be used in free or commercial games provided that they have been acquired through legitimate means at VisuStella.com and/or any other official approved VisuStella sources. Exceptions and special circumstances that may prohibit usage will be listed on VisuStella.com.

2. All of the listed coders found in the Credits section of this plugin must be given credit in your games or credited as a collective under the name: "VisuStella".

3. You may edit the source code to suit your needs, so long as you do not claim the source code belongs to you. VisuStella also does not take responsibility for the plugin if any changes have been made to the plugin's code, nor does VisuStella take responsibility for user-provided custom code used for custom control effects including advanced JavaScript notetags and/or plugin parameters that allow custom JavaScript code.

4. You may NOT redistribute these plugins nor take code from this plugin to use as your own. These plugins and their code are only to be downloaded from VisuStella.com and other official/approved VisuStella sources. A list of official/approved sources can also be found on VisuStella.com.

5. VisuStella is not responsible for problems found in your game due to unintended usage, incompatibility problems with plugins outside of the VisuStella MZ library, plugin versions that aren't up to date, nor responsible for the proper working of compatibility patches made by any third parties. VisuStella is not responsible for errors caused by any user-provided custom code used for custom control effects including advanced JavaScript notetags and/or plugin parameters that allow JavaScript code.

6. If a compatibility patch needs to be made through a third party that is unaffiliated with VisuStella that involves using code from the VisuStella MZ library, contact must be made with a member from VisuStella and have it approved. The patch would be placed on VisuStella.com as a free download to the public. Such patches cannot be sold for monetary gain, including commissions, crowdfunding, and/or donations.

7. If this VisuStella MZ plugin is a paid product, all project team members must purchase their own individual copies of the paid product if they are to use it. Usage includes working on related game mechanics, managing related code, and/or using related Plugin Commands and features. Redistribution of the plugin and/or its code to other members of the team is NOT allowed unless they own the plugin itself as that conflicts with Article 4.

8. Any extensions and/or addendums made to this plugin's Terms of Use can be found on VisuStella.com and must be followed.

Terms of Use: Japanese


『VisuStella MZ』利用規約

1. これらのプラグインは、VisuStella.comおよび/または公式に承認されたVisuStellaのソースから合法的な手段で入手したものである限り、フリーゲームや商用ゲームに使用することができます。例外的に使用が禁止される場合については、VisuStella.comの記載をご確認ください。

2. 本プラグインの「クレジット」部分に記載されているすべてのコーダーの名前は、ゲーム内にクレジット表記を行うか、もしくは「VisuStella」という名前の下にまとめて表記する必要があります。

3. ソースコードを自分のものだと主張しない限りは、必要に応じて編集することが可能です。ただしプラグインのコードに変更が加えられた場合、VisuStellaはそのプラグインに対して一切の責任を負いません。高度なJavaScriptのノートタグやJavaScriptコードを許可するプラグインのパラメータを含む、カスタムコントロールエフェクトに使用される、ユーザー提供のカスタムコードについても、VisuStellaは一切の責任を負いません。

4. これらのプラグインやプラグイン内のコードを、「自分のもの」として再配布したり使用したりすることはできません。これらのプラグインとそのコードは、VisuStella.comおよび、その他の公式/承認済みVisuStellaソースからのみダウンロードすることができます。公式/承認済みのソースのリストは、VisuStella.comでご確認いただけます。

5. VisuStellaは、意図しない使用方法による問題、VisuStella MZライブラリ以外のプラグインとの非互換性の問題、プラグインのバージョンが最新でないことによる問題、第三者による互換性パッチが適切に動作していないことなどが原因でゲーム内で発生した問題については、一切の責任を負いません。VisuStellaは、高度なJavaScriptのノートタグやJavaScriptコードを許可するプラグインのパラメータを含む、カスタムコントロールエフェクトに使用される、ユーザー提供のカスタムコードに起因するエラーについても、一切の責任を負いません。

6. VisuStella MZライブラリのコードを使用した互換性パッチをVisuStellaとは関係のない第三者を通じて作成する必要がある場合は、まずVisuStellaのメンバーと連絡を取り、承認を得る必要があります。パッチはVisuStella.comに公開され、誰でも無料でダウンロードすることができるようになります。このようなパッチを、制作発注やクラウドファンディングの対象にしたり、寄付などの金銭的な利益を得るために販売することはできません。

7. このVisuStella MZプラグインが商用製品である場合、プロジェクトチームのすべてのメンバーは、それを使用するため、それぞれ製品を購入しなければなりません。使用方法には、関連するゲームメカニクスの作業、関連するコードの管理、および/または関連するプラグインコマンドや機能の使用、が含まれます。プラグインそのものやそのコードをチームの他のメンバーに再配布することは第4項に抵触するため、そのメンバーがプラグインそのものを所有していない限りは許可されません。

8. このプラグインの利用規約の追加項目や補足については、VisuStella.comに掲載されていますので、それを参照し従ってください。

Credits

If you are using this plugin, credit the following people in your game:

Team VisuStella

Changelog

Version 1.01: June 25, 2021

  • Documentation Update!
    • Added section for VisuStella compatibility.
      • Those using the VisuStella MZ Core Engine will now have the "Title Picture Buttons" imported into the Event Title Scene. They can be interacted the same way. The picture buttons will appear above all else so keep that in mind for how you position them.
  • Compatibility Update!
    • This plugin is now compatible with the VisuMZ Core Engine's Title Picture Buttons and will have them displayed on the same scene. Update by Arisu.


Version 1.00 Official Release Date: July 9, 2021

  • Finished Plugin!

End of File