Class SharedPopupSystem

System for displaying small text popups on users' screens.

Inheritance

System.Object

SharedPopupSystem

PopupSystem

PopupSystem

Namespace: Content.Shared.Popups

Assembly: Content.Shared.dll

Syntax

public abstract class SharedPopupSystem : EntitySystem

Methods

PopupClient(String, EntityUid, EntityUid, PopupType)

Variant of that only runs on the client, outside of prediction. Useful for shared code that is always ran by both sides to avoid duplicate popups.

Declaration

public abstract void PopupClient(string message, EntityUid uid, EntityUid recipient, PopupType type = PopupType.Small)

Parameters

Type	Name	Description
System.String	message
EntityUid	uid
EntityUid	recipient
PopupType	type

PopupCoordinates(String, EntityCoordinates, PopupType)

Shows a popup at a world location to every entity in PVS range.

Declaration

public abstract void PopupCoordinates(string message, EntityCoordinates coordinates, PopupType type = PopupType.Small)

Parameters

Type	Name	Description
System.String	message	The message to display.
Robust.Shared.Map.EntityCoordinates	coordinates	The coordinates where to display the message.
PopupType	type	Used to customize how this popup should appear visually.

PopupCoordinates(String, EntityCoordinates, EntityUid, PopupType)

Variant of PopupCoordinates(String, EntityCoordinates, PopupType) that sends a pop-up to the player attached to some entity.

Declaration

public abstract void PopupCoordinates(string message, EntityCoordinates coordinates, EntityUid recipient, PopupType type = PopupType.Small)

Parameters

Type	Name	Description
System.String	message
Robust.Shared.Map.EntityCoordinates	coordinates
EntityUid	recipient
PopupType	type

PopupCoordinates(String, EntityCoordinates, Filter, Boolean, PopupType)

Filtered variant of PopupCoordinates(String, EntityCoordinates, PopupType), which should only be used if the filtering has to be more specific than simply PVS range based.

Declaration

public abstract void PopupCoordinates(string message, EntityCoordinates coordinates, Filter filter, bool recordReplay, PopupType type = PopupType.Small)

Parameters

Type	Name	Description
System.String	message
Robust.Shared.Map.EntityCoordinates	coordinates
Robust.Shared.Player.Filter	filter	Filter for the players that will see the popup.
System.Boolean	recordReplay	If true, this pop-up will be considered as a globally visible pop-up that gets shown during replays.
PopupType	type

PopupCoordinates(String, EntityCoordinates, ICommonSession, PopupType)

Variant of PopupCoordinates(String, EntityCoordinates, PopupType) that sends a pop-up to a specific player.

Declaration

public abstract void PopupCoordinates(string message, EntityCoordinates coordinates, ICommonSession recipient, PopupType type = PopupType.Small)

Parameters

Type	Name	Description
System.String	message
Robust.Shared.Map.EntityCoordinates	coordinates
Robust.Shared.Players.ICommonSession	recipient
PopupType	type

PopupCursor(String, PopupType)

Shows a popup at the local users' cursor. Does nothing on the server.

Declaration

public abstract void PopupCursor(string message, PopupType type = PopupType.Small)

Parameters

Type	Name	Description
System.String	message	The message to display.
PopupType	type	Used to customize how this popup should appear visually.

PopupCursor(String, EntityUid, PopupType)

Shows a popup at a users' cursor.

Declaration

public abstract void PopupCursor(string message, EntityUid recipient, PopupType type = PopupType.Small)

Parameters

Type	Name	Description
System.String	message	The message to display.
EntityUid	recipient	Client that will see this popup.
PopupType	type	Used to customize how this popup should appear visually.

PopupCursor(String, ICommonSession, PopupType)

Shows a popup at a users' cursor.

Declaration

public abstract void PopupCursor(string message, ICommonSession recipient, PopupType type = PopupType.Small)

Parameters

Type	Name	Description
System.String	message	The message to display.
Robust.Shared.Players.ICommonSession	recipient	Client that will see this popup.
PopupType	type	Used to customize how this popup should appear visually.

PopupEntity(String, EntityUid, PopupType)

Shows a popup above an entity for every player in pvs range.

Declaration

public abstract void PopupEntity(string message, EntityUid uid, PopupType type = PopupType.Small)

Parameters

Type	Name	Description
System.String	message	The message to display.
EntityUid	uid	The UID of the entity.
PopupType	type	Used to customize how this popup should appear visually.

PopupEntity(String, EntityUid, EntityUid, PopupType)

Variant of PopupEntity(String, EntityUid, PopupType) that shows the popup only to some specific client.

Declaration

public abstract void PopupEntity(string message, EntityUid uid, EntityUid recipient, PopupType type = PopupType.Small)

Parameters

Type	Name	Description
System.String	message
EntityUid	uid
EntityUid	recipient
PopupType	type

PopupEntity(String, EntityUid, Filter, Boolean, PopupType)

Filtered variant of PopupEntity(String, EntityUid, PopupType), which should only be used if the filtering has to be more specific than simply PVS range based.

Declaration

public abstract void PopupEntity(string message, EntityUid uid, Filter filter, bool recordReplay, PopupType type = PopupType.Small)

Parameters

Type	Name	Description
System.String	message
EntityUid	uid
Robust.Shared.Player.Filter	filter
System.Boolean	recordReplay
PopupType	type

PopupEntity(String, EntityUid, ICommonSession, PopupType)

Variant of PopupEntity(String, EntityUid, PopupType) that shows the popup only to some specific client.

Declaration

public abstract void PopupEntity(string message, EntityUid uid, ICommonSession recipient, PopupType type = PopupType.Small)

Parameters

Type	Name	Description
System.String	message
EntityUid	uid
Robust.Shared.Players.ICommonSession	recipient
PopupType	type