2022-11-08 21:00:20 +01:00
|
|
|
|
using Robust.Client.GameObjects;
|
|
|
|
|
|
using Robust.Client.UserInterface;
|
|
|
|
|
|
|
2022-12-02 17:46:58 -05:00
|
|
|
|
namespace Content.Client.UserInterface.Fragments;
|
2022-11-08 21:00:20 +01:00
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
2022-12-02 17:46:58 -05:00
|
|
|
|
/// Specific ui fragments need to inherit this class. The subclass is then used in yaml to tell a main ui to use it as a ui fragment.
|
2022-11-08 21:00:20 +01:00
|
|
|
|
/// </summary>
|
|
|
|
|
|
/// <example>
|
|
|
|
|
|
/// This is an example from the yaml definition from the notekeeper ui
|
|
|
|
|
|
/// <code>
|
|
|
|
|
|
/// - type: CartridgeUi
|
|
|
|
|
|
/// ui: !type:NotekeeperUi
|
|
|
|
|
|
/// </code>
|
|
|
|
|
|
/// </example>
|
|
|
|
|
|
[ImplicitDataDefinitionForInheritors]
|
2023-08-22 18:14:33 -07:00
|
|
|
|
public abstract partial class UIFragment
|
2022-11-08 21:00:20 +01:00
|
|
|
|
{
|
|
|
|
|
|
public abstract Control GetUIFragmentRoot();
|
|
|
|
|
|
|
2022-12-10 12:05:39 -05:00
|
|
|
|
public abstract void Setup(BoundUserInterface userInterface, EntityUid? fragmentOwner);
|
2022-11-08 21:00:20 +01:00
|
|
|
|
|
|
|
|
|
|
public abstract void UpdateState(BoundUserInterfaceState state);
|
|
|
|
|
|
|
|
|
|
|
|
}
|