io.github.nucleuspowered.nucleus.api.module.note.event

Interface NucleusNoteEvent

All Superinterfaces:

org.spongepowered.api.event.Event, org.spongepowered.api.event.user.TargetUserEvent

All Known Subinterfaces:

NucleusNoteEvent.Created

@MightOccurAsync
public interface NucleusNoteEvent
extends org.spongepowered.api.event.user.TargetUserEvent

Events for when notes are added to users.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	NucleusNoteEvent.Created Event that is fired when a note is created.

Method Summary

Modifier and Type	Method and Description
java.util.Optional<java.util.UUID>	getAuthor() Gets the UUID of the player who added the note, or an Optional.empty() if it was not a player.
java.time.Instant	getDate() Gets the Instant the note was created.
java.lang.String	getNote() The note.
org.spongepowered.api.entity.living.player.User	getTargetUser() The subject of the note.

Methods inherited from interface org.spongepowered.api.event.Event

getCause, getContext, getSource

Method Detail

getAuthor

java.util.Optional<java.util.UUID> getAuthor()

Gets the UUID of the player who added the note, or an Optional.empty() if it was not a player.

Returns:

The UUID of the player, if any.

getDate

java.time.Instant getDate()

Gets the Instant the note was created.

Returns:

When the note was created.

getNote

java.lang.String getNote()

The note.

Returns:

The note

getTargetUser

org.spongepowered.api.entity.living.player.User getTargetUser()

The subject of the note.

Specified by:

getTargetUser in interface org.spongepowered.api.event.user.TargetUserEvent

Returns:

The User