Class SharedEventHorizonSystem

The entity system primarily responsible for managing EventHorizonComponents.

Inheritance

System.Object

SharedEventHorizonSystem

EventHorizonSystem

EventHorizonSystem

Namespace: Content.Shared.Singularity.EntitySystems

Assembly: Content.Shared.dll

Syntax

public abstract class SharedEventHorizonSystem : EntitySystem

Fields

Vvm

Declaration

protected readonly IViewVariablesManager Vvm

Field Value

Type	Description
IViewVariablesManager

Methods

Initialize()

Declaration

public override void Initialize()

PreventCollide(EntityUid, EventHorizonComponent, ref PreventCollideEvent)

The actual, functional part of SharedEventHorizonSystem.OnPreventCollide. The return value allows for overrides to early return if the base successfully handles collision prevention.

Declaration

protected virtual bool PreventCollide(EntityUid uid, EventHorizonComponent comp, ref PreventCollideEvent args)

Parameters

Type	Name	Description
EntityUid	uid	The entity that is trying to collide with another entity.
EventHorizonComponent	comp	The event horizon of the former.
Robust.Shared.Physics.Events.PreventCollideEvent	args	The event arguments.

Returns

Type	Description
System.Boolean	A bool indicating whether the collision prevention has been handled.

SetCanBreachContainment(EntityUid, Boolean, Boolean, EventHorizonComponent)

Setter for CanBreachContainment May also update the fixture associated with the event horizon.

Declaration

public void SetCanBreachContainment(EntityUid uid, bool value, bool updateFixture = true, EventHorizonComponent eventHorizon = null)

Parameters

Type	Name	Description
EntityUid	uid	The uid of the event horizon to make (in)capable of breaching containment.
System.Boolean	value	Whether the event horizon should be able to breach containment.
System.Boolean	updateFixture	Whether to update the associated fixture upon changing whether the event horizon can breach containment.
EventHorizonComponent	eventHorizon	The state of the event horizon to make (in)capable of breaching containment.

SetColliderFixtureId(EntityUid, Nullable<String>, Boolean, EventHorizonComponent)

Setter for May also update the fixture associated with the event horizon.

Declaration

public void SetColliderFixtureId(EntityUid uid, string? value, bool updateFixture = true, EventHorizonComponent eventHorizon = null)

Parameters

Type	Name	Description
EntityUid	uid	The uid of the event horizon with the fixture ID to change.
System.Nullable<System.String>	value	The new fixture ID to associate the event horizon with.
System.Boolean	updateFixture	Whether to update the associated fixture upon changing whether the event horizon can breach containment.
EventHorizonComponent	eventHorizon	The state of the event horizon with the fixture ID to change.

SetConsumerFixtureId(EntityUid, Nullable<String>, Boolean, EventHorizonComponent)

Setter for May also update the fixture associated with the event horizon.

Declaration

public void SetConsumerFixtureId(EntityUid uid, string? value, bool updateFixture = true, EventHorizonComponent eventHorizon = null)

Parameters

Type	Name	Description
EntityUid	uid	The uid of the event horizon with the fixture ID to change.
System.Nullable<System.String>	value	The new fixture ID to associate the event horizon with.
System.Boolean	updateFixture	Whether to update the associated fixture upon changing whether the event horizon can breach containment.
EventHorizonComponent	eventHorizon	The state of the event horizon with the fixture ID to change.

SetRadius(EntityUid, Single, Boolean, EventHorizonComponent)

Setter for Radius May also update the fixture associated with the event horizon.

Declaration

public void SetRadius(EntityUid uid, float value, bool updateFixture = true, EventHorizonComponent eventHorizon = null)

Parameters

Type	Name	Description
EntityUid	uid	The uid of the event horizon to change the radius of.
System.Single	value	The new radius of the event horizon.
System.Boolean	updateFixture	Whether to update the associated fixture upon changing the radius of the event horizon.
EventHorizonComponent	eventHorizon	The state of the event horizon to change the radius of.

Shutdown()

Declaration

public override void Shutdown()

UpdateEventHorizonFixture(EntityUid, FixturesComponent, EventHorizonComponent)

Updates the state of the fixture associated with the event horizon.

Declaration

public void UpdateEventHorizonFixture(EntityUid uid, FixturesComponent fixtures = null, EventHorizonComponent eventHorizon = null)

Parameters

Type	Name	Description
EntityUid	uid	The uid of the event horizon associated with the fixture to update.
Robust.Shared.Physics.FixturesComponent	fixtures	The fixture manager component containing the fixture to update.
EventHorizonComponent	eventHorizon	The state of the event horizon associated with the fixture to update.