FeudalAPICore

java.lang.Object
- us.forseth11.feudal.api.FeudalAPICore

All Implemented Interfaces:

FeudalAPI
```
public class FeudalAPICore
extends java.lang.Object
implements FeudalAPI
```
Access this class via: 'Feudal.getAPI()'

Author:

Michael Forseth

Constructor Summary

Constructors
Constructor and Description

FeudalAPICore()

Constructors
Constructor and Description
`FeudalAPICore()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addCommand(Command feudalCommand)` Add a Feudal sub-command by using the Feudal @Command If you want to change the location your command is displayed in '/f help', implement @CustomCommand, and return the position you want your command to show up atfor '/f help'.
`Challenge`	`getChallenge(Kingdom attacker, Kingdom defender)` Get a @Challenge from a @Kingdom attacker and defender.
`java.util.List<Challenge>`	`getChallenges()` This gets a list of all active Challenges.
`java.util.List<Challenge>`	`getChallenges(Kingdom kingdom)` Get all active challenges for a specific @Kingdom.
`java.util.List<Command>`	`getCommands()` Get a list of Feudal @Command which are being used.
`Feudal`	`getFeudal()` Get direct instance of the main @Feudal class which extends JavaPlugin.
`Kingdom`	`getKingdom(org.bukkit.Chunk chunk)` Get a Feudal @Kingdom from a Bukkit Chunk
`Kingdom`	`getKingdom(Land land)` Get a Feudal @Kingdom from Feudal @Land.
`Kingdom`	`getKingdom(org.bukkit.Location location)` Get a Feudal @Kingdom from a Bukkit Location
`Kingdom`	`getKingdom(org.bukkit.OfflinePlayer player)` Get a Feudal @Kingdom from a Bukkit OfflinePlayer.
`Kingdom`	`getKingdom(User user)` Get a Feudal @Kingdom from a Feudal User.
`Kingdom`	`getKingdomByName(java.lang.String kingdomName)` Deprecated.
`Kingdom`	`getKingdomByUUID(java.lang.String uuid)` Get a Feudal @Kingdom by a kingdom's uuid.
`Kingdom`	`getKingdomByUUID(java.util.UUID uuid)` Get a Feudal @Kingdom by a kingdom's uuid.
`java.lang.String`	`getMessage(java.lang.String languageField)` This will get a String from the Feudal language config file based on the path entered as languageField.
`java.lang.String`	`getMinecraftVersion()` Get the version of minecraft Feudal has loaded for.
`java.util.UUID`	`getOfflineUUID(java.lang.String playerName)` Gets a Feudal player's uuid from their name.
`User`	`getUser(java.lang.String playerName)` Get a Feudal @User from a player's in game name.
`User`	`getUser(java.util.UUID uuid)` Get a Feudal @User via a player's UUID.
`boolean`	`removeCommand(Command feudalCommand)` Remove a Feudal sub-command by using the instance of that Feudal @Command

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FeudalAPICore
```
public FeudalAPICore()
```
- Method Detail
  - getFeudal
```
public Feudal getFeudal()
```
    Description copied from interface: FeudalAPI
    
    Get direct instance of the main @Feudal class which extends JavaPlugin.
    
    Specified by:
    
    getFeudal in interface FeudalAPI
    
    Returns:
    
    main @Feudal instance
  - getUser
```
public User getUser(java.util.UUID uuid)
```
    Description copied from interface: FeudalAPI
    
    Get a Feudal @User via a player's UUID.
    
    Specified by:
    
    getUser in interface FeudalAPI
    
    Parameters:
    
    uuid - of minecraft Player
    
    Returns:
    
    @User May return null.
  - getUser
```
public User getUser(java.lang.String playerName)
```
    Description copied from interface: FeudalAPI
    
    Get a Feudal @User from a player's in game name.
    
    Specified by:
    
    getUser in interface FeudalAPI
    
    Returns:
    
    @User May return null.
  - getOfflineUUID
```
public java.util.UUID getOfflineUUID(java.lang.String playerName)
```
    Description copied from interface: FeudalAPI
    
    Gets a Feudal player's uuid from their name. This can be used to check if they have Feudal user data.
    
    Specified by:
    
    getOfflineUUID in interface FeudalAPI
    
    Returns:
    
    Bukkit Player UUID - May return null
  - getKingdomByName
```
@Deprecated
public Kingdom getKingdomByName(java.lang.String kingdomName)
```
    Deprecated.
    
    Description copied from interface: FeudalAPI
    
    Get a Feudal @Kingdom by name.
    
    Specified by:
    
    getKingdomByName in interface FeudalAPI
    
    Parameters:
    
    kingdomName - Feudal kingdom name
    
    Returns:
    
    @Kingdom May be null
  - getKingdomByUUID
```
public Kingdom getKingdomByUUID(java.lang.String uuid)
```
    Description copied from interface: FeudalAPI
    
    Get a Feudal @Kingdom by a kingdom's uuid.
    
    Specified by:
    
    getKingdomByUUID in interface FeudalAPI
    
    Parameters:
    
    uuid - Feudal Kingdom uuid as string
    
    Returns:
    
    @Kingdom May return null
  - getKingdomByUUID
```
public Kingdom getKingdomByUUID(java.util.UUID uuid)
```
    Description copied from interface: FeudalAPI
    
    Get a Feudal @Kingdom by a kingdom's uuid.
    
    Specified by:
    
    getKingdomByUUID in interface FeudalAPI
    
    Parameters:
    
    uuid - Feudal Kingdom uuid
    
    Returns:
    
    @Kingdom May return null
  - getKingdom
```
public Kingdom getKingdom(User user)
```
    Description copied from interface: FeudalAPI
    
    Get a Feudal @Kingdom from a Feudal User.
    
    Specified by:
    
    getKingdom in interface FeudalAPI
    
    Parameters:
    
    user - Feudal User
    
    Returns:
    
    @Kingdom May return null
  - getKingdom
```
public Kingdom getKingdom(org.bukkit.OfflinePlayer player)
```
    Description copied from interface: FeudalAPI
    
    Get a Feudal @Kingdom from a Bukkit OfflinePlayer.
    This can also be used with a Bukkit Player.
    
    Specified by:
    
    getKingdom in interface FeudalAPI
    
    Parameters:
    
    player - Bukkit OfflinePlayer
    
    Returns:
    
    @Kingdom May return null
  - getKingdom
```
public Kingdom getKingdom(Land land)
```
    Description copied from interface: FeudalAPI
    
    Get a Feudal @Kingdom from Feudal @Land.
    
    Specified by:
    
    getKingdom in interface FeudalAPI
    
    Parameters:
    
    land - Feudal @Land which is just a from of a Bukkit Chunk
    
    Returns:
    
    @Kingdom May return null
  - getKingdom
```
public Kingdom getKingdom(org.bukkit.Chunk chunk)
```
    Description copied from interface: FeudalAPI
    
    Get a Feudal @Kingdom from a Bukkit Chunk
    
    Specified by:
    
    getKingdom in interface FeudalAPI
    
    Parameters:
    
    chunk - Bukkit Chunk
    
    Returns:
    
    @Kingdom May return null
  - getKingdom
```
public Kingdom getKingdom(org.bukkit.Location location)
```
    Description copied from interface: FeudalAPI
    
    Get a Feudal @Kingdom from a Bukkit Location
    
    Specified by:
    
    getKingdom in interface FeudalAPI
    
    Parameters:
    
    location - Bukkit Location
    
    Returns:
    
    @Kingdom May return null
  - addCommand
```
public void addCommand(Command feudalCommand)
```
    Description copied from interface: FeudalAPI
    
    Add a Feudal sub-command by using the Feudal @Command
    If you want to change the location your command is displayed in '/f help', implement @CustomCommand, and return the position you want your command to show up atfor '/f help'.
    
    Specified by:
    
    addCommand in interface FeudalAPI
    
    Parameters:
    
    feudalCommand - Feudal @Command
  - removeCommand
```
public boolean removeCommand(Command feudalCommand)
```
    Description copied from interface: FeudalAPI
    
    Remove a Feudal sub-command by using the instance of that Feudal @Command
    
    Specified by:
    
    removeCommand in interface FeudalAPI
    
    Parameters:
    
    feudalCommand - Feudal @Command
    
    Returns:
    
    true if command was remove, false if not in the command list
  - getCommands
```
public java.util.List<Command> getCommands()
```
    Description copied from interface: FeudalAPI
    
    Get a list of Feudal @Command which are being used.
    
    Specified by:
    
    getCommands in interface FeudalAPI
    
    Returns:
    
    List of @Command
  - getMinecraftVersion
```
public java.lang.String getMinecraftVersion()
```
    Description copied from interface: FeudalAPI
    Get the version of minecraft Feudal has loaded for.
    
    The versions contain, but are not limited to:
    - 1.12
    - 1.11
    - 1.10
    - 1.9.4
    - 1.9
    - 1.8
    Specified by:
    
    getMinecraftVersion in interface FeudalAPI
    
    Returns:
    
    Minecraft version Feudal loaded for.
  - getMessage
```
public java.lang.String getMessage(java.lang.String languageField)
```
    Description copied from interface: FeudalAPI
    
    This will get a String from the Feudal language config file based on the path entered as languageField.
    
    Specified by:
    
    getMessage in interface FeudalAPI
    
    Parameters:
    
    languageField - YAML path in language.yml
    
    Returns:
    
    language message
  - getChallenges
```
public java.util.List<Challenge> getChallenges()
```
    Description copied from interface: FeudalAPI
    
    This gets a list of all active Challenges.
    
    Specified by:
    
    getChallenges in interface FeudalAPI
    
    Returns:
    
    List of @Challenge
    
    See Also:
    
    @Challenge
  - getChallenge
```
public Challenge getChallenge(Kingdom attacker,
                              Kingdom defender)
```
    Description copied from interface: FeudalAPI
    
    Get a @Challenge from a @Kingdom attacker and defender.
    
    Specified by:
    
    getChallenge in interface FeudalAPI
    
    Parameters:
    
    attacker - @Kingdom which is attacking in this challenge
    
    defender - @Kingdom which is defending in this challenge
    
    Returns:
    
    @Challenge May be null
  - getChallenges
```
public java.util.List<Challenge> getChallenges(Kingdom kingdom)
```
    Description copied from interface: FeudalAPI
    
    Get all active challenges for a specific @Kingdom.
    
    Specified by:
    
    getChallenges in interface FeudalAPI
    
    Parameters:
    
    kingdom - @Kingdom
    
    Returns:
    
    List of @Challenge

Class FeudalAPICore

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FeudalAPICore

Method Detail

getFeudal

getUser

getUser

getOfflineUUID

getKingdomByName

getKingdomByUUID

getKingdomByUUID

getKingdom

getKingdom

getKingdom

getKingdom

getKingdom

addCommand

removeCommand

getCommands

getMinecraftVersion

getMessage

getChallenges

getChallenge

getChallenges