State Ring Icon - StateRingIcon.js

Plugin desc : Ring State Plugin

License : MIT License

Author : Triacontane

Website : https://triacontane.blogspot.com/

Desc page : https://triacontane.blogspot.com/

Download Page : https://raw.githubusercontent.com/munokura/triacontane-MV-plugins/refs/heads/main/StateRingIcon.js

File name : StateRingIcon.js

Help of plugin :

@url https://triacontane.blogspot.com/
@plugindesc Ring State Plugin
@author Triacontane
@license MIT License

@help
English Help Translator: munokura
This is an unofficial English translation of the plugin help，
created to support global RPG Maker users.
Feedback is welcome to improve translation quality
(see: https://github.com/munokura/triacontane-MV-plugins ).
Original plugin by Triacontane.
Please check the latest official version at:
https://triacontane.blogspot.com
-----

When multiple enemy states are active， you can rotate the state icons
clockwise to display them as a ring or in a row.

You can also display the number of turns remaining for each state.

- Only displayed if the state release timing is not "None."
- Due to the turn count managed by the core script， if the state release
timing is set to "At the end of an action，" the number displayed will start
from one greater than the set number of turns.

To adjust the ring state position for each enemy character， enter the
following in the database Note field:
<RingStateX:0>
<RingStateY:0>

This plugin does not have plugin commands.

Terms of Use:
You may modify and redistribute this plugin without permission from the
author， and there are no restrictions on its use (commercial， 18+， etc.).
This plugin is now yours.

@param RadiusX
@text X radius
@desc Horizontal radius value. (Default:64)
@type number
@default 64

@param RadiusY
@text Y Radius
@desc Vertical radius value. (Default:16)
@type number
@default 16

@param ScaleX
@text X Magnification
@desc The horizontal magnification of the icon.
@type number
@default 100

@param ScaleY
@text Y Magnification
@desc The vertical magnification of the icon.
@type number
@default 100

@param CycleDuration
@text period
@desc The time (number of frames) it takes for the icon to rotate once. If you set it to 0， it will not rotate.
@type number
@default 60

@param LineViewLimit
@text Maximum number of enemies in a row
@desc If the number of enemy states is less than this value， they will be displayed in a single row instead of a ring icon. If set to 0， they will always be displayed in a single row.
@type number
@default 1

@param LineViewLimitActor
@text Maximum number of actors in a row
@desc If the number of states of an actor is less than or equal to this value， it will be displayed in a single column instead of a ring icon. If set to 0， it will always be displayed in a single column.
@type number
@default 1

@param Reverse
@text Counterclockwise
@desc The rotation direction is counterclockwise. (Default: OFF)
@type boolean
@default false

@param ShowTurnCount
@text Turn number display
@desc Displays the number of remaining turns in the state.
@type boolean
@default true

@param IconIndexWithoutRing
@text Icons not to be displayed
@desc This is an "icon index" that is not included in the ring display.
@type string[]
@default []

@param IconIndexWithoutShowTurns
@text Turn count not displayed icon
@desc This is the "icon index" that is not subject to the display of state turn numbers.
@type string[]
@default []

@param TurnCountX
@text Turn number X coordinate
@desc Adjusts the X coordinate display position of the turn number. The default is the bottom right of the icon.
@type number
@default 0
@min -1000
@max 1000

@param TurnCountY
@text Turn number Y coordinate
@desc Adjusts the Y coordinate display position of the turn number. The default is the bottom right of the icon.
@type number
@default 0
@min -1000
@max 1000

@param TurnAdjustment
@text Turn number correction
@desc Corrects the displayed number of turns. Change this only if the value is incorrect when combined with other plugins.
@type number
@default 0
@min -9999
@max 9999

@param ShowActorTurnCount
@text Ally turn count display
@desc Displays the number of remaining turns for allies' states. This may not work depending on the plugin you are using.
@type boolean
@default true

@param FontSize
@text Font size
@desc The font size for the remaining turn count display.
@type number
@default 32

@param ActorRingIcon
@text Ally Ring Icon
@desc Ally state icons will also be displayed as a ring.
@type boolean
@default false

@param ActorRingIconX
@text Ally ring icon X coordinate
@desc The X coordinate of the ally's state icon.
@type number
@default 0
@min -1000
@max 1000

@param ActorRingIconY
@text Ally ring icon Y coordinate
@desc The Y coordinate of the ally's state icon.
@type number
@default 0
@min -1000
@max 1000

@param EnemyRingIconX
@text Enemy ring icon X coordinate
@desc The X coordinate of the enemy's state icon.
@type number
@default 0
@min -1000
@max 1000

@param EnemyRingIconY
@text Enemy ring icon Y coordinate
@desc The Y coordinate of the enemy's state icon.
@type number
@default 0
@min -1000
@max 1000

munokura

Welcome to PGMV! My goal is to make it easy for everyone to find and share great plugins for creating amazing games. As a plugin developer myself, I'm excited to grow this community with all of you.