Added docs for methods in FactionLogic, AttackLogic and events. Added isOnline, getPower, getMaxPower methods to FactionPlayer interface.

Author: Aquerr

src/main/java/io/github/aquerr/eaglefactions/api/entities/Faction.java

@@ -1,10 +1,18 @@
 package io.github.aquerr.eaglefactions.api.entities;
 
+import io.github.aquerr.eaglefactions.api.logic.FactionLogic;
+import io.github.aquerr.eaglefactions.api.managers.PowerManager;
 import org.spongepowered.api.text.Text;
 
 import java.time.Instant;
 import java.util.*;
 
+/**
+ * Faction is an immutable object that stores all information (but power) needed for faction to work.
+ *
+ * To change faction data use {@link FactionLogic}
+ * To get faction power use {@link PowerManager}
+ */
 public interface Faction
 {
     /**
@@ -131,11 +139,6 @@ public interface Faction
      */
     Builder toBuilder();
 
-//    static Builder builder(final String name, final Text tag, final UUID leader)
-//    {
-//        return new Builder(name, tag, leader);
-//    }
-
     //Builder
     interface Builder
     {

src/main/java/io/github/aquerr/eaglefactions/api/entities/FactionPlayer.java

@@ -5,15 +5,56 @@
 import java.util.Optional;
 import java.util.UUID;
 
+/**
+ * Represents a faction player.
+ */
 public interface FactionPlayer
 {
+    /**
+     * Gets last known player's name.
+     * @return the name of the player as {@link String}
+     */
     String getName();
 
+    /**
+     * Gets player's unique id.
+     * @return the {@link UUID} of the player.
+     */
     UUID getUniqueId();
 
+    /**
+     * Gets player's faction name.
+     * @return the name of the faction as {@link Optional<String>} or {@link Optional#empty()} if player is not in a faction.
+     */
     Optional<String> getFactionName();
 
+    /**
+     * Gets player's faction member type (rank).
+     * @return the {@link FactionMemberType} of the player.
+     */
     Optional<FactionMemberType> getFactionRole();
 
+    /**
+     * Checks if the player is online.
+     * @return <tt>true</tt> if player is online or <tt>false</tt> if not.
+     */
+    boolean isOnline();
+
+    /**
+     * Gets player's power.
+     * @return player's power as floating number.
+     */
+    float getPower();
+
+    /**
+     * Gets player's maxpower.
+     * @return player's maxpower as floating number.
+     */
+    float getMaxPower();
+
+    /**
+     * Gets {@link User} instance from the current player.
+     * @return the {@link User} instance or {@link Optional#empty()} if instance could not be found.
+     */
     Optional<User> getUser();
 }

src/main/java/io/github/aquerr/eaglefactions/api/events/FactionAreaEnterEvent.java

@@ -9,6 +9,11 @@
 
 import java.util.Optional;
 
+/**
+ * Event that is fired when player enters or leave a claimed territory.
+ *
+ * This event is NOT fired if player moves between territories which belongs to the same faction.
+ */
 public interface FactionAreaEnterEvent extends Event, Cancellable
 {
 	/**

src/main/java/io/github/aquerr/eaglefactions/api/events/FactionChestEvent.java

@@ -1,6 +1,12 @@
 package io.github.aquerr.eaglefactions.api.events;
 
-interface FactionChestEvent extends FactionEvent
+import io.github.aquerr.eaglefactions.api.entities.FactionChest;
+import org.spongepowered.api.entity.living.player.Player;
+
+/**
+ * Fired when a {@link Player} accesses a {@link FactionChest}
+ */
+public interface FactionChestEvent extends FactionEvent
 {
 
 }

src/main/java/io/github/aquerr/eaglefactions/api/events/FactionClaimEvent.java

@@ -1,8 +1,12 @@
 package io.github.aquerr.eaglefactions.api.events;
 
 import com.flowpowered.math.vector.Vector3i;
+import org.spongepowered.api.entity.living.player.Player;
 import org.spongepowered.api.world.World;
 
+/**
+ * Fired when a {@link Player} claims a chunk at a given {@link Vector3i}.
+ */
 public interface FactionClaimEvent extends FactionEvent
 {
     /**

src/main/java/io/github/aquerr/eaglefactions/api/events/FactionCreateEvent.java

@@ -1,5 +1,11 @@
 package io.github.aquerr.eaglefactions.api.events;
 
+import io.github.aquerr.eaglefactions.api.entities.Faction;
+import org.spongepowered.api.entity.living.player.Player;
+
+/**
+ * Fired when a {@link Player} creates a {@link Faction}
+ */
 public interface FactionCreateEvent extends FactionEvent
 {
     /**

src/main/java/io/github/aquerr/eaglefactions/api/events/FactionDisbandEvent.java

@@ -1,5 +1,11 @@
 package io.github.aquerr.eaglefactions.api.events;
 
+import io.github.aquerr.eaglefactions.api.entities.Faction;
+import org.spongepowered.api.entity.living.player.Player;
+
+/**
+ * Fired when a {@link Player} disbands a {@link Faction}.
+ */
 public interface FactionDisbandEvent extends FactionEvent
 {
 

src/main/java/io/github/aquerr/eaglefactions/api/events/FactionEvent.java

@@ -5,6 +5,9 @@
 import org.spongepowered.api.event.Cancellable;
 import org.spongepowered.api.event.Event;
 
+/**
+ * Base event for all events related to {@link Faction}
+ */
 public interface FactionEvent extends Event, Cancellable
 {
     /**

src/main/java/io/github/aquerr/eaglefactions/api/events/FactionInviteEvent.java

@@ -1,7 +1,11 @@
 package io.github.aquerr.eaglefactions.api.events;
 
+import io.github.aquerr.eaglefactions.api.entities.Faction;
 import org.spongepowered.api.entity.living.player.Player;
 
+/**
+ * Fired when a {@link Player} is being invited to a {@link Faction}
+ */
 public interface FactionInviteEvent extends FactionEvent
 {
     /**

src/main/java/io/github/aquerr/eaglefactions/api/events/FactionJoinEvent.java

@@ -1,5 +1,11 @@
 package io.github.aquerr.eaglefactions.api.events;
 
+import io.github.aquerr.eaglefactions.api.entities.Faction;
+import org.spongepowered.api.entity.living.player.Player;
+
+/**
+ * Fired when a {@link Player} joins a {@link Faction}
+ */
 public interface FactionJoinEvent extends FactionEvent
 {