/datum/progressbar

Vars
bar	The progress bar visual element.
bar_loc	The target where this progress bar is applied and where it is shown.
extra_checks	Extra checks for whether to stop the progress.
goal	Effectively the number of steps the progress bar will need to do before reaching completion.
last_progress	Control check to see if the progress was interrupted before reaching its goal.
listindex	Variable to ensure smooth visual stacking on multiple progress bars.
progress_ended	Whether progress has already been ended.
skill_check	Which skill this uses
skill_icon	The icon for the skill used.
user	The mob whose client sees the progress bar.
user_client	The client seeing the progress bar.
Procs
add_prog_bar_image_to_client	Adds a smoothly-appearing progress bar image to the player's screen.
clean_user_client	Removes the progress bar image from the user_client and nulls the variable, if it exists.
end_progress	Called on progress end, be it successful or a failure. Wraps up things to delete the datum and bar.
on_user_delete	Called right before the user's Destroy()
on_user_login	Called by user's Login(), it transfers the progress bar image to the new client.
update	Updates the progress bar image visually.

Var Details

var
bar
– /image

The progress bar visual element.

var
bar_loc
– /atom

The target where this progress bar is applied and where it is shown.

var
extra_checks
– /datum/callback

Extra checks for whether to stop the progress.

var
goal
–

Effectively the number of steps the progress bar will need to do before reaching completion.

var
last_progress
–

Control check to see if the progress was interrupted before reaching its goal.

var
listindex
–

Variable to ensure smooth visual stacking on multiple progress bars.

var
progress_ended
–

Whether progress has already been ended.

var
skill_check
–

Which skill this uses

var
skill_icon
– /image

The icon for the skill used.

var
user
– /mob

The mob whose client sees the progress bar.

var
user_client
– /client

The client seeing the progress bar.

Proc Details

proc
add_prog_bar_image_to_client
()

Adds a smoothly-appearing progress bar image to the player's screen.

proc
clean_user_client
(/datum/source)

Removes the progress bar image from the user_client and nulls the variable, if it exists.

proc
end_progress
()

Called on progress end, be it successful or a failure. Wraps up things to delete the datum and bar.

proc
on_user_delete
(/datum/source)

Called right before the user's Destroy()

proc
on_user_login
(/datum/source)

Called by user's Login(), it transfers the progress bar image to the new client.

proc
update
(progress)

Updates the progress bar image visually.

/datum/progressbar

Vars

Procs

Var Details

var bar – /image

var bar_loc – /atom

var extra_checks – /datum/callback

var goal –

var last_progress –

var listindex –

var progress_ended –

var skill_check –

var skill_icon – /image

var user – /mob

var user_client – /client