Skip to content

update select_card docs #125

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nh6574 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

update select_card docs #125

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion SMODS.Center/SMODS.Booster.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
- `select_card`:
- Set to string of destination card area, ex. `'consumeables'`, to save cards from the pack instead of using them.
- Set to table of form `{Set = 'area'}` to change behaviour according to a card's `Set` (e.g. `{Tarot = 'consumeables'}` to only save `Tarot` cards, relevant if you have multiple types of consumables in a booster).
- Set to a function `select_card(self, card, pack) -> string?` to control if and where `card` should be saved for any `card, pack` combination.
- Set to a function `select_card(self, card, pack) -> string?, boolean?` to control if and where `card` should be saved for any `card, pack` combination. Returning `true` as the second value allows the player to select whether to save or use the card.
- `disable_shine`: *(added in 1531zeebee)* Disables the default 'shine' shader.

## API methods
Expand Down
2 changes: 1 addition & 1 deletion SMODS.Center/SMODS.Consumable.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
- `can_repeat_soul`, allows repeats of this card as if Showman were present
- `select_card`:
- Set to string of destination card area, ex. `'consumeables'`, to save this card from Booster packs instead of using it.
- Set to a function `select_card(card, pack) -> string?` to control if and where `card` should be saved for any `card, pack` combination.
- Set to a function `select_card(card, pack) -> string?, boolean?` to control if and where `card` should be saved for any `card, pack` combination. Returning `true` as the second value allows the player to select whether to save or use the card.
- Takes priority over `select_card` on the ConsumableType or Booster pack
- `disable_shine`: *(added in 1531zeebee)* Disables the default 'shine' shader for Spectrals.

Expand Down
2 changes: 1 addition & 1 deletion SMODS.ObjectType.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ This is a subclass of `SMODS.ObjectType`. All values and functions tied to `SMOD
- `text_colour`: Set a custom text color used on the card type's badge. This can take any HEX color, and saves it as `G.C.UI[key]`.
- `select_card`:
- Set to string of destination card area, ex. `'consumeables'`, to save cards of this type from Booster packs instead of using it.
- Set to a function `select_card(card, pack) -> string?` to control if and where `card` should be saved for any `card, pack` combination.
- Set to a function `select_card(card, pack) -> string?, boolean?` to control if and where `card` should be saved for any `card, pack` combination. Returning `true` as the second value allows the player to select whether to save or use the card.
- Takes priority over `select_card` on the Booster pack

## API methods
Expand Down