sc.framework.plugins

Class Player

sc.framework.plugins.Player

public class Player

Keeps information about a player:

• basic info: name and color

• state info: if they can time out, whether their game is paused

• game result info: left & timeouts, to determine the winner and potential violation information

• listeners: subscribers that get notified about new messages concerning this player, notably Welcome and Errors

Note: the toString/equals/hashCode/clone methods only take color and displayName into account!

Constructor Detail

Player

@JvmOverloads
public Player(@NotNull
                            ITeam color,
                            @NotNull
                            java.lang.String displayName)

Keeps information about a player:

• basic info: name and color

• state info: if they can time out, whether their game is paused

• game result info: left & timeouts, to determine the winner and potential violation information

• listeners: subscribers that get notified about new messages concerning this player, notably Welcome and Errors

Note: the toString/equals/hashCode/clone methods only take color and displayName into account!

Player

@JvmOverloads
public Player(@NotNull
                            ITeam color)

Keeps information about a player:

• basic info: name and color

• state info: if they can time out, whether their game is paused

• game result info: left & timeouts, to determine the winner and potential violation information

• listeners: subscribers that get notified about new messages concerning this player, notably Welcome and Errors

Note: the toString/equals/hashCode/clone methods only take color and displayName into account!

Method Detail

getListeners

@NotNull
protected java.util.List<sc.api.plugins.host.IPlayerListener> getListeners()

setListeners

protected void setListeners(@NotNull
                            java.util.List<sc.api.plugins.host.IPlayerListener> p)

getCanTimeout

public boolean getCanTimeout()

setCanTimeout

public void setCanTimeout(boolean p)

getLeft

public boolean getLeft()

setLeft

public void setLeft(boolean p)

hasLeft

public boolean hasLeft()

getSoftTimeout

public boolean getSoftTimeout()

setSoftTimeout

public void setSoftTimeout(boolean p)

hasSoftTimeout

public boolean hasSoftTimeout()

getHardTimeout

public boolean getHardTimeout()

setHardTimeout

public void setHardTimeout(boolean p)

hasHardTimeout

public boolean hasHardTimeout()

hasViolated

public boolean hasViolated()

getViolationReason

@Nullable
public java.lang.String getViolationReason()

setViolationReason

public void setViolationReason(@Nullable
                               java.lang.String p)

addPlayerListener

public void addPlayerListener(@NotNull
                              IPlayerListener listener)

removePlayerListener

public void removePlayerListener(@NotNull
                                 IPlayerListener listener)

notifyListeners

public void notifyListeners(@NotNull
                            ProtocolMessage o)

requestMove

public void requestMove()

toString

@NotNull
public java.lang.String toString()

clone

@NotNull
public Player clone()

equals

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

hashCode

public int hashCode()

getColor

@NotNull
public ITeam getColor()

setColor

public void setColor(@NotNull
                     ITeam p)

getDisplayName

@NotNull
public java.lang.String getDisplayName()

setDisplayName

public void setDisplayName(@NotNull
                           java.lang.String p)