Method Events¶
Method Information¶
BanUser¶
Ban a user from the server
Event.MinecraftModule.BanUser
- Consumes these values:
Reason: type(String)
User: type(SimpleUser)
BanUserIP¶
Ban a user from the server by their IP address
Event.MinecraftModule.BanUserIP
- Consumes these values:
Reason: type(String)
User: type(SimpleUser)
CheckForUpdates¶
Check for available updates via SteamCMD
Event.steamcmdplugin.CheckForUpdates
CheckForUpdates - MinecraftModule¶
Check for Minecraft server updates
Event.MinecraftModule.CheckForUpdates
CommandWithWarnings¶
Run a command in one hour, with warnings (non-blocking)
Event.CommonCorePlugin.CommandWithWarnings
- Consumes these values:
Command: type(String)
FiveMins: type(String)
FiveSecs: type(String)
OneHour: type(String)
OneMin: type(String)
ThirtyMins: type(String)
ThirtySecs: type(String)
DiscordMessage¶
Post a message on Discord
Event.WebRequestPlugin.DiscordMessage
- Consumes these values:
Contents: type(String)
DisplayUsername: type(String)
WebhookURL: type(String)
Fabulous¶
Make a player fabulous
Event.MinecraftModule.Fabulous
- Consumes these values:
User: type(SimpleUser)
GiveXP¶
Give XP to a player
Event.MinecraftModule.GiveXP
- Consumes these values:
Quantity: type(Int32)
User: type(SimpleUser)
IfCondition¶
If condition is met
Event.CommonCorePlugin.IfCondition
- Consumes these values:
- Operation: type(IfOperators)
0 - Equals
1 - NotEquals
2 - Contains
3 - DoesNotContain
4 - GreaterThan
5 - LessThan
6 - GreaterThanOrEqual
7 - LessThanOrEqual
8 - RegexMatch
ValueToCheck: type(String)
ValueToCompare: type(String)
KickUser¶
Kick a user from the server
Event.MinecraftModule.KickUser
- Consumes these values:
Reason: type(String)
User: type(SimpleUser)
KillPlayer¶
Kill a player
Event.MinecraftModule.KillPlayer
- Consumes these values:
User: type(SimpleUser)
MakeGETRequest¶
Make a GET request to a URI.
Event.WebRequestPlugin.MakeGETRequest
- Consumes these values:
URI: type(String)
MakePOSTRequest¶
Make a POST request to a URI.
Event.WebRequestPlugin.MakePOSTRequest
- Consumes these values:
ContentType: type(String)
Payload: type(String)
URI: type(String)
PushMessage¶
Push a message via PushBullet
Event.WebRequestPlugin.PushMessage
- Consumes these values:
body: type(String)
title: type(String)
PushMessageChannel¶
Push a message via PushBullet to a specific channel
Event.WebRequestPlugin.PushMessageChannel
- Consumes these values:
body: type(String)
channel: type(String)
title: type(String)
Restart¶
Restart the Minecraft server
Event.MinecraftModule.Restart
RestartIfEmpty¶
Restart the application server, but only if it is empty
Event.CommonCorePlugin.RestartIfEmpty
RestoreBackup¶
Restore a backup
Event.LocalFileBackupPlugin.RestoreBackup
- Consumes these values:
BackupId: type(String)
SaveChanges¶
Write unsaved world data to disk (save-all)
Event.MinecraftModule.SaveChanges
ScheduleEmptyUpdate¶
Schedule an update and restart once the last user leaves, or immediately if empty.
Event.CommonCorePlugin.ScheduleEmptyUpdate
SendConsole¶
Send console input to the Minecraft server
Event.MinecraftModule.SendConsole
- Consumes these values:
Input: type(String)
SendConsoleAdv¶
Send advanced console input to the Minecraft server (Supports escaped characters)
Event.MinecraftModule.SendConsoleAdv
- Consumes these values:
Input: type(String)
SendGlobalTitle¶
Send a global title message
Event.MinecraftModule.SendGlobalTitle
- Consumes these values:
Subtitle: type(String)
Title: type(String)
SendMail¶
Send an email
Event.EmailSenderPlugin.SendMail
- Consumes these values:
Message: type(String)
- Priority: type(MailPriority)
0 - Normal
1 - Low
2 - High
Subject: type(String)
To: type(String)
SendMultipleConsole¶
Send multiple lines of input to the Minecraft server
Event.MinecraftModule.SendMultipleConsole
- Consumes these values:
Input: type(String)
SendServerMessage¶
Send a message to everyone on the server
Event.MinecraftModule.SendServerMessage
- Consumes these values:
Message: type(String)
SendTitle¶
Send a title message to a specific player
Event.MinecraftModule.SendTitle
- Consumes these values:
Subtitle: type(String)
Title: type(String)
User: type(SimpleUser)
SendUserMessage¶
Send a message to a specific player
Event.MinecraftModule.SendUserMessage
- Consumes these values:
Message: type(String)
Player: type(SimpleUser)
SendWakeOnLan¶
Send a Wake-On-LAN packet
Event.CommonCorePlugin.SendWakeOnLan
- Consumes these values:
MACAddress: type(String)
SetGameTime¶
Set the game time to a given real-world time
Event.MinecraftModule.SetGameTime
- Consumes these values:
When: type(DateTime)
SlackMessage¶
Post a message on Slack
Event.WebRequestPlugin.SlackMessage
- Consumes these values:
Contents: type(String)
WebhookURL: type(String)
Sleep¶
Put the server to sleep (Players can still connect)
Event.MinecraftModule.Sleep
SmitePlayer¶
Strike a player with lightning
Event.MinecraftModule.SmitePlayer
- Consumes these values:
User: type(SimpleUser)
Start¶
Start the Minecraft Server
Event.MinecraftModule.Start
Stop¶
Stop the Minecraft Server
Event.MinecraftModule.Stop
StopIfEmpty¶
Stop the application server, but only if it is empty
Event.CommonCorePlugin.StopIfEmpty
TakeBackup¶
Take a backup
Event.LocalFileBackupPlugin.TakeBackup
TakeBackupWhileDown¶
Shut the server down, take a backup, and start it up again.
Event.LocalFileBackupPlugin.TakeBackupWhileDown
- Consumes these values:
RestartEvenIfNotRunning: type(Boolean)
TakeStickyBackup¶
Take a sticky backup
Event.LocalFileBackupPlugin.TakeStickyBackup
TeleportToCoords¶
Teleport a player to a set of coordinates
Event.MinecraftModule.TeleportToCoords
- Consumes these values:
User: type(SimpleUser)
X: type(Single)
Y: type(Single)
YAngle: type(Single)
Z: type(Single)
ZAngle: type(Single)
TeleportToPlayer¶
Teleport a player to another player
Event.MinecraftModule.TeleportToPlayer
- Consumes these values:
Target: type(SimpleUser)
User: type(SimpleUser)
UpdateAndRestart¶
Update the application and restart it if it was previously running
Event.CommonCorePlugin.UpdateAndRestart
Wait¶
Wait
Event.CommonCorePlugin.Wait
- Consumes these values:
Seconds: type(Double)
Weaken¶
Weaken a player
Event.MinecraftModule.Weaken
- Consumes these values:
User: type(SimpleUser)