M&B: Bannerlord 1.3.4
The horns sound, the ravens gather.
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Member Functions | Properties | List of all members
TaleWorlds.CampaignSystem.Clan Class Referencesealed

A Faction Object.

Inherits TaleWorlds.ObjectSystem.MBObjectBase, and TaleWorlds.CampaignSystem.IFaction.

Public Member Functions

void UpdateFactionsAtWarWith ()
 
void UpdateCurrentStrength ()
 
bool IsAtWarWith (IFaction other)
 
 Clan ()
 
override void Deserialize (MBObjectManager objectManager, XmlNode node)
 De-serializes the object from an XmlNode.
 
int GetRelationWithClan (Clan other)
 
void SetLeader (Hero leader)
 
void SetInitialHomeSettlement (Settlement initialHomeSettlement)
 
void ConsiderAndUpdateHomeSettlement ()
 
override TextObject GetName ()
 
void ChangeClanName (TextObject name, TextObject informalName)
 
override string ToString ()
 
StanceLink GetStanceWith (IFaction other)
 
void ClanLeaveKingdom (bool giveBackFiefs=false)
 
float CalculateTotalSettlementBaseValue ()
 
void StartMercenaryService ()
 
void ResetPlayerHomeAndFactionMidSettlement ()
 
void EndMercenaryService (bool isByLeavingKingdom)
 
float CalculateTotalSettlementValueForFaction (Kingdom kingdom)
 
void OnHeroChangedState (Hero hero, Hero.CharacterStates oldState)
 
void AddRenown (float value, bool shouldNotify=true)
 
void ResetClanRenown ()
 
void OnSupportedByClan (Clan supporterClan)
 
void CalculateMidSettlement ()
 
Dictionary< Hero, int > GetHeirApparents ()
 
void UpdateBannerColor (uint backgroundColor, uint iconColor)
 
- Public Member Functions inherited from TaleWorlds.ObjectSystem.MBObjectBase
 MBObjectBase ()
 
 MBObjectBase (MBObjectBase other)
 
 MBObjectBase (string stringId)
 
void AfterInitialized ()
 
virtual void AfterRegister ()
 
virtual void Initialize ()
 
override int GetHashCode ()
 
void PreAfterLoadInternal ()
 
void AfterLoadInternal ()
 
void OnRegistered ()
 
void OnUnregistered ()
 

Static Public Member Functions

static Clan CreateClan (string stringID)
 
static Clan FindFirst (Predicate< Clan > predicate)
 
static IEnumerable< Clan > FindAll (Predicate< Clan > predicate)
 
static Clan CreateSettlementRebelClan (Settlement settlement, Hero owner, int iconMeshId=-1)
 
static Clan CreateCompanionToLordClan (Hero hero, Settlement settlement, TextObject clanName, int newClanIconId)
 

Protected Member Functions

override void PreAfterLoad ()
 
override void AfterLoad ()
 
override void OnBeforeLoad ()
 

Properties

TextObject Name [get]
 
TextObject InformalName [get]
 
CultureObject Culture [get, set]
 
CampaignTime LastFactionChangeTime [get, set]
 
PartyTemplateObject DefaultPartyTemplate [get]
 
bool HasNavalNavigationCapability [get]
 
int AutoRecruitmentExpenses [get, set]
 
TextObject EncyclopediaText [get]
 
bool IsNoble [get, set]
 
bool IsEliminated [get]
 
IList< CharacterObject > MinorFactionCharacterTemplates [get]
 
string EncyclopediaLink [get]
 
TextObject EncyclopediaLinkWithName [get]
 
Kingdom Kingdom [get, set]
 Gets kingdom of this clan.
 
IEnumerable< CharacterObject > DungeonPrisonersOfClan [get]
 
MBReadOnlyList< Town > Fiefs [get]
 
MBReadOnlyList< Village > Villages [get]
 
MBReadOnlyList< Settlement > Settlements [get]
 
MBReadOnlyList< Hero > SupporterNotables [get]
 
MBReadOnlyList< Hero > AliveLords [get]
 
MBReadOnlyList< Hero > DeadLords [get]
 
MBReadOnlyList< Hero > Heroes [get]
 
MBReadOnlyList< Hero > Companions [get]
 
MBReadOnlyList< WarPartyComponent > WarPartyComponents [get]
 
float Influence [get, set]
 
ExplainedNumber InfluenceChangeExplained [get]
 
float CurrentTotalStrength [get]
 
int MercenaryAwardMultiplier [get, set]
 
bool IsMapFaction [get]
 
Settlement InitialHomeSettlement [get]
 Point to spawn around if no settlement remained.
 
bool IsRebelClan [get, set]
 
bool IsMinorFaction [get]
 
bool IsOutlaw [get]
 
bool IsNomad [get]
 
bool IsMafia [get]
 
bool IsClanTypeMercenary [get]
 
bool IsSect [get]
 
bool IsUnderMercenaryService [get]
 
CampaignTime ShouldStayInKingdomUntil [get, set]
 
uint Color [get, set]
 Primary color.
 
uint Color2 [get, set]
 Secondary color.
 
Settlement FactionMidSettlement [get]
 
CharacterObject BasicTroop [get, set]
 
static Clan PlayerClan [get]
 
Hero Leader [get]
 
int Gold [get]
 
Banner Banner [get, set]
 
Banner ClanOriginalBanner [get]
 
bool IsBanditFaction [get]
 
bool IsClan [get]
 
float Renown [get, set]
 
float MainHeroCrimeRating [get, set]
 
float DailyCrimeRatingChange [get]
 
ExplainedNumber DailyCrimeRatingChangeExplained [get]
 
int Tier [get]
 
IFaction MapFaction [get]
 
CampaignTime NotAttackableByPlayerUntilTime [get, set]
 
float Aggressiveness [get]
 Kingdom Aggressiveness between 0 and 100 This is used for AI in evaluating peace offers and war proposals A kingdom with high aggressiveness can be declared war at without penalty.
 
int TributeWallet [get, set]
 Gold for spending on tributes. Can be negative which means tribute debt.

 
Settlement HomeSettlement [get]
 
int DebtToKingdom [get, set]
 
MBReadOnlyList< IFaction > FactionsAtWarWith [get]
 
int RenownRequirementForNextTier [get]
 
int CompanionLimit [get]
 
float DistanceToClosestNonAllyFortification [get]
 
int CommanderLimit [get]
 
static MBReadOnlyList< Clan > All [get]
 
static IEnumerable< Clan > NonBanditFactions [get]
 
static IEnumerable< Clan > BanditFactions [get]
 
- Properties inherited from TaleWorlds.ObjectSystem.MBObjectBase
string StringId [get, set]
 
MBGUID Id [get, set]
 
bool IsInitialized [get]
 
bool IsReady [get, set]
 
- Properties inherited from TaleWorlds.CampaignSystem.IFaction
string StringId [get]
 
MBGUID Id [get]
 

Constructor & Destructor Documentation

◆ Clan()

TaleWorlds.CampaignSystem.Clan.Clan ( )

Member Function Documentation

◆ UpdateFactionsAtWarWith()

void TaleWorlds.CampaignSystem.Clan.UpdateFactionsAtWarWith ( )

Implements TaleWorlds.CampaignSystem.IFaction.

◆ UpdateCurrentStrength()

void TaleWorlds.CampaignSystem.Clan.UpdateCurrentStrength ( )

◆ IsAtWarWith()

bool TaleWorlds.CampaignSystem.Clan.IsAtWarWith ( IFaction other)

Implements TaleWorlds.CampaignSystem.IFaction.

◆ CreateClan()

static Clan TaleWorlds.CampaignSystem.Clan.CreateClan ( string stringID)
static

◆ PreAfterLoad()

override void TaleWorlds.CampaignSystem.Clan.PreAfterLoad ( )
protectedvirtual

Reimplemented from TaleWorlds.ObjectSystem.MBObjectBase.

◆ AfterLoad()

override void TaleWorlds.CampaignSystem.Clan.AfterLoad ( )
protectedvirtual

Reimplemented from TaleWorlds.ObjectSystem.MBObjectBase.

◆ Deserialize()

override void TaleWorlds.CampaignSystem.Clan.Deserialize ( MBObjectManager objectManager,
XmlNode node )
virtual
Parameters
objectManagerObject manager
nodeXmlNode to be de-serialized from.

Reimplemented from TaleWorlds.ObjectSystem.MBObjectBase.

◆ OnBeforeLoad()

override void TaleWorlds.CampaignSystem.Clan.OnBeforeLoad ( )
protectedvirtual

Reimplemented from TaleWorlds.ObjectSystem.MBObjectBase.

◆ GetRelationWithClan()

int TaleWorlds.CampaignSystem.Clan.GetRelationWithClan ( Clan other)

◆ SetLeader()

void TaleWorlds.CampaignSystem.Clan.SetLeader ( Hero leader)

◆ SetInitialHomeSettlement()

void TaleWorlds.CampaignSystem.Clan.SetInitialHomeSettlement ( Settlement initialHomeSettlement)

◆ ConsiderAndUpdateHomeSettlement()

void TaleWorlds.CampaignSystem.Clan.ConsiderAndUpdateHomeSettlement ( )

◆ GetName()

override TextObject TaleWorlds.CampaignSystem.Clan.GetName ( )
virtual

Reimplemented from TaleWorlds.ObjectSystem.MBObjectBase.

◆ ChangeClanName()

void TaleWorlds.CampaignSystem.Clan.ChangeClanName ( TextObject name,
TextObject informalName )

◆ ToString()

override string TaleWorlds.CampaignSystem.Clan.ToString ( )

◆ GetStanceWith()

StanceLink TaleWorlds.CampaignSystem.Clan.GetStanceWith ( IFaction other)

Implements TaleWorlds.CampaignSystem.IFaction.

◆ ClanLeaveKingdom()

void TaleWorlds.CampaignSystem.Clan.ClanLeaveKingdom ( bool giveBackFiefs = false)

◆ CalculateTotalSettlementBaseValue()

float TaleWorlds.CampaignSystem.Clan.CalculateTotalSettlementBaseValue ( )

◆ StartMercenaryService()

void TaleWorlds.CampaignSystem.Clan.StartMercenaryService ( )

◆ ResetPlayerHomeAndFactionMidSettlement()

void TaleWorlds.CampaignSystem.Clan.ResetPlayerHomeAndFactionMidSettlement ( )

◆ FindFirst()

static Clan TaleWorlds.CampaignSystem.Clan.FindFirst ( Predicate< Clan > predicate)
static

◆ EndMercenaryService()

void TaleWorlds.CampaignSystem.Clan.EndMercenaryService ( bool isByLeavingKingdom)

◆ FindAll()

static IEnumerable< Clan > TaleWorlds.CampaignSystem.Clan.FindAll ( Predicate< Clan > predicate)
static

◆ CalculateTotalSettlementValueForFaction()

float TaleWorlds.CampaignSystem.Clan.CalculateTotalSettlementValueForFaction ( Kingdom kingdom)

◆ OnHeroChangedState()

void TaleWorlds.CampaignSystem.Clan.OnHeroChangedState ( Hero hero,
Hero.CharacterStates oldState )

◆ AddRenown()

void TaleWorlds.CampaignSystem.Clan.AddRenown ( float value,
bool shouldNotify = true )

◆ ResetClanRenown()

void TaleWorlds.CampaignSystem.Clan.ResetClanRenown ( )

◆ OnSupportedByClan()

void TaleWorlds.CampaignSystem.Clan.OnSupportedByClan ( Clan supporterClan)

◆ CreateSettlementRebelClan()

static Clan TaleWorlds.CampaignSystem.Clan.CreateSettlementRebelClan ( Settlement settlement,
Hero owner,
int iconMeshId = -1 )
static

◆ CalculateMidSettlement()

void TaleWorlds.CampaignSystem.Clan.CalculateMidSettlement ( )

◆ CreateCompanionToLordClan()

static Clan TaleWorlds.CampaignSystem.Clan.CreateCompanionToLordClan ( Hero hero,
Settlement settlement,
TextObject clanName,
int newClanIconId )
static

◆ GetHeirApparents()

Dictionary< Hero, int > TaleWorlds.CampaignSystem.Clan.GetHeirApparents ( )

◆ UpdateBannerColor()

void TaleWorlds.CampaignSystem.Clan.UpdateBannerColor ( uint backgroundColor,
uint iconColor )

Property Documentation

◆ Name

TextObject TaleWorlds.CampaignSystem.Clan.Name
get

Implements TaleWorlds.CampaignSystem.IFaction.

◆ InformalName

TextObject TaleWorlds.CampaignSystem.Clan.InformalName
get

Implements TaleWorlds.CampaignSystem.IFaction.

◆ Culture

CultureObject TaleWorlds.CampaignSystem.Clan.Culture
getset

Implements TaleWorlds.CampaignSystem.IFaction.

◆ LastFactionChangeTime

CampaignTime TaleWorlds.CampaignSystem.Clan.LastFactionChangeTime
getset

◆ DefaultPartyTemplate

PartyTemplateObject TaleWorlds.CampaignSystem.Clan.DefaultPartyTemplate
get

◆ HasNavalNavigationCapability

bool TaleWorlds.CampaignSystem.Clan.HasNavalNavigationCapability
get

Implements TaleWorlds.CampaignSystem.IFaction.

◆ AutoRecruitmentExpenses

int TaleWorlds.CampaignSystem.Clan.AutoRecruitmentExpenses
getset

◆ EncyclopediaText

TextObject TaleWorlds.CampaignSystem.Clan.EncyclopediaText
get

Implements TaleWorlds.CampaignSystem.IFaction.

◆ IsNoble

bool TaleWorlds.CampaignSystem.Clan.IsNoble
getset

◆ IsEliminated

bool TaleWorlds.CampaignSystem.Clan.IsEliminated
get

Implements TaleWorlds.CampaignSystem.IFaction.

◆ MinorFactionCharacterTemplates

IList<CharacterObject> TaleWorlds.CampaignSystem.Clan.MinorFactionCharacterTemplates
get

◆ EncyclopediaLink

string TaleWorlds.CampaignSystem.Clan.EncyclopediaLink
get

Implements TaleWorlds.CampaignSystem.IFaction.

◆ EncyclopediaLinkWithName

TextObject TaleWorlds.CampaignSystem.Clan.EncyclopediaLinkWithName
get

Implements TaleWorlds.CampaignSystem.IFaction.

◆ Kingdom

Kingdom TaleWorlds.CampaignSystem.Clan.Kingdom
getset
Returns
Kingdom of this clan

◆ DungeonPrisonersOfClan

IEnumerable<CharacterObject> TaleWorlds.CampaignSystem.Clan.DungeonPrisonersOfClan
get

◆ Fiefs

MBReadOnlyList<Town> TaleWorlds.CampaignSystem.Clan.Fiefs
get

Implements TaleWorlds.CampaignSystem.IFaction.

◆ Villages

MBReadOnlyList<Village> TaleWorlds.CampaignSystem.Clan.Villages
get

◆ Settlements

MBReadOnlyList<Settlement> TaleWorlds.CampaignSystem.Clan.Settlements
get

Implements TaleWorlds.CampaignSystem.IFaction.

◆ SupporterNotables

MBReadOnlyList<Hero> TaleWorlds.CampaignSystem.Clan.SupporterNotables
get

◆ AliveLords

MBReadOnlyList<Hero> TaleWorlds.CampaignSystem.Clan.AliveLords
get

Implements TaleWorlds.CampaignSystem.IFaction.

◆ DeadLords

MBReadOnlyList<Hero> TaleWorlds.CampaignSystem.Clan.DeadLords
get

Implements TaleWorlds.CampaignSystem.IFaction.

◆ Heroes

MBReadOnlyList<Hero> TaleWorlds.CampaignSystem.Clan.Heroes
get

Implements TaleWorlds.CampaignSystem.IFaction.

◆ Companions

MBReadOnlyList<Hero> TaleWorlds.CampaignSystem.Clan.Companions
get

◆ WarPartyComponents

MBReadOnlyList<WarPartyComponent> TaleWorlds.CampaignSystem.Clan.WarPartyComponents
get

Implements TaleWorlds.CampaignSystem.IFaction.

◆ Influence

float TaleWorlds.CampaignSystem.Clan.Influence
getset

◆ InfluenceChangeExplained

ExplainedNumber TaleWorlds.CampaignSystem.Clan.InfluenceChangeExplained
get

◆ CurrentTotalStrength

float TaleWorlds.CampaignSystem.Clan.CurrentTotalStrength
get

Implements TaleWorlds.CampaignSystem.IFaction.

◆ MercenaryAwardMultiplier

int TaleWorlds.CampaignSystem.Clan.MercenaryAwardMultiplier
getset

◆ IsMapFaction

bool TaleWorlds.CampaignSystem.Clan.IsMapFaction
get

Implements TaleWorlds.CampaignSystem.IFaction.

◆ InitialHomeSettlement

Settlement TaleWorlds.CampaignSystem.Clan.InitialHomeSettlement
get

Implements TaleWorlds.CampaignSystem.IFaction.

◆ IsRebelClan

bool TaleWorlds.CampaignSystem.Clan.IsRebelClan
getset

Implements TaleWorlds.CampaignSystem.IFaction.

◆ IsMinorFaction

bool TaleWorlds.CampaignSystem.Clan.IsMinorFaction
get

Implements TaleWorlds.CampaignSystem.IFaction.

◆ IsOutlaw

bool TaleWorlds.CampaignSystem.Clan.IsOutlaw
get

Implements TaleWorlds.CampaignSystem.IFaction.

◆ IsNomad

bool TaleWorlds.CampaignSystem.Clan.IsNomad
get

◆ IsMafia

bool TaleWorlds.CampaignSystem.Clan.IsMafia
get

◆ IsClanTypeMercenary

bool TaleWorlds.CampaignSystem.Clan.IsClanTypeMercenary
get

◆ IsSect

bool TaleWorlds.CampaignSystem.Clan.IsSect
get

◆ IsUnderMercenaryService

bool TaleWorlds.CampaignSystem.Clan.IsUnderMercenaryService
get

◆ ShouldStayInKingdomUntil

CampaignTime TaleWorlds.CampaignSystem.Clan.ShouldStayInKingdomUntil
getset

◆ Color

uint TaleWorlds.CampaignSystem.Clan.Color
getset

Implements TaleWorlds.CampaignSystem.IFaction.

◆ Color2

uint TaleWorlds.CampaignSystem.Clan.Color2
getset

Implements TaleWorlds.CampaignSystem.IFaction.

◆ FactionMidSettlement

Settlement TaleWorlds.CampaignSystem.Clan.FactionMidSettlement
get

Implements TaleWorlds.CampaignSystem.IFaction.

◆ BasicTroop

CharacterObject TaleWorlds.CampaignSystem.Clan.BasicTroop
getset

Implements TaleWorlds.CampaignSystem.IFaction.

◆ PlayerClan

Clan TaleWorlds.CampaignSystem.Clan.PlayerClan
staticget

◆ Leader

Hero TaleWorlds.CampaignSystem.Clan.Leader
get

Implements TaleWorlds.CampaignSystem.IFaction.

◆ Gold

int TaleWorlds.CampaignSystem.Clan.Gold
get

◆ Banner

Banner TaleWorlds.CampaignSystem.Clan.Banner
getset

Implements TaleWorlds.CampaignSystem.IFaction.

◆ ClanOriginalBanner

Banner TaleWorlds.CampaignSystem.Clan.ClanOriginalBanner
get

◆ IsBanditFaction

bool TaleWorlds.CampaignSystem.Clan.IsBanditFaction
get

Implements TaleWorlds.CampaignSystem.IFaction.

◆ IsClan

bool TaleWorlds.CampaignSystem.Clan.IsClan
get

Implements TaleWorlds.CampaignSystem.IFaction.

◆ Renown

float TaleWorlds.CampaignSystem.Clan.Renown
getset

◆ MainHeroCrimeRating

float TaleWorlds.CampaignSystem.Clan.MainHeroCrimeRating
getset

Implements TaleWorlds.CampaignSystem.IFaction.

◆ DailyCrimeRatingChange

float TaleWorlds.CampaignSystem.Clan.DailyCrimeRatingChange
get

Implements TaleWorlds.CampaignSystem.IFaction.

◆ DailyCrimeRatingChangeExplained

ExplainedNumber TaleWorlds.CampaignSystem.Clan.DailyCrimeRatingChangeExplained
get

Implements TaleWorlds.CampaignSystem.IFaction.

◆ Tier

int TaleWorlds.CampaignSystem.Clan.Tier
get

◆ MapFaction

IFaction TaleWorlds.CampaignSystem.Clan.MapFaction
get

Implements TaleWorlds.CampaignSystem.IFaction.

◆ NotAttackableByPlayerUntilTime

CampaignTime TaleWorlds.CampaignSystem.Clan.NotAttackableByPlayerUntilTime
getset

Implements TaleWorlds.CampaignSystem.IFaction.

◆ Aggressiveness

float TaleWorlds.CampaignSystem.Clan.Aggressiveness
get

Implements TaleWorlds.CampaignSystem.IFaction.

◆ TributeWallet

int TaleWorlds.CampaignSystem.Clan.TributeWallet
getset

Implements TaleWorlds.CampaignSystem.IFaction.

◆ HomeSettlement

Settlement TaleWorlds.CampaignSystem.Clan.HomeSettlement
get

◆ DebtToKingdom

int TaleWorlds.CampaignSystem.Clan.DebtToKingdom
getset

◆ FactionsAtWarWith

MBReadOnlyList<IFaction> TaleWorlds.CampaignSystem.Clan.FactionsAtWarWith
get

Implements TaleWorlds.CampaignSystem.IFaction.

◆ RenownRequirementForNextTier

int TaleWorlds.CampaignSystem.Clan.RenownRequirementForNextTier
get

◆ CompanionLimit

int TaleWorlds.CampaignSystem.Clan.CompanionLimit
get

◆ DistanceToClosestNonAllyFortification

float TaleWorlds.CampaignSystem.Clan.DistanceToClosestNonAllyFortification
get

Implements TaleWorlds.CampaignSystem.IFaction.

◆ CommanderLimit

int TaleWorlds.CampaignSystem.Clan.CommanderLimit
get

◆ All

MBReadOnlyList<Clan> TaleWorlds.CampaignSystem.Clan.All
staticget

◆ NonBanditFactions

IEnumerable<Clan> TaleWorlds.CampaignSystem.Clan.NonBanditFactions
staticget

◆ BanditFactions

IEnumerable<Clan> TaleWorlds.CampaignSystem.Clan.BanditFactions
staticget