Show / Hide Table of Contents

Class ReagentDispenserWindow

Client-side UI used to control a .

Inheritance
System.Object
Robust.Client.UserInterface.Control
Robust.Client.UserInterface.CustomControls.BaseWindow
Robust.Client.UserInterface.CustomControls.DefaultWindow
ReagentDispenserWindow
Namespace: Content.Client.Chemistry.UI
Assembly: Content.Client.dll
Syntax
public sealed class ReagentDispenserWindow : DefaultWindow

Constructors

| Improve this Doc View Source

ReagentDispenserWindow()

Create and initialize the dispenser UI client-side. Creates the basic layout, actual data isn't filled in until the server sends data about the dispenser.

Declaration
public ReagentDispenserWindow()

Methods

| Improve this Doc View Source

UpdateContainerInfo(ReagentDispenserBoundUserInterfaceState, Nullable<ReagentId>)

Update the fill state and list of reagents held by the current reagent container, if applicable.

Also highlights a reagent if it's dispense button is being mouse hovered.

Declaration
public void UpdateContainerInfo(ReagentDispenserBoundUserInterfaceState state, ReagentId? highlightedReagentId = null)
Parameters
Type Name Description
ReagentDispenserBoundUserInterfaceState state

State data for the dispenser.

System.Nullable<ReagentId> highlightedReagentId

Prototype ID of the reagent whose dispense button is currently being mouse hovered, or null if no button is being hovered.

| Improve this Doc View Source

UpdateReagentsList(List<ReagentId>)

Update the button grid of reagents which can be dispensed.

Declaration
public void UpdateReagentsList(List<ReagentId> inventory)
Parameters
Type Name Description
List<ReagentId> inventory

Reagents which can be dispensed by this dispenser

| Improve this Doc View Source

UpdateState(BoundUserInterfaceState)

Update the UI state when new state data is received from the server.

Declaration
public void UpdateState(BoundUserInterfaceState state)
Parameters
Type Name Description
BoundUserInterfaceState state

State data sent by the server.

Events

| Improve this Doc View Source

OnDispenseReagentButtonMouseEntered

Declaration
public event Action<GUIMouseHoverEventArgs, DispenseReagentButton>? OnDispenseReagentButtonMouseEntered
Event Type
Type Description
System.Nullable<Action<Robust.Client.UserInterface.GUIMouseHoverEventArgs, DispenseReagentButton>>
| Improve this Doc View Source

OnDispenseReagentButtonMouseExited

Declaration
public event Action<GUIMouseHoverEventArgs, DispenseReagentButton>? OnDispenseReagentButtonMouseExited
Event Type
Type Description
System.Nullable<Action<Robust.Client.UserInterface.GUIMouseHoverEventArgs, DispenseReagentButton>>
| Improve this Doc View Source

OnDispenseReagentButtonPressed

Declaration
public event Action<BaseButton.ButtonEventArgs, DispenseReagentButton>? OnDispenseReagentButtonPressed
Event Type
Type Description
System.Nullable<Action<Robust.Client.UserInterface.Controls.BaseButton.ButtonEventArgs, DispenseReagentButton>>

Extension Methods

ControlExtension.GetControlOfType<T>(Control)
ControlExtension.GetControlOfType<T>(Control, String)
ControlExtension.GetControlOfType<T>(Control, Boolean)
ControlExtension.GetControlOfType<T>(Control, String, Boolean)
ControlExtension.GetSearchableControls(Control, Boolean)
ControlExtension.ChildrenContainText(Control, String)
  • Improve this Doc
  • View Source
☀
☾
In This Article
Back to top
Generated by DocFX
☀
☾