CityBuilderTown.TownViewWalkerEnergyBar Class Reference

Detailed Description

view that visualizes a walkers current energy in percent

https://citybuilder.softleitner.com/manual/town

Inheritance diagram for CityBuilderTown.TownViewWalkerEnergyBar:

Public Member Functions
bool	HasValue (Walker walker)
	whether the value even applies to the walker in question
float	GetMaximum (Walker walker)
	the maximum value this value may get to for example storage capacity for item quantities important for bars that use a ratio
float	GetValue (Walker walker)
	checks for the value the walker currently has
Vector3	GetPosition (Walker walker)
	the world position that the value should be visualized at especially relevant for global values that are not created as a child of the walker
Public Member Functions inherited from CityBuilderCore.ViewWalkerBarBase
override void	Activate ()
override void	Deactivate ()
Public Member Functions inherited from CityBuilderCore.View
void	Activate ()
void	Deactivate ()

Properties
override IWalkerValue	WalkerValue [get]
Properties inherited from CityBuilderCore.ViewWalkerBarBase
IWalkerValue	WalkerValue [get]

Additional Inherited Members
Public Attributes inherited from CityBuilderCore.ViewWalkerBarBase
WalkerValueBar	Bar
Public Attributes inherited from CityBuilderCore.View
string	Name

Member Function Documentation

GetMaximum()

float CityBuilderTown.TownViewWalkerEnergyBar.GetMaximum

(

Walker

walker

)

the maximum value this value may get to
for example storage capacity for item quantities
important for bars that use a ratio

Parameters

walker

the walker in question

Returns

max value the walker might ever return

Implements CityBuilderCore.IWalkerValue.

GetPosition()

Vector3 CityBuilderTown.TownViewWalkerEnergyBar.GetPosition

(

Walker

walker

)

the world position that the value should be visualized at
especially relevant for global values that are not created as a child of the walker

Parameters

walker

the walker in question

Returns

where the value should be visualized

Implements CityBuilderCore.IWalkerValue.

GetValue()

float CityBuilderTown.TownViewWalkerEnergyBar.GetValue

(

Walker

walker

)

checks for the value the walker currently has

Parameters

walker

the walker of which we want to know the value

Returns

the value of the walker

Implements CityBuilderCore.IWalkerValue.

HasValue()

bool CityBuilderTown.TownViewWalkerEnergyBar.HasValue

(

Walker

walker

)

whether the value even applies to the walker in question

Parameters

walker

the walker in question

Returns

true when the walker has this value

Implements CityBuilderCore.IWalkerValue.