Interface ICharacterOptionsAutomation

Namespace

AcDream.Plugin.Abstractions

Assembly

AcDream.Plugin.Abstractions.dll

The character's own options: the on/off switches of the client's character options page (accepting gifts, auto-accepting fellowship requests, main pack preferred, showing the cloak, ...), which the server keeps with the character. An option is named the way that page's settings are named, such as AllowGive or FellowshipAutoAcceptRequests, compared without regard to case; Names lists them. A host that has not bound this surface answers every call as unavailable.

public interface ICharacterOptionsAutomation

Properties

IsAvailable

Whether the character is in the world, so options can be read and changed.

bool IsAvailable { get; }

Property Value

bool

Names

Every option name this client knows, in the options' own order. Empty on a host that does not offer this surface.

IReadOnlyList<string> Names { get; }

Property Value

IReadOnlyList<string>

Methods

Set(string, bool)

Turns one option on or off through the same route the character options page uses: the client's copy changes at once, and the server is told either straight away or with the client's next save of the whole option set, depending on the option. Setting an option to the value it already has is accepted and sends nothing.

PluginCharacterOptionResult Set(string name, bool value)

Parameters

name string

value bool

Returns

PluginCharacterOptionResult

TryGet(string, out bool)

Reads one option's current value. Returns false when no option has that name or the character is not in the world.

bool TryGet(string name, out bool value)

Parameters

name string

value bool

Returns

bool