Class ServerInputHandler

Classdesc

MultiPlayerServerInput class, used for handling input on the server side of a multiplayer game

Example

const input = new MultiPlayerServerInput({
     key: "w",
     fireRate: 10,
     on: (socket, playerObject) => {
     playerObject.move(0, -1);
     }
});

Constructors

constructor

Properties

active fireIntervals fireRate firing id key on sceneManager

Methods

activateOn init startFiring stopFiring

Constructors

constructor

Properties

active

active: boolean

Whether or not the input is active

fireIntervals

fireIntervals: any

Reference to all of the fire intervals

fireRate

fireRate: number

Fire rate of the input

firing

firing: any

Whether or not the input is firing for each socket

id

id: string

Unique ID of the input

key

key: string

Key that the input is bound to

on

on: ((socket, playerObject) => void)

Function to run when the input is fired (EventOnFunction)

Type declaration

    • (socket, playerObject): void

    • Function to run when the input is fired (EventOnFunction)

      Parameters

      Returns void

sceneManager

sceneManager: null | MultiPlayerSceneManager

SceneManager instance that the input is bound to

Methods

activateOn

  • activateOn(socket): void

  • Activates the input on the given socket

    Parameters

    • socket: any

      Socket.io socket to activate the input on

    Returns void

init

  • init(sceneManager): void

  • Activates the input on the given sceneManager (MultiPlayerSceneManager instance)

    Parameters

    Returns void

startFiring

  • startFiring(socket): void

  • Fires the input on a given socket every fireRate ms

    Parameters

    • socket: any

      Socket.io socket to start firing the input on

    Returns void

stopFiring

  • stopFiring(socket): void

  • Stops firing the input to a given socket

    Parameters

    • socket: any

      Socket.io socket to stop firing the input on

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc