net.risingworld.api.events.player

Class PlayerChangeGamemodeEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.player.PlayerEvent

net.risingworld.api.events.player.PlayerChangeGamemodeEvent

All Implemented Interfaces:

Cancellable

public class PlayerChangeGamemodeEvent
extends PlayerEvent
implements Cancellable

Called when a player changes his local game mode (i.e. by using the command "setgamemode" or "gm"). Note that certain game modes are not supported yet.

Constructor Summary

Constructors

Constructor and Description
PlayerChangeGamemodeEvent(Player player, Gamemode gamemode)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCancelReason() If the event was cancelled, this function returns the (optional) reason.
Gamemode	getNewGamemode() Gets the new game mode.
boolean	isCancelled() Determines if the event is cancelled.
void	setCancelled(boolean cancel) Cancels this event.
void	setCancelled(boolean cancel, java.lang.String reason) Cancels this event and provides a reason (which will be displayed for the player) why the event was cancelled (or more precisely, why he is not allowed to change the game mode).
void	setNewGamemode(Gamemode mode) Changes the new game mode for the player.

Methods inherited from class net.risingworld.api.events.player.PlayerEvent

getPlayer

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PlayerChangeGamemodeEvent

public PlayerChangeGamemodeEvent(Player player,
                                 Gamemode gamemode)

Method Detail

getNewGamemode

public Gamemode getNewGamemode()

Gets the new game mode.

Returns:

the new game mode.

setNewGamemode

public void setNewGamemode(Gamemode mode)

Changes the new game mode for the player.

Parameters:

mode - the new game mode.

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.

Please note: If the event is threaded, cancellation has no effect, i.e. the event will still be executed.

Specified by:

setCancelled in interface Cancellable

Parameters:

cancel - set to true if you want to cancel this event.

setCancelled

public void setCancelled(boolean cancel,
                         java.lang.String reason)

Cancels this event and provides a reason (which will be displayed for the player) why the event was cancelled (or more precisely, why he is not allowed to change the game mode).

Please note: If the event is threaded, cancellation has no effect, i.e. the event will still be executed.

Parameters:

cancel - set to true if you want to cancel this event.

reason - a reason why the event was cancelled. The player can see this reason in his console. Provide null if you don't want to show a reason. Has no effect if this event will not be cancelled, or if it is threaded.

See Also:

setCancelled(boolean)

Example: Only allow the player to change the game mode if he has played for at least 1 hour on this server

1	//Listener class
2	public class PlayerListener implements Listener{
3	@EventMethod
4	public void onGamemodeChange(PlayerChangeGamemodeEvent evt){
5
6	//Get the total play time on this server (seconds)
7	int playTime = evt.getPlayer().getTotalPlayTime();
8
9	//If playTime is less than 1 hour (3600 seconds), player is not
10	//allowed to change the game mode
11	if(playTime < 3600){
12	evt.setCancelled(true, "You haven't played on this server for long enough!");
13	}
14	}
15	}

getCancelReason

public java.lang.String getCancelReason()

If the event was cancelled, this function returns the (optional) reason.

Returns:

the reason why the event was cancelled, or null if no reason was set.