Difference between revisions of "Battle Command - Talk VisuStella MZ"

From Yanfly.moe Wiki
Jump to navigation Jump to search
(Created page with "{{MzPlugin |preview = <youtube>link</youtube> |link1 = <html>Not yet available</html> |link2 = {{VisuStella Battle Technician Vol 2}} }} <!-- Preview --> {| | File:VisuM...")
 
 
(12 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{MzPlugin
 
{{MzPlugin
|preview = <youtube>link</youtube>
+
|preview = <youtube>https://www.youtube.com/watch?v=CBbTJA1r9es</youtube>
|link1 = <html>Not yet available</html>
+
|link1 = <html><iframe frameborder="0" src="https://itch.io/embed/1232431" width="552" height="167"><a href="https://visustellamz.itch.io/battle-command-talk">Battle Command - Talk plugin for RPG Maker MZ by VisuStellaMZ</a></iframe></html>
 
|link2 = {{VisuStella Battle Technician Vol 2}}
 
|link2 = {{VisuStella Battle Technician Vol 2}}
  
Line 8: Line 8:
 
<!-- Preview -->
 
<!-- Preview -->
  
{|
+
[[File:BattleCmdTalk_Preview.png]]
| [[File:VisuMZ_Polish.png|400px]]
 
| [[File:VisuMZ_Polish.png|400px]]
 
 
|-
 
  
| [[File:VisuMZ_Polish.png|400px]]
+
[[File:BattleCmdTalk_1.gif]]
| [[File:VisuMZ_Polish.png|400px]]
 
  
|}
+
[[File:BattleCmdTalk_2.gif]]
  
 
{| style="width: 800px;" cellspacing="0" cellpadding="0"
 
{| style="width: 800px;" cellspacing="0" cellpadding="0"
 
| style="width: 100%; vertical-align: top;" |
 
| style="width: 100%; vertical-align: top;" |
  
<!--
 
 
{{RequiredPluginsMZ}}
 
{{RequiredPluginsMZ}}
* [[Required Plugin 1|Name1]]
+
* [[Battle Core VisuStella MZ]]
* [[Required Plugin 2|Name2]]
 
* [[Required Plugin 3|Name3]]
 
  
 +
<!--
 
{{ExtensionPluginsMZ}}
 
{{ExtensionPluginsMZ}}
 
* [[Extension Plugin 1|Name1]]
 
* [[Extension Plugin 1|Name1]]
Line 36: Line 29:
 
{{Visustella MZ}}
 
{{Visustella MZ}}
  
== Help File ==
+
== Introduction ==
 +
 
 +
[[File:BattleCmdTalk_1.gif]]
 +
 
 +
This plugin allows actors to talk with enemies. When talking with an enemy,
 +
a common event will run in place of the typical battle action, allow you,
 +
the game dev, to have full control over how the conversation steers. A
 +
variable tracker can be used to track how many times the player has started
 +
up a conversation with that specific enemy to allow for more drawn out
 +
talking if you, the game dev, so desires.
 +
 
 +
Features include all (but not limited to) the following:
 +
 
 +
* Adds the "Talk" command to the Actor Command Window, allowing the player to pick a target enemy to talk with.
 +
* Enemies can offer different conversations through the usage of notetags to determine what Common Event is played for talking.
 +
* A variable tracker is used to track the number of times the player has spoken to that specific enemy during the current battle and then stores that value to the specific variable.
 +
* Includes Text Codes to quickly acquire the battle action's target, user, and action names.
 +
 
 +
== Requirements ==
 +
 
 +
This plugin is made for RPG Maker MZ. This will not work in other iterations
 +
of RPG Maker.
 +
 
 +
=== Required Plugin List ===
 +
 
 +
* [[Battle Core VisuStella MZ]]
 +
 
 +
This plugin requires the above listed plugins to be installed inside your
 +
game's Plugin Manager list in order to work. You cannot start your game with
 +
this plugin enabled without the listed plugins.
 +
 
 +
{{MZ Tier 3}}
 +
 
 +
{{Notetags MZ}}
 +
 
 +
{{VisuMZ Battle Command - Talk Notetags}}
 +
 
 +
 
 +
 
 +
{{Text Codes MZ}}
 +
 
 +
{{VisuMZ Battle Command - Talk Text Codes}}
 +
 
 +
== Plugin Parameters ==
 +
 
 +
=== General Settings ===
 +
 
 +
[[File:BattleCmdTalk_1.gif]]
 +
 
 +
[[File:BattleCmdTalk_Param1.png]]
 +
 
 +
These are all of the settings required to control how the Talk Command works
 +
in-battle. These settings cannot be ignored and should not be used as
 +
default without any consideration.
 +
 
 +
---
 +
 
 +
Default Talk Events
 +
 
 +
  Talk: Common Event:
 +
  - Select a Common Event to refer to for default talking events.
 +
 
 +
  Variable Tracker:
 +
  - Tracks the number of times the target enemy has been talked to.
 +
  - Use 0 to not use this variable.
 +
  - The first time you talk to an enemy will start with a value of 1.
 +
 
 +
---
 +
 
 +
Accessibility
 +
 
 +
  Leader Only?:
 +
  - Make the Talk Command available to the party leader only?
 +
 
 +
  Show Command?:
 +
  - Show the Talk Command by default?
 +
 
 +
---
  
<pre>
+
Talk Command Settings
This plugin is currently being polished.
+
 
</pre>
+
  Command Name:
 +
  - What is the text displayed for the Talk Command?
 +
 
 +
  Icon Index:
 +
  - What is the icon index used for the Talk Command?
 +
 
 +
  Help Description:
 +
  - What is the help description associated with the Talk Command?
 +
 
 +
  Action Speed:
 +
  - What action speed should the Talk Command have?
 +
  - Positive is Faster.
 +
  - Negative is slower.
 +
 
 +
  Message Lines:
 +
  - What are the message lines displayed in the Battle Log?
 +
  - %1 - User's name.
 +
 
 +
---
 +
 
 +
Window_ActorCommand
 +
 
 +
  Auto Add?:
 +
  - Automatically add the Talk Command after the Guard command?
 +
 
 +
  Hide Cost?:
 +
  - For certain battle systems, hide the action cost of the Talk Command?
 +
 
 +
---
  
 
{{VisuStella MZ Terms of Use}}
 
{{VisuStella MZ Terms of Use}}
Line 50: Line 148:
 
Team VisuStella
 
Team VisuStella
  
* Insert Name
+
* [[Yanfly]]
* Insert Name
+
* [[Arisu]]
* Insert Name
+
* [[Olivia]]
* Insert Name
+
* [[Irina]]
  
 
== Changelog ==
 
== Changelog ==
  
* Version 1.00
+
Version 1.01: October 28, 2021
** Plugin released!
+
* Optimization Update!
 +
** Plugin should run more optimized.
 +
 
 +
 
 +
 
 +
Version 1.00 Official Release Date: November 3, 2021
 +
* Finished Plugin!
  
 
== End of File ==
 
== End of File ==
Line 66: Line 170:
 
<!-- This is a comment, remove the arrows surrounding this for the categories you want to show -->
 
<!-- This is a comment, remove the arrows surrounding this for the categories you want to show -->
 
<!-- [[Category: RPG Maker MZ Core Plugins]] -->
 
<!-- [[Category: RPG Maker MZ Core Plugins]] -->
<!-- [[Category: RPG Maker MZ Battle Plugins]] -->
+
[[Category: RPG Maker MZ Battle Plugins]]
 
<!-- [[Category: RPG Maker MZ Item Plugins]] -->
 
<!-- [[Category: RPG Maker MZ Item Plugins]] -->
 
<!-- [[Category: RPG Maker MZ Skill Plugins]] -->
 
<!-- [[Category: RPG Maker MZ Skill Plugins]] -->
 
<!-- [[Category: RPG Maker MZ Equip Plugins]] -->
 
<!-- [[Category: RPG Maker MZ Equip Plugins]] -->
 
<!-- [[Category: RPG Maker MZ Status Menu Plugins]] -->
 
<!-- [[Category: RPG Maker MZ Status Menu Plugins]] -->
<!-- [[Category: RPG Maker MZ Gameplay Plugins]] -->
+
[[Category: RPG Maker MZ Gameplay Plugins]]
 
<!-- [[Category: RPG Maker MZ Movement Plugins]] -->
 
<!-- [[Category: RPG Maker MZ Movement Plugins]] -->
 
<!-- [[Category: RPG Maker MZ Quest Plugins]] -->
 
<!-- [[Category: RPG Maker MZ Quest Plugins]] -->
 
<!-- [[Category: RPG Maker MZ Options Plugins]] -->
 
<!-- [[Category: RPG Maker MZ Options Plugins]] -->
<!-- [[Category: RPG Maker MZ Eventing Plugins]] -->
+
[[Category: RPG Maker MZ Eventing Plugins]]
<!-- [[Category: RPG Maker MZ Utility Plugins]] -->
+
[[Category: RPG Maker MZ Utility Plugins]]
<!-- [[Category: RPG Maker MZ Mechanical Plugins]] -->
+
[[Category: RPG Maker MZ Mechanical Plugins]]
 
<!-- [[Category: RPG Maker MZ Visual Plugins]] -->
 
<!-- [[Category: RPG Maker MZ Visual Plugins]] -->
 
<!-- [[Category: RPG Maker MZ Menu Plugins]] -->
 
<!-- [[Category: RPG Maker MZ Menu Plugins]] -->

Latest revision as of 13:39, 3 November 2021

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.



BattleCmdTalk Preview.png

BattleCmdTalk 1.gif

BattleCmdTalk 2.gif

Required Plugins

The following plugins are required in order to use this plugin.

Place the following plugins above this plugin located in the Plugin Manager.


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

BattleCmdTalk 1.gif

This plugin allows actors to talk with enemies. When talking with an enemy, a common event will run in place of the typical battle action, allow you, the game dev, to have full control over how the conversation steers. A variable tracker can be used to track how many times the player has started up a conversation with that specific enemy to allow for more drawn out talking if you, the game dev, so desires.

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

  • Adds the "Talk" command to the Actor Command Window, allowing the player to pick a target enemy to talk with.
  • Enemies can offer different conversations through the usage of notetags to determine what Common Event is played for talking.
  • A variable tracker is used to track the number of times the player has spoken to that specific enemy during the current battle and then stores that value to the specific variable.
  • Includes Text Codes to quickly acquire the battle action's target, user, and action names.

Requirements

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

Required Plugin List

This plugin requires the above listed plugins to be installed inside your game's Plugin Manager list in order to work. You cannot start your game with this plugin enabled without the listed plugins.


Tier 3

This plugin is a Tier 3 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.


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.

---

Enemy-Related Notetags

BattleCmdTalk 2.gif

---

<Talk Common Event: x>

- Used for: Enemy Notetags
- Determines the Common Event that will be ran when talking to this specific
  enemy.
- If this notetag is not used, the Common Event used will be whatever has
  been set up as default in the Plugin Parameters.
- Replace 'x' with a number representing the Common Event's ID to run.

---

Talk-Related Notetags

BattleCmdTalk Preview.png

---

<Battle Command Talk>

- Used for: Actor, Class, Weapon, Armor, State Notetags
- Allows the affected actor to talk.
- This will bypass the default show Plugin Parameter.
- This does not bypass the leader-only Plugin Parameter.
<pre>

---

<pre>
<No Battle Command Talk>

- Used for: Actor, Class, Weapon, Armor, State Notetags
- Prevents the affected actor from being able to talk.
- This will bypass the default show Plugin Parameter.

---


Text Codes

ShowTextWindowMZ.png

Text Codes are used in the Show Text event command. They are used to display things that text normally can't produce on its own, such as colors, get the name of a specific actor, change icons, and more.

RPG Maker MZ already comes with text codes of its own:

\V[n] Will be replaced with the value of the nth variable.
\N[n] Will be replaced with the name of the nth actor.
\P[n] Will be replaced by the name of the nth (arranged order) party member.
\G Will be replaced by the currency unit.
\C[n] Draw the subsequent text in the nth color. Text color conforms to the contents of the [Window.png] system image.
\I[n] Draws the nth icon.
\FS[n] Changes the text font size to 'n'.
\{ Increases the text by 1 step.
\} Decreases the text by 1 step.
\\ Replaced with the backslash character.
\$ Open the gold window.
\. Wait for 1/4 second.
\| Wait for 1 second.
\! Wait for button input.
\> Display remaining text on same line all at once.
\< Cancel the effect that displays text all at once.
\^ Do not wait for input after displaying the next.


The following are text codes that you may use with this plugin.

Battle-Related Text Codes

BattleCmdTalk 2.gif

---

----------------------------   ---------------------------------------------
Text Code                      Effect (Battle Only)
----------------------------   ---------------------------------------------
<Current Battle Target>        Replaces text code with the current target of
                               an action in battle.
<Current Battle User>          Replaces text code with the currently active
                               user in battle.
<Current Battle Action>        Replaces text code with the current battle
                               action's name with an icon in front.
<Current Battle Action Name>   Replaces text code with the current battle
                               action's name without an icon.

If there is no battle, no target, no user, or no action, then the text code
will just be replaced with no text.

These text codes are NOT recommended to be used inside of Help Descriptions.
They are best used with "Show Text" event commands.

---

Plugin Parameters

General Settings

BattleCmdTalk 1.gif

BattleCmdTalk Param1.png

These are all of the settings required to control how the Talk Command works in-battle. These settings cannot be ignored and should not be used as default without any consideration.

---

Default Talk Events

 Talk: Common Event:
 - Select a Common Event to refer to for default talking events.
 Variable Tracker:
 - Tracks the number of times the target enemy has been talked to.
 - Use 0 to not use this variable.
 - The first time you talk to an enemy will start with a value of 1.

---

Accessibility

 Leader Only?:
 - Make the Talk Command available to the party leader only?
 Show Command?:
 - Show the Talk Command by default?

---

Talk Command Settings

 Command Name:
 - What is the text displayed for the Talk Command?
 Icon Index:
 - What is the icon index used for the Talk Command?
 Help Description:
 - What is the help description associated with the Talk Command?
 Action Speed:
 - What action speed should the Talk Command have?
 - Positive is Faster.
 - Negative is slower.
 Message Lines:
 - What are the message lines displayed in the Battle Log?
 - %1 - User's name.

---

Window_ActorCommand

 Auto Add?:
 - Automatically add the Talk Command after the Guard command?
 Hide Cost?:
 - For certain battle systems, hide the action cost of the Talk Command?

---


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.01: October 28, 2021

  • Optimization Update!
    • Plugin should run more optimized.


Version 1.00 Official Release Date: November 3, 2021

  • Finished Plugin!

End of File