manabrew-engine 0.6.2

Magic: The Gathering rules engine — a Rust port of Forge
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
use forge_foundation::ZoneType;

use super::{resolve_numeric_svar, EffectContext};
use crate::ability::ability_ir::EffectIr;
use crate::card::card_damage_map::DamageTarget;
use crate::card::card_util;
use crate::parsing::amount::AmountExpr;
use crate::parsing::keys;
use crate::spellability::SpellAbility;

/// Struct form of this effect so it can participate in the
/// `SpellAbilityEffect` trait hierarchy — mirrors Java's
/// `DamageDealEffect` class extending `SpellAbilityEffect`.
#[manabrew_engine_macros::spell_effect(DamageDealEffect)]
fn resolve(ctx: &mut EffectContext, sa: &crate::spellability::SpellAbility) {
    let damage = resolve_damage_amount(ctx, sa);
    let use_damage_map = ctx.game.pending_damage_map.is_some() || sa.ir.damage_map;
    if sa.ir.damage_map {
        ctx.game.ensure_pending_damage_maps();
    }

    // For triggered abilities, resolve Defined$ for target. Some effects use
    // bare `Player` to mean "each player", so collect all defined players here
    // and fan out below instead of forcing everything through a single target.
    let target_players: Vec<_> = if let Some(target_player) = sa.target_chosen.target_player {
        vec![target_player]
    } else if let Some(defined) = sa.defined() {
        crate::ability::ability_utils::resolve_defined_players_with_sa(
            defined,
            sa,
            sa.activating_player,
            ctx.game,
        )
    } else {
        Vec::new()
    };

    // Check source card for Infect/Wither keywords
    let (source_has_infect_keyword, source_has_wither) = if let Some(src_id) = sa.source {
        let src = ctx.game.card(src_id);
        (
            src.has_infect(),
            src.has_wither()
                || crate::staticability::static_ability_wither_damage::is_wither_damage(
                    &ctx.game.cards,
                    src,
                ),
        )
    } else {
        (false, false)
    };

    // Overload: deal damage to ALL valid creatures instead of the chosen target.
    if sa.overloaded {
        let valid_tgts = sa
            .target_restrictions
            .as_ref()
            .and_then(|restrictions| restrictions.valid_tgts.first())
            .map(String::as_str)
            .unwrap_or_default();
        let valid_tgts_selector = sa
            .target_restrictions
            .as_ref()
            .map(|restrictions| &restrictions.valid_tgts_selector);
        let all_bf: Vec<crate::ids::CardId> = ctx
            .game
            .player_order
            .clone()
            .iter()
            .flat_map(|&pid| ctx.game.cards_in_zone(ZoneType::Battlefield, pid).to_vec())
            .collect();
        for cid in all_bf {
            if ctx.game.card(cid).zone != ZoneType::Battlefield {
                continue;
            }
            if !super::matches_valid_cards_for_sa(
                ctx.game,
                sa,
                ctx.game.card(cid),
                valid_tgts_selector,
                valid_tgts,
            ) {
                continue;
            }
            // Track damage source for DamagedBy trigger filters
            if let Some(src_id) = sa.source {
                if !ctx
                    .game
                    .card(cid)
                    .damage_sources_this_turn
                    .contains(&src_id)
                {
                    ctx.game.card_mut(cid).add_damage_source_this_turn(src_id);
                }
            }
            if source_has_infect_keyword || source_has_wither {
                if use_damage_map {
                    if let Some(src_id) = sa.source {
                        if let Some(map) = ctx.game.pending_damage_map.as_mut() {
                            map.put(src_id, DamageTarget::Card(cid), damage);
                        }
                    }
                } else if !crate::staticability::static_ability_cant_put_counter::any_cant_put_counter_on_card(
                    &ctx.game.cards,
                    ctx.game.card(cid),
                    &crate::card::CounterType::M1M1,
                ) {
                    crate::ability::effects::effect_context::add_counter_with_context(
                        ctx.game,
                        Some(ctx.trigger_handler),
                        Some(ctx.agents),
                        cid,
                        &crate::card::CounterType::M1M1,
                        damage,
                        crate::event::RunParams {
                            source_player: sa.source.map(|src_id| ctx.game.card(src_id).controller),
                            cause: Some(sa.clone()),
                            ..Default::default()
                        },
                        true,
                    );
                }
            } else if use_damage_map {
                if let Some(src_id) = sa.source {
                    if let Some(map) = ctx.game.pending_damage_map.as_mut() {
                        map.put(src_id, DamageTarget::Card(cid), damage);
                    }
                }
            } else {
                ctx.game
                    .deal_damage_to_card_from(cid, damage, sa.source, false);
            }
            if !use_damage_map {
                ctx.trigger_handler.run_trigger(
                    crate::trigger::TriggerType::DamageDone,
                    crate::event::RunParams {
                        damage_source: sa.source,
                        damage_target_card: Some(cid),
                        damage_amount: Some(damage),
                        is_combat_damage: Some(false),
                        ..Default::default()
                    },
                    false,
                );
            }
        }
        let _ = crate::ability::spell_ability_effect::replace_dying(ctx.game, sa);
        return;
    }

    for target_player in target_players {
        let source_has_infect = if let Some(src_id) = sa.source {
            let src = ctx.game.card(src_id);
            source_has_infect_keyword
                || crate::staticability::static_ability_infect_damage::is_infect_damage(
                    ctx.game,
                    &ctx.game.cards,
                    target_player,
                    src.controller,
                )
        } else {
            false
        };
        if source_has_infect {
            // Infect: deal damage to players as poison counters
            if use_damage_map {
                if let Some(src_id) = sa.source {
                    if let Some(map) = ctx.game.pending_damage_map.as_mut() {
                        map.put(src_id, DamageTarget::Player(target_player), damage);
                    }
                }
            } else {
                ctx.add_player_counter(
                    target_player,
                    &crate::card::CounterType::Poison,
                    damage,
                    sa,
                    crate::event::RunParams {
                        source_player: sa.source.map(|source| ctx.game.card(source).controller),
                        ..Default::default()
                    },
                );
            }
        } else if use_damage_map {
            if let Some(src_id) = sa.source {
                if let Some(map) = ctx.game.pending_damage_map.as_mut() {
                    map.put(src_id, DamageTarget::Player(target_player), damage);
                }
            }
        } else {
            let dealt =
                ctx.game
                    .deal_damage_to_player_from(target_player, damage, sa.source, false);
            ctx.game
                .record_player_damage_assignment(sa.source, Some(target_player), dealt, false);
        }

        // Record damage dealt by source for TotalDamageDoneByThisTurn SVar
        if !use_damage_map {
            if let Some(src_id) = sa.source {
                if damage > 0 {
                    ctx.game.card_mut(src_id).total_damage_done_this_turn += damage;
                    ctx.game
                        .card_mut(src_id)
                        .damage_history
                        .record_damage(damage, false);
                }
            }
        }

        // Fire DamageDone trigger
        if !use_damage_map {
            ctx.trigger_handler.run_trigger(
                crate::trigger::TriggerType::DamageDone,
                crate::event::RunParams {
                    damage_source: sa.source,
                    damage_target_player: Some(target_player),
                    damage_amount: Some(damage),
                    is_combat_damage: Some(false),
                    ..Default::default()
                },
                false,
            );
            ctx.trigger_handler.run_trigger(
                crate::trigger::TriggerType::DamageDoneOnce,
                crate::event::RunParams {
                    damage_target_player: Some(target_player),
                    damage_amount: Some(damage),
                    is_combat_damage: Some(false),
                    ..Default::default()
                },
                false,
            );
            ctx.trigger_handler.flush_waiting_triggers(ctx.game);
        }
    }
    let mut target_cards = sa.target_chosen.target_card.into_iter().collect::<Vec<_>>();
    target_cards.extend(card_util::get_radiance(ctx.game, sa).iter().copied());
    target_cards.sort_unstable_by_key(|cid| cid.0);
    target_cards.dedup();
    for target_card in target_cards {
        if ctx.game.card(target_card).zone == ZoneType::Battlefield {
            // Protection: prevents all damage from matching sources
            if let Some(src_id) = sa.source {
                if crate::staticability::static_ability_colorless_damage_source::target_is_protected_from_source(
                    &ctx.game.cards,
                    ctx.game.card(target_card),
                    ctx.game.card(src_id),
                ) {
                    return;
                }
            }

            // Track damage source for DamagedBy trigger filters
            if let Some(src_id) = sa.source {
                if !ctx
                    .game
                    .card(target_card)
                    .damage_sources_this_turn
                    .contains(&src_id)
                {
                    ctx.game
                        .card_mut(target_card)
                        .damage_sources_this_turn
                        .push(src_id);
                }
            }
            if source_has_infect_keyword || source_has_wither {
                // Infect/Wither: damage to creatures as -1/-1 counters
                if use_damage_map {
                    if let Some(src_id) = sa.source {
                        if let Some(map) = ctx.game.pending_damage_map.as_mut() {
                            map.put(src_id, DamageTarget::Card(target_card), damage);
                        }
                    }
                } else if !crate::staticability::static_ability_cant_put_counter::any_cant_put_counter_on_card(
                    &ctx.game.cards,
                    ctx.game.card(target_card),
                    &crate::card::CounterType::M1M1,
                ) {
                    crate::ability::effects::effect_context::add_counter_with_context(
                        ctx.game,
                        Some(ctx.trigger_handler),
                        Some(ctx.agents),
                        target_card,
                        &crate::card::CounterType::M1M1,
                        damage,
                        crate::event::RunParams {
                            source_player: sa.source.map(|src_id| ctx.game.card(src_id).controller),
                            cause: Some(sa.clone()),
                            ..Default::default()
                        },
                        true,
                    );
                }
            } else if use_damage_map {
                if let Some(src_id) = sa.source {
                    if let Some(map) = ctx.game.pending_damage_map.as_mut() {
                        map.put(src_id, DamageTarget::Card(target_card), damage);
                    }
                }
            } else {
                ctx.game
                    .deal_damage_to_card_from(target_card, damage, sa.source, false);
            }

            // Record damage dealt by source for TotalDamageDoneByThisTurn SVar
            if !use_damage_map {
                if let Some(src_id) = sa.source {
                    if damage > 0 {
                        ctx.game.card_mut(src_id).total_damage_done_this_turn += damage;
                        ctx.game
                            .card_mut(src_id)
                            .damage_history
                            .record_damage(damage, false);
                    }
                }
            }

            // Fire DamageDone trigger
            if !use_damage_map {
                ctx.trigger_handler.run_trigger(
                    crate::trigger::TriggerType::DamageDone,
                    crate::event::RunParams {
                        damage_source: sa.source,
                        damage_target_card: Some(target_card),
                        damage_amount: Some(damage),
                        is_combat_damage: Some(false),
                        ..Default::default()
                    },
                    false,
                );
                // Fire DamageDoneOnce batch trigger for non-map (non-combat)
                // damage.  Java fires this from CardDamageMap.triggerDamageOnce
                // which is called for ALL damage paths.  Without this, "when
                // dealt damage" triggers using DamageDoneOnce (e.g. Raptor
                // Hatchling Enrage) would never fire for spell damage.
                ctx.trigger_handler.run_trigger(
                    crate::trigger::TriggerType::DamageDoneOnce,
                    crate::event::RunParams {
                        damage_target_card: Some(target_card),
                        damage_amount: Some(damage),
                        is_combat_damage: Some(false),
                        ..Default::default()
                    },
                    false,
                );
                // Pre-match damage triggers while the creature is still on the
                // battlefield.  SBAs run after resolution and would move
                // lethally damaged creatures to the graveyard, causing their
                // Enrage triggers to fail the active-zone check.
                ctx.trigger_handler.flush_waiting_triggers(ctx.game);
            }

            if sa.ir.remember_damaged_creature {
                if let Some(src_id) = sa.source {
                    let src = ctx.game.card_mut(src_id);
                    src.add_remembered_card(target_card);
                }
            }
        }
    }

    let _ = crate::ability::spell_ability_effect::replace_dying(ctx.game, sa);
}

/// Resolve the NumDmg$ parameter, supporting both integer literals and SVar
/// references (e.g. `NumDmg$ X` where `SVar:X:ParentTargeted$CardPower`).
/// Mirrors Java's `AbilityUtils.calculateAmount(sa, "NumDmg", sa)`.
fn resolve_damage_amount(ctx: &EffectContext, sa: &SpellAbility) -> i32 {
    if let Some(EffectIr::DealDamage(ir)) = &sa.ir.effect {
        if let Some(amount) = &ir.amount {
            if let Some(value) = resolve_amount_expr(ctx, sa, amount) {
                #[cfg(debug_assertions)]
                debug_assert_eq!(
                    value,
                    resolve_damage_amount_from_params(ctx, sa),
                    "compiled DealDamage amount diverged from string params"
                );
                return value;
            }
        }
    }

    resolve_damage_amount_from_params(ctx, sa)
}

fn resolve_amount_expr(ctx: &EffectContext, sa: &SpellAbility, amount: &AmountExpr) -> Option<i32> {
    match amount {
        AmountExpr::Literal(value) => Some(*value),
        AmountExpr::X => Some(resolve_x_amount(ctx, sa)),
        AmountExpr::SVar(name) => Some(resolve_svar_amount(ctx, sa, name)),
        AmountExpr::Raw(_) => None,
    }
}

fn resolve_damage_amount_from_params(ctx: &EffectContext, sa: &SpellAbility) -> i32 {
    resolve_numeric_svar(ctx.game, sa, keys::NUM_DMG, 0)
}

fn resolve_x_amount(ctx: &EffectContext, sa: &SpellAbility) -> i32 {
    if let Some(source_id) = sa.source {
        if let Some(svar_expr) = ctx.game.card(source_id).get_s_var("X") {
            return evaluate_svar_expr(ctx, sa, svar_expr);
        }
    }
    sa.x_mana_cost_paid as i32
}

fn resolve_svar_amount(ctx: &EffectContext, sa: &SpellAbility, var_name: &str) -> i32 {
    if let Some(source_id) = sa.source {
        let svar_val = ctx
            .game
            .card(source_id)
            .get_s_var(var_name)
            .map(str::to_string);
        if let Some(expr) = svar_val {
            return evaluate_svar_expr(ctx, sa, &expr);
        }
    }

    0
}

/// Evaluate a simple SVar expression string.
/// Mirrors Java's `AbilityUtils.calculateAmount` for common SVar patterns.
fn evaluate_svar_expr(ctx: &EffectContext, sa: &SpellAbility, expr: &str) -> i32 {
    // Count$Kicked.X.Y — delegate to shared evaluator
    if expr.starts_with("Count$Kicked.") {
        return super::evaluate_svar(expr, sa);
    }
    // Count$ expressions — delegate to shared game-aware resolver
    if expr.starts_with("Count$") {
        if let Some(source_id) = sa.source {
            return crate::svar::resolve_count_svar_for_sa(
                expr,
                ctx.game,
                source_id,
                sa.activating_player,
                sa,
            );
        }
    }
    // Sacrificed$CardPower / Sacrificed$CardToughness — LKI from cost payment.
    // Used by Rite of Consumption: SVar:X:Sacrificed$CardPower
    if expr == "Sacrificed$CardPower" || expr == "Sacrificed$CardToughness" {
        if let Some(sac_id) = ctx.game.last_sacrificed_card {
            let sac_card = ctx.game.card(sac_id);
            let val = if expr.ends_with("Power") {
                sac_card
                    .lki_power
                    .unwrap_or(sac_card.base_power.unwrap_or(0))
            } else {
                sac_card
                    .lki_toughness
                    .unwrap_or(sac_card.base_toughness.unwrap_or(0))
            };
            return val;
        }
        return 0;
    }
    if expr == "TriggeredCard$CardPower" || expr == "TriggeredCard$CardToughness" {
        let trigger_value_key = if expr.ends_with("CardPower") {
            "TriggeredCardPower"
        } else {
            "TriggeredCardToughness"
        };
        if let Some(value) = crate::ability::ability_key::from_string(trigger_value_key)
            .and_then(|key| sa.get_triggering_value(key))
            .and_then(|value| value.trim().parse::<i32>().ok())
        {
            return value;
        }

        let triggered_card = sa
            .get_triggering_card(crate::ability::AbilityKey::Card)
            .or(sa.trigger_source);
        if let Some(card_id) = triggered_card {
            return if expr.ends_with("CardPower") {
                crate::lki::resolve_lki_power(ctx.game, card_id)
            } else {
                crate::lki::resolve_lki_toughness(ctx.game, card_id)
            };
        }
        return 0;
    }
    match expr {
        // X mana cost paid value
        "Count$xPaid" | "Count$XPaid" => sa.x_mana_cost_paid as i32,
        // Power / toughness of the parent SA's chosen target card.
        // Used by Ram Through: SVar:X:ParentTargeted$CardPower
        "ParentTargeted$CardPower" => ctx
            .parent_target_card
            .map(|id| ctx.game.card(id).power())
            .unwrap_or(0),
        "ParentTargeted$CardToughness" => ctx
            .parent_target_card
            .map(|id| ctx.game.card(id).toughness())
            .unwrap_or(0),
        _ => 0,
    }
}