/datum/allocated_region

Represents a map region you have allocated access to. While you hold a reference to this region you are free to assume nothing else will allocate this part of the map and touch your region. You should also not go out of its bounds of course. Deallocate the region by qdel()ing it or dropping all references to it.

Vars
bottom_left	Bottom left corner of the region
height	Height in tiles
name	optional friendly name for the region
node	Corresponding node in the region_allocator quad tree
width	Width in tiles
Procs
get_center	returns the center turf of the region, biasing towards top right if dimensions even
get_random_turf	returns a random turf in the region
relative_turf_coords	Returns the relative coordinates of the turf in the region (1, 1) being bottom left corner. Returns null if the turf is not in the region.
turf_at	Given local coordinates (x, y) returns you a turf at these coordinates in the region. I.e. (1, 1) will return src.bottom_left . This is the preferred method to access turfs in the region. If coordinates are out of bounds null will be returned.
turf_in_region	Checks if a turf is in the region.
turf_on_border	Checks if the turf is on the (inner) border of the region

Var Details

var
bottom_left
– /turf

Bottom left corner of the region

var
height
–

Height in tiles

var
name
–

optional friendly name for the region

var
node
– /datum/region_node

Corresponding node in the region_allocator quad tree

var
width
–

Width in tiles

Proc Details

proc
get_center
()

returns the center turf of the region, biasing towards top right if dimensions even

proc
get_random_turf
()

returns a random turf in the region

proc
relative_turf_coords
(/turf/T)

Returns the relative coordinates of the turf in the region (1, 1) being bottom left corner. Returns null if the turf is not in the region.

proc
turf_at
(x, y)

Given local coordinates (x, y) returns you a turf at these coordinates in the region. I.e. (1, 1) will return src.bottom_left . This is the preferred method to access turfs in the region. If coordinates are out of bounds null will be returned.

proc
turf_in_region
(/turf/T)

Checks if a turf is in the region.

proc
turf_on_border
(/turf/T)

Checks if the turf is on the (inner) border of the region

/datum/allocated_region

Vars

Procs

Var Details

var bottom_left – /turf

var height –

var name –

var node – /datum/region_node

var width –

Proc Details

proc get_center()

proc get_random_turf()

proc relative_turf_coords(/turf/T)

proc turf_at(x, y)

proc turf_in_region(/turf/T)

proc turf_on_border(/turf/T)