mirror of
https://github.com/Steffo99/patched-porobot.git
synced 2024-12-23 01:54:22 +00:00
Improve more docs
TODO: Fix super:: things
This commit is contained in:
parent
a7e0c8f1c5
commit
1ea725de02
6 changed files with 12 additions and 12 deletions
|
@ -1,6 +1,6 @@
|
||||||
//! Module defining [CardArt].
|
//! Module defining [CardArt].
|
||||||
|
|
||||||
/// An art asset associated with a [Card].
|
/// An art asset associated with a [super::Card].
|
||||||
#[derive(Clone, Debug, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
|
#[derive(Clone, Debug, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
|
||||||
pub struct CardArt {
|
pub struct CardArt {
|
||||||
/// URL to the `.png` image of the rendered card.
|
/// URL to the `.png` image of the rendered card.
|
||||||
|
|
|
@ -53,7 +53,7 @@ pub struct Card {
|
||||||
///
|
///
|
||||||
/// Should always contain at least an element; may sometimes contain two or more.
|
/// Should always contain at least an element; may sometimes contain two or more.
|
||||||
///
|
///
|
||||||
/// To quickly access the first element, use [main_art].
|
/// To quickly access the first element, use [Card::main_art].
|
||||||
#[serde(rename = "assets")]
|
#[serde(rename = "assets")]
|
||||||
pub art: Vec<CardArt>,
|
pub art: Vec<CardArt>,
|
||||||
|
|
||||||
|
@ -96,12 +96,12 @@ pub struct Card {
|
||||||
/// If the card has no level up text, contains an empty string.
|
/// If the card has no level up text, contains an empty string.
|
||||||
pub levelup_description_raw: String,
|
pub levelup_description_raw: String,
|
||||||
|
|
||||||
/// [Vec] with [code]s of other cards associated with this one.
|
/// [Vec] with [Card::code]s of other cards associated with this one.
|
||||||
///
|
///
|
||||||
/// To access references to the cards themselves, use [associated_cards].
|
/// To access references to the cards themselves, use [Card::associated_cards].
|
||||||
#[serde(rename = "associatedCardRefs")]
|
#[serde(rename = "associatedCardRefs")]
|
||||||
pub associated_card_codes: Vec<String>,
|
pub associated_card_codes: Vec<String>,
|
||||||
/// [Vec] with [name]s of other cards associated with this one.
|
/// [Vec] with [Card::name]s of other cards associated with this one.
|
||||||
///
|
///
|
||||||
/// Sometimes, it may be missing some references.
|
/// Sometimes, it may be missing some references.
|
||||||
#[deprecated = "Only for re-serialization purposes, use associated_card_codes instead!"]
|
#[deprecated = "Only for re-serialization purposes, use associated_card_codes instead!"]
|
||||||
|
|
|
@ -11,7 +11,7 @@ pub enum CardKeyword {
|
||||||
/// > Inflicts damage beyond what would kill the target(s) to the enemy Nexus.
|
/// > Inflicts damage beyond what would kill the target(s) to the enemy Nexus.
|
||||||
SpellOverwhelm,
|
SpellOverwhelm,
|
||||||
|
|
||||||
/// [SpellSpeed::Burst].
|
/// [super::SpellSpeed::Burst].
|
||||||
///
|
///
|
||||||
/// > Can be played whenever you may act. Happens instantly and allows you to continue to play other cards.
|
/// > Can be played whenever you may act. Happens instantly and allows you to continue to play other cards.
|
||||||
Burst,
|
Burst,
|
||||||
|
@ -27,7 +27,7 @@ pub enum CardKeyword {
|
||||||
#[serde(rename = "PlaySkillMark")]
|
#[serde(rename = "PlaySkillMark")]
|
||||||
OnPlay,
|
OnPlay,
|
||||||
|
|
||||||
/// [CardType::Landmark].
|
/// [super::CardType::Landmark].
|
||||||
///
|
///
|
||||||
/// > Landmarks take up a space on the board. They can't attack, block, or take damage.
|
/// > Landmarks take up a space on the board. They can't attack, block, or take damage.
|
||||||
#[serde(rename = "LandmarkVisualOnly")]
|
#[serde(rename = "LandmarkVisualOnly")]
|
||||||
|
@ -57,7 +57,7 @@ pub enum CardKeyword {
|
||||||
|
|
||||||
/// Focus.
|
/// Focus.
|
||||||
///
|
///
|
||||||
/// Used to disambiguate between Burst and Focus with [SpellSpeed::Burst].
|
/// Used to disambiguate between Burst and Focus with [super::SpellSpeed::Burst].
|
||||||
///
|
///
|
||||||
/// > Can be played outside combat or when no other spells or skills are pending. Happens instantly and allows you to continue to play other cards.
|
/// > Can be played outside combat or when no other spells or skills are pending. Happens instantly and allows you to continue to play other cards.
|
||||||
Focus,
|
Focus,
|
||||||
|
@ -99,7 +99,7 @@ pub enum CardKeyword {
|
||||||
/// ???
|
/// ???
|
||||||
BandleCity,
|
BandleCity,
|
||||||
|
|
||||||
/// [SpellSpeed::Fast].
|
/// [super::SpellSpeed::Fast].
|
||||||
///
|
///
|
||||||
/// > Can be played whenever you may act. Happens after your opponent has a chance to react.
|
/// > Can be played whenever you may act. Happens after your opponent has a chance to react.
|
||||||
Fast,
|
Fast,
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
//! Module defining [CardRarity].
|
//! Module defining [CardRarity].
|
||||||
|
|
||||||
/// A possible card rarity.
|
/// A possible [super::Card] rarity.
|
||||||
#[derive(Clone, Debug, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
|
#[derive(Clone, Debug, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
|
||||||
pub enum CardRarity {
|
pub enum CardRarity {
|
||||||
/// The card has no rarity, as it probably is not collectible.
|
/// The card has no rarity, as it probably is not collectible.
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
//! Module defining [CardRegion].
|
//! Module defining [CardRegion].
|
||||||
|
|
||||||
/// A region to which cards can belong to.
|
/// A region to which [super::Card]s can belong to.
|
||||||
///
|
///
|
||||||
/// Since more regions might be added in the future, especially Origin ones, this enum is [non_exaustive](https://doc.rust-lang.org/reference/attributes/type_system.html#the-non_exhaustive-attribute).
|
/// Since more regions might be added in the future, especially Origin ones, this enum is [non_exaustive](https://doc.rust-lang.org/reference/attributes/type_system.html#the-non_exhaustive-attribute).
|
||||||
#[non_exhaustive]
|
#[non_exhaustive]
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
//! Module defining [CardSet].
|
//! Module defining [CardSet].
|
||||||
|
|
||||||
/// The release set a [Card] may belong to.
|
/// The release set a [super::Card] may belong to.
|
||||||
///
|
///
|
||||||
/// Since more sets will definitely be added in the future, this enum is [non_exaustive](https://doc.rust-lang.org/reference/attributes/type_system.html#the-non_exhaustive-attribute).
|
/// Since more sets will definitely be added in the future, this enum is [non_exaustive](https://doc.rust-lang.org/reference/attributes/type_system.html#the-non_exhaustive-attribute).
|
||||||
#[non_exhaustive]
|
#[non_exhaustive]
|
||||||
|
|
Loading…
Reference in a new issue