Difference between revisions of "Event Sprite Offset (YEP)"
(Created page with "{{MvPlugin |preview = <youtube>https://www.youtube.com/watch?v=ScPX_JpmyR0</youtube> |link1 = <html><iframe src="https://itch.io/embed/399577" height="167" width="552" framebo...") |
|||
(3 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
{{MvPlugin | {{MvPlugin | ||
− | |preview = <youtube>https://www.youtube.com/watch?v=ScPX_JpmyR0</youtube> | + | |preview = <youtube>https://www.youtube.com/watch?v=ScPX_JpmyR0</youtube> |
− | | | + | |link2 = <html><iframe src="https://itch.io/embed/508223" height="167" width="552" frameborder="0"></iframe></html> |
− | | | + | |link3 = <html><iframe src="https://itch.io/embed/398158" height="167" width="552" frameborder="0"></iframe></html> |
}} | }} | ||
Line 9: | Line 9: | ||
{{Yanfly Engine Plugins}} | {{Yanfly Engine Plugins}} | ||
− | == | + | == Introduction == |
<nowiki> | <nowiki> | ||
− | |||
− | |||
− | |||
− | |||
Events are bound to their tiles and their sprites are bound to their events. | Events are bound to their tiles and their sprites are bound to their events. | ||
Naturally, this would mean that the sprites would be bound to the tiles, | Naturally, this would mean that the sprites would be bound to the tiles, | ||
Line 21: | Line 17: | ||
they don't look super uniform all of the time. This plugin gives you the | they don't look super uniform all of the time. This plugin gives you the | ||
ability to offset sprites visually using notetags comment tags. | ability to offset sprites visually using notetags comment tags. | ||
+ | </nowiki> | ||
− | + | {{Notetags MV}} | |
− | Notetags | ||
− | |||
+ | <nowiki> | ||
To offset sprites using the event notetags, using the following below: | To offset sprites using the event notetags, using the following below: | ||
Line 49: | Line 45: | ||
sprite left. Positive y will move the sprite down. Negative y will move | sprite left. Positive y will move the sprite down. Negative y will move | ||
the sprite up. | the sprite up. | ||
+ | </nowiki> | ||
− | + | {{Comment Tags MV}} | |
− | Comment Tags | ||
− | |||
+ | <nowiki> | ||
To offset sprites using comments, make comments for each event page you want | To offset sprites using comments, make comments for each event page you want | ||
the sprite to be offset in using the comment tags below: | the sprite to be offset in using the comment tags below: | ||
Line 81: | Line 77: | ||
the sprite up. | the sprite up. | ||
*NOTE*: This will take priority over event notetag sprite offsets. | *NOTE*: This will take priority over event notetag sprite offsets. | ||
+ | </nowiki> | ||
− | + | {{Script Calls MV}} | |
− | |||
− | |||
+ | ; Custom Movement Route | ||
+ | |||
+ | <nowiki> | ||
If you wish to change an event sprite's offset after a page has been loaded, | If you wish to change an event sprite's offset after a page has been loaded, | ||
you can issue a custom movement route script calls to alter it: | you can issue a custom movement route script calls to alter it: | ||
Line 108: | Line 106: | ||
comment tags. A positive X goes right, a negative X goes left. A positive | comment tags. A positive X goes right, a negative X goes left. A positive | ||
Y goes down, a negative Y goes up. | Y goes down, a negative Y goes up. | ||
+ | </nowiki> | ||
− | == | + | == Changelog == |
− | Changelog | ||
− | |||
+ | <nowiki> | ||
Version 1.00: | Version 1.00: | ||
- Finished Plugin! | - Finished Plugin! | ||
− | |||
− | |||
− | |||
</nowiki> | </nowiki> | ||
+ | |||
+ | <!-- This is a comment, remove the arrows surrounding this for the categories you want to show --> | ||
+ | <!-- [[Category: RPG Maker MV Core Plugins]] --> | ||
+ | <!-- [[Category: RPG Maker MV Battle Plugins]] --> | ||
+ | <!-- [[Category: RPG Maker MV Item Plugins]] --> | ||
+ | <!-- [[Category: RPG Maker MV Skill Plugins]] --> | ||
+ | <!-- [[Category: RPG Maker MV Equip Plugins]] --> | ||
+ | <!-- [[Category: RPG Maker MV Status Menu Plugins]] --> | ||
+ | <!-- [[Category: RPG Maker MV Gameplay Plugins]] --> | ||
+ | <!-- [[Category: RPG Maker MV Movement Plugins]] --> | ||
+ | <!-- [[Category: RPG Maker MV Quest Plugins]] --> | ||
+ | <!-- [[Category: RPG Maker MV Options Plugins]] --> | ||
+ | <!-- [[Category: RPG Maker MV Eventing Plugins]] --> | ||
+ | <!-- [[Category: RPG Maker MV Utility Plugins]] --> | ||
+ | <!-- [[Category: RPG Maker MV Mechanical Plugins]] --> | ||
+ | [[Category: RPG Maker MV Visual Plugins]] | ||
+ | <!-- [[Category: RPG Maker MV Menu Plugins]] --> | ||
+ | <!-- [[Category: RPG Maker MV Message Plugins]] --> | ||
+ | <!-- [[Category: RPG Maker MV Quality of Life Plugins]] --> | ||
+ | <!-- [[Category: RPG Maker MV Plugin Tips & Tricks]] --> | ||
+ | <!-- [[Category: Action Sequences (MV)]] --> | ||
+ | <!-- [[Category: Comment Tags (MV)]] --> | ||
+ | <!-- [[Category: Main Menu Manager Integration (MV)]] --> | ||
+ | <!-- [[Category: Notetags (MV)]] --> | ||
+ | <!-- [[Category: Options Core Integration (MV)]] --> | ||
+ | <!-- [[Category: Plugin Commands (MV)]] --> | ||
+ | <!-- [[Category: Script Calls (MV)]] --> | ||
+ | <!-- [[Category: Text Codes (MV)]] --> |
Latest revision as of 11:04, 13 June 2020
VisuStella, Caz Wolf, Fallen Angel Olivia, Atelier Irina, and other affiliated content creators.
Download
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.
Yanfly Engine Plugins
This plugin is a part of the Yanfly Engine Plugins library.
Introduction
Events are bound to their tiles and their sprites are bound to their events. Naturally, this would mean that the sprites would be bound to the tiles, too, but sometimes, we'd like to offset the appearance of sprites so that they don't look super uniform all of the time. This plugin gives you the ability to offset sprites visually using notetags comment tags.
Notetags
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: <Sprite Offset X: +n> <Sprite Offset X: -n> - Replace 'n' with the number of pixels you wish to offset the horizontal position of the sprite by. A positive number moves the sprite to the right. A negative number moves the sprite to the left. <Sprite Offset Y: +n> <Sprite Offset Y: -n> - Replace 'n' with the number of pixels you wish to offset the vertical position of the sprite by. A positive number moves the sprite down. A negative number moves the sprite up. <Sprite Offset: +x, +y> <Sprite Offset: -x, -y> - If you wish to put sprite offset information on one line, use the above comment tag instead. Replace 'x' and 'y' with the values to offset the sprite by. Positive x will move the sprite right. Negative x will move the sprite left. Positive y will move the sprite down. Negative y will move the sprite up.
Comment Tags
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: <Sprite Offset X: +n> <Sprite Offset X: -n> - Replace 'n' with the number of pixels you wish to offset the horizontal position of the sprite by. A positive number moves the sprite to the right. A negative number moves the sprite to the left. *NOTE*: This will take priority over event notetag sprite offsets. <Sprite Offset Y: +n> <Sprite Offset Y: -n> - Replace 'n' with the number of pixels you wish to offset the vertical position of the sprite by. A positive number moves the sprite down. A negative number moves the sprite up. *NOTE*: This will take priority over event notetag sprite offsets. <Sprite Offset: +x, +y> <Sprite Offset: -x, -y> - If you wish to put sprite offset information on one line, use the above comment tag instead. Replace 'x' and 'y' with the values to offset the sprite by. Positive x will move the sprite right. Negative x will move the sprite left. Positive y will move the sprite down. Negative y will move the sprite up. *NOTE*: This will take priority over event notetag sprite offsets.
Script Calls
Script Calls are event commands that are used to run JavaScript code during an event to call upon unique functions, usually added by the related plugin.
Here is a list of Script Call(s) that you may use:
- Custom Movement Route
If you wish to change an event sprite's offset after a page has been loaded, you can issue a custom movement route script calls to alter it: Script Call: this._spriteOffsetX = n this._spriteOffsetY = n - This sets the sprite offset X or Y values to 'n'. The same rules apply as the comment tags. A positive X goes right, a negative X goes left. A positive Y goes down, a negative Y goes up. this._spriteOffsetX += n this._spriteOffsetY += n - Increases the sprite's offset X or Y by 'n'. The same rules apply as the comment tags. A positive X goes right, a negative X goes left. A positive Y goes down, a negative Y goes up. this._spriteOffsetX -= n this._spriteOffsetY -= n - Decreases the sprite's offset X or Y by 'n'. The same rules apply as the comment tags. A positive X goes right, a negative X goes left. A positive Y goes down, a negative Y goes up.
Changelog
Version 1.00: - Finished Plugin!