NRF SDK 0.9Commencer
Trouver la bonne fonction
Partez du résultat souhaité pour choisir une API Native ou JVM et son guide.
Signaux et outils intégrés au jeu
Utilisez le package nimby dans un projet Kotlin/Native. Les fonctions ci-dessous sont des points d’entrée ; leurs guides expliquent les conditions, les valeurs inconnues et les résultats à traiter. Vos règles restent propres à votre mod.
| Résultat recherché | API à consulter | Décision de l’auteur |
|---|---|---|
| Plusieurs modèles de signaux | signalModel · signalMod · signal · Indication | Types d’aspect et de motif, règles et repli de chaque modèle. |
| Décider à partir du réseau | rules · next · of · invalidNetwork | Priorités locales, dépendance au voisin et liens non résolus. |
| Détecter une approche en amont | observeApproach · trainApproaching · approachingTrain | Nombre de cantons observés et effet d’une approche confirmée. |
| Réglages persistants et visibilité | checkbox · NumberSetting · enabled · number · settingsStatus | Identifiants stables, défauts, bornes, ordre et visibilité. |
| Préférences communes aux parties du joueur | options · BooleanOption · IntegerOption · ChoiceOption · value | Identifiants stables, valeurs par défaut, bornes et lecture dans les callbacks. |
| Raccourci personnalisable pour une fenêtre | window · ToolWindow.title · ToolWindow.shortcut | Titre de l’action et raccourci initial ; le SDK gère l’affectation du joueur et les conflits. |
| Apparence fixe ou animée | construction · images · appearance · steady · blink | Ressources, ordre du catalogue et cadence en temps simulé. |
| Décrire la conduite | driving · AutomaticDriving · DrivingRule | Vitesses en m/s, arrêt et conditions de libération. |
| Partager une préparation entre signaux | prepareNetwork · Signal | Calcul borné sur des copies, sans modifier les données persistantes. |
| Proposer un service optionnel | action · whenMod · service · toolMod | Disponibilité du fournisseur et comportement en son absence. |
| Panneaux, champs et fenêtres | ToolContext · ToolNumberInput · ToolWindow | Validation de la saisie, génération de fenêtre et durée des callbacks. |
| Parcourir et copier des signaux | ToolTopology · travelDirection · placementAt | Limites de parcours, longueurs inconnues et sens de circulation. |
| Prévisualiser puis construire | showSignalPreview · createSignals · ConstructionResult | Confirmation, suivi et annulation autorisée. |
| Lire des trains depuis un outil | ToolContext.trains · TrainQuery · TrainSnapshot | Groupes nécessaires, fraîcheur et conservation des copies. |
| Lire le calendrier | ToolContext.clock · GameDateTime | Temps simulé et conversion des dates. |
| Traduire et lire des ressources | tr · translations.json · readTextFile | Textes visibles, langue de repli et chemins relatifs au paquet. |
Applications Kotlin/JVM connectées
Utilisez fr.nimby.sdk lorsque votre programme s’exécute séparément du jeu. Commencez par Nimby.connect, fermez les ressources que vous ouvrez et choisissez vos lectures selon votre besoin. Une observation conservée reste une copie de son instant de capture.
| Résultat recherché | API à consulter | Point à vérifier |
|---|---|---|
| Connexion et copie du réseau | Nimby.connect · Game · snapshot · Observation | Jeu choisi, durée de la connexion, disponibilité et session. |
| Trains et groupes optionnels | Game.trains.snapshot · TrainQuery · TrainId · Observation | Demandé, non demandé, absent et vide sont des états distincts. |
| Lignes et tags | Line · LineId · LineType · Tag · tagsForLine | Identités, héritage et valeurs effectivement disponibles. |
| Service, horaires et retard | TrainDetails · Timetable · LineStop · predictedArrivalDelaySeconds | Heure absolue, offset de plan et retard prédit signé. |
| Matériel et composition | TrainCharacteristics · TrainVehicle · VehicleModel · TrainMetadata | Configuration, valeurs courantes, unités, capacité et voyageurs. |
| Dynamique ciblée | readTrain · DrivingObservation · TrainDynamics | Vitesse observée, propriétés physiques et données inconnues. |
| Géométrie et distances | TrackMetric · fraction · lengthM | Sens et longueur connue avant conversion en mètres. |
| Calendrier | Game.clock · SimulationClock | Temps simulé et résultat des changements demandés. |
| Contrôle temporaire | Game.mods · ModControlSession · ControlRequest | Permissions, durée, restauration et fermeture. |
| Création et suivi | Construction | Tickets, résultats partiels et annulation autorisée. |
| Diagnostic de votre application | DiagnosticLog | Événements utiles, sans message à chaque lecture. |
Du projet au paquet vérifié
Le plugin Gradle concerne les projets Native ; la référence Kotlin distingue chaque API Native/JVM. Pour une fonction précise, ouvrez son type, lisez les unités et les résultats inconnus, puis suivez l’exemple du guide lié.