/tg/ Station 13 - Modules - TypesVar Details - Proc Details

baton

Vars

activeWhether this baton is active or not
affect_cyborgCan we stun cyborgs?
clumsy_knockdown_timeThe length of the knockdown applied to the user on clumsy_check()
cooldownDefault wait time until can stun again.
cooldown_checkUsed interally, you don't want to modify
knockdown_timeThe length of the knockdown applied to a struck living, non-cyborg mob.
log_stun_attackWhether the stun attack is logged. Only relevant for abductor batons, which have different modes.
on_stun_soundThe path of the default sound to play when we stun something.
on_stun_volumeThe volume of the above.
stamina_damageHow much stamina damage we deal on a successful hit against a living, non-cyborg mob.
stun_animationDo we animate the "hit" when stunning something?
stun_time_cyborgIf affect_cyborg is TRUE, this is how long we stun cyborgs for on a hit.

Procs

additional_effects_cyborgContains any special effects that we apply to cyborgs we stun. Does not include flashing the cyborg's screen, hardstunning them, etc.
additional_effects_non_cyborgContains any special effects that we apply to living, non-cyborg mobs we stun. Does not include applying a knockdown, dealing stamina damage, etc.
attackOk, think of baton attacks like a melee attack chain:
get_cyborg_stun_descriptionDefault message for stunning a cyborg.
get_stun_descriptionDefault message for stunning a living, non-cyborg mob.
get_unga_dunga_cyborg_stun_descriptionDefault message for trying to stun a cyborg with a baton that can't stun cyborgs.
get_wait_descriptionDescription for trying to stun when still on cooldown.

Var Details

active

Whether this baton is active or not

affect_cyborg

Can we stun cyborgs?

clumsy_knockdown_time

The length of the knockdown applied to the user on clumsy_check()

cooldown

Default wait time until can stun again.

cooldown_check

Used interally, you don't want to modify

knockdown_time

The length of the knockdown applied to a struck living, non-cyborg mob.

log_stun_attack

Whether the stun attack is logged. Only relevant for abductor batons, which have different modes.

on_stun_sound

The path of the default sound to play when we stun something.

on_stun_volume

The volume of the above.

stamina_damage

How much stamina damage we deal on a successful hit against a living, non-cyborg mob.

stun_animation

Do we animate the "hit" when stunning something?

stun_time_cyborg

If affect_cyborg is TRUE, this is how long we stun cyborgs for on a hit.

Proc Details

additional_effects_cyborg

Contains any special effects that we apply to cyborgs we stun. Does not include flashing the cyborg's screen, hardstunning them, etc.

additional_effects_non_cyborg

Contains any special effects that we apply to living, non-cyborg mobs we stun. Does not include applying a knockdown, dealing stamina damage, etc.

attack

Ok, think of baton attacks like a melee attack chain:

[/baton_attack()] comes first. It checks if the user is clumsy, if the target parried the attack and handles some messages and sounds.

[/finalize_baton_attack()] is then called. It handles logging stuff, sound effects and calls baton_effect().

[/baton_effect()] is third in the line. It knockdowns targets, along other effects called in additional_effects_cyborg() and

Last but not least [/set_batoned()], which gives the target the IWASBATONED trait with REF(user) as source and then removes it

TL;DR: [/baton_attack()] -> [/finalize_baton_attack()] -> [/baton_effect()] -> [/set_batoned()]

get_cyborg_stun_description

Default message for stunning a cyborg.

get_stun_description

Default message for stunning a living, non-cyborg mob.

get_unga_dunga_cyborg_stun_description

Default message for trying to stun a cyborg with a baton that can't stun cyborgs.

get_wait_description

Description for trying to stun when still on cooldown.