Package net.risingworld.api.events.player

Class PlayGameMusicEvent

java.lang.Object
net.risingworld.api.events.Event
net.risingworld.api.events.player.PlayerEvent
net.risingworld.api.events.player.PlayGameMusicEvent
All Implemented Interfaces:
Cancellable
public final class PlayGameMusicEvent extends PlayerEvent implements Cancellable
Called when a new music track starts playing for a player. Not to be confused with music played by world objects (like the gramophone)! This only covers built-in, background music.

  • Method Details

    • getTrackName

      public String getTrackName()
      Gets the name of the music track.
      Returns:
      the name of the music track that's about to be played.

    • setTrackName

      public void setTrackName(String name)
      Sets another track that should be played instead.
      Parameters:
      name - the name of the new music track to be played.

    • getTrackDuration

      public int getTrackDuration()
      Gets the duration of the music track, in milliseconds
      Returns:
      the music track duration.

    • isCancelled

      public boolean isCancelled()
      Description copied from interface: Cancellable
      Determines if the event is cancelled. If an event is cancelled, it will no longer be executed, but other plugins will still receive the event.

      Please note: If the event is threaded, cancellation has no effect, i.e the event will still be executed.
      Specified by:
      isCancelled in interface Cancellable
      Returns:
      true if the event is cancelled, or false if not.

    • setCancelled

      public void setCancelled(boolean cancel)
      Description copied from interface: Cancellable
      Cancels this event. This means it will no longer be executed, but other plugins will still receive the event.

      Specified by:
      setCancelled in interface Cancellable
      Parameters:
      cancel - set to true if you want to cancel this event.
      Example: Cancel "PlayerEnterAreaEvent", i.e prevent player from entering an area
      1//Listener class
      2public class PlayerListener implements Listener{
      3 @EventMethod
      4 public void onEnterArea(PlayerEnterAreaEvent evt){
      5 //Now the player will not be able to enter the area, i.e.
      6 //he will be teleported back to his old position (outside the area)
      7 evt.setCancelled(true);
      8 }
      9}