Upstream/WorldGuard
1
0
Fork 0
mirror of https://github.com/EngineHub/WorldGuard.git synced 2025-01-10 10:28:25 +01:00
Code Issues Projects Releases Wiki Activity

Fix doc comment of FlagValueCalculator#getMembership(RegionAssociable)

Browse Source
This commit is contained in:
stonar96 2021-05-04 17:33:39 +02:00 committed by wizjany
parent 7dcec2b3b4
commit 65c894cfe9
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
worldguard-core/src/main/java/com/sk89q/worldguard/protection/FlagValueCalculator.java
View File

@ -90,13 +90,14 @@ private Iterable<ProtectedRegion> getApplicable() {
/**
* Return the membership status of the given subject, indicating
* whether there are no (counted) regions in the list of regions,
* whether the subject is a member of all regions, or whether
* the region is not a member of all regions.
* whether the subject is a member of all (counted) regions, or
* whether the subject is not a member of all (counted) regions.
*
* <p>A region is "counted" if it doesn't have the
* {@link Flags#PASSTHROUGH} flag set to {@code ALLOW}. (The
* explicit purpose of the PASSTHROUGH flag is to have the region
* be skipped over in this check.)</p>
* {@link Flags#PASSTHROUGH} flag set to {@code ALLOW} and if
* there isn't another "counted" region with a higher priority.
* (The explicit purpose of the PASSTHROUGH flag is to have the
* region be skipped over in this check.)</p>
*
* <p>This method is mostly for internal use. It's not particularly
* useful.</p>