Skip to content

Commit

Permalink
Update autodoc comments
Browse files Browse the repository at this point in the history
  • Loading branch information
Drulikar authored May 1, 2024
1 parent 40da469 commit 6dfbc76
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions code/game/cas_manager/datums/cas_fire_envelope.dm
Original file line number Diff line number Diff line change
Expand Up @@ -241,14 +241,13 @@
/datum/cas_fire_envelope/proc/check_firemission_loc(datum/cas_signal/target_turf)
return TRUE //redefined in child class

/**
* Execute firemission.
*/
/// Step 1: Sets the stat to FIRE_MISSION_STATE_ON_TARGET and starts the sound effect for the fire mission.
/datum/cas_fire_envelope/proc/play_sound(atom/target_turf)
stat = FIRE_MISSION_STATE_ON_TARGET
change_current_loc(target_turf)
playsound(target_turf, soundeffect, vol = 70, vary = TRUE, sound_range = 50, falloff = 8)

/// Step 2, 3, 4: Warns nearby mobs of the incoming fire mission. Warning as 1 is non-precise, whereas 2 and 3 are precise.
/datum/cas_fire_envelope/proc/chat_warning(atom/target_turf, range = 10, warning_number = 1)
var/ds_identifier = "LARGE BIRD"
var/fm_identifier = "SPIT FIRE"
Expand Down Expand Up @@ -278,14 +277,17 @@
SPAN_HIGHDANGER("YOU HEAR SOMETHING GO [SPAN_UNDERLINE(relative_dir ? uppertext(("TO YOUR " + dir2text(relative_dir))) : uppertext("right above you"))]!"), SHOW_MESSAGE_AUDIBLE \
)

/// Step 5: Actually executes the fire mission updating stat to FIRE_MISSION_STATE_FIRING and then FIRE_MISSION_STATE_OFF_TARGET
/datum/cas_fire_envelope/proc/open_fire(atom/target_turf,datum/cas_fire_mission/mission,dir)
stat = FIRE_MISSION_STATE_FIRING
mission.execute_firemission(linked_console, target_turf, dir, fire_length, step_delay, src)
stat = FIRE_MISSION_STATE_OFF_TARGET

/// Step 6: Sets the fire mission stat to FIRE_MISSION_STATE_COOLDOWN
/datum/cas_fire_envelope/proc/flyoff()
stat = FIRE_MISSION_STATE_COOLDOWN

/// Step 7: Sets the fire mission stat to FIRE_MISSION_STATE_IDLE
/datum/cas_fire_envelope/proc/end_cooldown()
stat = FIRE_MISSION_STATE_IDLE

Expand Down

0 comments on commit 6dfbc76

Please sign in to comment.