BattleBuilder (Pixelmon 1.16.5-9.1.7-pipe20926 API)

java.lang.Object
- com.pixelmonmod.pixelmon.battles.api.BattleBuilder

```
public class BattleBuilder
extends java.lang.Object
```
Used for creating battles with a bunch of different settings

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`allowSpectators`
`protected boolean`	`disableExp`
`protected java.util.Map<java.lang.Class<? extends BattleEvent>,java.util.function.BiConsumer<? extends BattleEvent,BattleController>>`	`eventHandlers`
`protected boolean`	`freezeBattle`
`protected boolean`	`removeFromTempParties`
`protected BattleRules`	`rules`
`protected TeamSelectionRegistry.Builder`	`selectionBuilder`
`protected long`	`startDelayMillis`
`protected boolean`	`startSync`
`protected BattleParticipant[]`	`teamOne`
`protected boolean`	`teamSelection`
`protected BattleParticipant[]`	`teamTwo`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected <A extends BattleEvent> void`	`addTask(BattleController controller, java.lang.Class<? extends BattleEvent> eventClass, java.util.function.BiConsumer<? extends BattleEvent,BattleController> task)`
`BattleBuilder`	`allowSpectators()` Allows spectators for the battle
`BattleBuilder`	`allowSpectators(boolean allowSpectators)` Sets if spectating the battle is allowed
`static BattleBuilder`	`builder()` Gets a new instance of the builder
`BattleBuilder`	`disableExp()` Disables exp gain during the battle
`BattleBuilder`	`disallowSpectators()` Prevents players from spectating the battle
`BattleBuilder`	`endHandler(java.util.function.BiConsumer<BattleEndEvent,BattleController> endConsumer)` Adds a consumer to run when the battle ends
`<E extends BattleEvent> BattleBuilder`	`eventHandler(java.lang.Class<E> eventClass, java.util.function.BiConsumer<E,BattleController> eventHandler)` Adds a consumer to run for any given battle event
`BattleBuilder`	`expEnabled()` Enables exp gain during the battle (defaults to true)
`BattleBuilder`	`frozen()` This sets the battle to be frozen when it is created meaning nothing will happen.
`protected void`	`handleClearingTemporaryMode(BattleEndEvent event, BattleController battleController)`
`BattleBuilder`	`ignoreTempParties()` The battle builder will not remove the player from temporary party mode if they are in it at the end of the battle
`BattleBuilder`	`noSelection()` Disables the team selection screen before the battle begins (default false)
`BattleBuilder`	`notFrozen()` This sets the battle to not be frozen when it is created (default)
`BattleBuilder`	`removeFromTempParty()` Sets the battle builder to remove the player from the temporary party mode if they are in it at the end of the battle
`BattleBuilder`	`rules(BattleRules rules)` Sets the battle rules
`protected void`	`setupController(BattleController controller)`
`java.util.concurrent.CompletableFuture<BattleController>`	`start()` Starts the battle
`BattleBuilder`	`startAsync()` Sets the start battle logic to run off the Minecraft server's main thread
`protected java.util.concurrent.CompletableFuture<BattleController>`	`startBattle()`
`BattleBuilder`	`startDelay(long startDelay, java.util.concurrent.TimeUnit timeUnit)` Adds a delay in the specified unit before the battle will begin
`BattleBuilder`	`startHandler(java.util.function.BiConsumer<BattleStartedEvent.Pre,BattleController> startConsumer)` Adds a consumer to run when the battle begins
`BattleBuilder`	`startSync()` Sets the start battle logic to run on the Minecraft server's main thread
`BattleBuilder`	`teamOne(BattleParticipant... teamOne)` Sets the first team
`BattleBuilder`	`teamSelection()` Enables the team selection screen before the battle begins
`BattleBuilder`	`teamSelection(boolean teamSelection)` Sets if the team selection screen will show before battle
`BattleBuilder`	`teamSelectionBuilder(TeamSelectionRegistry.Builder selectionBuilder)` Sets the builder, and settings, for the team selection screen
`BattleBuilder`	`teamTwo(BattleParticipant... teamTwo)` Sets the second team

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

- Field Detail
  - teamOne
```
protected BattleParticipant[] teamOne
```
  - teamTwo
```
protected BattleParticipant[] teamTwo
```
  - rules
```
protected BattleRules rules
```
  - eventHandlers
```
protected java.util.Map<java.lang.Class<? extends BattleEvent>,java.util.function.BiConsumer<? extends BattleEvent,BattleController>> eventHandlers
```
  - disableExp
```
protected boolean disableExp
```
  - allowSpectators
```
protected boolean allowSpectators
```
  - teamSelection
```
protected boolean teamSelection
```
  - selectionBuilder
```
protected TeamSelectionRegistry.Builder selectionBuilder
```
  - startDelayMillis
```
protected long startDelayMillis
```
  - startSync
```
protected boolean startSync
```
  - removeFromTempParties
```
protected boolean removeFromTempParties
```
  - freezeBattle
```
protected boolean freezeBattle
```
- Method Detail
  - teamOne
```
public BattleBuilder teamOne(BattleParticipant... teamOne)
```
    Sets the first team
    
    Parameters:
    
    teamOne - The first team
    
    Returns:
    
    The builder
  - teamTwo
```
public BattleBuilder teamTwo(BattleParticipant... teamTwo)
```
    Sets the second team
    
    Parameters:
    
    teamTwo - The second team
    
    Returns:
    
    The builder
  - rules
```
public BattleBuilder rules(BattleRules rules)
```
    Sets the battle rules
    
    Parameters:
    
    rules - The battle rules
    
    Returns:
    
    The builder
  - endHandler
```
public BattleBuilder endHandler(java.util.function.BiConsumer<BattleEndEvent,BattleController> endConsumer)
```
    Adds a consumer to run when the battle ends
    
    Parameters:
    
    endConsumer - The consumer to run
    
    Returns:
    
    The builder
  - startHandler
```
public BattleBuilder startHandler(java.util.function.BiConsumer<BattleStartedEvent.Pre,BattleController> startConsumer)
```
    Adds a consumer to run when the battle begins
    
    Parameters:
    
    startConsumer - The consumer to run
    
    Returns:
    
    The builder
  - eventHandler
```
public <E extends BattleEvent> BattleBuilder eventHandler(java.lang.Class<E> eventClass,
                                                          java.util.function.BiConsumer<E,BattleController> eventHandler)
```
    Adds a consumer to run for any given battle event
    
    Type Parameters:
    
    E - The event type
    
    Parameters:
    
    eventClass - The event class
    
    eventHandler - The handler to run for the given event
    
    Returns:
    
    The builder
  - disableExp
```
public BattleBuilder disableExp()
```
    Disables exp gain during the battle
    
    Returns:
    
    The builder
  - expEnabled
```
public BattleBuilder expEnabled()
```
    Enables exp gain during the battle (defaults to true)
    
    Returns:
    
    The builder
  - allowSpectators
```
public BattleBuilder allowSpectators()
```
    Allows spectators for the battle
    
    Returns:
    
    The builder
  - disallowSpectators
```
public BattleBuilder disallowSpectators()
```
    Prevents players from spectating the battle
    
    Returns:
    
    The builder
  - allowSpectators
```
public BattleBuilder allowSpectators(boolean allowSpectators)
```
    Sets if spectating the battle is allowed
    
    Parameters:
    
    allowSpectators - if spectating is allowed
    
    Returns:
    
    The builder
  - teamSelection
```
public BattleBuilder teamSelection()
```
    Enables the team selection screen before the battle begins
    
    Returns:
    
    The builder
  - noSelection
```
public BattleBuilder noSelection()
```
    Disables the team selection screen before the battle begins (default false)
    
    Returns:
    
    The builder
  - teamSelection
```
public BattleBuilder teamSelection(boolean teamSelection)
```
    Sets if the team selection screen will show before battle
    
    Parameters:
    
    teamSelection - If selection should occur
    
    Returns:
    
    The builder
  - teamSelectionBuilder
```
public BattleBuilder teamSelectionBuilder(TeamSelectionRegistry.Builder selectionBuilder)
```
    Sets the builder, and settings, for the team selection screen
    
    Parameters:
    
    selectionBuilder - The selection screen settings builder
    
    Returns:
    
    The builder
  - startDelay
```
public BattleBuilder startDelay(long startDelay,
                                java.util.concurrent.TimeUnit timeUnit)
```
    Adds a delay in the specified unit before the battle will begin
    
    Parameters:
    
    startDelay - The delay
    
    timeUnit - The unit for the delay
    
    Returns:
    
    The builder
  - startSync
```
public BattleBuilder startSync()
```
    Sets the start battle logic to run on the Minecraft server's main thread
    
    Returns:
    
    The builder
  - startAsync
```
public BattleBuilder startAsync()
```
    Sets the start battle logic to run off the Minecraft server's main thread
    
    Returns:
    
    The builder
  - removeFromTempParty
```
public BattleBuilder removeFromTempParty()
```
    Sets the battle builder to remove the player from the temporary party mode if they are in it at the end of the battle
    
    Returns:
    
    The builder
  - ignoreTempParties
```
public BattleBuilder ignoreTempParties()
```
    The battle builder will not remove the player from temporary party mode if they are in it at the end of the battle
    
    Returns:
    
    The builder
  - frozen
```
public BattleBuilder frozen()
```
    This sets the battle to be frozen when it is created meaning nothing will happen. This should ONLY really be used for testing as NOTHING will happen at all in the battle
    
    Returns:
    
    The builder
  - notFrozen
```
public BattleBuilder notFrozen()
```
    This sets the battle to not be frozen when it is created (default)
    
    Returns:
    
    The builder
  - start
```
public java.util.concurrent.CompletableFuture<BattleController> start()
```
    Starts the battle
    
    Returns:
    
    A completable future that will return the battle controller when the battle has begun
  - startBattle
```
protected java.util.concurrent.CompletableFuture<BattleController> startBattle()
```
  - setupController
```
protected void setupController(BattleController controller)
```
  - handleClearingTemporaryMode
```
protected void handleClearingTemporaryMode(BattleEndEvent event,
                                           BattleController battleController)
```
  - addTask
```
protected <A extends BattleEvent> void addTask(BattleController controller,
                                               java.lang.Class<? extends BattleEvent> eventClass,
                                               java.util.function.BiConsumer<? extends BattleEvent,BattleController> task)
```
  - builder
```
public static BattleBuilder builder()
```
    Gets a new instance of the builder
    
    Returns:
    
    A new instance of the battle builder

Class BattleBuilder

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

teamOne

teamTwo

rules

eventHandlers

disableExp

allowSpectators

teamSelection

selectionBuilder

startDelayMillis

startSync

removeFromTempParties

freezeBattle

Method Detail

teamOne

teamTwo

rules

endHandler

startHandler

eventHandler

disableExp

expEnabled

allowSpectators

disallowSpectators

allowSpectators

teamSelection

noSelection

teamSelection

teamSelectionBuilder

startDelay

startSync

startAsync

removeFromTempParty

ignoreTempParties

frozen

notFrozen

start

startBattle

setupController

handleClearingTemporaryMode

addTask

builder