Introduction

Currently, RPG Maker has a very basic Jump mechanic. That also only works via move route or script calls commands.

This plugin implements several new features for jump mechanics! Using buttons, triggering events exclusively by jumping on them and other ones!

Features

• Add a jump button!
• Can choose a sound to play when jumping.
• Can use a variable value to define how far the player will jump.
• Can set up the conditions that allow the player to jump or not, through a list of possible ones in plugin parameters.
• Add an impulse feature that changes the jump distance if the player is walking or dashing!
• Can block Jump with the region, event note tag, or switch!
• Can use a variable value to define a plus value to the jump height/peak.
• Auto turn on/off a switch when the player is jumping.
• Play a common event when the player finishes a jump.
• Optionally prevent jump-in-place animation when you can't jump.
• The script calls to Jump Forward, Jump into coordinates, and jump on a character
• Works with normal directions and diagonals!

How to use

Block/Prevent Jump

You can prevent the character from jumping over things with a region ID or using the event note tag(not case sensitive): <BlockJump>

You can also unblock the block jump with comment commands for specific event pages by writing on any comment:<UnblockJump>(not case sensitive). 

But for the plugin know you want it to search for comments on the event page, you also need to use another note tag: <IterateList> (It is not case sensitive). Or you can leave the “Always Iteralte Event List” plugin parameter from the EliMZ Book to true.

You can also disable the jump feature for the player using the block switch specified on the plugin parameter.

Alternatively, can also use the plugin command to change the event block jump condition.

Jump Height

You can change the jump height of the player by changing the variable value with the ID defined on the plugin parameter.

You can also change the Event jump peak/height with the following script call(Or with plugin commands):

• $gameMap.event(ID).setPlusJumpPeak(value)

The value will be added to the current and static jump peak value from the player/event (10) defined by the engine.

Activate Player touch events by jump

If you have an event with the trigger Player Touch, you can simulate an effect that will only trigger this event when the player jumps on it.

By default, if you use a conditional branch in this event with the script call $gamePlayer.isJumping() it will not work. Because at the moment the player touches the event while jumping, the default RPG Maker code already “sets this function to false”.

But with the Jumping Switch, I provided a feature that allows you to check if the player touches the event by walking on it or jumping on it.

You just need to put a conditional branch using the jumping switch. If it is ON, then the event will notice that it was activated by jumping.

Plugin Parameters

• Keyboard / Gamepad Button → The buttons used on both devices to execute the jump.
• Overwrite Keys → If true, the buttons above will be able to overwrite the default RPG Maker keys.
• Jump Distance → A variable that will hold the distance the player can jump, measured in tiles.
• Jump Height/peak → How high a jump can go. Measure in Pixels.
• Enable Diagonal Jump
• Diagonal Distance Penalty → optionally reduces an X amount of tiles/value from the jump distance when jumping diagonally. → If true, the player will be able to jump diagonally.
• Block Jump Regions / Terrain Tags → List here all the region IDs and Terrain Tags that will prevent the player from jumping over them. Separate each one with a comma. Can use multiple operators (But variables will not work).
• Disable jump Switch → If this switch is true, the player will not be able to jump.
• Jump Switch → This switch will always be true when the player is jumping.
• Landing Common Event → Plays a common event when the player finishes jumping.
• Allow Jump In Place → If true, even if the player cannot jump or the jump distance is 0, it will jump in the same place. Set to false to not jump at all. Only works with Jump Forward feature.
• Jumping Plus Z-Index → A Z index plus/extra value to add for the character when they are jumping.
• Jump Se → A sound to be played when a character jumps. You can also set a Pitch and Pan value.

Jump Check

There is a function that will check if the character can land on his jump destination, otherwise, it will jump in the closest destination possible or in the same place.

This is necessary for the character not to jump outside the screen or in places where he cannot move. 

But you still can choose some restrictions about this jumping behavior:

• Can Jump → The character will only be able to jump if the following conditions are true:
  • It is not inside a vehicle.
  • The X and Y land coordinates are valid map coordinates.
  • The X and Y land coordinates are passable through the direction it is facing.
  • There is no event on the X and Y land coordinates that is Normal priority(Same as characters).

The others below, all include these conditions above, but also, plus ones:

• Can jump only to the same regions
• Can jump only to higher regions
• Can jump only to lower regions
• Can jump only to the same terrain tag
• Can jump only to higher terrain tag
• Can jump only to lower terrain tag

It will check the current region/terrain tag that the character has, and if it matches the condition of being equal, higher, or lower, it will be able to jump.

Impulse

There is also the Impulse parameter. Once it is enabled, the jump value is changed by a value you choose when the player is walking or dashing.

This only works for the player.

Plugin Commands

For all character id and Jumper Character Id, arguments:

• 0 For this event, -1 For player, -2 First follower, "Ship", "Boat", "Airship" or an event Id.
• They accept multiple operators.

Jump Forward

Makes the character jump forward(into the direction he is facing).

• Character Id → Separate by comma, each character id that will jump forward.
• Distance → The distance the characters will jump. Can use \v[id] or formulas.
• Jump Peak → Change the jump peak value. Only works for events and vehicles.

Jump to Coordinates

• Character Id → Separate by comma, each character id that will jump forward.
• Coordinates → Separate x and y by comma. Can use \v[id] or formulas.
• Jump Peak → Change the jump peak value. Only works for events and vehicles.

Jump To Character

• Jumper Character Id → Separate by a comma, each character ID that will jump.
• Target Character Id → A single character ID that will be used as a target for the jumper characters.
• Jump Peak → Change the jump peak value. Only works for events and vehicles.

Event Block Jump

• Event Ids → Set what events IDS will block/unblock the player from jumping over them.
• Block Jump → You can set it to true, false, or toggle.

Script Calls

Replace character with:

• $gamePlayer → Player
• $gameMap.event(ID) → Map event
• $gamePlayer.followers()._data[ID] → 0 is the first follower, 1 is the second, etc.
• $gameMap.vehicles()[ID] → 0 for boat, 1 for ship, 2 for airship.

Replace charId with:

• -1 → Player
• -2 → Follower 1 (etc)
• 1, 2, 3 → Event Id
• "ship", "boat", "airship" → Vehicle

Jump to a specific coordinate¹: 

• character.jumpTo(x, y)

Jump to a character coordinate¹: 

• character.jumpToCharacter(charId)

Jump forward: 

• character.jumpForward(value)

Replace "value" with a number.

You can use these scripts on the move route too. There is also an equivalent in plugin commands for MZ.

NOTE 1: These two commands work like the default jump command(from the move route). Meaning that they will not follow the jump-check conditions. Only the jump forward will follow the jump check plugin parameter.

Help File | Terms of use | Sample Project