Struct BuiltCombatSystem 

pub struct BuiltCombatSystem {
    pub state: CombatState,
    pub rotation: RotationEngine,
    pub buffer: DenseBuffer,
    pub names: Vec<Box<str>>,
}

Output of a successful crate::CombatSystemBuilder::build call.

Fields

state: CombatState

rotation: RotationEngine

buffer: DenseBuffer

names: Vec<Box<str>>

Implementations

impl BuiltCombatSystem

pub fn builder(stats: CombatStats) -> CombatSystemBuilder

Start a combat-system definition for the supplied base stats.

pub fn set_pet_action_bar( &mut self, npc_id: u32, action_bar: PetActionBar, ) -> bool

Attach an action bar to the persistent pet identified by its creature id.

pub fn disable_spell(&mut self, spell_id: u32)

pub fn patch_spell( &mut self, spell: LocalSpellIdx, patch: impl FnOnce(&mut SpellData), ) -> bool

Apply a build-time spell patch and atomically refresh its buffer projections.

pub fn patch_aura( &mut self, aura: LocalAuraIdx, patch: impl FnOnce(&mut AuraData), ) -> bool

Apply a build-time aura patch to the authoritative definition.

pub fn register_aura( &mut self, name: impl Into<Box<str>>, aura: AuraData, ) -> Result<LocalAuraIdx, EngineError>

Register an aura added after the declarative combat system has been built.

This synchronizes the name table, definition, spell-id index, and identity index. Player auras also receive their persistent buffer slot immediately.

Errors

Returns an error when the runtime aura registry exceeds its local-index capacity.

pub fn register_impact_proc(&mut self, proc: ImpactProc)

Registers a post-build impact proc.

pub fn register_landed_impact_proc(&mut self, proc: LandedImpactProc)

Registers a post-build landed-impact proc.

pub fn register_accumulating_impact_proc( &mut self, proc: AccumulatingImpactProc, )

Registers a post-build accumulating impact proc.

pub fn register_resource_gain_proc(&mut self, proc: ResourceGainProc)

Registers a post-build resource-gain proc.

pub fn register_rppm_tracker( &mut self, tracker: RppmTracker, ) -> Result<LocalRppmIdx, EngineError>

Registers a post-build RPPM tracker.

Errors

Returns an error when the local tracker-index capacity is exhausted.

pub fn register_weapon_enchant_binding( &mut self, binding: WeaponEnchantBinding, tracker: RppmTracker, ) -> Result<bool, EngineError>

Register one equipped weapon-enchant source and its shared RPPM tracker.

Duplicate enchantment IDs return false; the first binding installs the impact dispatcher.

Errors

Returns an error when the local tracker-index capacity is exhausted.

pub fn register_threshold_tracker( &mut self, tracker: ThresholdTracker, ) -> Result<LocalThresholdIdx, EngineError>

Registers a post-build accumulated-threshold tracker.

Errors

Returns an error when the local tracker-index capacity is exhausted.

pub fn push_precombat_aura(&mut self, aura: LocalAuraIdx)

Appends an aura to the precombat application set.

pub fn set_precombat_aura(&mut self, aura: LocalAuraIdx, enabled: bool)

Include or exclude an aura from the precombat application set.

pub fn remove_precombat_aura(&mut self, aura: LocalAuraIdx)

Removes an aura from every precombat talent projection.

pub fn register_player_cast_hook(&mut self, hook: CastHookFn)

Registers a hook fired after every player cast.

pub fn aura(&self, aura: LocalAuraIdx) -> Option<&AuraData>

Returns a registered aura definition.

pub fn rppm_tracker(&self, tracker: LocalRppmIdx) -> Option<&RppmTracker>

Returns a registered RPPM tracker.

pub fn impact_proc(&self, index: usize) -> Option<&ImpactProc>

Returns a registered impact proc.

pub fn impact_proc_count(&self) -> usize

Returns the number of registered impact procs.

pub fn impact_effect_proc(&self, index: usize) -> Option<&ImpactEffectProc>

Returns a registered lowered impact-effect proc.

pub fn impact_effect_proc_count(&self) -> usize

Returns the number of registered lowered impact-effect procs.

pub fn spell_effects(&self) -> &[SpellEffectData]

Returns the lowered spell-effect program arena for read-only inspection.

pub fn talent_rank(&self, spell_id: u32) -> Option<u8>

Returns the selected rank of a talent spell.

pub fn rppm_tracker_count(&self) -> usize

Returns the number of registered RPPM trackers.

pub fn player_cast_hook_count(&self) -> usize

Returns the number of registered player-cast hooks.

pub fn spell_count(&self) -> usize

Returns the number of registered spells.

pub fn first_auto_attack(&self) -> Option<&AutoAttackData>

Returns the first auto-attack definition.

pub fn patch_auto_attacks(&mut self, patch: impl FnOnce(&mut [AutoAttackData]))

Applies a build-time patch to the registered auto-attack definitions.

pub fn register_system_rppm_from_data( &mut self, driver_spell_id: u32, ) -> Result<LocalRppmIdx, EngineError>

Register a system-level RPPM source from its DBC driver spell.

The definition and driver lookup are committed together. Re-registering the same driver is idempotent and returns its existing local index.

Errors

Returns a typed spec-construction error when the driver has no finite positive RPPM rate. It also errors when the local tracker-index capacity is exhausted.

pub fn patch_base_stats(&mut self, patch: impl FnOnce(&mut BaseStats))

Apply a build-time base-stat patch and refresh the primary resource projection.

pub fn base_combat_stats(&self) -> &CombatStats

Return the resolved baseline combat stats used by post-build content registration.

pub fn set_aura_effect(&mut self, aura: LocalAuraIdx, effect: BuffEffect)

Appends a runtime effect to an already-built aura.

Panics

Panics in debug builds if aura is not registered, or in all builds if its fixed-capacity effect list is full.

pub fn mask_aura_dbc_effect( &mut self, aura: LocalAuraIdx, source_spell_id: u32, effect_index: u8, ) -> usize

Removes the rows an aura derived from one DBC spell effect, returning how many were cleared.

The shared resolution consumes every modifier effect a live aura’s spell declares. Some are scripted in game to apply only under a talent, or to be replaced by a different effect when one is picked, which is what SimC spells out per spec with register_passive_effect_mask. Content masks the effect here and then wires whatever its talent state calls for; leaving both in place makes every hit take the modifier twice.

pub fn duplicate_aura_dbc_effect( &mut self, aura: LocalAuraIdx, source_spell_id: u32, effect_index: u8, ) -> usize

Duplicates rows lowered from one DBC effect while preserving their resolved payload.

Intended for modeled live-game bugs where the server applies the same modifier twice. Content identifies only the source coordinate.

pub fn register_driver_spell_modifier(&mut self, modifier: DriverSpellModifier)

Register an always-present spell modifier under its real spell/passive driver.

pub fn register_passive_driver_effect(&mut self, effect: PassiveDriverEffect)

Register an always-present player effect under its real spell/passive driver.

pub fn register_weapon_imbue( &mut self, spell_id: u32, key: &'static str, initially_active: bool, )

Register a real weapon-imbue action and initialize its persistent equipment state.

pub fn register_periodic_driver(&mut self, driver: PeriodicDriver)

Register encounter-lifetime periodic work under its real spell/passive driver.

pub(crate) fn size_scratch_buffers(&mut self)

Trait Implementations

impl Debug for BuiltCombatSystem

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

Formats the value using the given formatter.