com.sk89q.worldedit.cui

Interface CUIRegion

All Known Implementing Classes:

ConvexPolyhedralRegionSelector, CuboidRegionSelector, CylinderRegionSelector, EllipsoidRegionSelector, ExtendingCuboidRegionSelector, Polygonal2DRegionSelector, SphereRegionSelector

public interface CUIRegion

Method Summary

Methods

Modifier and Type	Method and Description
void	describeCUI(LocalSession session, LocalPlayer player) Sends CUI events describing the region for versions of CUI equal to or greater than the value supplied by getProtocolVersion().
void	describeLegacyCUI(LocalSession session, LocalPlayer player) Sends CUI events describing the region for versions of CUI smaller than the value supplied by getProtocolVersion().
String	getLegacyTypeID() Returns the type ID to send to CUI in the selection event if the CUI is in legacy mode.
int	getProtocolVersion() Returns the CUI version that is required to send up-to-date data.
String	getTypeID() Returns the type ID to send to CUI in the selection event.

Method Detail

describeCUI

void describeCUI(LocalSession session,
               LocalPlayer player)

Sends CUI events describing the region for versions of CUI equal to or greater than the value supplied by getProtocolVersion().

describeLegacyCUI

void describeLegacyCUI(LocalSession session,
                     LocalPlayer player)

Sends CUI events describing the region for versions of CUI smaller than the value supplied by getProtocolVersion().

getProtocolVersion

int getProtocolVersion()

Returns the CUI version that is required to send up-to-date data. If the CUI version is smaller than this value, the legacy methods will be called.

Returns:

getTypeID

String getTypeID()

Returns the type ID to send to CUI in the selection event.

Returns:

getLegacyTypeID

String getLegacyTypeID()

Returns the type ID to send to CUI in the selection event if the CUI is in legacy mode.

Returns: