net.sf.magicproject.action.listener
Interface WaitingPlayer

All Superinterfaces:

Waiting

All Known Implementing Classes:

ChoosenTarget, RealTarget, SilentTarget

public interface WaitingPlayer
extends Waiting

Since:

0.86

Author:

Fabrice Daugan

Method Summary

boolean	clickOn(Player player) Called to specify the player chosen for the current action by the handed player
void	finished() Called when this action is finished (aborted or completed).
boolean	manualSkip() Called by the handed player when he/she wants to skip/abort this action.
boolean	succeedClickOn(Player player) This function should be called by the 'clickOn' caller in case of the specified player has been handled during the checking validity of this click in the clickOn(Player) function.

Method Detail

clickOn

boolean clickOn(Player player)

Called to specify the player chosen for the current action by the handed player

Parameters:

player - the clicked player by the handed player for the current action

Returns:

true if this click has been managed. Return false if this click has been ignored

succeedClickOn

boolean succeedClickOn(Player player)

This function should be called by the 'clickOn' caller in case of the specified player has been handled during the checking validity of this click in the clickOn(Player) function.

The calls chain is :
• actionListener call clickOn(Player)
• if returned value is false we give hand to the player and exit, else we continue
• actionListener call succeedClickOn(Player)

Parameters:

player - the player that was clicked and successfuly handled by the clickOn(Player) function.

Returns:

true if this action is completed

finished

void finished()

Description copied from interface: Waiting

Called when this action is finished (aborted or completed). No stack operation should be done here.

Specified by:

finished in interface Waiting

manualSkip

boolean manualSkip()

Description copied from interface: Waiting

Called by the handed player when he/she wants to skip/abort this action. No stack operation should be done here.

Specified by:

manualSkip in interface Waiting

Returns:

true if this action allow the skip/cancel.