ReturnToDeck

From VASSAL
Jump to: navigation, search

VASSAL Reference Manual

Home > Module > Game Piece Palette > Game Piece > Return to Deck


Return to Deck

The 'Return to Deck' trait adds a menu entry to a piece's right-click menu.  Selecting that entry will place the piece in a Deck.  If there is only one Deck in the module the piece will be added to it.  If the module has more than one Deck, you may select the Deck that the piece will be placed in. Alternatively, you may prompt the players to choose a deck when 'Return to Deck' is clicked.

EXAMPLE:
For a game in which cards are drawn from a deck, used, and placed into a discard pile,  both the deck and the discard pile will be represented by a Deck component.  By adding a Return to Deck trait to each card, with the text 'Discard' and the command 'D', then hitting CTRL-D on any card will automatically send it to the discard pile.

ReturnToDeck.png