Package de.marcely.bedwars.api.arena

Interface ArenaBuilder

public interface ArenaBuilder

Can be obtained with GameAPI.createArena()

Method Summary

Modifier and Type	Method	Description
ArenaBuilder	addAuthor(String author)	Can be used for: - RegenerationType.WORLD, - RegenerationType.REGION
Arena	finish()	Takes all given parameters and constructs the arena
ArenaBuilder	setLocation1(XYZ loc)	Can be used for: - RegenerationType.REGION
ArenaBuilder	setLocation2(XYZ loc)	Can be used for: - RegenerationType.REGION
ArenaBuilder	setName(String name)	Can be used for: - RegenerationType.WORLD, - RegenerationType.REGION, - RegenerationType.VOTING
ArenaBuilder	setRegenerationType(RegenerationType regenType)	The regeneration type of an arena represents its form or its general behavior
ArenaBuilder	setWorld(World world)	Can be used for: - RegenerationType.WORLD, - RegenerationType.REGION

Method Details

setRegenerationType

ArenaBuilder setRegenerationType(RegenerationType regenType)

The regeneration type of an arena represents its form or its general behavior

Parameters:

regenType - The regeneration type for the arena

Returns:

This ArenaBuilder instance

setName

ArenaBuilder setName(String name)

Can be used for:
- RegenerationType.WORLD,
- RegenerationType.REGION,
- RegenerationType.VOTING

Parameters:

name - The name for the new arena

Returns:

This ArenaBuilder instance

addAuthor

ArenaBuilder addAuthor(String author)

Can be used for:
- RegenerationType.WORLD,
- RegenerationType.REGION

Parameters:

author - An author of the arena

Returns:

This ArenaBuilder instance

setWorld

ArenaBuilder setWorld(World world)

Can be used for:
- RegenerationType.WORLD,
- RegenerationType.REGION

Parameters:

world - The world for the new arena

Returns:

This ArenaBuilder instance

setLocation1

ArenaBuilder setLocation1(XYZ loc)

Can be used for:
- RegenerationType.REGION

Parameters:

loc - The location of the first corner

Returns:

This ArenaBuilder instance

setLocation2

ArenaBuilder setLocation2(XYZ loc)

Can be used for:
- RegenerationType.REGION

Parameters:

loc - The location of the second corner

Returns:

This ArenaBuilder instance

finish

Arena finish()
      throws ArenaBuildException

Takes all given parameters and constructs the arena

Returns:

The built arena

Throws:

ArenaBuildException - Can occur when e.g. the name is already taken or some parameters aren't correct