ItemView

Read-only view of an Item. Mirrors the *View pattern (e.g. SceneView).

public class ItemView

Inheritance System.Object → ItemView

Properties

CustomFields

Custom fields the writer attached to this item (game-specific metadata).

public IReadOnlyDictionary<string,object> CustomFields { get; }
Property Value

System.Collections.Generic.IReadOnlyDictionary<System.String,System.Object>

Description

Optional author description.

public string? Description { get; }
Property Value

System.String

DisplayName

Display name; resolves under the active locale on each access (lazy) when the view was hydrated with a LocaleService, else the raw source.

public string DisplayName { get; }
Property Value

System.String

Id

Writer’s human-readable item id (e.g. item_keycard). Stable across runs; safe in expressions and analytics.

public string Id { get; }
Property Value

System.String

Stackable

True when this item can occupy a single inventory slot with quantity > 1.

public bool Stackable { get; }
Property Value

System.Boolean

Tags

Authored tag ids (used by expressions and filtering).

public IReadOnlyList<string> Tags { get; }
Property Value

System.Collections.Generic.IReadOnlyList<System.String>

Uuid

Structural uuid — the universal cross-reference key. Use this when storing references to the item in host state.

public string Uuid { get; }
Property Value

System.String

Docs last synced: 2026-07-08
Screenshot viewer