Skip to main content

InputAxisValue

Struct InputAxisValue 

Source
pub struct InputAxisValue(/* private fields */);
Expand description

A finite normalized value for one float input axis.

The raw Input API describes this representation only as a float. The game consumes bindable axes in the inclusive -1.0..=1.0 interval, where zero is the center and the endpoints are the two maximum directions. Real ETS2 validation showed that a value below -1.0 still crosses the ABI boundary successfully but is interpreted by the input UI as the neutral center. Keeping the normalized domain in this type prevents safe plugins from emitting those semantically invalid values.

Construction rejects NaN and infinities as well as finite out-of-range values. Values are never silently clamped because that would hide a device conversion error and would not match the observed game behavior.

Implementations§

Source§

impl InputAxisValue

Source

pub const MIN: InputAxisValue

Maximum movement in the negative direction.

Source

pub const CENTER: InputAxisValue

Neutral centered position.

Source

pub const MAX: InputAxisValue

Maximum movement in the positive direction.

Source

pub fn new(value: f32) -> Result<InputAxisValue, InputAxisValueError>

Validates one normalized axis value.

Both positive and negative zero are accepted and preserved exactly.

§Errors

Returns InputAxisValueError::NotFinite for NaN or either infinity, and InputAxisValueError::OutOfRange for a finite value outside the inclusive -1.0..=1.0 interval.

Source

pub const fn get(self) -> f32

Returns the validated SDK float representation.

Trait Implementations§

Source§

impl Clone for InputAxisValue

Source§

fn clone(&self) -> InputAxisValue

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Copy for InputAxisValue

Source§

impl Debug for InputAxisValue

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
Source§

impl PartialEq for InputAxisValue

Source§

fn eq(&self, other: &InputAxisValue) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for InputAxisValue

Source§

impl TryFrom<f32> for InputAxisValue

Source§

type Error = InputAxisValueError

The type returned in the event of a conversion error.
Source§

fn try_from( value: f32, ) -> Result<InputAxisValue, <InputAxisValue as TryFrom<f32>>::Error>

Performs the conversion.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.