import Game from 'WTF-Adventure/WTF-Adventure/client/game.js'

public class | source

Game

Creates an instance of the game

Constructor Summary

Public Constructor
public	constructor(client: Client) Keep track of the game logic and the HTML5 canvas

Member Summary

Public Members
public	audio: Audio Controls the game music and sfx
public	bubble: Bubble A reference to the chat bubbles controller
public	client: Client An instance of the client application
public	development: Boolean Returns server/config.json => devClient value
public	entities: Array<Entity> An array of entities in the game
public	guild: Guild A reference to a guild
public	id: Number An ID used to identify the player after they've been given a handshake by the Node server
public	info: Info Used to display additional information on the screen (ie level up and hits and health/exp regeneration)
public	input: Input Controls all of the game's input
public	interface: Interface Controls the interface in the game
public	lastTime: Boolean Last time (used for renderer??)
public	loaded: Boolean Whether or not the map is loaded
public	map: Map An instance of the game's map
public	messages: Messages An array of mesages from the web socket
public	pathfinder: Pathfinder Used to find paths of entities
public	player: Player An instance of the player
public	playerHandler: PlayerHandler An instance of the game's player handler
public	pointer: Pointer The pointer shown on the HTML5 canvas
public	population: Number How many players are in the game, defaults to -1
public	pvp: Boolean True if there is currently pvp combat
public	ready: Boolean Whether or not the game is ready
public	renderer: Renderer An instance of the renderer
public	shop: *
public	socket: Socket An instance of the web socket used to talk to the node server
public	started: Boolean Whether or not the game is started
public	storage: Object A reference to the player's LocalStorage
public	time: Date Used for rendering fame ticks
public	updater: Updater An instance of the updater
public	zoning: Zoning Used to figure out direction

Method Summary

Public Methods
public	animationCallback(id: , info: )
public	audioCallback(song: *)
public	bankCallback(opcode: , info: )
public	blinkCallback(instance: *)
public	chatCallback(info: *)
public	combatCallback(data: *)
public	connect(): Boolean Connect to the nodeJS server and setup all the server to client callback messages
public	createPlayer()
public	deathCallback(id: *)
public	despawnCallback(id: Number): Boolean Callback for removing a spawned entity
public	enchantCallback(opcode: , info: )
public	entityListCallback(data: Array<Entity>): Boolean Callback for when the list of entities is done loading and adds the new entities to the screen
public	equipmentCallback(action: Number, info: Object): Boolean Callback for when player equipment is done loading
public	experienceCallback(info: *)
public	findPath(character: , x: , y: , ignores: ): *
public	getCamera(): *
public	getEntityAt(x: , y: , ignoreSelf: ):
public	getScaleFactor(): *
public	getSprite(spriteName: ):
public	getStorage(): *
public	getStoragePassword(): *
public	getStorageUsername(): *
public	guildCallback(opcode: , info: )
public	handleDisconnection(noError: *) This function is responsible for handling sudden disconnects of a player whilst in the game, not menu-based errors.
public	handshakeCallback(data: Messages): Boolean Callback for when the server has acknowledged the client connection then it creates the player object, makes sure the map is loaded, and if the user is registering or logging in it handles player registration or login requests
public	hasRemember(): *
public	healCallback(info: *)
public	implementStorage()
public	inventoryCallback(opcode: , info: )
public	loadControllers(): Boolean Load all of the game controllers
public	loadGameMap(): Boolean Load the game map data
public	loadRenderer(): Boolean Load the HTML5 canvas renderer layers for: background foreground text entities cursor
public	loadedSpritesCallback()
public	mapReadyCallback(): Boolean Callback for when the map data is done loading
public	moveCharacter(character: , x: , y: *)
public	movePlayer(x: , y: )
public	movementCallback(data: Object<Messages>): Boolean Callback for entity movement
public	networkCallback()
public	notificationCallback(opcode: , message: )
public	npcCallback(opcode: , info: )
public	onInput(inputType: , data: )
public	pointerCallback(opcode: , info: )
public	pointsCallback(data: *)
public	populationCallback(population: *)
public	postLoad() Call this after the player has been welcomed by the server and the client received the connection.
public	projectileCallback(opcode: , info: )
public	pvpCallback(id: , pvp: )
public	questCallback(opcode: , info: )
public	resize()
public	respawn()
public	respawnCallback(id: , x: , y: *)
public	setAudio(audio: *)
public	setBubble(bubble: *)
public	setEntityController(entities: *)
public	setInfo(info: *)
public	setInput(input: *)
public	setInterface(intrface: *)
public	setMessages(messages: *)
public	setPathfinder(pathfinder: *)
public	setPlayerMovement(direction: *)
public	setPointer(pointer: *)
public	setRenderer(renderer: *)
public	setSocket(socket: *)
public	setStorage(storage: *)
public	setUpdater(updater: *)
public	shopCallback(opcode: , info: )
public	spawnCallback(data: Object): Boolean Triggered when an entity has finished being spawned
public	start(): Boolean Start the game
public	stop() Stop the game, sets started and ready to false
public	syncCallback(playerEntity: Entity<Player>): Boolean Callback for when server side sync is done.
public	teleportCallback(data: Object<Messages>): Boolean Callback for player teleport
public	tick() Calls the renderer to draw to the HTML5 canvas if the game is ready and requests animations if the game is started
public	tradeWith(player: *)
public	unload(): Boolean Resets all of the controllers, storage and entities in the game.
public	welcomeCallback(playerData: Object): Boolean The callback for when the welcome message for brand new players is done.

Public Constructors

public constructor(client: Client) source

Keep track of the game logic and the HTML5 canvas

Params:

Name	Type	Attribute	Description
client	Client		an instance of the client application

Public Members

public audio: Audio source

Controls the game music and sfx

public bubble: Bubble source

A reference to the chat bubbles controller

public client: Client source

An instance of the client application

public development: Boolean source

Returns server/config.json => devClient value

public entities: Array<Entity> source

An array of entities in the game

public guild: Guild source

A reference to a guild

public id: Number source

An ID used to identify the player after they've been given a handshake by the Node server

public info: Info source

Used to display additional information on the screen (ie level up and hits and health/exp regeneration)

public input: Input source

Controls all of the game's input

public interface: Interface source

Controls the interface in the game

public lastTime: Boolean source

Last time (used for renderer??)

public loaded: Boolean source

Whether or not the map is loaded

public map: Map source

An instance of the game's map

public messages: Messages source

An array of mesages from the web socket

public pathfinder: Pathfinder source

Used to find paths of entities

public player: Player source

An instance of the player

public playerHandler: PlayerHandler source

An instance of the game's player handler

public pointer: Pointer source

The pointer shown on the HTML5 canvas

public population: Number source

How many players are in the game, defaults to -1

public ready: Boolean source

Whether or not the game is ready

public renderer: Renderer source

An instance of the renderer

public shop: * source

public socket: Socket source

An instance of the web socket used to talk to the node server

public started: Boolean source

Whether or not the game is started

public storage: Object source

A reference to the player's LocalStorage

public time: Date source

Used for rendering fame ticks

public updater: Updater source

An instance of the updater

public zoning: Zoning source

Used to figure out direction

Public Methods

public animationCallback(id: , info: ) source

Params:

Name	Type	Attribute	Description
id	*
info	*

public audioCallback(song: *) source

Params:

Name	Type	Attribute	Description
song	*

public bankCallback(opcode: , info: ) source

Params:

Name	Type	Attribute	Description
opcode	*
info	*

public blinkCallback(instance: *) source

Params:

Name	Type	Attribute	Description
instance	*

public chatCallback(info: *) source

Params:

Name	Type	Attribute	Description
info	*

public combatCallback(data: *) source

Params:

Name	Type	Attribute	Description
data	*

public connect(): Boolean source

Connect to the nodeJS server and setup all the server to client callback messages

Return:

Boolean

public createPlayer() source

public deathCallback(id: *) source

Params:

Name	Type	Attribute	Description
id	*

public despawnCallback(id: Number): Boolean source

Callback for removing a spawned entity

Params:

Name	Type	Attribute	Description
id	Number		the id of the entity that needs to be removed

Return:

Boolean

public enchantCallback(opcode: , info: ) source

Params:

Name	Type	Attribute	Description
opcode	*
info	*

public entityListCallback(data: Array<Entity>): Boolean source

Callback for when the list of entities is done loading and adds the new entities to the screen

Params:

Name	Type	Attribute	Description
data	Array<Entity>		array of entities

Return:

Boolean

public equipmentCallback(action: Number, info: Object): Boolean source

Callback for when player equipment is done loading

Params:

Name	Type	Attribute	Description
action	Number		the equipment action
info	Object		information about the equipment

Return:

Boolean

public experienceCallback(info: *) source

Params:

Name	Type	Attribute	Description
info	*

public findPath(character: , x: , y: , ignores: ): * source

Params:

Name	Type	Attribute	Description
character	*
x	*
y	*
ignores	*

Return:

public getCamera(): * source

Return:

public getEntityAt(x: , y: , ignoreSelf: ): source

Params:

Name	Type	Attribute	Description
x	*
y	*
ignoreSelf	*

Return:

public getScaleFactor(): * source

Return:

public getSprite(spriteName: ): source

Params:

Name	Type	Attribute	Description
spriteName	*

Return:

public getStorage(): * source

Return:

public getStoragePassword(): * source

Return:

public getStorageUsername(): * source

Return:

public guildCallback(opcode: , info: ) source

Params:

Name	Type	Attribute	Description
opcode	*
info	*

public handleDisconnection(noError: *) source

This function is responsible for handling sudden disconnects of a player whilst in the game, not menu-based errors.

Params:

Name	Type	Attribute	Description
noError	*

public handshakeCallback(data: Messages): Boolean source

Callback for when the server has acknowledged the client connection then it creates the player object, makes sure the map is loaded, and if the user is registering or logging in it handles player registration or login requests

Params:

Name	Type	Attribute	Description
data	Messages		server network message

Return:

Boolean

public hasRemember(): * source

Return:

public healCallback(info: *) source

Params:

Name	Type	Attribute	Description
info	*

public implementStorage() source

public inventoryCallback(opcode: , info: ) source

Params:

Name	Type	Attribute	Description
opcode	*
info	*

public loadControllers(): Boolean source

Load all of the game controllers

Return:

Boolean

public loadGameMap(): Boolean source

Load the game map data

Return:

Boolean

public loadRenderer(): Boolean source

Load the HTML5 canvas renderer layers for:

background
foreground
text
entities
cursor

Return:

Boolean

public loadedSpritesCallback() source

public mapReadyCallback(): Boolean source

Callback for when the map data is done loading

Return:

Boolean

public moveCharacter(character: , x: , y: *) source

Params:

Name	Type	Attribute	Description
character	*
x	*
y	*

public movePlayer(x: , y: ) source

Params:

Name	Type	Attribute	Description
x	*
y	*

public movementCallback(data: Object<Messages>): Boolean source

Callback for entity movement

Params:

Name	Type	Attribute	Description
data	Object<Messages>		message data

Return:

Boolean

public networkCallback() source

public notificationCallback(opcode: , message: ) source

Params:

Name	Type	Attribute	Description
opcode	*
message	*

public npcCallback(opcode: , info: ) source

Params:

Name	Type	Attribute	Description
opcode	*
info	*

public onInput(inputType: , data: ) source

Params:

Name	Type	Attribute	Description
inputType	*
data	*

public pointerCallback(opcode: , info: ) source

Params:

Name	Type	Attribute	Description
opcode	*
info	*

public pointsCallback(data: *) source

Params:

Name	Type	Attribute	Description
data	*

public populationCallback(population: *) source

Params:

Name	Type	Attribute	Description
population	*

public postLoad() source

Call this after the player has been welcomed by the server and the client received the connection.

public projectileCallback(opcode: , info: ) source

Params:

Name	Type	Attribute	Description
opcode	*
info	*

public pvpCallback(id: , pvp: ) source

Params:

Name	Type	Attribute	Description
id	*
pvp	*

public questCallback(opcode: , info: ) source

Params:

Name	Type	Attribute	Description
opcode	*
info	*

public resize() source

public respawn() source

public respawnCallback(id: , x: , y: *) source

Params:

Name	Type	Attribute	Description
id	*
x	*
y	*

public setAudio(audio: *) source

Params:

Name	Type	Attribute	Description
audio	*

public setBubble(bubble: *) source

Params:

Name	Type	Attribute	Description
bubble	*

public setEntityController(entities: *) source

Params:

Name	Type	Attribute	Description
entities	*

public setInfo(info: *) source

Params:

Name	Type	Attribute	Description
info	*

public setInput(input: *) source

Params:

Name	Type	Attribute	Description
input	*

public setInterface(intrface: *) source

Params:

Name	Type	Attribute	Description
intrface	*

public setMessages(messages: *) source

Params:

Name	Type	Attribute	Description
messages	*

public setPathfinder(pathfinder: *) source

Params:

Name	Type	Attribute	Description
pathfinder	*

public setPlayerMovement(direction: *) source

Params:

Name	Type	Attribute	Description
direction	*

public setPointer(pointer: *) source

Params:

Name	Type	Attribute	Description
pointer	*

public setRenderer(renderer: *) source

Params:

Name	Type	Attribute	Description
renderer	*

public setSocket(socket: *) source

Params:

Name	Type	Attribute	Description
socket	*

public setStorage(storage: *) source

Params:

Name	Type	Attribute	Description
storage	*

public setUpdater(updater: *) source

Params:

Name	Type	Attribute	Description
updater	*

public shopCallback(opcode: , info: ) source

Params:

Name	Type	Attribute	Description
opcode	*
info	*

public spawnCallback(data: Object): Boolean source

Triggered when an entity has finished being spawned

Params:

Name	Type	Attribute	Description
data	Object		entity id

Return:

Boolean

public start(): Boolean source

Start the game

Return:

Boolean

true if the game was successfully started, false if the game is already running

public stop() source

Stop the game, sets started and ready to false

public syncCallback(playerEntity: Entity<Player>): Boolean source

Callback for when server side sync is done. Used to make sure the player's information doesn't differntiate from what the server has for them

Params:

Name	Type	Attribute	Description
playerEntity	Entity<Player>		player entity object

Return:

Boolean

false if this entity is not a player type

public teleportCallback(data: Object<Messages>): Boolean source

Callback for player teleport

Params:

Name	Type	Attribute	Description
data	Object<Messages>		information about the teleport

Return:

Boolean

public tick() source

Calls the renderer to draw to the HTML5 canvas if the game is ready and requests animations if the game is started

public tradeWith(player: *) source

Params:

Name	Type	Attribute	Description
player	*

public unload(): Boolean source

Resets all of the controllers, storage and entities in the game. Stops all audio too. Sets the game to a totally blank state so that it can be initialized like a new game all over again

Return:

Boolean

public welcomeCallback(playerData: Object): Boolean source

The callback for when the welcome message for brand new players is done. Loads the player data and sets their starting position then calls this.postLoad()

Params:

Name	Type	Attribute	Description
playerData	Object		the data needed to load the player

Return:

Boolean

Game

Constructor Summary

Member Summary

Method Summary

Public Constructors

public constructor(client: Client) source

Params:

Public Members

public audio: Audio source

public bubble: Bubble source

public client: Client source

public development: Boolean source

public entities: Array<Entity> source

public guild: Guild source

public id: Number source

public info: Info source

public input: Input source

public interface: Interface source

public lastTime: Boolean source

public loaded: Boolean source

public map: Map source

public messages: Messages source

public pathfinder: Pathfinder source

public player: Player source

public playerHandler: PlayerHandler source

public pointer: Pointer source

public population: Number source

public pvp: Boolean source

public ready: Boolean source

public renderer: Renderer source

public shop: * source

public socket: Socket source

public started: Boolean source

public storage: Object source

public time: Date source

public updater: Updater source

public zoning: Zoning source

Public Methods

public animationCallback(id: *, info: *) source

Params:

public audioCallback(song: *) source

Params:

public bankCallback(opcode: *, info: *) source

Params:

public blinkCallback(instance: *) source

Params:

public chatCallback(info: *) source

Params:

public combatCallback(data: *) source

Params:

public connect(): Boolean source

Return:

public createPlayer() source

public deathCallback(id: *) source

Params:

public despawnCallback(id: Number): Boolean source

Params:

Return:

public enchantCallback(opcode: *, info: *) source

Params:

public entityListCallback(data: Array<Entity>): Boolean source

Params:

Return:

public equipmentCallback(action: Number, info: Object): Boolean source

Params:

Return:

public experienceCallback(info: *) source

Params:

public findPath(character: *, x: *, y: *, ignores: *): * source

Params:

Return:

public getCamera(): * source

Return:

public getEntityAt(x: *, y: *, ignoreSelf: *): * source

Params:

Return:

public getScaleFactor(): * source

Return:

public getSprite(spriteName: *): * source

Params:

public animationCallback(id: , info: ) source

public bankCallback(opcode: , info: ) source

public enchantCallback(opcode: , info: ) source

public findPath(character: , x: , y: , ignores: ): * source

public getEntityAt(x: , y: , ignoreSelf: ): source

public getSprite(spriteName: ): source

public guildCallback(opcode: , info: ) source

public inventoryCallback(opcode: , info: ) source

public moveCharacter(character: , x: , y: *) source

public movePlayer(x: , y: ) source

public notificationCallback(opcode: , message: ) source

public npcCallback(opcode: , info: ) source

public onInput(inputType: , data: ) source

public pointerCallback(opcode: , info: ) source

public projectileCallback(opcode: , info: ) source

public pvpCallback(id: , pvp: ) source

public questCallback(opcode: , info: ) source

public respawnCallback(id: , x: , y: *) source