com.sk89q.worldguard.session

Class Session

java.lang.Object

com.sk89q.worldguard.session.Session

public class Session
extends Object

Keeps session information on a player.

Constructor Summary

Constructors

Constructor and Description
Session(SessionManager manager) Create a new session.

Method Summary

Modifier and Type	Method and Description
<T extends Handler> T	getHandler(Class<T> type) Get a handler by class, if has been registered.
SessionManager	getManager() Get the session manager.
WorldGuardPlugin	getPlugin() Get the plugin.
boolean	isInvincible(org.bukkit.entity.Player player) Test whether the session has invincibility enabled.
org.bukkit.Location	testMoveTo(org.bukkit.entity.Player player, org.bukkit.Location to, MoveType moveType) Test movement to the given location.
org.bukkit.Location	testMoveTo(org.bukkit.entity.Player player, org.bukkit.Location to, MoveType moveType, boolean forced) Test movement to the given location.

Methods inherited from class java.lang.Object

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

Constructor Detail

Session

public Session(SessionManager manager)

Create a new session.

Parameters:

manager - The session manager

Method Detail

getPlugin

public WorldGuardPlugin getPlugin()

Get the plugin.

Returns:

The plugin

getManager

public SessionManager getManager()

Get the session manager.

Returns:

The session manager

getHandler

@Nullable
public <T extends Handler> T getHandler(Class<T> type)

Get a handler by class, if has been registered.

Type Parameters:

T - The type of handler

Parameters:

type - The type of handler

Returns:

A handler instance, otherwise null

isInvincible

public boolean isInvincible(org.bukkit.entity.Player player)

Test whether the session has invincibility enabled.

Returns:

Whether invincibility is enabled

testMoveTo

@Nullable
public org.bukkit.Location testMoveTo(org.bukkit.entity.Player player,
                                                org.bukkit.Location to,
                                                MoveType moveType)

Test movement to the given location.

Parameters:

player - The player

to - The new location

moveType - The type of move

Returns:

The overridden location, if the location is being overridden

See Also:

For an explanation

testMoveTo

@Nullable
public org.bukkit.Location testMoveTo(org.bukkit.entity.Player player,
                                                org.bukkit.Location to,
                                                MoveType moveType,
                                                boolean forced)

Test movement to the given location.

If a non-null Location is returned, the player should be at that location instead of where the player has tried to move to.

If the moveType is cancellable (MoveType.isCancellable(), then the last valid location will be set to the given one.

Parameters:

player - The player

to - The new location

moveType - The type of move

forced - Whether to force a check

Returns:

The overridden location, if the location is being overridden