Skip to content

Commit 28c84e8

Browse files
Document SMODS.PokerHand.modify_display_text
1 parent 69278d9 commit 28c84e8

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

SMODS.PokerHand.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,9 @@
3030
- `{ hand }` if all cards score,
3131
- `{ SMODS.merge_lists(parts._flush, parts._straight) }` for all scoring cards that are part of a straight or flush, or
3232
- `{}` if the cards don't contain this hand.
33+
- `modify_display_text(self, cards, scoring_hnd) -> string?`
34+
- Changes the displayed name of the poker hand.
35+
- Returns the key to the new display name that gets localized (placed inside of `misc.poker_hands[key]`).
3336

3437
## Utility functions
3538
- `SMODS.merge_lists(...) -> table`

0 commit comments

Comments
 (0)