[Tutorial] Creating a Lobby for your plugin

Alright, this is my first tutorial, so please try to ignore any mistakes I make, or anything like that. Also at this time, I am still writing this, and adding to it, because I decided to write this with 14 minutes before I had to leave (I'm at class).


Okay, so first thing we want to do, is create a class called Lobby.

Code:java

public class Lobby{
 
}

Good, now the next thing we want to do, is allow our Lobby class to hold our world, so add add this next line. We want it to be private and non static, so we can make an instance of it an object or something (I suck at terminology)

Code:java

private World lobby = null;

After that, we want to create a loadLobby method that loads our world.
Make it public, so it can be accessed later, and make it take in a string for the world name. This code tells bukkit to create a new world (yes I said create a new world). Why is this our loading class you ask? Its because if the world already exist, the WorldCreator wont create a new world. This is also an easy way to load the world, because doing Bukkit.getWorld(<String>) wont work if the world isn't loaded.

Code:java

public void loadLobby(String name){
try{
Bukkit.createWorld(new WorldCreator(name).environment(World.Environment.NORMAL));
lobby = Bukkit.getWorld(name);
}catch(Exception e){}
}
 

This line here is so you can call the world when ever you want, instead of having to create a World object when you want to use the world.

Code:java

public World getLobby(){
return lobby;
}

Next lets make it simple to move players to our lobby. Again, make sure that they are public. Now as you can see, both methods are named sendtoLobby. One of the methods takes in the prams Player[], which is an arraylist of players incase you want to move a bunch of players, and the other just takes in Player, which is a single player. You can use other things to send the player to the lobby, its just that this is something simple that you can use.

Code:java

public void sendToLobby(Player[] players){
for(Player player: players){
sendToLobby(player);
}
}
 
public void sendToLobby(Player p){
try{
if(p != null && lobby != null){
try{
p.teleport(lobby.getSpawnLocation());
}catch(Exception e){
try{
p.sendMessage(ChatColor.RED+"Failed to send you to the lobby!");
}catch(Exception e1){}
}
}
}catch(Exception e){}
}

Finally we arrive at the way to set Lobby, when you create a new instance of it. All we have to do, is take in the prams as a String, and call our loadLobby() method. Once we do this, we can call the world anytime we want, and are not limited to our Object (we can do Bukkit.getWorld(<String>)). Btw, note here, that you can have multiple lobbies, as long as they have different names.

Code:java

public Lobby(String name){
loadLobby(name);
}

If you are asking how you use this newly created class, it should be pretty simple. You simple create a new Object, and yeah. Btw note that you can use this object to get the world anytime you want, as long as you have it available for other classes.

Code:java

Lobby lobby = new Lobby("Lobby");

The final thing should look something like this:

Code:java

public class Lobby {
private World lobby;
 
public Lobby(String name){
loadLobby(name);
}
public World getWorld(){
return lobby;
}
public void loadLobby(String name){
try{
Bukkit.createWorld(new WorldCreator(name).environment(World.Environment.NORMAL));
lobby = Bukkit.getWorld(name);
}catch(Exception e){}
}
 
public void sendToLobby(Player[] players){
for(Player player: players){
sendToLobby(player);
}
}
public void sendToLobby(Player p){
try{
if(p != null && lobby != null){
try{
p.teleport(lobby.getSpawnLocation());
}catch(Exception e){
try{
p.sendMessage(ChatColor.RED+"Failed to send you to the lobby!");
}catch(Exception e1){}
}
}
}catch(Exception e){}
}
}

Any questions or comments? Feel free to post below

 

MrAwellstein
Not sure if on purpose, but like 22 and line 17, shouldn't it be Lobby? not Loby. Also, does this create a new world for the lobby

 

Yes it does, I forgot to mention that, also ignore my spelling, I'm pretty bad at English haha....
What happened was I directly copy n' pasted the final example from my IDE and the spelling errors where there.

 

MrAwellstein
No Problem, was just curious!

 

Thanks for the catch in the code btw. I would have never noticed it >.<