Skip to main content

ScoringTrigger

Struct ScoringTrigger 

Source
pub struct ScoringTrigger {
    pub battle_round: Option<ScoringTriggerBattleRound>,
    pub phase: Option<Phase>,
    pub player_turn: Option<PlayerTurn>,
    pub timing: Option<ScoringTriggerTiming>,
}
Expand description

When a VP award is evaluated. A bare phase is the legacy shorthand for ‘during this phase’; richer triggers add timing (the moment within a phase/turn/game), player_turn, and a battle_round window. A card’s section headers map onto these: ‘ANY BATTLE ROUND’ omits battle_round; ‘SECOND BATTLE ROUND ONWARDS’ is { min: 2 }; ‘END OF THE BATTLE’ is timing: end-of-battle.

JSON schema
{
 "description": "When a VP award is evaluated. A bare `phase` is the legacy shorthand for 'during this phase'; richer triggers add `timing` (the moment within a phase/turn/game), `player_turn`, and a `battle_round` window. A card's section headers map onto these: 'ANY BATTLE ROUND' omits `battle_round`; 'SECOND BATTLE ROUND ONWARDS' is { min: 2 }; 'END OF THE BATTLE' is timing: end-of-battle.",
 "type": "object",
 "minProperties": 1,
 "properties": {
   "battle_round": {
     "description": "Battle-round window in which the trigger is active. Absent means any battle round (1-5). 'Second battle round onwards' is { min: 2 }.",
     "type": "object",
     "minProperties": 1,
     "properties": {
       "max": {
         "type": "integer",
         "maximum": 5.0,
         "minimum": 1.0
       },
       "min": {
         "type": "integer",
         "maximum": 5.0,
         "minimum": 1.0
       }
     },
     "additionalProperties": false
   },
   "phase": {
     "description": "The phase the trigger is relative to. Required when `timing` is start-of-phase or end-of-phase; omitted for turn- or battle-level timings.",
     "$ref": "#/$defs/phase"
   },
   "player_turn": {
     "$ref": "#/$defs/player-turn"
   },
   "timing": {
     "description": "The moment the award is checked. 'End of your turn' = end-of-turn; 'End of your Command phase' = end-of-phase with phase: command; 'End of the battle' = end-of-battle.",
     "type": "string",
     "enum": [
       "start-of-turn",
       "end-of-turn",
       "start-of-phase",
       "end-of-phase",
       "end-of-battle"
     ]
   }
 },
 "additionalProperties": false
}

Fields§

§battle_round: Option<ScoringTriggerBattleRound>§phase: Option<Phase>

The phase the trigger is relative to. Required when timing is start-of-phase or end-of-phase; omitted for turn- or battle-level timings.

§player_turn: Option<PlayerTurn>§timing: Option<ScoringTriggerTiming>

The moment the award is checked. ‘End of your turn’ = end-of-turn; ‘End of your Command phase’ = end-of-phase with phase: command; ‘End of the battle’ = end-of-battle.

Trait Implementations§

Source§

impl Clone for ScoringTrigger

Source§

fn clone(&self) -> ScoringTrigger

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for ScoringTrigger

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for ScoringTrigger

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for ScoringTrigger

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for ScoringTrigger

Source§

fn eq(&self, other: &ScoringTrigger) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for ScoringTrigger

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for ScoringTrigger

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.