Difference between revisions of "Proximity Compass VisuStella MZ"

From Yanfly.moe Wiki
Jump to navigation Jump to search
(Notetags and Comment Tags)
(Plugin Commands)
Line 64: Line 64:
 
{{VisuMZ Proximity Compass Notetags}}
 
{{VisuMZ Proximity Compass Notetags}}
  
== Plugin Commands ==
+
{{Plugin Commands MZ}}
  
The following are Plugin Commands that come with this plugin. They can be
+
{{VisuMZ Proximity Compass Plugin Commands}}
accessed through the Plugin Command event command.
 
 
 
---
 
 
 
=== Compass Plugin Commands ===
 
 
 
---
 
 
 
Compass: Show/Hide Proximity Compass
 
- Show or hide the Proximity Compass.
 
- Does not bypass user settings.
 
 
 
  Setting:
 
  - Show or hide the Proximity Compass.
 
  - Does not bypass user settings.
 
 
 
---
 
 
 
Compass: Change Player Icon
 
- Change the player icon to a different icon.
 
 
 
  Icon Index:
 
  - This is the icon you wish to change the player icon to.
 
 
 
---
 
  
 
== Plugin Parameters ==
 
== Plugin Parameters ==

Revision as of 01:14, 8 October 2020

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.



VisuMZ Polish.png VisuMZ Polish.png
VisuMZ Polish.png VisuMZ Polish.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

This is a RPG Maker MZ plugin that adds a compass to the map screen, marking the position of nearby events and the directions of far away events. Events are represented by icons from the icon set. This can be used to help the player locate objectives, points of interests, NPCs, and more.

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

  • Places a compass on the main map screen.
  • Said compass will show the marked events on it with icons.
  • Marked events will move around the compass relative to the player's current position on the map.
  • Fade out marked events that are too far from the player's location.
  • The compass can be turned on/off in the Options menu.
  • The compass can also be resized in the Options menu.

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.

Some of these are comment tags. Comment tags are used for events to mark and affect individual event pages rather than the whole event.

---

Proximity Compass Notetags and Comment Tags

ProximityCompass.gif

---

<Hide Compass>

- Used for: Map Notetags
- Place this notetag inside maps where you don't want the compass to show.

---

<Compass Icon: x>

- Used for: Event Notetags and Event Page Comment Tags
- This will assign an icon to the event or the event's page.
- Replace 'x' with a number representing the icon index you wish for this
  event or event page to appear as in the Proximity Compass.
- 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.

---

<Compass Proximity: x>

- Used for: Event Notetags and Event Page Comment Tags
- This icon will only appear on the compass if the player is within range.
- Replace 'x' with the number of tiles the player must be within range of
  this event or event page in order to appear in the Proximity Compass.
- 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.

---

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.

---

Compass Plugin Commands

ProximityCompass.gif

---

ProximityCompass Command1.png

Compass: Show/Hide Proximity Compass
- Show or hide the Proximity Compass.
- Does not bypass user settings.

  Setting:
  - Show or hide the Proximity Compass.
  - Does not bypass user settings.

---

ProximityCompass Command2.png

Compass: Change Player Icon
- Change the player icon to a different icon.

  Icon Index:
  - This is the icon you wish to change the player icon to.

---

Plugin Parameters

Default Settings

Default settings used for the Proximity Compass.

---

Default

 Show by Default:
 - Show the Proximity Compass by default?
 Proximity Range:
 - Default range from the player to be shown on the Proximity Compass.
 Player Icon:
 - Icon used for the player to show on the Proximity Compass.

---

Compass Settings

Compass settings used for the Proximity Compass.

---

Position

 Center X:
 - Code used to calculate the X position of the compass's center.
 - This is NOT the upper left corner of the compass.
 Center Y:
 - Code used to calculate the Y position of the compass's center.
 - This is NOT the upper left corner of the compass.

---

Contents

 Filename:
 - The picture used for the compass' frame.
 - This will come from the img/pictures/ folder.
 Radius:
 - Radius of the Proximity Compass in pixels.
 Tile Scale:
 - The scale used to calculate the distance of a tile relative to the
   distance on the compass
 Back Color:
 - Use #rrggbb for custom colors or regular numbers for text colors from
   the Window Skin.
 Back Opacity:
 - Sets the opacity of the back color.

---

Fading

 Compass Fade Speed:
 - Fade speed of the compass when toggled on/off.
 - Lower is slower. Higher is faster.
 Icon Fade Speed:
 - Fade speed of the icons when out of range.
 - Lower is slower. Higher is faster.

---

Hiding

 Hide During Messages:
 - If true, hide compass whenever a message is being displayed.
 Hide During Events:
 - If true, hide compass whenever an event is running.

---

Options Settings

Options settings used for the Proximity Compass.

---

Options

 Add Show Option?:
 - Add the 'Show Compass' option to the Options menu?
   Option Name:
   - Command name of the option.
 Add Size Option?:
 - Add the 'Compass Size' option to the Options menu?
   Option Name:
   - Command name of the option.
 Adjust Window Height:
 - Automatically adjust the options window height?

---


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

  • Yanfly
  • Arisu
  • Olivia
  • Irina

Changelog

Version 1.00: October 23, 2020

  • Finished Plugin!

End of File