| Interface | Description |
|---|---|
| CancelMessage | |
| NucleusAFKEvent | |
| NucleusAFKEvent.GoingAFK |
Fired when a player goes AFK.
|
| NucleusAFKEvent.Kick |
Fired when a player is about to be kicked due to inactivity.
|
| NucleusAFKEvent.NotifyCommand |
Fired when the target of a command is AFK and the command is marked
as one that should notify the sender.
|
| NucleusAFKEvent.ReturningFromAFK |
Fired when a player returns from AFK.
|
| NucleusChangeNicknameEvent | Deprecated
Use
NucleusChangeNicknameEvent.Pre instead, this will
become a common interface to include Post in v2.0. |
| NucleusChangeNicknameEvent.Post | |
| NucleusChangeNicknameEvent.Pre | |
| NucleusClearInventoryEvent |
Fired when a player's inventory is cleared.
|
| NucleusClearInventoryEvent.Post |
Called when standard inventories have been cleared and should be used to clear other
inventories.
|
| NucleusClearInventoryEvent.Pre |
Called before any clearing takes effect.
|
| NucleusFirstJoinEvent |
Fired on a player's first time on the server.
|
| NucleusHomeEvent |
Events when a player's home changes.
|
| NucleusHomeEvent.Create |
Fired when a home is created.
|
| NucleusHomeEvent.Delete |
Fired when a home is deleted.
|
| NucleusHomeEvent.Modify |
Fired when a home is moved.
|
| NucleusHomeEvent.Use |
Fired when a
User is warped to a home. |
| NucleusJailEvent |
Called when a
User is jailed or unjailed. |
| NucleusJailEvent.Jailed |
Fired when a player is jailed.
|
| NucleusJailEvent.Unjailed |
Fired when a player is unjailed.
|
| NucleusKitEvent |
Events that are related about kits.
|
| NucleusKitEvent.Redeem |
Fired when a kit is redeemed.
|
| NucleusKitEvent.Redeem.Failed |
Fired when a player's kit could not be updated.
|
| NucleusKitEvent.Redeem.Post |
Fired when a player's kit has been updated.
|
| NucleusKitEvent.Redeem.Pre |
Fired when a player is redeeming a kit.
|
| NucleusMailEvent |
An event that is posted when a player uses /mail in NucleusPlugin
|
| NucleusMessageEvent |
An event that is posted when a player uses /m in NucleusPlugin
|
| NucleusModuleEvent |
A set of events that fire at various points of the NucleusPlugin lifecycle.
|
| NucleusModuleEvent.AboutToConstruct |
Fired just before modules are loaded.
|
| NucleusModuleEvent.AboutToEnable |
Fires when the Pre-Enable state of a module is about to be fired.
|
| NucleusModuleEvent.Complete |
Fires when all modules have fully loaded and the module loader has nothing more to do.
|
| NucleusModuleEvent.Enabled |
Fires when the Enable state of a module has completed, and the module is declared enabled.
|
| NucleusModuleEvent.PreEnable |
Fires when the Pre-Enable state of a module has completed, but is yet to be declared enabled.
|
| NucleusMuteEvent |
Events that occur whilst muted.
|
| NucleusMuteEvent.Muted |
Fired when a player is muted.
|
| NucleusMuteEvent.Unmuted |
Fired when a player is unmuted.
|
| NucleusNameBanEvent |
An event fired when a name is added or removed from the name ban list.
|
| NucleusNameBanEvent.Banned |
Fired when a regular expression is banned.
|
| NucleusNameBanEvent.Unbanned |
Fired when a regular expression is unbanned.
|
| NucleusNoteEvent |
Events for when notes are added to users.
|
| NucleusNoteEvent.Created |
Event that is fired when a note is created.
|
| NucleusRTPEvent |
Events for RTP
|
| NucleusRTPEvent.SelectedLocation |
Fired when the RTP system has selected a location
|
| NucleusSendToSpawnEvent |
Called when Nucleus has been requested to send a
User to spawn, either now, or on their next login. |
| NucleusTeleportEvent |
These events are fired before teleportation actually happens.
|
| NucleusTeleportEvent.AboutToTeleport |
Called when a player is about to be teleported through the Nucleus system.
|
| NucleusTeleportEvent.Request |
Indicates that a teleport request (such as through
/tpa) is being sent. |
| NucleusTeleportEvent.Request.CauseToPlayer |
Called when the root cause wants to teleport to the target player (like /tpa).
|
| NucleusTeleportEvent.Request.PlayerToCause |
Called when the root cause wants the target player to teleport to them (like /tpahere).
|
| NucleusTextTemplateEvent |
Event when messages are sent using
NucleusTextTemplates. |
| NucleusTextTemplateEvent.Broadcast |
Raised when the text being sent originated as a broadcast.
|
| NucleusWarnEvent |
Events for when players are warned.
|
| NucleusWarnEvent.Expired |
Fired when a warning expires.
|
| NucleusWarnEvent.Warned |
Fired when a player has been warned.
|
| NucleusWarpEvent |
Events when a server warp changes.
|
| NucleusWarpEvent.Create |
Fired when a warp is created.
|
| NucleusWarpEvent.Delete |
Fired when a warp is deleted.
|
| NucleusWarpEvent.Use |
Fired when a
User tries to teleport to a warp. |
| Enum | Description |
|---|---|
| NucleusModuleEvent.ModuleEnableState | |
| NucleusSendToSpawnEvent.Type |
The type of the spawn event.
|