sc.protocol.requests

Class PrepareGameRequest

sc.protocol.requests.PrepareGameRequest

All Implemented Interfaces:

AdminLobbyRequest, ILobbyRequest, ProtocolMessage

public class PrepareGameRequest
implements AdminLobbyRequest

Request to prepare a game of gameType with two reserved slots according to slotDescriptors.

Constructor Detail

PrepareGameRequest

public PrepareGameRequest(@NotNull
                          java.lang.String gameType,
                          @NotNull
                          SlotDescriptor[] slotDescriptors,
                          boolean pause)

Request to prepare a game of gameType with two reserved slots according to slotDescriptors.

PrepareGameRequest

@JvmOverloads
public PrepareGameRequest(@NotNull
                                        java.lang.String gameType,
                                        @NotNull
                                        SlotDescriptor descriptor1,
                                        @NotNull
                                        SlotDescriptor descriptor2,
                                        boolean pause)

Create a prepared game with descriptors for each player. The player descriptors default to "Player1" and "Player2".

Parameters:

gameType - type of the game (plugin id)

pause - whether the game should start paused

PrepareGameRequest

@JvmOverloads
public PrepareGameRequest(@NotNull
                                        java.lang.String gameType,
                                        @NotNull
                                        SlotDescriptor descriptor1,
                                        @NotNull
                                        SlotDescriptor descriptor2)

Create a prepared game with descriptors for each player. The player descriptors default to "Player1" and "Player2".

Parameters:

gameType - type of the game (plugin id)

PrepareGameRequest

@JvmOverloads
public PrepareGameRequest(@NotNull
                                        java.lang.String gameType,
                                        @NotNull
                                        SlotDescriptor descriptor1)

Create a prepared game with descriptors for each player. The player descriptors default to "Player1" and "Player2".

Parameters:

gameType - type of the game (plugin id)

PrepareGameRequest

@JvmOverloads
public PrepareGameRequest(@NotNull
                                        java.lang.String gameType)

Create a prepared game with descriptors for each player. The player descriptors default to "Player1" and "Player2".

Parameters:

gameType - type of the game (plugin id)

Method Detail

equals

public boolean equals(@Nullable
                      java.lang.Object other)

hashCode

public int hashCode()

getGameType

@NotNull
public java.lang.String getGameType()

getSlotDescriptors

@NotNull
public SlotDescriptor[] getSlotDescriptors()

getPause

public boolean getPause()

component1

@NotNull
public java.lang.String component1()

component2

@NotNull
public SlotDescriptor[] component2()

component3

public boolean component3()

copy

@NotNull
public PrepareGameRequest copy(@NotNull
                                        java.lang.String gameType,
                                        @NotNull
                                        SlotDescriptor[] slotDescriptors,
                                        boolean pause)

Request to prepare a game of gameType with two reserved slots according to slotDescriptors.

toString

@NotNull
public java.lang.String toString()

Request to prepare a game of gameType with two reserved slots according to slotDescriptors.