Skip to content

Document SMODS.card_to_image #138

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

Document SMODS.card_to_image #138

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
9 changes: 9 additions & 0 deletions Utility.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Steamodded provides utility functions that extend or replace vanilla functionali
- [Mod-facing Utilities](#mod-facing-utilities)
- [Joker Effects](#joker-effects)
- [Card Methods](#card-methods)
- [Miscellaneous](#miscellaneous)

***

Expand Down Expand Up @@ -270,3 +271,11 @@ This function checks whether a card object should display the front sprite or no
This function checks if a Joker is a certain rarity. Accepts a number for vanilla rarities, or a key as a string for modded rarities.
#### `Card:can_calculate(ignore_debuff, ignore_sliced) -> boolean`
This function checks whether a card can run its `calculate` function.

## Miscellaneous

#### `SMODS.card_to_image(card, scale, filename)`
Renders one card to a `.png` file, saved to your save directory (the folder above the Mods folder).
- `card` - Card to save as an image
- `scale` Scale to render the card at (default = `G.SETTINGS.GRAPHICS.texture_scaling`)
- `filename` - Name of the file (default = `card.config.center.key`)