permission

Documentation

Overview

Package permission is a utility package that defines primitives to allow checking a Subject for a permission.

E.g. A player's permission Func can be setup on join by subscribing to proxy.PermissionsSetupEvent.

Note: This is a simple package only allowing limited complexity of permission checking and may not suffice everyone's requirements. Therefore, Gate also makes no assumptions on whether this package is used or not. Plugins may use their own authorization system internally without a touch on this package.

Index

• type Func
• type Subject
• type TriState
  • func (t TriState) Bool() bool

Types

type Func

type Func func(permission string) TriState

Func is the permission function to obtain the TriState for a permission.

type Subject

type Subject interface {
	HasPermission(permission string) bool // Equal to PermissionValue(...).Bool()
	PermissionValue(permission string) TriState
}

Subject is a permission holder like a player.

type TriState

type TriState uint8

TriState can be in three states (True, False, Undefined), used for a setting.

const (
	Undefined TriState = iota // A permission is undefined.
	True                      // A permission is allowed.
	False                     // A permission is explicitly denied.
)

func (TriState) Bool

func (t TriState) Bool() bool

Bool returns the bool value of a TriState where Undefined is converted to false.