Action Sequence Camera VisuStella MZ

From Yanfly.moe Wiki
Revision as of 19:23, 3 October 2020 by Yanfly (talk | contribs) (Changelog)
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.



VisuMZ ActSeqCamera Angle.gif

VisuMZ ActSeqCamera Pan.gif

VisuMZ ActSeqCamera Skew.gif

VisuMZ ActSeqCamera Zoom.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

This plugin adds new Action Sequences functions to the VisuStella MZ Battle Core plugin to give you, the game dev, control over the battle camera and zoom functions.

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

  • Attach the camera to a specific point on the screen.
  • Attach the camera to a specific target(s) on the screen.
  • Pan the camera to be off center using the offset functions.
  • Remove camera clamping to let the camera go out of bounds.
  • Set the camera zoom level as you want.
  • Tilt the camera by adjust the angle.
  • New Options added to let the player turn on/off the battle camera.

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.


Major Changes

This plugin adds some new hard-coded features to RPG Maker MZ's functions. The following is a list of them.

---

Spriteset Position Rewrite

VisuMZ ActSeqCamera Pan.gif

The Spriteset_Battle function for updatePosition needed to be rewritten in order to allow all the new features and functions added by the battle camera and zoom.

Camera tricks like zooming, panning, and tilting will be reset during the input phase to ensure the player is able to see the whole battlefield.

The player has the option to turn off the battle camera effects. If they choose to turn it off, then all of this plugin's effects will be disabled until they turn it back on. This is to give players control over how the game visually appears in case they have motion sickness.

---

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 Action Sequence Plugin Commands that have been added with this plugin. These are accessible from the Battle Core plugin (not this one) in order to keep all the Action Sequences in place.

Once again, these plugin commands are only accessible through the Battle Core plugin and not this one! Make sure you have the most update to date version of the Battle Core for them.

---

Action Sequences - Angle (Camera)

VisuMZ ActSeqCamera Angle.gif

These action sequences allow you to have control over the camera angle.

---

ANGLE: Change Angle
- Changes the camera angle.
- Requires VisuMZ_3_ActSeqCamera!

  Angle:
  - Change the camera angle to this many degrees.

  Duration:
  - Duration in frames to change camera angle.

  Angle Easing:
  - Select which easing type you wish to apply.
  - Requires VisuMZ_0_CoreEngine.

  Wait For Angle?:
  - Wait for angle changes to complete before performing next command?

---

ANGLE: Reset Angle
- Reset any angle settings.
- Requires VisuMZ_3_ActSeqCamera!

  Duration:
  - Duration in frames to reset camera angle.

  Angle Easing:
  - Select which easing type you wish to apply.
  - Requires VisuMZ_0_CoreEngine.

  Wait For Angle?:
  - Wait for angle changes to complete before performing next command?

---

ANGLE: Wait For Angle
- Waits for angle changes to complete before performing next command.
- Requires VisuMZ_3_ActSeqCamera!

---

Action Sequences - Camera Control

VisuMZ ActSeqCamera Pan.gif

These Action Sequences are battle camera-related.

---

CAMERA: Clamp ON/OFF
- Turns battle camera clamping on/off.
- Requires VisuMZ_3_ActSeqCamera!

  Setting:
  - Turns camera clamping on/off.

---

CAMERA: Focus Point
- Focus the battle camera on a certain point in the screen.
- Requires VisuMZ_3_ActSeqCamera!

  X Coordinate:
  - Insert the point to focus the camera on.
  - You may use JavaScript code.

  Y Coordinate:
  - Insert the point to focus the camera on.
  - You may use JavaScript code.

  Duration:
  - Duration in frames for camera focus change.

  Camera Easing:
  - Select which easing type you wish to apply.
  - Requires VisuMZ_0_CoreEngine.

  Wait For Camera?
  - Wait for camera changes to complete before performing next command?

---

CAMERA: Focus Target(s)
- Focus the battle camera on certain battler target(s).
- Requires VisuMZ_3_ActSeqCamera!

  Targets:
  - Select unit(s) to focus the battle camera on.

  Duration:
  - Duration in frames for camera focus change.

  Camera Easing:
  - Select which easing type you wish to apply.
  - Requires VisuMZ_0_CoreEngine.

  Wait For Camera?
  - Wait for camera changes to complete before performing next command?

---

CAMERA: Offset
- Offset the battle camera from the focus target.
- Requires VisuMZ_3_ActSeqCamera!

  Offset X:
  - How much to offset the camera X by.
  - Negative: left. Positive: right.

  Offset Y:
  - How much to offset the camera Y by.
  - Negative: up. Positive: down.

  Duration:
  - Duration in frames for offset change.

  Camera Easing:
  - Select which easing type you wish to apply.
  - Requires VisuMZ_0_CoreEngine.

  Wait For Camera?
  - Wait for camera changes to complete before performing next command?

---

CAMERA: Reset
- Reset the battle camera settings.
- Requires VisuMZ_3_ActSeqCamera!

  Reset Focus?:
  - Reset the focus point?

  Reset Offset?:
  - Reset the camera offset?

  Duration:
  - Duration in frames for reset change.

  Camera Easing:
  - Select which easing type you wish to apply.
  - Requires VisuMZ_0_CoreEngine.

  Wait For Camera?
  - Wait for camera changes to complete before performing next command?

---

CAMERA: Wait For Camera
- Waits for camera changes to complete before performing next command.
- Requires VisuMZ_3_ActSeqCamera!

---

Action Sequences - Skew (Camera)

VisuMZ ActSeqCamera Skew.gif

These action sequences allow you to have control over the camera skew.

---

SKEW: Change Skew
- Changes the camera skew.
- Requires VisuMZ_3_ActSeqCamera!

  Skew X:
  - Change the camera skew X to this value.

  Skew Y:
  - Change the camera skew Y to this value.

  Duration:
  - Duration in frames to change camera skew.

  Skew Easing:
  - Select which easing type you wish to apply.
  - Requires VisuMZ_0_CoreEngine.

  Wait For Skew?:
  - Wait for skew changes to complete before performing next command?

---

SKEW: Reset Skew
- Reset any skew settings.
- Requires VisuMZ_3_ActSeqCamera!

  Duration:
  - Duration in frames to reset camera skew.

  Skew Easing:
  - Select which easing type you wish to apply.
  - Requires VisuMZ_0_CoreEngine.

  Wait For Skew?:
  - Wait for skew changes to complete before performing next command?

---

SKEW: Wait For Skew
- Waits for skew changes to complete before performing next command.
- Requires VisuMZ_3_ActSeqCamera!

---

Action Sequences - Zoom (Camera)

VisuMZ ActSeqCamera Zoom.gif

These Action Sequences are zoom-related.

---

ZOOM: Change Scale
- Changes the zoom scale.
- Requires VisuMZ_3_ActSeqCamera!

  Scale:
  - The zoom scale to change to.

  Duration:
  - Duration in frames to reset battle zoom.

  Zoom Easing:
  - Select which easing type you wish to apply.
  - Requires VisuMZ_0_CoreEngine.

  Wait For Zoom?
  - Wait for zoom changes to complete before performing next command?

---

ZOOM: Reset Zoom
- Reset any zoom settings.
- Requires VisuMZ_3_ActSeqCamera!

  Duration:
  - Duration in frames to reset battle zoom.

  Zoom Easing:
  - Select which easing type you wish to apply.
  - Requires VisuMZ_0_CoreEngine.

  Wait For Zoom?
  - Wait for zoom changes to complete before performing next command?

---

ZOOM: Wait For Zoom
- Waits for zoom changes to complete before performing next command.
Requires VisuMZ_3_ActSeqCamera!

---

Plugin Parameters

Options Menu Settings

These plugin parameters add a new options command in order to let the player decide if they want the battle camera ON or OFF.

The player has the option to turn off the battle camera effects. If they choose to turn it off, then all of this plugin's effects will be disabled until they turn it back on. This is to give players control over how the game visually appears in case they have motion sickness.

---

ActSeqCamera Option.png

ActSeqCamera Param1.png

Options

 Add Option?:
 - Add the Battle Camera options to the Options menu?
 Adjust Window Height:
 - Automatically adjust the options window height?
 Options Name:
 - Command name of the option.

---


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 4, 2020

  • Bug Fixes!
    • Damage offsets are now corrected and in line with the latest Battle Core version.


Version 1.00: September 23, 2020

  • Finished Plugin!

End of File