Index (squirtgun-api 2.0.0-pre8 API)

A B C D E F G H I K L M N O P R S T U V W
All Classes|All Packages|Deprecated API

A

AbstractArgument<T> - Class in net.lucypoulton.squirtgun.command.argument: An abstract argument, encapsulating the name and description fields.
AbstractArgument(String, String, boolean) - Constructor for class net.lucypoulton.squirtgun.command.argument.AbstractArgument
AbstractCancellableEvent - Class in net.lucypoulton.squirtgun.platform.event.cancellable
AbstractCancellableEvent() - Constructor for class net.lucypoulton.squirtgun.platform.event.cancellable.AbstractCancellableEvent
AbstractCancellablePlayerEvent - Class in net.lucypoulton.squirtgun.platform.event.player: An abstract event, implementing PlayerEvent.player() and CancellableEvent methods.
AbstractCancellablePlayerEvent(SquirtgunPlayer) - Constructor for class net.lucypoulton.squirtgun.platform.event.player.AbstractCancellablePlayerEvent
AbstractNode<T extends PermissionHolder> - Class in net.lucypoulton.squirtgun.command.node
AbstractNode(String, String, Condition<PermissionHolder, ? extends T>) - Constructor for class net.lucypoulton.squirtgun.command.node.AbstractNode
action(Runnable) - Method in class net.lucypoulton.squirtgun.platform.scheduler.Task.Builder
action(Consumer<Platform>) - Method in class net.lucypoulton.squirtgun.platform.scheduler.Task.Builder
ADVENTURE - Enum constant in enum class net.lucypoulton.squirtgun.platform.Gamemode
alwaysTrue() - Static method in interface net.lucypoulton.squirtgun.command.condition.Condition: A condition that will always pass, carrying out no casting.
and(Condition<? super U, V>) - Method in interface net.lucypoulton.squirtgun.command.condition.Condition: Combines two conditions with the same output type and a contravariant input type in such a way that the test passes when both tests are successful.
applyLegacyDecorations(Component, String) - Static method in class net.lucypoulton.squirtgun.format.TextFormatter: Apply a string of legacy decoration codes to a component.
arguments(CommandArgument<?>...) - Method in class net.lucypoulton.squirtgun.command.node.NodeBuilder: Adds arguments to this node.
async() - Method in class net.lucypoulton.squirtgun.platform.scheduler.Task.Builder
AuthMode - Enum Class in net.lucypoulton.squirtgun.platform

B

BlockedGradient - Class in net.lucypoulton.squirtgun.format.blocked: A blocked gradient - somewhat akin to a striped flag, represents solid and evenly-distributed blocks of colour.
BlockedGradient(String[], TextColor...) - Constructor for class net.lucypoulton.squirtgun.format.blocked.BlockedGradient
BlockedGradient(String, TextColor...) - Constructor for class net.lucypoulton.squirtgun.format.blocked.BlockedGradient
BlockedGradientPattern - Class in net.lucypoulton.squirtgun.format.blocked
BlockedGradientPattern(String, BlockedGradient...) - Constructor for class net.lucypoulton.squirtgun.format.blocked.BlockedGradientPattern
build() - Method in class net.lucypoulton.squirtgun.command.node.NodeBuilder: Builds this node, throwing a NullPointerException if an argument is incorrect or missing.
build() - Method in class net.lucypoulton.squirtgun.platform.event.EventHandler.Builder: Builds an EventHandler.
build() - Method in class net.lucypoulton.squirtgun.platform.scheduler.Task.Builder
build() - Method in class net.lucypoulton.squirtgun.util.SemanticVersion
builder() - Static method in class net.lucypoulton.squirtgun.platform.scheduler.Task
builder(Class<T>) - Static method in class net.lucypoulton.squirtgun.platform.event.EventHandler: Creates a new builder.
builder(Runnable) - Static method in class net.lucypoulton.squirtgun.platform.scheduler.Task
builder(Consumer<Platform>) - Static method in class net.lucypoulton.squirtgun.platform.scheduler.Task
Builder() - Constructor for class net.lucypoulton.squirtgun.platform.scheduler.Task.Builder
BUNGEE - Enum constant in enum class net.lucypoulton.squirtgun.platform.AuthMode

C

cancel() - Method in class net.lucypoulton.squirtgun.platform.event.cancellable.AbstractCancellableEvent
cancel() - Method in interface net.lucypoulton.squirtgun.platform.event.cancellable.CancellableEvent: Cancels this event.
cancel(Task) - Method in interface net.lucypoulton.squirtgun.platform.scheduler.TaskScheduler: Cancels a task.
CancellableEvent - Interface in net.lucypoulton.squirtgun.platform.event.cancellable
centreText(String, FormatProvider, String) - Static method in class net.lucypoulton.squirtgun.format.TextFormatter: Inserts characters either side of an input string to centre-align it in chat.
centreText(String, FormatProvider, String, TextDecoration[]) - Static method in class net.lucypoulton.squirtgun.format.TextFormatter: Inserts characters either side of an input string to centre-align it in chat.
checkDataForUpdate() - Method in class net.lucypoulton.squirtgun.update.UpdateChecker
checkDataForUpdate(String) - Method in class net.lucypoulton.squirtgun.update.PolymartUpdateChecker
checkDataForUpdate(String) - Method in class net.lucypoulton.squirtgun.update.UpdateChecker: Check if the result of a request indicates an update is available.
checkDataForUpdate(String) - Method in class net.lucypoulton.squirtgun.update.VersionStringUpdateChecker
checkForUpdate() - Method in class net.lucypoulton.squirtgun.update.UpdateChecker: Executes a blocking request to check for an update.
colourFromText(String) - Static method in class net.lucypoulton.squirtgun.format.TextFormatter: Parse a string colour representation to a TextColor.
CommandArgument<T> - Interface in net.lucypoulton.squirtgun.command.argument: An argument.
CommandContext - Interface in net.lucypoulton.squirtgun.command.context: The context a command is executed in, responsible for parsing, tab-completing and executing the command.
CommandNode<T extends PermissionHolder> - Interface in net.lucypoulton.squirtgun.command.node: A node as part of a command chain.
compareTo(EventHandler<?>) - Method in class net.lucypoulton.squirtgun.platform.event.EventHandler
compareTo(SemanticVersion) - Method in class net.lucypoulton.squirtgun.util.SemanticVersion
condition(Condition<PermissionHolder, T>) - Method in class net.lucypoulton.squirtgun.command.node.NodeBuilder: Sets this node's required condition.
Condition<T extends PermissionHolder,U extends PermissionHolder> - Interface in net.lucypoulton.squirtgun.command.condition: A condition that must be satisfied in order for a command to run.
Condition.Result<U> - Class in net.lucypoulton.squirtgun.command.condition: The result of a test.
CREATIVE - Enum constant in enum class net.lucypoulton.squirtgun.platform.Gamemode

D

delay(int) - Method in class net.lucypoulton.squirtgun.platform.scheduler.Task.Builder
description(String) - Method in class net.lucypoulton.squirtgun.command.node.NodeBuilder: Sets this node's description.
dispatch(T) - Method in class net.lucypoulton.squirtgun.platform.event.EventManager: Dispatches an event, calling all event handlers in the corresponding order.

E

equals(Object) - Method in class net.lucypoulton.squirtgun.platform.event.EventHandler
equals(Object) - Method in class net.lucypoulton.squirtgun.platform.scheduler.Task
equals(Object) - Method in class net.lucypoulton.squirtgun.util.SemanticVersion
Event - Interface in net.lucypoulton.squirtgun.platform.event: An event.
Event.Result - Interface in net.lucypoulton.squirtgun.platform.event: The result of executing an event's handlers.
EventHandler<T extends Event> - Class in net.lucypoulton.squirtgun.platform.event: An event handler.
EventHandler.Builder<T extends Event> - Class in net.lucypoulton.squirtgun.platform.event
EventListener - Interface in net.lucypoulton.squirtgun.platform.event: A set of EventHandlers.
EventManager - Class in net.lucypoulton.squirtgun.platform.event: Manages the execution of events and listeners.
EventManager(Platform) - Constructor for class net.lucypoulton.squirtgun.platform.event.EventManager
EventPriority - Enum Class in net.lucypoulton.squirtgun.platform.event: A priority for an event handler to dictate which order event handlers are executed in.
eventType() - Method in class net.lucypoulton.squirtgun.platform.event.EventHandler: The type of event that this handler accepts.
execute() - Method in interface net.lucypoulton.squirtgun.command.context.CommandContext: Executes the command.
execute() - Method in class net.lucypoulton.squirtgun.command.context.StringContext
execute(CommandContext) - Method in interface net.lucypoulton.squirtgun.command.node.CommandNode: Execute this node.
execute(CommandContext) - Method in class net.lucypoulton.squirtgun.command.node.HelpNode
execute(CommandContext) - Method in class net.lucypoulton.squirtgun.command.node.PluginInfoNode
execute(CommandContext) - Method in class net.lucypoulton.squirtgun.command.node.subcommand.SubcommandHelpNode
execute(CommandContext) - Method in class net.lucypoulton.squirtgun.command.node.subcommand.SubcommandNode
execute(Platform) - Method in class net.lucypoulton.squirtgun.platform.scheduler.Task: Executes this task.
execute(T) - Method in class net.lucypoulton.squirtgun.platform.event.EventHandler: Executes the handler.
executeOnCancel() - Method in class net.lucypoulton.squirtgun.platform.event.EventHandler.Builder: Defaults to false, calling sets to true.
executes(Function<CommandContext, Component>) - Method in class net.lucypoulton.squirtgun.command.node.NodeBuilder: Sets the function to execute this node.
executes(Class<T>, Consumer<T>) - Static method in class net.lucypoulton.squirtgun.platform.event.EventHandler: Creates a new builder from a consumer, with event priority EventPriority.NORMAL.
executesOnCancel() - Method in class net.lucypoulton.squirtgun.platform.event.EventHandler: Whether this handler should be called if a handler with a higher priority has cancelled the event.

F

fade(int, int, int) - Static method in class net.lucypoulton.squirtgun.format.TextFormatter: Create an array of evenly-spaced integers between two values.
failed() - Method in interface net.lucypoulton.squirtgun.platform.event.Event.Result: Inverse of Event.Result.successful()
FAILURE - Static variable in interface net.lucypoulton.squirtgun.platform.event.Event.Result
findWidth(String) - Static method in class net.lucypoulton.squirtgun.format.TextWidthFinder: Calculates the pixel of a string when using the default font.
format(String) - Static method in class net.lucypoulton.squirtgun.format.TextFormatter: Parses a string to a set of coloured components, calculating gradients.
format(String, String, boolean) - Static method in class net.lucypoulton.squirtgun.format.TextFormatter: Parses a string to a set of coloured components, calculating gradients.
formatAccent(String) - Method in interface net.lucypoulton.squirtgun.format.FormatProvider: Formats text using the accent colour.
formatAccent(String, TextDecoration[]) - Method in interface net.lucypoulton.squirtgun.format.FormatProvider: Formats text using the accent colour.
formatFooter(String) - Method in interface net.lucypoulton.squirtgun.format.FormatProvider: Formats text into a footer, intended to be shown as the last line of a message.
formatMain(String) - Method in interface net.lucypoulton.squirtgun.format.FormatProvider: Formats text using the main colour.
formatMain(String, TextDecoration[]) - Method in interface net.lucypoulton.squirtgun.format.FormatProvider: Formats text using the main colour.
FormatPattern - Interface in net.lucypoulton.squirtgun.format.pattern: A pattern that replaces string text into a component.
FormatProvider - Interface in net.lucypoulton.squirtgun.format: Provides formatting info to a command.
formatTitle(String, FormatProvider) - Static method in class net.lucypoulton.squirtgun.format.TextFormatter: Deprecated.
use FormatProvider.formatTitle(String)
formatTitle(String) - Method in interface net.lucypoulton.squirtgun.format.FormatProvider: Formats title text.
fromString(String) - Static method in class net.lucypoulton.squirtgun.util.UuidUtils: Converts a UUID, either with or without dashes, to a string.

G

Gamemode - Enum Class in net.lucypoulton.squirtgun.platform
getArguments() - Method in interface net.lucypoulton.squirtgun.command.node.CommandNode: Gets this command's arguments.
getArguments() - Method in class net.lucypoulton.squirtgun.command.node.HelpNode
getArguments() - Method in class net.lucypoulton.squirtgun.command.node.subcommand.SubcommandHelpNode
getArguments() - Method in class net.lucypoulton.squirtgun.command.node.subcommand.SubcommandNode
getArgumentValue(String) - Method in interface net.lucypoulton.squirtgun.command.context.CommandContext: Gets the value of an argument by name.
getArgumentValue(String) - Method in class net.lucypoulton.squirtgun.command.context.StringContext
getArgumentValue(CommandArgument<U>) - Method in interface net.lucypoulton.squirtgun.command.context.CommandContext: Gets the value of an argument.
getArgumentValue(CommandArgument<U>) - Method in class net.lucypoulton.squirtgun.command.context.StringContext
getAuthMode() - Method in interface net.lucypoulton.squirtgun.platform.Platform: Gets the server's authentication mode.
getAuthors() - Method in class net.lucypoulton.squirtgun.plugin.SquirtgunPlugin: Gets a list of the authors' names.
getCols() - Method in class net.lucypoulton.squirtgun.format.blocked.BlockedGradient
getCondition() - Method in class net.lucypoulton.squirtgun.command.node.AbstractNode
getCondition() - Method in interface net.lucypoulton.squirtgun.command.node.CommandNode: Gets the condition needed to execute this node or any children.
getCondition() - Method in class net.lucypoulton.squirtgun.command.node.HelpNode
getCondition() - Method in class net.lucypoulton.squirtgun.command.node.subcommand.SubcommandHelpNode
getConfigPath(SquirtgunPlugin<?>) - Method in interface net.lucypoulton.squirtgun.platform.Platform: Gets a path to a directory where config files specific to a plugin can be stored.
getConsole() - Method in interface net.lucypoulton.squirtgun.platform.Platform: Gets the console as a permissible audience.
getDelay() - Method in class net.lucypoulton.squirtgun.platform.scheduler.Task: How long to wait before executing this task.
getDescription() - Method in class net.lucypoulton.squirtgun.command.argument.AbstractArgument
getDescription() - Method in interface net.lucypoulton.squirtgun.command.argument.CommandArgument: Gets this argument's description for use in help commands.
getDescription() - Method in class net.lucypoulton.squirtgun.command.node.AbstractNode
getDescription() - Method in interface net.lucypoulton.squirtgun.command.node.CommandNode: Gets this node's description for use in help commands.
getDescription() - Method in class net.lucypoulton.squirtgun.command.node.HelpNode
getDescription() - Method in class net.lucypoulton.squirtgun.command.node.subcommand.SubcommandHelpNode
getError() - Method in class net.lucypoulton.squirtgun.command.condition.Condition.Result: Gets the error, if any, that this test encountered, When the test has passed, this may be null.
getEventManager() - Method in interface net.lucypoulton.squirtgun.platform.Platform: Gets the event manager which can be used to dispatch and listen for events.
getFallbackNode() - Method in class net.lucypoulton.squirtgun.command.node.subcommand.SubcommandNode: Gets the fallback node.
getFormat() - Method in interface net.lucypoulton.squirtgun.command.context.CommandContext: Gets the format provider to use in message decoration.
getFormat() - Method in class net.lucypoulton.squirtgun.command.context.StringContext
getGamemode() - Method in interface net.lucypoulton.squirtgun.platform.audience.SquirtgunPlayer
getId() - Method in class net.lucypoulton.squirtgun.platform.scheduler.Task: Get the numeric ID assigned to this task.
getInterval() - Method in class net.lucypoulton.squirtgun.platform.scheduler.Task: How many ticks to wait between executing repeatedly, or -1 if it should not repeat.
getLevel() - Method in enum class net.lucypoulton.squirtgun.platform.event.EventPriority
getListenerPermission() - Method in class net.lucypoulton.squirtgun.update.UpdateChecker
getLogger() - Method in interface net.lucypoulton.squirtgun.platform.Platform: Gets the plugin's logger for logging text to the console.
getName() - Method in class net.lucypoulton.squirtgun.command.argument.AbstractArgument
getName() - Method in interface net.lucypoulton.squirtgun.command.argument.CommandArgument: Gets this argument's name.
getName() - Method in class net.lucypoulton.squirtgun.command.node.AbstractNode
getName() - Method in interface net.lucypoulton.squirtgun.command.node.CommandNode: Gets this node's name, which will be used as a literal if needed.
getName() - Method in class net.lucypoulton.squirtgun.command.node.HelpNode
getName() - Method in class net.lucypoulton.squirtgun.command.node.subcommand.SubcommandHelpNode
getNames() - Method in class net.lucypoulton.squirtgun.format.blocked.BlockedGradient
getNodes() - Method in class net.lucypoulton.squirtgun.command.node.subcommand.SubcommandNode: Gets the child nodes that this node holds.
getOnlinePlayers() - Method in interface net.lucypoulton.squirtgun.platform.Platform: Gets a list of all online players.
getPlatform() - Method in class net.lucypoulton.squirtgun.plugin.SquirtgunPlugin: Gets the platform-specific object provided in the constructor.
getPlayer(String) - Method in interface net.lucypoulton.squirtgun.platform.Platform: Gets a player by cached name.
getPlayer(UUID) - Method in interface net.lucypoulton.squirtgun.platform.Platform: Gets a player by UUID.
getPlugin() - Method in class net.lucypoulton.squirtgun.update.UpdateChecker: Gets the plugin that this checker is associated with.
getPluginName() - Method in class net.lucypoulton.squirtgun.plugin.SquirtgunPlugin: Gets the plugin's name.
getPluginVersion() - Method in class net.lucypoulton.squirtgun.plugin.SquirtgunPlugin: Gets the plugin's version.
getPrefix() - Method in interface net.lucypoulton.squirtgun.format.FormatProvider: Get a prefix, which is put before most command messages.
getRaw() - Method in interface net.lucypoulton.squirtgun.command.context.CommandContext: Gets the raw input given to this context.
getRaw() - Method in class net.lucypoulton.squirtgun.command.context.StringContext
getResult() - Method in class net.lucypoulton.squirtgun.command.condition.Condition.Result: Gets the result of the test.
getTail() - Method in interface net.lucypoulton.squirtgun.command.context.CommandContext: Gets the last node in the chain that has been reached.
getTail() - Method in class net.lucypoulton.squirtgun.command.context.StringContext
getTarget() - Method in interface net.lucypoulton.squirtgun.command.context.CommandContext: Gets this command context's target.
getTarget() - Method in class net.lucypoulton.squirtgun.command.context.StringContext
getTaskScheduler() - Method in interface net.lucypoulton.squirtgun.platform.Platform: Gets the server's task scheduler.
getUpdateMessage() - Method in class net.lucypoulton.squirtgun.update.UpdateChecker
getUsername() - Method in interface net.lucypoulton.squirtgun.platform.audience.SquirtgunPlayer
getUuid() - Method in interface net.lucypoulton.squirtgun.platform.audience.SquirtgunPlayer
getValue(Queue<String>, CommandContext) - Method in interface net.lucypoulton.squirtgun.command.argument.CommandArgument: Reads from a queue to get the value for this argument.
getValue(Queue<String>, CommandContext) - Method in class net.lucypoulton.squirtgun.command.argument.GreedyStringArgument
getValue(Queue<String>, CommandContext) - Method in class net.lucypoulton.squirtgun.command.argument.ListArgument
getValue(Queue<String>, CommandContext) - Method in class net.lucypoulton.squirtgun.command.argument.OnlinePlayerArgument
getValue(Queue<String>, CommandContext) - Method in class net.lucypoulton.squirtgun.command.argument.SingleWordArgument
getValue(Queue<String>, CommandContext) - Method in class net.lucypoulton.squirtgun.command.node.subcommand.SubcommandNodeArgument
GreedyStringArgument - Class in net.lucypoulton.squirtgun.command.argument: An argument that consumes all the available arguments.
GreedyStringArgument(String, String, boolean) - Constructor for class net.lucypoulton.squirtgun.command.argument.GreedyStringArgument

H

handle(Consumer<T>) - Method in class net.lucypoulton.squirtgun.platform.event.EventHandler.Builder: This is a required parameter.
handlers() - Method in interface net.lucypoulton.squirtgun.platform.event.EventListener
hashCode() - Method in class net.lucypoulton.squirtgun.platform.scheduler.Task
hasPermission(String) - Static method in interface net.lucypoulton.squirtgun.command.condition.Condition: A condition that checks for a permission.
hasPermission(String) - Method in interface net.lucypoulton.squirtgun.platform.audience.PermissionHolder: Gets whether the target holds the provided permission.
hasPermission(String) - Method in interface net.lucypoulton.squirtgun.platform.audience.SquirtgunPlayer
HelpNode - Class in net.lucypoulton.squirtgun.command.node: A command node that shows a help screen for another node that shows its description, usage, and argument information.
HelpNode(CommandNode<?>) - Constructor for class net.lucypoulton.squirtgun.command.node.HelpNode
HexPattern - Class in net.lucypoulton.squirtgun.format.pattern: The hex pattern, in the format {#rrggbb}text.
HexPattern() - Constructor for class net.lucypoulton.squirtgun.format.pattern.HexPattern
HIGH - Enum constant in enum class net.lucypoulton.squirtgun.platform.event.EventPriority
HIGHEST - Enum constant in enum class net.lucypoulton.squirtgun.platform.event.EventPriority
HsvGradientPattern - Class in net.lucypoulton.squirtgun.format.pattern: The HSV gradient pattern, fading between two HSV hues with a consistent saturation and value in the format {hsv:hhssvv>}text{hh<}.
HsvGradientPattern() - Constructor for class net.lucypoulton.squirtgun.format.pattern.HsvGradientPattern

I

interval(int) - Method in class net.lucypoulton.squirtgun.platform.scheduler.Task.Builder
invert(Component) - Static method in class net.lucypoulton.squirtgun.format.TextFormatter: Inverts a component, flipping the extra components and adding the original component on the end.
isAsync() - Method in class net.lucypoulton.squirtgun.platform.scheduler.Task: Whether this task should be run asynchronously.
isCancelled() - Method in class net.lucypoulton.squirtgun.platform.event.cancellable.AbstractCancellableEvent
isCancelled() - Method in interface net.lucypoulton.squirtgun.platform.event.cancellable.CancellableEvent: Whether the event has been cancelled by a handler.
isConsole() - Static method in interface net.lucypoulton.squirtgun.command.condition.Condition: A condition ensuring the target is the console.
isFailure() - Method in class net.lucypoulton.squirtgun.command.condition.Condition.Result: Whether the test failed - inverse of Condition.Result.isSuccessful().
isOnline() - Method in interface net.lucypoulton.squirtgun.platform.audience.SquirtgunPlayer
isOptional() - Method in class net.lucypoulton.squirtgun.command.argument.AbstractArgument
isOptional() - Method in interface net.lucypoulton.squirtgun.command.argument.CommandArgument: Gets whether this argument is optional or not.
isOptional() - Method in class net.lucypoulton.squirtgun.command.node.subcommand.SubcommandNodeArgument
isPlayer() - Static method in interface net.lucypoulton.squirtgun.command.condition.Condition: A condition ensuring the target is a SquirtgunPlayer.
isPrerelease() - Method in class net.lucypoulton.squirtgun.util.SemanticVersion
isRepeating() - Method in class net.lucypoulton.squirtgun.platform.scheduler.Task: Whether this task is repeating.
isSuccessful() - Method in class net.lucypoulton.squirtgun.command.condition.Condition.Result: Whether the test passed.

K

key() - Method in class net.lucypoulton.squirtgun.util.Pair

L

LegacyAmpersandPattern - Class in net.lucypoulton.squirtgun.format.pattern: The legacy ampersand pattern.
LegacyAmpersandPattern() - Constructor for class net.lucypoulton.squirtgun.format.pattern.LegacyAmpersandPattern
ListArgument - Class in net.lucypoulton.squirtgun.command.argument: An argument that accepts a single string from a list.
ListArgument(String, String, boolean, List<String>) - Constructor for class net.lucypoulton.squirtgun.command.argument.ListArgument
log(String) - Method in class net.lucypoulton.squirtgun.plugin.SquirtgunPlugin: Logs a prefixed text message to the console.
log(Component) - Method in interface net.lucypoulton.squirtgun.platform.Platform: Logs a formatted component to the console.
LOW - Enum constant in enum class net.lucypoulton.squirtgun.platform.event.EventPriority
LOWEST - Enum constant in enum class net.lucypoulton.squirtgun.platform.event.EventPriority

M

major() - Method in class net.lucypoulton.squirtgun.util.SemanticVersion
minor() - Method in class net.lucypoulton.squirtgun.util.SemanticVersion

N

name() - Method in interface net.lucypoulton.squirtgun.platform.Platform: Gets this platform's user-friendly name.
name(String) - Method in class net.lucypoulton.squirtgun.command.node.NodeBuilder: Sets this node's name.
net.lucypoulton.squirtgun - package net.lucypoulton.squirtgun: Squirtgun is a general-purpose, cross-platform Minecraft Java edition library, designed to make plugin development a little easier.
net.lucypoulton.squirtgun.command.argument - package net.lucypoulton.squirtgun.command.argument
net.lucypoulton.squirtgun.command.condition - package net.lucypoulton.squirtgun.command.condition
net.lucypoulton.squirtgun.command.context - package net.lucypoulton.squirtgun.command.context
net.lucypoulton.squirtgun.command.node - package net.lucypoulton.squirtgun.command.node
net.lucypoulton.squirtgun.command.node.subcommand - package net.lucypoulton.squirtgun.command.node.subcommand
net.lucypoulton.squirtgun.format - package net.lucypoulton.squirtgun.format: Ripoff MiniMessage.
net.lucypoulton.squirtgun.format.blocked - package net.lucypoulton.squirtgun.format.blocked
net.lucypoulton.squirtgun.format.pattern - package net.lucypoulton.squirtgun.format.pattern
net.lucypoulton.squirtgun.platform - package net.lucypoulton.squirtgun.platform: Abstraction around server APIs to use one codebase for multiple platforms.
net.lucypoulton.squirtgun.platform.audience - package net.lucypoulton.squirtgun.platform.audience
net.lucypoulton.squirtgun.platform.event - package net.lucypoulton.squirtgun.platform.event
net.lucypoulton.squirtgun.platform.event.cancellable - package net.lucypoulton.squirtgun.platform.event.cancellable
net.lucypoulton.squirtgun.platform.event.player - package net.lucypoulton.squirtgun.platform.event.player
net.lucypoulton.squirtgun.platform.scheduler - package net.lucypoulton.squirtgun.platform.scheduler
net.lucypoulton.squirtgun.plugin - package net.lucypoulton.squirtgun.plugin
net.lucypoulton.squirtgun.update - package net.lucypoulton.squirtgun.update
net.lucypoulton.squirtgun.util - package net.lucypoulton.squirtgun.util
next(CommandNode<T>) - Method in class net.lucypoulton.squirtgun.command.node.NodeBuilder: Sets the next node in the chain.
next(CommandContext) - Method in interface net.lucypoulton.squirtgun.command.node.CommandNode: Returns the node following this node.
next(CommandContext) - Method in class net.lucypoulton.squirtgun.command.node.subcommand.SubcommandHelpNode
next(CommandContext) - Method in class net.lucypoulton.squirtgun.command.node.subcommand.SubcommandNode
NodeBuilder<T extends PermissionHolder> - Class in net.lucypoulton.squirtgun.command.node: A builder to build a node.
NodeBuilder() - Constructor for class net.lucypoulton.squirtgun.command.node.NodeBuilder
NORMAL - Enum constant in enum class net.lucypoulton.squirtgun.platform.event.EventPriority

O

ofCancellable(CancellableEvent) - Static method in interface net.lucypoulton.squirtgun.platform.event.Event.Result
OFFLINE - Enum constant in enum class net.lucypoulton.squirtgun.platform.AuthMode
onDisable() - Method in class net.lucypoulton.squirtgun.plugin.SquirtgunPlugin: Called when the plugin is disabled.
onEnable() - Method in class net.lucypoulton.squirtgun.plugin.SquirtgunPlugin: Called when the plugin is enabled.
ONLINE - Enum constant in enum class net.lucypoulton.squirtgun.platform.AuthMode
OnlinePlayerArgument - Class in net.lucypoulton.squirtgun.command.argument: An argument that gets a player.
OnlinePlayerArgument(String, String, boolean, Platform) - Constructor for class net.lucypoulton.squirtgun.command.argument.OnlinePlayerArgument
or(Condition<? super T, ? extends U>) - Method in interface net.lucypoulton.squirtgun.command.condition.Condition: Combines two conditions with the same output type and a contravariant input type in such a way that the test passes when either or both tests are successful.

P

Pair<K,V> - Class in net.lucypoulton.squirtgun.util: A utility class that contains a key-value pair.
Pair(K, V) - Constructor for class net.lucypoulton.squirtgun.util.Pair
parse(CharSequence) - Static method in class net.lucypoulton.squirtgun.util.SemanticVersion
patch() - Method in class net.lucypoulton.squirtgun.util.SemanticVersion
PermissionHolder - Interface in net.lucypoulton.squirtgun.platform.audience: An entity capable of holding permissions and executing commands.
Platform - Interface in net.lucypoulton.squirtgun.platform: A wrapper around a server platform's API, specific to a plugin.
player() - Method in class net.lucypoulton.squirtgun.platform.event.player.AbstractCancellablePlayerEvent
player() - Method in interface net.lucypoulton.squirtgun.platform.event.player.PlayerEvent
player() - Method in class net.lucypoulton.squirtgun.platform.event.player.PlayerLeaveEvent
PlayerEvent - Interface in net.lucypoulton.squirtgun.platform.event.player: An event with a player argument.
PlayerJoinEvent - Class in net.lucypoulton.squirtgun.platform.event.player: An event called when a player joins the server.
PlayerJoinEvent(SquirtgunPlayer) - Constructor for class net.lucypoulton.squirtgun.platform.event.player.PlayerJoinEvent
PlayerLeaveEvent - Class in net.lucypoulton.squirtgun.platform.event.player: An event called when a player leaves the server.
PlayerLeaveEvent(SquirtgunPlayer) - Constructor for class net.lucypoulton.squirtgun.platform.event.player.PlayerLeaveEvent
plugin() - Method in class net.lucypoulton.squirtgun.platform.event.PluginReloadEvent
PluginInfoNode - Class in net.lucypoulton.squirtgun.command.node
PluginInfoNode(String, SquirtgunPlugin<?>) - Constructor for class net.lucypoulton.squirtgun.command.node.PluginInfoNode
PluginReloadEvent - Class in net.lucypoulton.squirtgun.platform.event
PluginReloadEvent(SquirtgunPlugin<?>) - Constructor for class net.lucypoulton.squirtgun.platform.event.PluginReloadEvent
PolymartUpdateChecker - Class in net.lucypoulton.squirtgun.update: Update checking mechanism for plugins on Polymart.
PolymartUpdateChecker(SquirtgunPlugin<?>, int, Component, String) - Constructor for class net.lucypoulton.squirtgun.update.PolymartUpdateChecker: Creates a new update checker, and schedule update checking every 3 hours.
prerelease() - Method in class net.lucypoulton.squirtgun.util.SemanticVersion
priority() - Method in class net.lucypoulton.squirtgun.platform.event.EventHandler: This handler's priority.
priority(EventPriority) - Method in class net.lucypoulton.squirtgun.platform.event.EventHandler.Builder: Defaults to EventPriority.NORMAL.
process(String, String) - Method in interface net.lucypoulton.squirtgun.format.pattern.FormatPattern: Parses the given string to a component.
process(String, String) - Method in class net.lucypoulton.squirtgun.format.blocked.BlockedGradientPattern
process(String, String) - Method in class net.lucypoulton.squirtgun.format.pattern.HexPattern
process(String, String) - Method in class net.lucypoulton.squirtgun.format.pattern.HsvGradientPattern
process(String, String) - Method in class net.lucypoulton.squirtgun.format.pattern.LegacyAmpersandPattern
process(String, String) - Method in class net.lucypoulton.squirtgun.format.pattern.RgbGradientPattern

R

reason() - Method in interface net.lucypoulton.squirtgun.platform.event.Event.Result: The reason given for this result.
register(EventHandler<?>) - Method in class net.lucypoulton.squirtgun.platform.event.EventManager: Registers an event handler.
register(EventListener) - Method in class net.lucypoulton.squirtgun.platform.event.EventManager: Registers all of a listener's handlers.
registerCommand(CommandNode<?>, FormatProvider) - Method in interface net.lucypoulton.squirtgun.platform.Platform: Registers a command node with the server.
reload() - Method in class net.lucypoulton.squirtgun.plugin.SquirtgunPlugin: Dispatches a PluginReloadEvent.
repeat(String, int) - Static method in class net.lucypoulton.squirtgun.format.TextFormatter: Deprecated.
use String.repeat(int)
Result(boolean, U, String) - Constructor for class net.lucypoulton.squirtgun.command.condition.Condition.Result
RgbGradientPattern - Class in net.lucypoulton.squirtgun.format.pattern: The RGB gradient pattern, fading between two RGB codes in the format {#rrggbb>}text{#rrggbb<}.
RgbGradientPattern() - Constructor for class net.lucypoulton.squirtgun.format.pattern.RgbGradientPattern

S

SemanticVersion - Class in net.lucypoulton.squirtgun.util: A semantic version.
SemanticVersion(int, int, int, String, String...) - Constructor for class net.lucypoulton.squirtgun.util.SemanticVersion
SemanticVersion(int, int, int, String...) - Constructor for class net.lucypoulton.squirtgun.util.SemanticVersion
setGamemode(Gamemode) - Method in interface net.lucypoulton.squirtgun.platform.audience.SquirtgunPlayer
SingleWordArgument - Class in net.lucypoulton.squirtgun.command.argument: An argument that accepts a single word.
SingleWordArgument(String, String, boolean) - Constructor for class net.lucypoulton.squirtgun.command.argument.SingleWordArgument
SPECTATOR - Enum constant in enum class net.lucypoulton.squirtgun.platform.Gamemode
SpigotUpdateChecker - Class in net.lucypoulton.squirtgun.update: Update checking mechanism for Spigot plugins.
SpigotUpdateChecker(SquirtgunPlugin<?>, int, Component, String) - Constructor for class net.lucypoulton.squirtgun.update.SpigotUpdateChecker: Creates a new update checker, and schedule update checking every 3 hours.
Squirtgun - Class in net.lucypoulton.squirtgun: A simple class containing the framework's version.
Squirtgun() - Constructor for class net.lucypoulton.squirtgun.Squirtgun
SquirtgunPlayer - Interface in net.lucypoulton.squirtgun.platform.audience
SquirtgunPlugin<P extends Platform> - Class in net.lucypoulton.squirtgun.plugin: A plugin written using the Squirtgun API.
SquirtgunPlugin(P) - Constructor for class net.lucypoulton.squirtgun.plugin.SquirtgunPlugin
SquirtgunUser - Interface in net.lucypoulton.squirtgun.platform.audience: An empty interface extending PermissionHolder and Audience.
start(Task) - Method in interface net.lucypoulton.squirtgun.platform.scheduler.TaskScheduler: Schedules a task for execution.
StringContext - Class in net.lucypoulton.squirtgun.command.context: A command context that parses a raw string.
StringContext(FormatProvider, PermissionHolder, CommandNode<?>, String) - Constructor for class net.lucypoulton.squirtgun.command.context.StringContext
SubcommandHelpNode - Class in net.lucypoulton.squirtgun.command.node.subcommand: A help node for a subcommand.
SubcommandHelpNode(SubcommandNode) - Constructor for class net.lucypoulton.squirtgun.command.node.subcommand.SubcommandHelpNode
SubcommandNode - Class in net.lucypoulton.squirtgun.command.node.subcommand: A node that tab completes and acts as a "splitter" for other nodes.
SubcommandNode(String, String, Condition<PermissionHolder, ?>, CommandNode<?>...) - Constructor for class net.lucypoulton.squirtgun.command.node.subcommand.SubcommandNode
SubcommandNodeArgument - Class in net.lucypoulton.squirtgun.command.node.subcommand
SubcommandNodeArgument(SubcommandNode, String, String) - Constructor for class net.lucypoulton.squirtgun.command.node.subcommand.SubcommandNodeArgument
SUCCESS - Static variable in interface net.lucypoulton.squirtgun.platform.event.Event.Result
successful() - Method in interface net.lucypoulton.squirtgun.platform.event.Event.Result: Whether the handlers were successful.
SURVIVAL - Enum constant in enum class net.lucypoulton.squirtgun.platform.Gamemode

T

tabComplete() - Method in interface net.lucypoulton.squirtgun.command.context.CommandContext: Gets a list of entries for tab completion.
tabComplete() - Method in class net.lucypoulton.squirtgun.command.context.StringContext
tabComplete(Queue<String>, CommandContext) - Method in interface net.lucypoulton.squirtgun.command.argument.CommandArgument: Tab-completes this node.
tabComplete(Queue<String>, CommandContext) - Method in class net.lucypoulton.squirtgun.command.argument.GreedyStringArgument
tabComplete(Queue<String>, CommandContext) - Method in class net.lucypoulton.squirtgun.command.argument.ListArgument
tabComplete(Queue<String>, CommandContext) - Method in class net.lucypoulton.squirtgun.command.argument.OnlinePlayerArgument
tabComplete(Queue<String>, CommandContext) - Method in class net.lucypoulton.squirtgun.command.argument.SingleWordArgument
tabComplete(Queue<String>, CommandContext) - Method in class net.lucypoulton.squirtgun.command.node.subcommand.SubcommandNodeArgument
Task - Class in net.lucypoulton.squirtgun.platform.scheduler: A task that can be run.
Task.Builder - Class in net.lucypoulton.squirtgun.platform.scheduler: A builder for a task.
TaskScheduler - Interface in net.lucypoulton.squirtgun.platform.scheduler: Responsible for scheduling tasks to occur later.
test(T, CommandContext) - Method in interface net.lucypoulton.squirtgun.command.condition.Condition: Test the condition.
TextFormatter - Class in net.lucypoulton.squirtgun.format: Formats text, supporting gradients and hex codes.
TextFormatter() - Constructor for class net.lucypoulton.squirtgun.format.TextFormatter
TextWidthFinder - Class in net.lucypoulton.squirtgun.format: Calculates the pixel of a string when using the default font.
TextWidthFinder() - Constructor for class net.lucypoulton.squirtgun.format.TextWidthFinder
toString() - Method in class net.lucypoulton.squirtgun.command.argument.AbstractArgument
toString() - Method in enum class net.lucypoulton.squirtgun.platform.AuthMode
toString() - Method in class net.lucypoulton.squirtgun.platform.scheduler.Task
toString() - Method in class net.lucypoulton.squirtgun.util.SemanticVersion
toString(UUID) - Static method in class net.lucypoulton.squirtgun.util.UuidUtils: Converts a UUID to a string, removing hyphens.

U

unregister(EventHandler<?>) - Method in class net.lucypoulton.squirtgun.platform.event.EventManager: Unregisters an event handler.
UpdateChecker - Class in net.lucypoulton.squirtgun.update: Update checking mechanism base class.
UpdateChecker(SquirtgunPlugin<?>, String, Component, String) - Constructor for class net.lucypoulton.squirtgun.update.UpdateChecker: Creates a new update checker, and schedule update checking every 3 hours.
UuidUtils - Class in net.lucypoulton.squirtgun.util: Various utilities for formatting UUIDs.
UuidUtils() - Constructor for class net.lucypoulton.squirtgun.util.UuidUtils

V

value() - Method in class net.lucypoulton.squirtgun.util.Pair
valueOf(String) - Static method in enum class net.lucypoulton.squirtgun.platform.AuthMode: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class net.lucypoulton.squirtgun.platform.event.EventPriority: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class net.lucypoulton.squirtgun.platform.Gamemode: Returns the enum constant of this class with the specified name.
values() - Static method in enum class net.lucypoulton.squirtgun.platform.AuthMode: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class net.lucypoulton.squirtgun.platform.event.EventPriority: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class net.lucypoulton.squirtgun.platform.Gamemode: Returns an array containing the constants of this enum class, in the order they are declared.
VERSION - Static variable in class net.lucypoulton.squirtgun.Squirtgun: The framework's version.
VersionStringUpdateChecker - Class in net.lucypoulton.squirtgun.update: Update checking mechanism that compares a string fetched from a URL with the current version.
VersionStringUpdateChecker(SquirtgunPlugin<?>, String, Component, String) - Constructor for class net.lucypoulton.squirtgun.update.VersionStringUpdateChecker

W

willContinue() - Method in interface net.lucypoulton.squirtgun.platform.event.cancellable.CancellableEvent: Inverse of CancellableEvent.isCancelled()
withBasicHelp(String, String, Condition<PermissionHolder, ?>, CommandNode<?>...) - Static method in class net.lucypoulton.squirtgun.command.node.subcommand.SubcommandNode: Creates a node with a basic help node.
withExtraCondition(Condition<? super T, ? extends T>) - Method in interface net.lucypoulton.squirtgun.command.node.CommandNode
withFallback(String, String, Condition<PermissionHolder, ?>, CommandNode<?>, CommandNode<?>...) - Static method in class net.lucypoulton.squirtgun.command.node.subcommand.SubcommandNode: Creates a node with a custom default node.
withHelp(String, String, Condition<PermissionHolder, ?>, CommandNode<?>...) - Static method in class net.lucypoulton.squirtgun.command.node.subcommand.SubcommandNode: Creates a node with an advanced help node.
withReason(boolean, String) - Static method in interface net.lucypoulton.squirtgun.platform.event.Event.Result

A B C D E F G H I K L M N O P R S T U V W
All Classes|All Packages|Deprecated API