com.electrotank.electroserver4.extensions.api.value
Class GameConfiguration

java.lang.Object
  com.electrotank.electroserver4.extensions.api.value.GameConfiguration

public class GameConfiguration
extends Object

Object class that holds the configuration of a single game. This is normally initialized in the init method of a class that implements ExtensionLifeCycle.

See Also:

ElectroServerApi.registerGameConfiguration, ExtensionLifeCycle

Constructor Summary

GameConfiguration()

Method Summary

EsObjectRO	getInitialGameDetails() Gets the initial game details.
RoomConfiguration	getRoomConfiguration() Gets the room configuration for the game.
boolean	isReceivingRoomListUpdates() Does this game receive room list updates?
boolean	isReceivingRoomVariableUpdates() Does this game receive room variable updates?
boolean	isReceivingUserListUpdates() Does this game receive user list updates?
boolean	isReceivingUserVariableUpdates() Does this game receive user variable updates?
boolean	isReceivingVideoEvents() Does this game receive video events?
void	setInitialGameDetails(EsObjectRO initialGameDetails) Sets the initial game details.
void	setReceivingRoomListUpdates(boolean receivingRoomListUpdates) Sets the game to receive room list updates, or not.
void	setReceivingRoomVariableUpdates(boolean receivingRoomVariableUpdates) Sets the game to receive room variable updates.
void	setReceivingUserListUpdates(boolean receivingUserListUpdates) Sets the game to receive user list updates.
void	setReceivingUserVariableUpdates(boolean receivingUserVariableUpdates) Sets the game to receive user variable updates.
void	setReceivingVideoEvents(boolean receivingVideoEvents) Sets the game to receive video events.
void	setRoomConfiguration(RoomConfiguration roomConfiguration) Sets the room configuration for the game.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GameConfiguration

public GameConfiguration()

Method Detail

isReceivingRoomListUpdates

public boolean isReceivingRoomListUpdates()

Does this game receive room list updates?

Returns:

true if the game receives room list updates

setReceivingRoomListUpdates

public void setReceivingRoomListUpdates(boolean receivingRoomListUpdates)

Sets the game to receive room list updates, or not.

Parameters:

receivingRoomListUpdates - true to start receiving room list updates, false to stop.

isReceivingUserListUpdates

public boolean isReceivingUserListUpdates()

Does this game receive user list updates?

Returns:

true if the room receives user list updates.

setReceivingUserListUpdates

public void setReceivingUserListUpdates(boolean receivingUserListUpdates)

Sets the game to receive user list updates.

Parameters:

receivingUserListUpdates - true to start receiving user list updates, false to stop.

isReceivingRoomVariableUpdates

public boolean isReceivingRoomVariableUpdates()

Does this game receive room variable updates?

Returns:

true if the room is receiving room variable updates.

setReceivingRoomVariableUpdates

public void setReceivingRoomVariableUpdates(boolean receivingRoomVariableUpdates)

Sets the game to receive room variable updates.

Parameters:

receivingRoomVariableUpdates - true to start receiving room variable updates, false to stop.

isReceivingUserVariableUpdates

public boolean isReceivingUserVariableUpdates()

Does this game receive user variable updates?

Returns:

true if the room is receiving user variable updates.

setReceivingUserVariableUpdates

public void setReceivingUserVariableUpdates(boolean receivingUserVariableUpdates)

Sets the game to receive user variable updates.

Parameters:

receivingUserVariableUpdates - true to start receiving user variable updates, false to stop.

isReceivingVideoEvents

public boolean isReceivingVideoEvents()

Does this game receive video events?

Returns:

true if the room is receiving video events.

setReceivingVideoEvents

public void setReceivingVideoEvents(boolean receivingVideoEvents)

Sets the game to receive video events.

Parameters:

receivingVideoEvents - true to start receiving video events, false to stop.

getRoomConfiguration

public RoomConfiguration getRoomConfiguration()

Gets the room configuration for the game.

Returns:

room configuration

See Also:

RoomConfiguration

setRoomConfiguration

public void setRoomConfiguration(RoomConfiguration roomConfiguration)

Sets the room configuration for the game.

Parameters:

roomConfiguration - new room configuration

See Also:

RoomConfiguration

getInitialGameDetails

public EsObjectRO getInitialGameDetails()

Gets the initial game details.

Returns:

gameDetails

setInitialGameDetails

public void setInitialGameDetails(EsObjectRO initialGameDetails)

Sets the initial game details.

Parameters:

initialGameDetails - initial game details