Class MultiPlayerSceneManager

Classdesc

MultiPlayerSceneManager class, used for managing scenes, players, and transitions between scenes in a multiplayer game

Example

const sceneManager = new MultiPlayerSceneManager({
     initialScene: scene,
     canvas: createCanvas(), // create a synthetic canvas... nothing will be rendered on it, it is just for SceneManager to use under the hood
     width: 500,
     height: 500,
     showPlayerLabels: true
});

Hierarchy (view full)

Constructors

constructor

Properties

activeScene animateTo animationNames animationRunTime animationRunning animationStartTime canvas ctx fromScenePrevHadLights height players sceneAnimation scenes showPlayerLabels start toScenePrevHadLights width

Methods

addPlayer addScene animate changeScene draw getPlayer getPlayerByLabel getPlayersByLabel removePlayer

Constructors

constructor

Properties

activeScene

activeScene: string

ID of the active scene

animateTo

animateTo: Scene

Scene to animate to

animationNames

animationNames: string[]

Names of the animations that can be used

animationRunTime

animationRunTime: number

How long the animation should run for

animationRunning

animationRunning: boolean

Whether or not the animation is running

animationStartTime

animationStartTime: number

Time when the animation started

canvas

canvas: HTMLCanvasElement

Canvas element to draw the scenes on

ctx

ctx: CanvasRenderingContext2D

Canvas rendering context of the canvas

fromScenePrevHadLights

fromScenePrevHadLights: boolean

Whether or not the scene that the animation is coming from had lighting enabled

height

height: number

Height of the canvas (Will resize the canvas to this height). By default is the width of the canvas element

players

players: Player[]

Array of players in the scene manager

sceneAnimation

sceneAnimation: string

Animation to use when transitioning between scenes

scenes

scenes: {
    [key: string]: Scene;
}

Scenes in the scene manager

Type declaration

showPlayerLabels

showPlayerLabels: boolean

Whether or not to show player labels

start

start: boolean

Whether or not to start the scene manager when it is initialized (true by default)

toScenePrevHadLights

toScenePrevHadLights: boolean

Whether or not the scene that the animation is going to had lighting enabled

width

width: number

Width of the canvas (Will resize the canvas to this width). By default is the width of the canvas element

Methods

addPlayer

  • addPlayer(player): void

  • Adds a player into the scene manager

    Parameters

    • player: Player

      Player to add to the scene manager

    Returns void

addScene

animate

  • animate(transition, scene, duration?): void

  • Smoothly animates between scenes (unless lighting is enabled, in which case lighting is temporarily disabled as the animation is running)

    Parameters

    • transition: string

      Name of the transition to use

    • scene: Scene

      Scene to transition to

    • duration: number = 1000

      Time (in ms) to run the transition for

    Returns void

changeScene

draw

getPlayer

  • getPlayer(id): Player

  • Retrieves a given player from the scene manager. Has O(n) time complexity, so not recommended to use often

    Parameters

    • id: string

      ID of the player to get

    Returns Player

    The player with the given ID

getPlayerByLabel

  • getPlayerByLabel(label): Player

  • Retrieves a given player from the scene manager. Has O(n) time complexity, so not recommended to use often

    Parameters

    • label: string

      Label of the player to get

    Returns Player

    The first player with the given label

getPlayersByLabel

  • getPlayersByLabel(label): Player[]

  • Gets all players that match a given label

    Parameters

    • label: string

      Label of the players to get

    Returns Player[]

    Array of players with the given label (eg: if multiple players have the same label)

removePlayer

  • removePlayer(player): void

  • Removes a player from the scene manager

    Parameters

    • player: Player

      Player to remove from the scene manager

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc