Class GlobalProtectedRegion
java.lang.Object
com.sk89q.worldguard.protection.regions.ProtectedRegion
com.sk89q.worldguard.protection.regions.GlobalProtectedRegion
- All Implemented Interfaces:
ChangeTracked
,Comparable<ProtectedRegion>
A special region that is not quite "anywhere" (its volume is 0, it
contains no positions, and it does not intersect with any other region).
Global regions, however, are used to specify a region with flags that are applied with the lowest priority.
-
Nested Class Summary
Nested classes/interfaces inherited from class com.sk89q.worldguard.protection.regions.ProtectedRegion
ProtectedRegion.CircularInheritanceException
-
Field Summary
Fields inherited from class com.sk89q.worldguard.protection.regions.ProtectedRegion
GLOBAL_REGION, max, min
-
Constructor Summary
ConstructorDescriptionCreate a new instance.
Equivalent toGlobalProtectedRegion(id, false)
transientRegion
will be set to false, and this region can be saved.GlobalProtectedRegion
(String id, boolean transientRegion) Create a new instance. -
Method Summary
Modifier and TypeMethodDescriptionboolean
contains
(com.sk89q.worldedit.math.BlockVector3 pt) Check to see if a point is inside this region.getIntersectingRegions
(Collection<ProtectedRegion> regions) Return a list of regions from the given list of regions that intersect with this region.List<com.sk89q.worldedit.math.BlockVector2>
Get points of the region projected onto the X-Z plane.getType()
Get the type of region.boolean
Return whether this type of region encompasses physical area.int
volume()
Get the number of blocks in this region.Methods inherited from class com.sk89q.worldguard.protection.regions.ProtectedRegion
clearParent, compareTo, contains, contains, containsAny, copyFrom, getFlag, getFlags, getId, getMaximumPoint, getMembers, getMinimumPoint, getOwners, getParent, getPriority, hashCode, hasMembersOrOwners, intersects, intersectsBoundingBox, intersectsEdges, isDirty, isMember, isMember, isMemberOnly, isOwner, isOwner, isTransient, isValidId, setDirty, setFlag, setFlags, setMembers, setMinMaxPoints, setOwners, setParent, setPriority, toString
-
Constructor Details
-
GlobalProtectedRegion
Create a new instance.
Equivalent toGlobalProtectedRegion(id, false)
transientRegion
will be set to false, and this region can be saved.- Parameters:
id
- the ID
-
GlobalProtectedRegion
Create a new instance.- Parameters:
id
- the IDtransientRegion
- whether this region should only be kept in memory and not be saved
-
-
Method Details
-
isPhysicalArea
public boolean isPhysicalArea()Description copied from class:ProtectedRegion
Return whether this type of region encompasses physical area.- Specified by:
isPhysicalArea
in classProtectedRegion
- Returns:
- Whether physical area is encompassed
-
getPoints
Description copied from class:ProtectedRegion
Get points of the region projected onto the X-Z plane.- Specified by:
getPoints
in classProtectedRegion
- Returns:
- the points
-
volume
public int volume()Description copied from class:ProtectedRegion
Get the number of blocks in this region.- Specified by:
volume
in classProtectedRegion
- Returns:
- the volume of this region in blocks
-
contains
public boolean contains(com.sk89q.worldedit.math.BlockVector3 pt) Description copied from class:ProtectedRegion
Check to see if a point is inside this region.- Specified by:
contains
in classProtectedRegion
- Parameters:
pt
- The point to check- Returns:
- Whether
pt
is in this region
-
getType
Description copied from class:ProtectedRegion
Get the type of region.- Specified by:
getType
in classProtectedRegion
- Returns:
- the type
-
getIntersectingRegions
Description copied from class:ProtectedRegion
Return a list of regions from the given list of regions that intersect with this region.- Overrides:
getIntersectingRegions
in classProtectedRegion
- Parameters:
regions
- a list of regions to source from- Returns:
- the elements of
regions
that intersect with this region
-