Package net.luckperms.api.model.group
Interface Group
-
- All Superinterfaces:
PermissionHolder
public interface Group extends PermissionHolder
An inheritable holder of permission data.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface net.luckperms.api.model.PermissionHolder
PermissionHolder.Identifier
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description @Nullable StringgetDisplayName()Gets the groups "display name", if it has one that differs from it's actual name.@Nullable StringgetDisplayName(@NonNull QueryOptions queryOptions)Gets the groups "display name", if it has one that differs from it's actual name.@NonNull StringgetName()Get the name of the group@NonNull OptionalIntgetWeight()Gets the weight of this group, if present.-
Methods inherited from interface net.luckperms.api.model.PermissionHolder
auditTemporaryNodes, data, getCachedData, getData, getDistinctNodes, getFriendlyName, getIdentifier, getInheritedGroups, getNodes, getNodes, getQueryOptions, resolveDistinctInheritedNodes, resolveInheritedNodes, resolveInheritedNodes, transientData
-
-
-
-
Method Detail
-
getDisplayName
@Nullable String getDisplayName()
Gets the groups "display name", if it has one that differs from it's actual name.The lookup is made using the current servers active context.
Will return
nullif the groups display name is equal to it'sactual name.- Returns:
- the display name
-
getDisplayName
@Nullable String getDisplayName(@NonNull QueryOptions queryOptions)
Gets the groups "display name", if it has one that differs from it's actual name.Will return
nullif the groups display name is equal to it'sactual name.- Parameters:
queryOptions- the query options to lookup in- Returns:
- the display name
-
getWeight
@NonNull OptionalInt getWeight()
Gets the weight of this group, if present.- Returns:
- the group weight
-
-