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

/datum/progressbar

Vars

barThe progress bar visual element.
bar_locThe target where this progress bar is applied and where it is shown.
goalEffectively the number of steps the progress bar will need to do before reaching completion.
last_progressControl check to see if the progress was interrupted before reaching its goal.
listindexVariable to ensure smooth visual stacking on multiple progress bars.
userThe mob whose client sees the progress bar.
user_clientThe client seeing the progress bar.

Procs

add_prog_bar_image_to_clientAdds a smoothly-appearing progress bar image to the player's screen.
clean_user_clientRemoves the progress bar image from the user_client and nulls the variable, if it exists.
end_progressCalled on progress end, be it successful or a failure. Wraps up things to delete the datum and bar.
on_user_deleteCalled right before the user's Destroy()
on_user_loginCalled by user's Login(), it transfers the progress bar image to the new client.
updateUpdates the progress bar image visually.

Var Details

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.

user

The mob whose client sees the progress bar.

user_client

The client seeing the progress bar.

Proc Details

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.