Customize GameModes! [Create a spectator mode]

Hello Bukkit,

I have been thinking of good ways to let players become spectators in my minigame without utilizing lists or tons of code just to do some simple functions like invisibility or fly. I came up with the idea of editing the ADVENTURE gamemode to better suit my needs, as it is easy to set, edit, and it is easy to check if a player is a "spectator".

I will be hooking into the PlayerGameModeChangeEvent for this tutorial, as it will let me intercept if a player is being changed to ADVENTURE mode.

First we start with the GameMode Change event. Make sure your onEnable is registering events or it won't work.

Code:java

@EventHandler
    public void onGameModeChange(PlayerGameModeChangeEvent e){     
    }

This will fire every time someone changes gamemodes. Let's add some functionality

Code:java

@EventHandler
    public void onGameModeChange(PlayerGameModeChangeEvent e){     
  if(e.getNewGameMode() == GameMode.ADVENTURE){
 
        } else {
}
}

This will make sure we are only doing this to the ADVENTURE gamemode. For my uses, I want players to teleport 5 blocks up when they are spectating, and I want them to be able to fly. I also want them to be invisible to all online players.

Code:java

@EventHandler
    public void gamemode(PlayerGameModeChangeEvent e){
        final Player p = e.getPlayer();
        if(e.getNewGameMode() == GameMode.ADVENTURE){
 
            final Plugin yourPlugin= Bukkit.getPluginManager().getPlugin(your plugin here!); //make sure to replace with YOUR plugin
              Bukkit.getServer().getScheduler().scheduleSyncDelayedTask(yourPlugin, new Runnable()//start a delay so flight will work
                {
                    public void run()
                    {
                        p.setAllowFlight(true); //lets players fly
                        p.setFlying(true);   //sets player to flying
                        p.teleport(p.getLocation().add(0,5,0)); //teleports player 5 blocks up
 
                    }
                }, 2L);
            for(Player pla: Bukkit.getOnlinePlayers()){
                pla.hidePlayer(e.getPlayer()); //hides players to all online players
            }
 
            e.getPlayer().sendMessage(ChatColor.RED + "You are now a spectator!"); //tells player he is a spectator
 
 
        } else {
        }
    }

The delay is crucial, as the player won't fly without it. This will also send a message to the player saying he is now a spectator. If you plan on restarting a game once it's done, you will want to reset the player back into survival mode. We need to set an else statement to remove fly and invisibility.

Code:java

@EventHandler
    public void gamemode(PlayerGameModeChangeEvent e){
        final Player p = e.getPlayer();
        if(e.getNewGameMode() == GameMode.ADVENTURE){
 
            final Plugin yourPlugin= Bukkit.getPluginManager().getPlugin(your plugin here!);
              Bukkit.getServer().getScheduler().scheduleSyncDelayedTask(yourPlugin, new Runnable()
                {
                    public void run()
                    {
                        p.setAllowFlight(true);
                        p.setFlying(true);     
                        p.teleport(p.getLocation().add(0,5,0));
 
                    }
                }, 2L);
            for(Player pla: Bukkit.getOnlinePlayers()){
                pla.hidePlayer(e.getPlayer());
            }
 
            e.getPlayer().sendMessage(ChatColor.RED + "You are now a spectator!");
 
 
        } else { //will fire when player is changed to SURVIVAL or CREATIVE gamemodes
          for(Player pla:Bukkit.getOnlinePlayers()){ //reshows a player to all online players
                pla.showPlayer(e.getPlayer());
 
            }
            e.getPlayer().setAllowFlight(false); //disallows flight
            e.getPlayer().setFlying(false); //makes them stop flying if they are in flight
            e.getPlayer().teleport(your location here); //teleport them to spawn if they are no longer spectator
        }
    }

You're done with that part! To make the player change to adventure mode, use

Code:java

e.getPlayer().setGameMode(GameMode.ADVENTURE);
 

and

Code:java

e.getPlayer().setGameMode(GameMode.SURVIVAL);
 

to reset them.

EXTRA:
To hook into events to check if a player is in this gamemode or not, you can use

Code:java

if(player.getGameMode() == GameMode.ADVENTURE){

For my needs, I want the player to teleport to another living player on interact event.

Code:java

@EventHandler
    public void teleport(PlayerInteractEvent e){
        if(e.getPlayer().getGameMode() == GameMode.ADVENTURE){
                int rand = new Random().nextInt(Bukkit.getOnlinePlayers().size()); //get a random player
       Player player = Bukkit.getOnlinePlayers()[rand]; //choose a player based on our random player
                if(player  == e.getPlayer()){
                    e.setCancelled(true);
                } else {
                    if(p.getGameMode() == GameMode.ADVENTURE){
                        e.setCancelled(true);
                    } else {
                    p.setPassenger(e.getPlayer()); //sets the player in ADVENTURE mode to ride the living player
                    }
                }
 
        }
    }

You can also edit the event to cancel chat or breaking blocks to suit your needs. I hope someone gets some use out of this method!

Cheers,
ccrama

 

ccrama Well but you're kind of limited with this, because you can only use the Adventure game mode. I you'd have more possibilities if you modify the game mode enum with Jogy34 's EnumModifier. However the "spectator" mode is going to implemented in 1.8 so you don't even have to create one then

 

Wow, I got really confused as to where I was tagged in this post at first.

Anyways, if you do want to do that you can find my post that has that stuff here under the modifiers section. Be careful with it though and let me know if how it turns out if you end up trying it.

 

DarkBladee12, Yeah, just learned about that... Apart from this, I think I'll check out Jogy34 's enum modifier, looks pretty cool

 

I looked into it a little bit. It doesn't seem like it would be as easy as just adding to the bukkit enum. You'll also have to mess with the NMS EnumGamemode.

 

I was about to say this as I was reading down the post.

 

Ultimate_n00b Yeah, wish I knew this. At least this will work to tide you over for a few more months (and possibly a few more after MC is released before Bukkit updates)!

 

I just coded it actually.

 

You need to make him invincible and invisible

 

HeavyMine13 He is invisible, and as I stated below it you can check if the user is in adventure mode, and cancel damage events