1.21.9/llc.redstone.systemsapi.api/Group

Group

interface Group

Represents a group within Housing.

Implementations perform sequential behavior and therefore expose suspend functions for better interaction with Housing.

Inheritors

GroupImporter

Types

ChatSpeed

enum ChatSpeed : Enum<Group.ChatSpeed>

Chat speeds used for chat throttling permissions.

DefaultGameMode

enum DefaultGameMode : Enum<Group.DefaultGameMode>

Default game modes that can be applied to players in the group.

GroupColor

enum GroupColor : Enum<Group.GroupColor>

Possible display colors for a group.

PermissionKey

sealed class PermissionKey<T>

A key representing a typed permission entry.

Permissions

object Permissions

Available permissions.

PermissionSet

class PermissionSet

Mutable container for permission values keyed by PermissionKey.

Properties

name

abstract var name: String

The unique name of this group.

Functions

clearGroupPlayers

abstract suspend fun clearGroupPlayers(): Group

Removes all players from this group.

delete

abstract suspend fun delete()

Deletes this group.

getColor

abstract suspend fun getColor(): Group.GroupColor

Returns the group's display color.

getName

open suspend fun getName(): String

Returns the current name of this group.

getPermissions

abstract suspend fun getPermissions(): Group.PermissionSet

Returns the group's permissions as a PermissionSet.

getPriority

abstract suspend fun getPriority(): Int

Returns the group's priority. Higher values indicate higher priority.

getTag

abstract suspend fun getTag(): String?

Gets the group's current tag.

getTagVisibleInChat

abstract suspend fun getTagVisibleInChat(): Boolean

Returns whether the group's tag is visible in chat.

setColor

abstract suspend fun setColor(newColor: Group.GroupColor): Group

Sets the group's display color.

setName

abstract suspend fun setName(newName: String): Group

Sets the name of this group.

setPermissions

abstract suspend fun setPermissions(newPermissions: Group.PermissionSet): Group

Replaces the group's permissions with the provided set.

setPriority

abstract suspend fun setPriority(newPriority: Int): Group

Sets the group's priority.

setTag

abstract suspend fun setTag(newTag: String): Group

Sets the group's chat tag.

setTagVisibleInChat

abstract suspend fun setTagVisibleInChat(newVisibleInChat: Boolean): Group

Sets visibility of the group's tag in chat.