Table of Contents

Class CampaignUIHelper

Namespace
TaleWorlds.CampaignSystem.ViewModelCollection
Assembly
TaleWorlds.CampaignSystem.ViewModelCollection.dll
public static class CampaignUIHelper
Inheritance
CampaignUIHelper
Inherited Members

Fields

MobilePartyPrecedenceComparerInstance 

public static readonly CampaignUIHelper.MobilePartyPrecedenceComparer MobilePartyPrecedenceComparerInstance

Field Value

CampaignUIHelper.MobilePartyPrecedenceComparer

Methods

ConvertToHexColor(uint) 

public static string ConvertToHexColor(uint color)

Parameters

color uint

Returns

string

FloatToString(float) 

public static string FloatToString(float x)

Parameters

x float

Returns

string

GetAbbreviatedValueTextFromValue(int) 

public static string GetAbbreviatedValueTextFromValue(int valueAmount)

Parameters

valueAmount int

Returns

string

GetAddFocusHintString(bool, bool, int, int, int, IHeroDeveloper, SkillObject) 

public static string GetAddFocusHintString(bool playerHasEnoughPoints, bool isMaxedSkill, int currentFocusAmount, int currentAttributeAmount, int currentSkillValue, IHeroDeveloper developer, SkillObject skill)

Parameters

playerHasEnoughPoints bool
isMaxedSkill bool
currentFocusAmount int
currentAttributeAmount int
currentSkillValue int
developer IHeroDeveloper
skill SkillObject

Returns

string

GetArmyCohesionTooltip(Army) 

public static List<TooltipProperty> GetArmyCohesionTooltip(Army army)

Parameters

army Army

Returns

List<TooltipProperty>

GetArmyDisbandDisableReasonString(bool, bool, bool, bool) 

public static string GetArmyDisbandDisableReasonString(bool hasEnoughInfluence, bool isArmyInAnyEvent, bool isPlayerClanMercenary, bool isPlayerInThisArmy)

Parameters

hasEnoughInfluence bool
isArmyInAnyEvent bool
isPlayerClanMercenary bool
isPlayerInThisArmy bool

Returns

string

GetArmyFoodTooltip(Army) 

public static List<TooltipProperty> GetArmyFoodTooltip(Army army)

Parameters

army Army

Returns

List<TooltipProperty>

GetArmyManCountTooltip(Army) 

public static List<TooltipProperty> GetArmyManCountTooltip(Army army)

Parameters

army Army

Returns

List<TooltipProperty>

GetCharacterCode(CharacterObject, bool) 

public static CharacterCode GetCharacterCode(CharacterObject character, bool useCivilian = false)

Parameters

character CharacterObject
useCivilian bool

Returns

CharacterCode

GetCharacterTierData(CharacterObject, bool) 

public static StringItemWithHintVM GetCharacterTierData(CharacterObject character, bool isBig = false)

Parameters

character CharacterObject
isBig bool

Returns

StringItemWithHintVM

GetCharacterTypeData(CharacterObject, bool) 

public static StringItemWithHintVM GetCharacterTypeData(CharacterObject character, bool isBig = false)

Parameters

character CharacterObject
isBig bool

Returns

StringItemWithHintVM

GetClanExpelDisableReasonString(bool, bool, bool, bool) 

public static string GetClanExpelDisableReasonString(bool hasEnoughInfluence, bool isTargetMainClan, bool isTargetRulingClan, bool isMainClanMercenary)

Parameters

hasEnoughInfluence bool
isTargetMainClan bool
isTargetRulingClan bool
isMainClanMercenary bool

Returns

string

GetClanProsperityTooltip(Clan) 

public static List<TooltipProperty> GetClanProsperityTooltip(Clan clan)

Parameters

clan Clan

Returns

List<TooltipProperty>

GetClanRenownTooltip(Clan) 

public static List<TooltipProperty> GetClanRenownTooltip(Clan clan)

Parameters

clan Clan

Returns

List<TooltipProperty>

GetClanStrengthTooltip(Clan) 

public static List<TooltipProperty> GetClanStrengthTooltip(Clan clan)

Parameters

clan Clan

Returns

List<TooltipProperty>

GetClanSupportDisableReasonString(bool, bool, bool) 

public static string GetClanSupportDisableReasonString(bool hasEnoughInfluence, bool isTargetMainClan, bool isMainClanMercenary)

Parameters

hasEnoughInfluence bool
isTargetMainClan bool
isMainClanMercenary bool

Returns

string

GetClanWealthStatusText(Clan) 

public static string GetClanWealthStatusText(Clan clan)

Parameters

clan Clan

Returns

string

GetCombinedPerkRoleText(PerkObject) 

public static TextObject GetCombinedPerkRoleText(PerkObject perk)

Parameters

perk PerkObject

Returns

TextObject

GetCommaSeparatedText(TextObject, IEnumerable<TextObject>) 

public static TextObject GetCommaSeparatedText(TextObject label, IEnumerable<TextObject> texts)

Parameters

label TextObject
texts IEnumerable<TextObject>

Returns

TextObject

GetCraftingDisableReasonString(bool) 

public static string GetCraftingDisableReasonString(bool playerHasEnoughMaterials)

Parameters

playerHasEnoughMaterials bool

Returns

string

GetCraftingHeroTooltip(Hero, CraftingOrder) 

public static List<TooltipProperty> GetCraftingHeroTooltip(Hero hero, CraftingOrder order)

Parameters

hero Hero
order CraftingOrder

Returns

List<TooltipProperty>

GetCraftingOrderDisabledReasonTooltip(Hero, CraftingOrder) 

public static List<TooltipProperty> GetCraftingOrderDisabledReasonTooltip(Hero heroToCheck, CraftingOrder order)

Parameters

heroToCheck Hero
order CraftingOrder

Returns

List<TooltipProperty>

GetCraftingOrderMissingPropertyWarningText(CraftingOrder, ItemObject) 

public static string GetCraftingOrderMissingPropertyWarningText(CraftingOrder order, ItemObject craftedItem)

Parameters

order CraftingOrder
craftedItem ItemObject

Returns

string

GetCraftingTemplatePieceUnlockProgressHint(float) 

public static TextObject GetCraftingTemplatePieceUnlockProgressHint(float progress)

Parameters

progress float

Returns

TextObject

GetCreateNewPartyReasonString(bool, bool) 

public static TextObject GetCreateNewPartyReasonString(bool haveEmptyPartySlots, bool haveAvailableHero)

Parameters

haveEmptyPartySlots bool
haveAvailableHero bool

Returns

TextObject

GetCrimeTooltip(Settlement) 

public static List<TooltipProperty> GetCrimeTooltip(Settlement settlement)

Parameters

settlement Settlement

Returns

List<TooltipProperty>

GetDaysUntilNoFood(float, float) 

public static string GetDaysUntilNoFood(float totalFood, float foodChange)

Parameters

totalFood float
foodChange float

Returns

string

GetDenarTooltip() 

public static TooltipTriggerVM GetDenarTooltip()

Returns

TooltipTriggerVM

GetEncounterPartyMoraleTooltip(List<MobileParty>) 

public static List<TooltipProperty> GetEncounterPartyMoraleTooltip(List<MobileParty> parties)

Parameters

parties List<MobileParty>

Returns

List<TooltipProperty>

GetFlagDetailsForWeapon(WeaponComponentData, ItemUsageSetFlags, CharacterObject) 

public static List<(string, TextObject)> GetFlagDetailsForWeapon(WeaponComponentData weapon, ItemObject.ItemUsageSetFlags itemUsageFlags, CharacterObject character = null)

Parameters

weapon WeaponComponentData
itemUsageFlags ItemObject.ItemUsageSetFlags
character CharacterObject

Returns

List<(string, TextObject)>

GetFormattedItemPropertyText(float, bool) 

public static string GetFormattedItemPropertyText(float propertyValue, bool typeRequiresInteger)

Parameters

propertyValue float
typeRequiresInteger bool

Returns

string

GetGovernorPerksTooltipForHero(Hero) 

public static List<TooltipProperty> GetGovernorPerksTooltipForHero(Hero hero)

Parameters

hero Hero

Returns

List<TooltipProperty>

GetGovernorSelectionConfirmationPopupTexts(Hero, Hero, Settlement) 

public static (TextObject titleText, TextObject bodyText) GetGovernorSelectionConfirmationPopupTexts(Hero currentGovernor, Hero newGovernor, Settlement settlement)

Parameters

currentGovernor Hero
newGovernor Hero
settlement Settlement

Returns

(TextObject titleText, TextObject bodyText)

GetHeroBehaviorText(Hero, ITeleportationCampaignBehavior) 

public static string GetHeroBehaviorText(Hero hero, ITeleportationCampaignBehavior teleportationBehavior = null)

Parameters

hero Hero
teleportationBehavior ITeleportationCampaignBehavior

Returns

string

GetHeroClanRoleText(Hero, Clan) 

public static string GetHeroClanRoleText(Hero hero, Clan clan)

Parameters

hero Hero
clan Clan

Returns

string

GetHeroCompareSortIndex(Hero, Hero) 

public static int GetHeroCompareSortIndex(Hero x, Hero y)

Parameters

x Hero
y Hero

Returns

int

GetHeroGovernorEffectsTooltip(Hero, Settlement) 

public static List<TooltipProperty> GetHeroGovernorEffectsTooltip(Hero hero, Settlement settlement)

Parameters

hero Hero
settlement Settlement

Returns

List<TooltipProperty>

GetHeroHealthTooltip(Hero) 

public static List<TooltipProperty> GetHeroHealthTooltip(Hero hero)

Parameters

hero Hero

Returns

List<TooltipProperty>

GetHeroKingdomRank(Hero) 

public static string GetHeroKingdomRank(Hero hero)

Parameters

hero Hero

Returns

string

GetHeroOccupationName(Hero) 

public static string GetHeroOccupationName(Hero hero)

Parameters

hero Hero

Returns

string

GetHeroRank(Hero) 

public static string GetHeroRank(Hero hero)

Parameters

hero Hero

Returns

string

GetHeroRelationToHeroText(Hero, Hero, bool) 

public static TextObject GetHeroRelationToHeroText(Hero queriedHero, Hero baseHero, bool uppercaseFirst)

Parameters

queriedHero Hero
baseHero Hero
uppercaseFirst bool

Returns

TextObject

GetHeroTraits() 

public static IEnumerable<TraitObject> GetHeroTraits()

Returns

IEnumerable<TraitObject>

GetHintTextFromReasons(List<TextObject>) 

public static string GetHintTextFromReasons(List<TextObject> reasons)

Parameters

reasons List<TextObject>

Returns

string

GetHoursAndDaysTextFromHourValue(int) 

public static TextObject GetHoursAndDaysTextFromHourValue(int hours)

Parameters

hours int

Returns

TextObject

GetInfluenceTooltip(Clan) 

public static List<TooltipProperty> GetInfluenceTooltip(Clan clan)

Parameters

clan Clan

Returns

List<TooltipProperty>

GetInventoryCharacterTooltip(Hero) 

public static List<TooltipProperty> GetInventoryCharacterTooltip(Hero hero)

Parameters

hero Hero

Returns

List<TooltipProperty>

GetIssueType(IssueBase) 

public static CampaignUIHelper.IssueQuestFlags GetIssueType(IssueBase issue)

Parameters

issue IssueBase

Returns

CampaignUIHelper.IssueQuestFlags

GetItemFlagDetails(ItemFlags) 

public static List<Tuple<string, TextObject>> GetItemFlagDetails(ItemFlags itemFlags)

Parameters

itemFlags ItemFlags

Returns

List<Tuple<string, TextObject>>

GetItemLockStringID(EquipmentElement) 

public static string GetItemLockStringID(EquipmentElement equipmentElement)

Parameters

equipmentElement EquipmentElement

Returns

string

GetItemObjectTypeSortIndex(ItemObject) 

public static int GetItemObjectTypeSortIndex(ItemObject item)

Parameters

item ItemObject

Returns

int

GetItemUsageSetFlagDetails(ItemUsageSetFlags, CharacterObject) 

public static List<(string, TextObject)> GetItemUsageSetFlagDetails(ItemObject.ItemUsageSetFlags flags, CharacterObject character = null)

Parameters

flags ItemObject.ItemUsageSetFlags
character CharacterObject

Returns

List<(string, TextObject)>

GetLearningLimitTooltip(int, int, TextObject) 

public static List<TooltipProperty> GetLearningLimitTooltip(int attributeValue, int focusValue, TextObject attributeName)

Parameters

attributeValue int
focusValue int
attributeName TextObject

Returns

List<TooltipProperty>

GetLearningRateTooltip(int, int, int, int, TextObject) 

public static List<TooltipProperty> GetLearningRateTooltip(int attributeValue, int focusValue, int skillValue, int characterLevel, TextObject attributeName)

Parameters

attributeValue int
focusValue int
skillValue int
characterLevel int
attributeName TextObject

Returns

List<TooltipProperty>

GetMainPartyHealthTooltip() 

public static List<TooltipProperty> GetMainPartyHealthTooltip()

Returns

List<TooltipProperty>

GetMapScreenActionIsEnabledWithReason(out TextObject) 

public static bool GetMapScreenActionIsEnabledWithReason(out TextObject disabledReason)

Parameters

disabledReason TextObject

Returns

bool

GetMobilePartyBehaviorText(MobileParty) 

public static string GetMobilePartyBehaviorText(MobileParty party)

Parameters

party MobileParty

Returns

string

GetOrderCannotBeCompletedReasonTooltip(CraftingOrder, ItemObject) 

public static List<TooltipProperty> GetOrderCannotBeCompletedReasonTooltip(CraftingOrder order, ItemObject item)

Parameters

order CraftingOrder
item ItemObject

Returns

List<TooltipProperty>

GetOrdersDisabledReasonTooltip(MBBindingList<CraftingOrderItemVM>, Hero) 

public static List<TooltipProperty> GetOrdersDisabledReasonTooltip(MBBindingList<CraftingOrderItemVM> craftingOrders, Hero heroToCheck)

Parameters

craftingOrders MBBindingList<CraftingOrderItemVM>
heroToCheck Hero

Returns

List<TooltipProperty>

GetPartyDistanceByTimeText(float, float) 

public static string GetPartyDistanceByTimeText(float distance, float speed)

Parameters

distance float
speed float

Returns

string

GetPartyFoodTooltip(MobileParty) 

public static List<TooltipProperty> GetPartyFoodTooltip(MobileParty mainParty)

Parameters

mainParty MobileParty

Returns

List<TooltipProperty>

GetPartyHealthTooltip(PartyBase) 

public static List<TooltipProperty> GetPartyHealthTooltip(PartyBase party)

Parameters

party PartyBase

Returns

List<TooltipProperty>

GetPartyInventoryCapacityTooltip(MobileParty) 

public static List<TooltipProperty> GetPartyInventoryCapacityTooltip(MobileParty party)

Parameters

party MobileParty

Returns

List<TooltipProperty>

GetPartyMoraleTooltip(MobileParty) 

public static List<TooltipProperty> GetPartyMoraleTooltip(MobileParty mainParty)

Parameters

mainParty MobileParty

Returns

List<TooltipProperty>

GetPartyNameplateText(MobileParty, bool) 

public static string GetPartyNameplateText(MobileParty party, bool includeAttachedParties)

Parameters

party MobileParty
includeAttachedParties bool

Returns

string

GetPartyNameplateText(PartyBase) 

public static string GetPartyNameplateText(PartyBase party)

Parameters

party PartyBase

Returns

string

GetPartyPrisonerSizeLimitTooltip(PartyBase) 

public static List<TooltipProperty> GetPartyPrisonerSizeLimitTooltip(PartyBase party)

Parameters

party PartyBase

Returns

List<TooltipProperty>

GetPartySpeedTooltip() 

public static List<TooltipProperty> GetPartySpeedTooltip()

Returns

List<TooltipProperty>

GetPartyTroopSizeLimitTooltip(PartyBase) 

public static List<TooltipProperty> GetPartyTroopSizeLimitTooltip(PartyBase party)

Parameters

party PartyBase

Returns

List<TooltipProperty>

GetPartyWageTooltip() 

public static List<TooltipProperty> GetPartyWageTooltip()

Returns

List<TooltipProperty>

GetPartyWageTooltip(MobileParty) 

public static List<TooltipProperty> GetPartyWageTooltip(MobileParty mobileParty)

Parameters

mobileParty MobileParty

Returns

List<TooltipProperty>

GetPerkEffectText(PerkObject, bool) 

public static List<TooltipProperty> GetPerkEffectText(PerkObject perk, bool isActive)

Parameters

perk PerkObject
isActive bool

Returns

List<TooltipProperty>

GetPerkRoleText(PerkObject, bool) 

public static TextObject GetPerkRoleText(PerkObject perk, bool getSecondary)

Parameters

perk PerkObject
getSecondary bool

Returns

TextObject

GetPlayerHitpointsTooltip() 

public static List<TooltipProperty> GetPlayerHitpointsTooltip()

Returns

List<TooltipProperty>

GetQuestExplanationOfHero(IssueQuestFlags) 

public static string GetQuestExplanationOfHero(CampaignUIHelper.IssueQuestFlags questType)

Parameters

questType CampaignUIHelper.IssueQuestFlags

Returns

string

GetQuestStateOfHero(Hero) 

public static List<(CampaignUIHelper.IssueQuestFlags, TextObject, TextObject)> GetQuestStateOfHero(Hero queriedHero)

Parameters

queriedHero Hero

Returns

List<(CampaignUIHelper.IssueQuestFlags, TextObject, TextObject)>

GetQuestType(QuestBase, Hero) 

public static CampaignUIHelper.IssueQuestFlags GetQuestType(QuestBase quest, Hero queriedQuestGiver)

Parameters

quest QuestBase
queriedQuestGiver Hero

Returns

CampaignUIHelper.IssueQuestFlags

GetQuestsRelatedToHero(Hero) 

public static List<QuestBase> GetQuestsRelatedToHero(Hero hero)

Parameters

hero Hero

Returns

List<QuestBase>

GetQuestsRelatedToParty(MobileParty) 

public static List<QuestBase> GetQuestsRelatedToParty(MobileParty party)

Parameters

party MobileParty

Returns

List<QuestBase>

GetQuestsRelatedToSettlement(Settlement) 

public static List<QuestBase> GetQuestsRelatedToSettlement(Settlement settlement)

Parameters

settlement Settlement

Returns

List<QuestBase>

GetSettlementConsumptionTooltip(Settlement) 

public static List<TooltipProperty> GetSettlementConsumptionTooltip(Settlement settlement)

Parameters

settlement Settlement

Returns

List<TooltipProperty>

GetSettlementProductionTooltip(Settlement) 

public static List<TooltipProperty> GetSettlementProductionTooltip(Settlement settlement)

Parameters

settlement Settlement

Returns

List<TooltipProperty>

GetSettlementPropertyTooltip(Settlement, string, float, ExplainedNumber) 

public static List<TooltipProperty> GetSettlementPropertyTooltip(Settlement settlement, string valueName, float value, ExplainedNumber explainedNumber)

Parameters

settlement Settlement
valueName string
value float
explainedNumber ExplainedNumber

Returns

List<TooltipProperty>

GetSettlementPropertyTooltipWithResult(Settlement, string, float, ref ExplainedNumber) 

public static List<TooltipProperty> GetSettlementPropertyTooltipWithResult(Settlement settlement, string valueName, float value, ref ExplainedNumber explainedNumber)

Parameters

settlement Settlement
valueName string
value float
explainedNumber ExplainedNumber

Returns

List<TooltipProperty>

GetSiegeMachineName(SiegeEngineType) 

public static string GetSiegeMachineName(SiegeEngineType engineType)

Parameters

engineType SiegeEngineType

Returns

string

GetSiegeMachineNameWithDesctiption(SiegeEngineType) 

public static string GetSiegeMachineNameWithDesctiption(SiegeEngineType engineType)

Parameters

engineType SiegeEngineType

Returns

string

GetSiegeMachineTooltip(SiegeEngineType, bool, int) 

public static List<TooltipProperty> GetSiegeMachineTooltip(SiegeEngineType engineType, bool showDescription = true, int hoursUntilCompletion = 0)

Parameters

engineType SiegeEngineType
showDescription bool
hoursUntilCompletion int

Returns

List<TooltipProperty>

GetSiegeWallTooltip(int, int) 

public static List<TooltipProperty> GetSiegeWallTooltip(int wallLevel, int wallHitpoints)

Parameters

wallLevel int
wallHitpoints int

Returns

List<TooltipProperty>

GetSkillEffectText(SkillEffect, int) 

public static string GetSkillEffectText(SkillEffect effect, int skillLevel)

Parameters

effect SkillEffect
skillLevel int

Returns

string

GetTeleportationDelayText(Hero, PartyBase) 

public static TextObject GetTeleportationDelayText(Hero hero, PartyBase target)

Parameters

hero Hero
target PartyBase

Returns

TextObject

GetTeleportingGovernor(Settlement, ITeleportationCampaignBehavior) 

public static Hero GetTeleportingGovernor(Settlement settlement, ITeleportationCampaignBehavior teleportationBehavior)

Parameters

settlement Settlement
teleportationBehavior ITeleportationCampaignBehavior

Returns

Hero

GetTeleportingLeaderHero(MobileParty, ITeleportationCampaignBehavior) 

public static Hero GetTeleportingLeaderHero(MobileParty party, ITeleportationCampaignBehavior teleportationBehavior)

Parameters

party MobileParty
teleportationBehavior ITeleportationCampaignBehavior

Returns

Hero

GetTextForRole(PerkRole) 

public static string GetTextForRole(SkillEffect.PerkRole role)

Parameters

role SkillEffect.PerkRole

Returns

string

GetTimeOfDayAndResetCameraTooltip() 

public static List<TooltipProperty> GetTimeOfDayAndResetCameraTooltip()

Returns

List<TooltipProperty>

GetTooltipForAccumulatingProperty(string, float, ExplainedNumber) 

public static List<TooltipProperty> GetTooltipForAccumulatingProperty(string propertyName, float currentValue, ExplainedNumber explainedNumber)

Parameters

propertyName string
currentValue float
explainedNumber ExplainedNumber

Returns

List<TooltipProperty>

GetTooltipForAccumulatingPropertyWithResult(string, float, ref ExplainedNumber) 

public static List<TooltipProperty> GetTooltipForAccumulatingPropertyWithResult(string propertyName, float currentValue, ref ExplainedNumber explainedNumber)

Parameters

propertyName string
currentValue float
explainedNumber ExplainedNumber

Returns

List<TooltipProperty>

GetTooltipForgProperty(string, float, ExplainedNumber) 

public static List<TooltipProperty> GetTooltipForgProperty(string propertyName, float currentValue, ExplainedNumber explainedNumber)

Parameters

propertyName string
currentValue float
explainedNumber ExplainedNumber

Returns

List<TooltipProperty>

GetTournamentChampionRewardsTooltip(Hero, Town) 

public static List<TooltipProperty> GetTournamentChampionRewardsTooltip(Hero hero, Town town)

Parameters

hero Hero
town Town

Returns

List<TooltipProperty>

GetTownDailyProductionTooltip(Town) 

public static List<TooltipProperty> GetTownDailyProductionTooltip(Town town)

Parameters

town Town

Returns

List<TooltipProperty>

GetTownFoodTooltip(Town) 

public static List<TooltipProperty> GetTownFoodTooltip(Town town)

Parameters

town Town

Returns

List<TooltipProperty>

GetTownGarrisonTooltip(Town) 

public static List<TooltipProperty> GetTownGarrisonTooltip(Town town)

Parameters

town Town

Returns

List<TooltipProperty>

GetTownLoyaltyTooltip(Town) 

public static List<TooltipProperty> GetTownLoyaltyTooltip(Town town)

Parameters

town Town

Returns

List<TooltipProperty>

GetTownMilitiaTooltip(Town) 

public static List<TooltipProperty> GetTownMilitiaTooltip(Town town)

Parameters

town Town

Returns

List<TooltipProperty>

GetTownProsperityTooltip(Town) 

public static List<TooltipProperty> GetTownProsperityTooltip(Town town)

Parameters

town Town

Returns

List<TooltipProperty>

GetTownSecurityTooltip(Town) 

public static List<TooltipProperty> GetTownSecurityTooltip(Town town)

Parameters

town Town

Returns

List<TooltipProperty>

GetTownWallsTooltip(Town) 

public static string GetTownWallsTooltip(Town town)

Parameters

town Town

Returns

string

GetTraitNameText(TraitObject, Hero) 

public static string GetTraitNameText(TraitObject traitObject, Hero hero)

Parameters

traitObject TraitObject
hero Hero

Returns

string

GetTraitTooltipText(TraitObject, int) 

public static string GetTraitTooltipText(TraitObject traitObject, int traitValue)

Parameters

traitObject TraitObject
traitValue int

Returns

string

GetTroopConformityTooltip(TroopRosterElement) 

public static List<TooltipProperty> GetTroopConformityTooltip(TroopRosterElement troop)

Parameters

troop TroopRosterElement

Returns

List<TooltipProperty>

GetTroopLockStringID(TroopRosterElement) 

public static string GetTroopLockStringID(TroopRosterElement rosterElement)

Parameters

rosterElement TroopRosterElement

Returns

string

GetTroopXPTooltip(TroopRosterElement) 

public static List<TooltipProperty> GetTroopXPTooltip(TroopRosterElement troop)

Parameters

troop TroopRosterElement

Returns

List<TooltipProperty>

GetTruceOwnedSettlementsTooltip(List<Settlement>, TextObject, bool) 

public static List<TooltipProperty> GetTruceOwnedSettlementsTooltip(List<Settlement> settlements, TextObject factionName, bool isTown)

Parameters

settlements List<Settlement>
factionName TextObject
isTown bool

Returns

List<TooltipProperty>

GetUpgradeHint(int, int, int, int, bool, PerkObject, CharacterObject, TroopRosterElement, int, string, string) 

public static string GetUpgradeHint(int index, int numOfItems, int availableUpgrades, int upgradeCoinCost, bool hasRequiredPerk, PerkObject requiredPerk, CharacterObject character, TroopRosterElement troop, int partyGoldChangeAmount, string entireStackShortcutKeyText, string fiveStackShortcutKeyText)

Parameters

index int
numOfItems int
availableUpgrades int
upgradeCoinCost int
hasRequiredPerk bool
requiredPerk PerkObject
character CharacterObject
troop TroopRosterElement
partyGoldChangeAmount int
entireStackShortcutKeyText string
fiveStackShortcutKeyText string

Returns

string

GetUsedHorsesTooltip(List<Tuple<EquipmentElement, int>>) 

public static List<TooltipProperty> GetUsedHorsesTooltip(List<Tuple<EquipmentElement, int>> usedUpgradeHorsesHistory)

Parameters

usedUpgradeHorsesHistory List<Tuple<EquipmentElement, int>>

Returns

List<TooltipProperty>

GetValueChangeText(float, float, string) 

public static string GetValueChangeText(float originalValue, float valueChange, string valueFormat = "F0")

Parameters

originalValue float
valueChange float
valueFormat string

Returns

string

GetViewDistanceTooltip() 

public static List<TooltipProperty> GetViewDistanceTooltip()

Returns

List<TooltipProperty>

GetVillageMilitiaTooltip(Village) 

public static List<TooltipProperty> GetVillageMilitiaTooltip(Village village)

Parameters

village Village

Returns

List<TooltipProperty>

GetVillageProsperityTooltip(Village) 

public static List<TooltipProperty> GetVillageProsperityTooltip(Village village)

Parameters

village Village

Returns

List<TooltipProperty>

GetVisualPartyLeader(PartyBase) 

public static CharacterObject GetVisualPartyLeader(PartyBase party)

Parameters

party PartyBase

Returns

CharacterObject

GetWarPrisonersTooltip(List<Hero>, TextObject) 

public static List<TooltipProperty> GetWarPrisonersTooltip(List<Hero> capturedPrisoners, TextObject factionName)

Parameters

capturedPrisoners List<Hero>
factionName TextObject

Returns

List<TooltipProperty>

GetWarSuccessfulRaidsTooltip(List<Settlement>, TextObject) 

public static List<TooltipProperty> GetWarSuccessfulRaidsTooltip(List<Settlement> settlements, TextObject factionName)

Parameters

settlements List<Settlement>
factionName TextObject

Returns

List<TooltipProperty>

GetWarSuccessfulSiegesTooltip(List<Settlement>, TextObject, bool) 

public static List<TooltipProperty> GetWarSuccessfulSiegesTooltip(List<Settlement> settlements, TextObject factionName, bool isTown)

Parameters

settlements List<Settlement>
factionName TextObject
isTown bool

Returns

List<TooltipProperty>

GetWeaponFlagDetails(WeaponFlags, CharacterObject) 

public static List<(string, TextObject)> GetWeaponFlagDetails(WeaponFlags weaponFlags, CharacterObject character = null)

Parameters

weaponFlags WeaponFlags
character CharacterObject

Returns

List<(string, TextObject)>

IsHeroInformationHidden(Hero, out TextObject) 

public static bool IsHeroInformationHidden(Hero hero, out TextObject disableReason)

Parameters

hero Hero
disableReason TextObject

Returns

bool

IsItemUsageApplicable(WeaponComponentData) 

public static bool IsItemUsageApplicable(WeaponComponentData weapon)

Parameters

weapon WeaponComponentData

Returns

bool

IsSettlementInformationHidden(Settlement, out TextObject) 

public static bool IsSettlementInformationHidden(Settlement settlement, out TextObject disableReason)

Parameters

settlement Settlement
disableReason TextObject

Returns

bool

IsStringApplicableForHeroName(string) 

public static Tuple<bool, string> IsStringApplicableForHeroName(string name)

Parameters

name string

Returns

Tuple<bool, string>

IsStringApplicableForItemName(string) 

public static Tuple<bool, TextObject> IsStringApplicableForItemName(string name)

Parameters

name string

Returns

Tuple<bool, TextObject>

This page was last modified at 09/01/2024 16:12:00 +00:00 (UTC).