Class ChatHistory

Namespace

BSGameLib.Chat

Assembly

BSGameLib.Chat.dll

The lines a player has sent, for stepping back through with Up and forward with Down. What they had typed before stepping back is kept, and comes back when they step past the newest.

public sealed class ChatHistory

Inheritance

object

ChatHistory

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ChatHistory(int)

Creates a history that keeps up to most lines. A value below 1 keeps one.

public ChatHistory(int most = 100)

Parameters

most int

Properties

Count

How many lines it holds.

public int Count { get; }

Property Value

int

Methods

Add(string)

Keeps a line sent, newest last; the same line twice in a row is kept once.

public void Add(string line)

Parameters

line string

Back(string)

The line before the one shown, keeping typed when leaving what was being typed; it stays at the oldest.

public string Back(string typed)

Parameters

typed string

Returns

string

Forward(string)

The line after the one shown; past the newest, what was being typed.

public string Forward(string typed)

Parameters

typed string

Returns

string

Reset()

Stops stepping through, as typing does: the next step back starts at the newest again.

public void Reset()