admins

Vars
admin_signature	Randomly generated signature used for security records authorization name.
blocked_by_2fa	Whether or not the user tried to connect, but was blocked by 2FA
bypass_2fa	Whether or not this user can bypass 2FA
cached_feedback_link	Link from the database pointing to the admin's feedback forum
tagged_datums	A lazylist of tagged datums, for quick reference with the View Tags verb
Procs
Game	Panels
add_tagged_datum	Inserts the target_datum into /datum/admins/var/tagged_datums, for later reference.
can_edit_rights_flags	Get the permissions this admin is allowed to edit on other ranks
can_place_additional_admin_ban	Checks if the admin can place an additional admin ban.
check_2fa	Returns whether or not the given client has a verified 2FA connection. The output is in the form of a list with the first index being whether or not the check was successful, the 2nd is the ID of the associated database entry if its a false result and if one can be found.
feedback_link	Returns the feedback forum thread for the admin holder's owner, as according to DB.
forceEvent	Opens up the Force Event Panel
handle_tagged_del	Get ahead of the curve with deleting
message_pda	Opens up the PDA Message Panel
modify_traits	Allow admin to add or remove traits of datum
notify_all_banned_players	Notifies all banned players about their ban and gives them a link to appeal from the config. If it was a server ban, it also kicks them.
poll_list_panel	Shows a list of all current and future polls and buttons to edit or delete them or create a new poll.
poll_management_panel	Show the options for creating a poll or editing its parameters along with its linked options.
poll_option_panel	Show the options for creating a poll option or editing its parameters.
poll_option_parse_href	Processes topic data from poll option panel.
poll_parse_href	Processes topic data from poll management panel.
rank_flags	Get the rank flags of the admin
rank_names	Get the rank name of the admin
reban	Sometimes an admin did not intend to unban a player. This proc undoes an unbanning operation by setting the unbanned_ keys in the DB back to null.
remove_tagged_datum	Attempts to remove the specified datum from /datum/admins/var/tagged_datums if it exists
verify_admin_from_local_cache	Returns true if the admin's cid/ip is verified in the local cache

Var Details

var
admin_signature
–

Randomly generated signature used for security records authorization name.

var
blocked_by_2fa
–

Whether or not the user tried to connect, but was blocked by 2FA

var
bypass_2fa
–

Whether or not this user can bypass 2FA

var
cached_feedback_link
–

Link from the database pointing to the admin's feedback forum

var
tagged_datums
– /list

A lazylist of tagged datums, for quick reference with the View Tags verb

Proc Details

proc
Game
()

Panels

proc
add_tagged_datum
(/datum/target_datum)

Inserts the target_datum into /datum/admins/var/tagged_datums, for later reference.

Arguments:

target_datum - The datum you want to create a tag for

proc
can_edit_rights_flags
()

Get the permissions this admin is allowed to edit on other ranks

proc
can_place_additional_admin_ban
(admin_ckey)

Checks if the admin can place an additional admin ban.

Returns FALSE if the query fails to execute. Returns FALSE and notifies the admin in chat if they are at their max number of admin bans already. Returns TRUE if an admin can place an additional admin ban.

Arguments:

admin_ckey - The ckey of the admin who is trying to place an admin ban.

proc
check_2fa
(/client/client)

Returns whether or not the given client has a verified 2FA connection. The output is in the form of a list with the first index being whether or not the check was successful, the 2nd is the ID of the associated database entry if its a false result and if one can be found.

proc
feedback_link
()

Returns the feedback forum thread for the admin holder's owner, as according to DB.

proc
forceEvent
()

Opens up the Force Event Panel

proc
handle_tagged_del
(/datum/source)

Get ahead of the curve with deleting

proc
message_pda
()

Opens up the PDA Message Panel

proc
modify_traits
(/datum/D)

Allow admin to add or remove traits of datum

proc
notify_all_banned_players
(banned_player_ckey, banned_player_ip, banned_player_cid, banned_player_message, banned_other_message, kick_banned_players, applies_to_admins)

Notifies all banned players about their ban and gives them a link to appeal from the config. If it was a server ban, it also kicks them.

If the banned player's ckey has a linked client on the server, it notifies them of the ban details and kicks them if it was a server ban. If there is anyone else sharing the banned player's IP or CID, it notifies them of the ban details and kicks them if it was a server ban.

Builds the ban cache for every client impacted by the ban.

Arguments:

banned_player_ckey - The ckey of the banned player.
banned_player_ip - IP address of the banned player.
banned_player_cid - CID of the banned player.
banned_player_message - The message to show to only the specifically banned player.
banned_other_message - The message to show to any other players who share the banned player's IP or CID.
kick_banned_players - TRUE if we want to kick affected players, FALSE otherwise. This should generally only be TRUE for server bans.
applies_to_admins - TRUE if this ban applies to admins and we may need to kick them, FALSE otherwise.

proc
poll_list_panel
()

Shows a list of all current and future polls and buttons to edit or delete them or create a new poll.

proc
poll_management_panel
(/datum/poll_question/poll)

Show the options for creating a poll or editing its parameters along with its linked options.

proc
poll_option_panel
(/datum/poll_question/poll, /datum/poll_option/option)

Show the options for creating a poll option or editing its parameters.

proc
poll_option_parse_href
(/list/href_list, /datum/poll_question/poll, /datum/poll_option/option)

Processes topic data from poll option panel.

Reads through returned form data and assigns data to the option datum, creating a new one if required, before passing it to be saved. Also does some simple error checking to ensure the option will be valid before creation.

proc
poll_parse_href
(/list/href_list, /datum/poll_question/poll)

Processes topic data from poll management panel.

Reads through returned form data and assigns data to the poll datum, creating a new one if required, before passing it to be saved. Also does some simple error checking to ensure the poll will be valid before creation.

proc
rank_flags
()

Get the rank flags of the admin

proc
rank_names
()

Get the rank name of the admin

proc
reban
(ban_id, applies_to_admins, player_key, player_ip, player_cid, role, page, admin_key)

Sometimes an admin did not intend to unban a player. This proc undoes an unbanning operation by setting the unbanned_ keys in the DB back to null.

proc
remove_tagged_datum
(/datum/target_datum, silent)

Attempts to remove the specified datum from /datum/admins/var/tagged_datums if it exists

Arguments:

target_datum - The datum you want to remove from the tagged_datums list
silent - If TRUE, won't print messages to the owner's chat

proc
verify_admin_from_local_cache
(/client/client)

Returns true if the admin's cid/ip is verified in the local cache

admins /datum/admins

Vars

Procs

Var Details

var admin_signature –

var blocked_by_2fa –

var bypass_2fa –

var cached_feedback_link –

var tagged_datums – /list

Proc Details

proc Game()

proc add_tagged_datum(/datum/target_datum)

proc can_edit_rights_flags()

proc can_place_additional_admin_ban(admin_ckey)

proc check_2fa(/client/client)

proc feedback_link()

proc forceEvent()

proc handle_tagged_del(/datum/source)

proc message_pda()

proc modify_traits(/datum/D)

proc notify_all_banned_players(banned_player_ckey, banned_player_ip, banned_player_cid, banned_player_message, banned_other_message, kick_banned_players, applies_to_admins)

proc poll_list_panel()

proc poll_management_panel(/datum/poll_question/poll)

proc poll_option_panel(/datum/poll_question/poll, /datum/poll_option/option)

proc poll_option_parse_href(/list/href_list, /datum/poll_question/poll, /datum/poll_option/option)

proc poll_parse_href(/list/href_list, /datum/poll_question/poll)

proc rank_flags()

proc rank_names()

proc reban(ban_id, applies_to_admins, player_key, player_ip, player_cid, role, page, admin_key)

proc remove_tagged_datum(/datum/target_datum, silent)

proc verify_admin_from_local_cache(/client/client)

admins
/datum/admins

var
admin_signature
–

var
blocked_by_2fa
–

var
bypass_2fa
–

var
cached_feedback_link
–

var
tagged_datums
– /list

proc
Game
()

proc
add_tagged_datum
(/datum/target_datum)

proc
can_edit_rights_flags
()

proc
can_place_additional_admin_ban
(admin_ckey)

proc
check_2fa
(/client/client)

proc
feedback_link
()

proc
forceEvent
()

proc
handle_tagged_del
(/datum/source)

proc
message_pda
()

proc
modify_traits
(/datum/D)

proc
notify_all_banned_players
(banned_player_ckey, banned_player_ip, banned_player_cid, banned_player_message, banned_other_message, kick_banned_players, applies_to_admins)

proc
poll_list_panel
()

proc
poll_management_panel
(/datum/poll_question/poll)

proc
poll_option_panel
(/datum/poll_question/poll, /datum/poll_option/option)

proc
poll_option_parse_href
(/list/href_list, /datum/poll_question/poll, /datum/poll_option/option)

proc
poll_parse_href
(/list/href_list, /datum/poll_question/poll)

proc
rank_flags
()

proc
rank_names
()

proc
reban
(ban_id, applies_to_admins, player_key, player_ip, player_cid, role, page, admin_key)

proc
remove_tagged_datum
(/datum/target_datum, silent)

proc
verify_admin_from_local_cache
(/client/client)