Class AccessReaderComponent

Stores access levels necessary to "use" an entity and allows checking if something or somebody is authorized with these access levels.

Inheritance

System.Object

AccessReaderComponent

Namespace: Content.Shared.Access.Components

Assembly: Content.Shared.dll

Syntax

public sealed class AccessReaderComponent : Component

Fields

AccessKeys

A list of StationRecordKeys that grant access. Only a single matching key is required tp gaim access.

Declaration

public HashSet<StationRecordKey> AccessKeys

Field Value

Type	Description
HashSet<StationRecordKey>

AccessLists

List of access groups that grant access to this reader. Only a single matching group is required to gain access. A group matches if it is a subset of the set being checked against.

Declaration

public List<HashSet<string>> AccessLists

Field Value

Type	Description
List<HashSet<System.String>>

ContainerAccessProvider

If specified, then this access reader will instead pull access requirements from entities contained in the given container.

Declaration

public string? ContainerAccessProvider

Field Value

Type	Description
System.Nullable<System.String>

Remarks

This effectively causes DenyTags, AccessLists, and AccessKeys to be ignored, though Enabled is still respected. Access is denied if there are no valid entities or they all deny access.

DenyTags

The set of tags that will automatically deny an allowed check, if any of them are present.

Declaration

public HashSet<string> DenyTags

Field Value

Type	Description
HashSet<System.String>

Enabled

Whether or not the accessreader is enabled. If not, it will always let people through.

Declaration

public bool Enabled

Field Value

Type	Description
System.Boolean