Add properties representing entities to controller objects

[rwaldron]

For every non-trivial project that uses dualShock, that I'm currently working (3 on going) I find that I need to create state objects for the controller, eg:

var state = {
  r1: { 
    value: 0
  }
};

controller.on('r1:press', function() {
  state.r1.value = 1;
});

controller.on('r1:release', function() {
  state.r1.value = 0;
});

// ... elsewhere I might have something like this: 

controller.on('left:move', function() {
  // treat r1's value as some kind of modifier
  if (state.r1.value) {
    // when r1 was pressed do stuff
  } else {
    // otherwise do the other stuff
  }
});

It would be nice if this was part of the controller object itself, which would reduce the above example to:

// No other events are needed!

controller.on('left:move', function() {
  // treat r1's value as some kind of modifier
  if (controller.r1.value) {
    // when r1 was pressed do stuff
  } else {
    // otherwise do the other stuff
  }
});

Each "entity" (button, analog stick, etc) should have a corresponding property on the controller object. Each button entity property would be an object that contained at least the following properties: state, value. Each analog entity property would contain axis value properties.

controller { 
  _events: ..., 

  left: {
    x: 0-255,
    y: 0-255
  },
  right: {
    x: 0-255,
    y: 0-255
  },  
  l1: { 
    state: press|hold|release|analog, 
    value: 0|1 
  },
  r1: { 
    state: press|hold|release|analog, 
    value: 0|1 
  },
  l2: { 
    state: press|hold|release|analog, 
    value: 0-255 
  },
  r2: { 
    state: press|hold|release|analog, 
    value: 0-255
  },
  triangle: { 
    state: press|hold|release|analog, 
    value: 0|1 
  },
  circle: { 
    state: press|hold|release|analog, 
    value: 0|1 
  },
  x: { 
    state: press|hold|release|analog, 
    value: 0|1 
  },
  square: { 
    state: press|hold|release|analog, 
    value: 0|1 
  },
  select: { 
    state: press|hold|release|analog, 
    value: 0|1
  },
  start: { 
    state: press|hold|release|analog, 
    value: 0|1
  },  
  leftAnalogBump: { 
    state: press|hold|release|analog, 
    value: 0|1 
  },
  rightAnalogBump: { 
    state: press|hold|release|analog, 
    value: 0|1 
  },
  dpadUp: { 
    state: press|hold|release|analog, 
    value: 0|1 
  },
  dpadRight: { 
    state: press|hold|release|analog, 
    value: 0|1 
  },
  dpadDown: { 
    state: press|hold|release|analog, 
    value: 0|1 
  },
  dpadLeft: { 
    state: press|hold|release|analog, 
    value: 0|1 
  },
  psxButton: { 
    state: press|hold|release|analog, 
    value: 0|1 
  } 
}

If this feature is desirable, I can provide a patch

[rdepena]

if you have to maintain these state objects then its a legitimate use case, note that I would not add the "analog" state to the buttons as it would conflict with the new hold state.