lotussim-script 0.8.7

A library for creating LOTUS-Simulator scripts.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72

//! Logische Controller-Achsen und Force Feedback.
//!
//! Logical controller axes and force feedback.

use lotus_script_sys::FfiObject;
pub use lotus_shared::axis::*;

/// Gibt den aktuellen Achsenwert zurück, im Bereich `0..=1`.
/// Ohne Belegung oder vor dem ersten Messwert ist das [`AXIS_CENTER`] (0,5).
///
/// Returns the current axis value, in the range `0..=1`.
/// Without a binding, or before the first sample, this is [`AXIS_CENTER`] (0.5).
pub fn value(id: &str) -> f32 {
    let id = FfiObject::new(&id);
    unsafe { lotus_script_sys::axis::value(id.packed()) }
}

/// Setzt die Rückstellkraft der Achse.
/// Koeffizient 0 schaltet die Feder aus. Koeffizient und Sättigung übernimmt die Engine
/// unbeschränkt, multipliziert sie mit der Geräte-Intensität und klemmt erst danach auf `0..=1`.
/// `offset` verschiebt die Federmitte und wird danach auf `-1..=1` geklemmt; `0` lässt sie unverändert.
///
/// Sets the restoring force of the axis.
/// A coefficient of 0 turns the spring off. The engine takes coefficient and saturation
/// unrestricted, multiplies them by the device intensity, and only then clamps to `0..=1`.
/// `offset` shifts the spring center and is then clamped to `-1..=1`; `0` leaves it unchanged.
pub fn center_force(id: &str, coefficient: f32, saturation: f32, offset: f32) {
    let id = FfiObject::new(&id);
    unsafe {
        lotus_script_sys::axis::center_force(id.packed(), coefficient, saturation, offset);
    }
}

/// Setzt die Reibung der Achse. 0 schaltet sie aus.
/// Die Engine übernimmt den Koeffizienten unbeschränkt, multipliziert mit der Geräte-Intensität
/// und klemmt erst danach auf `0..=1`.
///
/// Sets the friction of the axis. 0 turns it off.
/// The engine takes the coefficient unrestricted, multiplies by the device intensity,
/// and only then clamps to `0..=1`.
pub fn friction(id: &str, coefficient: f32) {
    let id = FfiObject::new(&id);
    unsafe { lotus_script_sys::axis::friction(id.packed(), coefficient) }
}

/// Setzt die Schwingung der Achse. Magnitude 0 schaltet sie aus.
/// Die Stärke übernimmt die Engine unbeschränkt, multipliziert mit der Geräte-Intensität
/// und klemmt erst danach auf `0..=1`.
///
/// Sets the oscillation of the axis. A magnitude of 0 turns it off.
/// The engine takes the strength unrestricted, multiplies by the device intensity,
/// and only then clamps to `0..=1`.
pub fn vibration(id: &str, magnitude: f32, frequency_hz: f32) {
    let id = FfiObject::new(&id);
    unsafe { lotus_script_sys::axis::vibration(id.packed(), magnitude, frequency_hz) }
}

/// Registriert Achsen bei der Engine.
/// Aufruf aus [`crate::Script::init`] oder am Anfang von [`crate::Script::actions`].
/// [`crate::script`] ruft das nicht auf, bestehende Addon-Scripts bleiben unverändert.
///
/// Registers axes with the engine.
/// Call this from [`crate::Script::init`] or at the start of [`crate::Script::actions`].
/// [`crate::script`] does not call it, so existing addon scripts stay unchanged.
pub fn register_many(axes: &[RegisterAxis]) {
    for axis in axes {
        let axis = FfiObject::new(&axis);
        unsafe {
            lotus_script_sys::axis::register(axis.packed());
        }
    }
}