Skip to content

Reference

tilttek/sets
TypeRole
SetsDefines versions, measures progress, records completions and dispatches their events
SetDefinitionA version of a set: members, tiers and rewards; evaluates holdings; read from and written to arrays and JSON
TierA step of a set: a number of members at a level or higher, with its rewards
RewardAn opaque reward a set or a tier declares: kind, reference and quantity
HoldingsWhat a holder owns: each member with its highest level
EvaluationA set measured against holdings: owned, missing, percentage, tiers reached
ProgressAn evaluation with the holder's completions, those kept and those the call recorded
CompletionA set or tier completed once by a holder, with the version and the moment in UTC
IdentifiersThe shapes of codes, members and holders, which other packages reuse
UtcClockThe system's clock in UTC, the default clock
Contract\DefinitionStoreWhere the versions of the sets are kept
Contract\CompletionStoreWhere the completions are kept
Store\InMemoryDefinitionStore, Store\InMemoryCompletionStoreThe stores in memory
Event\SetCompletedDispatched once, when a holder completes a set, with its rewards
Event\TierReachedDispatched once, when a holder reaches a tier, with its rewards
Exception\SetsExceptionThe interface of every exception of the library
Exception\InvalidSet, UnknownSet, DefinitionConflictSee Exceptions

ArrayInput is internal.