Class AdminFlagsHelper
Contains various helper methods for working with admin flags.
Inheritance
System.Object
AdminFlagsHelper
Namespace: Content.Shared.Administration
Assembly: Content.Shared.dll
Syntax
public static class AdminFlagsHelper : object
Fields
| Improve this Doc View SourceAllFlags
A list of all individual admin flags.
Declaration
public static readonly IReadOnlyList<AdminFlags> AllFlags
Field Value
Type | Description |
---|---|
IRead |
Everything
Every admin flag in the game, at once!
Declaration
public static readonly AdminFlags Everything
Field Value
Type | Description |
---|---|
Admin |
Methods
| Improve this Doc View SourceFlagsToNames(AdminFlags)
Converts a bitfield of admin flags to an array of all the flag names set.
Declaration
public static string[] FlagsToNames(AdminFlags flags)
Parameters
Type | Name | Description |
---|---|---|
Admin |
flags |
Returns
Type | Description |
---|---|
System. |
NamesToFlags(IEnumerable<String>)
Converts an enumerable of admin flag names to a bitfield.
Declaration
public static AdminFlags NamesToFlags(IEnumerable<string> names)
Parameters
Type | Name | Description |
---|---|---|
IEnumerable<System. |
names |
Returns
Type | Description |
---|---|
Admin |
Remarks
The flags must all be uppercase.
NameToFlag(String)
Gets the flag bit for an admin flag name.
Declaration
public static AdminFlags NameToFlag(string name)
Parameters
Type | Name | Description |
---|---|---|
System. |
name |
Returns
Type | Description |
---|---|
Admin |
Remarks
The flag name must be all uppercase.
PosNegFlagsText(AdminFlags, AdminFlags)
Declaration
public static string PosNegFlagsText(AdminFlags posFlags, AdminFlags negFlags)
Parameters
Type | Name | Description |
---|---|---|
Admin |
posFlags | |
Admin |
negFlags |
Returns
Type | Description |
---|---|
System. |