Class FoodItem

Food Items are items that spoil over time, See DurabilityItems.md

Inheritance
System.Object
ItemLinkable
ItemRepresentation
Item
DurabilityItem
FoodItem
SeedItem
Inherited Members
Namespace: Eco.Gameplay.Items
Assembly: Eco.Gameplay.dll
Syntax
[Compostable]
[ItemGroup("Food")]
public abstract class FoodItem : DurabilityItem, IItem, ILinkableParameterized<LinkConfig>, ILinkable, IHasIcon, INotifyPropertyChanged, IInteractor, IHasInteractions, IPlaceableItem, IController, IViewController, IHasUniversalID

Constructors

FoodItem()

Declaration
protected FoodItem()

Properties

BaseShelfLife

Declaration
protected abstract float BaseShelfLife { get; }
Property Value
Type Description
System.Single

Calories

Declaration
public abstract float Calories { get; }
Property Value
Type Description
System.Single

CanBeHeld

Declaration
public override bool CanBeHeld { get; }
Property Value
Type Description
System.Boolean
Overrides

DefaultMinRequiredDurabilityInTradeOffers

Declaration
public override float DefaultMinRequiredDurabilityInTradeOffers { get; }
Property Value
Type Description
System.Single
Overrides

Nutrition

Declaration
public abstract Nutrients Nutrition { get; }
Property Value
Type Description
Nutrients

SpoilageTime

Declaration
public ImmutableCountdown SpoilageTime { get; set; }
Property Value
Type Description
ImmutableCountdown

Methods

Clone()

Declaration
public override Item Clone()
Returns
Type Description
Item
Overrides

Consume(Player)

RPC that is called by client when its time to actually remove food item from inventory an eat it

Declaration
public virtual string Consume(Player player)
Parameters
Type Name Description
Player player
Returns
Type Description
System.String

GetDurability()

Declaration
public override float GetDurability()
Returns
Type Description
System.Single
Overrides

GetSpoilageTimeBasedOnDurability(Single, Boolean)

Create a new immutable countdown based on the given durability value and the current storage modifier.

Declaration
public ImmutableCountdown GetSpoilageTimeBasedOnDurability(float durability, bool paused = false)
Parameters
Type Name Description
System.Single durability
System.Boolean paused
Returns
Type Description
ImmutableCountdown

OnUsed(Player, ItemStack)

On food item right click - we point toolbar override slot with this item stack of food. for client so it knows what item will be used Also we immediately call consume (so item will be eaten with calories and removed from inventory)

Declaration
public override string OnUsed(Player player, ItemStack itemStack)
Parameters
Type Name Description
Player player
ItemStack itemStack
Returns
Type Description
System.String
Overrides

SetDurability(Single)

Declaration
public override void SetDurability(float d)
Parameters
Type Name Description
System.Single d
Overrides

SetSpoilageTimeBasedOnDurability(Single)

Declaration
public void SetSpoilageTimeBasedOnDurability(float durability)
Parameters
Type Name Description
System.Single durability

UpdateSpoilageTime(Single)

Sets the spoilage time based on durability or updates the durability with spoilage progress if the storage is still the same.

Declaration
public void UpdateSpoilageTime(float shelfLifeMultiplier = 1F)
Parameters
Type Name Description
System.Single shelfLifeMultiplier

Implements

System.ComponentModel.INotifyPropertyChanged

Extension Methods