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

Interface NucleusNoteService

public interface NucleusNoteService

A service that determines whether a subject has notes.

Method Summary

Modifier and Type	Method and Description
boolean	addNote(org.spongepowered.api.entity.living.player.User user, org.spongepowered.api.command.CommandSource source, java.lang.String note) Adds a note to a subject.
boolean	clearNotes(org.spongepowered.api.entity.living.player.User user) Clears all notes from a subject.
com.google.common.collect.ImmutableList<Note>	getNotes(org.spongepowered.api.entity.living.player.User user) Gets all notes for a specific user
boolean	removeNote(org.spongepowered.api.entity.living.player.User user, Note note) Removes a note from a subject.

Method Detail

getNotes

com.google.common.collect.ImmutableList<Note> getNotes(org.spongepowered.api.entity.living.player.User user)

Gets all notes for a specific user

Parameters:

user - The User to check.

Returns:

A list of Notes.

addNote

boolean addNote(org.spongepowered.api.entity.living.player.User user,
                org.spongepowered.api.command.CommandSource source,
                java.lang.String note)

Adds a note to a subject.

Parameters:

user - The User to add a note to.

source - The CommandSource that is adding the note.

note - The note to add.

Returns:

true if the note was added.

removeNote

boolean removeNote(org.spongepowered.api.entity.living.player.User user,
                   Note note)

Removes a note from a subject.

Parameters:

user - The User to remove a note from.

note - The Note to remove.

Returns:

true if the note was removed.

clearNotes

boolean clearNotes(org.spongepowered.api.entity.living.player.User user)

Clears all notes from a subject.

Parameters:

user - The User to remove all notes from.

Returns:

true if all notes were removed.