Class PlayerClient

Classdesc

PlayerClient class, used for constructing, running, and managing a multiplayer client

Example

const playerClient = new ANVIL.PlayerClient({
  canvas: document.getElementById('canvas'),
  modifyLocalObject: function (obj) {
     obj.backgroundColor = "blue";
     this.scene.bindCamera(obj)
 },
 sceneOptions: {
     fpsMonitoringEnabled: true
 }
});

Indexable

[key: string]: any

Constructors

constructor

Properties

canvas ctx emitStack height inputStack io localPlayer modifyLocalObject objects ready scene socket width

Methods

draw emit emitData init on setReady update updatePlayer

Constructors

constructor

Properties

canvas

canvas: HTMLCanvasElement

Canvas to draw the scene on

ctx

ctx: CanvasRenderingContext2D

CanvasRenderingContext2D of the canvas

emitStack

emitStack: NotReadyStackEmitItem[]

Stack data to emitwhen the client is ready

height

height: number

Height of the scene

inputStack

inputStack: MultiPlayerClientInput[]

Stack of inputs to activate when the client is ready

io

io: any

Socket.io instance (used to generate socket)

localPlayer

localPlayer: null | GameObject

Local player's GameObject

modifyLocalObject

modifyLocalObject: ((gameObject) => void)

Function to modify the local player's GameObject

Type declaration

    • (gameObject): void

    • Function to modify the local player's GameObject

      Parameters

      Returns void

objects

objects: GameObject[]

Array of GameObjects in the scene

ready

ready: boolean

Whether or not the client is ready

scene

scene: Scene

A Scene reference used to render the objects and lights sent by the server

socket

socket: any

Socket.io socket of the client

width

width: number

Width of the scene

Methods

draw

  • draw(): void

  • Draws the scene on the canvas

    Returns void

emit

  • emit(event, data): void

  • Emits an event to the server

    Parameters

    • event: string

      Event to emit. "key_down", "key_up", "player_data", and "player_initialized" are reserved events.

    • data: any

      Data to send to the server

    Returns void

emitData

  • emitData(data): void

  • Emits data to the server

    Parameters

    • data: any

      Data to send to the server

    Returns void

init

  • init(io): void

  • Initializes the client after socket.io is loaded, empties the emitStack and inputStack, and sets the client to ready

    Parameters

    • io: any

      Socket.io instance

    Returns void

on

  • on(event, callback): void

  • Listens for an event, fires the given callback when the event is fired.

    Parameters

    • event: string

      Event to listen to

    • callback: Function

      Callback to run when the event is fired

    Returns void

setReady

  • setReady(): void

  • Empties the emitStack and inputStack, and sets the client to ready, starts the render loop

    Returns void

update

  • update(data): void

  • Updates the scene with data from the server

    Parameters

    • data: any

      Data to update the client with (Updates lights, objects, fog, ambient lighting, and directional lights)

    Returns void

updatePlayer

  • updatePlayer(data): void

  • Updates the client's local player

    Parameters

    • data: any

      Sets the local player

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc