martial_art

Vars
allow_temp_override	If TRUE, this martial art can be overridden and stored (via base) by other martial arts if deemed "temporary" via teach().
base	Used for temporary martial arts. This is a reference to the last martial art that was replaced by this one.
combo_timer	The length of time until streaks are auto-reset.
current_target	Weakref to the last mob we attacked, for determining when to reset streaks
display_combos	If TRUE, a combo meter will be displayed on the HUD for the current streak
help_verb	Path to verb to display help text for this martial art.
holder	The current mob associated with this martial art datum. Do not set directly.
id	ID of the martial art
max_streak_length	The maximum length of streaks allowed
name	Player readable name of the martial art
pacifist_style	If TRUE, this style allows you to punch people despite being a pacifist (IE: Boxing, which does no damage)
smashes_tables	If TRUE, this martial art smashes tables when performing table slams and head smashes
streak	The streak of attacks the user has performed
timerid	Timer ID for the combo reset timer.
Procs
add_to_streak	Adds the passed element to the current streak, resetting it if the target is not the same as the last target.
attempt_grab	Signal proc for COMSIG_LIVING_GRAB to hook into the grab
can_use	Checks if the passed mob can use this martial art.
disarm_act	Called when disarm-intenting on someone
fully_remove	A helper proc to remove the martial art from the passed mob fully, e ven if stored in another martial art's base.
grab_act	Called when grabbing someone
harm_act	Called when harm-intenting on someone
help_act	Called when help-intenting on someone
on_remove	Called when this martial art is removed from a mob.
on_teach	Called when this martial art is added to a mob.
remove	Removes this martial art from the passed mob AND their mind.
reset_streak	Resets the current streak.
store_martial_art	Stores the passed martial art in the base var.
teach	Teaches the passed mob this martial art.
transfer_martial_arts	Signal proc for COMSIG_MOB_MIND_TRANSFERRED_OUT_OF to pass martial arts between bodies on mind transfer By this point the martial art's holder is the old body, but the mind that owns it is in the new body
unarmed_strike	Signal proc for COMSIG_LIVING_UNARMED_ATTACK to hook into the appropriate proc
unstore_martial_art	Unstores the base var.

Var Details

var
allow_temp_override
–

If TRUE, this martial art can be overridden and stored (via base) by other martial arts if deemed "temporary" via teach().

var
base
– /datum/martial_art

Used for temporary martial arts. This is a reference to the last martial art that was replaced by this one.

var
combo_timer
–

The length of time until streaks are auto-reset.

var
current_target
– /datum/weakref

Weakref to the last mob we attacked, for determining when to reset streaks

var
display_combos
–

If TRUE, a combo meter will be displayed on the HUD for the current streak

var
help_verb
–

Path to verb to display help text for this martial art.

var
holder
– /mob/living

The current mob associated with this martial art datum. Do not set directly.

var
id
–

ID of the martial art

var
max_streak_length
–

The maximum length of streaks allowed

var
name
–

Player readable name of the martial art

var
pacifist_style
–

If TRUE, this style allows you to punch people despite being a pacifist (IE: Boxing, which does no damage)

var
smashes_tables
–

If TRUE, this martial art smashes tables when performing table slams and head smashes

var
streak
–

The streak of attacks the user has performed

var
timerid
–

Timer ID for the combo reset timer.

Proc Details

proc
add_to_streak
(element, /mob/living/defender)

Adds the passed element to the current streak, resetting it if the target is not the same as the last target.

Arguments

element - The element to add to the streak. This is some one letter string.
mob/living/defender - The mob being attacked

proc
attempt_grab
(/mob/living/source, /mob/living/grabbing)

Signal proc for COMSIG_LIVING_GRAB to hook into the grab

proc
can_use
(/mob/living/martial_artist)

Checks if the passed mob can use this martial art.

Arguments

mob/living/martial_artist - The mob to check

Returns

TRUE - The mob can use this martial art
FALSE - The mob cannot use this martial art

proc
disarm_act
(/mob/living/attacker, /mob/living/defender)

Called when disarm-intenting on someone

What is checked going into this: Adjacency, TRAIT_MARTIAL_ARTS_IMMUNE, attacker incapacitated, can_unarmed_attack, can_use

What is NOT: check_block

Arguments

mob/living/attacker - The mob attacking
mob/living/defender - The mob being attacked

Returns

MARTIAL_ATTACK_INVALID - The attack is not valid, do normal unarmed attack
MARTIAL_ATTACK_FAIL - The attack is valid, but failed. No followup attack is made.
MARTIAL_ATTACK_SUCCESS - The attack is valid, and succeeded. No followup attack is made.

proc
fully_remove
(/mob/living/maybe_holder)

A helper proc to remove the martial art from the passed mob fully, e ven if stored in another martial art's base.

Arguments

mob/living/maybe_holder - The mob to check.

Returns

TRUE - If the martial art was removed in some way
FALSE - If nothing happened

proc
grab_act
(/mob/living/attacker, /mob/living/defender)

Called when grabbing someone

What is checked going into this: Adjacency, TRAIT_MARTIAL_ARTS_IMMUNE, attacker incapacitated, can_unarmed_attack, can_use

What is NOT: check_block

Arguments

mob/living/attacker - The mob attacking
mob/living/defender - The mob being attacked

Returns

MARTIAL_ATTACK_INVALID - The attack is not valid, do normal unarmed attack
MARTIAL_ATTACK_FAIL - The attack is valid, but failed. No followup attack is made.
MARTIAL_ATTACK_SUCCESS - The attack is valid, and succeeded. No followup attack is made.

proc
harm_act
(/mob/living/attacker, /mob/living/defender)

Called when harm-intenting on someone

What is checked going into this: Adjacency, TRAIT_MARTIAL_ARTS_IMMUNE, attacker incapacitated, can_unarmed_attack, can_use

What is NOT: check_block

Arguments

mob/living/attacker - The mob attacking
mob/living/defender - The mob being attacked

Returns

MARTIAL_ATTACK_INVALID - The attack is not valid, do normal unarmed attack
MARTIAL_ATTACK_FAIL - The attack is valid, but failed. No followup attack is made.
MARTIAL_ATTACK_SUCCESS - The attack is valid, and succeeded. No followup attack is made.

proc
help_act
(/mob/living/attacker, /mob/living/defender)

Called when help-intenting on someone

What is checked going into this: Adjacency, TRAIT_MARTIAL_ARTS_IMMUNE, attacker incapacitated, can_unarmed_attack, can_use

What is NOT: check_block

Arguments

mob/living/attacker - The mob attacking
mob/living/defender - The mob being attacked

Returns

MARTIAL_ATTACK_INVALID - The attack is not valid, do normal unarmed attack
MARTIAL_ATTACK_FAIL - The attack is valid, but failed. No followup attack is made.
MARTIAL_ATTACK_SUCCESS - The attack is valid, and succeeded. No followup attack is made.

proc
on_remove
(/mob/living/remove_from)

Called when this martial art is removed from a mob.

proc
on_teach
(/mob/living/new_holder)

Called when this martial art is added to a mob.

proc
remove
(/mob/living/old_holder)

Removes this martial art from the passed mob AND their mind.

Arguments

mob/living/old_holder - The mob to remove this martial art from.

proc
reset_streak
(/mob/living/new_target, update_icon)

Resets the current streak.

Arguments

mob/living/new_target - (Optional) The mob being attacked while the reset is occuring.
update_icon - If TRUE, the combo display will be updated.

proc
store_martial_art
(/datum/martial_art/martial)

Stores the passed martial art in the base var.

proc
teach
(/mob/living/new_holder, make_temporary)

Teaches the passed mob this martial art.

Arguments

mob/living/new_holder - The mob to teach this martial art to.
make_temporary - If FALSE, this martial art will completely replace any existing martial arts. If TRUE, any existing martial art will be stored in the base variable, and will be restored when this martial art is removed. This can only occur if allow_temp_override is TRUE.

Returns

TRUE - The martial art was successfully taught.
FALSE - The mob failed to learn the martial art, for whatever reason.

proc
transfer_martial_arts
(/mob/living/old_body, /mob/living/new_body)

Signal proc for COMSIG_MOB_MIND_TRANSFERRED_OUT_OF to pass martial arts between bodies on mind transfer By this point the martial art's holder is the old body, but the mind that owns it is in the new body

proc
unarmed_strike
(/mob/living/source, /atom/attack_target, proximity, modifiers)

Signal proc for COMSIG_LIVING_UNARMED_ATTACK to hook into the appropriate proc

proc
unstore_martial_art
()

Unstores the base var.

martial_art /datum/martial_art

Vars

Procs

Var Details

var allow_temp_override –

var base – /datum/martial_art

var combo_timer –

var current_target – /datum/weakref

var display_combos –

var help_verb –

var holder – /mob/living

var id –

var max_streak_length –

var name –

var pacifist_style –

var smashes_tables –

var streak –

var timerid –

Proc Details

proc add_to_streak(element, /mob/living/defender)

proc attempt_grab(/mob/living/source, /mob/living/grabbing)

proc can_use(/mob/living/martial_artist)

proc disarm_act(/mob/living/attacker, /mob/living/defender)

proc fully_remove(/mob/living/maybe_holder)

proc grab_act(/mob/living/attacker, /mob/living/defender)

proc harm_act(/mob/living/attacker, /mob/living/defender)

proc help_act(/mob/living/attacker, /mob/living/defender)

proc on_remove(/mob/living/remove_from)

proc on_teach(/mob/living/new_holder)

proc remove(/mob/living/old_holder)

proc reset_streak(/mob/living/new_target, update_icon)

proc store_martial_art(/datum/martial_art/martial)

proc teach(/mob/living/new_holder, make_temporary)

proc transfer_martial_arts(/mob/living/old_body, /mob/living/new_body)

proc unarmed_strike(/mob/living/source, /atom/attack_target, proximity, modifiers)

proc unstore_martial_art()

martial_art
/datum/martial_art

var
allow_temp_override
–

var
base
– /datum/martial_art

var
combo_timer
–

var
current_target
– /datum/weakref

var
display_combos
–

var
help_verb
–

var
holder
– /mob/living

var
id
–

var
max_streak_length
–

var
name
–

var
pacifist_style
–

var
smashes_tables
–

var
streak
–

var
timerid
–

proc
add_to_streak
(element, /mob/living/defender)

proc
attempt_grab
(/mob/living/source, /mob/living/grabbing)

proc
can_use
(/mob/living/martial_artist)

proc
disarm_act
(/mob/living/attacker, /mob/living/defender)

proc
fully_remove
(/mob/living/maybe_holder)

proc
grab_act
(/mob/living/attacker, /mob/living/defender)

proc
harm_act
(/mob/living/attacker, /mob/living/defender)

proc
help_act
(/mob/living/attacker, /mob/living/defender)

proc
on_remove
(/mob/living/remove_from)

proc
on_teach
(/mob/living/new_holder)

proc
remove
(/mob/living/old_holder)

proc
reset_streak
(/mob/living/new_target, update_icon)

proc
store_martial_art
(/datum/martial_art/martial)

proc
teach
(/mob/living/new_holder, make_temporary)

proc
transfer_martial_arts
(/mob/living/old_body, /mob/living/new_body)

proc
unarmed_strike
(/mob/living/source, /atom/attack_target, proximity, modifiers)

proc
unstore_martial_art
()