Package sfs3.client.requests

Class PlayerToSpectatorRequest

java.lang.Object

sfs3.client.requests.BaseRequest

sfs3.client.requests.PlayerToSpectatorRequest

All Implemented Interfaces:

sfs3.client.requests.IClientRequest

public class PlayerToSpectatorRequest
extends BaseRequest

Turns the current user from player to spectator in a Game Room.

If the operation is successful, all the users in the target Room are notified with the playerToSpectator event. The operation could fail if no spectator slots are available in the Game Room at the time of the request; in this case the playerToSpectatorError event is dispatched to the requester's client.

See Also:

• SFSEvent.PLAYER_TO_SPECTATOR
• SFSEvent.PLAYER_TO_SPECTATOR_ERROR
• SpectatorToPlayerRequest

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY_ROOM_ID
static final String	KEY_USER_ID

Fields inherited from class sfs3.client.requests.BaseRequest

AddBuddy, AdminMessage, AutoJoin, BanUser, BanUsersFromRoom, BlockBuddy, CallExtension, ChangeRoomCapacity, ChangeRoomName, ChangeRoomPassword, ClusterInviteUsers, ClusterJoinOrCreate, CreateRoom, CreateSFSGame, FindRooms, FindUsers, GameServerConnectionRequired, GenericMessage, GetRoomList, GoOnline, Handshake, InitBuddyList, InvitationReply, InviteUser, JoinRoom, JoinRoomInvite, KEY_ERROR_CODE, KEY_ERROR_PARAMS, KickUser, LeaveRoom, Login, Logout, ManualDisconnection, ModeratorMessage, ObjectMessage, PingPong, PlayerToSpectator, PrivateMessage, PublicMessage, QuickJoinGame, QuickJoinOrCreateRoom, RemoveBuddy, SetBuddyVariables, SetRoomVariables, SetUserPosition, SetUserVariables, sfso, SpectatorToPlayer, SubscribeRoomGroup, targetController, UdpInit, UnsubscribeRoomGroup

Constructor Summary

Constructors

Constructor	Description
PlayerToSpectatorRequest()
PlayerToSpectatorRequest(Room targetRoom)	Creates a new PlayerToSpectatorRequest instance.

Method Summary

Modifier and Type	Method	Description
void	execute(ISmartFox sfs)
void	validate(ISmartFox sfs)

Methods inherited from class sfs3.client.requests.BaseRequest

getId, getRequest, getTargetController, getTransportType, setId, setTargetController, setTransportType

Methods inherited from class java.lang.Object

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

Field Details

KEY_ROOM_ID

public static final String KEY_ROOM_ID

See Also:

• Constant Field Values

Internal

KEY_USER_ID

public static final String KEY_USER_ID

See Also:

• Constant Field Values

Internal

Constructor Details

PlayerToSpectatorRequest

public PlayerToSpectatorRequest(Room targetRoom)

Creates a new PlayerToSpectatorRequest instance. The instance must be passed to the SmartFox.send() method for the request to be performed.

Parameters:

targetRoom - The Room object corresponding to the Room in which the player should be turned to spectator. If null, the last Room joined by the user is used.

See Also:

• SmartFox.send(sfs3.client.requests.IClientRequest)
• Room

PlayerToSpectatorRequest

public PlayerToSpectatorRequest()

See Also:

• PlayerToSpectatorRequest(sfs3.client.entities.Room)

Method Details

validate

public void validate(ISmartFox sfs)
              throws SFSValidationException

Throws:

SFSValidationException

Internal

execute

public void execute(ISmartFox sfs)

Internal