Yandrik/Gamelib
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

fix: fixed comments to properly display as a list

Browse Source
This commit is contained in:
Yannik Bretschneider 2021-05-01 23:54:25 +02:00
parent 1cb86f6be8
commit 1a33a8cb7e
1 changed files with 34 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
src/main/java/uulm/teamname/marvelous/gamelibrary/events/EventBuilder.java
View File

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