Show / Hide Table of Contents

Class AdminData

Represents data for a single server admin.

Inheritance
System.Object
AdminData
Namespace: Content.Shared.Administration
Assembly: Content.Shared.dll
Syntax
public sealed class AdminData : object

Fields

| Improve this Doc View Source

Active

Whether the admin is currently active. This can be false if they have de-adminned mid-round.

Declaration
public bool Active
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

Flags

The admin's permission flags.

Declaration
public AdminFlags Flags
Field Value
Type Description
AdminFlags
| Improve this Doc View Source

Title

The admin's title.

Declaration
public string? Title
Field Value
Type Description
System.Nullable<System.String>

Methods

| Improve this Doc View Source

CanAdminMenu()

Check if this admin can open the admin menu.

Declaration
public bool CanAdminMenu()
Returns
Type Description
System.Boolean
| Improve this Doc View Source

CanAdminPlace()

Check if this admin can spawn stuff in with the entity/tile spawn panel.

Declaration
public bool CanAdminPlace()
Returns
Type Description
System.Boolean
| Improve this Doc View Source

CanAdminReloadPrototypes()

Declaration
public bool CanAdminReloadPrototypes()
Returns
Type Description
System.Boolean
| Improve this Doc View Source

CanScript()

Check if this admin can execute server-side C# scripts.

Declaration
public bool CanScript()
Returns
Type Description
System.Boolean
| Improve this Doc View Source

HasFlag(AdminFlags)

Checks whether this admin has an admin flag.

Declaration
public bool HasFlag(AdminFlags flag)
Parameters
Type Name Description
AdminFlags flag

The flags to check. Multiple flags can be specified, they must all be held.

Returns
Type Description
System.Boolean

False if this admin is not Active or does not have all the flags specified.

  • Improve this Doc
  • View Source
☀
☾
In This Article
Back to top
Generated by DocFX
☀
☾