Return to Deck Documentation?

Module Design
1

Howdy,

Maybe I don’t know where to look, but I’m having trouble finding the documentation on the Return to Deck trait in the Reference Manual. It doesn’t seem to be included in the game piece trait list: https://vassalengine.org/doc/latest/ReferenceManual/GamePiece.html#Traits
Although I see a text reference to the Return to Deck trait in the Name property discussion for Decks in: VASSAL Reference Manual
I don’t see any links to documentation for the Return to Deck on that Deck page.

I am using the Return to Deck trait, but having a problem that I will write about in a separate topic
Edit: The second post in KC to Apply to all units ending movement on this map is a description of what I perceive as the problem.

Any help would be appreciated.

2

The Return to Deck reference page certainly exists, but you’re right it looks like it’s dropped off the list of piece traits on your initial link.

2 Likes
3

Here’s a PR to add the missing entry to the trait list in the Reference Manual. It will be there when 3.7.8 is released at the end of the month.

2 Likes
4

So… I have a question on this… “Most” decks are randomized, but some games use decks that are not randomized and the maintaining the correct order is critical…
Most games that do this, put the card at the bottom of the stack, but some put it at the top of the stack…

So for a non-randomized deck, does “Return to Deck” put it on the TOP or BOTTOM of the deck?

IMHO, it would be good to give the module designer the flexibility to do either…

1 Like
5

Hi;
Would a Deck Sort Key Command help with that?

Darren

6

I don’t think so… Because while that will allow you to sort the deck based on some inherent property of the cards, the use case I describe must maintain relative order of pulled/played/discards (when there is no separate discard pile).

Imagine a deck (top) A, B, C, D, E, F, G, H (bottom). (Note there is no separate discard pile).

Scenario #1: Discards go to top.
I draw 3 cards (A, B, C) and play/discard “B” (retain A, C in hand).
Deck is now: (top) B, D, E, F, G, H (bottom)

Scenario #2: Discards go to bottom.
I draw 3 cards (A, B, C) and play/discard “B” (retain A, C in hand).
Deck is now: (top) D, E, F, G, H, B (bottom)

7

Good question. When targeting an ordered deck, Return to Deck puts something on top of that deck. The docs should be modified to make that clear.

To get a card to the bottom of an ordered deck, you can employ a Trigger that first sends the RtD, then applies Down arrow.

2 Likes
8

That is handy to know. How did you find this information?

Darren

9

I had a minimal module with an ordered deck in it already from something I was demonstrating to another user just within the last few days, so I modified it quick to test and make sure it works the way I thought it did.

1 Like