Class PlayerBeforeSpawnEvent

Event raised broadcast before a player is spawned by the GameTicker. You can use this event to spawn a player off-station on late-join but also at round start. When this event is handled, the GameTicker will not perform its own player-spawning logic.

Inheritance

System.Object

PlayerBeforeSpawnEvent

Namespace: Content.Server.GameTicking

Assembly: Content.Server.dll

Syntax

public sealed class PlayerBeforeSpawnEvent : HandledEntityEventArgs

Constructors

PlayerBeforeSpawnEvent(IPlayerSession, HumanoidCharacterProfile, Nullable<String>, Boolean, EntityUid)

Declaration

public PlayerBeforeSpawnEvent(IPlayerSession player, HumanoidCharacterProfile profile, string? jobId, bool lateJoin, EntityUid station)

Parameters

Type	Name	Description
Robust.Server.Player.IPlayerSession	player
HumanoidCharacterProfile	profile
System.Nullable<System.String>	jobId
System.Boolean	lateJoin
EntityUid	station

Properties

JobId

Declaration

public string? JobId { get; }

Property Value

Type	Description
System.Nullable<System.String>

LateJoin

Declaration

public bool LateJoin { get; }

Property Value

Type	Description
System.Boolean

Player

Declaration

public IPlayerSession Player { get; }

Property Value

Type	Description
Robust.Server.Player.IPlayerSession

Profile

Declaration

public HumanoidCharacterProfile Profile { get; }

Property Value

Type	Description
HumanoidCharacterProfile

Station

Declaration

public EntityUid Station { get; }

Property Value

Type	Description
EntityUid