Class HomeFurnishingValue

Inheritance
System.Object
HomeFurnishingValue
Implements
System.ComponentModel.INotifyPropertyChanged
Namespace: Eco.Gameplay.Housing.PropertyValues
Assembly: Eco.Gameplay.dll
Syntax
public class HomeFurnishingValue : Object, IController, IViewController, IHasUniversalID, INotifyPropertyChanged

Constructors

HomeFurnishingValue()

Declaration
public HomeFurnishingValue()

Properties

BaseValue

Declaration
public float BaseValue { get; set; }
Property Value
Type Description
System.Single

Category

Declaration
public RoomCategory Category { get; set; }
Property Value
Type Description
RoomCategory

ControllerID

Declaration
public ref int ControllerID { get; }
Property Value
Type Description
System.Int32

DiminishingMultiplierAcrossFullProperty

Declaration
public float DiminishingMultiplierAcrossFullProperty { get; set; }
Property Value
Type Description
System.Single

DiminishingReturnMultiplier

Declaration
public float DiminishingReturnMultiplier { get; set; }
Property Value
Type Description
System.Single

ObjectName

Declaration
public LocString ObjectName { set; }
Property Value
Type Description
LocString

TypeForRoomLimit

Declaration
public LocString TypeForRoomLimit { get; set; }
Property Value
Type Description
LocString

UniquenessObject

When set, defines the value which determines an object uniqueness, insted of the type (which is the default). IE, a painting can link to the painting's owner to determine uniqueness per painter.

Declaration
public Func<WorldObject, object> UniquenessObject { set; }
Property Value
Type Description
System.Func<WorldObject, System.Object>

UniqueObjectName

Declaration
public LocString UniqueObjectName { set; }
Property Value
Type Description
LocString

Methods

CalculateValue(WorldObject, Int32)

Determines the housing value including any reductions

Declaration
public float CalculateValue(WorldObject obj, int uniquenessCountAcrossFullProperty)
Parameters
Type Name Description
WorldObject obj
System.Int32 uniquenessCountAcrossFullProperty
Returns
Type Description
System.Single

Describe(WorldObject, Int32)

Describe the value, taking as a paramter how many of these exist across the whole property being scored.

Declaration
public LocString Describe(WorldObject obj, int uniquenessCountAcrossFullProperty)
Parameters
Type Name Description
WorldObject obj
System.Int32 uniquenessCountAcrossFullProperty
Returns
Type Description
LocString

GetUniquenessObject(WorldObject)

Get the object which we use to determine uniqueness across the property. This may have a special callback attached (like PicutreFrame to get the artist) or be the default of the world object's type.

Declaration
public object GetUniquenessObject(WorldObject obj)
Parameters
Type Name Description
WorldObject obj
Returns
Type Description
System.Object

Events

PropertyChanged

Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
Type Description
System.ComponentModel.PropertyChangedEventHandler

Implements

System.ComponentModel.INotifyPropertyChanged

Extension Methods