Class PortalComponent

Marks an entity as being a 'portal' which teleports entities sent through it to linked entities. Relies on LinkedEntityComponent being set up.

Inheritance

System.Object

PortalComponent

Namespace: Content.Shared.Teleportation.Components

Assembly: Content.Shared.dll

Syntax

public sealed class PortalComponent : Component

Fields

ArrivalSound

Sound played on arriving to this portal, centered on the destination. The arrival sound of the entered portal will play if the destination is not a portal.

Declaration

public SoundSpecifier ArrivalSound

Field Value

Type	Description
Robust.Shared.Audio.SoundSpecifier

CanTeleportToOtherMaps

If false, this portal will fail to teleport and fizzle out if attempting to send an entity to a different map

Declaration

public bool CanTeleportToOtherMaps

Field Value

Type	Description
System.Boolean

Remarks

Shouldn't be able to teleport people to centcomm or the eshuttle from the station

DepartureSound

Sound played on departing from this portal, centered on the original portal.

Declaration

public SoundSpecifier DepartureSound

Field Value

Type	Description
Robust.Shared.Audio.SoundSpecifier

MaxRandomRadius

If no portals are linked, the subject will be teleported a random distance at maximum this far away.

Declaration

public float MaxRandomRadius

Field Value

Type	Description
System.Single

MaxTeleportRadius

Maximum distance that portals can teleport to, in all cases. Mostly this matters for linked portals. Null means no restriction on distance.

Declaration

public float? MaxTeleportRadius

Field Value

Type	Description
System.Nullable<System.Single>

Remarks

Obviously this should strictly be larger than MaxRandomRadius (or null)