Interface IPlayerRole

Namespace

Vintagestory.API.Common

Assembly

VintagestoryAPI.dll

public interface IPlayerRole

Extension Methods

ObjectHandleExtensions.ToGcHandle(object)

ObjectHandleExtensions.ToIntPtr(object)

Properties

AutoGrant

bool AutoGrant { get; set; }

Property Value

bool

Code

string Code { get; }

Property Value

string

Color

Color Color { get; }

Property Value

Color

DefaultGameMode

EnumGameMode DefaultGameMode { get; }

Property Value

EnumGameMode

DefaultSpawn

PlayerSpawnPos DefaultSpawn { get; }

Property Value

PlayerSpawnPos

Description

string Description { get; }

Property Value

string

ForcedSpawn

PlayerSpawnPos ForcedSpawn { get; }

Property Value

PlayerSpawnPos

LandClaimAllowance

int LandClaimAllowance { get; set; }

Property Value

int

LandClaimMaxAreas

int LandClaimMaxAreas { get; set; }

Property Value

int

LandClaimMinSize

Vec3i LandClaimMinSize { get; set; }

Property Value

Vec3i

Name

string Name { get; }

Property Value

string

PrivilegeLevel

int PrivilegeLevel { get; }

Property Value

int

Privileges

List<string> Privileges { get; }

Property Value

List<string>

RuntimePrivileges

HashSet<string> RuntimePrivileges { get; }

Property Value

HashSet<string>

Methods

EqualLevel(IPlayerRole)

bool EqualLevel(IPlayerRole role)

Parameters

role IPlayerRole

Returns

bool

GrantPrivilege(params string[])

void GrantPrivilege(params string[] privileges)

Parameters

privileges string[]

IsSuperior(IPlayerRole)

bool IsSuperior(IPlayerRole role)

Parameters

role IPlayerRole

Returns

bool

RevokePrivilege(string)

void RevokePrivilege(string privilege)

Parameters

privilege string