public class CylinderRegionSelector extends CylinderRegionSelector implements RegionSelector, CUIRegion
CylinderRegionSelector from a user's selections.| Modifier and Type | Field and Description |
|---|---|
protected static NumberFormat |
NUMBER_FORMAT |
protected CylinderRegion |
region |
| Constructor and Description |
|---|
CylinderRegionSelector()
Create a new region selector with a
null world. |
CylinderRegionSelector(RegionSelector oldSelector)
Create a new selector from the given one.
|
CylinderRegionSelector(World world)
Create a new region selector.
|
CylinderRegionSelector(World world,
Vector2D center,
Vector2D radius,
int minY,
int maxY)
Create a new selector.
|
| Modifier and Type | Method and Description |
|---|---|
void |
clear()
Clear the selection.
|
void |
describeCUI(LocalSession session,
Actor 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,
Actor player)
Sends CUI events describing the region for
versions of CUI smaller than the value
supplied by getProtocolVersion().
|
void |
explainPrimarySelection(Actor player,
LocalSession session,
Vector pos)
Tell the player information about his/her primary selection.
|
void |
explainPrimarySelection(LocalPlayer player,
LocalSession session,
Vector position)
Deprecated.
|
void |
explainRegionAdjust(Actor player,
LocalSession session)
The the player information about the region's changes.
|
void |
explainRegionAdjust(LocalPlayer player,
LocalSession session)
Deprecated.
|
void |
explainSecondarySelection(Actor player,
LocalSession session,
Vector pos)
Tell the player information about his/her secondary selection.
|
void |
explainSecondarySelection(LocalPlayer player,
LocalSession session,
Vector position)
Deprecated.
|
int |
getArea()
Get the number of blocks inside the region.
|
CylinderRegion |
getIncompleteRegion()
Get the region even if it's not fully defined.
|
List<String> |
getInformationLines()
Get lines of information about the selection.
|
String |
getLegacyTypeID()
Returns the type ID to send to CUI in the selection
event if the CUI is in legacy mode.
|
BlockVector |
getPrimaryPosition()
Get the primary position.
|
int |
getProtocolVersion()
Returns the CUI version that is required to send
up-to-date data.
|
CylinderRegion |
getRegion()
Get the selection.
|
String |
getTypeID()
Returns the type ID to send to CUI in the selection event.
|
String |
getTypeName()
Get a lowercase name of this region selector type.
|
World |
getWorld()
Get the world for the region selector.
|
boolean |
isDefined()
Returns whether the region has been fully defined.
|
void |
learnChanges()
Update the selector with changes to the region.
|
boolean |
selectPrimary(Vector position,
SelectorLimits limits)
Called when the first point is selected.
|
boolean |
selectSecondary(Vector position,
SelectorLimits limits)
Called when the second point is selected.
|
void |
setWorld(World world)
Set the world for the region selector.
|
protected static final transient NumberFormat NUMBER_FORMAT
protected transient CylinderRegion region
public CylinderRegionSelector()
null world.public CylinderRegionSelector(@Nullable World world)
world - the world, which may be nullpublic CylinderRegionSelector(RegionSelector oldSelector)
oldSelector - the old selector@Nullable public World getWorld()
RegionSelectorgetWorld in interface RegionSelectorpublic void setWorld(@Nullable World world)
RegionSelectorsetWorld in interface RegionSelectorworld - the world, which may be nullpublic boolean selectPrimary(Vector position, SelectorLimits limits)
RegionSelectorselectPrimary in interface RegionSelectorposition - the positionpublic boolean selectSecondary(Vector position, SelectorLimits limits)
RegionSelectorselectSecondary in interface RegionSelectorposition - the positionpublic void explainPrimarySelection(Actor player, LocalSession session, Vector pos)
RegionSelectorexplainPrimarySelection in interface RegionSelectorplayer - the actorsession - the sessionpos - positionpublic void explainSecondarySelection(Actor player, LocalSession session, Vector pos)
RegionSelectorexplainSecondarySelection in interface RegionSelectorplayer - the actorsession - the sessionpos - positionpublic void explainRegionAdjust(Actor player, LocalSession session)
RegionSelectorexplainRegionAdjust in interface RegionSelectorplayer - the actorsession - the sessionpublic BlockVector getPrimaryPosition() throws IncompleteRegionException
RegionSelectorgetPrimaryPosition in interface RegionSelectorIncompleteRegionException - thrown if a region has not been fully definedpublic CylinderRegion getRegion() throws IncompleteRegionException
RegionSelectorgetRegion in interface RegionSelectorIncompleteRegionException - thrown if a region has not been fully definedpublic CylinderRegion getIncompleteRegion()
RegionSelectorgetIncompleteRegion in interface RegionSelectorpublic boolean isDefined()
RegionSelectorisDefined in interface RegionSelectorpublic void learnChanges()
RegionSelectorlearnChanges in interface RegionSelectorpublic void clear()
RegionSelectorclear in interface RegionSelectorpublic String getTypeName()
RegionSelectorgetTypeName in interface RegionSelectorpublic List<String> getInformationLines()
RegionSelectorgetInformationLines in interface RegionSelectorpublic int getArea()
RegionSelectorgetArea in interface RegionSelectorpublic void describeCUI(LocalSession session, Actor player)
CUIRegiondescribeCUI in interface CUIRegionpublic void describeLegacyCUI(LocalSession session, Actor player)
CUIRegiondescribeLegacyCUI in interface CUIRegionpublic int getProtocolVersion()
CUIRegiongetProtocolVersion in interface CUIRegionpublic String getTypeID()
CUIRegionpublic String getLegacyTypeID()
CUIRegiongetLegacyTypeID in interface CUIRegion@Deprecated public final void explainPrimarySelection(LocalPlayer player, LocalSession session, Vector position)
@Deprecated public final void explainSecondarySelection(LocalPlayer player, LocalSession session, Vector position)
@Deprecated public final void explainRegionAdjust(LocalPlayer player, LocalSession session)
Copyright © 2010-2014. All Rights Reserved.