MVEli_SuperTimer
Preserved forum archive. This topic stores the original first post and locally mirrored RPG Maker Web attachments when available. It is posted by the BMMPlay archive account, not by the original creator.
Original Source
- Original title: Eli_SuperTimer
- Original author: Eliaquim
- Original date: April 9, 2020
- Source thread: https://forums.rpgmakerweb.com/threads/eli_supertimer.119961/
- Source forum path: Game Development Engines > RPG Maker Javascript Plugins > JS Plugin Releases (RMMV)
Summary
{ "lightbox_close": "Close", "lightbox_next": "Next", "lightbox_previous": "Previous",
Archived First Post
Author: Eliaquim
Introduction
By default, the Rpg Maker Mv timer is boring in terms of functionality and visual. You cannot change its position, color, font, size, add or reduce timer.
This plugin aims to expand those features! Adding new mechanics and visual effects (six new customizable sprites) to make your timer more unique!
Features
• Visuals:
• Background: Define colors (single or gradient) and size for the background.
• Picture: Set an image to be displayed as a background.
• Label: Define a label to be displayed along with the timer, being able to change its color, font, position and more!
• Numbers: Set the timer format to show only 00:00 or 00:00:00. You can also customize it as well as the label!
• Sprite Gauges: Set the width and height, color and more of an animated rectangular gauge to symbolize your timer count.
• Image gauges: Same as above, but it can be done by images.
• Character / Icon: Choose an icon or animated character to be displayed along with the timer!
• Mechanics:
• Add or remove seconds, minutes or hours from the active timer.
• The Option of a new format 00:00:00 (hours, minutes, seconds).
• Pause/resume the timer (Stop working).
• Run a common event when the timer starts, pauses or expires.
• Automatically turn on and off a switch when the timer is active/inactive.
• Hold the count (other than pausing, it will still working). Useful for cutscenes or tutorials.
• Adjust the position of all sprites to your liking, or use the preset positions.
• Adjust the layer order for each displayed sprite.
• Possibility to change the settings for all sprites while the timer is active.
• You can choose to reset the settings to the default each time you start the timer or keep the changes.
• Plugin commands and script calls to help you set your timer!
How to use
There are eleven plugin parameters in which you can configure the respective functionalities for each of them and their sub-parameters.
Most are self-explanatory, however, some need an explanation:
• Features > Settings related to the mechanics of the timer.
• Hold count > Makes the timer not change the count, but still keeps it in a “working” state. The switch that turns on and off automatically will still be on and any other conditions that are based on “$gameTimer.isWorking()” will remain true. This option is different from the Pause option, as it does not change the colors of the sprites. It is useful for a cutscene or a brief presentation of what is to come when a timer is started.
• Sprite master > What you change here will apply to all sprites.
• Background and other sprites:
• Enabled > All sprites have this sub-parameter. If you choose to disable, you cannot activate them within the game.
• The orientation of the bars > If you want to change the orientation of the bars be careful to also change the width and height.
• Character/icon > The image that will represent this sprite is similar to the images of the characters used in events. However, it can only be composed of one line and the frames are from left to right (Ex: 1, 2, 3, 4 ...) The Max Frames parameter will determine how many animated "squares" will appear for the character.
• Predefined positions > You can choose predefined positions for the timer. And, from that position, configure the X and Y coordinates of the other sprites. If you choose the top center position, the X = 0 coordinate will start from that predefined position. If you don't want to use a pre-defined position and want to leave the sprites free on the screen, set the manual option and Master X and Master Y to 0.
• Changing fonts > Please see the file “font instructions” inside the font folder.
Most are self-explanatory, however, some need an explanation:
• Features > Settings related to the mechanics of the timer.
• Hold count > Makes the timer not change the count, but still keeps it in a “working” state. The switch that turns on and off automatically will still be on and any other conditions that are based on “$gameTimer.isWorking()” will remain true. This option is different from the Pause option, as it does not change the colors of the sprites. It is useful for a cutscene or a brief presentation of what is to come when a timer is started.
• Sprite master > What you change here will apply to all sprites.
• Background and other sprites:
• Enabled > All sprites have this sub-parameter. If you choose to disable, you cannot activate them within the game.
• The orientation of the bars > If you want to change the orientation of the bars be careful to also change the width and height.
• Character/icon > The image that will represent this sprite is similar to the images of the characters used in events. However, it can only be composed of one line and the frames are from left to right (Ex: 1, 2, 3, 4 ...) The Max Frames parameter will determine how many animated "squares" will appear for the character.
• Predefined positions > You can choose predefined positions for the timer. And, from that position, configure the X and Y coordinates of the other sprites. If you choose the top center position, the X = 0 coordinate will start from that predefined position. If you don't want to use a pre-defined position and want to leave the sprites free on the screen, set the manual option and Master X and Master Y to 0.
• Changing fonts > Please see the file “font instructions” inside the font folder.
Plugin Commands
They are, in the majority, not case sensitive. Otherwise, I let you know.
All color-related commands can be used with hex, rgba or by name. In the background sprite, it shows an example of each one, in the others only one command.
• Blended commands: Values from 0 to 3.
• Commands with opacity: Values from 0 to 255.
• Commands with scale: Values of 1 or greater.
• Commands with IMG or FILE: Write the file names without the extension. It is case sensitive.
• Commands with FontFace: Write the names of the files without the extension. It is case sensitive.
• Commands with Align: Values can be Left | Center | Right
• TIMER_CHAR_SPEED command: The higher the value, the slower.
• TIMER_CHAR_MAX_INDEX command: Determines the last index that will appear in the character's animation.
Examples:
• Timer:
◆Plugin Command：TIMER_ADD_SEC 15
◆Plugin Command：TIMER_ADD_MIN 10
◆Plugin Command：TIMER_ADD_HOUR 2
◆Plugin Command：TIMER_REMOVE_SEC 30
◆Plugin Command：TIMER_REMOVE_MIN 20
◆Plugin Command：TIMER_REMOVE_HOUR 1
◆Plugin Command：TIMER_HOLD
◆Plugin Command：TIMER_UNHOLD
◆Plugin Command：TIMER_START_SEC 60
◆Plugin Command：TIMER_START_MIN 30
◆Plugin Command：TIMER_START_HOUR 1
◆Plugin Command：TIMER_PAUSE
◆Plugin Command：TIMER_RESUME
◆Plugin Command：TIMER_STOP
◆Plugin Command：TIMER_SCALE 2
◆Plugin Command：TIMER_POS 300 150
◆Plugin Command：TIMER_PRESET_POS 5
◆Plugin Command：TIMER_OPACITY 150
• Background:
◆Plugin Command：TIMER_BACK_COLOR rgba 1 240 255 255
◆Plugin Command：TIMER_BACK_COLOR #0101FF
◆Plugin Command：TIMER_BACK_COLOR SALMON
◆Plugin Command：TIMER_BACK_DIMMED_ON
◆Plugin Command：TIMER_BACK_DIMMED_OFF
◆Plugin Command：TIMER_BACK_OPACITY 150
◆Plugin Command：TIMER_BACK_BLEND 1
◆Plugin Command：TIMER_BACK_GRADCOLOR rgba 1 255 20 1 rgba 220 255 1 1
◆Plugin Command：TIMER_BACK_GRADCOLOR rgba 125 135 63 1 GREEN
◆Plugin Command：TIMER_BACK_GRADCOLOR #E89223 INDIANRED
◆Plugin Command：TIMER_BACK_GRADCOLOR BLUE rgba 130 63 135 1
• Picture:
◆Plugin Command：TIMER_PICTURE_OPACITY 150
◆Plugin Command：TIMER_PICTURE_BLEND 2
◆Plugin Command：TIMER_PICTURE_IMG picLayout2
◆Plugin Command：TIMER_PICTURE_TONE 255 0 0 0
• Label:
◆Plugin Command：TIMER_LABEL_COLOR rgba 150 0 150 1
◆Plugin Command：TIMER_LABEL_OUTCOLOR Rgba 255 186 1 1
◆Plugin Command：TIMER_LABEL_OPACITY 150
◆Plugin Command：TIMER_LABEL_BLEND 2
◆Plugin Command：TIMER_LABEL_OUTWIDTH 10
◆Plugin Command：TIMER_LABEL_SCALE 2
◆Plugin Command：TIMER_LABEL_POS 0 0
◆Plugin Command：TIMER_LABEL_FONTSIZE 18
◆Plugin Command：TIMER_LABEL_FONTFACE TimerFont
◆Plugin Command：TIMER_LABEL_ITALIC_ON
◆Plugin Command：TIMER_LABEL_ITALIC_OFF
◆Plugin Command：TIMER_LABEL_ALIGN LEFT
◆Plugin Command：TIMER_LABEL_TEXT COUNTDOWN!
• Numbers:
◆Plugin Command：TIMER_NUMBERS_COLOR rgba 150 0 150 1
◆Plugin Command：TIMER_NUMBERS_OUTCOLOR rgba 150 0 150 1
◆Plugin Command：TIMER_NUMBERS_OPACITY 150
◆Plugin Command：TIMER_NUMBERS_BLEND 2
◆Plugin Command：TIMER_NUMBERS_OUTWIDTH 10
◆Plugin Command：TIMER_NUMBERS_SCALE 2
◆Plugin Command：TIMER_NUMBERS_POS 0 10
◆Plugin Command：TIMER_NUMBERS_ALIGN LEFT
◆Plugin Command：TIMER_NUMBERS_FONTSIZE 18
◆Plugin Command：TIMER_NUMBERS_FONTFACE TimerFont
◆Plugin Command：TIMER_NUMBERS_ITALIC_ON
◆Plugin Command：TIMER_NUMBERS_ITALIC_OFF
• Sprite Gauges:
◆Plugin Command：TIMER_GAUGE_OUTCOLOR rgba 150 0 150 1
◆Plugin Command：TIMER_GAUGE_BACKCOLOR rgba 150 0 150 1
◆Plugin Command：TIMER_GAUGE_FRONTCOLOR rgba 1 255 20 1 rgba 220 255 1 1
◆Plugin Command：TIMER_GAUGE_FRONTCOLOR #E89223 INDIANRED
◆Plugin Command：TIMER_GAUGE_OPACITY 155
◆Plugin Command：TIMER_GAUGE_BLEND 3
◆Plugin Command：TIMER_GAUGE_POS 0 25
◆Plugin Command：TIMER_GAUGE_SCALE 2
• Image gauges:
◆Plugin Command：TIMER_PICGAUGE_BACKIMG gaugefront2
◆Plugin Command：TIMER_PICGAUGE_FRONTIMG gaugeback
◆Plugin Command：TIMER_PICGAUGE_BLEND 2
◆Plugin Command：TIMER_PICGAUGE_OPACITY 150
◆Plugin Command：TIMER_PICGAUGE_POS 0 50
◆Plugin Command：TIMER_PICGAUGE_SCALE 2
• Character - Icon:
◆Plugin Command：TIMER_CHAR_OPACITY 150
◆Plugin Command：TIMER_CHAR_IMG fairy
◆Plugin Command：TIMER_CHAR_SPEED 8
◆Plugin Command：TIMER_CHAR_MAX_INDEX 8
◆Plugin Command：TIMER_CHAR_POS 0 100
◆Plugin Command：TIMER_CHAR_SCALE 2
All color-related commands can be used with hex, rgba or by name. In the background sprite, it shows an example of each one, in the others only one command.
• Blended commands: Values from 0 to 3.
• Commands with opacity: Values from 0 to 255.
• Commands with scale: Values of 1 or greater.
• Commands with IMG or FILE: Write the file names without the extension. It is case sensitive.
• Commands with FontFace: Write the names of the files without the extension. It is case sensitive.
• Commands with Align: Values can be Left | Center | Right
• TIMER_CHAR_SPEED command: The higher the value, the slower.
• TIMER_CHAR_MAX_INDEX command: Determines the last index that will appear in the character's animation.
Examples:
• Timer:
◆Plugin Command：TIMER_ADD_SEC 15
◆Plugin Command：TIMER_ADD_MIN 10
◆Plugin Command：TIMER_ADD_HOUR 2
◆Plugin Command：TIMER_REMOVE_SEC 30
◆Plugin Command：TIMER_REMOVE_MIN 20
◆Plugin Command：TIMER_REMOVE_HOUR 1
◆Plugin Command：TIMER_HOLD
◆Plugin Command：TIMER_UNHOLD
◆Plugin Command：TIMER_START_SEC 60
◆Plugin Command：TIMER_START_MIN 30
◆Plugin Command：TIMER_START_HOUR 1
◆Plugin Command：TIMER_PAUSE
◆Plugin Command：TIMER_RESUME
◆Plugin Command：TIMER_STOP
◆Plugin Command：TIMER_SCALE 2
◆Plugin Command：TIMER_POS 300 150
◆Plugin Command：TIMER_PRESET_POS 5
◆Plugin Command：TIMER_OPACITY 150
• Background:
◆Plugin Command：TIMER_BACK_COLOR rgba 1 240 255 255
◆Plugin Command：TIMER_BACK_COLOR #0101FF
◆Plugin Command：TIMER_BACK_COLOR SALMON
◆Plugin Command：TIMER_BACK_DIMMED_ON
◆Plugin Command：TIMER_BACK_DIMMED_OFF
◆Plugin Command：TIMER_BACK_OPACITY 150
◆Plugin Command：TIMER_BACK_BLEND 1
◆Plugin Command：TIMER_BACK_GRADCOLOR rgba 1 255 20 1 rgba 220 255 1 1
◆Plugin Command：TIMER_BACK_GRADCOLOR rgba 125 135 63 1 GREEN
◆Plugin Command：TIMER_BACK_GRADCOLOR #E89223 INDIANRED
◆Plugin Command：TIMER_BACK_GRADCOLOR BLUE rgba 130 63 135 1
• Picture:
◆Plugin Command：TIMER_PICTURE_OPACITY 150
◆Plugin Command：TIMER_PICTURE_BLEND 2
◆Plugin Command：TIMER_PICTURE_IMG picLayout2
◆Plugin Command：TIMER_PICTURE_TONE 255 0 0 0
• Label:
◆Plugin Command：TIMER_LABEL_COLOR rgba 150 0 150 1
◆Plugin Command：TIMER_LABEL_OUTCOLOR Rgba 255 186 1 1
◆Plugin Command：TIMER_LABEL_OPACITY 150
◆Plugin Command：TIMER_LABEL_BLEND 2
◆Plugin Command：TIMER_LABEL_OUTWIDTH 10
◆Plugin Command：TIMER_LABEL_SCALE 2
◆Plugin Command：TIMER_LABEL_POS 0 0
◆Plugin Command：TIMER_LABEL_FONTSIZE 18
◆Plugin Command：TIMER_LABEL_FONTFACE TimerFont
◆Plugin Command：TIMER_LABEL_ITALIC_ON
◆Plugin Command：TIMER_LABEL_ITALIC_OFF
◆Plugin Command：TIMER_LABEL_ALIGN LEFT
◆Plugin Command：TIMER_LABEL_TEXT COUNTDOWN!
• Numbers:
◆Plugin Command：TIMER_NUMBERS_COLOR rgba 150 0 150 1
◆Plugin Command：TIMER_NUMBERS_OUTCOLOR rgba 150 0 150 1
◆Plugin Command：TIMER_NUMBERS_OPACITY 150
◆Plugin Command：TIMER_NUMBERS_BLEND 2
◆Plugin Command：TIMER_NUMBERS_OUTWIDTH 10
◆Plugin Command：TIMER_NUMBERS_SCALE 2
◆Plugin Command：TIMER_NUMBERS_POS 0 10
◆Plugin Command：TIMER_NUMBERS_ALIGN LEFT
◆Plugin Command：TIMER_NUMBERS_FONTSIZE 18
◆Plugin Command：TIMER_NUMBERS_FONTFACE TimerFont
◆Plugin Command：TIMER_NUMBERS_ITALIC_ON
◆Plugin Command：TIMER_NUMBERS_ITALIC_OFF
• Sprite Gauges:
◆Plugin Command：TIMER_GAUGE_OUTCOLOR rgba 150 0 150 1
◆Plugin Command：TIMER_GAUGE_BACKCOLOR rgba 150 0 150 1
◆Plugin Command：TIMER_GAUGE_FRONTCOLOR rgba 1 255 20 1 rgba 220 255 1 1
◆Plugin Command：TIMER_GAUGE_FRONTCOLOR #E89223 INDIANRED
◆Plugin Command：TIMER_GAUGE_OPACITY 155
◆Plugin Command：TIMER_GAUGE_BLEND 3
◆Plugin Command：TIMER_GAUGE_POS 0 25
◆Plugin Command：TIMER_GAUGE_SCALE 2
• Image gauges:
◆Plugin Command：TIMER_PICGAUGE_BACKIMG gaugefront2
◆Plugin Command：TIMER_PICGAUGE_FRONTIMG gaugeback
◆Plugin Command：TIMER_PICGAUGE_BLEND 2
◆Plugin Command：TIMER_PICGAUGE_OPACITY 150
◆Plugin Command：TIMER_PICGAUGE_POS 0 50
◆Plugin Command：TIMER_PICGAUGE_SCALE 2
• Character - Icon:
◆Plugin Command：TIMER_CHAR_OPACITY 150
◆Plugin Command：TIMER_CHAR_IMG fairy
◆Plugin Command：TIMER_CHAR_SPEED 8
◆Plugin Command：TIMER_CHAR_MAX_INDEX 8
◆Plugin Command：TIMER_CHAR_POS 0 100
◆Plugin Command：TIMER_CHAR_SCALE 2
Script Calls
Timer(Replace X with a number)
• $gameTimer.start(X * 60); // Seconds
• $gameTimer.start((X * 60) * 60); // Minutes
• $gameTimer.start(((X * 60) * 60) * 60); // Hours
• $gameTimer.addSeconds(X);
• $gameTimer.addMinutes(X);
• $gameTimer.addHours(X);
• $gameTimer.removeSeconds(X)
• $gameTimer.removeMinutes(X)
• $gameTimer.removeHours(X)
• $gameTimer.pause();
• $gameTimer.resume();
• $gameTimer.hold();
• $gameTimer.unhold();
• $gameTimer.stop();
Sprites - There are many script calls here. The best way for you to find out which one to use is to open the console with F8 or F12 and type:
$gameTimer._param - This will give you access to a list of sprites, which can be:
background / picture / label / numbers / gauge / picGauge / char
Ex: $gameTimer._param.label / $gameTimer._param.gauge
So you can access its properties and change the values by clicking on the arrows.
Ex: $gameTimer._param.label.fontSize = 24;
$gameTimer._param.positions.labelX = 13;
etc…
All of these commands must be written in the same way as they are on the console(it is case sensitive!).
After entering all the commands you want in the script call, just start the timer and it will updated(if the default settings are off)
If the timer is already active, you must use one of these commands at the end of your script call for the update to be done:
$gameTimer._requestPositionUpdate = true;
$gameTimer._requestVisibilityUpdate = true;
$gameTimer._requestSettingsUpdate = true;
$gameTimer._requestColorsUpdate = true;
• $gameTimer.start(X * 60); // Seconds
• $gameTimer.start((X * 60) * 60); // Minutes
• $gameTimer.start(((X * 60) * 60) * 60); // Hours
• $gameTimer.addSeconds(X);
• $gameTimer.addMinutes(X);
• $gameTimer.addHours(X);
• $gameTimer.removeSeconds(X)
• $gameTimer.removeMinutes(X)
• $gameTimer.removeHours(X)
• $gameTimer.pause();
• $gameTimer.resume();
• $gameTimer.hold();
• $gameTimer.unhold();
• $gameTimer.stop();
Sprites - There are many script calls here. The best way for you to find out which one to use is to open the console with F8 or F12 and type:
$gameTimer._param - This will give you access to a list of sprites, which can be:
background / picture / label / numbers / gauge / picGauge / char
Ex: $gameTimer._param.label / $gameTimer._param.gauge
So you can access its properties and change the values by clicking on the arrows.
Ex: $gameTimer._param.label.fontSize = 24;
$gameTimer._param.positions.labelX = 13;
etc…
All of these commands must be written in the same way as they are on the console(it is case sensitive!).
After entering all the commands you want in the script call, just start the timer and it will updated(if the default settings are off)
If the timer is already active, you must use one of these commands at the end of your script call for the update to be done:
$gameTimer._requestPositionUpdate = true;
$gameTimer._requestVisibilityUpdate = true;
$gameTimer._requestSettingsUpdate = true;
$gameTimer._requestColorsUpdate = true;
Screenshots(Visual)
Screenshots(Plugin Parameters)
Terms of Use
1. Give the credits to Eliaquim in the credits section of your game.
2. It can be used in free and commercial games.
3. Do not sell or say that you made this plugin or part of him.
4. Do not redistribute this plugin. Link back to this thread.
DOWNLOAD
It's not a free plugin. You can buy it on the link below.
Eli_SuperTimer.js
Update LogIt's not a free plugin. You can buy it on the link below.
Eli_SuperTimer.js
Version 1.1 - 04/13/2020
- Fixed an issue where several changes made to the sprites did not remain after entering and exiting the menu.
- Removed the PICTURE TONE plugin command, as it is more viable for the user to exchange the picture for another image file.
- Clean code.
Version 1.0 - 04/09/2020
- Released!
- Fixed an issue where several changes made to the sprites did not remain after entering and exiting the menu.
- Removed the PICTURE TONE plugin command, as it is more viable for the user to exchange the picture for another image file.
- Clean code.
Version 1.0 - 04/09/2020
- Released!
Features Mentioned
- Visuals:
- Background: Define colors (single or gradient) and size for the background.
- Picture: Set an image to be displayed as a background.
- Label: Define a label to be displayed along with the timer, being able to change its color, font, position and more!
- Numbers: Set the timer format to show only 00:00 or 00:00:00. You can also customize it as well as the label!
- Sprite Gauges: Set the width and height, color and more of an animated rectangular gauge to symbolize your timer count.
- Image gauges: Same as above, but it can be done by images.
- Character / Icon: Choose an icon or animated character to be displayed along with the timer!
- Mechanics:
- Add or remove seconds, minutes or hours from the active timer.
- The Option of a new format 00:00:00 (hours, minutes, seconds).
- Pause/resume the timer (Stop working).
- Run a common event when the timer starts, pauses or expires.
- Automatically turn on and off a switch when the timer is active/inactive.
- Hold the count (other than pausing, it will still working). Useful for cutscenes or tutorials.
- Adjust the position of all sprites to your liking, or use the preset positions.
- Adjust the layer order for each displayed sprite.
- Possibility to change the settings for all sprites while the timer is active.
Downloads / Referenced Files
Log in to download
Log in, then follow the RPG Maker Developers Group to see these download links.
Log in to downloadLicense / Terms Note
Terms of Use 1. Give the credits to Eliaquim in the credits section of your game. 2. It can be used in free and commercial games. 3. Do not sell or say that you made this plugin or part of him.
Creator Claims / Removal
If you are the original creator and want this listing reassigned, edited, or removed, join BMMPlay and contact the moderators with proof that matches the original RPG Maker Web profile, linked GitHub, itch.io page, or another public creator identity.
Replies (0)
No replies yet.
Topic Summary
Loading summary...