Class UIUtils
Inheritance
System.Object
UIUtils
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
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
OpenUI(Player, IController, String, String, Action<BSONObject>)
Declaration
public static void OpenUI(this Player player, IController ui, string uiName, string customKey = "UI", Action<BSONObject> configureBson = null)
Parameters
| Type |
Name |
Description |
| Player |
player |
|
| IController |
ui |
|
| System.String |
uiName |
|
| System.String |
customKey |
|
| System.Action<BSONObject> |
configureBson |
|
SkipNextCacheForAllPlayers(IPlayerUseTracking, String, Func<Player, BSONObject>)
Tell every user we've tracked as using this thing to skip the next cache update for the given UI (used when adding a component, so that the next time the UI is opened it will be refreshed).
Declaration
public static void SkipNextCacheForAllPlayers(this IPlayerUseTracking tracker, string uiName, Func<Player, BSONObject> makeBson = null)
Parameters