Interface that represents an input binding that is bound to the input manager to receive input Note: This object is ref-tracked, meaning that if it's not pinned, and there's no variable that holds it, it will be removed More...

Inheritance diagram for pluginbase.Objects.Input.IBoundInput:

Public Member Functions
void	StartListening ()
	Start listening to bindings More...

void	StopListening ()
	Stop listening to bindings More...

Public Member Functions inherited from pluginbase.Objects.Input.IInputBinding
void	Listen (string bindName, Key defaultKey)
	Listen to a key, with the assigned bind name More...

void	Listen (string bindName, MouseButton defaultButton)
	Listens to a button, with the given assigned name More...

void	Bind (string bindName, Action action)
	Do an action when the event attached to the bind occurs More...

void	Bind (string bindName, InputDirection direction, Action action)
	Bind an action to a given name during a direction More...

void	Bind (string bindName, Key defaultKey, Action keyBind)
	Bind an action, during the down-direction, of a key More...

void	Bind (string bindName, Key defaultKey, InputDirection direction, Action keyBind)
	Bind an action to a default key and direction More...

void	Bind (string bindName, MouseButton defaultButton, Action mouseBind)
	Bind a mouse button to the given action More...

void	Bind (string bindName, MouseButton defaultButton, InputDirection direction, Action mouseBind)
	Bind mouse button to given action More...

void	BindMouseWheel (MouseWheelAction callback)
	Bind a callback when the mouse wheel is scrolled More...

void	BindMouseMove (MouseMoveAction callback)
	Bind an event when an absolute-mouse-move occurs More...

bool	IsDown (string bindName)
	Gets whether or not the current bind name is in the "Down" position (Key or mouse) More...

Vector2d	GetMouseDelta (bool reset=true)
	Gets the mouse delta, for, eg, moving FPS rotation More...

string	GetBoundEventName (string bindName)
	Get the name of the input that is bound to the bindName Eg return "K" for Key.K or "Left" for Mouse left Used for display only More...

Properties
bool	Enabled `[get]`
	Is the binding enabled (Will it receive keys and buttons?) More...

bool	Pinned `[get, set]`
	Is the binding pinned? If true, then it will not go away even if it loses a ref More...

Properties inherited from pluginbase.Objects.Input.IInputBinding
string	Name `[get]`
	Gets the name of the input binding More...

string	Description `[get, set]`
	Gets or sets the description. More...

bool	CaptureAll `[get, set]`
	If true, the binding will block all other bindings that have been enabled before it More...

MouseMode	MouseMode `[get, set]`
	Gets or sets the mouse mode. More...

Detailed Description

Interface that represents an input binding that is bound to the input manager to receive input Note: This object is ref-tracked, meaning that if it's not pinned, and there's no variable that holds it, it will be removed

Member Function Documentation

◆ StartListening()

void pluginbase.Objects.Input.IBoundInput.StartListening ( )

Start listening to bindings

◆ StopListening()

void pluginbase.Objects.Input.IBoundInput.StopListening ( )

Stop listening to bindings

Property Documentation

◆ Enabled

bool pluginbase.Objects.Input.IBoundInput.Enabled

get

Is the binding enabled (Will it receive keys and buttons?)

true if enabled; otherwise, false.

◆ Pinned

bool pluginbase.Objects.Input.IBoundInput.Pinned

getset

Is the binding pinned? If true, then it will not go away even if it loses a ref

true if pinned; otherwise, false.

The documentation for this interface was generated from the following file:

pluginbase/Objects/Input/IBoundInput.cs

Public Member Functions