Show / Hide Table of Contents

Class PlayerSpawnCompleteEvent

Event raised both directed and broadcast when a player has been spawned by the GameTicker. You can use this to handle people late-joining, or to handle people being spawned at round start. Can be used to give random players a role, modify their equipment, etc.

Inheritance
System.Object
PlayerSpawnCompleteEvent
Namespace: Content.Server.GameTicking
Assembly: Content.Server.dll
Syntax
public sealed class PlayerSpawnCompleteEvent : EntityEventArgs

Constructors

| Improve this Doc View Source

PlayerSpawnCompleteEvent(EntityUid, IPlayerSession, Nullable<String>, Boolean, Int32, EntityUid, HumanoidCharacterProfile)

Declaration
public PlayerSpawnCompleteEvent(EntityUid mob, IPlayerSession player, string? jobId, bool lateJoin, int joinOrder, EntityUid station, HumanoidCharacterProfile profile)
Parameters
Type Name Description
EntityUid mob
Robust.Server.Player.IPlayerSession player
System.Nullable<System.String> jobId
System.Boolean lateJoin
System.Int32 joinOrder
EntityUid station
HumanoidCharacterProfile profile

Properties

| Improve this Doc View Source

JobId

Declaration
public string? JobId { get; }
Property Value
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

JoinOrder

Declaration
public int JoinOrder { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

LateJoin

Declaration
public bool LateJoin { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Mob

Declaration
public EntityUid Mob { get; }
Property Value
Type Description
EntityUid
| Improve this Doc View Source

Player

Declaration
public IPlayerSession Player { get; }
Property Value
Type Description
Robust.Server.Player.IPlayerSession
| Improve this Doc View Source

Profile

Declaration
public HumanoidCharacterProfile Profile { get; }
Property Value
Type Description
HumanoidCharacterProfile
| Improve this Doc View Source

Station

Declaration
public EntityUid Station { get; }
Property Value
Type Description
EntityUid
  • Improve this Doc
  • View Source
☀
☾
In This Article
Back to top
Generated by DocFX
☀
☾