Classes 2

Class Description
AdminId

GroupId

Enums 8

Enum Description
AdmAccessMode

Methods of computing access permissions.

AdminCachePart

Represents the various cache regions.

AdminFlag

Access levels (flags) for admins.

AdminId

Identifies a unique entry in the admin permissions cache. These are not Handles.

GroupId

Identifies a unique entry in the group permissions cache. These are not Handles.

ImmunityType

DEPRECATED, do not use.

OverrideRule

Access override rules.

OverrideType

Access override types.

Forwards 1

Function Description
OnRebuildAdminCache

Called when part of the cache needs to be rebuilt.

Functions 46

Function Description
AddAdmGroupCmdOverride

Adds a group-specific override type.

AddCommandOverride

Adds a global command flag override. Any command registered with this name will assume the new flag. This is applied retroactively as well.

AdminInheritGroup

Adds a group to an admin's inherited group list. Any flags the group has will be added to the admin's effective flags.

BindAdminIdentity

Binds an admin to an identity for fast lookup later on. The bind must be unique.

BitToFlag

Converts a bit to an AdminFlag.

CanAdminTarget

Tests whether one admin can target another.

CreateAdmGroup

Adds a new group. Name must be unique.

CreateAdmin

Creates a new admin entry in the permissions cache.

CreateAuthMethod

Creates an admin auth method. This does not need to be called more than once per method, ever.

DumpAdminCache

Tells the admin system to dump a portion of the cache.

FindAdmGroup

Finds a group by name.

FindAdminByIdentity

Attempts to find an admin by an auth method and an identity.

FindFlagByChar

Finds a flag by a given character.

FindFlagByName

Finds a flag by its string name.

FindFlagChar

Finds the flag char for a given admin flag.

FlagArrayToBits

Converts an array of flags to bits.

FlagBitArrayToBits

Converts a flag array to a bit string.

FlagBitsToArray

Converts a bit string to an array of flags.

FlagBitsToBitArray

Converts a flag bit string to a bit array.

FlagToBit

Converts a flag to its single bit.

GetAdmGroupAddFlag

Gets the set value of an add flag on a group's flag set.

GetAdmGroupAddFlags

Returns the flag set that is added to a user from their group.

GetAdmGroupCmdOverride

Retrieves a group-specific command override.

GetAdmGroupImmuneCount

Returns the number of specific group immunities.

GetAdmGroupImmuneFrom

Returns a group that this group is immune to given an index.

GetAdmGroupImmunity

GetAdmGroupImmunityLevel

Gets a group's immunity level (defaults to 0).

GetAdminFlag

Returns whether or not a flag is enabled on an admin.

GetAdminFlags

Returns the bitstring of access flags on an admin.

GetAdminGroup

Returns group information from an admin.

GetAdminGroupCount

Returns the number of groups this admin is a member of.

GetAdminImmunityLevel

Gets an admin's immunity level.

GetAdminPassword

Gets an admin's password.

GetAdminUsername

Retrieves an admin's user name as made with CreateAdmin().

GetCommandOverride

Returns a command override.

ReadFlagString

Converts a string of flag characters to a bit string.

RegisterAuthIdentType

Registers an authentication identity type. You normally never need to call this except for very specific systems.

RemoveAdmin

Removes an admin entry from the cache.

SetAdmGroupAddFlag

Adds or removes a flag from a group's flag set.

SetAdmGroupImmuneFrom

Adds immunity to a specific group.

SetAdmGroupImmunity

SetAdmGroupImmunityLevel

Sets a group's immunity level.

SetAdminFlag

Sets whether or not a flag is enabled on an admin.

SetAdminImmunityLevel

Sets an admin's immunity level.

SetAdminPassword

Sets a password on an admin.

UnsetCommandOverride

Unsets a command override.