Struct gdnative_bindings_lily::InputEvent [−][src]
pub struct InputEvent { /* fields omitted */ }
Expand description
core class InputEvent
inherits Resource
(reference counted).
Official documentation
See the documentation of this class in the Godot engine’s official documentation. The method descriptions are generated from it and typically contain code samples in GDScript, not Rust.
Memory management
The lifetime of this object is automatically managed through reference counting.
Class hierarchy
InputEvent inherits methods from:
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
Returns true
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 relative
is a sum of both events. Both events’ modifiers have to be identical.
Returns a String representation of the event.
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.
The event’s device ID.
Note: This device ID will always be -1
for emulated mouse input from a touchscreen. This can be used to distinguish emulated mouse input from physical mouse input.
Returns true
if this input event matches a pre-defined action of any type.
Returns true
if the given action is being pressed (and is not an echo event for InputEventKey events, unless allow_echo
is true
). Not relevant for events of type InputEventMouseMotion or InputEventScreenDrag.
Default Arguments
allow_echo
-false
Returns true
if the given action is released (i.e. not pressed). Not relevant for events of type InputEventMouseMotion or InputEventScreenDrag.
Returns true
if this input event’s type is one that can be assigned to an input action.
Returns true
if this input event is an echo event (only for events of type InputEventKey).
Returns true
if this input event is pressed. Not relevant for events of type InputEventMouseMotion or InputEventScreenDrag.
The event’s device ID.
Note: This device ID will always be -1
for emulated mouse input from a touchscreen. This can be used to distinguish emulated mouse input from physical mouse input.
Returns true
if the given input event is checking for the same key (InputEventKey), button (InputEventJoypadButton) or action (InputEventAction).
pub fn xformed_by(
&self,
xform: Transform2D,
local_ofs: Vector2
) -> Option<Ref<InputEvent, Shared>>
pub fn xformed_by(
&self,
xform: Transform2D,
local_ofs: Vector2
) -> Option<Ref<InputEvent, Shared>>
Returns a copy of the given input event which has been offset by local_ofs
and transformed by xform
. Relevant for events of type InputEventMouseButton, InputEventMouseMotion, InputEventScreenTouch, InputEventScreenDrag, InputEventMagnifyGesture and InputEventPanGesture.
Default Arguments
local_ofs
-Vector2( 0, 0 )
Methods from Deref<Target = Resource>
Duplicates the resource, returning a new resource. By default, sub-resources are shared between resource copies for efficiency. This can be changed by passing true
to the subresources
argument which will copy the subresources.
Note: If subresources
is true
, this method will only perform a shallow copy. Nested resources within subresources will not be duplicated and will still be shared.
Default Arguments
subresources
-false
If [member resource_local_to_scene] is enabled and the resource was loaded from a PackedScene instantiation, returns the local scene where this resource’s unique copy is in use. Otherwise, returns null
.
The name of the resource. This is an optional identifier.
The path to the resource. In case it has its own file, it will return its filepath. If it’s tied to the scene, it will return the scene’s path, followed by the resource’s index.
If true
, the resource will be made unique in each instance of its local scene. It can thus be modified in a scene instance without impacting other instances of that same scene.
If true
, the resource will be made unique in each instance of its local scene. It can thus be modified in a scene instance without impacting other instances of that same scene.
The name of the resource. This is an optional identifier.
The path to the resource. In case it has its own file, it will return its filepath. If it’s tied to the scene, it will return the scene’s path, followed by the resource’s index.
This method is called when a resource with [member resource_local_to_scene] enabled is loaded from a PackedScene instantiation. Its behavior can be customized by overriding [method _setup_local_to_scene] from script. For most resources, this method performs no base logic. ViewportTexture performs custom logic to properly set the proxy texture and flags in the local viewport.
Sets the path of the resource, potentially overriding an existing cache entry for this path. This differs from setting [member resource_path], as the latter would error out if another resource was already cached for the given path.
Trait Implementations
type RefKind = RefCounted
type RefKind = RefCounted
Creates an explicitly null reference of Self
as a method argument. This makes type
inference easier for the compiler compared to Option
. Read more
Creates a new instance of Self
using a zero-argument constructor, as a Unique
reference. Read more
Performs a dynamic reference downcast to target type. Read more
Performs a static reference upcast to a supertype that is guaranteed to be valid. Read more
Creates a persistent reference to the same Godot object with shared thread access. Read more
unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
Self: GodotObject<RefKind = RefCounted>,
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. Read more
Creates a persistent reference to the same Godot object with unique access. Read more
Recovers a instance ID previously returned by Object::get_instance_id
if the object is
still alive. See also TRef::try_from_instance_id
. Read more
Auto Trait Implementations
impl RefUnwindSafe for InputEvent
impl !Send for InputEvent
impl !Sync for InputEvent
impl Unpin for InputEvent
impl UnwindSafe for InputEvent