Interface IAllegianceAutomation

Namespace

AcDream.Plugin.Abstractions

Assembly

AcDream.Plugin.Abstractions.dll

Reads authoritative allegiance state, and sends the two allegiance commands the client's own social panel sends. Everything read here is the state the server last told the client; a command only asks, it does not decide.

public interface IAllegianceAutomation

Properties

IsAvailable

True when the host is tracking allegiance state.

bool IsAvailable { get; }

Property Value

bool

Snapshot

The latest normalized allegiance snapshot.

PluginAllegianceSnapshot Snapshot { get; }

Property Value

PluginAllegianceSnapshot

Methods

Break(uint)

Asks the server to break the tie between the character and someone in its allegiance -- its patron, or one of its vassals. The target has to be someone the client has been told is in that allegiance; it does not have to be nearby, or even logged in.

PluginAllegianceCommandResult Break(uint targetObjectId)

Parameters

targetObjectId uint

The patron or vassal to break from.

Returns

PluginAllegianceCommandResult

Sent once it is on its way, InvalidTarget when that character is not in the allegiance, Refused when the client would not send it for a reason that is not about the target, and Unavailable off-world.

Swear(uint)

Asks the server to pledge the character to another player as its patron. The patron has to be a player the client can currently see, which is what the client's own panel requires as well: swearing is done face to face.

PluginAllegianceCommandResult Swear(uint patronObjectId)

Parameters

patronObjectId uint

The player to swear to.

Returns

PluginAllegianceCommandResult

Sent once it is on its way, InvalidTarget when that is not a player standing there, Refused when the client would not send it for a reason that is not about the target, and Unavailable off-world.