NRF SDK 0.9
Wiki/Reference

Reference

The complete Kotlin API

Public Kotlin/Native and Kotlin/JVM declarations, grouped by purpose.

Create a mod · Kotlin/Native

The nimby module is included in the Kotlin kit. The Gradle plugin provides the native bridge and mod loading.

AutomaticDriving — Build generic instructions with speeds chosen by your mod. Files — Read a bounded UTF-8 file from Kotlin/Native. GameDateTime — Public Kotlin SDK declarations. Mod — Observations, settings, decisions and signalling and driving contracts. ModOptions — Global player preferences and shortcuts configurable from the NRF Hub tab of the game options. ModResources — Public Kotlin SDK declarations. ModServices — Declare a tool or an action available when another mod is loaded. NumberSetting — Persistent bounded integer settings in signal panels. SignalAnimation — Static and blinking images declared by the mod, animated using game time. SignalMod — Indication and the earlier shared-vocabulary declaration; prefer signalModel for new projects. SignalModel — Independent models: enums, rules, images, driving and typed neighbour access. SignalTypes — Validate signal model identifiers, catalogues and checkboxes. ToolContext — Read the network, prepare placement, publish buttons and write to the log from a tool. ToolOperationException — Typed operation refusals and recovery of temporary presentations. ToolTopology — Track traversal using observed distances and connections. ToolWindow — Public Kotlin SDK declarations. TrainObservation — Copied trains, services, lines and stops available in callbacks. TrainTypes · Kotlin/Native — Typed identifiers, read options and material characteristics. Translations — UI text translated from the mod JSON, with arguments and fallback.

Create a tool · Kotlin/JVM

The fr.nimby.sdk module provides reads and commands for external tools. Its connections must be closed.

Construction — Tickets and results for the experimental construction bridge. DiagnosticLog — Application logs with rotation, repeated-message grouping and error tracking. DrivingObservation — Targeted train reads and declared vehicle characteristics. ModControl — Scenario leases, temporary commands and mod responses. Nimby — Client entry point: connection and functions grouped by purpose in Game. NimbyClient — Connections, captures, targeted reads and commands for the Kotlin/JVM client. Observation — Observed trains, tracks, signals, services, clock and collections. TrackMetric — Convert track fractions and distances in metres. TrainServices — States, alerts and joins of train data within a snapshot. TrainTypes · Kotlin/JVM — Typed identifiers, read options and material characteristics.

Reference scope

29 public Kotlin files are listed. Each constructor property and enum entry has its own entry. Identical names in nimby and fr.nimby.sdk belong to two distinct APIs: choose imports for the correct environment.

Report an error on this page ↗Windows · SDK 0.9.0-alpha.2