com.sk89q.worldguard.session.handler

Class FarewellFlag

java.lang.Object

com.sk89q.worldguard.session.handler.Handler

com.sk89q.worldguard.session.handler.FarewellFlag

public class FarewellFlag
extends Handler

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FarewellFlag.Factory

Field Summary

Fields

Modifier and Type	Field and Description
static FarewellFlag.Factory	FACTORY

Constructor Summary

Constructors

Constructor and Description
FarewellFlag(Session session)

Method Summary

Modifier and Type	Method and Description
void	initialize(LocalPlayer player, com.sk89q.worldedit.util.Location current, ApplicableRegionSet set) Called when the session is first being created or /wg flushstates is used.
boolean	onCrossBoundary(LocalPlayer player, com.sk89q.worldedit.util.Location from, com.sk89q.worldedit.util.Location to, ApplicableRegionSet toSet, java.util.Set<ProtectedRegion> entered, java.util.Set<ProtectedRegion> exited, MoveType moveType) Called when a player has moved into a new location.

Methods inherited from class com.sk89q.worldguard.session.handler.Handler

getInvincibility, getSession, testMoveTo, tick

Methods inherited from class java.lang.Object

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

Field Detail

FACTORY

public static final FarewellFlag.Factory FACTORY

Constructor Detail

FarewellFlag

public FarewellFlag(Session session)

Method Detail

initialize

public void initialize(LocalPlayer player,
                       com.sk89q.worldedit.util.Location current,
                       ApplicableRegionSet set)

Description copied from class: Handler

Called when the session is first being created or /wg flushstates is used.

Overrides:

initialize in class Handler

Parameters:

player - The player

current - The player's current location

set - The regions for the current location

onCrossBoundary

public boolean onCrossBoundary(LocalPlayer player,
                               com.sk89q.worldedit.util.Location from,
                               com.sk89q.worldedit.util.Location to,
                               ApplicableRegionSet toSet,
                               java.util.Set<ProtectedRegion> entered,
                               java.util.Set<ProtectedRegion> exited,
                               MoveType moveType)

Description copied from class: Handler

Called when a player has moved into a new location.

This is called only if the move test (Session.testMoveTo(LocalPlayer, Location, MoveType)) was successful.

If this method returns false, then no other handlers will be run (for this move attempt).

Overrides:

onCrossBoundary in class Handler

Parameters:

player - The player

from - The previous, valid, location

to - The new location to test

toSet - The regions for the new location

entered - The list of regions that have been entered

exited - The list of regions that have been left

moveType - The type of move

Returns:

Whether the movement should be allowed