Struct gdnative::api::InputEventJoypadButton

pub struct InputEventJoypadButton { /* fields omitted */ }

core class InputEventJoypadButton inherits InputEvent (reference counted).

Official documentation

See the documentation of this class in the Godot engine's official documentation.

Memory management

The lifetime of this object is automatically managed through reference counting.

Class hierarchy

InputEventJoypadButton inherits methods from:

• InputEvent
• Resource
• Reference
• Object

Safety

All types in the Godot API have "interior mutability" in Rust parlance. To enforce that the official thread-safety guidelines are followed, the typestate pattern is used in the Ref and TRef smart pointers, and the Instance API. The typestate Access in these types tracks whether the access is unique, shared, or exclusive to the current thread. For more information, see the type-level documentation on Ref.

Implementations

impl InputEventJoypadButton

pub fn new() -> Ref<InputEventJoypadButton, Unique>

Creates a new instance of this object.

This is a reference-counted type. The returned object is automatically managed by Ref.

pub fn button_index(&self) -> i64

Button identifier. One of the [enum JoystickList] button constants.

pub fn pressure(&self) -> f64

Represents the pressure the user puts on the button with his finger, if the controller supports it. Ranges from [code]0[/code] to [code]1[/code].

pub fn set_button_index(&self, button_index: i64)

Button identifier. One of the [enum JoystickList] button constants.

pub fn set_pressed(&self, pressed: bool)

If [code]true[/code], the button's state is pressed. If [code]false[/code], the button's state is released.

pub fn set_pressure(&self, pressure: f64)

Represents the pressure the user puts on the button with his finger, if the controller supports it. Ranges from [code]0[/code] to [code]1[/code].

Methods from Deref<Target = InputEvent>

pub fn accumulate(&self, with_event: impl AsArg<InputEvent>) -> bool

Returns [code]true[/code] if the given input event and this input event can be added together (only for events of type [InputEventMouseMotion]).
				The given input event's position, global position and speed will be copied. The resulting [code]relative[/code] is a sum of both events. Both events' modifiers have to be identical.

pub fn as_text(&self) -> GodotString

Returns a [String] representation of the event.

pub fn get_action_strength(&self, action: impl Into<GodotString>) -> f64

Returns a value between 0.0 and 1.0 depending on the given actions' state. Useful for getting the value of events of type [InputEventJoypadMotion].

pub fn device(&self) -> i64

The event's device ID.
			[b]Note:[/b] This device ID will always be [code]-1[/code] for emulated mouse input from a touchscreen. This can be used to distinguish emulated mouse input from physical mouse input.

pub fn is_action(&self, action: impl Into<GodotString>) -> bool

Returns [code]true[/code] if this input event matches a pre-defined action of any type.

pub fn is_action_pressed(
    &self,
    action: impl Into<GodotString>,
    allow_echo: bool
) -> bool

Returns [code]true[/code] if the given action is being pressed (and is not an echo event for [InputEventKey] events, unless [code]allow_echo[/code] is [code]true[/code]). Not relevant for events of type [InputEventMouseMotion] or [InputEventScreenDrag].

Default Arguments

• allow_echo - false

pub fn is_action_released(&self, action: impl Into<GodotString>) -> bool

Returns [code]true[/code] if the given action is released (i.e. not pressed). Not relevant for events of type [InputEventMouseMotion] or [InputEventScreenDrag].

pub fn is_action_type(&self) -> bool

Returns [code]true[/code] if this input event's type is one that can be assigned to an input action.

pub fn is_echo(&self) -> bool

Returns [code]true[/code] if this input event is an echo event (only for events of type [InputEventKey]).

pub fn is_pressed(&self) -> bool

Returns [code]true[/code] if this input event is pressed. Not relevant for events of type [InputEventMouseMotion] or [InputEventScreenDrag].

pub fn set_device(&self, device: i64)

The event's device ID.
			[b]Note:[/b] This device ID will always be [code]-1[/code] for emulated mouse input from a touchscreen. This can be used to distinguish emulated mouse input from physical mouse input.

pub fn shortcut_match(&self, event: impl AsArg<InputEvent>) -> bool

Returns [code]true[/code] if the given input event is checking for the same key ([InputEventKey]), button ([InputEventJoypadButton]) or action ([InputEventAction]).

pub fn xformed_by(
    &self,
    xform: Transform2D<f32, UnknownUnit, UnknownUnit>,
    local_ofs: Vector2D<f32, UnknownUnit>
) -> Option<Ref<InputEvent, Shared>>

Returns a copy of the given input event which has been offset by [code]local_ofs[/code] and transformed by [code]xform[/code]. Relevant for events of type [InputEventMouseButton], [InputEventMouseMotion], [InputEventScreenTouch], [InputEventScreenDrag], [InputEventMagnifyGesture] and [InputEventPanGesture].

Default Arguments

• local_ofs - Vector2( 0, 0 )

Trait Implementations

impl Debug for InputEventJoypadButton

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

Formats the value using the given formatter.

impl Deref for InputEventJoypadButton

type Target = InputEvent

The resulting type after dereferencing.

fn deref(&self) -> &InputEvent

Dereferences the value.

impl DerefMut for InputEventJoypadButton

fn deref_mut(&mut self) -> &mut InputEvent

Mutably dereferences the value.

impl GodotObject for InputEventJoypadButton

type RefKind = RefCounted

The memory management kind of this type. This modifies the behavior of the Ref smart pointer. See its type-level documentation for more information.

fn class_name() -> &'static str

fn null() -> Null<Self>

Creates an explicitly null reference of Self as a method argument. This makes type inference easier for the compiler compared to Option.

fn new() -> Ref<Self, Unique> where
    Self: Instanciable, 

Creates a new instance of Self using a zero-argument constructor, as a Unique reference.

fn cast<T>(&self) -> Option<&T> where
    T: GodotObject + SubClass<Self>, 

Performs a dynamic reference downcast to target type.

fn upcast<T>(&self) -> &T where
    Self: SubClass<T>,
    T: GodotObject, 

Performs a static reference upcast to a supertype that is guaranteed to be valid.

unsafe fn assume_shared(&self) -> Ref<Self, Shared>

Creates a persistent reference to the same Godot object with shared thread access.

unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
    Self: GodotObject<RefKind = RefCounted>, 

Creates a persistent reference to the same Godot object with thread-local thread access.

unsafe fn assume_unique(&self) -> Ref<Self, Unique>

Creates a persistent reference to the same Godot object with unique access.

impl Instanciable for InputEventJoypadButton

fn construct() -> Ref<InputEventJoypadButton, Unique>

impl SubClass<InputEvent> for InputEventJoypadButton

impl SubClass<Object> for InputEventJoypadButton

impl SubClass<Reference> for InputEventJoypadButton

impl SubClass<Resource> for InputEventJoypadButton