Struct PluginNetworkClient

Namespace

AcDream.Plugin.Abstractions

Assembly

AcDream.Plugin.Abstractions.dll

What one other client running on this same computer last published about itself, so plugins can coordinate several characters played side by side.

public readonly record struct PluginNetworkClient : IEquatable<PluginNetworkClient>

Implements

IEquatable<PluginNetworkClient>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

PluginNetworkClient(uint, uint, string, string, PluginNavigationPosition, IReadOnlyList<string>, uint, uint, uint, uint, uint, uint, float)

What one other client running on this same computer last published about itself, so plugins can coordinate several characters played side by side.

public PluginNetworkClient(uint ClientId, uint PlayerId, string Name, string WorldName, PluginNavigationPosition Position, IReadOnlyList<string> Tags, uint CurrentHealth, uint CurrentMana, uint CurrentStamina, uint MaxHealth, uint MaxMana, uint MaxStamina, float Heading)

Parameters

ClientId uint

A stable non-zero number identifying the publishing client instance for as long as it runs.

PlayerId uint

That client's character object id.

Name string

That client's character name.

WorldName string

The world that client is logged in to.

Position PluginNavigationPosition

Where that character stood when it last published.

Tags IReadOnlyList<string>

Free-form labels the publishing client was started with, for example to mark the role it plays; empty when it was given none.

CurrentHealth uint

That character's current health points.

CurrentMana uint

That character's current mana points.

CurrentStamina uint

That character's current stamina points.

MaxHealth uint

That character's maximum health points.

MaxMana uint

That character's maximum mana points.

MaxStamina uint

That character's maximum stamina points.

Heading float

The direction that character faced, in degrees clockwise from north.

Properties

ClientId

A stable non-zero number identifying the publishing client instance for as long as it runs.

public uint ClientId { get; init; }

Property Value

uint

CurrentHealth

That character's current health points.

public uint CurrentHealth { get; init; }

Property Value

uint

CurrentMana

That character's current mana points.

public uint CurrentMana { get; init; }

Property Value

uint

CurrentStamina

That character's current stamina points.

public uint CurrentStamina { get; init; }

Property Value

uint

Heading

The direction that character faced, in degrees clockwise from north.

public float Heading { get; init; }

Property Value

float

IsRemote

True when this client did not read the peer from this computer but was handed it by a plugin through ImportRemoteClient(PluginNetworkClient), typically a character played on another computer. False for a client on this computer and for this client's own state.

public bool IsRemote { get; init; }

Property Value

bool

MaxHealth

That character's maximum health points.

public uint MaxHealth { get; init; }

Property Value

uint

MaxMana

That character's maximum mana points.

public uint MaxMana { get; init; }

Property Value

uint

MaxStamina

That character's maximum stamina points.

public uint MaxStamina { get; init; }

Property Value

uint

Name

That client's character name.

public string Name { get; init; }

Property Value

string

PlayerId

That client's character object id.

public uint PlayerId { get; init; }

Property Value

uint

Position

Where that character stood when it last published.

public PluginNavigationPosition Position { get; init; }

Property Value

PluginNavigationPosition

Tags

Free-form labels the publishing client was started with, for example to mark the role it plays; empty when it was given none.

public IReadOnlyList<string> Tags { get; init; }

Property Value

IReadOnlyList<string>

WorldName

The world that client is logged in to.

public string WorldName { get; init; }

Property Value

string