M&B: Bannerlord 1.1.0
The horns sound, the ravens gather.
Loading...
Searching...
No Matches
Public Types | Static Public Member Functions | Static Public Attributes | List of all members
SandBox.ViewModelCollection.SandBoxUIHelper Class Reference

This is a temporary class before Tooltip refactor. To show hints in proper formatting, we need to convert them to list of TooltipProperty. Because, UiHelper class in logic, can't refer to TooltipProperty, I added this class to SandBox for it's references. This class and CampaignUIHelper will be deleted after the Tooltip refactor.

Public Types

enum  IssueQuestFlags {
  None = 0 ,
  AvailableIssue = 1 ,
  ActiveIssue = 2 ,
  ActiveStoryQuest = 4 ,
  TrackedIssue = 8 ,
  TrackedStoryQuest = 16
}
 
enum  MapEventVisualTypes {
  None ,
  Raid ,
  Siege ,
  Battle ,
  Rebellion ,
  SallyOut
}
 

Static Public Member Functions

static List< TooltipProperty > GetExplainedNumberTooltip (ref ExplainedNumber explanation)
 
static List< TooltipProperty > GetBattleLootAwardTooltip (float lootPercentage)
 
static string GetSkillEffectText (SkillEffect effect, int skillLevel)
 
static string GetRecruitNotificationText (int recruitmentAmount)
 
static string GetItemSoldNotificationText (ItemRosterElement item, int itemAmount, bool fromHeroToSettlement)
 
static string GetTroopGivenToSettlementNotificationText (int givenAmount)
 
static List< TooltipProperty > GetSiegeEngineInProgressTooltip (SiegeEvent.SiegeEngineConstructionProgress engineInProgress)
 
static List< TooltipProperty > GetSiegeEngineTooltip (SiegeEngineType engine)
 
static List< TooltipProperty > GetWallSectionTooltip (Settlement settlement, int wallIndex)
 
static string GetPrisonersSoldNotificationText (int soldPrisonerAmount)
 
static List<(IssueQuestFlags, TextObject, TextObject)> GetQuestStateOfHero (Hero queriedHero)
 
static List< QuestBase > GetQuestsRelatedToHero (Hero hero)
 
static List< QuestBase > GetQuestsRelatedToParty (MobileParty party)
 
static List<(bool, QuestBase)> GetQuestsRelatedToSettlement (Settlement settlement)
 
static bool IsQuestRelatedToSettlement (QuestBase quest, Settlement settlement)
 
static IssueQuestFlags GetIssueType (IssueBase issue)
 
static int GetPartyHealthyCount (MobileParty party)
 
static string GetPartyWoundedText (int woundedAmount)
 
static string GetPartyPrisonerText (int prisonerAmount)
 
static int GetAllWoundedMembersAmount (MobileParty party)
 
static int GetAllPrisonerMembersAmount (MobileParty party)
 
static CharacterCode GetCharacterCode (CharacterObject character, bool useCivilian=false)
 
static bool IsHeroInformationHidden (Hero hero, out TextObject disableReason)
 
static MapEventVisualTypes GetMapEventVisualTypeFromMapEvent (MapEvent mapEvent)
 

Static Public Attributes

static IssueQuestFlags[] IssueQuestFlagsValues = (IssueQuestFlags[])Enum.GetValues(typeof(IssueQuestFlags))
 

Member Enumeration Documentation

◆ IssueQuestFlags

enum SandBox.ViewModelCollection.SandBoxUIHelper.IssueQuestFlags
Enumerator
None 
AvailableIssue 
ActiveIssue 
ActiveStoryQuest 
TrackedIssue 
TrackedStoryQuest 

◆ MapEventVisualTypes

enum SandBox.ViewModelCollection.SandBoxUIHelper.MapEventVisualTypes
Enumerator
None 
Raid 
Siege 
Battle 
Rebellion 
SallyOut 

Member Function Documentation

◆ GetExplainedNumberTooltip()

static List< TooltipProperty > SandBox.ViewModelCollection.SandBoxUIHelper.GetExplainedNumberTooltip ( ref ExplainedNumber  explanation)
static

◆ GetBattleLootAwardTooltip()

static List< TooltipProperty > SandBox.ViewModelCollection.SandBoxUIHelper.GetBattleLootAwardTooltip ( float  lootPercentage)
static

◆ GetSkillEffectText()

static string SandBox.ViewModelCollection.SandBoxUIHelper.GetSkillEffectText ( SkillEffect  effect,
int  skillLevel 
)
static

◆ GetRecruitNotificationText()

static string SandBox.ViewModelCollection.SandBoxUIHelper.GetRecruitNotificationText ( int  recruitmentAmount)
static

◆ GetItemSoldNotificationText()

static string SandBox.ViewModelCollection.SandBoxUIHelper.GetItemSoldNotificationText ( ItemRosterElement  item,
int  itemAmount,
bool  fromHeroToSettlement 
)
static

◆ GetTroopGivenToSettlementNotificationText()

static string SandBox.ViewModelCollection.SandBoxUIHelper.GetTroopGivenToSettlementNotificationText ( int  givenAmount)
static

◆ GetSiegeEngineInProgressTooltip()

static List< TooltipProperty > SandBox.ViewModelCollection.SandBoxUIHelper.GetSiegeEngineInProgressTooltip ( SiegeEvent::SiegeEngineConstructionProgress  engineInProgress)
static

◆ GetSiegeEngineTooltip()

static List< TooltipProperty > SandBox.ViewModelCollection.SandBoxUIHelper.GetSiegeEngineTooltip ( SiegeEngineType  engine)
static

◆ GetWallSectionTooltip()

static List< TooltipProperty > SandBox.ViewModelCollection.SandBoxUIHelper.GetWallSectionTooltip ( Settlement  settlement,
int  wallIndex 
)
static

◆ GetPrisonersSoldNotificationText()

static string SandBox.ViewModelCollection.SandBoxUIHelper.GetPrisonersSoldNotificationText ( int  soldPrisonerAmount)
static

◆ GetQuestStateOfHero()

static List<(IssueQuestFlags, TextObject, TextObject)> SandBox.ViewModelCollection.SandBoxUIHelper.GetQuestStateOfHero ( Hero  queriedHero)
static

◆ GetQuestsRelatedToHero()

static List< QuestBase > SandBox.ViewModelCollection.SandBoxUIHelper.GetQuestsRelatedToHero ( Hero  hero)
static

◆ GetQuestsRelatedToParty()

static List< QuestBase > SandBox.ViewModelCollection.SandBoxUIHelper.GetQuestsRelatedToParty ( MobileParty  party)
static

◆ GetQuestsRelatedToSettlement()

static List<(bool, QuestBase)> SandBox.ViewModelCollection.SandBoxUIHelper.GetQuestsRelatedToSettlement ( Settlement  settlement)
static

◆ IsQuestRelatedToSettlement()

static bool SandBox.ViewModelCollection.SandBoxUIHelper.IsQuestRelatedToSettlement ( QuestBase  quest,
Settlement  settlement 
)
static

◆ GetIssueType()

static IssueQuestFlags SandBox.ViewModelCollection.SandBoxUIHelper.GetIssueType ( IssueBase  issue)
static

◆ GetPartyHealthyCount()

static int SandBox.ViewModelCollection.SandBoxUIHelper.GetPartyHealthyCount ( MobileParty  party)
static

◆ GetPartyWoundedText()

static string SandBox.ViewModelCollection.SandBoxUIHelper.GetPartyWoundedText ( int  woundedAmount)
static

◆ GetPartyPrisonerText()

static string SandBox.ViewModelCollection.SandBoxUIHelper.GetPartyPrisonerText ( int  prisonerAmount)
static

◆ GetAllWoundedMembersAmount()

static int SandBox.ViewModelCollection.SandBoxUIHelper.GetAllWoundedMembersAmount ( MobileParty  party)
static

◆ GetAllPrisonerMembersAmount()

static int SandBox.ViewModelCollection.SandBoxUIHelper.GetAllPrisonerMembersAmount ( MobileParty  party)
static

◆ GetCharacterCode()

static CharacterCode SandBox.ViewModelCollection.SandBoxUIHelper.GetCharacterCode ( CharacterObject  character,
bool  useCivilian = false 
)
static

◆ IsHeroInformationHidden()

static bool SandBox.ViewModelCollection.SandBoxUIHelper.IsHeroInformationHidden ( Hero  hero,
out TextObject  disableReason 
)
static

◆ GetMapEventVisualTypeFromMapEvent()

static MapEventVisualTypes SandBox.ViewModelCollection.SandBoxUIHelper.GetMapEventVisualTypeFromMapEvent ( MapEvent  mapEvent)
static

Member Data Documentation

◆ IssueQuestFlagsValues

IssueQuestFlags [] SandBox.ViewModelCollection.SandBoxUIHelper.IssueQuestFlagsValues = (IssueQuestFlags[])Enum.GetValues(typeof(IssueQuestFlags))
static