Package com.pixelmonmod.pixelmon.api.battles.animation.schedule.acknowledge

Class PendingClientAcknowledgement

java.lang.Object

com.pixelmonmod.pixelmon.api.battles.animation.schedule.acknowledge.PendingClientAcknowledgement

All Implemented Interfaces:

ClientAcknowledgementState

public class PendingClientAcknowledgement
extends Object
implements ClientAcknowledgementState

Acknowledgement state that waits for a set of clients to respond.

Constructor Summary

Constructors

Constructor	Description
PendingClientAcknowledgement(BattleAnimationClientAcknowledgement config, Set<UUID> waitingFor)

Method Summary

Modifier and Type	Method	Description
void	acknowledge(UUID playerId, UUID acknowledgementId)	Handles an acknowledgement received from a client.
void	complete()	Marks acknowledgement as complete.
BattleAnimationClientAcknowledgement	config()	Returns the acknowledgement configuration that created this state.
UUID	id()	Returns the acknowledgement id clients must echo back.
boolean	isComplete()	Returns whether all required clients have acknowledged.
boolean	isPending()	Returns whether this state is waiting on clients.
boolean	isTimedOut()	Returns whether this acknowledgement has timed out.
void	tick()	Advances timeout tracking by one tick.
Set<UUID>	waitingFor()	Returns the clients that have not acknowledged yet.

Methods inherited from class java.lang.Object

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

Constructor Details

PendingClientAcknowledgement

public PendingClientAcknowledgement(BattleAnimationClientAcknowledgement config,
 Set<UUID> waitingFor)

Method Details

isPending

public boolean isPending()

Description copied from interface: ClientAcknowledgementState

Returns whether this state is waiting on clients.

Specified by:

isPending in interface ClientAcknowledgementState

Returns:

true while acknowledgement is pending

id

public UUID id()

Description copied from interface: ClientAcknowledgementState

Returns the acknowledgement id clients must echo back.

Specified by:

id in interface ClientAcknowledgementState

Returns:

the acknowledgement id

config

public BattleAnimationClientAcknowledgement config()

Description copied from interface: ClientAcknowledgementState

Returns the acknowledgement configuration that created this state.

Specified by:

config in interface ClientAcknowledgementState

Returns:

the acknowledgement configuration

waitingFor

public Set<UUID> waitingFor()

Description copied from interface: ClientAcknowledgementState

Returns the clients that have not acknowledged yet.

Specified by:

waitingFor in interface ClientAcknowledgementState

Returns:

the waiting player ids

tick

public void tick()

Description copied from interface: ClientAcknowledgementState

Advances timeout tracking by one tick.

Specified by:

tick in interface ClientAcknowledgementState

acknowledge

public void acknowledge(UUID playerId,
 UUID acknowledgementId)

Description copied from interface: ClientAcknowledgementState

Handles an acknowledgement received from a client.

Specified by:

acknowledge in interface ClientAcknowledgementState

Parameters:

playerId - the acknowledging player

acknowledgementId - the acknowledgement id sent by the client

isComplete

public boolean isComplete()

Description copied from interface: ClientAcknowledgementState

Returns whether all required clients have acknowledged.

Specified by:

isComplete in interface ClientAcknowledgementState

Returns:

true when acknowledgement is complete

isTimedOut

public boolean isTimedOut()

Description copied from interface: ClientAcknowledgementState

Returns whether this acknowledgement has timed out.

Specified by:

isTimedOut in interface ClientAcknowledgementState

Returns:

true when the configured timeout has elapsed

complete

public void complete()

Description copied from interface: ClientAcknowledgementState

Marks acknowledgement as complete.

Specified by:

complete in interface ClientAcknowledgementState