M&B: Bannerlord 1.1.0
The horns sound, the ravens gather.
Loading...
Searching...
No Matches
TaleWorlds.CampaignSystem.Clan Class Reference

A Faction Object.

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

Public Member Functions

bool IsAtWarWith (IFaction other)
 
 Clan ()
 
void InitializeClan (TextObject name, TextObject informalName, CultureObject culture, Banner banner, Vec2 initialPosition=default, bool isDeserialize=false)
 
override void Deserialize (MBObjectManager objectManager, XmlNode node)
 De-serializes the object from an XmlNode.
 
void OnGameCreated ()
 
int GetRelationWithClan (Clan other)
 
void SetLeader (Hero leader)
 
void UpdateHomeSettlement (Settlement updatedSettlement)
 
override TextObject GetName ()
 
void ChangeClanName (TextObject name, TextObject informalName)
 
override string ToString ()
 
StanceLink GetStanceWith (IFaction other)
 
void ConsiderSiegesAndMapEvents (IFaction factionToConsiderAgainst)
 
void ClanLeaveKingdom (bool giveBackFiefs=false)
 
float CalculateTotalSettlementBaseValue ()
 
void StartMercenaryService ()
 
void EndMercenaryService (bool isByLeavingKingdom)
 
float CalculateTotalSettlementValueForFaction (Kingdom kingdom)
 
void OnBoundVillageAdded (Village village)
 
void AddRenown (float value, bool shouldNotify=true)
 
void ResetClanRenown ()
 
void OnSupportedByClan (Clan supporterClan)
 
MobileParty CreateNewMobileParty (Hero hero)
 
MobileParty CreateNewMobilePartyAtPosition (Hero hero, Vec2 spawnPosition)
 
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 ()
 
virtual void Deserialize (MBObjectManager objectManager, XmlNode node)
 
override int GetHashCode ()
 
virtual TextObject GetName ()
 
void PreAfterLoadInternal ()
 
void AfterLoadInternal ()
 
void OnRegistered ()
 
void OnUnregistered ()
 
bool IsAtWarWith (IFaction other)
 
StanceLink GetStanceWith (IFaction other)
 
void ConsiderSiegesAndMapEvents (IFaction factionToConsiderAgainst)
 

Static Public Member Functions

static Clan CreateClan (string stringID)
 
static Clan FindFirst (Predicate< Clan > predicate)
 
static IEnumerable< ClanFindAll (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 ()
 
virtual void OnBeforeLoad ()
 
virtual void PreAfterLoad ()
 
virtual void AfterLoad ()
 

Properties

TextObject Name [get]
 
TextObject InformalName [get]
 
TextObject FullName [get]
 
CultureObject Culture [get, set]
 
CampaignTime LastFactionChangeTime [get, set]
 
PartyTemplateObject DefaultPartyTemplate [get]
 
int AutoRecruitmentExpenses [get, set]
 
TextObject EncyclopediaText [get]
 
bool IsNoble [get, set]
 
bool IsEliminated [get]
 
IList< CharacterObjectMinorFactionCharacterTemplates [get]
 
string EncyclopediaLink [get]
 
bool IsNeutralClan [get]
 
TextObject EncyclopediaLinkWithName [get]
 
Kingdom Kingdom [get, set]
 Gets kingdom of this clan.
 
IEnumerable< CharacterObjectDungeonPrisonersOfClan [get]
 
MBReadOnlyList< TownFiefs [get]
 
MBReadOnlyList< VillageVillages [get]
 
MBReadOnlyList< SettlementSettlements [get]
 
MBReadOnlyList< HeroSupporterNotables [get]
 
MBReadOnlyList< HeroLords [get]
 
MBReadOnlyList< HeroHeroes [get]
 
MBReadOnlyList< HeroCompanions [get]
 
MBReadOnlyList< WarPartyComponentWarPartyComponents [get]
 
float Influence [get, set]
 
ExplainedNumber InfluenceChangeExplained [get]
 
float TotalStrength [get]
 
int MercenaryAwardMultiplier [get, set]
 
bool IsMapFaction [get]
 
uint LabelColor [get, set]
 Label color.
 
Vec2 InitialPosition [get, set]
 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]
 
uint Color [get, set]
 Primary color.
 
uint Color2 [get, set]
 Secondary color.
 
uint AlternativeColor [get, set]
 Primary alternative color.
 
uint AlternativeColor2 [get, set]
 Secondary alternative color.
 
CharacterObject BasicTroop [get, set]
 
static Clan PlayerClan [get]
 
Hero Leader [get]
 
int Gold [get]
 
Banner Banner [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]
 
IEnumerable< StanceLinkStances [get]
 
int RenownRequirementForNextTier [get]
 
int CompanionLimit [get]
 
float DistanceToClosestNonAllyFortification [get]
 
int CommanderLimit [get]
 
Settlement FactionMidSettlement [get]
 
static MBReadOnlyList< ClanAll [get]
 
static IEnumerable< ClanNonBanditFactions [get]
 
static IEnumerable< ClanBanditFactions [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
TextObject Name [get]
 
string StringId [get]
 
MBGUID Id [get]
 
TextObject InformalName [get]
 
string EncyclopediaLink [get]
 
TextObject EncyclopediaLinkWithName [get]
 
TextObject EncyclopediaText [get]
 
CultureObject Culture [get]
 
Vec2 InitialPosition [get]
 Point to spawn around if no settlement remained.
 
uint LabelColor [get]
 
uint Color [get]
 
uint Color2 [get]
 
uint AlternativeColor [get]
 
uint AlternativeColor2 [get]
 
CharacterObject BasicTroop [get]
 
Hero Leader [get]
 
Banner Banner [get]
 
MBReadOnlyList< SettlementSettlements [get]
 
MBReadOnlyList< TownFiefs [get]
 
MBReadOnlyList< HeroLords [get]
 
MBReadOnlyList< HeroHeroes [get]
 
MBReadOnlyList< WarPartyComponentWarPartyComponents [get]
 
bool IsBanditFaction [get]
 
bool IsMinorFaction [get]
 
bool IsKingdomFaction [get]
 
bool IsRebelClan [get]
 
bool IsClan [get]
 
bool IsOutlaw [get]
 
bool IsMapFaction [get]
 
IFaction MapFaction [get]
 
float TotalStrength [get]
 
Settlement FactionMidSettlement [get]
 
float DistanceToClosestNonAllyFortification [get]
 
IEnumerable< StanceLinkStances [get]
 
int TributeWallet [get, set]
 Gold for spending on tributes. Can be negative which means tribute debt.

 
float MainHeroCrimeRating [get, set]
 
float DailyCrimeRatingChange [get]
 
float Aggressiveness [get]
 
bool IsEliminated [get]
 
ExplainedNumber DailyCrimeRatingChangeExplained [get]
 
CampaignTime NotAttackableByPlayerUntilTime [get, set]
 

Constructor & Destructor Documentation

◆ Clan()

TaleWorlds.CampaignSystem.Clan.Clan ( )

Member Function Documentation

◆ IsAtWarWith()

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

◆ CreateClan()

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

◆ InitializeClan()

void TaleWorlds.CampaignSystem.Clan.InitializeClan ( TextObject  name,
TextObject  informalName,
CultureObject  culture,
Banner  banner,
Vec2  initialPosition = default,
bool  isDeserialize = false 
)

◆ PreAfterLoad()

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

◆ AfterLoad()

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

◆ 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

◆ OnGameCreated()

void TaleWorlds.CampaignSystem.Clan.OnGameCreated ( )

◆ GetRelationWithClan()

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

◆ SetLeader()

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

◆ UpdateHomeSettlement()

void TaleWorlds.CampaignSystem.Clan.UpdateHomeSettlement ( Settlement  updatedSettlement)

◆ GetName()

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

◆ 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)

◆ ConsiderSiegesAndMapEvents()

void TaleWorlds.CampaignSystem.Clan.ConsiderSiegesAndMapEvents ( IFaction  factionToConsiderAgainst)

◆ ClanLeaveKingdom()

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

◆ CalculateTotalSettlementBaseValue()

float TaleWorlds.CampaignSystem.Clan.CalculateTotalSettlementBaseValue ( )

◆ StartMercenaryService()

void TaleWorlds.CampaignSystem.Clan.StartMercenaryService ( )

◆ 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)

◆ OnBoundVillageAdded()

void TaleWorlds.CampaignSystem.Clan.OnBoundVillageAdded ( Village  village)

◆ 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

◆ CreateCompanionToLordClan()

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

◆ CreateNewMobileParty()

MobileParty TaleWorlds.CampaignSystem.Clan.CreateNewMobileParty ( Hero  hero)

◆ CreateNewMobilePartyAtPosition()

MobileParty TaleWorlds.CampaignSystem.Clan.CreateNewMobilePartyAtPosition ( Hero  hero,
Vec2  spawnPosition 
)

◆ 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

◆ InformalName

TextObject TaleWorlds.CampaignSystem.Clan.InformalName
get

◆ FullName

TextObject TaleWorlds.CampaignSystem.Clan.FullName
get

◆ Culture

CultureObject TaleWorlds.CampaignSystem.Clan.Culture
getset

◆ LastFactionChangeTime

CampaignTime TaleWorlds.CampaignSystem.Clan.LastFactionChangeTime
getset

◆ DefaultPartyTemplate

PartyTemplateObject TaleWorlds.CampaignSystem.Clan.DefaultPartyTemplate
get

◆ AutoRecruitmentExpenses

int TaleWorlds.CampaignSystem.Clan.AutoRecruitmentExpenses
getset

◆ EncyclopediaText

TextObject TaleWorlds.CampaignSystem.Clan.EncyclopediaText
get

◆ IsNoble

bool TaleWorlds.CampaignSystem.Clan.IsNoble
getset

◆ IsEliminated

bool TaleWorlds.CampaignSystem.Clan.IsEliminated
get

◆ MinorFactionCharacterTemplates

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

◆ EncyclopediaLink

string TaleWorlds.CampaignSystem.Clan.EncyclopediaLink
get

◆ IsNeutralClan

bool TaleWorlds.CampaignSystem.Clan.IsNeutralClan
get

◆ EncyclopediaLinkWithName

TextObject TaleWorlds.CampaignSystem.Clan.EncyclopediaLinkWithName
get

◆ 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

◆ Villages

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

◆ Settlements

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

◆ SupporterNotables

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

◆ Lords

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

◆ Heroes

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

◆ Companions

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

◆ WarPartyComponents

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

◆ Influence

float TaleWorlds.CampaignSystem.Clan.Influence
getset

◆ InfluenceChangeExplained

ExplainedNumber TaleWorlds.CampaignSystem.Clan.InfluenceChangeExplained
get

◆ TotalStrength

float TaleWorlds.CampaignSystem.Clan.TotalStrength
get

◆ MercenaryAwardMultiplier

int TaleWorlds.CampaignSystem.Clan.MercenaryAwardMultiplier
getset

◆ IsMapFaction

bool TaleWorlds.CampaignSystem.Clan.IsMapFaction
get

◆ LabelColor

uint TaleWorlds.CampaignSystem.Clan.LabelColor
getset

◆ InitialPosition

Vec2 TaleWorlds.CampaignSystem.Clan.InitialPosition
getset

◆ IsRebelClan

bool TaleWorlds.CampaignSystem.Clan.IsRebelClan
getset

◆ IsMinorFaction

bool TaleWorlds.CampaignSystem.Clan.IsMinorFaction
get

◆ IsOutlaw

bool TaleWorlds.CampaignSystem.Clan.IsOutlaw
get

◆ 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

◆ Color

uint TaleWorlds.CampaignSystem.Clan.Color
getset

◆ Color2

uint TaleWorlds.CampaignSystem.Clan.Color2
getset

◆ AlternativeColor

uint TaleWorlds.CampaignSystem.Clan.AlternativeColor
getset

◆ AlternativeColor2

uint TaleWorlds.CampaignSystem.Clan.AlternativeColor2
getset

◆ BasicTroop

CharacterObject TaleWorlds.CampaignSystem.Clan.BasicTroop
getset

◆ PlayerClan

Clan TaleWorlds.CampaignSystem.Clan.PlayerClan
staticget

◆ Leader

Hero TaleWorlds.CampaignSystem.Clan.Leader
get

◆ Gold

int TaleWorlds.CampaignSystem.Clan.Gold
get

◆ Banner

Banner TaleWorlds.CampaignSystem.Clan.Banner
get

◆ IsBanditFaction

bool TaleWorlds.CampaignSystem.Clan.IsBanditFaction
get

◆ IsClan

bool TaleWorlds.CampaignSystem.Clan.IsClan
get

◆ Renown

float TaleWorlds.CampaignSystem.Clan.Renown
getset

◆ MainHeroCrimeRating

float TaleWorlds.CampaignSystem.Clan.MainHeroCrimeRating
getset

◆ DailyCrimeRatingChange

float TaleWorlds.CampaignSystem.Clan.DailyCrimeRatingChange
get

◆ DailyCrimeRatingChangeExplained

ExplainedNumber TaleWorlds.CampaignSystem.Clan.DailyCrimeRatingChangeExplained
get

◆ Tier

int TaleWorlds.CampaignSystem.Clan.Tier
get

◆ MapFaction

IFaction TaleWorlds.CampaignSystem.Clan.MapFaction
get

◆ NotAttackableByPlayerUntilTime

CampaignTime TaleWorlds.CampaignSystem.Clan.NotAttackableByPlayerUntilTime
getset

◆ Aggressiveness

float TaleWorlds.CampaignSystem.Clan.Aggressiveness
get

◆ TributeWallet

int TaleWorlds.CampaignSystem.Clan.TributeWallet
getset

◆ HomeSettlement

Settlement TaleWorlds.CampaignSystem.Clan.HomeSettlement
get

◆ DebtToKingdom

int TaleWorlds.CampaignSystem.Clan.DebtToKingdom
getset

◆ Stances

IEnumerable<StanceLink> TaleWorlds.CampaignSystem.Clan.Stances
get

◆ RenownRequirementForNextTier

int TaleWorlds.CampaignSystem.Clan.RenownRequirementForNextTier
get

◆ CompanionLimit

int TaleWorlds.CampaignSystem.Clan.CompanionLimit
get

◆ DistanceToClosestNonAllyFortification

float TaleWorlds.CampaignSystem.Clan.DistanceToClosestNonAllyFortification
get

◆ CommanderLimit

int TaleWorlds.CampaignSystem.Clan.CommanderLimit
get

◆ FactionMidSettlement

Settlement TaleWorlds.CampaignSystem.Clan.FactionMidSettlement
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