Conditional Random Encounters 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.



CondRandEnc Preview1.png


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

CondRandEnc Preview1.png

Do you use Random Encounters for your RPG but want certain troops to appear only after certain conditions have been met? For example, a pack of wolves that appear when a specific switch is on, or a school of piranhas that show up if they detect you have bait in your inventory? This plugin allows that to be possible!

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

  • Conditional Random Encounter requirements will prevent certain troops from being a part of the random encounter pool until the requirements are met.
  • Also applies to the "Battle Processing" event command's "Same As Random Encounters" feature.
  • Requirements range from switch conditions, variable values, item counts, weapon counts, armor counts, alive members, and more.
  • Additional Comment Tags to force specific BGM's to play for specific troop encounters.

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.


Notetags

RPG Maker MZ'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.


To make these comment tags work, insert any of the below comment tags inside a comment found within any of the troop's pages. The page's conditions do not need to be met and can even work with the "Don't Run" condition.

If there are multiple comments, the comments will be stringed together allowing for more than 6 lines of conditions.

If using the Battle Core's "Base Troop ID(s)" Plugin Parameter, the comments from the Base Troop pages will also be copied over.

---

Requirement Comment Tags

CondRandEnc Preview1.png

---

<Random Encounter Requirements>
 condition
 condition
 condition
 condition
</Random Encounter Requirements>

- Used for: Troop Page Comment Tags
- Create conditional requirements for this random encounter to be met before
  it would appear in the random encounter pool for the map.
- Replace 'condition' with any of the conditions listed in below section.
- Insert and/or remove 'condition' lines to add/remove conditions.

Condition List

CondRandEnc Preview1.png

Replace 'condition' in the notetags in the above section with any of the following to make conditions. These conditions are also used in the Plugin Parameters for the default conditions, too.

---

x >= y
x > y
x === y
x !== y
x < y
x <= y

- Replace 'x' and 'y' with any of the following:

- 'Switch x' (replace 'x' with a number) for switch x's current state.
- 'TRUE', 'FALSE', 'ON', 'OFF' for the opposite x/y value.
- Using any of these boolean modifiers must be paired with '===' or '!=='

- 'Variable x' (replace 'x' with a number) for variable x's current value.
- A numeric value representing a hard number.
- '50%' or any other percentile number to represent a rate.
- '0.5' or any other float number to represent a rate.

- 'Item id Count' for the number of specific items the party owns.
  - Replace 'id' with the ID of the item.
- 'Item name Count' for the number of specific items the party owns.
  - Replace 'name' with the ID of the item.

- 'Weapon id Count' for the number of specific weapons the party owns.
  - Replace 'id' with the ID of the weapon.
- 'Weapon name Count' for the number of specific weapons the party owns.
  - Replace 'name' with the ID of the weapon.

- 'Armor id Count' for the number of specific armors the party owns.
  - Replace 'id' with the ID of the armor.
- 'Armor name Count' for the number of specific armors the party owns.
  - Replace 'name' with the ID of the armor.

- 'Alive Members' for the number of alive party members when drops are
  being determined.

- 'Battle Members' for the number of participating party members in battle.

- 'Dead Members' for the number of dead party members when drops are
  being determined.

- 'Death Turn' for the turn the enemy died. If an enemy was revived during
  battle, then take the most recent turn the enemy has died.

- 'Party Gold' for the party's current gold value when drops are
  being determined.

- 'Party Members' for the number of total party members in battle.

---

BGM Comment Tags

---

<Forced BGM>
 Name: filename
 Volume: x
 Pitch: x
 Pan: x
</Forced BGM>

- Used for: Troop Page Comment Tags
- Forces a specific BGM to play whenever this specific encounter is primed
  for battle.
- This will override any database settings or music changes from event
  commands.
- Replace 'filename' with the filename of the BGM you want to play.
  - Do NOT include the file extension.
- Replace 'volume' with a number to determine sound volume.
- Replace 'pitch' with a number to determine sound pitch.
- Replace 'pan' with a number to determine sound panning.

---


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.00 Official Release Date: September 10, 2021

  • Finished Plugin!

End of File