Class LogViewerScene

Namespace

Gloam.Runtime.Scenes

Assembly

Gloam.Runtime.dll

Log viewer scene that displays scrolling log messages

public sealed class LogViewerScene : BaseScene, IScene

Inheritance

object

BaseScene

LogViewerScene

Implements

IScene

Inherited Members

BaseScene.Name

BaseScene.Layers

BaseScene.IsActive

BaseScene.OnActivateAsync(CancellationToken)

BaseScene.OnDeactivateAsync(CancellationToken)

BaseScene.UpdateAsync(CancellationToken)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

LogViewerScene()

public LogViewerScene()

Methods

ActivateSceneAsync(CancellationToken)

Override this method to implement scene-specific activation logic. Default implementation does nothing.

protected override ValueTask ActivateSceneAsync(CancellationToken ct = default)

Parameters

ct CancellationToken

Cancellation token

Returns

ValueTask

AddLogMessage(string)

Adds a new log message to the list

public void AddLogMessage(string message)

Parameters

message string

DeactivateSceneAsync(CancellationToken)

Override this method to implement scene-specific deactivation logic. Default implementation does nothing.

protected override ValueTask DeactivateSceneAsync(CancellationToken ct = default)

Parameters

ct CancellationToken

Cancellation token

Returns

ValueTask

GetTotalMessageCount()

Gets the total number of log messages

public int GetTotalMessageCount()

Returns

int

GetVisibleMessages(int)

Gets the visible log messages (last N messages)

public IReadOnlyList<string> GetVisibleMessages(int maxVisibleLines)

Parameters

maxVisibleLines int

Maximum number of lines to display

Returns

IReadOnlyList<string>

HandleInputAsync(RenderLayerContext, CancellationToken)

Handles input for the log viewer

public ValueTask HandleInputAsync(RenderLayerContext context, CancellationToken ct = default)

Parameters

context RenderLayerContext

ct CancellationToken

Returns

ValueTask

SetSceneManager(ISceneManager)

public void SetSceneManager(ISceneManager sceneManager)

Parameters

sceneManager ISceneManager

UpdateSceneAsync(CancellationToken)

Override this method to implement scene-specific update logic. Default implementation does nothing.

protected override ValueTask UpdateSceneAsync(CancellationToken ct = default)

Parameters

ct CancellationToken

Cancellation token

Returns

ValueTask