Class PermissiveRegionSet
- All Implemented Interfaces:
ApplicableRegionSet
,Iterable<ProtectedRegion>
-
Method Summary
Modifier and TypeMethodDescriptionstatic PermissiveRegionSet
Get an instance.Get an immutable set of regions that are included in this set.boolean
isMemberOfAll
(LocalPlayer player) Test whether a player is an owner or member of all regions in this set.boolean
isOwnerOfAll
(LocalPlayer player) Test whether a player is an owner of all regions in this set.boolean
Return whether this region set is a virtual set.iterator()
<V> Collection
<V> queryAllValues
(RegionAssociable subject, Flag<V> flag) Get the effective values for a flag, returning a collection of all values.<V,
K> V queryMapValue
(RegionAssociable subject, MapFlag<K, V> flag, K key) Get the effective value for a key in aMapFlag
.<V,
K> V queryMapValue
(RegionAssociable subject, MapFlag<K, V> flag, K key, Flag<V> fallback) Get the effective value for a key in aMapFlag
.<V> V
queryValue
(RegionAssociable subject, Flag<V> flag) Get the effective value for a flag.int
size()
Get the number of regions that are included.Methods inherited from class com.sk89q.worldguard.protection.AbstractRegionSet
queryState, testState
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
Method Details
-
isVirtual
public boolean isVirtual()Description copied from interface:ApplicableRegionSet
Return whether this region set is a virtual set. A virtual set does not contain real results.A virtual result may be returned if region data failed to load or there was some special exception (i.e. the region bypass permission).
Be sure to check the value of this flag if an instance of this interface is being retrieved from RegionQuery as it may return an instance of
PermissiveRegionSet
orFailedLoadRegionSet
, among other possibilities.- Returns:
- true if loaded
- See Also:
-
queryValue
Description copied from interface:ApplicableRegionSet
Get the effective value for a flag. If there are multiple values (for example, multiple overlapping regions with the same priority may have the same flag set), then the selected (or "winning") value will depend on the flag type.Only some flag types actually have a strategy for picking the "best value." For most types, the actual value that is chosen to be returned is undefined (it could be any value). As of writing, the only type of flag that actually has a strategy for picking a value is the
StateFlag
.subject
can be non-null to satisfy region group requirements, otherwise it will be assumed that the caller that is not a member of any regions. (Flags on a region can be changed so that they only apply to certain users.) The subject argument is required if theFlags.BUILD
flag is the flag being queried.- Parameters:
subject
- an optional subject, which would be used to determine the region group to applyflag
- the flag- Returns:
- a value, which could be
null
-
queryMapValue
@Nullable public <V,K> V queryMapValue(@Nullable RegionAssociable subject, MapFlag<K, V> flag, K key) Description copied from interface:ApplicableRegionSet
Get the effective value for a key in aMapFlag
. If there are multiple values (for example, if there are multiple regions with the same priority but with different farewell messages set, there would be multiple completing values), then the selected (or "winning") value will be undefined.A subject can be provided that is used to determine whether the value of a flag on a particular region should be used. For example, if a flag's region group is set to
RegionGroup.MEMBERS
and the given subject is not a member, then the region would be skipped when querying that flag. Ifnull
is provided for the subject, then only flags that useRegionGroup.ALL
,RegionGroup.NON_MEMBERS
, etc. will apply.- Parameters:
subject
- an optional subject, which would be used to determine the region group to applyflag
- the flag of typeMapFlag
key
- the key for the map flag- Returns:
- a value, which could be
null
-
queryMapValue
@Nullable public <V,K> V queryMapValue(@Nullable RegionAssociable subject, MapFlag<K, V> flag, K key, @Nullable Flag<V> fallback) Description copied from interface:ApplicableRegionSet
Get the effective value for a key in aMapFlag
. If there are multiple values (for example, if there are multiple regions with the same priority but with different farewell messages set, there would be multiple completing values), then the selected (or "winning") value will be undefined.A subject can be provided that is used to determine whether the value of a flag on a particular region should be used. For example, if a flag's region group is set to
RegionGroup.MEMBERS
and the given subject is not a member, then the region would be skipped when querying that flag. Ifnull
is provided for the subject, then only flags that useRegionGroup.ALL
,RegionGroup.NON_MEMBERS
, etc. will apply.- Parameters:
subject
- an optional subject, which would be used to determine the region group to applyflag
- the flag of typeMapFlag
key
- the key for the map flag- Returns:
- a value, which could be
null
-
queryAllValues
Description copied from interface:ApplicableRegionSet
Get the effective values for a flag, returning a collection of all values. It is up to the caller to determine which value, if any, from the collection will be used.subject
can be non-null to satisfy region group requirements, otherwise it will be assumed that the caller that is not a member of any regions. (Flags on a region can be changed so that they only apply to certain users.) The subject argument is required if theFlags.BUILD
flag is the flag being queried.- Parameters:
subject
- an optional subject, which would be used to determine the region group to applyflag
- the flag- Returns:
- a collection of values
-
isOwnerOfAll
Description copied from interface:ApplicableRegionSet
Test whether a player is an owner of all regions in this set.- Parameters:
player
- the player- Returns:
- whether the player is an owner of all regions
-
isMemberOfAll
Description copied from interface:ApplicableRegionSet
Test whether a player is an owner or member of all regions in this set.- Parameters:
player
- the player- Returns:
- whether the player is a member of all regions
-
size
public int size()Description copied from interface:ApplicableRegionSet
Get the number of regions that are included.- Returns:
- the number of contained regions
-
getRegions
Description copied from interface:ApplicableRegionSet
Get an immutable set of regions that are included in this set.- Returns:
- a set of regions
-
iterator
-
getInstance
Get an instance.- Returns:
- an instance
-