Event Step Animation Options (YEP)

From Yanfly.moe Wiki
Jump to navigation Jump to search


System

This is a plugin created for RPG Maker MV.

For help on how to install plugins, click here.

For help on how to update plugins, click here.

Got errors with your RPG Maker MV plugin? Click here.

Download

Yanfly Engine Plugins

This plugin is a part of the Yanfly Engine Plugins library.


Introduction

When setting events to have a stepping animation, RPG Maker MV would animate
them with a "ping-pong" format where it will go from frame 0 to 1 to 2 to 1
back to 0. In some cases, devs would like to animate their sprites in a
different format, perhaps 0-1-2-0-1-2 or in reverse: 2-1-0-2-1-0. This
plugin will also give events the option to spin in place while stepping.

Notetags

NotetagsMV.png

RPG Maker MV'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 offset sprites using the event notetags, using the following below:

Event Notetags:

  <Step Animation: 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 backwards.

  <Step Animation: 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 forwards.

  <Step Animation: Spin Clockwise>
  <Step Animation: Spin CW>
  - Makes the event sprite's step behavior spin itself clockwise.

  <Step Animation: Spin CounterClockwise>
  <Step Animation: Spin CCW>
  <Step Animation: Spin AntiClockwise>
  <Step Animation: Spin ACW>
  - Makes the event sprite's step behavior spin itself counterclockwise.

Comment Tags

CommentTags.png

Comment Tags are similar to Notetags. RPG Maker MV's editor is unable to allow for custom traits/properties that a game dev may wish to associate with an event or common event. Comment Tags are used to work around such limitations by allowing the game dev to tag certain traits/properties using specific Comment Tags declared by the related plugin.

Here is a list of Comment Tag(s) that you may use.

To offset sprites using comments, make comments for each event page you want
the sprite to be offset in using the comment tags below:

Comment Tags:

  <Step Animation: 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 backwards.
  *NOTE*: This will take priority over event notetag step animations.

  <Step Animation: 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 forwards.
  *NOTE*: This will take priority over event notetag step animations.

  <Step Animation: Spin Clockwise>
  <Step Animation: Spin CW>
  - Makes the event sprite's step behavior spin itself clockwise.
  *NOTE*: This will take priority over event notetag step animations.

  <Step Animation: Spin CounterClockwise>
  <Step Animation: Spin CCW>
  <Step Animation: Spin AntiClockwise>
  <Step Animation: Spin ACW>
  - Makes the event sprite's step behavior spin itself counterclockwise.
  *NOTE*: This will take priority over event notetag step animations.

Changelog

Version 1.00:
- Finished Plugin!