python-genshin-artifact/docs/CalculatorConfig.md
luoshuijs 5f7033d331
📝 Add Documentation
Co-authored-by: Nahida <CHxCOOH@googlemail.com>
Co-authored-by: kotoriのねこ <minamiktr@outlook.com>
2023-10-24 18:42:49 +08:00

53 lines
2.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# CalculatorConfig 类说明文档
## 类定义
CalculatorConfig 是一个主要用于存放计算所需要的数据的类,给伤害计算器进行分析。它具有以下属性:
- `index`:角色信息。
- `weapon`:武器信息。
- `buffs`BUFF如角色自身的 BUFF、武器的 BUFF、圣遗物的 BUFF、元素共鸣、自定义 BUFF。
- `artifacts`:圣遗物列表。
- `artifact_config`:圣遗物效果配置,如魔女四件套的效果。
- `skill`:需要计算的技能。
- `enemy`:敌人信息。
## artifact_config
圣遗物遗器效果来源于
`genshin_artifact/mona_core/src/artifacts/effect_config.rs`
`ArtifactEffectConfig` 结构体中表示了各个圣遗物的效果配置
```rust
#[derive(Default, Debug, Clone)]
#[derive(Serialize, Deserialize)]
pub struct ArtifactEffectConfig {
pub config_archaic_petra: ConfigArchaicPetra,
pub config_berserker: ConfigRate,
pub config_blizzard_strayer: ConfigBlizzardStrayer,
pub config_bloodstained_chivalry: ConfigRate,
pub config_brave_heart: ConfigRate,
pub config_crimson_witch_of_flames: ConfigLevel,
pub config_heart_of_depth: ConfigRate,
pub config_husk_of_opulent_dreams: ConfigLevel,
pub config_instructor: ConfigRate,
pub config_lavawalker: ConfigRate,
pub config_martial_artist: ConfigRate,
pub config_noblesse_oblige: ConfigRate,
pub config_pale_flame: ConfigPaleFlame,
pub config_retracing_bolide: ConfigRate,
pub config_shimenawas_reminiscence: ConfigRate,
pub config_tenacity_of_the_millelith: ConfigRate,
pub config_thundersoother: ConfigRate,
pub config_vermillion_hereafter: ConfigVermillionHereafter,
pub config_echoes_of_an_offering: ConfigEchoesOfAnOffering,
pub config_deepwood_memories: ConfigRate,
pub config_gilded_dreams: ConfigGildedDreams,
pub config_desert_pavilion_chronicle: ConfigRate,
pub config_flower_of_paradise_lost: ConfigFlowerOfParadiseLost,
pub config_nymphs_dream: ConfigNymphsDream,
pub config_vourukashas_glow: ConfigVourukashasGlow,
pub config_marechaussee_hunter: ConfigMarechausseeHunter,
pub config_golden_troupe: ConfigRate,
}
```