Struct InputEvent 

pub struct InputEvent { /* private fields */ }

One safe input event to write into the buffer supplied by SCS.

Implementations

impl InputEvent

pub const fn new(index: InputIndex, value: InputValue) -> Self

pub const fn index(self) -> InputIndex

pub const fn value(self) -> InputValue

pub unsafe fn write_to( self, output: *mut ScsInputEvent, expected_type: InputValueType, ) -> SdkResult

Writes this event into a live SDK output buffer after type validation.

The official callback contract gives the plugin a reusable output buffer and requires it to populate the index plus the union member that matches the registered input type. This method deliberately leaves the inactive union tail untouched instead of replacing the entire raw structure. Besides matching the official sample, that avoids copying bytes for inactive or future-extension storage whose contents have no meaning for the current value.

Errors

Returns SdkError::InvalidParameter when output is null or when the event value does not match the value type registered for that input.

Safety

output must identify the live scs_input_event_t supplied to the current input callback. The callback must be executing directly on the SCS game main thread.

Trait Implementations

impl Clone for InputEvent

fn clone(&self) -> InputEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for InputEvent

impl Debug for InputEvent

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

Formats the value using the given formatter.

impl PartialEq for InputEvent

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for InputEvent