Structured Pacenote Schema

Defines the schema for structured pacenote fields - the machine-readable description format for rally corners, caution levels, modifiers, and special events. Provides field definitions with types, defaults, and valid ranges/values.

Public API

Schema Fields

Corner Descriptors

Caution Descriptors

Modifiers

Special

System Pacenotes

The schema also defines system pacenote names (not structured fields, but listed for reference):

system = {
  'damage', 'go',
  'countdown1', 'countdown2', 'countdown3', 'countdown4', 'countdown5',
  'firstnoteintro', 'firstnoteoutro',
  'finish'
}

How It Works

1. Schema defines the contract for structured pacenote data
2. initDefaultFields(fields) populates a table with all defaults - used by Structured:init()
3. default(keyName) provides individual field defaults
4. The text compositor uses this schema to know which fields exist and their types
5. Legacy migrations in Structured:onDeserialized handle old value ranges (e.g., cornerLength 20 → 50)

Usage Example

local Schema = require('gameplay/rally/notebook/structured/schema')

-- Initialize a fields table with defaults
local fields = {}
Schema.initDefaultFields(fields)
-- fields.cornerSeverity == -1
-- fields.cornerDirection == 0
-- fields.modDontCut == false
-- etc.

-- Get a single default
local defaultSeverity = Schema.default('cornerSeverity')  -- -1

-- Check schema definition
local severityDef = Schema.schema.cornerSeverity
-- { type='number', default=-1, min=-1, max=100 }

See Also

• Library Compositor - Related reference
• TextCompositor - Structured Pacenote Text Generation - Related reference
• VisualCompositor - Pacenote Visual Icon Generation - Related reference
• Gameplay Systems Guide - Guide