Interface ILoginAutomation

Namespace

AcDream.Plugin.Abstractions

Assembly

AcDream.Plugin.Abstractions.dll

The account's character list and the client's own logout. A host that has not bound this surface answers every call as unavailable.

public interface ILoginAutomation

Properties

CanRequestLogout

Whether a logout would be accepted right now. False when there is no in-world session, and while a teleport, portal entry or an earlier logout is still in flight.

bool CanRequestLogout { get; }

Property Value

bool

IsAvailable

Whether this surface is bound to a live session. False on a host that does not offer it.

bool IsAvailable { get; }

Property Value

bool

NextLoginObjectId

The character the client will log in next, or 0 when none has been chosen.

uint NextLoginObjectId { get; }

Property Value

uint

Methods

CaptureRoster()

The account's characters, in list order. Empty before the server has sent the list, and on a host that does not offer this surface.

IReadOnlyList<PluginLoginCharacter> CaptureRoster()

Returns

IReadOnlyList<PluginLoginCharacter>

ClearNextLogin()

Forgets the chosen next character. Returns false when none was chosen or there is no session to tell.

bool ClearNextLogin()

Returns

bool

Logout()

The client's own graceful logout: the same route the UI's logout control uses. Forwards to RequestLogout(); returns false when there is no in-world session to log out of.

bool Logout()

Returns

bool

RequestLogout()

Asks the client to log the character out. Returns true when the request was sent -- not that it has completed -- and false in every case CanRequestLogout is false.

bool RequestLogout()

Returns

bool

SetNextLogin(uint)

Chooses which character the client logs in next. Returns false when the id is not on the account's list or there is no session to tell.

bool SetNextLogin(uint characterObjectId)

Parameters

characterObjectId uint

Returns

bool