RPG Maker Custom Timer System 1.1

Title: CT_Bolt's Timers System

Current Version: v1.10

Description:

An extremely customize-able timer system for RPG Maker MV

Feature List:

List coming soon, very very many to list.





How to Use (basic use):

For the following script calls...

if eventId < 1 the player's timer will be used if mode is not 2.

if eventId > 0 the event's timer will be used if mode is not 2.

if mode is 2 then "extra" timers will be used.

Script Calls:

startTimer(settings) // settings is an object that can contain many various options. see below.

changeTimer(eventId, settings, mode) // if mode is used and set to 2 this will change an "extra" timer.

pauseTimer(eventId, toggle, mode) // set toggle to true to toggle paused

unpauseTimer(eventId, mode) // unpause the timer, if mode set to 2 this will change an "extra" timer.

stopTimer(eventId, mode) // if mode set to 2 this will change an "extra" timer.

Examples:

A)

startTimer({timerId: 1, eventId: 0, seconds: 60, commonEventId: 1, switchId: 1, switchMode: 2, selfSwitchId: 'A', selfSwitchMode: 2, selfSwitchMapId: 1, selfSwitchEventId: 1, script: $gameVariables.setValue($gameVariables.value(1)+1), intervalScript: script: $gameVariables.setValue($gameVariables.value(1)+1), intervalCommonEventId: 2, interval: 10, font: 'verdana', fontSize: 12, fontItalic: false, textColor: 'rgba(0, 255, 0, 255)', textOutlineColor: 'rgba(0, 255, 0, 255)', textOutlineWidth: 4, textVisible: false, useGauge: true, gaugeColorA: 'rgba(0, 0, 255, 255)', gaugeColorB: 'rgba(255, 0, 0, 255)', gaugeX: 0, gaugeY: 0, gaugeWidth: 28, gaugeHeight: 14, gaugeOutlineColor: 'rgba(0, 0, 0, 0)', gaugeTextOnTop: true, gaugeTopImage: 'gauge_top', gaugeBottomImage: 'gauge_top', x: 0, y: 0, width: 96, height: 48, screenLocked: false, expires: true, textPrefix: "Time: [", textSuffix: "]", visible: true, speed: 60, maxSeconds: 60, direction: -1, textMode: 1, textCodeOffset: 64, textArray: ['A', 'B', 'C', 'D'], topImage: 'timer_top', bottomImage: 'timer_bottom'});

This starts a timer using "player" timer and uses timerId #1 setting as a base, then adds a bunch of other manual(override) settings.

B)

startTimer({timerId: 2, eventId: 1, mode: 2});

This starts a timer using the first "extra" timer and uses timerId #2 setting from the plugin parameters set in the plugin manager.

Note the use of mode 2 which tells this to use an "extra" timer.

C)

changeTimer(18, {timerId: 5, seconds: 60})

This will change the timer of EventID #18 to the preset timerId #5 setting from the plugin parameters set in the plugin manager.

This also overrides the amount of seconds to 60

changeTimer(2, {timerId: 3}, 2)

This will change the second "extra" timer to the preset timerId #3 setting from the plugin parameters set in the plugin manager.

Note the use of mode 2 which tells this to use an "extra" timer.

Property Definitions:

timerId: Number

Preset Timer ID, these are set using Plugin Parameters

eventId: Number

Event ID, the Event ID of an event on the current map

seconds: Number

Number of Seconds

commonEventId: Number

Common Event ID that is executed when the timer expires

switchId: Number

Switch ID that is toggled when the timer expires

switchMode: Number

Switch Mode, 0 = Off, 1 = On, 2 = Toggle

selfSwitchId: String

Self Switch ID that is toggled when the timer expires

selfSwitchMode: Number

Self Switch Mode, 0 = Off, 1 = On, 2 = Toggle

selfSwitchMapId: Number

Self Switch Map ID

selfSwitchEventId: Number

Self Switch Event ID

script: String

Script that is executed when the timer expires

intervalScript: String

Script that is executed at the set interval

intervalCommonEventId: String

Common Event ID that is executed at the set interval

interval: Number

Interval amount

font: String

fontSize: Number

fontItalic: Boolean

textColor: String

textOutlineColor: String

textOutlineWidth: Number

textVisible: Boolean

useGauge: Boolean

gaugeColorA: String

gaugeColorB: String

gaugeX: Number

gaugeY: Number

gaugeWidth: Number

gaugeHeight: Number

gaugeOutlineColor: String

gaugeTextOnTop: Boolean

gaugeTopImage: String

gaugeBottomImage: String

x: Number

y: Number

width: Number

height: Number

screenLocked: Boolean

expires: Boolean

textPrefix: String

textSuffix: String

visible: Boolean

visibleInBattle: Boolean

workingInBattle: Boolean

allowFollowInBattle: Boolean

speed: Number

maxSeconds: Number

direction: Number

textMode: Number

1 = 00:00, 2 = Text Code Offset, 3 = Random Text Array, 4 = Seconds Only, 5 = Text Array, 6 = Real Time, 7 = 00/60, 8 = Script

textCodeOffset: Number

textArray: Array

textScript: String

topImage: String

bottomImage: String

Note/Comments Tags:

Place the following Note-Tags/Comments in Events to Setup Timers that automatically run everytime the map is loaded.

Use ,, to seperate the timer Properties (or seperate with new line)

*FYI* Page Comments Take Priority Over Notebox

The format is similar to the script calls above, and is not case sensitive. Also javascript can be used.

Examples:

A)

Timer ID: 5,, TextColor: 'rgba(255,255,0,255)',, Seconds: 25,, FontSize: 22,, CommonEventId: 23

This will start a timer when the page is activated using TimerId #5 and then manually(override) a few other settings.

B)

Stop Timer

This will stop the timer



History Log:

v0.70 Alpha Release (2018)

v1.00 Beta Release (2019)

v1.10 Initial Release (02/01/2020)