Class UIUtils

Inheritance

System.Object

UIUtils

Namespace: Eco.Gameplay.Players

Assembly: Eco.Gameplay.dll

Syntax

public static class UIUtils : Object

Fields

SharedIdBsonKey

Declaration

public const string SharedIdBsonKey = "instance"

Field Value

Type	Description
System.String

Methods

CloseUI(Player, IController, String)

Declaration

public static void CloseUI(this Player player, IController ui, string uiName)

Parameters

Type	Name	Description
Player	player
IController	ui
System.String	uiName

CloseUIForAllPlayers(IPlayerUseTracking, String, Boolean, Func<Player, BSONObject>)

Tell every user we've tracked as using this thing to Close the given UI, passing the given bson (for specifying the instance etc)

Declaration

public static void CloseUIForAllPlayers(this IPlayerUseTracking tracker, string uiName, bool killCache, Func<Player, BSONObject> makeBson = null)

Parameters

Type	Name	Description
IPlayerUseTracking	tracker
System.String	uiName
System.Boolean	killCache
System.Func<Player, BSONObject>	makeBson

OpenUI(Player, IController, String, String)

Declaration

public static void OpenUI(this Player player, IController ui, string uiName, string customKey = "UI")

Parameters

Type	Name	Description
Player	player
IController	ui
System.String	uiName
System.String	customKey