pluginbase.Objects.Input.InputAttribute Class Reference

Wrapper class to be used with extension 'BindInputMethods' Provides a convenient way to trigger methods for an IInputTypeBinding when a state changes More...

Inheritance diagram for pluginbase.Objects.Input.InputAttribute:

Public Member Functions
	InputAttribute (Key defaultKey)
	Initializes a new instance of the pluginbase.Objects.Input.InputAttribute class. More...
	InputAttribute (MouseButton defaultMouse)
	Initializes a new instance of the pluginbase.Objects.Input.InputAttribute class. More...
	InputAttribute (string bindName, Key defaultKey)
	Initializes a new instance of the pluginbase.Objects.Input.InputAttribute class. More...
	InputAttribute (string bindName, MouseButton defaultMouse)
	Initializes a new instance of the pluginbase.Objects.Input.InputAttribute class. More...
Public Member Functions inherited from pluginbase.Helpers.Attributes.ScopeAttribute
	ScopeAttribute ()
	ScopeAttribute (object scopeEnum)
bool	HasScope (Enum scope)
override string	ToString ()

Public Attributes
readonly Key	DefaultKey
	The default key binding, if a key-bind More...
readonly MouseButton	DefaultMouseButton
	The default mouse binding, if a mouse-bind More...
readonly string	Name = null
	The name of the bind. If null, method name will be used More...
InputDirection	Direction = InputDirection.Down
	The direction of the bind to invoke the key More...
bool	Forward = false
	If true, and forwarding is available, the input will be forwarded to the remote More...

Additional Inherited Members
Public Types inherited from pluginbase.Helpers.Attributes.ScopeAttribute
enum	Special { Special.Wildcard }
Properties inherited from pluginbase.Helpers.Attributes.ScopeAttribute
Enum	Scope [get, set]
bool	IsFlags [get]
bool	ScopeDefined [get]

Detailed Description

Wrapper class to be used with extension 'BindInputMethods' Provides a convenient way to trigger methods for an IInputTypeBinding when a state changes

Attribute: AttributeUsage(AttributeTargets.Method, AllowMultiple = true)

Constructor & Destructor Documentation

InputAttribute() [1/4]

pluginbase.Objects.Input.InputAttribute.InputAttribute

(

Key

defaultKey

)

Initializes a new instance of the pluginbase.Objects.Input.InputAttribute class.

Parameters

defaultKey

Default key.

        {
            this.DefaultKey = defaultKey;
        }

InputAttribute() [2/4]

pluginbase.Objects.Input.InputAttribute.InputAttribute

(

MouseButton

defaultMouse

)

Initializes a new instance of the pluginbase.Objects.Input.InputAttribute class.

Parameters

defaultMouse

Default mouse.

        {
            this.DefaultMouseButton = defaultMouse;
        }

InputAttribute() [3/4]

pluginbase.Objects.Input.InputAttribute.InputAttribute	(	string	bindName,
		Key	defaultKey
	)

Initializes a new instance of the pluginbase.Objects.Input.InputAttribute class.

Parameters

bindName	Bind name.
defaultKey	Default key.

        {
            this.DefaultKey = defaultKey;
            this.Name = bindName;
        }

InputAttribute() [4/4]

pluginbase.Objects.Input.InputAttribute.InputAttribute	(	string	bindName,
		MouseButton	defaultMouse
	)

Initializes a new instance of the pluginbase.Objects.Input.InputAttribute class.

Parameters

bindName	Bind name.
defaultMouse	Default mouse.

        {
            this.DefaultMouseButton = defaultMouse;
            this.Name = bindName;
        }

Member Data Documentation

DefaultKey

readonly Key pluginbase.Objects.Input.InputAttribute.DefaultKey

The default key binding, if a key-bind

DefaultMouseButton

readonly MouseButton pluginbase.Objects.Input.InputAttribute.DefaultMouseButton

The default mouse binding, if a mouse-bind

Direction

InputDirection pluginbase.Objects.Input.InputAttribute.Direction = InputDirection.Down

The direction of the bind to invoke the key

Forward

bool pluginbase.Objects.Input.InputAttribute.Forward = false

If true, and forwarding is available, the input will be forwarded to the remote

Name

readonly string pluginbase.Objects.Input.InputAttribute.Name = null

The name of the bind. If null, method name will be used

---

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

• pluginbase/Objects/Input/InputAttribute.cs