Difference between revisions of "cock.bind"
(Created page with "Binds controls to the current layout. == Synopsis == === Function === <source lang="Lua">cock.bind ( self, map, option, device, key, inverse, delta, value, joystick ) cock.bind (...") |
m |
||
| (10 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
Binds controls to the current layout. | Binds controls to the current layout. | ||
| − | == | + | == Function == |
| − | === | + | === Synopsis === |
| − | <source lang="Lua">cock.bind ( self, map, option, device, key, inverse, delta, value, joystick | + | <source lang="Lua">cock.bind ( self, map, option, device, key, inverse, delta, value, joystick )</source> |
| − | |||
=== Arguments === | === Arguments === | ||
{{param|table|self|An object to use.}} | {{param|table|self|An object to use.}} | ||
{{param|string|map|A controls input map to bind controls.}} | {{param|string|map|A controls input map to bind controls.}} | ||
| − | {{param|string|option|Optional. An option to which bind the controls. Will revert to [[ | + | {{param|string|option|Optional. An option to which bind the controls. Will revert to [[Common Organization of Controls Kit Fields|defaultOption]] if not provided.}} |
| − | {{param|string|device|[[ | + | {{param|string|device|[[Common Organization of Controls Kit Input devices|Input device]] to use.}} |
| − | {{param|string|key|[[ | + | {{param|string|key|[[Common Organization of Controls Kit Input keys|Reading]] of an input device to bind.}} |
| − | {{param|string|inverse|[[ | + | {{param|string|inverse|Optional. [[Common Organization of Controls Kit Modes|Inversion]] mode. Will use "positive cutoff" if not provided.}} |
| − | {{param|string|delta|[[ | + | {{param|string|delta|Optional. [[Common Organization of Controls Kit Modes|Delta]] mode. Will use "bypass" if nor provided.}} |
| − | {{param|number|value|Raw value of the input reading during capture.}} | + | {{param|number|value|Optional. Raw value of the input reading during capture. Will use 0 if not provided.}} |
| − | {{param|string|joystick|[ | + | {{param|string|joystick|Optional. [[Common Organization of Controls Kit Input devices|Internal alias]] of joystick to use. Will use 1 if not provided.}} |
| − | {{param|string|longdata|A string coming from [[ | + | == Function == |
| − | + | === Synopsis === | |
| − | Alternatively, instead of using literal values for device, key, inverse, delta and joystick arguments, you can pass numerical values. | + | <source lang="Lua">cock.bind ( self, longdata )</source> |
| + | === Arguments === | ||
| + | {{param|table|self|An object to use.}} | ||
| + | {{param|string|longdata|A string coming from [[Common Organization of Controls Kit Callbacks|cock.controlcaptured]] event.}} | ||
| + | == Remarks == | ||
| + | Alternatively, instead of using literal values for device, key, inverse, delta and joystick arguments, you can pass numerical values. Although, just using magic numbers to set values by hand in your code will only make it messier, and given that internal conversion is an optimized operation and you wouldn't call this function hundreds of times every frame, that would make no performance difference. | ||
==See also== | ==See also== | ||
*[[cock.addOption]] | *[[cock.addOption]] | ||
*[[cock.unbind]] | *[[cock.unbind]] | ||
*[[cock.getBinded]] | *[[cock.getBinded]] | ||
| + | *[[Common Organization of Controls Kit Callbacks]] | ||
| + | *[[Common Organization of Controls Kit Input devices]] | ||
| + | *[[Common Organization of Controls Kit Input keys]] | ||
| + | *[[Common Organization of Controls Kit Modes]] | ||
| + | *[[Common Organization of Controls Kit Fields]] | ||
*[[parent::Common Organization of Controls Kit Manual]] | *[[parent::Common Organization of Controls Kit Manual]] | ||
[[Category:Functions]] | [[Category:Functions]] | ||
Latest revision as of 14:54, 2 September 2013
Binds controls to the current layout.
Contents
Function
Synopsis
cock.bind ( self, map, option, device, key, inverse, delta, value, joystick )
Arguments
table self- An object to use.
string map- A controls input map to bind controls.
string option- Optional. An option to which bind the controls. Will revert to defaultOption if not provided.
string device- Input device to use.
string key- Reading of an input device to bind.
string inverse- Optional. Inversion mode. Will use "positive cutoff" if not provided.
string delta- Optional. Delta mode. Will use "bypass" if nor provided.
number value- Optional. Raw value of the input reading during capture. Will use 0 if not provided.
string joystick- Optional. Internal alias of joystick to use. Will use 1 if not provided.
Function
Synopsis
cock.bind ( self, longdata )
Arguments
table self- An object to use.
string longdata- A string coming from cock.controlcaptured event.
Remarks
Alternatively, instead of using literal values for device, key, inverse, delta and joystick arguments, you can pass numerical values. Although, just using magic numbers to set values by hand in your code will only make it messier, and given that internal conversion is an optimized operation and you wouldn't call this function hundreds of times every frame, that would make no performance difference.
See also
- cock.addOption
- cock.unbind
- cock.getBinded
- Common Organization of Controls Kit Callbacks
- Common Organization of Controls Kit Input devices
- Common Organization of Controls Kit Input keys
- Common Organization of Controls Kit Modes
- Common Organization of Controls Kit Fields
- Common Organization of Controls Kit Manual
- Common Organization of Controls Kit
