test.md

Classes

GameObject

World ÔçÉ GameObject

Crumb

Map

Player ÔçÉ GameObject

Room

AssetContainer ÔçÉ createjs.Container

BalloonContainer

BeepContainer

BeepItem

CritterContainer

LayerContainer ÔçÉ createjs.Container

MapContainer

MascotContainer

MenuContainer

MonsterContainer

NicknameContainer

PlayerContainer

RoomContainer

Inventory

Background

CoinsWidget

Beep

Functions

calculateDistance(t, e, i, o) ÔçÆ Number

calculateAngle(t, e, i, o) ÔçÆ Number

findDirection(t) ÔçÆ Number

handleDepthSort(t)

findObjectInArray(t, e, i)

removeObjectInArray(t, e, i)

createBalloon(t, e)

GameObject

Kind: global class
Properties

Name	Type
_events	*

• GameObject
  • .on(t, e)
  • .emit(t)

gameObject.on(t, e)

Kind: instance method of GameObject

Param	Type
t	*
e	*

gameObject.emit(t)

Kind: instance method of GameObject

Param	Type
t	*

World ÔçÉ GameObject

Kind: global class
Extends: GameObject
Properties

Name	Type
player	Player
room	Room
data	*
data.settings	*
data.critters	Array.<Critter>

• World ÔçÉ GameObject
  • new World(t)
  • .updateData(t, e)
  • .getData(t)
  • .getItemData(t)
  • .getCritterData(t)
  • .updatePlayer(t)
  • .getPlayer()
  • .handleSocket()
  • .handleLogin(t)
  • .handleJoinRoom(t)
  • .login(t)
  • .logout()
  • .joinRoom(t)
  • .sendMessage(t)
  • .sendCode(t)
  • .sendMove(t, e)
  • .sendTrigger()
  • .updateData(t, e)
  • .getData(t)
  • .getItemData(t)
  • .getCritterData(t)
  • .updatePlayer(t)
  • .getPlayer()
  • .handleSocket()
  • .handleLogin(t)
  • .handleJoinRoom(t)
  • .login(t)
  • .logout()
  • .joinRoom(t)
  • .sendMessage(t)
  • .sendCode(t)
  • .sendMove(t, e)
  • .sendTrigger()
  • .on(t, e)
  • .emit(t)

new World(t)

The current session housing notably the current player and the room they're in.

Param	Type
t	*

world.updateData(t, e)

Kind: instance method of World

Param	Type
t	*
e	*

world.getData(t)

Kind: instance method of World

Param	Type
t	*

world.getItemData(t)

Kind: instance method of World

Param	Type
t	*

world.getCritterData(t)

Kind: instance method of World

Param	Type
t	*

world.updatePlayer(t)

Kind: instance method of World

Param	Type
t	*

world.getPlayer()

Kind: instance method of World

world.handleSocket()

Kind: instance method of World

world.handleLogin(t)

Kind: instance method of World

Param	Type
t	*

world.handleJoinRoom(t)

Kind: instance method of World

Param	Type
t	*

world.login(t)

Kind: instance method of World

Param	Type
t	*

world.logout()

Kind: instance method of World

world.joinRoom(t)

Kind: instance method of World

Param	Type
t	*

world.sendMessage(t)

Kind: instance method of World

Param	Type
t	*

world.sendCode(t)

Kind: instance method of World

Param	Type
t	*

world.sendMove(t, e)

Kind: instance method of World

Param	Type
t	*
e	*

world.sendTrigger()

Kind: instance method of World

world.updateData(t, e)

Kind: instance method of World

Param	Type
t	*
e	*

world.getData(t)

Kind: instance method of World

Param	Type
t	*

world.getItemData(t)

Kind: instance method of World

Param	Type
t	*

world.getCritterData(t)

Kind: instance method of World

Param	Type
t	*

world.updatePlayer(t)

Kind: instance method of World

Param	Type
t	*

world.getPlayer()

Kind: instance method of World

world.handleSocket()

Kind: instance method of World

world.handleLogin(t)

Kind: instance method of World

Param	Type
t	*

world.handleJoinRoom(t)

Kind: instance method of World

Param	Type
t	*

world.login(t)

Kind: instance method of World

Param	Type
t	*

world.logout()

Kind: instance method of World

world.joinRoom(t)

Kind: instance method of World

Param	Type
t	*

world.sendMessage(t)

Kind: instance method of World

Param	Type
t	*

world.sendCode(t)

Kind: instance method of World

Param	Type
t	*

world.sendMove(t, e)

Kind: instance method of World

Param	Type
t	*
e	*

world.sendTrigger()

Kind: instance method of World

world.on(t, e)

Kind: instance method of World

Param	Type
t	*
e	*

world.emit(t)

Kind: instance method of World

Param	Type
t	*

Crumb

Kind: global class

• Crumb
  • new Crumb(t)
  • .get(t)

new Crumb(t)

Param	Type
t	*

crumb.get(t)

Kind: instance method of Crumb

Param	Type
t	*

Map

Kind: global class

• Map
  • new Map(t)
  • .getTile(t, e)
  • .getTrigger(t)
  • .getLayer(t)
  • .new(t, e)

new Map(t)

Param	Type
t	*

map.getTile(t, e)

Kind: instance method of Map

Param	Type
t	*
e	*

map.getTrigger(t)

Kind: instance method of Map

Param	Type
t	*

map.getLayer(t)

Kind: instance method of Map

Param	Type
t	*

map.new(t, e)

Kind: instance method of Map

Param	Type
t	*
e	*

Player ÔçÉ GameObject

Kind: global class
Extends: GameObject

• Player ÔçÉ GameObject
  • new Player(t)
  • .getPlayerId()
  • .getCrumb()
  • .updateData(t)
  • .getCoins()
  • .updateCoins(t)
  • .updateGear(t)
  • .addItem(t)
  • .removeItem(t)
  • .isItemActive(t)
  • .getItemFromInventory(t)
  • .on(t, e)
  • .emit(t)

new Player(t)

Param	Type
t	*

player.getPlayerId()

Kind: instance method of Player

player.getCrumb()

Kind: instance method of Player

player.updateData(t)

Kind: instance method of Player

Param	Type
t	*

player.getCoins()

Kind: instance method of Player

player.updateCoins(t)

Kind: instance method of Player

Param	Type
t	*

player.updateGear(t)

Kind: instance method of Player

Param	Type
t	*

player.addItem(t)

Kind: instance method of Player

Param	Type
t	*

player.removeItem(t)

Kind: instance method of Player

Param	Type
t	*

player.isItemActive(t)

Kind: instance method of Player

Param	Type
t	*

player.getItemFromInventory(t)

Kind: instance method of Player

Param	Type
t	*

player.on(t, e)

Kind: instance method of Player

Param	Type
t	*
e	*

player.emit(t)

Kind: instance method of Player

Param	Type
t	*

Room

Kind: global class

• Room
  • new Room(t)
  • .addPlayer(t)
  • .getPlayer(t)
  • .removePlayer(t)
  • .updatePlayer(t)

new Room(t)

Param	Type
t	*

room.addPlayer(t)

Kind: instance method of Room

Param	Type
t	*

room.getPlayer(t)

Kind: instance method of Room

Param	Type
t	*

room.removePlayer(t)

Kind: instance method of Room

Param	Type
t	*

room.updatePlayer(t)

Kind: instance method of Room

Param	Type
t	*

AssetContainer ÔçÉ createjs.Container

Kind: global class
Extends: createjs.Container

• AssetContainer ÔçÉ createjs.Container
  • new AssetContainer(t)
  • .showEdit()

new AssetContainer(t)

Param	Type
t	*

assetContainer.showEdit()

Kind: instance method of AssetContainer

BalloonContainer

Kind: global class

• BalloonContainer
  • new BalloonContainer(t)
  • .showMessage(t)

new BalloonContainer(t)

Param	Type
t	*

balloonContainer.showMessage(t)

Kind: instance method of BalloonContainer

Param	Type
t	*

BeepContainer

Kind: global class

• BeepContainer
  • new BeepContainer(t, e)
  • .show(t)
  • .alert(t, e)
  • .message(t)
  • .grant(t)

new BeepContainer(t, e)

Param	Type
t	*
e	*

beepContainer.show(t)

Kind: instance method of BeepContainer

Param	Type
t	*

beepContainer.alert(t, e)

Kind: instance method of BeepContainer

Param	Type
t	*
e	*

beepContainer.message(t)

Kind: instance method of BeepContainer

Param	Type
t	*

beepContainer.grant(t)

Kind: instance method of BeepContainer

Param	Type
t	*

BeepItem

Kind: global class

new BeepItem(t)

Param	Type
t	*

CritterContainer

Kind: global class

• CritterContainer
  • new CritterContainer(t)
  • .addItem(t, e)
  • .removeItem(t)
  • .updateGear(t)
  • .updateDirection(t)
  • .updateDepth()
  • .updateState(t)

new CritterContainer(t)

Param	Type
t	*

critterContainer.addItem(t, e)

Kind: instance method of CritterContainer

Param	Type
t	*
e	*

critterContainer.removeItem(t)

Kind: instance method of CritterContainer

Param	Type
t	*

critterContainer.updateGear(t)

Kind: instance method of CritterContainer

Param	Type
t	*

critterContainer.updateDirection(t)

Kind: instance method of CritterContainer

Param	Type
t	*

critterContainer.updateDepth()

Kind: instance method of CritterContainer

critterContainer.updateState(t)

Kind: instance method of CritterContainer

Param	Type
t	*

LayerContainer ÔçÉ createjs.Container

Kind: global class
Extends: createjs.Container

• LayerContainer ÔçÉ createjs.Container
  • new LayerContainer(t, e, i)
  • .addSprite(t, e)
  • .addGroup(t, e)

new LayerContainer(t, e, i)

Param	Type
t	*
e	*
i	*

layerContainer.addSprite(t, e)

Kind: instance method of LayerContainer

Param	Type
t	*
e	*

layerContainer.addGroup(t, e)

Kind: instance method of LayerContainer

Param	Type
t	*
e	*

MapContainer

Kind: global class

new MapContainer(t)

Param	Type
t	*

MascotContainer

Kind: global class

new MascotContainer(t)

Param	Type
t	*

MenuContainer

Kind: global class

new MenuContainer(t)

Param	Type
t	*

MonsterContainer

Kind: global class

new MonsterContainer(t)

Param	Type
t	*

NicknameContainer

Kind: global class

new NicknameContainer(t)

Param	Type
t	*

PlayerContainer

Kind: global class

new PlayerContainer(t, e)

Param	Type
t	*
e	*

RoomContainer

Kind: global class

new RoomContainer(t)

Param	Type
t	*

Inventory

Kind: global class

new Inventory(e)

Param	Type
e	*

Background

Kind: global class

CoinsWidget

Kind: global class

Beep

Kind: global class

new Beep(t, e)

Param	Type
t	*
e	*

calculateDistance(t, e, i, o) ÔçÆ Number

Kind: global function

Param	Type
t	Number
e	Number
i	Number
o	Number

calculateAngle(t, e, i, o) ÔçÆ Number

Kind: global function

Param	Type
t	Number
e	Number
i	Number
o	Number

findDirection(t) ÔçÆ Number

Kind: global function

Param	Type
t	Number

handleDepthSort(t)

Kind: global function

Param	Type
t	*

findObjectInArray(t, e, i)

Kind: global function

Param	Type
t	*
e	*
i	*

removeObjectInArray(t, e, i)

Kind: global function

Param	Type
t	*
e	*
i	*

createBalloon(t, e)

Kind: global function

Param	Type
t	*
e	*