📚 API Reference
Welcome to the CSV Standard API reference. This section provides a comprehensive technical breakdown of the classes and interfaces that drive the Standard tier, bridging raw data grids to strongly-typed Unity ScriptableObjects.
Core Architecture Classes
1. CSVRecord
- Namespace:
Canley.Utility.CSV.Standard - Base Class:
ScriptableObject - Role: Represents a single row of data, acting as both a live strongly-typed C# class for your game logic and a background container via its Shadow Dictionary (
rawValues) to ensure lossless round-tripping. - Key Features: Supports slug/natural key identification (
recordLabel), surrogate primary keys (id), custom inbound/outbound parsing hooks (OnImportField/OnExportField), and a convenient dictionary indexer (this[string fieldName]).
2. CSVTable<T>
- Namespace:
Canley.Utility.CSV.Standard - Role: The primary orchestrator and controller for your data collections, managing a
List<T>whereTinherits fromCSVRecord. - Key Features: Handles automated reflection mapping, hard-typed validation gates, polymorphic loading, predicate filtering (
GetRecords), live reflection sorting (SortByField), and automated UI spawning (SpawnUI).
Core Interfaces
3. ICSVDisplayable<T>
- Namespace:
Canley.Utility.CSV.Standard - Role: A generic contract acting as the bridge between your data records and your visual interface components.
- Key Features: Ensures prefabs used with the
SpawnUImethod feature a standardized implementation to automatically receive and display record values (e.g., populating text elements or icons).