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

From Yanfly.moe Wiki
Jump to navigation Jump to search
(Event Location Plugin Commands)
Line 594: Line 594:
 
Player Icon: Delete
 
Player Icon: Delete
 
- Delete the icon that appears on the player.
 
- Delete the icon that appears on the player.
 +
</pre>
 +
 +
---
 +
 +
=== Self Data Plugin Commands ===
 +
 +
---
 +
 +
[[File:EventsMoveCore_Update97_Command1.png]]
 +
 +
<pre>
 +
Self Data: Reset All
 +
- Reset the Self Switch and Self Variable data of all events within the
 +
  specified map.
 +
 +
  Map ID:
 +
  - The map the target map. Use 0 for current map.
 +
  - You may use JavaScript code.
 
</pre>
 
</pre>
  

Revision as of 12:20, 23 June 2022

The following are Plugin Commands that come with this plugin. They can be accessed through the Plugin Command event command.

---

Auto Movement Plugin Commands

---

ZaWarudo.gif

EventsMoveCore PluginCommand 1.png

Auto Movement: Events
- Allow/stop events from auto movement.

  Value:
  - Allow events to move automatically?

---

Call Event Plugin Commands

---

EventsMoveCore PluginCommand 2.png

Call Event: Remote Activation
- Runs the page of a different event remotely.

  Map ID:
  - Target event's map. Use 0 for current map.
  - You may use JavaScript code.

  Event ID:
  - The ID of the event to remotely run.
  - Use 0 for current event.
  - You may use JavaScript code.

  Page ID:
  - The page of the remote event to run.
  - You may use JavaScript code.

---

Dash Plugin Commands

---

EventsMoveCore PluginCommand 3.png

Dash Enable: Toggle
- Enable/Disable Dashing on maps.

  Value:
  - What do you wish to change dashing to?

---

Event Icon Plugin Commands

---

EventsMoveCoreIcon.png

EventsMoveCore PluginCommand 4.png

Event Icon: Change
- Change the icon that appears on an event.

  Map ID:
  - The map the target map. Use 0 for current map.
  - You may use JavaScript code.

  Event ID:
  - The ID of the target event.
  - Use 0 for current event.
  - You may use JavaScript code.

  Icon Index:
  - Icon index used for the icon.
  - You may use JavaScript code.

  Buffer X:
  - How much to shift the X position by?
  - You may use JavaScript code.

  Buffer Y:
  - How much to shift the Y position by?
  - You may use JavaScript code.

  Blend Mode:
  - What kind of blend mode do you wish to apply to the icon sprite?

---

EventsMoveCore PluginCommand 5.png

Event Icon: Delete
- Delete the icon that appears on an event.

  Map ID:
  - The map the target map. Use 0 for current map.
  - You may use JavaScript code.

  Event ID:
  - The ID of the target event.
  - Use 0 for current event.
  - You may use JavaScript code.

---

Event Label Plugin Commands

---

EventsMoveCoreLabel.png

EventsMoveCore PluginCommand 6.png

Event Label: Refresh
- Refresh all Event Labels on screen.
- This is used to refresh page conditions for map changes that don't
  force a refresh.

---

EventsMoveCore PluginCommand 7.png

Event Label: Visible
- Change the visibility of Event Labels.

  Visibility:
  - What do you wish to change visibility to?

---

Event Location Plugin Commands

---

EventsMoveCore PluginCommand 8.png

Event Location: Save
- Memorize an event's map location so it reappears there the next time the
  map is loaded.

  Event ID:
  - The ID of the target event.
  - You may use JavaScript code.

---

EventsMoveCore PluginCommand 9.png

Event Location: Delete
- Deletes an event's saved map location.
- The event will reappear at its default location.

  Map ID:
  - The map the target map. Use 0 for current map.
  - You may use JavaScript code.

  Event ID:
  - The ID of the target event.
  - Use 0 for current event.
  - You may use JavaScript code.

---

EventsMoveCore PluginCommand 10.png

Event Location: Create
- Creates a custom spawn location for a specific map's event so it appears
  there the next time the map is loaded.

  Map ID:
  - The map the target map. Use 0 for current map.
  - You may use JavaScript code.

  Event ID:
  - The ID of the target event.
  - Use 0 for current event.
  - You may use JavaScript code.

  X Coordinate:
  - The X coordinate of the event.
  - You may use JavaScript code.

  Y Coordinate:
  - The Y coordinate of the event.
  - You may use JavaScript code.

  Direction:
  - The direction the event will be facing.

  Optional:

    Page ID:
    - The page of the event to set the move route to.
    - You may use JavaScript code.

    Move Route Index:
    - The point in the move route for this event to be at if the page ID
      matches the rest of the page conditions.

---

Event Timer Plugin Commands

---

EventsMoveCore Update25 Command1.png

Event Timer: Change Speed
- Changes the timer frame decrease (or increase) speed.

  Speed:
  - How many 1/60ths of a second does each frame increase or decrease by?
  - Negative decreases.
  - Positive increases.
  - JavaScript allowed.

---

EventsMoveCore Update25 Command2.png

Event Timer: Expire Event Assign
- Sets a Common Event to run upon expiration.
- Bypasses the default code if one is set.

  Common Event ID:
  - Select the Common Event to run upon the timer's expiration.

---

EventsMoveCore Update25 Command3.png

Event Timer: Expire Event Clear
- Clears any set to expire Common Event and instead, run the default
  Game_Timer expiration code.

---

EventsMoveCore Update25 Command4.png

Event Timer: Frames Gain
- Chooses how many frames, seconds, minutes, or hours are gained or lost for
  the event timer.

  Frames:
  - How many 1/60ths of a second are gained/lost?
  - Positive for gain.
  - Negative for lost.
  - JavaScript allowed.

  Seconds:
  - How many seconds are gained/lost?
  - Positive for gain.
  - Negative for lost.
  - JavaScript allowed.

  Minutes:
  - How many minutes are gained/lost?
  - Positive for gain.
  - Negative for lost.
  - JavaScript allowed.

  Hours:
  - How many hours are gained/lost?
  - Positive for gain.
  - Negative for lost.
  - JavaScript allowed.

---

EventsMoveCore Update25 Command5.png

Event Timer: Frames Set
- Chooses how many frames, seconds, minutes, or hours are set for the event
  timer.

  Frames:
  - Set frame count to this value.
  - Each frame is 1/60th of a second.
  - JavaScript allowed.

  Seconds:
  - Set seconds to this value.
  - JavaScript allowed.

  Minutes:
  - Set minutes to this value.
  - Each minute is 60 seconds.
  - JavaScript allowed.

  Hours:
  - Set hours to this value.
  - Each hour is 60 minutes.
  - JavaScript allowed.

---

EventsMoveCore Update25 Command6.png

Event Timer: Pause
- Pauses the current event timer, but does not stop it.

---

EventsMoveCore Update25 Command7.png

Event Timer: Resume
- Resumes the current event timer from the paused state.

---

Follower Control Plugin Commands

---

EventsMoveCore Update18 Command1.png

Follower: Set Global Chase
- Disables all followers from chasing the player or reenables it.

  Chase:
  - Sets all followers to chase the player or not.

---

EventsMoveCore Update18 Command2.png

Follower: Set Target Chase
- Disables target follower from chasing the player or reenables it.

  Follower ID:
  - Select which follower ID to disable/reenable chasing for.

  Chase:
  - Sets target follower to chase its target or not.

---

EventsMoveCore Update18 Command3.png

Follower: Set Control
- Sets the event commands to target a follower when "Player" is selected as
  the target.

  Follower ID:
  - Select which follower ID to control.
  - 0 is the player.

---

EventsMoveCore Update18 Command4.png

Follower: Reset
- Resets all follower controls. Event Commands that target the "Player"
  return to normal and followers chase again.

---

Global Switch Plugin Commands

---

EventsMoveCoreCommandGlobal1.png

Global Switch: Get Self Switch A B C D
- Gets the current ON/OFF value from a Self Switch and stores it onto a
  Global Switch.

  Map ID:
  - The map the source map. Use 0 for current map.
  - You may use JavaScript code.

  Event ID:
  - The ID of the source event.
  - Use 0 for current event.
  - You may use JavaScript code.

  Letter:
  - Letter of the target event's Self Switch to obtain data from.

  -

  Target Switch ID:
  - The ID of the target switch.

---

EventsMoveCoreCommandGlobal2.png

Global Switch: Get Self Switch ID
- Gets the current ON/OFF value from a Self Switch and stores it onto a
  Global Switch.

  Map ID:
  - The map the source map. Use 0 for current map.
  - You may use JavaScript code.

  Event ID:
  - The ID of the source event.
  - Use 0 for current event.
  - You may use JavaScript code.

  Switch ID:
  - The ID of the source switch.

  -

  Target Switch ID:
  - The ID of the target switch.

---

Global Variable Plugin Commands

---

EventsMoveCoreCommandGlobal3.png

Global Variable: Get Self Variable ID
- Gets the current stored value from a Self Variable and stores it onto a
  Global Variable.

  Map ID:
  - The map the source map. Use 0 for current map.
  - You may use JavaScript code.

  Event ID:
  - The ID of the source event.
  - Use 0 for current event.
  - You may use JavaScript code.

  Variable ID:
  - The ID of the source variable.

  -

  Target Variable ID:
  - The ID of the target variable.

---

Morph Event Plugin Commands

---

EventsMoveCore PluginCommand 11.png

Morph Event: Change
- Runs the page of a different event remotely.

  Step 1:

    Map ID:
    - Target event's map. Use 0 for current map.
    - You may use JavaScript code.

    Event ID:
    - The ID of the target event.
    - Use 0 for current event.
    - You may use JavaScript code.

  Step 2:

    Template Name:
    - Name of the target event template to morph into.
    - Ignored if this is called "Untitled".

    Map ID:
    - Target event's map. Use 0 for current map.
    - You may use JavaScript code.

    Event ID:
    - The ID of the target event.
    - Use 0 for current event.
    - You may use JavaScript code.

    Preserve Morph:
    - Is the morph effect preserved?
    - Or does it expire upon leaving the map?

---

EventsMoveCore PluginCommand 12.png

Morph Event: Remove
- Remove the morph status of an event.

  Map ID:
  - Target event's map. Use 0 for current map.
  - You may use JavaScript code.

  Event ID:
  - The ID of the event to remotely run.
  - Use 0 for current event.
  - You may use JavaScript code.

  Remove Preservation:
  - Also remove the preservation effect?

---

Player Icon Plugin Commands

---

EventsMoveCoreIcon.png

EventsMoveCore PluginCommand 13.png

Player Icon: Change
- Change the icon that appears on on the player.

  Icon Index:
  - Icon index used for the icon.
  - You may use JavaScript code.

  Buffer X:
  - How much to shift the X position by?
  - You may use JavaScript code.

  Buffer Y:
  - How much to shift the Y position by?
  - You may use JavaScript code.

  Blend Mode:
  - What kind of blend mode do you wish to apply to the icon sprite?

---

EventsMoveCore PluginCommand 14.png

Player Icon: Delete
- Delete the icon that appears on the player.

---

Self Data Plugin Commands

---

EventsMoveCore Update97 Command1.png

Self Data: Reset All
- Reset the Self Switch and Self Variable data of all events within the
  specified map.

  Map ID:
  - The map the target map. Use 0 for current map.
  - You may use JavaScript code.

---

Self Switch Plugin Commands

---

EventsMoveCore PluginCommand 15.png

Self Switch: A B C D
- Change the Self Switch of a different event.

  Map ID:
  - The map the target map. Use 0 for current map.
  - You may use JavaScript code.

  Event ID:
  - The ID of the target event.
  - Use 0 for current event.
  - You may use JavaScript code.

  Letter:
  - Letter of the target event's Self Switch to change.

  Value:
  - What value do you want to set the Self Switch to?

---

EventsMoveCoreSelfSwitchesVariables.png

EventsMoveCore PluginCommand 16.png

Self Switch: Switch ID
- Change the Self Switch of a different event.

  Map ID:
  - The map the target map. Use 0 for current map.
  - You may use JavaScript code.

  Event ID:
  - The ID of the target event.
  - Use 0 for current event.
  - You may use JavaScript code.

  Switch ID:
  - The ID of the target switch.

  Value:
  - What value do you want to set the Self Switch to?

---

Self Variable Plugin Commands

---

EventsMoveCoreSelfSwitchesVariables.png

EventsMoveCore PluginCommand 17.png

Self Variable: Variable ID
- Change the Self Variable of a different event.

  Map ID:
  - The map the target map. Use 0 for current map.
  - You may use JavaScript code.

  Event ID:
  - The ID of the target event.
  - Use 0 for current event.
  - You may use JavaScript code.

  Variable ID:
  - The ID of the target variable.

  Value:
  - What value do you want to set the Self Switch to?

---

Spawn Event Plugin Commands

---

EventsMoveCore PluginCommand 18.png

Spawn Event: Spawn At X, Y
- Spawns desired event at X, Y location on the current map.

  Step 1:

    Template Name:
    - Name of the target event template to spawn as.
    - Ignored if this is called "Untitled".

    Map ID:
    - Target event's map to be used as reference.
    - You may use JavaScript code.

    Event ID:
    - The ID of the target event to be used as reference.
    - You may use JavaScript code.

  Step 2:

    X Coordinate:
    - Target Location to spawn at.
    - You may use JavaScript code.

    Y Coordinate:
    - Target Location to spawn at.
    - You may use JavaScript code.

    Check Event Collision:
    - Check collision with any other events and player?

    Check Passability:
    - Check passability of the target location.

    Preserve Spawn:
    - Is the spawned event preserved?
    - Or does it expire upon leaving the map?

  Step 3:

    Success Switch ID:
    - Target switch ID to record spawning success.
    - Ignore if ID is 0. OFF means failed. ON means success.

---

EventsMoveCore PluginCommand 19.png

Spawn Event: Spawn At Region
- Spawns desired event at a random region-marked location on the
  current map.

  Step 1:

    Template Name:
    - Name of the target event template to spawn as.
    - Ignored if this is called "Untitled".

    Map ID:
    - Target event's map to be used as reference.
    - You may use JavaScript code.

    Event ID:
    - The ID of the target event to be used as reference.
    - You may use JavaScript code.

  Step 2:

    Region ID(s):
    - Pick region(s) to spawn this event at.

    Check Event Collision:
    - Check collision with any other events and player?

    Check Passability:
    - Check passability of the target location.

    Preserve Spawn:
    - Is the spawned event preserved?
    - Or does it expire upon leaving the map?

  Step 3:

    Success Switch ID:
    - Target switch ID to record spawning success.
    - Ignore if ID is 0. OFF means failed. ON means success.

---

EventsMoveCore Update20 Command1.png

Spawn Event: Spawn At Terrain Tag
- Spawns desired event at a random terrain tag-marked location on the
  current map.

  Step 1:

    Template Name:
    - Name of the target event template to spawn as.
    - Ignored if this is called "Untitled".

    Map ID:
    - Target event's map to be used as reference.
    - You may use JavaScript code.

    Event ID:
    - The ID of the target event to be used as reference.
    - You may use JavaScript code.

  Step 2:

    Terrain Tag(s):
    - Pick terrain tag(s) to spawn this event at.
    - Insert numbers between 0 and 7.

    Check Event Collision:
    - Check collision with any other events and player?

    Check Passability:
    - Check passability of the target location.

    Preserve Spawn:
    - Is the spawned event preserved?
    - Or does it expire upon leaving the map?

  Step 3:

    Success Switch ID:
    - Target switch ID to record spawning success.
    - Ignore if ID is 0. OFF means failed. ON means success.

---

EventsMoveCore PluginCommand 20.png

Spawn Event: Despawn Event ID
- Despawns the selected Event ID on the current map.

  Event ID
  - The ID of the target event.
  - You may use JavaScript code.

---

EventsMoveCore PluginCommand 21.png

Spawn Event: Despawn At X, Y
- Despawns any spawned event(s) at X, Y location on the current map.

  X Coordinate:
  - Target Location to despawn at.
  - You may use JavaScript code.

  Y Coordinate:
  - Target Location to despawn at.
  - You may use JavaScript code.

---

EventsMoveCore PluginCommand 22.png

Spawn Event: Despawn Region(s)
- Despawns the selected Region(s).

  Region ID(s)
  - Pick region(s) and despawn everything inside it.

---

EventsMoveCore Update20 Command2.png

Spawn Event: Despawn Terrain Tag(s)
- Despawns the selected Terrain Tags(s) on the current map.

  Terrain Tag(s):
  - Pick terrain tag(s) and despawn everything inside it.
  - Insert numbers between 0 and 7.

---

EventsMoveCore PluginCommand 23.png

Spawn Event: Despawn Everything
- Despawns all spawned events on the current map.

---