Difference between revisions of "Template:VisuMZ Proximity Messages Notetags"

From Yanfly.moe Wiki
Jump to navigation Jump to search
(Created page with "<noinclude>VisuMZ Proximity Messages Notetags</noinclude> The following are notetags that have been added through this plugin. These notetags wi...")
 
 
Line 6: Line 6:
  
 
=== Proximity Message-Related Tags ===
 
=== Proximity Message-Related Tags ===
 +
 +
[[File:ProximityMsg_Preview.gif]]
  
 
---
 
---

Latest revision as of 18:32, 30 June 2023

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

ProximityMsg Preview.gif

---

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

---