MLCountdown Plugin

From Cinemar Wiki
Jump to: navigation, search

About

MLCountdown adds ability to trigger MLServer commands when a timed event is triggered. The plugin supports 16 individual countdown events.


Software Requirements

MainLobby Server 3

MainLobby 3 Client


Installation

MLCountdown can be downloaded with latest MLServer3 installation, or latest can be found using MLServer3 / Help / Additional Software Downloads.

Download the MLCountdown_Plugin_Setup.exe file and run it on the MLServer3 PC while MLServer is shutdown.

Restart MLServer3

Right click on the MLCountdown plugin in the Plugins window and click Setup tab.

Click Enable checkbox, set the day and time you would like the MLServeCmd to fire.

Enter your desired MLServeCmd.

Click Save.

Repeat the above process for subsequent timed events.


MLServeCmds

MLCountdown|SetTimer~Timer~Month~Day~Year~Hour~Minute~Seconds~AmPm

or

MLCountDown|SetTimer~Timer~Offset~Increment

where Increment = Yr or Mn or Dy or H or M or S

or

MLCountDown|SetTimer~Timer~H:M:S

where H:M:S = Hours:Minutes:Seconds

MLCountdown|Enable~Timer

MLCountdown|Disable~Timer

MLCountDown|Toggle~Timer

Where Timer = 1..16


Question:
"I would like to do something like this:

MLCountdown|SetTimer~1~Offset~160

I would hope this would set the timer to 160 seconds from the current time.

The syntax for the offset command and does it work like I want or will I have to convert my seconds into Minutes and seconds?

Answer:
Macro|MLCountdown|SetTimer~1~160~S!MLCountdown|Enable~1

The offset is a physical number based off the current time. The increment is how the offset number is interpreted.

MLServer Variables

countdown_X_

Where X is 1 - 16

and

<time interval> can be days, hours and minutes till the countdown event fires.


countdown_X_status

Status will be 0 if the event has not been triggered yet, or 1 if the event has been executed already.

Bugs

== New Feature Requests ==