LOTUS Scripting

Rust-API für Scripts im LOTUS-Simulator.

Rust API for LOTUS Simulator scripts.

Verwendung / Usage

Als Script-Autor reicht die eine 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.

Scripts are compiled for wasm32-unknown-unknown and run inside the LOTUS script engine.

use lotus_script::prelude::*;

#[derive(Default)]
struct MyScript;

impl Script for MyScript {
    fn tick(&mut self) {
        // ...
    }

    fn init(&mut self) {
        // ...
    }

    fn on_message(&mut self, msg: lotus_script::message::Message) {
        // ...
    }
}

script!(MyScript);

Der Script-Typ muss Default implementieren. script! exportiert die WASM-Einstiegspunkte.

The script type must implement Default. script! exports the WASM entry points.

Hilfe / Help

• Offline-Hilfe im LOTUS-Simulator
• LOTUS-Forum
• API-Dokumentation auf docs.rs/lotussim-script

Suggestions / Contributions

Submit an issue/PR. But in almost all cases it's better to first open an issue before submitting a PR, so you don't waste your time implementing a PR which may get rejected.

License

This project is licensed under either of

• Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.