From 0668dd4d4028e8effd8cf92ad9834b672bb4400d Mon Sep 17 00:00:00 2001 From: Kayne Ruse Date: Thu, 15 Dec 2016 21:26:17 +1100 Subject: [PATCH] Minor amendments --- Region.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/Region.md b/Region.md index d6e4407..062753e 100644 --- a/Region.md +++ b/Region.md @@ -1,3 +1,7 @@ +# Introduction + +Region objects hold a number of tiles, equal to `REGION_WIDTH * REGION_HEIGHT`. Each tile has a number of layers equal to `REGION_DEPTH`, as well as a flag indicating if that tile is solid or not. Regions are handled and processed by RegionPagerBase (and RegionPagerLua), and generally don't exist on their own. + # Globals ```C++ @@ -26,6 +30,8 @@ Region(Region const&); This is Region's constructor. The first version takes an `x` & `y` value as a parameter, while the second version, the copy constructor, takes another `Region` as a parameter. Please note that the parameters `x` & `y` must be multiples of `REGION_WIDTH` and `REGION_HEIGHT` respectfully, otherwise an exception is thrown (multiples can be zero, or negatives). +Please note that the default constructor is explicitly deleted. + ```C++ type_t SetTile(int x, int y, int z, type_t v); ```