monorail
/
Scrython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated docs

This commit is contained in:
NandaScott 2019-04-01 13:01:17 -04:00
parent 26526e802b
commit ce29649a73
7 changed files with 378 additions and 238 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

84
docs/scrython.cards/ArenaId.md
View File

@ -131,32 +131,6 @@ A list of strings with all colors found in the mana cost
Returns: Returns:
list list
```
---
### `colorshifted()`
```
Returns True if the card is colorshifted
Returns:
boolean
```
---
### `currency()`
```
Returns currency from modes `usd`, `eur`, and `tix`
Args:
mode (string): The currency to get
Raises:
KeyError: If the mode parameter does not match a known key
Returns:
float: The currency as a float
``` ```
--- ---
### `digital()` ### `digital()`
@ -207,6 +181,16 @@ The year of the card frame
Returns: Returns:
string string
```
---
### `frame_effect()`
```
The card's frame effect, if any. (miracle, nyxtouched, etc.)
Returns:
string: The card's frame effect.
``` ```
--- ---
### `full_art()` ### `full_art()`
@ -219,13 +203,13 @@ Returns True if the card is considered full art
``` ```
--- ---
### `futureshifted()` ### `games()`
``` ```
Returns True if the card is futureshifted A list of games that this card print is available in.
Returns: Returns:
boolean array: A list of games
``` ```
--- ---
@ -448,6 +432,22 @@ The power of the creature, if applicable
Returns: Returns:
string string
```
---
### `prices()`
```
Returns prices from modes `usd`, `usd_foil`, `eur`, and `tix`
Args:
mode (string): The prices to get
Raises:
KeyError: If the mode parameter does not match a known key
Returns:
float: The prices as a float
``` ```
--- ---
### `printed_name()` ### `printed_name()`
@ -488,6 +488,16 @@ A link to where you can begin paginating all re/prints for this card on Scryfall
Returns: Returns:
string string
```
---
### `promo()`
```
True if this card is a promotional print.
Returns:
boolean
``` ```
--- ---
### `purchase_uris()` ### `purchase_uris()`
@ -518,6 +528,16 @@ A dictionary of related websites for this card
Returns: Returns:
dict dict
```
---
### `released_at()`
```
The date this card was first released.
Returns:
string: The date in ISO format
``` ```
--- ---
### `reprint()` ### `reprint()`
@ -621,13 +641,13 @@ True if this card is featured in the story
``` ```
--- ---
### `timeshifted()` ### `tcgplayer_id()`
``` ```
Returns True if the card is timeshifted The `productId` of the card on TCGplayer.
Returns: Returns:
boolean integer: The TCGplayer id of the card
``` ```
--- ---

84
docs/scrython.cards/Collector.md
View File

@ -128,32 +128,6 @@ A list of strings with all colors found in the mana cost
Returns: Returns:
list list
```
---
### `colorshifted()`
```
Returns True if the card is colorshifted
Returns:
boolean
```
---
### `currency()`
```
Returns currency from modes `usd`, `eur`, and `tix`
Args:
mode (string): The currency to get
Raises:
KeyError: If the mode parameter does not match a known key
Returns:
float: The currency as a float
``` ```
--- ---
### `digital()` ### `digital()`
@ -204,6 +178,16 @@ The year of the card frame
Returns: Returns:
string string
```
---
### `frame_effect()`
```
The card's frame effect, if any. (miracle, nyxtouched, etc.)
Returns:
string: The card's frame effect.
``` ```
--- ---
### `full_art()` ### `full_art()`
@ -216,13 +200,13 @@ Returns True if the card is considered full art
``` ```
--- ---
### `futureshifted()` ### `games()`
``` ```
Returns True if the card is futureshifted A list of games that this card print is available in.
Returns: Returns:
boolean array: A list of games
``` ```
--- ---
@ -445,6 +429,22 @@ The power of the creature, if applicable
Returns: Returns:
string string
```
---
### `prices()`
```
Returns prices from modes `usd`, `usd_foil`, `eur`, and `tix`
Args:
mode (string): The prices to get
Raises:
KeyError: If the mode parameter does not match a known key
Returns:
float: The prices as a float
``` ```
--- ---
### `printed_name()` ### `printed_name()`
@ -485,6 +485,16 @@ A link to where you can begin paginating all re/prints for this card on Scryfall
Returns: Returns:
string string
```
---
### `promo()`
```
True if this card is a promotional print.
Returns:
boolean
``` ```
--- ---
### `purchase_uris()` ### `purchase_uris()`
@ -515,6 +525,16 @@ A dictionary of related websites for this card
Returns: Returns:
dict dict
```
---
### `released_at()`
```
The date this card was first released.
Returns:
string: The date in ISO format
``` ```
--- ---
### `reprint()` ### `reprint()`
@ -618,13 +638,13 @@ True if this card is featured in the story
``` ```
--- ---
### `timeshifted()` ### `tcgplayer_id()`
``` ```
Returns True if the card is timeshifted The `productId` of the card on TCGplayer.
Returns: Returns:
boolean integer: The TCGplayer id of the card
``` ```
--- ---

84
docs/scrython.cards/Id.md
View File

@ -131,32 +131,6 @@ A list of strings with all colors found in the mana cost
Returns: Returns:
list list
```
---
### `colorshifted()`
```
Returns True if the card is colorshifted
Returns:
boolean
```
---
### `currency()`
```
Returns currency from modes `usd`, `eur`, and `tix`
Args:
mode (string): The currency to get
Raises:
KeyError: If the mode parameter does not match a known key
Returns:
float: The currency as a float
``` ```
--- ---
### `digital()` ### `digital()`
@ -207,6 +181,16 @@ The year of the card frame
Returns: Returns:
string string
```
---
### `frame_effect()`
```
The card's frame effect, if any. (miracle, nyxtouched, etc.)
Returns:
string: The card's frame effect.
``` ```
--- ---
### `full_art()` ### `full_art()`
@ -219,13 +203,13 @@ Returns True if the card is considered full art
``` ```
--- ---
### `futureshifted()` ### `games()`
``` ```
Returns True if the card is futureshifted A list of games that this card print is available in.
Returns: Returns:
boolean array: A list of games
``` ```
--- ---
@ -448,6 +432,22 @@ The power of the creature, if applicable
Returns: Returns:
string string
```
---
### `prices()`
```
Returns prices from modes `usd`, `usd_foil`, `eur`, and `tix`
Args:
mode (string): The prices to get
Raises:
KeyError: If the mode parameter does not match a known key
Returns:
float: The prices as a float
``` ```
--- ---
### `printed_name()` ### `printed_name()`
@ -488,6 +488,16 @@ A link to where you can begin paginating all re/prints for this card on Scryfall
Returns: Returns:
string string
```
---
### `promo()`
```
True if this card is a promotional print.
Returns:
boolean
``` ```
--- ---
### `purchase_uris()` ### `purchase_uris()`
@ -518,6 +528,16 @@ A dictionary of related websites for this card
Returns: Returns:
dict dict
```
---
### `released_at()`
```
The date this card was first released.
Returns:
string: The date in ISO format
``` ```
--- ---
### `reprint()` ### `reprint()`
@ -621,13 +641,13 @@ True if this card is featured in the story
``` ```
--- ---
### `timeshifted()` ### `tcgplayer_id()`
``` ```
Returns True if the card is timeshifted The `productId` of the card on TCGplayer.
Returns: Returns:
boolean integer: The TCGplayer id of the card
``` ```
--- ---

84
docs/scrython.cards/Mtgo.md
View File

@ -131,32 +131,6 @@ A list of strings with all colors found in the mana cost
Returns: Returns:
list list
```
---
### `colorshifted()`
```
Returns True if the card is colorshifted
Returns:
boolean
```
---
### `currency()`
```
Returns currency from modes `usd`, `eur`, and `tix`
Args:
mode (string): The currency to get
Raises:
KeyError: If the mode parameter does not match a known key
Returns:
float: The currency as a float
``` ```
--- ---
### `digital()` ### `digital()`
@ -207,6 +181,16 @@ The year of the card frame
Returns: Returns:
string string
```
---
### `frame_effect()`
```
The card's frame effect, if any. (miracle, nyxtouched, etc.)
Returns:
string: The card's frame effect.
``` ```
--- ---
### `full_art()` ### `full_art()`
@ -219,13 +203,13 @@ Returns True if the card is considered full art
``` ```
--- ---
### `futureshifted()` ### `games()`
``` ```
Returns True if the card is futureshifted A list of games that this card print is available in.
Returns: Returns:
boolean array: A list of games
``` ```
--- ---
@ -448,6 +432,22 @@ The power of the creature, if applicable
Returns: Returns:
string string
```
---
### `prices()`
```
Returns prices from modes `usd`, `usd_foil`, `eur`, and `tix`
Args:
mode (string): The prices to get
Raises:
KeyError: If the mode parameter does not match a known key
Returns:
float: The prices as a float
``` ```
--- ---
### `printed_name()` ### `printed_name()`
@ -488,6 +488,16 @@ A link to where you can begin paginating all re/prints for this card on Scryfall
Returns: Returns:
string string
```
---
### `promo()`
```
True if this card is a promotional print.
Returns:
boolean
``` ```
--- ---
### `purchase_uris()` ### `purchase_uris()`
@ -518,6 +528,16 @@ A dictionary of related websites for this card
Returns: Returns:
dict dict
```
---
### `released_at()`
```
The date this card was first released.
Returns:
string: The date in ISO format
``` ```
--- ---
### `reprint()` ### `reprint()`
@ -621,13 +641,13 @@ True if this card is featured in the story
``` ```
--- ---
### `timeshifted()` ### `tcgplayer_id()`
``` ```
Returns True if the card is timeshifted The `productId` of the card on TCGplayer.
Returns: Returns:
boolean integer: The TCGplayer id of the card
``` ```
--- ---

84
docs/scrython.cards/Multiverse.md
View File

@ -131,32 +131,6 @@ A list of strings with all colors found in the mana cost
Returns: Returns:
list list
```
---
### `colorshifted()`
```
Returns True if the card is colorshifted
Returns:
boolean
```
---
### `currency()`
```
Returns currency from modes `usd`, `eur`, and `tix`
Args:
mode (string): The currency to get
Raises:
KeyError: If the mode parameter does not match a known key
Returns:
float: The currency as a float
``` ```
--- ---
### `digital()` ### `digital()`
@ -207,6 +181,16 @@ The year of the card frame
Returns: Returns:
string string
```
---
### `frame_effect()`
```
The card's frame effect, if any. (miracle, nyxtouched, etc.)
Returns:
string: The card's frame effect.
``` ```
--- ---
### `full_art()` ### `full_art()`
@ -219,13 +203,13 @@ Returns True if the card is considered full art
``` ```
--- ---
### `futureshifted()` ### `games()`
``` ```
Returns True if the card is futureshifted A list of games that this card print is available in.
Returns: Returns:
boolean array: A list of games
``` ```
--- ---
@ -448,6 +432,22 @@ The power of the creature, if applicable
Returns: Returns:
string string
```
---
### `prices()`
```
Returns prices from modes `usd`, `usd_foil`, `eur`, and `tix`
Args:
mode (string): The prices to get
Raises:
KeyError: If the mode parameter does not match a known key
Returns:
float: The prices as a float
``` ```
--- ---
### `printed_name()` ### `printed_name()`
@ -488,6 +488,16 @@ A link to where you can begin paginating all re/prints for this card on Scryfall
Returns: Returns:
string string
```
---
### `promo()`
```
True if this card is a promotional print.
Returns:
boolean
``` ```
--- ---
### `purchase_uris()` ### `purchase_uris()`
@ -518,6 +528,16 @@ A dictionary of related websites for this card
Returns: Returns:
dict dict
```
---
### `released_at()`
```
The date this card was first released.
Returns:
string: The date in ISO format
``` ```
--- ---
### `reprint()` ### `reprint()`
@ -621,13 +641,13 @@ True if this card is featured in the story
``` ```
--- ---
### `timeshifted()` ### `tcgplayer_id()`
``` ```
Returns True if the card is timeshifted The `productId` of the card on TCGplayer.
Returns: Returns:
boolean integer: The TCGplayer id of the card
``` ```
--- ---

84
docs/scrython.cards/Named.md
View File

@ -133,32 +133,6 @@ A list of strings with all colors found in the mana cost
Returns: Returns:
list list
```
---
### `colorshifted()`
```
Returns True if the card is colorshifted
Returns:
boolean
```
---
### `currency()`
```
Returns currency from modes `usd`, `eur`, and `tix`
Args:
mode (string): The currency to get
Raises:
KeyError: If the mode parameter does not match a known key
Returns:
float: The currency as a float
``` ```
--- ---
### `digital()` ### `digital()`
@ -209,6 +183,16 @@ The year of the card frame
Returns: Returns:
string string
```
---
### `frame_effect()`
```
The card's frame effect, if any. (miracle, nyxtouched, etc.)
Returns:
string: The card's frame effect.
``` ```
--- ---
### `full_art()` ### `full_art()`
@ -221,13 +205,13 @@ Returns True if the card is considered full art
``` ```
--- ---
### `futureshifted()` ### `games()`
``` ```
Returns True if the card is futureshifted A list of games that this card print is available in.
Returns: Returns:
boolean array: A list of games
``` ```
--- ---
@ -450,6 +434,22 @@ The power of the creature, if applicable
Returns: Returns:
string string
```
---
### `prices()`
```
Returns prices from modes `usd`, `usd_foil`, `eur`, and `tix`
Args:
mode (string): The prices to get
Raises:
KeyError: If the mode parameter does not match a known key
Returns:
float: The prices as a float
``` ```
--- ---
### `printed_name()` ### `printed_name()`
@ -490,6 +490,16 @@ A link to where you can begin paginating all re/prints for this card on Scryfall
Returns: Returns:
string string
```
---
### `promo()`
```
True if this card is a promotional print.
Returns:
boolean
``` ```
--- ---
### `purchase_uris()` ### `purchase_uris()`
@ -520,6 +530,16 @@ A dictionary of related websites for this card
Returns: Returns:
dict dict
```
---
### `released_at()`
```
The date this card was first released.
Returns:
string: The date in ISO format
``` ```
--- ---
### `reprint()` ### `reprint()`
@ -623,13 +643,13 @@ True if this card is featured in the story
``` ```
--- ---
### `timeshifted()` ### `tcgplayer_id()`
``` ```
Returns True if the card is timeshifted The `productId` of the card on TCGplayer.
Returns: Returns:
boolean integer: The TCGplayer id of the card
``` ```
--- ---

84
docs/scrython.cards/Random.md
View File

@ -129,32 +129,6 @@ A list of strings with all colors found in the mana cost
Returns: Returns:
list list
```
---
### `colorshifted()`
```
Returns True if the card is colorshifted
Returns:
boolean
```
---
### `currency()`
```
Returns currency from modes `usd`, `eur`, and `tix`
Args:
mode (string): The currency to get
Raises:
KeyError: If the mode parameter does not match a known key
Returns:
float: The currency as a float
``` ```
--- ---
### `digital()` ### `digital()`
@ -205,6 +179,16 @@ The year of the card frame
Returns: Returns:
string string
```
---
### `frame_effect()`
```
The card's frame effect, if any. (miracle, nyxtouched, etc.)
Returns:
string: The card's frame effect.
``` ```
--- ---
### `full_art()` ### `full_art()`
@ -217,13 +201,13 @@ Returns True if the card is considered full art
``` ```
--- ---
### `futureshifted()` ### `games()`
``` ```
Returns True if the card is futureshifted A list of games that this card print is available in.
Returns: Returns:
boolean array: A list of games
``` ```
--- ---
@ -446,6 +430,22 @@ The power of the creature, if applicable
Returns: Returns:
string string
```
---
### `prices()`
```
Returns prices from modes `usd`, `usd_foil`, `eur`, and `tix`
Args:
mode (string): The prices to get
Raises:
KeyError: If the mode parameter does not match a known key
Returns:
float: The prices as a float
``` ```
--- ---
### `printed_name()` ### `printed_name()`
@ -486,6 +486,16 @@ A link to where you can begin paginating all re/prints for this card on Scryfall
Returns: Returns:
string string
```
---
### `promo()`
```
True if this card is a promotional print.
Returns:
boolean
``` ```
--- ---
### `purchase_uris()` ### `purchase_uris()`
@ -516,6 +526,16 @@ A dictionary of related websites for this card
Returns: Returns:
dict dict
```
---
### `released_at()`
```
The date this card was first released.
Returns:
string: The date in ISO format
``` ```
--- ---
### `reprint()` ### `reprint()`
@ -619,13 +639,13 @@ True if this card is featured in the story
``` ```
--- ---
### `timeshifted()` ### `tcgplayer_id()`
``` ```
Returns True if the card is timeshifted The `productId` of the card on TCGplayer.
Returns: Returns:
boolean integer: The TCGplayer id of the card
``` ```
--- ---