Difference between revisions of "Template:VisuMZ Core Engine Plugin Commands"

From Yanfly.moe Wiki
Jump to navigation Jump to search
(System Plugin Commands)
Line 3: Line 3:
 
The following are Plugin Commands that come with this plugin. They can be
 
The following are Plugin Commands that come with this plugin. They can be
 
accessed through the Plugin Command event command.
 
accessed through the Plugin Command event command.
 +
 +
---
 +
 +
=== Export Plugin Commands ===
 +
 +
[[File:CoreEngine_Update39_Command1.png|600px]]
 +
 +
---
 +
 +
<pre>
 +
Export: All Maps Text
 +
- PLAY TEST ONLY. Exports all of the text from all maps,
 +
  their events, event pages, and any associated Common Events.
 +
 +
  - Exports 'Show Text' event commands.
 +
  - Exports 'Show Choices' event commands.
 +
  - Exports 'Show Scrolling Text' event commands.
 +
  - Exports 'Comments' event commands.
 +
  - Only the raw text will be exported.
 +
  - Only usable during Play Test.
 +
</pre>
 +
 +
---
 +
 +
<pre>
 +
Export: All Troops Text
 +
- PLAY TEST ONLY. Exports all of the text from all troops,
 +
  their event pages, and any associated Common Events.
 +
 +
  - Exports 'Show Text' event commands.
 +
  - Exports 'Show Choices' event commands.
 +
  - Exports 'Show Scrolling Text' event commands.
 +
  - Exports 'Comments' event commands.
 +
  - Only the raw text will be exported.
 +
  - Only usable during Play Test.
 +
</pre>
 +
 +
---
 +
 +
<pre>
 +
Export: Current Map Text
 +
- PLAY TEST ONLY. Exports all of the text on the current map,
 +
  its events, the event pages, and any associated Common Events.
 +
 +
  - Exports 'Show Text' event commands.
 +
  - Exports 'Show Choices' event commands.
 +
  - Exports 'Show Scrolling Text' event commands.
 +
  - Exports 'Comments' event commands.
 +
  - Only the raw text will be exported.
 +
  - Only usable during Play Test.
 +
  - If not in battle, this Plugin Command will not work.
 +
</pre>
 +
 +
---
 +
 +
<pre>
 +
Export: Current Troop Text
 +
- PLAY TEST ONLY. Exports all of the text on the current troop,
 +
  the troop's event pages, and any associated Common Events.
 +
 +
  - Exports 'Show Text' event commands.
 +
  - Exports 'Show Choices' event commands.
 +
  - Exports 'Show Scrolling Text' event commands.
 +
  - Exports 'Comments' event commands.
 +
  - Only the raw text will be exported.
 +
  - Only usable during Play Test.
 +
  - If not in battle, this Plugin Command will not work.
 +
</pre>
  
 
---
 
---

Revision as of 14:37, 14 May 2021


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

---

Export Plugin Commands

CoreEngine Update39 Command1.png

---

Export: All Maps Text
- PLAY TEST ONLY. Exports all of the text from all maps,
  their events, event pages, and any associated Common Events.

  - Exports 'Show Text' event commands.
  - Exports 'Show Choices' event commands.
  - Exports 'Show Scrolling Text' event commands.
  - Exports 'Comments' event commands.
  - Only the raw text will be exported.
  - Only usable during Play Test.

---

Export: All Troops Text
- PLAY TEST ONLY. Exports all of the text from all troops,
  their event pages, and any associated Common Events.

  - Exports 'Show Text' event commands.
  - Exports 'Show Choices' event commands.
  - Exports 'Show Scrolling Text' event commands.
  - Exports 'Comments' event commands.
  - Only the raw text will be exported.
  - Only usable during Play Test.

---

Export: Current Map Text
- PLAY TEST ONLY. Exports all of the text on the current map,
  its events, the event pages, and any associated Common Events.

  - Exports 'Show Text' event commands.
  - Exports 'Show Choices' event commands.
  - Exports 'Show Scrolling Text' event commands.
  - Exports 'Comments' event commands.
  - Only the raw text will be exported.
  - Only usable during Play Test.
  - If not in battle, this Plugin Command will not work.

---

Export: Current Troop Text
- PLAY TEST ONLY. Exports all of the text on the current troop,
  the troop's event pages, and any associated Common Events.

  - Exports 'Show Text' event commands.
  - Exports 'Show Choices' event commands.
  - Exports 'Show Scrolling Text' event commands.
  - Exports 'Comments' event commands.
  - Only the raw text will be exported.
  - Only usable during Play Test.
  - If not in battle, this Plugin Command will not work.

---

Game Plugin Commands

---

CoreEnginePluginCommand01.png

Game: Open URL
- Opens a website URL from the game.

  URL:
  - Where do you want to take the player?

---

Gold Plugin Commands

---

CoreEnginePluginCommand02.png

Gold: Gain/Lose
- Allows you to give/take more gold than the event editor limit.

  Value:
  - How much gold should the player gain/lose?
  - Use negative values to remove gold.

---

Picture Plugin Commands

---

CoreEnginePluginCommand03.png

CoreEnginePluginCommand03a.png

Picture: Easing Type
- Changes the easing type to a number of options.

  Picture ID:
  - Which picture do you wish to apply this easing to?

  Easing Type:
  - Select which easing type you wish to apply.

  Instructions:
  - Insert this Plugin Command after a "Move Picture" event command.
  - Turn off "Wait for Completion" in the "Move Picture" event.
  - You may have to add in your own "Wait" event command after.

---

Screen Shake Plugin Commands

---

CoreEngineCommandScreenShake.png

Screen Shake: Custom:
- Creates a custom screen shake effect and also sets the following uses of
  screen shake to this style.

  Shake Style:
  - Select shake style type.
  - Original
  - Random
  - Horizontal
  - Vertical

  Power:
  - Power level for screen shake.

  Speed:
  - Speed level for screen shake.

  Duration:
  - Duration of screenshake.
  - You can use code as well.

  Wait for Completion:
  - Wait until completion before moving onto the next event?

---

System Plugin Commands

---

CoreEngine Update5 Command1.png

System: Battle System Change
- Switch to a different battle system in-game.

  Change To:
  - Choose which battle system to switch to.
    - Database Default (Use game database setting)
    - -
    - DTB: Default Turn Battle
    - TPB Active: Time Progress Battle (Active)
    - TPB Wait: Time Progress Battle (Wait)
    - -
    - BTB: Brave Turn Battle (Req VisuMZ_2_BattleSystemBTB)
    - CTB: Charge Turn Battle (Req VisuMZ_2_BattleSystemCTB)
    - OTB: Order Turn Battle (Req VisuMZ_2_BattleSystemOTB)
    - STB: Standard Turn Battle (Req VisuMZ_2_BattleSystemSTB)

---

CoreEngine Update14 Command1.png

System: Load Images
- Allows you to (pre) load up images ahead of time.

  img/animations/:
  img/battlebacks1/:
  img/battlebacks2/:
  img/enemies/:
  img/faces/:
  img/parallaxes/:
  img/pictures/:
  img/sv_actors/:
  img/sv_enemies/:
  img/system/:
  img/tilesets/:
  img/titles1/:
  img/titles2/:
  - Which files do you wish to load from this directory?

---

CoreEnginePluginCommand04.png

System: Main Font Size
- Set the game's main font size.

  Change To:
  - Change the font size to this number.

---

CoreEnginePluginCommand05.png

System: Side View Battle
- Switch between Front View or Side View for battle.

  Change To:
  - Choose which view type to switch to.

---

CoreEnginePluginCommand07.png

System: Window Padding
- Change the game's window padding amount.

  Change To:
  - Change the game's standard window padding to this value.

---