Documentation
¶
Overview ¶
Contains a generic action which can be targeted from several types of inputs. Actions and their events can be set in the Input Map tab in Project > Project Settings, or with the InputMap class.
Note: Unlike the other InputEvent subclasses which map to unique physical events, this virtual one is not emitted by the engine. This class is useful to emit actions manually with Input.ParseInputEvent, which are then received in Node.Input. To check if a physical event matches an action from the Input Map, use InputEvent.IsAction and InputEvent.IsActionPressed.
Index ¶
- type Advanced
- type Any
- type Extension
- type ID
- type Instance
- func (self Instance) Action() string
- func (self Instance) AsInputEvent() InputEvent.Instance
- func (self Instance) AsInputEventAction() Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsRefCounted() [1]gd.RefCounted
- func (self Instance) AsResource() Resource.Instance
- func (self Instance) EventIndex() int
- func (self Instance) ID() ID
- func (self Instance) SetAction(value string)
- func (self Instance) SetEventIndex(value int)
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) SetPressed(value bool)
- func (self Instance) SetStrength(value Float.X)
- func (self Instance) Strength() Float.X
- func (self Instance) Virtual(name string) reflect.Value
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Advanced ¶
type Advanced = class
Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.
type Extension ¶
Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension
func (*Extension[T]) AsInputEvent ¶
func (self *Extension[T]) AsInputEvent() InputEvent.Instance
func (*Extension[T]) AsInputEventAction ¶
func (*Extension[T]) AsRefCounted ¶
func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted
func (*Extension[T]) AsResource ¶
type ID ¶
ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.
type Instance ¶
type Instance [1]gdclass.InputEventAction
Instance of the class with convieniently typed arguments and results.
var Nil Instance
Nil is a nil/null instance of the class. Equivalent to the zero value.
func (Instance) Action ¶
The action's name. This is usually the name of an existing action in the InputMap which you want this custom event to match.
func (Instance) AsInputEvent ¶
func (self Instance) AsInputEvent() InputEvent.Instance
func (Instance) AsInputEventAction ¶
func (Instance) AsRefCounted ¶
func (self Instance) AsRefCounted() [1]gd.RefCounted
func (Instance) AsResource ¶
func (Instance) EventIndex ¶
The real event index in action this event corresponds to (from events defined for this action in the InputMap). If -1, a unique ID will be used and actions pressed with this ID will need to be released with another InputEventAction.
func (Instance) SetEventIndex ¶
SetEventIndex sets the property returned by [GetEventIndex].
func (Instance) SetPressed ¶
If true, the action's state is pressed. If false, the action's state is released.
func (Instance) SetStrength ¶
SetStrength sets the property returned by [GetStrength].
Source Files