HUD - Documentation

HUD

new HUD()

Description:

HUD drawing and management

Source:

pxlNav/gui/HUD.js, line 21

Examples

// Add a button to the HUD from your room
let buttonData = { 'style': ['my-button-style'] };
this.pxlHUD.addItem('myButton', HUD_ELEMENT.BUTTON, buttonData, () => {
  console.log('Button clicked!');
});

// Add a draggable region to the HUD from your room
let dragData = { 'style': ['my-drag-style'] };
this.pxlHUD.addItem('myDragRegion', HUD_ELEMENT.DRAG_REGION, dragData, ( data ) => {
  // data = { type = pxlEnum, name='myDragRegion', value={ x: number, y: number } };
  console.log('Drag delta / relative offset : ', data.value );
});

// Add a thumbstick to the HUD from your room
let thumbData = { 'style': ['my-thumbstick-style'] };
this.pxlHUD.addItem('myThumbstick', HUD_ELEMENT.THUMBSTICK, thumbData, ( data ) => {
  // data = { type = pxlEnum, name='myThumbstick', value={ x: number (-1 to 1), y: number (-1 to 1) } };
  console.log('Thumbstick value : ', data.value );
});