Package org.vrspace.server.obj

Class Game

java.lang.Object

org.vrspace.server.obj.Entity

org.vrspace.server.obj.VRObject

org.vrspace.server.obj.Game

@Node
public class Game
extends VRObject

A game in a world. Typically does not have mesh, but does have a script, that implements client-side game logic. It's an active object - all observers receive events generated by the game. Game object is Owned - only the Client that created it can change properties. Games can be persistent, or added by user(s). Depending on the game and world type, users can opt to join, or may join as soon as they enter the world. Server-side Game object maintains the list of currently active players, and provides basic functions to Clients, like joining and leaving the game. Note that a game members are Clients rather than Users - robots can play games, why not. The game listens to all events generated by players.

Constructor Summary

Constructors

Constructor	Description
Game()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
void	end(Client client)
boolean	equals(Object o)
String	getName()	Name of the game, supposed to be unique within the world
int	getNumberOfPlayers()	Current number of players
Set<ID>	getPlayers()
String	getStatus()
int	hashCode()
void	join(Client client)	A client wants to join the game.
void	processEvent(VREvent event)	Process a client (player) event.
void	quit(Client client)	A client left the game
void	setName(String name)	Name of the game, supposed to be unique within the world
void	setNumberOfPlayers(int numberOfPlayers)	Current number of players
void	setPlayers(Set<ID> players)
void	setStatus(String status)
void	start(Client client)
String	toString()

Methods inherited from class org.vrspace.server.obj.VRObject

active, addChildren, addListener, getActive, getAnimation, getChildren, getListeners, getMesh, getPermanent, getPosition, getProperties, getRotation, getScale, getScript, getTemporary, getWorld, getWorldId, isActive, isPermanent, isTemporary, notifyListeners, passive, removeListener, setActive, setAnimation, setChildren, setListeners, setMesh, setPermanent, setPosition, setProperties, setRotation, setScale, setScript, setTemporary, setWorld, setWorldId

Methods inherited from class org.vrspace.server.obj.Entity

dispose, getId, getObjectId, setId

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Game

public Game()

Method Details

join

public void join(Client client)

A client wants to join the game.

Parameters:

client -

quit

public void quit(Client client)

A client left the game

Parameters:

client -

start

public void start(Client client)

end

public void end(Client client)

processEvent

public void processEvent(VREvent event)

Process a client (player) event. This implementation does nothing, only removes the client from the player list on disconnect. CHECKME should we do that, what if they reconnect?

Overrides:

processEvent in class VRObject

Parameters:

event - Whatever has changed

getName

public String getName()

Name of the game, supposed to be unique within the world

getNumberOfPlayers

public int getNumberOfPlayers()

Current number of players

getStatus

public String getStatus()

getPlayers

public Set<ID> getPlayers()

setName

public void setName(String name)

Name of the game, supposed to be unique within the world

setNumberOfPlayers

public void setNumberOfPlayers(int numberOfPlayers)

Current number of players

setStatus

public void setStatus(String status)

setPlayers

public void setPlayers(Set<ID> players)

toString

public String toString()

Overrides:

toString in class VRObject

equals

public boolean equals(Object o)

Overrides:

equals in class VRObject

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VRObject

hashCode

public int hashCode()

Overrides:

hashCode in class VRObject