Empeld
Empeld plugin documentation.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events
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:
pluginbase.Helpers.Attributes.ScopeAttribute

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

pluginbase.Objects.Input.InputAttribute.InputAttribute ( Key  defaultKey)

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

Parameters
defaultKeyDefault key.
44  {
45  this.DefaultKey = defaultKey;
46  }
readonly Key DefaultKey
The default key binding, if a key-bind
Definition: InputAttribute.cs:17
pluginbase.Objects.Input.InputAttribute.InputAttribute ( MouseButton  defaultMouse)

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

Parameters
defaultMouseDefault mouse.
53  {
54  this.DefaultMouseButton = defaultMouse;
55  }
readonly MouseButton DefaultMouseButton
The default mouse binding, if a mouse-bind
Definition: InputAttribute.cs:22
pluginbase.Objects.Input.InputAttribute.InputAttribute ( string  bindName,
Key  defaultKey 
)

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

Parameters
bindNameBind name.
defaultKeyDefault key.
63  {
64  this.DefaultKey = defaultKey;
65  this.Name = bindName;
66  }
readonly Key DefaultKey
The default key binding, if a key-bind
Definition: InputAttribute.cs:17
readonly string Name
The name of the bind. If null, method name will be used
Definition: InputAttribute.cs:27
pluginbase.Objects.Input.InputAttribute.InputAttribute ( string  bindName,
MouseButton  defaultMouse 
)

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

Parameters
bindNameBind name.
defaultMouseDefault mouse.
74  {
75  this.DefaultMouseButton = defaultMouse;
76  this.Name = bindName;
77  }
readonly string Name
The name of the bind. If null, method name will be used
Definition: InputAttribute.cs:27
readonly MouseButton DefaultMouseButton
The default mouse binding, if a mouse-bind
Definition: InputAttribute.cs:22

Member Data Documentation

readonly Key pluginbase.Objects.Input.InputAttribute.DefaultKey

The default key binding, if a key-bind

readonly MouseButton pluginbase.Objects.Input.InputAttribute.DefaultMouseButton

The default mouse binding, if a mouse-bind

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

The direction of the bind to invoke the key

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

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

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: