The Samurai (Python) class

class samurai.Samurai(base_gcd=2.4, kenki_mastery=0, kenki_gauge=0)[source]

Far across the rolling waves, towards the rising sun, there lies the island nation of Hingashi.

In the distant past, the realm’s great lords vied for supremacy over its sea-girt confines in a long and bloody conflict. And taking to battle in their lieges’ names were noble swordsmen whose art was forged in the crucible of war: the samurai.

Eventually, the nation was unified under one banner, and these warriors came to wield their katana not upon fields as part of an army, but upon streets as protectors of the peace.

But as a neglected blade grows dull with rust, so too do men forget their purpose. Amidst waning memories of the old ways, a determined few hold fast to their convictions, hands by katana grips, awaiting the moment for steel to sing.

ageha(n_targets=1)[source]

lvl 10

Recast: 60s

Delivers an attack with a potency of 250.

Additional Effect: Increases Kenki Gauge by 10

If target’s HP is 20% or less and killing blow is dealt, Kenki Gauge will increase by 20.

Only available if target’s HP is 20% or less

enpi(n_targets=1)[source]

lvl 15

Delivers a ranged attack with a potency of 100.

Yaten Bonus Potency: 300

Additional Effect: Increases Kenki Gauge by 10

fuga(n_targets)[source]

lvl 26

Delivers an attack with a potency of 100 to all enemies in a cone before you.

Additional Effect: Increases Kenki Gauge by 5

gekko(n_targets=1)[source]

lvl 30

Delivers an attack with a potency of 100.

Combo Action: Jinpu

Combo Potency: 400

Rear Combo Bonus: Increases Kenki Gauge by 10

Combo Bonus: Grants Getsu

hagakure(n_targets=1)[source]

lvl 68

Recast: 40s

Converts Setsu, Getsu, and Ka into Kenki. Each Sen converted increases your Kenki Gauge by 20. Can only be executed if under the effect of at least one of the three statuses.

hakaze(n_targets=1)[source]

lvl 1

Delivers an attack with a potency of 150.

Additional Effect: Increases Kenki Gauge by 5

higanbana(n_targets=1)[source]

Delivers an attack with a potency of 240.

Additional Effect: Damage over time

Potency: 35

Duration: 60s

higanbana_dot(n_targets=1)[source]

DoT component of Higanbana.

hissatsu_guren(n_targets)[source]

lvl 70

Recast: 120s

Delivers an attack to all enemies in a straight line before you with a potency of 800 for the first enemy, 25% less for the second, and 50% less for all remaining enemies.

Kenki Gauge Cost: 50

hissatsu_gyoten(n_targets=1)[source]

lvl 54

Recast: 10s

Rushes target and delivers an attack with a potency of 100.

Kenki Gauge Cost: 10

Cannot be executed while bound.

hissatsu_kaiten(n_targets=1)[source]

lvl 52

Recast: 5s

Increases potency of next weaponskill by 50%.

Duration: 10s

Kenki Gauge Cost: 20

hissatsu_kyuten(n_targets)[source]

lvl 64

Recast: 1s

Delivers an attack with a potency of 150 to all nearby enemies.

Kenki Gauge Cost: 25

hissatsu_seigan(n_targets=1)[source]

lvl 66

Delivers an attack with a potency of 200.

Kenki Gauge Cost: 15

Can only be executed while under the effect of Open Eyes.

Shares a recast timer with Merciful Eyes.

hissatsu_shinten(n_targets=1)[source]

lvl 62

Recast: 1s

Delivers an attack with a potency of 300.

Kenki Gauge Cost: 25

hissatsu_yaten(n_targets=1)[source]

lvl 56

Recast: 10s

Delivers an attack with a potency of 100.

Additional Effect: 10-yalm backstep

Additional Effect: Grants Enhanced Enpi

Kenki Gauge Cost: 10

Cannot be executed while bound.

inc_kenki_gauge(inc_amt)[source]

Changes the Kenki gauge amount by inc_amt.

jinpu(n_targets=1)[source]

lvl 4

Delivers an attack with a potency of 100.

Combo Action: Hakaze

Combo Potency: 280

Combo Bonus: Increases damage dealt by 15%

Duration: 30s

Combo Bonus: Increases Kenki Gauge by 5

kasha(n_targets=1)[source]

lvl 40

Delivers an attack with a potency of 100.

Combo Action: Shifu

Combo Potency: 400

Side Combo Bonus: Increases Kenki Gauge by 10

Combo Bonus: Grants Ka

mangetsu(n_targets)[source]

lvl 35

Delivers an attack with a potency of 100 to all nearby enemies.

Combo Action: Fuga

Combo Potency: 200 for the first enemy, 10% less for the second, 20% less for the third, 30% less for the fourth, 40% less for the fifth, and 50% less for all remaining enemies

Combo Bonus: Increases Kenki Gauge by 10

Combo Bonus: Grants Getsu

meditate()[source]

lvl 60

Recast: 60s

Gradually increases your Kenki Gauge.

Duration: 15s

Kenki Gauge not affected when used outside battle.

Cancels auto-attack upon execution.

meikyo_shisui(n_targets=1)[source]

lvl 50

Recast: 80s

Execute up to 3 combos without meeting combo prerequisites.

Duration: 10s

meikyo_shisui_active()[source]

The Meikyo Shisui buff allows combo bonuses without executing combos for up to three weaponskills.

merciful_eyes()[source]

lvl 58

Recast: 1s

Instantly restores own HP.

Cure Potency: 500

Cure potency varies with current attack power.

Can only be executed while under the effect of Open Eyes.

Shares a recast timer with Starry Eyes.

midare_setsugekka(n_targets=1)[source]

Delivers an attack with a potency of 720.

oka(n_targets)[source]

lvl 45

Delivers an attack with a potency of 100 to all nearby enemies.

Combo Action: Fuga

Combo Potency: 200 for the first enemy, 10% less for the second, 20% less for the third, 30% less for the fourth, 40% less for the fifth, and 50% less for all remaining enemies

Combo Bonus: Increases Kenki Gauge by 10

Combo Bonus: Grants Ka

parse_rotation(rotation, n_targets=1)[source]

Creates a dataframe describing the given rotation.

Parameters:
  • rotation – A list of tuples describing each GCD with strings. Each tuple takes the format (weaponskill, ability). If no ability is used, a 1-tuple may be supplied: (‘weaponskill).
  • n_targets – Number of targets available in the encounter. Defaults to 1.
Returns:

df: A Pandas DataFrame object describing the rotation

Returns:

average_potency: The average potency per GCD of the rotation

Returns:

pps: The average potency per second of the rotation

potency_mod_update()[source]

Method to update the potency modifier when weaponskills are used.

shifu(n_targets=1)[source]

lvl 18

Delivers an attack with a potency of 100.

Combo Action: Hakaze

Combo Potency: 280

Combo Bonus: Reduces weaponskill cast time and recast time, spell cast time and recast time, and auto-attack delay by 10%

Duration: 30s

Combo Bonus: Increases Kenki Gauge by 5

tenka_goken(n_targets)[source]

Delivers an attack to all nearby enemies with a potency of 360 for the first enemy, 10% less for the second, 20% less for the third, 30% less for the fourth, 40% less for the fifth, and 50% less for all remaining enemies.

third_eye()[source]

lvl 6

Recast: 15s

Grants the Open Eyes status, reducing the amount of damage taken by the next attack by 20%.

Duration: 3s

yukikaze(n_targets=1)[source]

lvl 50

Delivers an attack with a potency of 100.

Combo Action: Hakaze

Combo Potency: 340

Combo Bonus: Reduces target’s slashing resistance by 10%

Duration: 30s

Combo Bonus: Increases Kenki Gauge by 10

Combo Bonus: Grants Setsu

applied_higanbana

Number of targets afflicted with the Higanbana DoT.

applied_yukikaze

If the slashing resistance down debuff from Yukikaze is applied.

base_gcd

The base GCD length in seconds.

combo_act_gekko

If the Gekko combo bonus is applicable.

combo_act_jinpu

If the Jinpu combo bonus is available.

combo_act_kasha

If the Kasha combo bonus is applicable.

combo_act_mangetsu

If the Mangetsu combo bonus is applicable.

combo_act_oka

If the Oka combo bonus is available.

combo_act_shifu

If the Shifu combo bonus is available.

combo_act_yukikaze

If the Yukikaze combo bonus is available.

current_gcd

The current GCD length in seconds.

enhanced_enpi

If the Enhanced Enpi status is active.

has_getsu

If the Getsu Sen is opened.

has_hissatsu_kaiten

If the Hissatsu: Kaiten buff is active.

has_jinpu

If the Jinpu buff is active.

has_ka

If the Ka Sen is opened.

has_meikyo_shisui

If the Meikyo Shisui buff is active.

has_setsu

If the Setsu Sen is opened.

has_shifu

If the Shifu buff is active.

kenki_gauge

The current Kenki gauge reading.

kenki_mastery

Kenki Mastery trait. 0 if none, 1 if I, 2 if II.

open_eyes

If the Open Eyes status from Third Eye is active.

potency_mod

Potency modifier based on Jinpu buff and slashing resistance down debuff.