LogoAntiRaid

@antiraid-core/kittycat

API reference for @antiraid-core/kittycat

@antiraid-core/kittycat

Types

Permission

!nocheck

Permission type

Raw Type
--!nocheck
--- Permission type
type Permission = {
	--- Namespace of the permission
	namespace: string,

	--- Permission of the permission
	perm: string,

	--- Whether the permission is negated
	negator: boolean
}
PropTypeDescription
namespace
Namespace of the permission
perm
Permission of the permission
negator
Whether the permission is negated

PartialStaffPosition

PartialStaffPosition type

Raw Type
--- PartialStaffPosition type
type PartialStaffPosition = {
	id: string,

	index: number,

	perms: {Permission}
}
PropTypeDescription
id
-
index
-
perms
-

StaffPermissions

StaffPermissions type

Raw Type
--- StaffPermissions type
type StaffPermissions = {
	user_positions: {PartialStaffPosition},

	perm_overrides: {Permission},

	resolve: (self: StaffPermissions) -> {Permission}
}
PropTypeDescription
resolve
(self) -> {Permission}
-
user_positions
-
perm_overrides
-

CheckPatchChangesError

Error types

Raw Type
-- Error types
type CheckPatchChangesError = {
	type: "NoPermission",

	permission: Permission
} | {
	type: "LacksNegatorForWildcard",

	wildcard: Permission,

	negator: Permission
}

Union with variants:

Variant 1
PropTypeDescription
type
'NoPermission'
-
permission
-
Variant 2
PropTypeDescription
type
'LacksNegatorForWildcard'
-
wildcard
-
negator
-

Functions

Permission.new

Permission implementation

Function Signature
-- Permission implementation
function Permission.new(namespace: string, perm: string, negator: boolean) -> Permission end

Arguments

namespace

string

perm

string

negator

boolean

Returns

ret1

Permission

Permission.from_string

Function Signature
function Permission.from_string(perm_str) end

Arguments

perm_str

No type specified!!!

Permission.from_tab

Function Signature
function Permission.from_tab(perm: Permission) end

Arguments

perm

Permission

Permission.__tostring

Function Signature
function Permission.__tostring(self: Permission) end

PartialStaffPosition.new

PartialStaffPosition implementation

Function Signature
-- PartialStaffPosition implementation
function PartialStaffPosition.new(id: string, index: number, perms: {Permission}) -> PartialStaffPosition end

Arguments

id

string

index

number

perms

{Permission}

Returns

ret1

PartialStaffPosition

StaffPermissions.new

StaffPermissions implementation

Function Signature
-- StaffPermissions implementation
function StaffPermissions.new(user_positions: {PartialStaffPosition}, perm_overrides: {Permission}) -> StaffPermissions end

Arguments

user_positions

{PartialStaffPosition}

perm_overrides

{Permission}

Returns

ret1

StaffPermissions

OrderedStrNumTable.new

Function Signature
function OrderedStrNumTable.new() end

OrderedStrNumTable.get

Function Signature
function OrderedStrNumTable.get(self: OrderedStrNumTable, key: string) end

Arguments

key

string

OrderedStrNumTable.insert

Function Signature
function OrderedStrNumTable.insert(self: OrderedStrNumTable, key: string, value: number) end

Arguments

key

string

value

number

OrderedStrNumTable.remove

Function Signature
function OrderedStrNumTable.remove(self: OrderedStrNumTable, key: string) end

Arguments

key

string

OrderedStrNumTable.iterByInsertionOrder

Function Signature
function OrderedStrNumTable.iterByInsertionOrder(self: OrderedStrNumTable) end

OrderedStrNumTable.clear

Function Signature
function OrderedStrNumTable.clear(self: OrderedStrNumTable) end

StaffPermissions.resolve

Function Signature
function StaffPermissions.resolve(self: StaffPermissions) end

has_perm

Helper functions

Function Signature
-- Helper functions
function has_perm(perms: {Permission}, perm: Permission) end

Arguments

perms

{Permission}

perm

Permission

has_perm_str

Function Signature
function has_perm_str(perms: {string}, perm_str: string) end

Arguments

perms

{string}

perm_str

string

cpce_to_string

Function Signature
function cpce_to_string(err: CheckPatchChangesError?) -> string end

Arguments

err

This field is optional and may not be specified

CheckPatchChangesError?

Returns

ret1

string

check_patch_changes

Function Signature
function check_patch_changes(manager_perms: {Permission}, current_perms: {Permission}, new_perms: {Permission}) -> (boolean, CheckPatchChangesError?) end

Arguments

manager_perms

{Permission}

current_perms

{Permission}

new_perms

{Permission}

Returns

ret1

boolean

ret2

This field is optional and may not be specified

CheckPatchChangesError?

check_patch_changes_str

Function Signature
function check_patch_changes_str(manager_perms: {string}, current_perms: {string}, new_perms: {string}) end

Arguments

manager_perms

{string}

current_perms

{string}

new_perms

{string}

test

Test

Function Signature
-- Test
function test() end

Last updated on