handheld_radar

Vars
allowed_areas	Mining areas we allow.
digging_speed	Speed it takes for the Scanner to dig out rocks
disallowed_areas	Mining areas we don't allow.
disallowed_turfs	Turfs we don't allow.
max_distance	Maximum amount of distance from the user that the dig site will spawn in.
min_distance	Minimum amount of distance from the user that the dig site will spawn in.
profiles	Static list of players profiles so their searchs are saved.
scanner_leeway	How precise the scanner needs to be to dig out the treasures. Archeology has a change to give 1 more, the more leeway, the better.
scanner_speed	Speed it takes for the Scanner to do any scan operation that needs attention, ie, scan the digsite for the missing bit (the full scan is done in intervals). Do not reduce this under 3 seconds.
Procs
check_dig	This is the digging action, operates when you try to dig in the leeway area of the archeological site, its the one that spawns the rocks and calculates how many, as well as awrding xp
get_profile	Gets the profile of the user ckey, or creates a new one should it be needed.
is_valid_scavenge_turf	Checks wherever a particular turf is
pick_valid_turf_in_range	Makes 50 tries to get a turf in a radius between min and max distance of the caller, ensuring not to count places outside the map, and then validating the turf is one of the allowed types.
scan	Initiates the scan action for the radar, checking the user is able to and on the right conditions to get a new digging site, then stores that along with the ckey of the user and special modifiers like the leeway they rolled to dig at the area.
scan_digsite	This generates an arrow of color based on the distance of the archeological site, and pointing in the direction of it, when you are in the site, it will no longer show an arrow, but you will have to make an educated guess as the exact site (counting of course on the leeway you rolled previously.)

Var Details

var
allowed_areas
– /static/list

Mining areas we allow.

var
digging_speed

Speed it takes for the Scanner to dig out rocks

var
disallowed_areas
– /static/list

Mining areas we don't allow.

var
disallowed_turfs
– /static/list

Turfs we don't allow.

var
max_distance

Maximum amount of distance from the user that the dig site will spawn in.

var
min_distance

Minimum amount of distance from the user that the dig site will spawn in.

var
profiles
– /static/list

Static list of players profiles so their searchs are saved.

var
scanner_leeway

How precise the scanner needs to be to dig out the treasures. Archeology has a change to give 1 more, the more leeway, the better.

var
scanner_speed

Speed it takes for the Scanner to do any scan operation that needs attention, ie, scan the digsite for the missing bit (the full scan is done in intervals). Do not reduce this under 3 seconds.

Proc Details

proc
check_dig
(/mob/user, /turf/dig_turf)

This is the digging action, operates when you try to dig in the leeway area of the archeological site, its the one that spawns the rocks and calculates how many, as well as awrding xp

proc
get_profile
(/mob/user)

Gets the profile of the user ckey, or creates a new one should it be needed.

proc
is_valid_scavenge_turf
(/turf/candidate_turf)

Checks wherever a particular turf is

proc
pick_valid_turf_in_range
(/mob/user)

Makes 50 tries to get a turf in a radius between min and max distance of the caller, ensuring not to count places outside the map, and then validating the turf is one of the allowed types.

proc
scan
(/mob/user)

Initiates the scan action for the radar, checking the user is able to and on the right conditions to get a new digging site, then stores that along with the ckey of the user and special modifiers like the leeway they rolled to dig at the area.

proc
scan_digsite
(/mob/user)

This generates an arrow of color based on the distance of the archeological site, and pointing in the direction of it, when you are in the site, it will no longer show an arrow, but you will have to make an educated guess as the exact site (counting of course on the leeway you rolled previously.)

handheld_radar /obj/item/xenoarch/handheld_radar

Vars

Procs

Var Details

var allowed_areas – /static/list

var digging_speed

var disallowed_areas – /static/list

var disallowed_turfs – /static/list

var max_distance

var min_distance

var profiles – /static/list

var scanner_leeway

var scanner_speed