Paradise Station 13 - Modules - TypesProc Details

tgui

Procs

close_all_uisprivate
close_uisprivate
close_user_uisprivate
get_open_uiprivate
on_closeprivate
on_logoutprivate
on_openprivate
on_transferprivate
try_update_uipublic
update_uisprivate
update_user_uisprivate

Proc Details

close_all_uis

private

Close ALL UIs Returns the number of UIs closed.

close_uis

private

Close all UIs attached to src_object. Returns the number of UIs closed.

close_user_uis

private

Close all UIs belonging to a user. Returns the number of UIs closed.

get_open_ui

private

Get an open UI given a user, src_object, and ui_key. Returns the found UI.

on_close

private

Remove a UI from the list of open UIs. Returns TRUE if removed, and FALSE if not.

on_logout

private

Handle client logout, by closing all their UIs. Returns the number of UIs closed.

on_open

private

Add a UI to the list of open UIs.

on_transfer

private

Handle clients switching mobs, by transferring their UIs. Returns TRUE if the UIs were transferred, and FALSE if not.

try_update_ui

public

Get an open UI given a user, src_object, and ui_key and try to update it with data. Returns the found UI.

update_uis

private

Update all UIs attached to src_object. Returns the number of UIs updated.

update_user_uis

private

Update all UIs belonging to a user. Returns the number of UIs updated.