diff options
| author | Rubén Beltrán del Río <ben@nsovocal.com> | 2018-04-23 05:13:08 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-04-23 05:13:08 -0500 |
| commit | 7ade6f8d96825386bf2e89dea51f9297cbac8e9c (patch) | |
| tree | 1e0c95625250c6fc41c7c8722ed81f4a3246ce6c /lib/components/control_map.js | |
| parent | f45bcde17fe0a8849e647ac843106fb51d2e8971 (diff) | |
Add control via keyboard (#6)
* Correct angle documentation
* Correct body component doc
* Add a config module with px 2 meters
* Create component to map input
* Add components for mappable actions
* Add component for elastic manipulation
* Add node to modify physics
* Add controllable node
* Add dasher node
* Add control mapper system
* Add component to limit velocity
* Add node for limiting velocity
* Add systems to move and dash
* Use meters in physics systems
* Correct documentation in render system
* Add elastic manipulation system
* Update factories to use new components
* Update main app to use new systems
* Ignore dist dir
* Also ignore cache
* Ignore personal configuration files
* Add system to reduce velocity
* Add changelog
Diffstat (limited to 'lib/components/control_map.js')
| -rw-r--r-- | lib/components/control_map.js | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/lib/components/control_map.js b/lib/components/control_map.js new file mode 100644 index 0000000..cb447d0 --- /dev/null +++ b/lib/components/control_map.js @@ -0,0 +1,57 @@ +import { Component } from '@serpentity/serpentity'; + +/** + * The contorl mapping object, holds a source and target for the action. + * + * @typedef tControlMap + * @type object + * + * @property {tControlSource} source the source input for the action + * @property {tControlTarget} target the target property for the action + */ + +/** + * The definition of an input source + * + * @typedef tControlSource + * @type object + * + * @property {string} type type of input, can be keyboard or gamepad (only keyboard supported atm) + * @property {number} gamepadNumber the number of gamepad to use (unsupported) + * @property {string} gamepadInputSource either axes or buttons + * @property {number} index the input index or keycode + */ + +/** + * The definition of an input target + * + * @typedef tControlTarget + * @type object + * + * @property {external:Serpentity:Component} component the component affected by this + * @property {string} property property to affect. For nested properties use dot.notation + * @property {[function]} value a function that takes in the input and outputs a transformed value + */ + +/** + * Component that stores the state of motion controls to properties + * + * @extends {external:Serpentity.Component} + * @class ControlMapComponent + * @param {object} config a configuration object to extend. + */ +export default class ControlMapComponent extends Component { + constructor(config) { + + super(config); + + /** + * The map of actions and controls. An array of mappings + * + * @property {Array<tControlMap>} map + * @instance + * @memberof ControlMapComponent + */ + this.map = this.map || []; + } +}; |