Class BaseEui
Base class to implement server-side for an EUI.
Inheritance
System.Object
BaseEui
Namespace: Content.Server.EUI
Assembly: Content.Server.dll
Syntax
public abstract class BaseEui : objectRemarks
An EUI is a system for making a relatively-easy connection between client and server for the purposes of UIs.
Properties
| Improve this Doc View SourceId
Declaration
public uint Id { get; }Property Value
| Type | Description |
|---|---|
| System.UInt32 |
IsShutDown
Declaration
public bool IsShutDown { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Manager
Declaration
public EuiManager Manager { get; }Property Value
| Type | Description |
|---|---|
| EuiManager |
Player
The player that this EUI is open for.
Declaration
public ICommonSession Player { get; }Property Value
| Type | Description |
|---|---|
| Robust.Shared.Players.ICommonSession |
Methods
| Improve this Doc View SourceClose()
Close the EUI, breaking the connection between client and server.
Declaration
public void Close()Closed()
Called when the UI has been closed.
Declaration
public virtual void Closed()GetNewState()
Called some time after StateDirty() has been called to get a new UI state that can be sent to the client.
Declaration
public virtual EuiStateBase GetNewState()Returns
| Type | Description |
|---|---|
| EuiStateBase |
HandleMessage(EuiMessageBase)
Called when a message comes in from the client.
Declaration
public virtual void HandleMessage(EuiMessageBase msg)Parameters
| Type | Name | Description |
|---|---|---|
| EuiMessageBase | msg |
Opened()
Called when the UI has been opened. Do initializing logic here.
Declaration
public virtual void Opened()SendMessage(EuiMessageBase)
Send a message to the client-side EUI.
Declaration
public void SendMessage(EuiMessageBase message)Parameters
| Type | Name | Description |
|---|---|---|
| EuiMessageBase | message |
StateDirty()
Mark the current UI state as dirty and queue for an update.
Declaration
public void StateDirty()