progressbar

Vars
bar	The progress bar visual element.
bar_loc	The target where this progress bar is applied and where it is shown.
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.
location_type	The type of our last value for bar_loc, for debugging
offset_y	Where to draw the progress bar above the icon
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.
dump_harddel_info	Progress bars are very generic, and what hangs a ref to them depends heavily on the context in which they're used So let's make hunting harddels easier yeah?
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
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
location_type
–

The type of our last value for bar_loc, for debugging

var
offset_y
–

Where to draw the progress bar above the icon

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.

↑
dump_harddel_info
()

Progress bars are very generic, and what hangs a ref to them depends heavily on the context in which they're used So let's make hunting harddels easier yeah?

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.

progressbar /datum/progressbar

Vars

Procs

Var Details

var bar – /image

var bar_loc – /atom

var goal –

var last_progress –

var listindex –

var location_type –

var offset_y –

var user – /mob

var user_client – /client