NRF SDK 0.9

Référence

SignalAnimation

Images fixes et clignotantes déclarées par le mod, animées sur le temps du jeu.

Contexte d’utilisation

ModulePackageSource SDK
Kotlin/Nativenimbykotlin/src/nimby/SignalAnimation.kt

API publique du SDK 0.9.0-alpha.2. Chaque entrée donne la signature Kotlin et son contrat : sens de la valeur, conditions d’utilisation et effets à connaître. Choisissez les imports du module indiqué ci-dessus.

Imports de cette page
import nimby.SignalAnimation
import nimby.steady
import nimby.blink

SignalAnimation

nimby · class
class SignalAnimation

Description d’affichage construite avec steady ou blink. Le SDK gère le rythme ; aucun thread ou minuteur de mod n’est nécessaire. Le constructeur est réservé au SDK.

SignalAnimation.first

nimby · val
val first: String

Chemin de l’image affichée au temps simulé zéro et pendant la première moitié du cycle.

SignalAnimation.alternate

nimby · val
val alternate: String

Chemin de l’autre image du clignotement. Identique à first pour une image fixe.

SignalAnimation.everyMs

nimby · val
val everyMs: Long

Durée de chaque image en millisecondes simulées ; zéro pour steady. Pour blink, de 100 à 10000 inclus.

SignalAnimation.frameAt

nimby · fun
fun frameAt(simulationMs: Long): String

Renvoie l’image correspondant à un temps simulé positif ou nul, en ms. Le même instant donne toujours la même image, notamment en pause ; utile aux tests purs.

steady

nimby · fun
fun steady(path: String): SignalAnimation

Déclare une image fixe du catalogue. Chemin non vide de 1 à 95 octets UTF-8, sans caractère nul ; doit aussi être déclaré dans construction.states.

blink

nimby · fun
fun blink(on: String, off: String, everyMs: Long): SignalAnimation

Alterne deux images déclarées toutes les 100 à 10000 ms simulées par image. 500 signifie 500 ms puis 500 ms. Pause et accélération sont respectées ; les signaux de même durée partagent la phase.