StoryMode.ViewModelCollection.Tutorial.TutorialItemVM Class Reference

Inherits TaleWorlds.Library.ViewModel.

Public Types
enum	ItemPlacements {   Left ,   Right ,   Top ,   Bottom ,   TopLeft ,   TopRight ,   BottomLeft ,   BottomRight ,   Center }

Public Member Functions
	TutorialItemVM ()
void	Init (string tutorialTypeId, bool requiresMouse, Action onFinishTutorial)
override void	RefreshValues ()
	Used for updating localized texts.
void	CloseTutorialPanel ()
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)

Properties
Action< bool >	SetIsActive [get]
HintViewModel	DisableCurrentTutorialHint [get, set]
bool	AreTutorialsEnabled [get, set]
string	TutorialsEnabledText [get, set]
string	TutorialTitleText [get, set]
HintViewModel	DisableAllTutorialsHint [get, set]
string	TitleText [get, set]
string	StepCountText [get, set]
bool	IsEnabled [get, set]
string	DescriptionText [get, set]
string	SoundId [get, set]
ImageIdentifierVM	CenterImage [get, set]
bool	RequiresMouse [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.Library.ViewModel
static void	CollectPropertiesAndMethods ()
Static Public Attributes inherited from TaleWorlds.Library.ViewModel
static bool	UIDebugMode
Protected Member Functions inherited from TaleWorlds.Library.ViewModel
	ViewModel ()
bool	SetField< T > (ref T field, T value, string propertyName)
Events inherited from TaleWorlds.Library.IViewModel
PropertyChangedWithValueEventHandler	PropertyChangedWithValue
PropertyChangedWithBoolValueEventHandler	PropertyChangedWithBoolValue
PropertyChangedWithIntValueEventHandler	PropertyChangedWithIntValue
PropertyChangedWithFloatValueEventHandler	PropertyChangedWithFloatValue
PropertyChangedWithUIntValueEventHandler	PropertyChangedWithUIntValue
PropertyChangedWithColorValueEventHandler	PropertyChangedWithColorValue
PropertyChangedWithDoubleValueEventHandler	PropertyChangedWithDoubleValue
PropertyChangedWithVec2ValueEventHandler	PropertyChangedWithVec2Value

Member Enumeration Documentation

ItemPlacements

enum StoryMode.ViewModelCollection.Tutorial.TutorialItemVM.ItemPlacements

Enumerator
Left
Right
Top
Bottom
TopLeft
TopRight
BottomLeft
BottomRight
Center

Constructor & Destructor Documentation

TutorialItemVM()

StoryMode.ViewModelCollection.Tutorial.TutorialItemVM.TutorialItemVM

(

)

Member Function Documentation

Init()

void StoryMode.ViewModelCollection.Tutorial.TutorialItemVM.Init	(	string	tutorialTypeId,
		bool	requiresMouse,
		Action	onFinishTutorial
	)

RefreshValues()

override void StoryMode.ViewModelCollection.Tutorial.TutorialItemVM.RefreshValues ( )

virtual

Reimplemented from TaleWorlds.Library.ViewModel.

CloseTutorialPanel()

void StoryMode.ViewModelCollection.Tutorial.TutorialItemVM.CloseTutorialPanel

(

)

Property Documentation

SetIsActive

Action<bool> StoryMode.ViewModelCollection.Tutorial.TutorialItemVM.SetIsActive

get

DisableCurrentTutorialHint

HintViewModel StoryMode.ViewModelCollection.Tutorial.TutorialItemVM.DisableCurrentTutorialHint

getset

AreTutorialsEnabled

bool StoryMode.ViewModelCollection.Tutorial.TutorialItemVM.AreTutorialsEnabled

getset

TutorialsEnabledText

string StoryMode.ViewModelCollection.Tutorial.TutorialItemVM.TutorialsEnabledText

getset

TutorialTitleText

string StoryMode.ViewModelCollection.Tutorial.TutorialItemVM.TutorialTitleText

getset

DisableAllTutorialsHint

HintViewModel StoryMode.ViewModelCollection.Tutorial.TutorialItemVM.DisableAllTutorialsHint

getset

TitleText

string StoryMode.ViewModelCollection.Tutorial.TutorialItemVM.TitleText

getset

StepCountText

string StoryMode.ViewModelCollection.Tutorial.TutorialItemVM.StepCountText

getset

IsEnabled

bool StoryMode.ViewModelCollection.Tutorial.TutorialItemVM.IsEnabled

getset

DescriptionText

string StoryMode.ViewModelCollection.Tutorial.TutorialItemVM.DescriptionText

getset

SoundId

string StoryMode.ViewModelCollection.Tutorial.TutorialItemVM.SoundId

getset

CenterImage

ImageIdentifierVM StoryMode.ViewModelCollection.Tutorial.TutorialItemVM.CenterImage

getset

RequiresMouse

bool StoryMode.ViewModelCollection.Tutorial.TutorialItemVM.RequiresMouse

getset