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 Source

AllFlags

A list of all individual admin flags.

Declaration

public static readonly IReadOnlyList<AdminFlags> AllFlags

Field Value

Type	Description
IReadOnlyList<AdminFlags>

| Improve this Doc View Source

Everything

Every admin flag in the game, at once!

Declaration

public static readonly AdminFlags Everything

Field Value

Type	Description
AdminFlags

Methods

| Improve this Doc View Source

FlagsToNames(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
AdminFlags	flags

Returns

Type	Description
System.String[]

| Improve this Doc View Source

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.String>	names

Returns

Type	Description
AdminFlags

Remarks

The flags must all be uppercase.

| Improve this Doc View Source

NameToFlag(String)

Gets the flag bit for an admin flag name.

Declaration

public static AdminFlags NameToFlag(string name)

Parameters

Type	Name	Description
System.String	name

Returns

Type	Description
AdminFlags

Remarks

The flag name must be all uppercase.

| Improve this Doc View Source

PosNegFlagsText(AdminFlags, AdminFlags)

Declaration

public static string PosNegFlagsText(AdminFlags posFlags, AdminFlags negFlags)

Parameters

Type	Name	Description
AdminFlags	posFlags
AdminFlags	negFlags

Returns

Type	Description
System.String