M&B: Bannerlord 1.2.7
The horns sound, the ravens gather.
Loading...
Searching...
No Matches
TaleWorlds.CampaignSystem.ComponentInterfaces.SettlementAccessModel Class Referenceabstract

Inherits TaleWorlds.Core.GameModel.

Inherited by TaleWorlds.CampaignSystem.GameComponents.DefaultSettlementAccessModel.

Classes

struct  AccessDetails
 

Public Types

enum  AccessLevel {
  NoAccess ,
  LimitedAccess ,
  FullAccess
}
 
enum  AccessMethod {
  None ,
  Direct ,
  ByRequest
}
 
enum  AccessLimitationReason {
  None ,
  HostileFaction ,
  RelationshipWithOwner ,
  CrimeRating ,
  VillageIsLooted ,
  Disguised ,
  ClanTier ,
  LocationEmpty
}
 
enum  LimitedAccessSolution {
  None ,
  Bribe ,
  Disguise
}
 
enum  PreliminaryActionObligation {
  None ,
  Optional
}
 
enum  PreliminaryActionType {
  None ,
  FaceCharges
}
 
enum  SettlementAction {
  RecruitTroops ,
  Craft ,
  WalkAroundTheArena ,
  JoinTournament ,
  WatchTournament ,
  Trade ,
  WaitInSettlement ,
  ManageTown
}
 

Public Member Functions

abstract void CanMainHeroEnterSettlement (Settlement settlement, out AccessDetails accessDetails)
 
abstract void CanMainHeroEnterLordsHall (Settlement settlement, out AccessDetails accessDetails)
 
abstract void CanMainHeroEnterDungeon (Settlement settlement, out AccessDetails accessDetails)
 
abstract bool CanMainHeroAccessLocation (Settlement settlement, string locationId, out bool disableOption, out TextObject disabledText)
 
abstract bool CanMainHeroDoSettlementAction (Settlement settlement, SettlementAction settlementAction, out bool disableOption, out TextObject disabledText)
 
abstract bool IsRequestMeetingOptionAvailable (Settlement settlement, out bool disableOption, out TextObject disabledText)
 

Member Enumeration Documentation

◆ AccessLevel

Enumerator
NoAccess 
LimitedAccess 
FullAccess 

◆ AccessMethod

◆ AccessLimitationReason

Enumerator
None 
HostileFaction 
RelationshipWithOwner 
CrimeRating 
VillageIsLooted 
Disguised 
ClanTier 
LocationEmpty 

◆ LimitedAccessSolution

◆ PreliminaryActionObligation

◆ PreliminaryActionType

◆ SettlementAction

Enumerator
RecruitTroops 
Craft 
WalkAroundTheArena 
JoinTournament 
WatchTournament 
Trade 
WaitInSettlement 
ManageTown 

Member Function Documentation

◆ CanMainHeroEnterSettlement()

abstract void TaleWorlds.CampaignSystem.ComponentInterfaces.SettlementAccessModel.CanMainHeroEnterSettlement ( Settlement  settlement,
out AccessDetails  accessDetails 
)
pure virtual

◆ CanMainHeroEnterLordsHall()

abstract void TaleWorlds.CampaignSystem.ComponentInterfaces.SettlementAccessModel.CanMainHeroEnterLordsHall ( Settlement  settlement,
out AccessDetails  accessDetails 
)
pure virtual

◆ CanMainHeroEnterDungeon()

abstract void TaleWorlds.CampaignSystem.ComponentInterfaces.SettlementAccessModel.CanMainHeroEnterDungeon ( Settlement  settlement,
out AccessDetails  accessDetails 
)
pure virtual

◆ CanMainHeroAccessLocation()

abstract bool TaleWorlds.CampaignSystem.ComponentInterfaces.SettlementAccessModel.CanMainHeroAccessLocation ( Settlement  settlement,
string  locationId,
out bool  disableOption,
out TextObject  disabledText 
)
pure virtual

◆ CanMainHeroDoSettlementAction()

abstract bool TaleWorlds.CampaignSystem.ComponentInterfaces.SettlementAccessModel.CanMainHeroDoSettlementAction ( Settlement  settlement,
SettlementAction  settlementAction,
out bool  disableOption,
out TextObject  disabledText 
)
pure virtual

◆ IsRequestMeetingOptionAvailable()

abstract bool TaleWorlds.CampaignSystem.ComponentInterfaces.SettlementAccessModel.IsRequestMeetingOptionAvailable ( Settlement  settlement,
out bool  disableOption,
out TextObject  disabledText 
)
pure virtual