Merge pull request #98 from mixer/feat/screen

feat(screen): support for screen controls

src/state/controls/Screen.ts

@@ -0,0 +1,38 @@
+import { IScreenInput } from '../interfaces/controls/IInput';
+import { IScreen, IScreenData, IScreenUpdate } from '../interfaces/controls/IScreen';
+import { Control } from './Control';
+
+/**
+ * Screen can be used to get mouse input
+ */
+export class Screen extends Control<IScreenData> implements IScreen {
+  /**
+     * Whether the control will send coordinates on mousemove
+     */
+  public sendOnMove: boolean;
+  /**
+     * Whether the control will send coordinates on mousedown
+     */
+  public sendMoveOnMouseDown: boolean;
+  /**
+     * The debounce rate for input sent
+     */
+  public moveDeboune: number;
+
+  /**
+     * Update this control on the server.
+     */
+  public update(controlUpdate: IScreenUpdate): Promise<void> {
+    // Clone to prevent mutations
+    // XXX: Typescript 2.4 is strict, let the compiler be clever.
+    const changedData = { ...controlUpdate };
+    return super.update(changedData);
+  }
+
+  /**
+     * Sends an input event from a participant to the server for consumption.
+     */
+  public giveInput(input: IScreenInput): Promise<void> {
+    return this.sendInput(input);
+  }
+}

src/state/controls/index.ts

@@ -3,4 +3,5 @@ export { Control } from './Control';
 export { Button } from './Button';
 export { Joystick } from './Joystick';
 export { Label } from './Label';
+export { Screen } from './Screen';
 export { Textbox } from './Textbox';

src/state/interfaces/controls/IInput.ts

@@ -59,6 +59,24 @@ export interface IJoystickInput extends IInput {
     y: number;
 }
 
+/**
+ * Extends the base input to include screen specific data.
+ */
+export interface IScreenInput extends IInput {
+    /**
+     * Joysticks can only be moved.
+     */
+    event: 'move' | 'mousedown' | 'mouseup';
+    /**
+     * The X coordinate of the input.
+     */
+    x: number;
+    /**
+     * The Y coordinate of the input.
+     */
+    y: number;
+}
+
 /**
  * Extends the base input to include textbox specific data.
  */

src/state/interfaces/controls/IScreen.ts

@@ -0,0 +1,45 @@
+import { IControl, IControlData, IControlUpdate } from './IControl';
+/**
+ * Extends the regular control data with additional properties for Textbox
+ */
+export interface IScreenData extends IControlData {
+  /**
+     * Whether the control will send coordinates on mousemove
+     */
+  sendOnMove?: boolean;
+  /**
+     * Whether the control will send coordinates on mousedown
+     */
+  sendMoveOnMouseDown?: boolean;
+  /**
+     * The debounce rate for input sent
+     */
+  moveDeboune?: number;
+}
+
+/**
+ * Represents updatable components of a scren control which developers can
+ * update from game clients.
+ */
+export interface IScreenUpdate extends IControlUpdate {
+  /**
+     * Whether the control will send coordinates on mousemove
+     */
+  sendOnMove?: boolean;
+  /**
+     * Whether the control will send coordinates on mousedown
+     */
+  sendMoveOnMouseDown?: boolean;
+  /**
+     * The debounce rate for input sent
+     */
+  moveDeboune?: number;
+}
+
+export interface IScreen extends IControl, IScreenData {
+  sendOnMove: boolean;
+  sendMoveOnMouseDown: boolean;
+  moveDeboune: number;
+  // GameClient
+  update(changedData: IScreen): Promise<void>;
+}

src/state/interfaces/controls/index.ts

@@ -8,5 +8,6 @@ export * from './IControl';
 export * from './IInput';
 export * from './IJoystick';
 export * from './ILabel';
+export * from './IScreen';
 export * from './ITextbox';
 export * from './IMeta';