Combat Log VisuStella MZ

From Yanfly.moe Wiki
Jump to navigation Jump to search

Welcome to the wiki! This is where you can find resources from Yanfly.moe, Ækashics.moe,
VisuStella, Caz Wolf, Fallen Angel Olivia, Atelier Irina, and other affiliated content creators.



Download

System

This is a plugin created for RPG Maker MZ.

Click here for help on how to install plugins and an explanation on the Tier Hierarchy System.


UpdatePlugins.png

Click here to learn how to update plugins.


Troubleshooting.jpg

Click here for how to troubleshoot plugins if you get an error.



CombatLog Preview1.png

CombatLog Preview2.png


VisuStella MZ

This plugin is a part of the VisuStella MZ Plugin Library.


Support VisuStella

Click here if you want to help support VisuStella on Patreon.


Introduction

CombatLog Preview1.png

Sometimes text appears way too fast in the battle system or sometimes players may miss what kind of information was delivered on-screen. For times like that, being able to access the Combat Log would be important. The Combat Log records all of the text that appears in the battle log window at the top. The player can access the Combat Log display any time during action selection phase or by holding down the designated Hot Key. Sometimes, players can even review over the Combat Log to try and figure out any kinds of patterns enemies may even have.

Features include all (but not limited to) the following:

  • Record the events that happen in battle into an accessible Combat Log for players to go back and review.
  • Access the Combat Log in-battle through the Party Command Window, Actor Command Window, or by holding down the Hot Key.
  • Icons are added to help players quickly differentiate between different types of events.
  • Combat Log can have its numbers color-coded to quickly determine their effects towards action targets.
  • Players can review past Combat Logs from an option in the Main Menu.

Requirements

This plugin is made for RPG Maker MZ. This will not work in other iterations of RPG Maker.


Tier 4

This plugin is a Tier 4 plugin. Place it under other plugins of lower tier value on your Plugin Manager list (ie: 0, 1, 2, 3, 4, 5).

This is to ensure that your plugins will have the best compatibility with the rest of the VisuStella MZ Plugin library.


Extra Features

There are some extra features found if other VisuStella MZ plugins are found present in the Plugin Manager list.

---

Battle Core VisuStella MZ

The VisuStella MZ Battle Core's <Battle Commands> notetag can now add in "Combat Log" to its list to have the Combat Log shown as an option to the Actor Command Window. Do remember to have this option enabled in the Plugin Parameters as well.

---

Message Core VisuStella MZ

By having the VisuStella MZ Message Core installed, you can enable the Auto Color functions for the Combat Log. Do remember to have this option enabled in the Plugin Parameters as well.

---

Notetags

RPG Maker MZ'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.


The following are notetags that have been added through this plugin. These notetags will not work with your game if this plugin is OFF or not present.

---

Bypass-Related Notetags

---

CombatLog Preview1.png

<Bypass Combat Log>

- Used for: State Notetags
- Insert this notetag inside a state to make its state messages ignored.

---

Plugin Commands

Plugin Commands are event commands that are used to call upon functions added by a plugin that aren't inherently a part of RPG Maker MZ.

Here is a list of Plugin Command(s) that you may use:

---


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

---

Combat Log Plugin Commands

CombatLog Preview1.png

---

CombatLog Command1.png

Combat Log: Add Text
- Adds custom text to the current Combat Log.

  Text:
  - What text would you like to add to the Combat Log?

  Icon:
  - What icon would you like to bind to this entry?

---

CombatLog Command2.png

Combat Log: Add Horizontal Line
- Adds a horizontal line to the current Combat Log.

---

CombatLog Command3.png

Combat Log: Bypass Text?
- Temporarily bypass adding any new text to the Combat Log until this
  is turned off?

  Bypass?:
  - Bypass text from being added to the Combat Log temporarily?

---

CombatLog Command4.png

Combat Log: Hot Key Enable?
- Enables/disables the Combat Log hot key in battle?

  Enable?:
  - Enables/disables the Combat Log hot key in battle.

---

System Plugin Commands

---

CombatLog MenuAccess.png

CombatLog Command5.png

System: Show in Main Menu?
- Shows/hides CombatLog menu inside the Main Menu.

  Show/Hide?:
  - Shows/hides Combat Log command inside the Main Menu.
  - Note! This command will be disabled if the player does not have any
    Combat Logs recorded.

---

CombatLog PartyCommand.png

CombatLog Command6.png

System: Show in Party Command?
- Shows/hides CombatLog menu inside the Window_PartyCommand.

  Show/Hide?:
  - Shows/hides Combat Log command inside Window_PartyCommand.

---

CombatLog ActorCommand.png

CombatLog Command7.png

System: Show in Actor Command?
- Shows/hides CombatLog menu inside the Window_ActorCommand.

  Show/Hide?:
  - Shows/hides Combat Log command inside Window_ActorCommand.

---

Plugin Parameters

General Settings

CombatLog Preview1.png

General settings for the Combat Log. Determine how the commands appear, the hot key used, and accessibility through the Main Menu, Party Command Window, and Actor Command Window.

---

General

 Command Name:
 - Name of the 'Combat Log' option in the various menus.
 Icon:
 - Icon used for each of the 'Combat Log' options.
 Hot Key:
 - This is the key used for quickly opening the Combat Log in battle.
 Stored Logs:
 - How many combat logs are stored as a history?
 - This affects the Combat Log menu.

---

Main Menu

CombatLog MenuAccess.png

 Show in Main Menu?:
 - Add the 'Combat Log' option to the Main Menu by default?
 - Note! This command will be disabled if the player does not have any
   Combat Logs recorded.

---

Window_PartyCommand

CombatLog PartyCommand.png

 Show in Window?:
 - Add the 'Combat Log' option to Window_PartyCommand by default?

---

Window_ActorCommand

CombatLog ActorCommand.png

 Show in Window?:
 - Add the 'Combat Log' option to Window_ActorCommand by default?
 Help: Combat Log:
 - Help text for Combat Log command.

---

Combat Log Settings

CombatLog Preview1.png

Settings regarding the Combat Log contents. Disable any unwanted information you want from here to prevent them from being displayed.

---

General

 Show Icons?:
 - Show icons in the Combat Log?
 Auto Color?:
 - Use auto colors for the Combat Log?
 - Requires VisuMZ_1_MessageCore
 Color Numbers?:
 - Color numbers for damage differences?

---

Battle Start

 Show?:
 - Show this event in the Combat Log?
 Icon:
 - Icon used for this event in the Combat Log.
 Text:
 - Text displayed for this event in the Combat Log.
 - You may use text codes.

---

Enemy Emerge

 Show?:
 - Show this event in the Combat Log?
 Icon:
 - Icon used for this event in the Combat Log.

---

Battle Advantages

 Show?:
 - Show this event in the Combat Log?
 Preemptive Icon:
 Surprised Icon:
 - Icon used for this event in the Combat Log.
 Text:
 - Text displayed for this event in the Combat Log.
 - You may use text codes.

---

Start Turn

 Show?:
 - Show this event in the Combat Log?
 Icon:
 - Icon used for this event in the Combat Log.
 Text:
 - Text displayed for this event in the Combat Log.
 - You may use text codes.
 - %1 - Turn Count

---

End Turn

 Show?:
 - Show this event in the Combat Log?
 Icon:
 - Icon used for this event in the Combat Log.
 Text:
 - Text displayed for this event in the Combat Log.
 - You may use text codes.
 - %1 - Turn Count

---

Battle Victory

 Show?:
 - Show this event in the Combat Log?
 Icon:
 - Icon used for this event in the Combat Log.

---

Battle Escape

 Show?:
 - Show this event in the Combat Log?
 Icon:
 - Icon used for this event in the Combat Log.

---

Battle Defeat

 Show?:
 - Show this event in the Combat Log?
 Icon:
 - Icon used for this event in the Combat Log.

---

Action Text

 Show Skill Message 1?:
 - Show this event in the Combat Log?
 Show Skill Message 2?:
 - Show this event in the Combat Log?
 Show Item Message?:
 - Show this event in the Combat Log?

---

HP Settings

 Show?:
 - Show this event in the Combat Log?

---

HP Settings > HP Heal

 Icon:
 - Icon used for this event in the Combat Log.
 Text Color:
 - Text color used for this event in the Combat Log.

---

HP Settings > HP Damage

 Icon:
 - Icon used for this event in the Combat Log.
 Text Color:
 - Text color used for this event in the Combat Log.

---

HP Settings > No HP Damage

 Icon:
 - Icon used for this event in the Combat Log.
 Text Color:
 - Text color used for this event in the Combat Log.

---

MP Settings

 Show?:
 - Show this event in the Combat Log?

---

MP Settings > MP Heal

 Icon:
 - Icon used for this event in the Combat Log.
 Text Color:
 - Text color used for this event in the Combat Log.

---

MP Settings > MP Damage

 Icon:
 - Icon used for this event in the Combat Log.
 Text Color:
 - Text color used for this event in the Combat Log.

---

MP Settings > No MP Damage

 Icon:
 - Icon used for this event in the Combat Log.
 Text Color:
 - Text color used for this event in the Combat Log.

---

TP Settings

 Show?:
 - Show this event in the Combat Log?

---

TP Settings > TP Heal

 Icon:
 - Icon used for this event in the Combat Log.
 Text Color:
 - Text color used for this event in the Combat Log.

---

TP Settings > TP Damage

 Icon:
 - Icon used for this event in the Combat Log.
 Text Color:
 - Text color used for this event in the Combat Log.

---

TP Settings > No TP Damage

 Icon:
 - Icon used for this event in the Combat Log.
 Text Color:
 - Text color used for this event in the Combat Log.

---

State Settings

 Show State Add?:
 - Show this event in the Combat Log?
 Show State Remove?:
 - Show this event in the Combat Log?
 Show State Current?:
 - Show this event in the Combat Log?

---

Buff & Debuff Settings

 Show Add Buff?:
 - Show this event in the Combat Log?
 Show Add Debuff?:
 - Show this event in the Combat Log?
 Show Erase Buff?:
 - Show this event in the Combat Log?

---

Counterattack

 Show?:
 - Show this event in the Combat Log?
 Icon:
 - Icon used for this event in the Combat Log.

---

Reflection

 Show?:
 - Show this event in the Combat Log?
 Icon:
 - Icon used for this event in the Combat Log.

---

Substitute

 Show?:
 - Show this event in the Combat Log?
 Icon:
 - Icon used for this event in the Combat Log.

---

Effect Failure

 Show?:
 - Show this event in the Combat Log?
 Icon:
 - Icon used for this event in the Combat Log.

---

Critical Hit

 Show?:
 - Show this event in the Combat Log?
 Icon:
 - Icon used for this event in the Combat Log.

---

Missed Hit

 Show?:
 - Show this event in the Combat Log?
 Icon:
 - Icon used for this event in the Combat Log.

---

Evaded Hit

 Show?:
 - Show this event in the Combat Log?
 Icon:
 - Icon used for this event in the Combat Log.

---

Background Settings

Background settings for Scene_CombatLog. Pretty up the scene to fit the rest of your game with these settings!

---

Settings

 Snapshop Opacity:
 - Snapshot opacity for the scene.
 Background 1:
 - Filename used for the bottom background image.
 - Leave empty if you don't wish to use one.
 Background 2:
 - Filename used for the upper background image.
 - Leave empty if you don't wish to use one.

---

Window Settings

Settings regarding this plugin's windows. These alter how the windows appear in the battle and menu scenes.

---

Combat Log (Battle)

 Background Type:
 - Select background type for this window.
 JS: X, Y, W, H:
 - Code used to determine the dimensions for this window.

---

Combat Log (Menu)

 Background Type:
 - Select background type for this window.
 JS: X, Y, W, H:
 - Code used to determine the dimensions for this window.

---

Combat History (Menu)

 Latest Command:
 - Text displayed for latest battle.
 - %1 - Battle Count
 Past Command:
 - Text displayed for past battles.
 - %1 - Battle Count
 Background Type:
 - Select background type for this window.
 JS: X, Y, W, H:
 - Code used to determine the dimensions for this window.

---

Compatibility Settings

CombatLog Preview1.png

These settings are for creating compatibility with the other VisuStella MZ plugins that can benefit from having their effects recorded inside of the Combat Log.

---

Battle System - ATB VisuStella MZ > Interrupt

 Show?:
 - Show this event in the Combat Log?
 Icon:
 - Icon used for this event in the Combat Log.
 Text:
 - Text displayed for this event in the Combat Log.
 - You may use text codes.
 - %1 - Target Name

---

Battle System - CTB VisuStella MZ > Order Change

 Show?:
 - Show this event in the Combat Log?
 Icon:
 - Icon used for this event in the Combat Log.
 Text:
 - Text displayed for this event in the Combat Log.
 - You may use text codes.
 - %1 - Target Name

---

Battle System - STB VisuStella MZ > Instant

 Show?:
 - Show this event in the Combat Log?
 Icon:
 - Icon used for this event in the Combat Log.
 Text:
 - Text displayed for this event in the Combat Log.
 - You may use text codes.
 - %1 - Target Name

---

Anti-Damage Barriers VisuStella MZ > Cancel Barrier

 Show?:
 - Show this event in the Combat Log?
 Icon:
 - Icon used for this event in the Combat Log.
 Text:
 - Text displayed for this event in the Combat Log.
 - You may use text codes.
 - %1 - Target Name, %2 - State Name

---

Anti-Damage Barriers VisuStella MZ > Nullify Barrier

 Show?:
 - Show this event in the Combat Log?
 Icon:
 - Icon used for this event in the Combat Log.
 Text:
 - Text displayed for this event in the Combat Log.
 - You may use text codes.
 - %1 - Target Name, %2 - State Name

---

Anti-Damage Barriers VisuStella MZ > Reduction Barrier

 Show?:
 - Show this event in the Combat Log?
 Icon:
 - Icon used for this event in the Combat Log.
 Text:
 - Text displayed for this event in the Combat Log.
 - You may use text codes.
 - %1 - Target Name, %2 - State Name

---

Anti-Damage Barriers VisuStella MZ > Absorption Barrier

 Show?:
 - Show this event in the Combat Log?
 Icon:
 - Icon used for this event in the Combat Log.
 Text:
 - Text displayed for this event in the Combat Log.
 - You may use text codes.
 - %1 - Target Name, %2 - State Name, %3 - Damage

---

Anti-Damage Barriers VisuStella MZ > MP Dispersion Barrier

 Show?:
 - Show this event in the Combat Log?
 Icon:
 - Icon used for this event in the Combat Log.
 Text:
 - Text displayed for this event in the Combat Log.
 - You may use text codes.
 - %1 - Target Name, %2 - State Name, %3 - MP

---

Anti-Damage Barriers VisuStella MZ > TP Dispersion Barrier

 Show?:
 - Show this event in the Combat Log?
 Icon:
 - Icon used for this event in the Combat Log.
 Text:
 - Text displayed for this event in the Combat Log.
 - You may use text codes.
 - %1 - Target Name, %2 - State Name, %3 - TP

---

Life State Effects VisuStella MZ > Auto Life

 Show?:
 - Show this event in the Combat Log?
 Icon:
 - Icon used for this event in the Combat Log.
 Text:
 - Text displayed for this event in the Combat Log.
 - You may use text codes.
 - %1 - Target Name

---

Life State Effects VisuStella MZ > Curse

 Show?:
 - Show this event in the Combat Log?
 Icon:
 - Icon used for this event in the Combat Log.
 Text:
 - Text displayed for this event in the Combat Log.
 - You may use text codes.
 - %1 - Target Name

---

Life State Effects VisuStella MZ > Doom

 Show?:
 - Show this event in the Combat Log?
 Icon:
 - Icon used for this event in the Combat Log.
 Text:
 - Text displayed for this event in the Combat Log.
 - You may use text codes.
 - %1 - Target Name

---

Life State Effects VisuStella MZ > Fragile

 Show?:
 - Show this event in the Combat Log?
 Icon:
 - Icon used for this event in the Combat Log.
 Text:
 - Text displayed for this event in the Combat Log.
 - You may use text codes.
 - %1 - Target Name

---

Life State Effects VisuStella MZ > Guts

 Show?:
 - Show this event in the Combat Log?
 Icon:
 - Icon used for this event in the Combat Log.
 Text:
 - Text displayed for this event in the Combat Log.
 - You may use text codes.
 - %1 - Target Name

---

Life State Effects VisuStella MZ > Undead

 Show?:
 - Show this event in the Combat Log?
 Icon:
 - Icon used for this event in the Combat Log.
 Text:
 - Text displayed for this event in the Combat Log.
 - You may use text codes.
 - %1 - Target Name

---

Steal Items VisuStella MZ > Steal Text

 Show?:
 - Show this event in the Combat Log?
 Icon:
 - Icon used for this event in the Combat Log.

---


Terms of Use

1. These plugins may be used in free or commercial games provided that they have been acquired through legitimate means at VisuStella.com and/or any other official approved VisuStella sources. Exceptions and special circumstances that may prohibit usage will be listed on VisuStella.com.

2. All of the listed coders found in the Credits section of this plugin must be given credit in your games or credited as a collective under the name: "VisuStella".

3. You may edit the source code to suit your needs, so long as you do not claim the source code belongs to you. VisuStella also does not take responsibility for the plugin if any changes have been made to the plugin's code, nor does VisuStella take responsibility for user-provided custom code used for custom control effects including advanced JavaScript notetags and/or plugin parameters that allow custom JavaScript code.

4. You may NOT redistribute these plugins nor take code from this plugin to use as your own. These plugins and their code are only to be downloaded from VisuStella.com and other official/approved VisuStella sources. A list of official/approved sources can also be found on VisuStella.com.

5. VisuStella is not responsible for problems found in your game due to unintended usage, incompatibility problems with plugins outside of the VisuStella MZ library, plugin versions that aren't up to date, nor responsible for the proper working of compatibility patches made by any third parties. VisuStella is not responsible for errors caused by any user-provided custom code used for custom control effects including advanced JavaScript notetags and/or plugin parameters that allow JavaScript code.

6. If a compatibility patch needs to be made through a third party that is unaffiliated with VisuStella that involves using code from the VisuStella MZ library, contact must be made with a member from VisuStella and have it approved. The patch would be placed on VisuStella.com as a free download to the public. Such patches cannot be sold for monetary gain, including commissions, crowdfunding, and/or donations.

7. If this VisuStella MZ plugin is a paid product, all project team members must purchase their own individual copies of the paid product if they are to use it. Usage includes working on related game mechanics, managing related code, and/or using related Plugin Commands and features. Redistribution of the plugin and/or its code to other members of the team is NOT allowed unless they own the plugin itself as that conflicts with Article 4.

8. Any extensions and/or addendums made to this plugin's Terms of Use can be found on VisuStella.com and must be followed.

Terms of Use: Japanese


『VisuStella MZ』利用規約

1. これらのプラグインは、VisuStella.comおよび/または公式に承認されたVisuStellaのソースから合法的な手段で入手したものである限り、フリーゲームや商用ゲームに使用することができます。例外的に使用が禁止される場合については、VisuStella.comの記載をご確認ください。

2. 本プラグインの「クレジット」部分に記載されているすべてのコーダーの名前は、ゲーム内にクレジット表記を行うか、もしくは「VisuStella」という名前の下にまとめて表記する必要があります。

3. ソースコードを自分のものだと主張しない限りは、必要に応じて編集することが可能です。ただしプラグインのコードに変更が加えられた場合、VisuStellaはそのプラグインに対して一切の責任を負いません。高度なJavaScriptのノートタグやJavaScriptコードを許可するプラグインのパラメータを含む、カスタムコントロールエフェクトに使用される、ユーザー提供のカスタムコードについても、VisuStellaは一切の責任を負いません。

4. これらのプラグインやプラグイン内のコードを、「自分のもの」として再配布したり使用したりすることはできません。これらのプラグインとそのコードは、VisuStella.comおよび、その他の公式/承認済みVisuStellaソースからのみダウンロードすることができます。公式/承認済みのソースのリストは、VisuStella.comでご確認いただけます。

5. VisuStellaは、意図しない使用方法による問題、VisuStella MZライブラリ以外のプラグインとの非互換性の問題、プラグインのバージョンが最新でないことによる問題、第三者による互換性パッチが適切に動作していないことなどが原因でゲーム内で発生した問題については、一切の責任を負いません。VisuStellaは、高度なJavaScriptのノートタグやJavaScriptコードを許可するプラグインのパラメータを含む、カスタムコントロールエフェクトに使用される、ユーザー提供のカスタムコードに起因するエラーについても、一切の責任を負いません。

6. VisuStella MZライブラリのコードを使用した互換性パッチをVisuStellaとは関係のない第三者を通じて作成する必要がある場合は、まずVisuStellaのメンバーと連絡を取り、承認を得る必要があります。パッチはVisuStella.comに公開され、誰でも無料でダウンロードすることができるようになります。このようなパッチを、制作発注やクラウドファンディングの対象にしたり、寄付などの金銭的な利益を得るために販売することはできません。

7. このVisuStella MZプラグインが商用製品である場合、プロジェクトチームのすべてのメンバーは、それを使用するため、それぞれ製品を購入しなければなりません。使用方法には、関連するゲームメカニクスの作業、関連するコードの管理、および/または関連するプラグインコマンドや機能の使用、が含まれます。プラグインそのものやそのコードをチームの他のメンバーに再配布することは第4項に抵触するため、そのメンバーがプラグインそのものを所有していない限りは許可されません。

8. このプラグインの利用規約の追加項目や補足については、VisuStella.comに掲載されていますので、それを参照し従ってください。

Credits

If you are using this plugin, credit the following people in your game:

Team VisuStella

Changelog

Version 1.09: July 2, 2021

  • Optimization Update!
    • Plugin should run more optimized.


Version 1.08: April 9, 2021

  • Documentation Update!
    • Help file updated for new features.
  • New Features!
    • New Plugin Parameters added by Olivia!
      • Plugin Parameters > General Settings > Help: Combat Log
        • Help text for Combat Log command.


Version 1.07: March 19, 2021

  • Bug Fixes!
    • Combat log should no longer mask some windows from appearing and is now instead placed as a non-window object. Fix made by Arisu.


Version 1.06: March 12, 2021

  • Bug Fixes!
    • Icons for counters, reflections, and substitutes should now display properly in the combat log. Fix made by Arisu.
    • Turn data should now display properly in TPB-base battle systems. Fix made by Arisu.
    • Switching out to the Options Scene or Party Scene should no longer clear the Combat Log in-battle. Fix made by Arisu.


Version 1.05: January 22, 2021

  • Feature Update!
    • Dimmed background sprite now expands through the width of the screen while in battle to no longer display the jagged edges. Update by Irina.


Version 1.04: January 15, 2021

  • Feature Update!
    • Any entries added to the Combat Log with \V[x] will now have their exact variable data stored at the time instead of displaying their current variable value. Update made by Irina.


Version 1.03: January 8, 2021

  • Documentation Update!
    • Help file updated for new features.
  • New Feature!
    • New Plugin Command added by Irina.
      • Plugin Parameters > General Settings > Stored Logs
        • How many combat logs are stored as a history?


Version 1.02: January 1, 2021

  • Bug Fixes!
    • Compatibility with the Absorption Barrier should be fixed. Fix made by Yanfly.


Version 1.01: December 25, 2020

  • Feature Update!
    • Combat Log when opened with the hot key will automatically close itself if the Message Window is open. Update made by Yanfly.


Version 1.00: January 15, 2021

  • Finished Plugin!

End of File