Package net.luckperms.api.model.group
Interface Group
- All Superinterfaces:
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
Modifier and TypeMethodDescriptionGets the groups "display name", if it has one that differs from it's actual name.getDisplayName
(@NonNull QueryOptions queryOptions) Gets the groups "display name", if it has one that differs from it's actual name.getName()
Get the name of the groupGets 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 Details
-
getName
Get the name of the group- Returns:
- the name of the group
-
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
null
if the groups display name is equal to it'sactual name
.- Returns:
- the display name
-
getDisplayName
Gets the groups "display name", if it has one that differs from it's actual name.Will return
null
if 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
-