byond - Modules - TypesProc Details

Sticky Ban

Procs

add_matched_cidAdds a CID match to the specified stickyban.
add_matched_ckeyAdds a ckey match to the specified sticky ban.
add_matched_ipAdds an IP match to the specified stickyban.
add_stickybanAdds a new tracked stickyban, and returns a /datum/entity/stickyban if it was successful. Blocking, sleeps.
check_for_sticky_banReturns a list of /datum/view_record/stickybans, or null, if no stickybans are found. All arguments are optional, but you should pass at least one if you want any results.
get_impacted_cid_recordsReturns a /list of /datum/view_record/stickyban_matched_cid where the impacted CID matches the CID provided. Connections matching this CID will be blocked - provided the linked stickyban is active.
get_impacted_ckey_recordsReturns a /list of /datum/view_record/stickyban_matched_ckey where the ckey provided has not been whitelisted from the stickyban, and would be prevented from joining - provided that the stickyban itself remains active.
get_impacted_ip_recordsReturns a /list of /datum/view_record/stickyban_matched_ip where the impacted IP matches the IP provided. Connections matchin this IP will be blocked - provided the linked stickyban is active.
get_whitelisted_ckey_recordsReturns a /list of /datum/view_record/stickyban_matched_ckey which have been manually whitelisted by an admin and matches the provided existing_ban_id and key.
handle_old_permaImports permabans from the old ban.txt, and does not ban people that have been whitelisted.
import_stickyLegacy import from pager bans to database bans.
match_stickyAssociates an existing stickyban with a new match, either of a ckey, address, or computer_id. Or all three.
whitelist_ckeyWhitelists a specific CKEY to the specified stickyban, which will allow connection, even with matching CIDs and IPs.

Proc Details

add_matched_cid

Adds a CID match to the specified stickyban.

add_matched_ckey

Adds a ckey match to the specified sticky ban.

add_matched_ip

Adds an IP match to the specified stickyban.

add_stickyban

Adds a new tracked stickyban, and returns a /datum/entity/stickyban if it was successful. Blocking, sleeps.

check_for_sticky_ban

Returns a list of /datum/view_record/stickybans, or null, if no stickybans are found. All arguments are optional, but you should pass at least one if you want any results.

get_impacted_cid_records

Returns a /list of /datum/view_record/stickyban_matched_cid where the impacted CID matches the CID provided. Connections matching this CID will be blocked - provided the linked stickyban is active.

get_impacted_ckey_records

Returns a /list of /datum/view_record/stickyban_matched_ckey where the ckey provided has not been whitelisted from the stickyban, and would be prevented from joining - provided that the stickyban itself remains active.

get_impacted_ip_records

Returns a /list of /datum/view_record/stickyban_matched_ip where the impacted IP matches the IP provided. Connections matchin this IP will be blocked - provided the linked stickyban is active.

get_whitelisted_ckey_records

Returns a /list of /datum/view_record/stickyban_matched_ckey which have been manually whitelisted by an admin and matches the provided existing_ban_id and key.

handle_old_perma

Imports permabans from the old ban.txt, and does not ban people that have been whitelisted.

import_sticky

Legacy import from pager bans to database bans.

match_sticky

Associates an existing stickyban with a new match, either of a ckey, address, or computer_id. Or all three.

Arguments:

whitelist_ckey

Whitelists a specific CKEY to the specified stickyban, which will allow connection, even with matching CIDs and IPs.