Class AssetValueSource<T>

Definition

Namespace: StardewUI.Framework.Sources
Assembly: StardewUI.dll

Value source that looks up an asset registered with SMAPI's content manager.

public class AssetValueSource<T> : StardewUI.Framework.Sources.IValueSource<T>, 
    StardewUI.Framework.Sources.IValueSource, System.IDisposable

Type Parameters

T
The type of asset to retrieve.

Inheritance
Object ⇦ AssetValueSource<T>

Implements
IValueSource<T>, IValueSource, IDisposable

Members

Constructors

Name	Description
AssetValueSource<T>(IAssetCache, string)	Value source that looks up an asset registered with SMAPI's content manager.

Properties

Name	Description
CanRead	Whether or not the source can be read from, i.e. if an attempt to get the Value should succeed.
CanWrite	Whether or not the source can be written back to, i.e. if an attempt to set the Value should succeed.
DisplayName	Descriptive name for the property, used primarily for debug views and log/exception messages.
Value
ValueType	The compile-time type of the value tracked by this source; the type parameter for IValueSource<T>.

Methods

Name	Description
Dispose()
Update(Boolean)	Checks if the value needs updating, and if so, updates Value to the latest.

Details

Constructors

AssetValueSource<T>(IAssetCache, string)

Value source that looks up an asset registered with SMAPI's content manager.

public AssetValueSource<T>(StardewUI.Framework.Content.IAssetCache cache, string name);

Parameters

cache   IAssetCache
Asset cache used to obtain current value/status.

name   string
The asset name/path as it would be supplied to SMAPI in Load<T>(string).

---

Properties

CanRead

Whether or not the source can be read from, i.e. if an attempt to get the Value should succeed.

public bool CanRead { get; }

Property Value

Boolean

---

CanWrite

Whether or not the source can be written back to, i.e. if an attempt to set the Value should succeed.

public bool CanWrite { get; }

Property Value

Boolean

---

DisplayName

Descriptive name for the property, used primarily for debug views and log/exception messages.

public string DisplayName { get; }

Property Value

string

---

Value

public T Value { get; set; }

Property Value

T

---

ValueType

The compile-time type of the value tracked by this source; the type parameter for IValueSource<T>.

public System.Type ValueType { get; }

Property Value

Type

---

Methods

Dispose()

public void Dispose();

---

Update(bool)

Checks if the value needs updating, and if so, updates Value to the latest.

public bool Update(bool force);

Parameters

force   Boolean
If true, forces the source to update its value even if it isn't considered dirty. This should never be used in a regular binding, but can be useful in sources that are intended for occasional or one-shot use such as event handler arguments.

Returns

Boolean

true if the underlying asset expired since the last update; false if the Value was still current.

Remarks

This method is called every frame, for every binding, and providing a correct return value is essential in order to avoid slowdowns due to unnecessary rebinds.

---