Index (Prodrivers Commons API 1.0 API)

A B C D E F G H I J L M N P R S U
All Classes and Interfaces|All Packages|Serialized Form

A

AbstractAttributeConfiguration - Class in fr.prodrivers.bukkit.commons.configuration: Field-based configuration framework for Prodrivers plugins.
AbstractAttributeConfiguration() - Constructor for class fr.prodrivers.bukkit.commons.configuration.AbstractAttributeConfiguration
AbstractFileAttributeConfiguration - Class in fr.prodrivers.bukkit.commons.configuration.file: Field-based, Bukkit's FileConfiguration backed configuration framework for Prodrivers plugins.
AbstractFileAttributeConfiguration() - Constructor for class fr.prodrivers.bukkit.commons.configuration.file.AbstractFileAttributeConfiguration
addPartyInvite(UUID, Party) - Static method in class fr.prodrivers.bukkit.commons.parties.PartyManager: Invites a player to a party
addPlayer(UUID) - Method in class fr.prodrivers.bukkit.commons.parties.Party: Adds a player.

B

broadcast(Chat, String) - Method in class fr.prodrivers.bukkit.commons.parties.Party: Send a message to all party players
broadcast(Chat, String, List<UUID>) - Method in class fr.prodrivers.bukkit.commons.parties.Party: Send a message to all party players, except some defined ones

C

Chat - Class in fr.prodrivers.bukkit.commons: Chat helper for Prodrivers plugins.
Chat(String) - Constructor for class fr.prodrivers.bukkit.commons.Chat: Constructor for the Chat helper for Prodrivers plugins
Configuration - Class in fr.prodrivers.bukkit.commons.configuration: Configuration helper for Prodrivers plugins.
Configuration(Plugin, Class<? extends Messages>, Chat) - Constructor for class fr.prodrivers.bukkit.commons.configuration.Configuration: Configuration helper constructor.
containsPlayer(UUID) - Method in class fr.prodrivers.bukkit.commons.parties.Party: Checks if a player is present in party list.
createParty(UUID) - Static method in class fr.prodrivers.bukkit.commons.parties.PartyManager: Creates a new party.
createPlayer(UUID) - Static method in class fr.prodrivers.bukkit.commons.storage.StorageProvider: Creates a document for a player in the database, and returns it.

D

disband() - Method in class fr.prodrivers.bukkit.commons.parties.Party: Disband/Delete the party.

E

electOwner(UUID) - Method in class fr.prodrivers.bukkit.commons.parties.Party: Set a player as the new party owner
enter(Player) - Static method in class fr.prodrivers.bukkit.commons.sections.SectionManager: Make a player enter his current section's preferred next section
enter(Player, String) - Static method in class fr.prodrivers.bukkit.commons.sections.SectionManager: Make a player enter a section by section name.
enter(Player, String, String) - Static method in class fr.prodrivers.bukkit.commons.sections.SectionManager: Make a player enter a section by section name.
enter(Player, String, String, boolean) - Static method in class fr.prodrivers.bukkit.commons.sections.SectionManager: Make a player enter a section by section name.
error(CommandSender, String) - Method in class fr.prodrivers.bukkit.commons.Chat: Error message receiver
ExcludedFromConfiguration - Annotation Type in fr.prodrivers.bukkit.commons.annotations: Exclude a field from field-based configurations

F

FileAttributeConfiguration - Class in fr.prodrivers.bukkit.commons.configuration.file: Fully managed, field-based, Bukkit's FileConfiguration backed configuration class for Prodrivers plugins.
FileAttributeConfiguration(File) - Constructor for class fr.prodrivers.bukkit.commons.configuration.file.FileAttributeConfiguration: Fully managed, field-based, Bukkit's FileConfiguration backed configuration class constructor.
filterFieldName(String) - Static method in class fr.prodrivers.bukkit.commons.configuration.file.AbstractFileAttributeConfiguration: Field name fitler.
forceNextSection() - Method in interface fr.prodrivers.bukkit.commons.sections.IProdriversSection: Get if we shall force the player to go to the preferred next section.
fr.prodrivers.bukkit.commons - package fr.prodrivers.bukkit.commons
fr.prodrivers.bukkit.commons.annotations - package fr.prodrivers.bukkit.commons.annotations
fr.prodrivers.bukkit.commons.configuration - package fr.prodrivers.bukkit.commons.configuration
fr.prodrivers.bukkit.commons.configuration.file - package fr.prodrivers.bukkit.commons.configuration.file
fr.prodrivers.bukkit.commons.events - package fr.prodrivers.bukkit.commons.events
fr.prodrivers.bukkit.commons.exceptions - package fr.prodrivers.bukkit.commons.exceptions
fr.prodrivers.bukkit.commons.parties - package fr.prodrivers.bukkit.commons.parties
fr.prodrivers.bukkit.commons.sections - package fr.prodrivers.bukkit.commons.sections
fr.prodrivers.bukkit.commons.storage - package fr.prodrivers.bukkit.commons.storage

G

get(Field) - Method in interface fr.prodrivers.bukkit.commons.configuration.IConfigurationAction: Returns, for a provided field, the value stored by the configuration action's storage mechanism.
getConfiguration() - Method in class fr.prodrivers.bukkit.commons.configuration.file.AbstractFileAttributeConfiguration: Get the underlying FileConfiguration instance.
getConnection() - Static method in class fr.prodrivers.bukkit.commons.storage.SQLProvider: Gets the database connection.
getCurrentSection(Player) - Static method in class fr.prodrivers.bukkit.commons.sections.SectionManager: Get a player's current section instance
getEbeanServer(List<Class<?>>) - Static method in class fr.prodrivers.bukkit.commons.storage.SQLProvider: Gets an Ebean ORM Server that uses the provided classes
getHandlerList() - Static method in class fr.prodrivers.bukkit.commons.events.PlayerOpenOwnInventoryEvent
getHandlers() - Method in class fr.prodrivers.bukkit.commons.events.PlayerOpenOwnInventoryEvent
getMessages() - Method in class fr.prodrivers.bukkit.commons.configuration.Configuration: Get the initialized Messages instance.
getName() - Method in interface fr.prodrivers.bukkit.commons.sections.IProdriversSection: Get the section's name, as used by players in commands
getOwnerUniqueId() - Method in class fr.prodrivers.bukkit.commons.parties.Party: Returns owner's unique id.
getParties() - Static method in class fr.prodrivers.bukkit.commons.parties.PartyManager: Returns all known parties.
getParty(UUID) - Static method in class fr.prodrivers.bukkit.commons.parties.PartyManager: Get player's party.
getPartyInvites(UUID) - Static method in class fr.prodrivers.bukkit.commons.parties.PartyManager: Get parties on which the player has pending party invitations.
getPlayer() - Method in class fr.prodrivers.bukkit.commons.events.PlayerOpenOwnInventoryEvent: Get the concerned player
getPlayer(UUID) - Static method in class fr.prodrivers.bukkit.commons.storage.StorageProvider: Get a player's document.
getPlayers() - Method in class fr.prodrivers.bukkit.commons.parties.Party: Returns party members.
getPlayersCollection() - Static method in class fr.prodrivers.bukkit.commons.storage.StorageProvider: Gets the players collection from database.
getPreferredNextSection() - Method in interface fr.prodrivers.bukkit.commons.sections.IProdriversSection: Get this section's preferred next section, ie. the section where the player should go by default when exiting this section
getStorage() - Static method in class fr.prodrivers.bukkit.commons.storage.StorageProvider: Gets the used MongoDatabase instance.
getTypes() - Method in interface fr.prodrivers.bukkit.commons.configuration.IConfigurationAction: Returns an array of classes (types) that this configuration action can handle.

H

hasPartyInvites(UUID) - Static method in class fr.prodrivers.bukkit.commons.parties.PartyManager: Checks if the player has pending party invitations.

I

IConfigurationAction - Interface in fr.prodrivers.bukkit.commons.configuration: Configuration Action interface.
IllegalSectionEnteringException - Exception in fr.prodrivers.bukkit.commons.exceptions
IllegalSectionEnteringException() - Constructor for exception fr.prodrivers.bukkit.commons.exceptions.IllegalSectionEnteringException
IllegalSectionEnteringException(String) - Constructor for exception fr.prodrivers.bukkit.commons.exceptions.IllegalSectionEnteringException
IllegalSectionEnteringException(String, Throwable) - Constructor for exception fr.prodrivers.bukkit.commons.exceptions.IllegalSectionEnteringException
IllegalSectionEnteringException(Throwable) - Constructor for exception fr.prodrivers.bukkit.commons.exceptions.IllegalSectionEnteringException
IllegalSectionLeavingException - Exception in fr.prodrivers.bukkit.commons.exceptions
IllegalSectionLeavingException() - Constructor for exception fr.prodrivers.bukkit.commons.exceptions.IllegalSectionLeavingException
IllegalSectionLeavingException(String) - Constructor for exception fr.prodrivers.bukkit.commons.exceptions.IllegalSectionLeavingException
IllegalSectionLeavingException(String, Throwable) - Constructor for exception fr.prodrivers.bukkit.commons.exceptions.IllegalSectionLeavingException
IllegalSectionLeavingException(Throwable) - Constructor for exception fr.prodrivers.bukkit.commons.exceptions.IllegalSectionLeavingException
init() - Method in class fr.prodrivers.bukkit.commons.configuration.AbstractAttributeConfiguration: Init a field-based configuration.
InvalidSectionException - Exception in fr.prodrivers.bukkit.commons.exceptions
InvalidSectionException() - Constructor for exception fr.prodrivers.bukkit.commons.exceptions.InvalidSectionException
InvalidSectionException(String) - Constructor for exception fr.prodrivers.bukkit.commons.exceptions.InvalidSectionException
InvalidSectionException(String, Throwable) - Constructor for exception fr.prodrivers.bukkit.commons.exceptions.InvalidSectionException
InvalidSectionException(Throwable) - Constructor for exception fr.prodrivers.bukkit.commons.exceptions.InvalidSectionException
IProdriversSection - Interface in fr.prodrivers.bukkit.commons.sections: Interface for all Prodrivers Commons-compatible Section implementations.
isCancelled() - Method in class fr.prodrivers.bukkit.commons.events.PlayerOpenOwnInventoryEvent: Get if the event is cancelled
isHub() - Method in interface fr.prodrivers.bukkit.commons.sections.IProdriversSection: Get if the section should be considered as a hub (player is not in a minigame)
isInParty(UUID) - Static method in class fr.prodrivers.bukkit.commons.parties.PartyManager: Checks if given player is in a party.
isPartyOwner(UUID) - Method in class fr.prodrivers.bukkit.commons.parties.Party: Checks if a player is the party owner

J

join(Player, String, String) - Method in interface fr.prodrivers.bukkit.commons.sections.IProdriversSection: Section join callback, called before teleporting the player to the section.

L

leave(Player, String) - Method in interface fr.prodrivers.bukkit.commons.sections.IProdriversSection: Section leave callback, called before teleporting the player to the section.

M

Messages - Class in fr.prodrivers.bukkit.commons.configuration: Messages helper for Prodrivers plugins.
Messages(Plugin) - Constructor for class fr.prodrivers.bukkit.commons.configuration.Messages: Messages helper constructor.

N

NoCurrentSectionException - Exception in fr.prodrivers.bukkit.commons.exceptions
NoCurrentSectionException() - Constructor for exception fr.prodrivers.bukkit.commons.exceptions.NoCurrentSectionException
NoCurrentSectionException(String) - Constructor for exception fr.prodrivers.bukkit.commons.exceptions.NoCurrentSectionException
NoCurrentSectionException(String, Throwable) - Constructor for exception fr.prodrivers.bukkit.commons.exceptions.NoCurrentSectionException
NoCurrentSectionException(Throwable) - Constructor for exception fr.prodrivers.bukkit.commons.exceptions.NoCurrentSectionException
NoNextSectionException - Exception in fr.prodrivers.bukkit.commons.exceptions
NoNextSectionException() - Constructor for exception fr.prodrivers.bukkit.commons.exceptions.NoNextSectionException
NoNextSectionException(String) - Constructor for exception fr.prodrivers.bukkit.commons.exceptions.NoNextSectionException
NoNextSectionException(String, Throwable) - Constructor for exception fr.prodrivers.bukkit.commons.exceptions.NoNextSectionException
NoNextSectionException(Throwable) - Constructor for exception fr.prodrivers.bukkit.commons.exceptions.NoNextSectionException
NotPartyOwnerException - Exception in fr.prodrivers.bukkit.commons.exceptions
NotPartyOwnerException() - Constructor for exception fr.prodrivers.bukkit.commons.exceptions.NotPartyOwnerException
NotPartyOwnerException(String) - Constructor for exception fr.prodrivers.bukkit.commons.exceptions.NotPartyOwnerException
NotPartyOwnerException(String, Throwable) - Constructor for exception fr.prodrivers.bukkit.commons.exceptions.NotPartyOwnerException
NotPartyOwnerException(Throwable) - Constructor for exception fr.prodrivers.bukkit.commons.exceptions.NotPartyOwnerException

P

Party - Class in fr.prodrivers.bukkit.commons.parties: Prodrivers Commons Party instance
PartyManager - Class in fr.prodrivers.bukkit.commons.parties: Prodrivers Commons Party Manager.
PartyManager() - Constructor for class fr.prodrivers.bukkit.commons.parties.PartyManager
PlayerOpenOwnInventoryEvent - Class in fr.prodrivers.bukkit.commons.events: Event fired when player open its own inventory.
PlayerOpenOwnInventoryEvent(Player) - Constructor for class fr.prodrivers.bukkit.commons.events.PlayerOpenOwnInventoryEvent
postJoin(Player, String, String) - Method in interface fr.prodrivers.bukkit.commons.sections.IProdriversSection: Section post-join callback, called after teleporting the player to the section.
postLeave(Player, String) - Method in interface fr.prodrivers.bukkit.commons.sections.IProdriversSection: Section post-leave callback, called after teleporting the player to the section.
prefix - Variable in class fr.prodrivers.bukkit.commons.configuration.Messages

R

register(IProdriversSection) - Static method in class fr.prodrivers.bukkit.commons.sections.SectionManager: Register a new section instance against the Prodrivers Commons infrastructure
reload() - Method in class fr.prodrivers.bukkit.commons.configuration.AbstractAttributeConfiguration: Reloads a field-based configuration using the IConfigurationAction reported values.
removePartyInvites(UUID) - Static method in class fr.prodrivers.bukkit.commons.parties.PartyManager: Removes all pending party invitations for a player.
removePlayer(UUID) - Method in class fr.prodrivers.bukkit.commons.parties.Party: Removes a player.
replacePlayer(UUID, Document) - Static method in class fr.prodrivers.bukkit.commons.storage.StorageProvider: Replaces a player's document with another

S

save() - Method in class fr.prodrivers.bukkit.commons.configuration.AbstractAttributeConfiguration: Saves a field-based configuration.
SectionManager - Class in fr.prodrivers.bukkit.commons.sections: Prodrivers Commons Section Manager
SectionManager() - Constructor for class fr.prodrivers.bukkit.commons.sections.SectionManager
send(CommandSender, String) - Method in class fr.prodrivers.bukkit.commons.Chat: Generic message receiver
set(Field, Object) - Method in interface fr.prodrivers.bukkit.commons.configuration.IConfigurationAction: Sets a provided field's value to the configuration action's storage mechanism.
setCancelled(boolean) - Method in class fr.prodrivers.bukkit.commons.events.PlayerOpenOwnInventoryEvent: Set that the event is cancelled
setDefault(Field, Object) - Method in interface fr.prodrivers.bukkit.commons.configuration.IConfigurationAction: Sets a provided field's default value to the configuration action's storage mechanism.
shouldMoveParty() - Method in interface fr.prodrivers.bukkit.commons.sections.IProdriversSection: Get if the whole party should enter the section
size() - Method in class fr.prodrivers.bukkit.commons.parties.Party: Returns the party's number of players.
SQLProvider - Class in fr.prodrivers.bukkit.commons.storage: SQL Database provider for Prodrivers plugins.
SQLProvider() - Constructor for class fr.prodrivers.bukkit.commons.storage.SQLProvider
StorageProvider - Class in fr.prodrivers.bukkit.commons.storage: Persistent storage provider for Prodrivers plugins.
StorageProvider() - Constructor for class fr.prodrivers.bukkit.commons.storage.StorageProvider
success(CommandSender, String) - Method in class fr.prodrivers.bukkit.commons.Chat: Success message receiver

U

updatePlayer(UUID, Bson) - Static method in class fr.prodrivers.bukkit.commons.storage.StorageProvider: Updates a player's document with provided BSON values.

A B C D E F G H I J L M N P R S U
All Classes and Interfaces|All Packages|Serialized Form