SplitScript reference

This reference is generated from the same compiler-owned catalogs used by parsing, type checking, migration diagnostics, completion, and hover.

Guides

Symbol	Description
Decision guides	Choose a lifecycle block, state-field form, failure boundary, or string unit.
Getting started	Build a first SplitScript autosplitter with the VS Code extension or native CLI.
Language	Syntax, declarations, lifecycle blocks, and contextual values.
Migration	Guidance from ASL and familiar languages to canonical SplitScript.
Porting ASL to SplitScript	Canonical compiler-checked recipes for migrating legacy ASL autosplitters.
SplitScript for C# authors	A concise guide to SplitScript's types, control flow, errors, and autosplitter lifecycle for C# authors.
SplitScript for JavaScript authors	A concise guide to SplitScript's static types, fixed-width numbers, errors, and autosplitter lifecycle for JavaScript authors.
SplitScript for Rust authors	A concise guide to SplitScript's inference, capabilities, error values, async behavior, and autosplitter lifecycle for Rust authors.

Namespaces

Symbol	Description
future	Coordinates lazy asynchronous values without exposing threads or background tasks.
runtime	Reads metadata about the autosplitting runtime host.
timer	Reads information from the timer.
Unity	Provides Unity runtime utilities outside managed schema declarations.

Types

Symbol	Description
[T]	Stores an indexed sequence of values.
address	Stores a process address.
bool	Stores a boolean value.
char	Stores one Unicode scalar value.
Duration	Represents a precise span of time.
f32	Stores a 32-bit floating-point number.
f64	Stores a 64-bit floating-point number.
File	Provides whole-file, read-only filesystem operations.
FileVersion	A four-part numeric Windows executable version.
GBAEmulator	Retains a discovered GBA emulator memory mapping.
GCNEmulator	Retains a discovered Nintendo GameCube MEM1 mapping.
GenesisEmulator	Retains a discovered Sega Genesis work-RAM mapping.
i16	Stores a 16-bit signed integer.
i32	Stores a 32-bit signed integer.
i64	Stores a 64-bit signed integer.
i8	Stores an 8-bit signed integer.
Instant	Identifies one reading of the runtime's monotonic clock.
IteratorStep<T>	Distinguishes one yielded item from iterator exhaustion.
Map<K, V>	Stores an insertion-ordered association from unique keys to values.
MapEntry<K, V>	Stores one key-value pair yielded while iterating a `Map`.
MemoryPath	Describes a native pointer chain rooted at an address.
MemoryRange	Describes one mapped process-memory range.
MemoryRangeAccess	Selects the permissions required by a mapped-memory query.
Module	Describes a module loaded in the attached process.
ModuleVersionInfo	The fixed numeric versions embedded in a Windows PE module.
MonoVersion	Identifies the supported Unity Mono metadata layouts.
Never	Describes an expression that cannot produce a value.
None	Stores the single unit value `None`.
PointerSize	Describes the native pointer width used by a process module.
Process	Accesses the attached game process.
PS1Emulator	Retains a discovered PlayStation emulator memory mapping.
PS2Emulator	Retains a discovered PlayStation 2 emulator memory mapping.
Set<T>	Stores a growable collection of unique values for one script instance.
SettingsView	Selects either the current or previous values of the script's declared settings.
Signature	Stores a compiled process-memory signature.
SignatureMatch	Identifies a signature selected by a multi-pattern memory scan.
SMSEmulator	Retains a discovered Sega Master System or Game Gear memory mapping.
String	Stores ordinary immutable UTF-8 text in WebAssembly GC memory.
T!	Represents a value or an error.
T..<T	Represents an integer interval whose upper bound is excluded.
T..=T	Represents an integer interval whose upper bound is included.
T?	Represents a value that may be absent.
TimerState	Describes the current timer state.
u16	Stores a 16-bit unsigned integer.
u32	Stores a 32-bit unsigned integer.
u64	Stores a 64-bit unsigned integer.
u8	Stores an 8-bit unsigned integer.
UnityContext	Attachment-scoped Unity engine facilities.
UnityGameObject	A live GameObject in an attached Unity scene hierarchy.
UnityScene	Captures one Unity scene at a particular polling update.
UnityScenes	Reads immutable snapshots from Unity's native scene manager.
WiiEmulator	Retains discovered Nintendo Wii MEM1 and MEM2 mappings.

Capabilities

Symbol	Description
Debug	Produces an unambiguous structural representation of a value.
Display	Supports conversion to a user-facing textual representation.
Equatable	Supports equality comparison.
Float	Identifies floating-point types.
Index	Reads a value selected by bracket indexing.
IndexAssign	Replaces or inserts a value through bracket assignment.
Integer	Identifies integral numeric types.
Iterable	Creates an `Iterator` over a value without consuming that value.
Iterator	Produces a sequence of values one step at a time.
MemoryReadable	Supports deserialization from process memory.
MemoryReader	Reads typed values and bounded strings from an address space.
Numeric	Supports ordered numeric operations.
Signed	Identifies signed numeric types.

State providers

Symbol	Description
GBA	Attaches to a supported Game Boy Advance emulator.
GCN	Attaches to a supported Nintendo GameCube emulator.
Genesis	Attaches to a supported Sega Genesis emulator.
Native	Attaches to one of the native processes named by the state declaration.
PS1	Attaches to a supported PlayStation emulator.
PS2	Attaches to a supported PlayStation 2 emulator.
SMS	Attaches to a supported Sega Master System or Game Gear emulator.
Unity	Attaches to a Unity game and binds declared managed metadata schemas.
Wii	Attaches to a supported Nintendo Wii emulator.

Functions

Symbol	Description
nextTick	Continues attachment on the next runtime update.
print	Prints a diagnostic message.
setTickRate	Changes the autosplitter tick rate.
setVariable	Sets a custom variable in the timer runtime.