Crate lotus_script

Expand description

High-Level-API für LOTUS-Simulator-Scripts (WebAssembly).

High-level API for LOTUS simulator scripts (WebAssembly).

§Einstieg / Getting started

Als Script-Autor reicht die Abhängigkeit lotussim-script. Im Rust-Code heißt das Crate lotus_script.

As a script author, depend only on lotussim-script. In Rust code the crate is named lotus_script.

[dependencies]
lotussim-script = "0.8"

Scripts werden nach wasm32-unknown-unknown gebaut und laufen in der LOTUS-Scriptengine. Der mit script! registrierte Typ muss Default implementieren.

Scripts are compiled for wasm32-unknown-unknown and run inside the LOTUS script engine. The type registered with script! must implement Default.

use lotus_script::prelude::*;

#[derive(Default)]
struct MyScript;

impl Script for MyScript {
    fn init(&mut self) {}

    fn tick(&mut self) {}

    fn on_message(&mut self, msg: Message) {}
}

script!(MyScript);

§Hilfe / Help

Offline-Hilfe im LOTUS-Simulator / in-game offline help of the LOTUS simulator
LOTUS-Forum
Repository-README / repository README

§Features

time: zusätzliche Zeitumrechnungen über die time-Crate / extra time conversions via the time crate
internal: Schnittstellen für die Simulator-Engine, nicht für Addon-Scripts / APIs for the simulator engine, not for addon scripts

Modules§

action: Abfrage registrierter Eingabeaktionen.
content: Laden und Vorhalten von Content-Assets.
font: Bitmap-Schriftarten zum Rendern von Text auf Script-Texturen.
gizmos: Debug-Gizmos.
graphics: Zeichen- und Textur-API für Script-Displays.
input: Maus-Eingabe und Tastatur-Aktionstypen.
log: Logging-Hilfsfunktionen für Scripts.
math: Mathematik-Hilfen und Vektortypen.
message: Nachrichten senden und empfangen.
module: Informationen zum Modul-Slot, auf dem dieses Script läuft.
pis: PIS-Daten und Abfragefunktionen.
prelude: Häufig genutzte Typen und Makros für Script-Implementierungen.
public_vars: Öffentliche Script-Variablen für die Plugin-API.
rand: Zufallszahlen-Generierung für Scripts.
time: Simulationszeit und Tick-Zähler.
var: Lesen und Schreiben von Script-Variablen.
vehicle: Fahrzeugphysik und Zugbildung.

Macros§

public_vars: Deklariert öffentliche Script-Variablen und exportiert sie für die Plugin-API.
script: Registriert einen LOTUS-Script-Typ und exportiert die WASM-Einstiegspunkte.

Structs§

AccelerationVelocity: Lineare und Winkelgeschwindigkeit sowie -beschleunigung im globalen Simulationskoordinatensystem.
Animation: Handle auf eine benannte Animation am aktuellen Objekt.
LocalPointAcceleration: Lineare und Winkelbeschleunigung an einem Punkt einer Animationseinheit.

Enums§

AnimationError: Fehler beim Auflösen oder Abfragen von Animationen.

Traits§

Script: Haupt-Trait für LOTUS-Script-Implementierungen.

Functions§

is_rc: Gibt true zurück, wenn das scriptbehaftete Objekt ferngesteuert ist.