TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.SettlementMenuOverlayVM Class Reference

Inherits TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.GameMenuOverlay.

Classes
class	CrimeValueInspectedInSettlementOverlayEvent
class	SettlementOverlayLeaveCharacterPermissionEvent
	An event that is triggered before calculating if the characters are leave-able in the settlement from the settlement overlay UI. Any objecting systems will register this event and give reasoning for it's deactivation. More...
class	SettlementOverlayTalkPermissionEvent
	An event that is triggered before calculating if the character is talk-able from the settlement overlay UI. Any objecting systems will register this event and give reasoning for it's deactivation. More...
class	SettlementOverylayQuickTalkPermissionEvent
	An event that is triggered before calculating if the character is "quick talk"-able from the settlement overlay UI. Any objecting systems will register this event and give reasoning for it's deactivation. More...

Public Member Functions
	SettlementMenuOverlayVM (GameOverlays.MenuOverlayType type)
override void	RefreshValues ()
	Used for updating localized texts.
override void	ExecuteOnOverlayClosed ()
	Fires when player clicks close button on overlay. Does not capture other exits.
override void	UpdateOverlayType (GameOverlays.MenuOverlayType newType)
override void	Refresh ()
void	ExecuteAddCompanion ()
override void	OnFinalize ()
Public Member Functions inherited from TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.GameMenuOverlay
	GameMenuOverlay ()
override void	RefreshValues ()
	Used for updating localized texts.
virtual void	ExecuteOnOverlayClosed ()
	Fires when player clicks close button on overlay. Does not capture other exits.
virtual void	ExecuteOnOverlayOpened ()
override void	OnFinalize ()
void	ClearOverlay ()
virtual void	Refresh ()
virtual void	UpdateOverlayType (GameOverlays.MenuOverlayType newType)
virtual void	OnFrameTick (float dt)
void	HourlyTick ()
Public Member Functions inherited from TaleWorlds.Library.ViewModel
void	OnPropertyChanged ([CallerMemberName] string propertyName=null)
	Method for notifying binded views about the changes in a property. Uses reflection to get the value of the property. If reflection is not needed or updated value of the property is already known, use OnPropertyChangedWithValue() instead.
void	OnPropertyChangedWithValue< T > (T value, [CallerMemberName]string propertyName=null)
	Faster method for notifying binded views about the changes in a property. To avoid reflection, caller can pass changed value to this method. If caller does not have access rights to the value, use OnPropertyChanged() instead.
void	OnPropertyChangedWithValue (bool value, [CallerMemberName] string propertyName=null)
void	OnPropertyChangedWithValue (int value, [CallerMemberName] string propertyName=null)
void	OnPropertyChangedWithValue (float value, [CallerMemberName] string propertyName=null)
void	OnPropertyChangedWithValue (uint value, [CallerMemberName] string propertyName=null)
void	OnPropertyChangedWithValue (Color value, [CallerMemberName] string propertyName=null)
void	OnPropertyChangedWithValue (double value, [CallerMemberName] string propertyName=null)
void	OnPropertyChangedWithValue (Vec2 value, [CallerMemberName] string propertyName=null)
object	GetViewModelAtPath (BindingPath path, bool isList)
object	GetViewModelAtPath (BindingPath path)
object	GetPropertyValue (string name, PropertyTypeFeeder propertyTypeFeeder)
object	GetPropertyValue (string name)
Type	GetPropertyType (string name)
void	SetPropertyValue (string name, object value)
virtual void	OnFinalize ()
void	ExecuteCommand (string commandName, object[] parameters)
virtual void	RefreshValues ()
	Used for updating localized texts.
object	GetViewModelAtPath (BindingPath path)
object	GetViewModelAtPath (BindingPath path, bool isList)
object	GetPropertyValue (string name)
object	GetPropertyValue (string name, PropertyTypeFeeder propertyTypeFeeder)
void	SetPropertyValue (string name, object value)
void	ExecuteCommand (string commandName, object[] parameters)

Protected Member Functions
override void	ExecuteOnSetAsActiveContextMenuItem (GameMenuPartyItemVM troop)
Protected Member Functions inherited from TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.GameMenuOverlay
virtual void	ExecuteOnSetAsActiveContextMenuItem (GameMenuPartyItemVM troop)
void	ExecuteTroopAction (object o)
Protected Member Functions inherited from TaleWorlds.Library.ViewModel
	ViewModel ()
bool	SetField< T > (ref T field, T value, string propertyName)

Properties
string	RemainingFoodText [get, set]
int	ProsperityChangeAmount [get, set]
int	MilitiaChangeAmount [get, set]
int	GarrisonChangeAmount [get, set]
int	GarrisonAmount [get, set]
int	CrimeChangeAmount [get, set]
int	LoyaltyChangeAmount [get, set]
int	SecurityChangeAmount [get, set]
int	FoodChangeAmount [get, set]
BasicTooltipViewModel	RemainingFoodHint [get, set]
BasicTooltipViewModel	SecurityHint [get, set]
HintViewModel	PartyFilterHint [get, set]
HintViewModel	CharacterFilterHint [get, set]
BasicTooltipViewModel	MilitasHint [get, set]
BasicTooltipViewModel	GarrisonHint [get, set]
BasicTooltipViewModel	ProsperityHint [get, set]
BasicTooltipViewModel	LoyaltyHint [get, set]
BasicTooltipViewModel	WallsHint [get, set]
BasicTooltipViewModel	CrimeHint [get, set]
HintViewModel	LeaveMembersHint [get, set]
ImageIdentifierVM	SettlementOwnerBanner [get, set]
MBBindingList< GameMenuPartyItemVM >	CharacterList [get, set]
MBBindingList< GameMenuPartyItemVM >	PartyList [get, set]
MBBindingList< StringItemWithHintVM >	IssueList [get, set]
string	MilitasLbl [get, set]
string	GarrisonLbl [get, set]
string	CrimeLbl [get, set]
bool	CanLeaveMembers [get, set]
string	ProsperityLbl [get, set]
string	LoyaltyLbl [get, set]
string	SecurityLbl [get, set]
string	WallsLbl [get, set]
int	WallsLevel [get, set]
string	SettlementNameLbl [get, set]
bool	IsFortification [get, set]
bool	IsCrimeEnabled [get, set]
bool	IsNoGarrisonWarning [get, set]
bool	IsCrimeLabelHighlightEnabled [get, set]
bool	IsLoyaltyRebellionWarning [get, set]
Properties inherited from TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.GameMenuOverlay
bool	IsContextMenuEnabled [get, set]
bool	IsInitializationOver [get, set]
bool	IsInfoBarExtended [get, set]
MBBindingList< StringItemWithEnabledAndHintVM >	ContextList [get, set]
int	CurrentOverlayType [get, set]
Properties inherited from TaleWorlds.Library.ViewModel
PropertyChangedEventHandler	PropertyChanged
PropertyChangedWithValueEventHandler	PropertyChangedWithValue
PropertyChangedWithBoolValueEventHandler	PropertyChangedWithBoolValue
PropertyChangedWithIntValueEventHandler	PropertyChangedWithIntValue
PropertyChangedWithFloatValueEventHandler	PropertyChangedWithFloatValue
PropertyChangedWithUIntValueEventHandler	PropertyChangedWithUIntValue
PropertyChangedWithColorValueEventHandler	PropertyChangedWithColorValue
PropertyChangedWithDoubleValueEventHandler	PropertyChangedWithDoubleValue
PropertyChangedWithVec2ValueEventHandler	PropertyChangedWithVec2Value

Additional Inherited Members
Static Public Member Functions inherited from TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.GameMenuOverlay
static GameMenuOverlay	GetOverlay (GameOverlays.MenuOverlayType menuOverlayType)
Static Public Member Functions inherited from TaleWorlds.Library.ViewModel
static void	CollectPropertiesAndMethods ()
Public Attributes inherited from TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.GameMenuOverlay
string	GameMenuOverlayName
Static Public Attributes inherited from TaleWorlds.Library.ViewModel
static bool	UIDebugMode
Protected Attributes inherited from TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.GameMenuOverlay
GameMenuPartyItemVM	_contextMenuItem
Events inherited from TaleWorlds.Library.IViewModel
PropertyChangedWithValueEventHandler	PropertyChangedWithValue
PropertyChangedWithBoolValueEventHandler	PropertyChangedWithBoolValue
PropertyChangedWithIntValueEventHandler	PropertyChangedWithIntValue
PropertyChangedWithFloatValueEventHandler	PropertyChangedWithFloatValue
PropertyChangedWithUIntValueEventHandler	PropertyChangedWithUIntValue
PropertyChangedWithColorValueEventHandler	PropertyChangedWithColorValue
PropertyChangedWithDoubleValueEventHandler	PropertyChangedWithDoubleValue
PropertyChangedWithVec2ValueEventHandler	PropertyChangedWithVec2Value

Constructor & Destructor Documentation

SettlementMenuOverlayVM()

TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.SettlementMenuOverlayVM.SettlementMenuOverlayVM

(

GameOverlays::MenuOverlayType

type

)

Member Function Documentation

RefreshValues()

override void TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.SettlementMenuOverlayVM.RefreshValues ( )

virtual

Reimplemented from TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.GameMenuOverlay.

ExecuteOnSetAsActiveContextMenuItem()

override void TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.SettlementMenuOverlayVM.ExecuteOnSetAsActiveContextMenuItem ( GameMenuPartyItemVM  troop )

protectedvirtual

Reimplemented from TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.GameMenuOverlay.

ExecuteOnOverlayClosed()

override void TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.SettlementMenuOverlayVM.ExecuteOnOverlayClosed ( )

virtual

Reimplemented from TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.GameMenuOverlay.

UpdateOverlayType()

override void TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.SettlementMenuOverlayVM.UpdateOverlayType ( GameOverlays::MenuOverlayType  newType )

virtual

Reimplemented from TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.GameMenuOverlay.

Refresh()

override void TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.SettlementMenuOverlayVM.Refresh ( )

virtual

Reimplemented from TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.GameMenuOverlay.

ExecuteAddCompanion()

void TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.SettlementMenuOverlayVM.ExecuteAddCompanion

(

)

OnFinalize()

override void TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.SettlementMenuOverlayVM.OnFinalize ( )

virtual

Reimplemented from TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.GameMenuOverlay.

Property Documentation

RemainingFoodText

string TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.SettlementMenuOverlayVM.RemainingFoodText

getset

ProsperityChangeAmount

int TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.SettlementMenuOverlayVM.ProsperityChangeAmount

getset

MilitiaChangeAmount

int TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.SettlementMenuOverlayVM.MilitiaChangeAmount

getset

GarrisonChangeAmount

int TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.SettlementMenuOverlayVM.GarrisonChangeAmount

getset

GarrisonAmount

int TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.SettlementMenuOverlayVM.GarrisonAmount

getset

CrimeChangeAmount

int TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.SettlementMenuOverlayVM.CrimeChangeAmount

getset

LoyaltyChangeAmount

int TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.SettlementMenuOverlayVM.LoyaltyChangeAmount

getset

SecurityChangeAmount

int TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.SettlementMenuOverlayVM.SecurityChangeAmount

getset

FoodChangeAmount

int TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.SettlementMenuOverlayVM.FoodChangeAmount

getset

RemainingFoodHint

BasicTooltipViewModel TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.SettlementMenuOverlayVM.RemainingFoodHint

getset

SecurityHint

BasicTooltipViewModel TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.SettlementMenuOverlayVM.SecurityHint

getset

PartyFilterHint

HintViewModel TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.SettlementMenuOverlayVM.PartyFilterHint

getset

CharacterFilterHint

HintViewModel TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.SettlementMenuOverlayVM.CharacterFilterHint

getset

MilitasHint

BasicTooltipViewModel TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.SettlementMenuOverlayVM.MilitasHint

getset

GarrisonHint

BasicTooltipViewModel TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.SettlementMenuOverlayVM.GarrisonHint

getset

ProsperityHint

BasicTooltipViewModel TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.SettlementMenuOverlayVM.ProsperityHint

getset

LoyaltyHint

BasicTooltipViewModel TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.SettlementMenuOverlayVM.LoyaltyHint

getset

WallsHint

BasicTooltipViewModel TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.SettlementMenuOverlayVM.WallsHint

getset

CrimeHint

BasicTooltipViewModel TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.SettlementMenuOverlayVM.CrimeHint

getset

LeaveMembersHint

HintViewModel TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.SettlementMenuOverlayVM.LeaveMembersHint

getset

SettlementOwnerBanner

ImageIdentifierVM TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.SettlementMenuOverlayVM.SettlementOwnerBanner

getset

CharacterList

MBBindingList<GameMenuPartyItemVM> TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.SettlementMenuOverlayVM.CharacterList

getset

PartyList

MBBindingList<GameMenuPartyItemVM> TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.SettlementMenuOverlayVM.PartyList

getset

IssueList

MBBindingList<StringItemWithHintVM> TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.SettlementMenuOverlayVM.IssueList

getset

MilitasLbl

string TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.SettlementMenuOverlayVM.MilitasLbl

getset

GarrisonLbl

string TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.SettlementMenuOverlayVM.GarrisonLbl

getset

CrimeLbl

string TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.SettlementMenuOverlayVM.CrimeLbl

getset

CanLeaveMembers

bool TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.SettlementMenuOverlayVM.CanLeaveMembers

getset

ProsperityLbl

string TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.SettlementMenuOverlayVM.ProsperityLbl

getset

LoyaltyLbl

string TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.SettlementMenuOverlayVM.LoyaltyLbl

getset

SecurityLbl

string TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.SettlementMenuOverlayVM.SecurityLbl

getset

WallsLbl

string TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.SettlementMenuOverlayVM.WallsLbl

getset

WallsLevel

int TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.SettlementMenuOverlayVM.WallsLevel

getset

SettlementNameLbl

string TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.SettlementMenuOverlayVM.SettlementNameLbl

getset

IsFortification

bool TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.SettlementMenuOverlayVM.IsFortification

getset

IsCrimeEnabled

bool TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.SettlementMenuOverlayVM.IsCrimeEnabled

getset

IsNoGarrisonWarning

bool TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.SettlementMenuOverlayVM.IsNoGarrisonWarning

getset

IsCrimeLabelHighlightEnabled

bool TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.SettlementMenuOverlayVM.IsCrimeLabelHighlightEnabled

getset

IsLoyaltyRebellionWarning

bool TaleWorlds.CampaignSystem.ViewModelCollection.GameMenu.Overlay.SettlementMenuOverlayVM.IsLoyaltyRebellionWarning

getset