Skip to content

Game.UI.InGame.JournalPanel

Assembly: Assembly-CSharp
Namespace: Game.UI.InGame

Type: public class

Base: GamePanel

Summary:
JournalPanel is a lightweight UI panel class representing the in-game journal panel. It only customizes the panel's layout position by overriding the base class position property to anchor this panel to the right side of the screen. This class is intended to be used by the game's UI system; modders can derive from it to add or change behavior and appearance.

Fields

  • (none declared)
    No private or public fields are defined in JournalPanel; it relies on functionality inherited from GamePanel.

Properties

  • public override LayoutPosition position => LayoutPosition.Right;
    Overrides the base GamePanel position to return LayoutPosition.Right. This tells the UI layout system to place this panel on the right side of the screen. To change placement, derive from JournalPanel and override this property to return a different LayoutPosition.

Constructors

  • (implicit) public JournalPanel()
    No explicit constructor is declared. The default parameterless constructor is used (inherited behavior). Any initialization logic should be added by overriding lifecycle methods from GamePanel (for example, OnCreate, OnEnable, etc.) in a derived class.

Methods

  • (no additional methods)
    JournalPanel does not declare its own methods. It inherits lifecycle and behavior methods from GamePanel. For custom behavior, override the appropriate protected methods from GamePanel, such as OnCreate, OnEnable, OnDisable, or Update-like hooks provided by the UI framework.

Usage Example

// Simple usage: read position (will be LayoutPosition.Right)
var journal = new JournalPanel();
var pos = journal.position; // LayoutPosition.Right

// Example: deriving to customize initialization or change position
public class MyCustomJournalPanel : JournalPanel
{
    public override LayoutPosition position => LayoutPosition.Left; // move to left

    protected override void OnCreate()
    {
        base.OnCreate();
        // custom initialization (add controls, bind events, etc.)
    }
}