TaleWorlds.CampaignSystem.ExplainedNumber Struct Reference

Public Member Functions
	ExplainedNumber (float baseNumber=0f, bool includeDescriptions=false, TextObject baseText=null)
string	GetExplanations ()
List<(string name, float number)>	GetLines ()
void	Add (float value, TextObject description=null, TextObject variable=null)
void	AddFactor (float value, TextObject description=null)
void	LimitMin (float minValue)
void	LimitMax (float maxValue)
void	Clamp (float minValue, float maxValue)

Properties
float	ResultNumber [get]
float	BaseNumber [get]
float	LimitMinValue [get]
float	LimitMaxValue [get]

Constructor & Destructor Documentation

ExplainedNumber()

TaleWorlds.CampaignSystem.ExplainedNumber.ExplainedNumber	(	float	baseNumber = 0f,
		bool	includeDescriptions = false,
		TextObject	baseText = null
	)

Member Function Documentation

GetExplanations()

string TaleWorlds.CampaignSystem.ExplainedNumber.GetExplanations

(

)

GetLines()

List<(string name, float number)> TaleWorlds.CampaignSystem.ExplainedNumber.GetLines

(

)

Add()

void TaleWorlds.CampaignSystem.ExplainedNumber.Add	(	float	value,
		TextObject	description = null,
		TextObject	variable = null
	)

AddFactor()

void TaleWorlds.CampaignSystem.ExplainedNumber.AddFactor	(	float	value,
		TextObject	description = null
	)

LimitMin()

void TaleWorlds.CampaignSystem.ExplainedNumber.LimitMin

(

float

minValue

)

LimitMax()

void TaleWorlds.CampaignSystem.ExplainedNumber.LimitMax

(

float

maxValue

)

Clamp()

void TaleWorlds.CampaignSystem.ExplainedNumber.Clamp	(	float	minValue,
		float	maxValue
	)

Property Documentation

ResultNumber

float TaleWorlds.CampaignSystem.ExplainedNumber.ResultNumber

get

BaseNumber

float TaleWorlds.CampaignSystem.ExplainedNumber.BaseNumber

get

LimitMinValue

float TaleWorlds.CampaignSystem.ExplainedNumber.LimitMinValue

get

LimitMaxValue

float TaleWorlds.CampaignSystem.ExplainedNumber.LimitMaxValue

get