me.realized.duels.api.kit

Interface KitManager

public interface KitManager

Represents the KitManager singleton used by Duels.

Method Summary

Modifier and Type	Method and Description
Kit	create(org.bukkit.entity.Player creator, java.lang.String name) Creates a kit with given name and Player's inventory contents.
Kit	get(java.lang.String name) Attempts to find an Kit instance associated with the given name.
java.util.List<Kit>	getKits() An UnmodifiableList of Kits that are currently loaded.
Kit	remove(org.bukkit.command.CommandSender source, java.lang.String name) Removes a kit with given name.
Kit	remove(java.lang.String name) Calls remove(CommandSender, String) with source being null.

Method Detail

get

@Nullable
Kit get(@NotNull
                  java.lang.String name)

Attempts to find an Kit instance associated with the given name.

Parameters:

name - Name to search through the loaded kits. Should not be null!

Returns:

Kit instance that has a name matching with the given name or null if not exists.

create

@Nullable
Kit create(@NotNull
                     org.bukkit.entity.Player creator,
                     @NotNull
                     java.lang.String name)

Creates a kit with given name and Player's inventory contents. Note: Calls KitCreateEvent on successful creation.

Parameters:

creator - Player who is the creator of this kit.

name - Name of the newly created Kit. Requires to be alphanumeric (underscore is allowed).

Returns:

The newly created Kit or null if a kit with given name already exists.

remove

@Nullable
Kit remove(@Nullable
                     org.bukkit.command.CommandSender source,
                     @NotNull
                     java.lang.String name)

Removes a kit with given name. Note: Calls KitRemoveEvent on successful removal.

Parameters:

source - CommandSender who is the source of this call.

name - Name of the kit to remove.

Returns:

The removed Kit or null if no Kit was found with the given name.

remove

@Nullable
Kit remove(@NotNull
                     java.lang.String name)

Calls remove(CommandSender, String) with source being null.

See Also:

remove(CommandSender, String)

getKits

@NotNull
java.util.List<Kit> getKits()

An UnmodifiableList of Kits that are currently loaded.

Returns:

Never-null UnmodifiableList of Kits that are currently loaded.

Since:

3.1.0