Broke Protocol Game API Reference  1.39
Code reference for server and client scripting
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | Properties | List of all members
BrokeProtocol.API.Group Class Reference

Public Member Functions

bool IsMember (ShPlayer player)
 
string GetInputByType (ShPlayer player)
 
bool HasPermission (ShPlayer player, string permission, bool inheritedGroup=false)
 
bool AddMember (ShPlayer player)
 
bool RemoveMember (ShPlayer player)
 
void ClearMembers ()
 
void ClearPermissions ()
 

Static Public Attributes

const string defaultNamespace = "bp"
 

Properties

GroupType Type [get, set]
 
string Name [get, set]
 
string Tag [get, set]
 
HashSet< string > Permissions = new () [get, set]
 
CustomData CustomData = new () [get, set]
 
HashSet< string > Members = new () [get, set]
 
List< string > Inherits = new () [get, set]
 

Member Function Documentation

◆ AddMember()

bool BrokeProtocol.API.Group.AddMember ( ShPlayer player)

◆ ClearMembers()

void BrokeProtocol.API.Group.ClearMembers ( )

◆ ClearPermissions()

void BrokeProtocol.API.Group.ClearPermissions ( )

◆ GetInputByType()

string BrokeProtocol.API.Group.GetInputByType ( ShPlayer player)

◆ HasPermission()

bool BrokeProtocol.API.Group.HasPermission ( ShPlayer player,
string permission,
bool inheritedGroup = false )
inline

◆ IsMember()

bool BrokeProtocol.API.Group.IsMember ( ShPlayer player)

◆ RemoveMember()

bool BrokeProtocol.API.Group.RemoveMember ( ShPlayer player)

Member Data Documentation

◆ defaultNamespace

const string BrokeProtocol.API.Group.defaultNamespace = "bp"
static

Property Documentation

◆ CustomData

CustomData BrokeProtocol.API.Group.CustomData = new ()
getset

◆ Inherits

List<string> BrokeProtocol.API.Group.Inherits = new ()
getset

◆ Members

HashSet<string> BrokeProtocol.API.Group.Members = new ()
getset

◆ Name

string BrokeProtocol.API.Group.Name
getset

◆ Permissions

HashSet<string> BrokeProtocol.API.Group.Permissions = new ()
getset

◆ Tag

string BrokeProtocol.API.Group.Tag
getset

◆ Type

GroupType BrokeProtocol.API.Group.Type
getset

The documentation for this class was generated from the following file: