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

Updated docs.

This commit is contained in:
Nanda Scott 2018-02-19 17:14:23 -05:00
parent 30d4711d2a
commit e41a6d7fa5
1 changed files with 17 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
docs/Catalog.md
View File

@ -5,30 +5,29 @@ Documentation for a catalog object. These docs will likely not be as detailed as
>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`catalog.scryfallJson`). >In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`catalog.scryfallJson`).
## Classes ## Classes
All classes accept the following parameters.
|Name|Description|
|:---:|:---:|
|`.ArtifactTypes()`|Returns all unique types of artifacts printed.|
|`.CardNames()`|Returns all unique card names printed.|
|`.CreatureTypes()`|Returns all unique creature types printed.|
|`.LandTypes()`|Returns all unique land types printed.|
|`.Loyalties()`|Returns all unique starting loyalties printed.|
|`.PlaneswalkerTypes()`|Returns all unique planeswalker types printed.|
|`.Powers()`|Returns all unique power values printed.|
|`.SpellTypes()`|Returns all unique spell types printed.|
|`.Toughnesses()`|Returns all unique toughness values printed.|
|`.Watermarks()`|Returns the name of all unique watermarks printed.|
|`.WordBanks()`|Returns all unique words ever printed on a card.|
**Parameters**
| Param |Required [y/n]| Input type | Description | | Param |Required [y/n]| Input type | Description |
| :---: | :---: | :---: |:---: | | :---: | :---: | :---: |:---: |
|format|No|String|The format to return. Defaults to JSON.| |format|No|String|The format to return. Defaults to JSON.|
|pretty|No|Boolean|Makes the returned JSON prettier. The library may not work properly with this setting.| |pretty|No|Boolean|Makes the returned JSON prettier. The library may not work properly with this setting.|
**Classes** **Attributes**
|Name|Description|
|:---:|:---:|
|`.ArtifactTypes()`|Returns all unique types of artifacts printed.
|`.CardNames()`|Returns all unique card names printed.
|`.CreatureTypes()`|Returns all unique creature types printed.
|`.LandTypes()`|Returns all unique land types printed.
|`.Loyalties()`|Returns all unique starting loyalties printed.
|`.PlaneswalkerTypes()`|Returns all unique planeswalker types printed.
|`.Powers()`|Returns all unique power values printed.
|`.SpellTypes()`|Returns all unique spell types printed.
|`.Toughnesses()`|Returns all unique toughness values printed.
|`.Watermarks()`|Returns the name of all unique watermarks printed.
|`.WordBanks()`|Returns all unique words ever printed on a card.
## Attributes
All attributes are listed assuming the following All attributes are listed assuming the following
`catalog = scrython.catalog.<Class>()` is the current usage. `catalog = scrython.catalog.<Class>()` is the current usage.