Proximity Messages VisuStella MZ

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.	Click here to learn how to update plugins.	Click here for how to troubleshoot plugins if you get an error.

Masterarbeit Writer

VisuStella MZ This plugin is a part of the VisuStella MZ Plugin Library. Click here if you want to help support VisuStella on Patreon. Introduction This plugin allows events to display text windows saying whatever they want once the player character is nearby. Once within proximity range, the window appears for the player to be able to read. This can be used to simulate seeing sign-boards from afar, eavesdropping on NPC's, or simply emulating an NPC shouting something in general for the public to hear. Doing so will allow the player to continue moving and not interrupt their exploration. Features include all (but not limited to) the following: Display small text windows on top of events that only appear while the player character is moving nearby. Text windows can use text codes and the like. Change the text displayed in their windows via Plugin Commands. Add speech tail types to help indicate the speaker. Show or hide all Proximity Message on a global scale via Plugin Command. 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. The following are notetags that have been added through this plugin. These notetags will not work with your game if this plugin is OFF or not present. --- Proximity Message-Related Tags --- <Proximity Message> text text text text </Proximity Message> - Used for: Event Page Comment Tags - Displays 'text' in the event's Proximity Message text window. - Replace 'text' with the text you would like displayed. - Text codes allowed. --- <Proximity Message Range Type: Circle> <Proximity Message Range Type: Radius> <Proximity Message Range Type: Square> - Used for: Event Notetags and Event Page Comment Tags - Changes the proximity range type for the event's Proximity Message. - Circle - Be within circular range of event with event at center. - Radius - Have to be x tiles within range of event. - Square - Within a square range with event at the center. - If this is placed in a notetag, the effect will be present across all event pages used. - If this is placed inside a page's comment, the effect will only occur if that event page is currently active. - If none of these tags are used, use the settings found in the Plugin Parameters. --- <Proximity Message Max Range: x> <Proximity Message Min Range: x> - Used for: Event Notetags and Event Page Comment Tags - Changes the maximum and minimum range for the Proximity Message to dislay. - For max range variant, replace 'x' with a number representing the maximum range. If the player is outside of this range, hide the Proximity Message. - For min range variant, replace 'x' with a number representing the minimum range. If the player is within this range, hide the Proximity Message. - If this is placed in a notetag, the effect will be present across all event pages used. - If this is placed inside a page's comment, the effect will only occur if that event page is currently active. - If none of these tags are used, use the settings found in the Plugin Parameters. --- <Proximity Message Offsets: +x, +y> <Proximity Message Offsets: -x, -y> <Proximity Message Offsets: +x, -y> <Proximity Message Offsets: -x, +y> - Used for: Event Notetags and Event Page Comment Tags - Offsets the Proximity Message text window for this event by 'x' and 'y'. - Replace 'x' and 'y' with numbers representing how much to offset the window position by. - For 'x', lower numbers move left and higher numbers move right. - For 'y', lower numbers move up and higher numbers move down. - If this is placed in a notetag, the effect will be present across all event pages used. - If this is placed inside a page's comment, the effect will only occur if that event page is currently active. - If none of these tags are used, use the settings found in the Plugin Parameters. --- <Proximity Message Scale: x%> - Used for: Event Notetags and Event Page Comment Tags - Changes the size scaling of the Proximity Message window to 'x' percent. - Replace 'x' with a number representing the scaling percent. - If this is placed in a notetag, the effect will be present across all event pages used. - If this is placed inside a page's comment, the effect will only occur if that event page is currently active. - If none of these tags are used, use the settings found in the Plugin Parameters. --- <Proximity Message Tail Type: Bottom Left> <Proximity Message Tail Type: Bottom Right> <Proximity Message Tail Type: None> - Used for: Event Notetags and Event Page Comment Tags - Changes the speech tail type used for the Proximity Message text window. - If this is placed in a notetag, the effect will be present across all event pages used. - If this is placed inside a page's comment, the effect will only occur if that event page is currently active. - If none of these tags are used, use the settings found in the Plugin Parameters. --- <Proximity Message Tail X: x> - Used for: Event Notetags and Event Page Comment Tags - Moves the position of the speech tail to 'x'. - Replace 'x' with a number representing the x position of the Proximity Message text window. - If this is placed in a notetag, the effect will be present across all event pages used. - If this is placed inside a page's comment, the effect will only occur if that event page is currently active. - If not used, the speech tail will be centered. --- 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. --- Event Plugin Commands --- Event: Clear Proximity Message - Clears target event's Proximity Message. - Must be used on the map scene. Event ID: - Insert the ID of the target event. - Use 0 for the current event. --- Event: Set Proximity Message Text - Sets target event's Proximity Message text. - Must be used on the map scene. Event ID: - Insert the ID of the target event. - Use 0 for the current event. Text: - The text displayed by the event. - Text codes allowed. --- Global Plugin Commands --- Global: Show/Hide All Proximity Messages - Turns on/off all Proximity Messages. - When turned off, all Proximity Messages become hidden. Show/Hide?: - Shows/hides all Proximity Messages. --- Plugin Parameters Default Settings What are the default settings made for events? --- General Proximity Type: - What do you want to be the default proximity type? - Circle - Be within circular range of event with event at center. - Radius - Have to be x tiles within range of event. - Square - Within a square range with event at the center. Speech Tail Type: - What do you want to use as the default tail type? --- Range Maximum: - What is the default maximum range for showing a Proximity Message window? Minimum: - What is the default minimum range for showing a Proximity Message window? --- Window Offset Offset X: - Offsets the Proximity Message Window x position. - Negative: left. Positive: right. Offset Y: - Offsets the Proximity Message Window y position. - Negative: up. Positive: down. --- Scaling Window Scale: - What is the default scale of the Proximity Message window? - 0.00 - 0%; 0.50 - 50%; 1.00 - 100%; 1.50 - 150%; --- Window Settings Adjust the settings for the Proximity Message Windows. --- General Update Frequency: - Update all Proximity Message windows every x frames. --- Hide During Game Message Open: - Hide all Proximity Messages when game message is open? Map Event Running: - Hide all Proximity Messages when a map event is running? --- Tail Directions > Bottom Left Tail Directions > Bottom Right Filename: - Filename of the Speech Tail graphic. Anchor X: - Anchor value X. Use a number between 0 and 1. - 0.0 - Left; 0.5 - Center; 1.0 - Right Anchor Y: - Anchor value Y. Use a number between 0 and 1. - 0.0 - Top; 0.5 - Middle; 1.0 - Bottom Offset X: - Offset the Speech Tail's X position. - Negative: left. Positive: right. Offset Y: - Offset the Speech Tail's Y position. - Negative: left. Positive: right. --- Window Offset Offset X: - Offsets the Proximity Message Window x position. - Negative: left. Positive: right. Offset Y: - Offsets the Proximity Message Window y position. - Negative: up. Positive: down. --- 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 Arisu Irina Olivia Yanfly Changelog Version 1.00 Official Release Date: July 26, 2023 Finished Plugin! See Also Inspiration Behind Enchanted Explorers Volume 2 End of Helpfile