Class TerminalUser

Namespace

Uncreated.Warfare.Interaction.Commands

Assembly

Uncreated.Warfare.dll

[CannotApplyEqualityOperator]
public class TerminalUser : ICommandUser

Inheritance

object

TerminalUser

Implements

ICommandUser

Inherited Members

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Constructors

TerminalUser(ILogger)

public TerminalUser(ILogger logger)

Parameters

logger ILogger

Properties

IMGUI

If SendMessage(string) should use IMGUI (Unity rich text) for coloring.

public bool IMGUI { get; }

Property Value

bool

Instance

public static TerminalUser Instance { get; }

Property Value

TerminalUser

IsDisconnected

If this user is disconnected from the server.

public bool IsDisconnected { get; }

Property Value

bool

Remarks

Return false if not supported.

IsSuperUser

If permissions shouldn't even be considered for this actor (the console).

public bool IsSuperUser { get; }

Property Value

bool

IsTerminal

If SendMessage(string) outputs to a terminal.

public bool IsTerminal { get; }

Property Value

bool

Steam64

Steam ID of this actor where applicable, or zero.

public CSteamID Steam64 { get; }

Property Value

CSteamID

Methods

Equals(object?)

Determines whether the specified object is equal to the current object.

public override bool Equals(object? obj)

Parameters

obj object

The object to compare with the current object.

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

GetModerationActor()

Create an IModerationActor for this command actor.

public IModerationActor GetModerationActor()

Returns

IModerationActor

Exceptions

NotSupportedException

SendMessage(string)

Send a raw string as feedback to this actor.

public void SendMessage(string message)

Parameters

message string

Exceptions

GameThreadException

Not on main thread.

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.