Class CampaignExtensions

Namespace

Bannerlord.ButterLib.Common.Extensions

Assembly

Bannerlord.ButterLib.dll

Helper extension of the Campaign class returning additional information, provided by the ButterLib.

public static class CampaignExtensions

Inheritance

object

CampaignExtensions

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Remarks

Contains easy accessible distance matrices for the settlements, clans and kingdoms.

Methods

GetDefaultClanDistanceMatrix(Campaign)

Gets the DistanceMatrix<T> calculated by default for the Clan object type.

public static DistanceMatrix<Clan>? GetDefaultClanDistanceMatrix(this Campaign campaign)

Parameters

campaign Campaign

The campaign

Returns

DistanceMatrix<Clan>

Distance matrix for all the active clans of the current campaign, or null if the campaign has not started yet.

Remarks

Calculation is based on the average distance between clans fiefs weighted by the fief type.

GetDefaultKingdomDistanceMatrix(Campaign)

Gets the DistanceMatrix<T> calculated by default for the Kingdom object type.

public static DistanceMatrix<Kingdom>? GetDefaultKingdomDistanceMatrix(this Campaign campaign)

Parameters

campaign Campaign

The campaign

Returns

DistanceMatrix<Kingdom>

Distance matrix for all the active kingdoms of the current campaign, or null if the campaign has not started yet.

Remarks

Calculation is based on the average distance between kingdoms fiefs weighted by the fief type.

GetDefaultSettlementDistanceMatrix(Campaign)

Gets the DistanceMatrix<T> calculated by default for the Settlement object type.

public static DistanceMatrix<Settlement>? GetDefaultSettlementDistanceMatrix(this Campaign campaign)

Parameters

campaign Campaign

The campaign

Returns

DistanceMatrix<Settlement>

Distance matrix for all the towns, castles and villages of the current campaign, or null if the campaign has not started yet.