Method Maps2
SymbolDescription
AdminId
GroupId
Enumerations8
SymbolDescription
AdmAccessModeMethods of computing access permissions.
AdminCachePartRepresents the various cache regions.
AdminFlagAccess levels (flags) for admins.
AdminIdIdentifies a unique entry in the admin permissions cache. These are not Handles.
GroupIdIdentifies a unique entry in the group permissions cache. These are not Handles.
ImmunityTypeDEPRECATED, do not use.
OverrideRuleAccess override rules.
OverrideTypeAccess override types.
Defines25
SymbolDescription
ADMFLAG_BANConvenience macro for Admin_Ban as a FlagBit
ADMFLAG_CHANGEMAPConvenience macro for Admin_Changemap as a FlagBit
ADMFLAG_CHATConvenience macro for Admin_Chat as a FlagBit
ADMFLAG_CHEATSConvenience macro for Admin_Cheats as a FlagBit
ADMFLAG_CONFIGConvenience macro for Admin_Config as a FlagBit
ADMFLAG_CONVARSConvenience macro for Admin_Convars as a FlagBit
ADMFLAG_CUSTOM1Convenience macro for Admin_Custom1 as a FlagBit
ADMFLAG_CUSTOM2Convenience macro for Admin_Custom2 as a FlagBit
ADMFLAG_CUSTOM3Convenience macro for Admin_Custom3 as a FlagBit
ADMFLAG_CUSTOM4Convenience macro for Admin_Custom4 as a FlagBit
ADMFLAG_CUSTOM5Convenience macro for Admin_Custom5 as a FlagBit
ADMFLAG_CUSTOM6Convenience macro for Admin_Custom6 as a FlagBit
ADMFLAG_GENERICConvenience macro for Admin_Generic as a FlagBit
ADMFLAG_KICKConvenience macro for Admin_Kick as a FlagBit
ADMFLAG_PASSWORDConvenience macro for Admin_Password as a FlagBit
ADMFLAG_RCONConvenience macro for Admin_RCON as a FlagBit
ADMFLAG_RESERVATIONConvenience macro for Admin_Reservation as a FlagBit
ADMFLAG_ROOTConvenience macro for Admin_Root as a FlagBit
ADMFLAG_SLAYConvenience macro for Admin_Slay as a FlagBit
ADMFLAG_UNBANConvenience macro for Admin_Unban as a FlagBit
ADMFLAG_VOTEConvenience macro for Admin_Vote as a FlagBit
AdminFlags_TOTALTotal number of admin flags
AUTHMETHOD_IPIP based authentication
AUTHMETHOD_NAMEName based authentication
AUTHMETHOD_STEAMSteamID based authentication
Forwards1
SymbolDescription
OnRebuildAdminCacheCalled when part of the cache needs to be rebuilt.
Functions47
SymbolDescription
AddAdmGroupCmdOverrideAdds a group-specific override type.
AddCommandOverrideAdds a global command flag override. Any command registered with this name will assume the new flag. This is applied retroactively as well.
AdminInheritGroupAdds a group to an admin's inherited group list. Any flags the group has will be added to the admin's effective flags.
BindAdminIdentityBinds an admin to an identity for fast lookup later on. The bind must be unique.
BitToFlagConverts a bit to an AdminFlag.
CanAdminTargetTests whether one admin can target another. The heuristics for this check are as follows: 0. If the targeting AdminId is INVALID_ADMIN_ID, targeting fails. 1. If the targeted AdminId is INVALID_ADMIN_ID, targeting succeeds. 2. If the targeted AdminId is the same as the targeting AdminId, (self) targeting succeeds. 3. If the targeting admin is root, targeting succeeds. 4. If the targeted admin has access higher (as interpreted by (sm_immunity_mode) than the targeting admin, then targeting fails. 5. If the targeted admin has specific immunity from the targeting admin via group immunities, targeting fails. 6. Targeting succeeds.
CreateAdmGroupAdds a new group. Name must be unique.
CreateAdminCreates a new admin entry in the permissions cache and returns the generated AdminId index.
CreateAuthMethodCreates an admin auth method. This does not need to be called more than once per method, ever.
DumpAdminCacheTells the admin system to dump a portion of the cache.
FindAdmGroupFinds a group by name.
FindAdminByIdentityAttempts to find an admin by an auth method and an identity.
FindFlagByCharFinds a flag by a given character.
FindFlagByNameFinds a flag by its string name.
FindFlagCharFinds the flag char for a given admin flag.
FlagArrayToBitsConverts an array of flags to bits.
FlagBitArrayToBitsConverts a flag array to a bit string.
FlagBitsToArrayConverts a bit string to an array of flags.
FlagBitsToBitArrayConverts a flag bit string to a bit array.
FlagBitsToStringConverts a bit string to a string of flag characters.
FlagToBitConverts a flag to its single bit.
GetAdmGroupAddFlagGets the set value of an add flag on a group's flag set.
GetAdmGroupAddFlagsReturns the flag set that is added to a user from their group.
GetAdmGroupCmdOverrideRetrieves a group-specific command override.
GetAdmGroupImmuneCountReturns the number of specific group immunities.
GetAdmGroupImmuneFromReturns a group that this group is immune to given an index.
GetAdmGroupImmunity
GetAdmGroupImmunityLevelGets a group's immunity level (defaults to 0).
GetAdminFlagReturns whether or not a flag is enabled on an admin.
GetAdminFlagsReturns the bitstring of access flags on an admin.
GetAdminGroupReturns group information from an admin.
GetAdminGroupCountReturns the number of groups this admin is a member of.
GetAdminImmunityLevelGets an admin's immunity level.
GetAdminPasswordGets an admin's password.
GetAdminUsernameRetrieves an admin's user name as made with CreateAdmin().
GetCommandOverrideReturns a command override.
ReadFlagStringConverts a string of flag characters to a bit string.
RegisterAuthIdentTypeRegisters an authentication identity type. You normally never need to call this except for very specific systems.
RemoveAdminRemoves an admin entry from the cache.
SetAdmGroupAddFlagAdds or removes a flag from a group's flag set.
SetAdmGroupImmuneFromAdds immunity to a specific group.
SetAdmGroupImmunity
SetAdmGroupImmunityLevelSets a group's immunity level.
SetAdminFlagSets whether or not a flag is enabled on an admin.
SetAdminImmunityLevelSets an admin's immunity level.
SetAdminPasswordSets a password on an admin.
UnsetCommandOverrideUnsets a command override.