BorderlessVectorTemplate¶
src.templates.normal.BorderlessVectorTemplate
¶
Bases: NicknameMod, VectorBorderlessMod, VectorMDFCMod, VectorTransformMod, VectorTemplate
Borderless template first used in the Womens Day Secret Lair, redone with vector shapes.
Source code in src\templates\normal.py
1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 | |
Attributes¶
RGB_BLACK: SolidColor
¶
RGB_WHITE: SolidColor
¶
active_layer: Union[ArtLayer, LayerSet]
¶
Union[ArtLayer, LayerSet]: Get the currently active layer in the Photoshop document.
app: PhotoshopHandler
¶
art_action: Optional[Callable]
¶
Function that is called to perform an action on the imported art.
art_action_args: Optional[dict]
¶
Args to pass to art_action.
art_frame_vertical: str
¶
art_layer: ArtLayer
¶
art_reference: ReferenceLayer
¶
artifact_color_mode: str
¶
Setting determining what elements to color for colored artifacts..
background: str
¶
background_colors: str
¶
Must be returned as color combination or layer name, e.g. WU or Artifact.
background_group = None
¶
- Mixin Methods
background_layer: Optional[ArtLayer]
¶
Borderless cards have no 'Background' layer.
background_masks: list[ArtLayer]
¶
List of layers containing masks used to blend background layers. Default: mask_layers.
basic_watermark_color: SolidColor
¶
Color to use for the Basic Land Watermark.
basic_watermark_color_map: dict
¶
Maps color values for Basic Land Watermark.
basic_watermark_fx: list[LayerEffects]
¶
Defines the layer effects used on the Basic Land Watermark.
border_color: str
¶
Use 'black' unless an alternate color and a valid border group is provided.
border_group: Optional[Union[LayerSet, ArtLayer]]
¶
Optional[Union[LayerSet, ArtLayer]]: Group, or sometimes a layer, containing the card border.
border_mask: Optional[list]
¶
Support border mask for Textless and front face Transform modifications.
border_shape: Union[LayerObjectTypes, list[LayerObjectTypes], None]
¶
Vector shape representing the card border.
color_indicator_layer: Optional[ArtLayer]
¶
Color indicator icon layer.
console: type[CONSOLE]
¶
type[CONSOLE]: Console output object used to communicate with the user.
crown_group: LayerSet
¶
Legendary Crown group, use inner group to allow textured overlays above.
crown_layer: Optional[ArtLayer]
¶
Legendary crown layer.
crown_mask: Optional[dict]
¶
Copy the pinlines mask to Legendary crown if card is Legendary.
crown_masks: list[ArtLayer]
¶
List of layers containing masks used to blend legendary crown layers. Default: mask_layers.
crown_shadow_layer: Union[ArtLayer, LayerSet, None]
¶
Legendary crown hollow shadow layer.
crown_shape: Union[LayerObjectTypes, list[LayerObjectTypes], None]
¶
Vector shape for Legendary Crown.
crown_texture_enabled: bool
¶
Returns True if Legendary crown clipping texture should be enabled.
dfc_group: Optional[LayerSet]
¶
Optional[LayerSet]: Group containing double face elements.
divider_layer: Optional[ArtLayer]
¶
Optional[ArtLayer]: Divider layer between rules text and flavor text.
doc_selection: Selection
¶
docref: Optional[Document]
¶
Optional[Document]: This template's document open in Photoshop.
drop_shadow_enabled: bool
¶
Returns True if Drop Shadow text setting is enabled.
enabled_masks: list[Union[dict, list, ArtLayer, LayerSet, None]]
¶
Masks that should be copied or enabled.
enabled_shapes: list[Union[ArtLayer, LayerSet, None]]
¶
Add Nickname shape if needed.
event: Event
¶
expansion_reference: Optional[ArtLayer]
¶
Expansion symbol reference layer
expansion_symbol_alignments: list[Dimensions]
¶
Alignments used for positioning the expansion symbol
expansion_symbol_layer: Optional[ArtLayer]
¶
Expansion symbol layer, value set during the load_expansion_symbol method.
frame_layer_methods: list[Callable]
¶
Add MDFC frame layers step.
frame_type: str
¶
Layer name associated with the holistic frame type.
front_face_colors: bool
¶
Returns True if lighter color map should be used on front face DFC cards.
hooks: list[Callable]
¶
list[Callable]: List of methods that will be called during the hooks execution step
hybrid_colored: bool
¶
Returns True if Twins and PT should be colored on Hybrid cards.
identity: str
¶
indicator_color_map: dict
¶
Maps color values for the Color Indicator.
indicator_colors: list[list[int]]
¶
list[list[int]]: Must be returned as list of RGB/CMYK color notations.
indicator_group: Optional[LayerSet]
¶
Group where Color Indicator colors will be generated.
indicator_masks: list[ArtLayer]
¶
List of layers containing masks used to build the Color Indicator.
is_art_vertical: bool
¶
is_artifact: bool
¶
is_authentic_front: bool
¶
Return True if rendering a front face DFC card with authentic lighter colors.
is_basic_land
¶
Disable basic land watermark if Textless is enabled.
is_centered: bool
¶
Conditions for rules text centering, avoid the flipside PT cutout.
is_collector_promo: bool
¶
is_colored_nickname: bool
¶
Return True if nickname plate should be colored.
is_colorless: bool
¶
is_companion: bool
¶
is_content_aware_enabled = True
¶
- Layers
is_creature: bool
¶
is_drop_shadow: bool
¶
Return True if drop shadow setting is enabled.
is_emblem: bool
¶
is_flipside_creature: bool
¶
is_front: bool
¶
is_hollow_crown: bool
¶
is_hybrid: bool
¶
is_land: bool
¶
is_legendary: bool
¶
is_mdfc: bool
¶
is_miracle: bool
¶
is_multicolor: bool
¶
Whether the card is multicolor and within the color limit range.
is_name_shifted: bool
¶
is_nickname: bool
¶
Return True if this a nickname render.
is_nyx: bool
¶
is_pt_enabled: bool
¶
Return True if a separate Power/Toughness text layer is used for this render.
is_snow: bool
¶
is_textless: bool
¶
Return True if this a textless render.
is_token: bool
¶
is_transform: bool
¶
is_type_shifted: bool
¶
is_vehicle: bool
¶
is_within_color_limit: bool
¶
land_colorshift: bool
¶
Returns True if Land cards should use the darker brown color.
legal_group: LayerSet
¶
mask_group: Optional[LayerSet]
¶
mdfc_bar_color: str
¶
Layer name for the MDFC top icon color.
mdfc_icon_color: str
¶
Layer name for the MDFC top icon color.
multicolor_pinlines: bool
¶
Returns True if Pinlines and Crown for multicolored cards should use blended colors.
multicolor_pt: bool
¶
Returns True if PT Box for multicolored cards should use the last color.
multicolor_textbox: bool
¶
Returns True if Textbox for multicolored cards should use blended colors.
multicolor_twins: bool
¶
Returns True if Twins for multicolored cards should use blended colors.
name_reference: Optional[ArtLayer]
¶
nickname_fx: ArtLayer
¶
nickname_group: Optional[LayerSet]
¶
Nickname frame element group.
nickname_shape: Optional[ReferenceLayer]
¶
Shape layer behind the original card name on the nickname frame element. Also used to position the original card name as a reference.
output_directory: Path
¶
PathL Directory to save the rendered image.
output_file_name: Path
¶
pinlines: str
¶
pinlines_color_map: dict
¶
Maps color values for the Pinlines.
pinlines_group: Optional[LayerSet]
¶
Group containing pinlines colors, textures, or other groups.
pinlines_groups: list[LayerSet]
¶
Groups where pinline colors will be generated.
pinlines_layer: Optional[ArtLayer]
¶
Pinlines (and textbox) layer.
pinlines_mask: dict
¶
Use pre-calculated frame type to find pinlines mask. This mask hides overlapping layer effects.
pinlines_masks: list[ArtLayer]
¶
List of layers containing masks used to blend Pinlines layers. Default: mask_layers.
pinlines_shape: Union[LayerObjectTypes, list[LayerObjectTypes], None]
¶
Support a variety of pinlines shapes including Transform, MDFC, Textless, Nickname, etc.
pinlines_vector_mask: Optional[dict]
¶
Enable the pinlines vector mask if card is Legendary.
post_save_methods: list[Callable]
¶
list[Callable]: Methods called after the rendered image is saved.
post_text_methods
¶
Add post-text adjustments method.
pre_render_methods: list[Callable]
¶
list[Callable]: Methods called before rendering begins.
Functions:
| Name | Description |
|---|---|
`process_layout_data` |
Processes layout data before it is used to generate the card. |
pt_group: Optional[LayerSet]
¶
PT Box group, alternative Textless option used when Expansion Symbol is disabled.
pt_layer: Optional[ArtLayer]
¶
Power and toughness box layer.
pt_masks: list[ArtLayer]
¶
List of layers containing masks used to blend PT box layers. Default: mask_layers.
pt_reference: Optional[ReferenceLayer]
¶
save_mode: Callable
¶
size: str
¶
Layer name associated with the size of the textbox.
text: list[FormattedTextLayer]
¶
List of text layer objects to execute.
text_group: Optional[LayerSet]
¶
Optional[LayerSet]: Text and icon group, contains rules text and necessary symbols.
text_layer_creator: Optional[ArtLayer]
¶
Optional[ArtLayer]: Proxy creator name text layer.
text_layer_flipside_pt: Optional[ArtLayer]
¶
Flipside power/toughness layer for front face Transform cards.
text_layer_mana: Optional[ArtLayer]
¶
Optional[ArtLayer]: Card mana cost text layer.
text_layer_mdfc_left: Optional[ArtLayer]
¶
The back face card type.
text_layer_mdfc_right: Optional[ArtLayer]
¶
The back face mana cost or land tap ability.
text_layer_methods: list[Callable]
¶
Add MDFC text layers step.
text_layer_name: Optional[ArtLayer]
¶
Optional[ArtLayer]: Card name text layer.
text_layer_nickname: Optional[ArtLayer]
¶
Alternate text layer to use for original card name when a nickname is used.
text_layer_pt: Optional[ArtLayer]
¶
Optional[ArtLayer]: Card power and toughness text layer.
text_layer_rules: Optional[ArtLayer]
¶
Card rules text layer, use pre-computed layer name.
text_layer_rules_name: str
¶
Compute the name of this layer separately, so we can use it for automatic textbox sizing.
text_layer_type: Optional[ArtLayer]
¶
Optional[ArtLayer]: Card typeline text layer.
textbox_group: Optional[LayerSet]
¶
Optional[LayerSet]: Textbox group if not a 'Textless' render.
textbox_masks: list[ArtLayer]
¶
List of layers containing masks used to blend textbox layers. Default: mask_layers.
textbox_reference: Optional[ReferenceLayer]
¶
Use size appropriate textbox reference.
textbox_shape: Union[LayerObjectTypes, list[LayerObjectTypes], None]
¶
Support a size appropriate textbox shape and Transform Front addition.
transform_icon_layer: Optional[ArtLayer]
¶
Optional[ArtLayer]: Transform icon layer.
twins: str
¶
twins_group: Optional[LayerSet]
¶
Group containing twins texture layers.
twins_layer: Optional[ArtLayer]
¶
Name and title boxes layer.
twins_masks: list[ArtLayer]
¶
List of layers containing masks used to blend background layers. Default: mask_layers.
twins_shape: Union[LayerObjectTypes, list[LayerObjectTypes], None]
¶
Separate shapes for Name and Typeline box.
type_reference: Optional[ArtLayer]
¶
otherwise fallback to the expansion symbols reference layer.
watermark_bevel_map: dict[str, int] = {BorderlessTextbox.Short: 20, BorderlessTextbox.Medium: 22, BorderlessTextbox.Normal: 25, BorderlessTextbox.Tall: 28}
¶
- Frame Layer Methods
watermark_blend_mode: BlendMode
¶
Blend mode to use on the Watermark layer.
watermark_color_map: dict
¶
Maps color values for Watermark.
watermark_colors: list[SolidColor]
¶
Colors to use for the Watermark.
watermark_fx: list[LayerEffects]
¶
Defines the layer effects to use for the Watermark.
Functions¶
add_basic_watermark_snow_effects(wm: ArtLayer)
¶
Adds optional snow effects for 'Snow' Basic Land watermarks.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
wm
|
ArtLayer
|
ArtLayer containing the Basic Land Watermark. |
required |
check_photoshop() -> None
¶
Check if Photoshop is responsive to automation.
Source code in src\templates\_core.py
collector_info() -> None
¶
Format and add the collector info at the bottom.
Source code in src\templates\_core.py
collector_info_artist_only() -> None
¶
Called to generate 'Artist Only' collector info.
Source code in src\templates\_core.py
collector_info_authentic() -> None
¶
Called to generate realistic collector info.
Source code in src\templates\_core.py
collector_info_basic() -> None
¶
Called to generate basic collector info.
Source code in src\templates\_core.py
color_border() -> None
¶
Color this card's border based on given setting.
Source code in src\templates\_core.py
create_basic_watermark() -> None
¶
Builds a basic land watermark.
Source code in src\templates\_core.py
create_blended_layer(group: LayerSet, colors: Union[None, str, list[str]] = None, masks: Optional[list[ArtLayer]] = None, **kwargs)
¶
Either enable a single frame layer or create a multicolor layer using a gradient mask.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
group
|
LayerSet
|
Group to look for the color layers within. |
required |
colors
|
None | str | list[str]
|
Color layers to look for. |
None
|
masks
|
list[ArtLayer] | None
|
Masks to use for blending the layers. |
None
|
Source code in src\templates\_core.py
create_blended_solid_color(group: LayerSet, colors: list[ColorObject], masks: Optional[list[Union[ArtLayer, LayerSet]]] = None, **kwargs) -> None
¶
Either enable a single frame layer or create a multicolor layer using a gradient mask.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
group
|
LayerSet
|
Group to look for the color layers within. |
required |
colors
|
list[ColorObject]
|
Color layers to look for. |
required |
masks
|
list[ArtLayer | LayerSet] | None
|
Masks to use for blending the layers. |
None
|
Source code in src\templates\_core.py
create_watermark() -> None
¶
Builds the watermark.
Source code in src\templates\_core.py
enable_crown() -> None
¶
Allow modifying crown texture based on setting.
Source code in src\templates\normal.py
enable_frame_layers() -> None
¶
Hook this step to optionally add color to Nickname plate.
Source code in src\templates\normal.py
enable_hollow_crown(**kwargs) -> None
¶
Enable the Hollow Crown within the Legendary Crown, only called if card is Legendary Nyx or Companion.
Source code in src\templates\_vector.py
enable_layer_masks() -> None
¶
Enable or copy required layer masks provided by enabled_masks.
Source code in src\templates\_vector.py
enable_mdfc_layers() -> None
¶
enable_mdfc_layers_back() -> None
¶
enable_mdfc_layers_front() -> None
¶
enable_shape_layers() -> None
¶
Enable required vector shape layers provided by enabled_shapes.
Source code in src\templates\_vector.py
enable_transform_layers() -> None
¶
enable_transform_layers_back() -> None
¶
enable_transform_layers_front() -> None
¶
execute() -> bool
¶
Perform actions to render the card using this template.
Notes
- Each action is wrapped in an exception check and breakpoint to cancel the thread if a cancellation signal was sent by the user.
- Never override this method!
Source code in src\templates\_core.py
1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 | |
format_nickname_text() -> None
¶
Actions taken if this is a 'Nickname' render.
Source code in src\templates\normal.py
format_text_layers() -> None
¶
Validate and execute each formatted text layer.
Source code in src\templates\_core.py
generate_layer(group: Union[ArtLayer, LayerSet], colors: Union[str, ColorObject, list[ColorObject], list[dict]], masks: Optional[list[ArtLayer]] = None, **kwargs) -> Optional[ArtLayer]
¶
Takes information about a frame layer group and routes it to the correct generation function which blends rasterized layers, blends solid color layers, or generates a solid color/gradient adjustment layer.
Notes
The result for a given 'colors' schema: - str: Enable and/or blend one or more texture layers, unless string is a hex color, in which case create a solid color adjustment layer. - list[str]: Blend multiple texture layers. - list[int]: Create a solid color adjustment layer. - list[dict]: Create a gradient adjustment layer. - list[list[int]]: Blend multiple solid color adjustment layers. - list[SolidColor]: Blend multiple solid color adjustment layers.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
group
|
ArtLayer | LayerSet
|
Layer or group containing layers. |
required |
colors
|
str | ColorObject | list[ColorObject] | list[dict]
|
Color definition for this frame layer generation. |
required |
masks
|
list[ArtLayer] | None
|
Masks used to blend this generated layer. |
None
|
Source code in src\templates\_core.py
1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 | |
get_template_route(layout, **kwargs) -> BaseTemplate
¶
Overwrite this method to reroute a template class to another class under a set of conditions. See the 'IxalanTemplate' class for an example.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
layout
|
The card layout object. |
required |
Returns:
| Type | Description |
|---|---|
BaseTemplate
|
Initialized template class object. |
Source code in src\templates\_core.py
hook_creature() -> None
¶
hook_large_mana() -> None
¶
load_artwork(art_file: Optional[str | Path] = None, art_layer: Optional[ArtLayer] = None, art_reference: Optional[ReferenceLayer] = None) -> None
¶
Loads the specified art file into the specified layer.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
art_file
|
str | Path | None
|
Optional path (as str or Path) to art file. Will use |
None
|
art_layer
|
ArtLayer | None
|
Optional |
None
|
art_reference
|
ReferenceLayer | None
|
Optional |
None
|
Source code in src\templates\_core.py
load_expansion_symbol() -> None
¶
Imports and positions the expansion symbol SVG image.
Source code in src\templates\_core.py
log(text: str, e: Optional[Exception] = None) -> None
¶
Writes a message to console if test mode isn't enabled, logs an exception if provided.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
text
|
str
|
Message to write to console. |
required |
e
|
Exception | None
|
Exception to log if provided. |
None
|
Source code in src\templates\_core.py
paste_scryfall_scan(rotate: bool = False, visible: bool = True) -> Optional[ArtLayer]
¶
Downloads the card's scryfall scan, pastes it into the document next to the active layer, and frames it to fill the given reference layer.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
rotate
|
bool
|
Will rotate the card horizontally if True, useful for Planar cards. |
False
|
visible
|
bool
|
Whether to leave the layer visible or hide it. |
True
|
Returns:
| Type | Description |
|---|---|
ArtLayer | None
|
ArtLayer if Scryfall scan was imported, otherwise None. |
Source code in src\templates\_core.py
process_layout_data() -> None
¶
Performs any required pre-processing on the provided layout data.
Source code in src\templates\_core.py
prompt_nickname_text() -> None
¶
Check if nickname text is already defined. If not, prompt the user.
Source code in src\templates\_cosmetic.py
raise_error(message: str, error: Optional[Exception] = None) -> None
¶
Raise an error on the console display.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
message
|
str
|
Message to be displayed |
required |
error
|
Exception | None
|
Exception object |
None
|
Source code in src\templates\_core.py
raise_warning(message: str, error: Exception = None) -> None
¶
Raise a warning on the console display.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
message
|
str
|
Message to be displayed. |
required |
error
|
Exception
|
Exception object. |
None
|
Source code in src\templates\_core.py
redirect_template(template_class: type[BaseTemplate], template_file: Union[str, Path], layout, **kwargs) -> BaseTemplate
¶
Reroutes template initialization to another template class and PSD file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
template_class
|
type[BaseTemplate]
|
Template class to reroute to. |
required |
template_file
|
str | Path
|
Filename of the PSD to load with this template class. |
required |
layout
|
The card layout object. |
required |
Returns:
| Type | Description |
|---|---|
BaseTemplate
|
Initialized template class object. |
Source code in src\templates\_core.py
reset() -> None
¶
Reset the document, purge the cache, end await.
rules_text_and_pt_layers() -> None
¶
Skip this step for 'Textless' renders.
Source code in src\templates\normal.py
run_tasks(funcs: list[Callable], message: str, warning: bool = False, args: Union[Iterable[Any], None] = None, kwargs: Optional[dict] = None) -> bool
¶
Run a list of functions, checking for thread cancellation and exceptions on each.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
funcs
|
list[Callable]
|
List of functions to perform. |
required |
message
|
str
|
Error message to raise if exception occurs. |
required |
warning
|
bool
|
Warn the user if True, otherwise raise error. |
False
|
args
|
Iterable[Any] | None
|
Optional arguments to pass to the func. Empty tuple if not provided. |
None
|
kwargs
|
dict | None
|
Optional keyword arguments to pass to the func. Empty dict if not provided. |
None
|
Returns:
| Type | Description |
|---|---|
bool
|
True if tasks completed, False if exception occurs or thread is cancelled. |
Source code in src\templates\_core.py
swap_font_color(color: SolidColor = None) -> None
¶
Switch the font color of each key text layer.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
color
|
SolidColor
|
SolidColor object, will use black if not provided. |
None
|
Source code in src\templates\normal.py
text_layer_fx() -> None
¶
Handles all specialized text adjustments for a variety of render settings.
Source code in src\templates\normal.py
text_layers_mdfc() -> None
¶
Adds and modifies text layers required by modal double faced cards.
Source code in src\templates\mdfc.py
text_layers_mdfc_back() -> None
¶
text_layers_mdfc_front() -> None
¶
text_layers_transform() -> None
¶
Adds and modifies text layers for transform cards.
Source code in src\templates\transform.py
text_layers_transform_back()
¶
text_layers_transform_front() -> None
¶
Switch font colors on 'Authentic' front face cards.
Source code in src\templates\normal.py
textbox_positioning() -> None
¶
Reposition various elements when textbox size isn't 'Tall' (the default).
Source code in src\templates\normal.py
textless_adjustments() -> None
¶
Actions taken if this is a 'Textless' render.
Source code in src\templates\normal.py
token_adjustments() -> None
¶
Actions taken if this is a 'Token' card.