diff --git a/src/main/java/uulm/teamname/marvelous/gamelibrary/events/EventBuilder.java b/src/main/java/uulm/teamname/marvelous/gamelibrary/events/EventBuilder.java index 9212081..fff5c60 100644 --- a/src/main/java/uulm/teamname/marvelous/gamelibrary/events/EventBuilder.java +++ b/src/main/java/uulm/teamname/marvelous/gamelibrary/events/EventBuilder.java @@ -160,14 +160,16 @@ public class EventBuilder { /** * Builds a {@link GameEvent} from the values given to the builder - * type is the {@link EventType} of the {@link GameEvent}. - * roundCount describes the count of rounds in the RoundSetupEvent - * turnCount describes the amount of turns taken in Events - * characterOrder describes the order in which characters have their turn - * nextCharacter describes the next character in the turn order in the TurnEvent - * playerWon describes the player that has won the game in the WinEvent - * message describes a generic message delivered as a String in several GameEvents. It is optional. - * timeLeft describes the time left for a client to act before getting kicked in the TimeoutWarning event + * * @return a {@link GameEvent} based on the builder. Caution: non-given fields are null! */ public GameEvent buildGameEvent() { @@ -187,10 +189,12 @@ public class EventBuilder { /** * Builds an {@link EntityEvent} from the values given to the builder. - * type is the {@link EventType} of the EntityEvent - * targetEntity is the target {@link Entity} - * targetField is the target field in the form of an {@link IntVector2} - * amount is the amount of something, like damage. It's an int. + * * @return a {@link EntityEvent} based on the builder. Caution: non-given fields are null! */ public EntityEvent buildEntityEvent() { @@ -204,11 +208,13 @@ public class EventBuilder { /** * Builds a {@link CharacterEvent} from the values given to the builder. - * type is the {@link EventType} of the EntityEvent - * originEntity is the origin {@link Entity} - * targetEntity is the target {@link Entity} - * originField is the field that an action originates in, delivered as an {@link IntVector2} - * targetField is the target field in the form of an {@link IntVector2} + * * @return a {@link CharacterEvent} based on the builder. Caution: non-given fields are null! */ public CharacterEvent buildCharacterEvent() { @@ -225,11 +231,13 @@ public class EventBuilder { /** * Builds a {@link GameStateEvent} from the values given to the builder. - * type is the {@link EventType} of the {@link GameStateEvent} - * entities is an array of {@link Entity Entities} - * turnOrder describes the order in which characters take turns - * activeCharacter describes the currently active character - * describes whether the win condition is in effect + * * @return a {@link GameStateEvent} based on the builder. Caution: non-given fields are null! */ public GameStateEvent buildGamestateEvent() { @@ -244,8 +252,10 @@ public class EventBuilder { /** * Builds a {@link CustomEvent} from the values given to the builder - * teamIdentifier is a String for identifying a specific custom content - * customContent is a {@link HashMap}<{@link String}, {@link Object}> resembling the JSON keys in the event + * * @return a {@link CustomEvent} based on the builder. Caution: non-given fields are null! */ public CustomEvent buildCustomEvent() {