Class SharedAccessSystem

Inheritance
System.Object
SharedAccessSystem
AccessSystem
AccessSystem
Namespace: Content.Shared.Access.Systems
Assembly: Content.Shared.dll
Syntax
public abstract class SharedAccessSystem : EntitySystem

Methods

| Improve this Doc View Source

Initialize()

Declaration
public override void Initialize()
| Improve this Doc View Source

SetAccessEnabled(EntityUid, Boolean, AccessComponent)

Declaration
public void SetAccessEnabled(EntityUid uid, bool val, AccessComponent component = null)
Parameters
Type Name Description
EntityUid uid
System.Boolean val
AccessComponent component
| Improve this Doc View Source

SetAccessToJob(EntityUid, JobPrototype, Boolean, AccessComponent)

Set the access on an AccessComponent to the access for a specific job.

Declaration
public void SetAccessToJob(EntityUid uid, JobPrototype prototype, bool extended, AccessComponent access = null)
Parameters
Type Name Description
EntityUid uid

The ID of the entity with the access component.
JobPrototype prototype

The job prototype to use access from.
System.Boolean extended

Whether to apply extended job access.
AccessComponent access

The access component.
| Improve this Doc View Source

TryAddGroups(EntityUid, IEnumerable<String>, AccessComponent)

Declaration
public bool TryAddGroups(EntityUid uid, IEnumerable<string> newGroups, AccessComponent access = null)
Parameters
Type Name Description
EntityUid uid
IEnumerable<System.String> newGroups
AccessComponent access
Returns
Type Description
System.Boolean
| Improve this Doc View Source

TryGetTags(EntityUid, AccessComponent)

Gets the set of access tags.

Declaration
public IEnumerable<string>? TryGetTags(EntityUid uid, AccessComponent access = null)
Parameters
Type Name Description
EntityUid uid
AccessComponent access

The new access tags
Returns
Type Description
System.Nullable<IEnumerable<System.String>>
| Improve this Doc View Source

TrySetTags(EntityUid, IEnumerable<String>, AccessComponent)

Replaces the set of access tags we have with the provided set.

Declaration
public bool TrySetTags(EntityUid uid, IEnumerable<string> newTags, AccessComponent access = null)
Parameters
Type Name Description
EntityUid uid
IEnumerable<System.String> newTags
AccessComponent access

The new access tags
Returns
Type Description
System.Boolean