Difference between revisions of "Template:VisuMZ Events and Movement Core Notetags"

From Yanfly.moe Wiki
Jump to navigation Jump to search
(Event and Event Page Notetags)
(Event and Event Page Notetags)
 
Line 139: Line 139:
 
   - Player/Event Touch: Player must step onto the region.
 
   - Player/Event Touch: Player must step onto the region.
 
   - Autorun/Parallel: Player be in the region.
 
   - Autorun/Parallel: Player be in the region.
 +
- 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.
 
- NOTE: This cannot be used with any other activation tags.
 
- NOTE: This cannot be used with any other activation tags.
 
</pre>
 
</pre>
Line 160: Line 164:
 
   - Row: Spans horizontally across the map. 'x' expands up and down.
 
   - Row: Spans horizontally across the map. 'x' expands up and down.
 
   - Column: Spans vertically across the map. 'x' expands left and right.
 
   - Column: Spans vertically across the map. 'x' expands left and right.
 +
- 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.
 
- NOTE: This cannot be used with any other activation tags.
 
- NOTE: This cannot be used with any other activation tags.
 
</pre>
 
</pre>
Line 171: Line 179:
 
- Events normally have to be within screen range for them to update their
 
- Events normally have to be within screen range for them to update their
 
   self movement. If this tag is present, the event is always updating.
 
   self movement. If this tag is present, the event is always updating.
 +
- 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.
 
</pre>
 
</pre>
  
Line 182: Line 194:
 
- Used for: Event Notetags and Event Page Comment Tags
 
- Used for: Event Notetags and Event Page Comment Tags
 
- Allows this event to activate upon being clicked on with the mouse.
 
- Allows this event to activate upon being clicked on with the mouse.
 +
- 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.
 
</pre>
 
</pre>
  
Line 201: Line 217:
 
   template made in Plugin Parameters => Event Template Settings =>
 
   template made in Plugin Parameters => Event Template Settings =>
 
   Event Template List.
 
   Event Template List.
 +
- 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.
 
</pre>
 
</pre>
  
Line 217: Line 237:
 
   tiles towards the listed direction.
 
   tiles towards the listed direction.
 
- Use multiples of this notetag to extend them to different directions.
 
- Use multiples of this notetag to extend them to different directions.
 +
- 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.
 
</pre>
 
</pre>
  
Line 230: Line 254:
 
- This will not override any Icons designated to the ID through a
 
- This will not override any Icons designated to the ID through a
 
   Plugin Command.
 
   Plugin Command.
 +
- 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.
 
</pre>
 
</pre>
  
Line 247: Line 275:
 
- Allows you to adjust the positions of the icon on the envent by buffers.
 
- Allows you to adjust the positions of the icon on the envent by buffers.
 
- Replace 'x' and 'y' with the values to adjust the position buffers by.
 
- Replace 'x' and 'y' with the values to adjust the position buffers by.
 +
- 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.
 
</pre>
 
</pre>
  
Line 259: Line 291:
 
- Used for: Event Notetags and Event Page Comment Tags
 
- Used for: Event Notetags and Event Page Comment Tags
 
- Sets the blend mode for the icon on the event.
 
- Sets the blend mode for the icon on the event.
 +
- 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.
 
</pre>
 
</pre>
  
Line 271: Line 307:
 
- Puts a label over the event's head displaying 'text'.
 
- Puts a label over the event's head displaying 'text'.
 
- Text codes can be used.
 
- Text codes can be used.
 +
- 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.
 
</pre>
 
</pre>
  
Line 285: Line 325:
 
- This can display multiple lines.
 
- This can display multiple lines.
 
- Text codes can be used.
 
- Text codes can be used.
 +
- 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.
 
</pre>
 
</pre>
  
Line 296: Line 340:
 
   label to appear.
 
   label to appear.
 
- Replace 'x' with a number value depicting the range in tiles.
 
- Replace 'x' with a number value depicting the range in tiles.
 +
- 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.
 
</pre>
 
</pre>
  
Line 313: Line 361:
 
- Allows you to adjust the positions of the label on the envent by offsets.
 
- Allows you to adjust the positions of the label on the envent by offsets.
 
- Replace 'x' and 'y' with the values to adjust the position offsets by.
 
- Replace 'x' and 'y' with the values to adjust the position offsets by.
 +
- 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.
 
</pre>
 
</pre>
  
Line 328: Line 380:
 
- This will bypass terrain passability.
 
- This will bypass terrain passability.
 
- This will not bypass event collision.
 
- This will not bypass event collision.
 +
- 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.
 
</pre>
 
</pre>
  
Line 344: Line 400:
 
   target moves.
 
   target moves.
 
- For 'Event x' variant, replace 'x' with the ID of the event to synch to.
 
- For 'Event x' variant, replace 'x' with the ID of the event to synch to.
 +
- 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.
 
</pre>
 
</pre>
  
Line 371: Line 431:
 
   - Mirror Horizontal: Moves as if a mirror is placed horizontally.
 
   - Mirror Horizontal: Moves as if a mirror is placed horizontally.
 
   - Mirror Vertical: Moves as if a mirror is placed vertically.
 
   - Mirror Vertical: Moves as if a mirror is placed vertically.
 +
- 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.
 
</pre>
 
</pre>
  
Line 382: Line 446:
 
   moving again.
 
   moving again.
 
- Replace 'x' with the number of movement instances in between.
 
- Replace 'x' with the number of movement instances in between.
 +
- 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.
 
</pre>
 
</pre>
  
Line 403: Line 471:
 
- Used for: Event Notetags and Event Page Comment Tags
 
- Used for: Event Notetags and Event Page Comment Tags
 
- Hides the shadow for the event.
 
- Hides the shadow for the event.
 +
- 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.
 
</pre>
 
</pre>
  
Line 413: Line 485:
 
- Replaces the shadow graphic used with 'filename' found in the
 
- Replaces the shadow graphic used with 'filename' found in the
 
   img/system/ project folder.
 
   img/system/ project folder.
 +
- 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.
 
</pre>
 
</pre>
  
Line 430: Line 506:
 
- Changes how much the event's sprite is visibly offset by.
 
- Changes how much the event's sprite is visibly offset by.
 
- Replace 'x' and 'y' with numbers indicating the offset in pixels.
 
- Replace 'x' and 'y' with numbers indicating the offset in pixels.
 +
- 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.
 
</pre>
 
</pre>
  
Line 454: Line 534:
 
   - Spin Clockwise: Makes the event sprite's step behavior spin CW.
 
   - Spin Clockwise: Makes the event sprite's step behavior spin CW.
 
   - Spin CounterClockwise: Makes the event sprite's step behavior spin CCW.
 
   - Spin CounterClockwise: Makes the event sprite's step behavior spin CCW.
 +
- 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.
 
</pre>
 
</pre>
  
 
---
 
---

Latest revision as of 17:28, 20 October 2020

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.

Map Notetags

The following notetags are used for maps only. While some of these options are also available in the Plugin Parameters, some of these notetags extend usage to specific maps marked by these notetags as well.

---

EventsMoveCoreVS8.gif

<Diagonal Movement: On>
<Diagonal Movement: Off>

- Used for: Map Notetags
- Turns on/off diagonal movement for those maps.
- If notetag isn't present, use Plugin Parameter setting.

---

EventMoveCoreRegions.png

<type Allow Region: x>
<type Allow Region: x, x, x>

<type Forbid Region: x>
<type Forbid Region: x, x, x>

<type Dock Region: x>
<type Dock Region: x, x, x>

- Used for: Map Notetags
- Replace 'type' with 'All', 'Walk', 'Player', 'Event', 'Vehicle', 'Boat',
  'Ship', or 'Airship'.
- 'Allow' notetag variants allow that type to pass through them no matter
  what other passability settings are in place.
- 'Forbid' notetag variants forbid that type from passing through at all.
- 'Dock' notetag variants allow vehicles to dock there. Boats and ships must
  face the region direction while airships must land directly on top.

---

<Save Event Locations>

- Used for: Maps Notetags
- Saves the locations of all events on the map so that when you return to
  that map at a later point, the events will be in the position they were
  last in.

---

Page Comment Tags

The following comment tags are to be put inside of the pages of events, troops, and common events for them to work!

---

<Page Conditions>
  conditions
  conditions
  conditions
</Page Conditions>

- Used for: Map Event Page, Troop Page, and Common Event Page Comment Tags
- This allows you to create custom page conditions that utilize the
  Conditional Branch event command to see if the additional page conditions
  are met.

---

<Conditions Met>
- Used for: Map Event Page, Troop Page, and Common Event Page Comment Tags
- If used between the <Page Conditions> and </Page Conditions> comment tag,
  upon reaching this part of event command list, the custom page conditions
  will be considered met.

---

EventsMoveCoreCustomPageCondition.png

Example:

◆Comment:<Page Conditions>
◆If:Reid has equipped Potion Sword
  ◆Comment:If Reid has equipped the Potion Sword
:       :<Condition Met>
  ◆
:End
◆Comment:</Page Conditions>

If Reid has the "Potion Sword" weapon equipped, then the additional custom
page conditions are met and the event page will be present/active.

If this is a troop condition, the troop page event will activate.

If this is a common event, there will be a parallel common event active.

---

Event and Event Page Notetags

The following notetags have comment tag variants (with a few exceptions). If a notetag is used for an event, it will affect the event constantly. If a comment tag is used, it will only affect the page the comment tag is on and only that page.

---

EventsMoveCoreActivationRegion.png

<Activation Region: x>
<Activation Regions: x,x,x>

- Used for: Event Notetags and Event Page Comment Tags
- Allows this event to be remotely activated as long as the player is
  standing within a tile marked by a designated region.
- Replace 'x' with the regions you wish to remotely activate this event in.
  - Action Button: Player must press OK while being in the region.
  - Player/Event Touch: Player must step onto the region.
  - Autorun/Parallel: Player be in the region.
- 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.
- NOTE: This cannot be used with any other activation tags.

---

EventsMoveCoreActivationAreas.png

<Activation Square: x>
<Activation Radius: x>
<Activation Row: x>
<Activation Column: x>

- Used for: Event Notetags and Event Page Comment Tags
- Allows this event to be remotely activated as long as the player is
  within range of its activation type.
- Replace 'x' with a number stating the range in tiles.
  - Square: A square-shaped range with the event at the center.
  - Radius: A diamond-shaped range with the event at the center.
  - Row: Spans horizontally across the map. 'x' expands up and down.
  - Column: Spans vertically across the map. 'x' expands left and right.
- 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.
- NOTE: This cannot be used with any other activation tags.

---

<Always Update Movement>

- Used for: Event Notetags and Event Page Comment Tags
- Events normally have to be within screen range for them to update their
  self movement. If this tag is present, the event is always updating.
- 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.

---

EventsMoveCoreClickTrigger.gif

<Click Trigger>

- Used for: Event Notetags and Event Page Comment Tags
- Allows this event to activate upon being clicked on with the mouse.
- 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.

---

<Copy Event: Map x, Event y>
<Copy Event: x, y>

<Copy Event: template>

- Used for: Event Notetags ONLY
- Makes this event copy all of the event settings from a different event
  that can be found on a different map (as long as that map is registered
  inside of Plugin Parameters => Event Template Settings => Preloaded Maps).
- Replace 'x' with a number representing the copied event's Map ID.
- Replace 'y' with a number representing the copied event's Event ID.
- For the 'template' variant, replace 'template' with the name of the
  template made in Plugin Parameters => Event Template Settings =>
  Event Template List.
- 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.

---

EventsMoveCoreHitbox fixed.png

<Hitbox Left: x>
<Hitbox Right: x>
<Hitbox Up: x>
<Hitbox Down: x>

- Used for: Event Notetags and Event Page Comment Tags
- Replace 'x' with a number to extend the hitbox of the event by that many
  tiles towards the listed direction.
- Use multiples of this notetag to extend them to different directions.
- 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.

---

EventsMoveCoreIcon.png

<Icon: x>

- Used for: Event Notetags and Event Page Comment Tags
- Replace 'x' with the Icon ID you wish to put above this event.
- This will not override any Icons designated to the ID through a
  Plugin Command.
- 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.

---

<Icon Buffer X: +x>
<Icon Buffer X: -x>

<Icon Buffer Y: +x>
<Icon Buffer Y: -x>

<Icon Buffer: +x, +y>
<Icon Buffer: -x, -y>

- Used for: Event Notetags and Event Page Comment Tags
- Allows you to adjust the positions of the icon on the envent by buffers.
- Replace 'x' and 'y' with the values to adjust the position buffers by.
- 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.

---

<Icon Blend Mode: Normal>
<Icon Blend Mode: Additive>
<Icon Blend Mode: Multiply>
<Icon Blend Mode: Screen>

- Used for: Event Notetags and Event Page Comment Tags
- Sets the blend mode for the icon on the event.
- 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.

---

EventsMoveCoreLabel.png

<Label: text>

- Used for: Event Notetags and Event Page Comment Tags
- Puts a label over the event's head displaying 'text'.
- Text codes can be used.
- 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.

---

<Label>
text
text
</Label>

- Used for: Event Notetags and Event Page Comment Tags
- Puts a label over the event's head displaying 'text'.
- This can display multiple lines.
- Text codes can be used.
- 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.

---

<Label Range: x>

- Used for: Event Notetags and Event Page Comment Tags
- Sets a range requirement for the player to be in order for the event's
  label to appear.
- Replace 'x' with a number value depicting the range in tiles.
- 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.

---

<Label Offset X: +x>
<Label Offset X: -x>

<Label Offset Y: +x>
<Label Offset Y: -x>

<Label Offset: +x, +y>
<Label Offset: -x, -y>

- Used for: Event Notetags and Event Page Comment Tags
- Allows you to adjust the positions of the label on the envent by offsets.
- Replace 'x' and 'y' with the values to adjust the position offsets by.
- 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.

---

EventsMoveCoreMoveOnlyRegion.gif

<Move Only Region: x>
<Move Only Regions: x,x,x>

- Used for: Event Notetags and Event Page Comment Tags
- Sets the move range of this event to only the region(s) marked by the
  notetag(s) or comment tag(s).
- This will bypass terrain passability.
- This will not bypass event collision.
- 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.

---

EventsMoveCoreMoveSynch.gif

<Move Synch Target: Player>

<Move Synch Target: Event x>

- Used for: Event Notetags and Event Page Comment Tags
- Synchronizes the movement of this event with a target (either the player
  or another event). This event will only move whenever the synchronized
  target moves.
- For 'Event x' variant, replace 'x' with the ID of the event to synch to.
- 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.

---

<Move Synch Type: Random>
<Move Synch Type: Approach>
<Move Synch Type: Away>
<Move Synch Type: Custom>

<Move Synch Type: Mimic>
<Move Synch Type: Reverse Mimic>

<Move Synch Type: Mirror Horizontal>
<Move Synch Type: Mirror Vertical>

- Used for: Event Notetags and Event Page Comment Tags
- Choose the type of movement the event will have if it is synchronized to
  a target.
  - Random: Move to a random position.
  - Approach: Approaches target.
  - Away: Flees from target.
  - Custom: Follows a custom move route.
  - Mimic: Imitates the target's movement style.
  - Reverse Mimic: Does the opposite of the target's movement.
  - Mirror Horizontal: Moves as if a mirror is placed horizontally.
  - Mirror Vertical: Moves as if a mirror is placed vertically.
- 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.

---

<Move Synch Delay: x>

- Used for: Event Notetags and Event Page Comment Tags
- If this tag is present, the event will wait a bit after each move before
  moving again.
- Replace 'x' with the number of movement instances in between.
- 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.

---

<Save Event Location>

- Used for: Event Notetags ONLY
- Saves the locations of the event on the map so that when you return to
  that map at a later point, the event will be in the position it was
  last in.

---

EventsMoveCoreShadow.png

<Hide Shadow>
- Used for: Event Notetags and Event Page Comment Tags
- Hides the shadow for the event.
- 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.

---

<Shadow Filename: filename>

- Used for: Event Notetags and Event Page Comment Tags
- Replaces the shadow graphic used with 'filename' found in the
  img/system/ project folder.
- 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.

---

<Sprite Offset X: +x>
<Sprite Offset X: -x>

<Sprite Offset Y: +x>
<Sprite Offset Y: -x>

<Sprite Offset: +x, +y>
<Sprite Offset: -x, -y>

- Used for: Event Notetags and Event Page Comment Tags
- Changes how much the event's sprite is visibly offset by.
- Replace 'x' and 'y' with numbers indicating the offset in pixels.
- 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.

---

<Step Pattern: Left to Right>
<Step Pattern: Right to Left>

<Step Pattern: Spin Clockwise>
<Step Pattern: Spin CW>

<Step Pattern: Spin CounterClockwise>
<Step Pattern: Spin CCW>
<Step Pattern: Spin AntiClockwise>
<Step Pattern: Spin ACW>

- Used for: Event Notetags and Event Page Comment Tags
- Changes the way the event animates if a tag is present.
  - Left to Right: Makes the event sprite's step behavior go from frame 0 to
    1 to 2, then back to 0 instead of looping backward.
  - Right to Left: Makes the event sprite's step behavior go from frame 2 to
    1 to 0, then back to 2 instead of looping forward.
  - Spin Clockwise: Makes the event sprite's step behavior spin CW.
  - Spin CounterClockwise: Makes the event sprite's step behavior spin CCW.
- 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.

---