Difference between revisions of "GetCurrentRegion"

GetCurrentRegion (edit)

365 bytes added , 00:40, 7 January 2012

m

it's hard to even call this deprecated, since I don't think it's intended at all.

Anonymous user

@@ Line 1: / Line 1: @@
+{{Deprecated}}
 {{Function
   | origin = OBSE
-  | summary = Returns the region in which the player is currently located, if any. In interior cells, generally returns 0. Regions in exterior cells can overlap, therefore it's possible for the player to be in several regions simultaneously, so [[GetCurrentRegions]] is probably the better function to use.
+  | summary = Intended to return the region in which the player is currently located, if any. In interior cells, generally returns 0.
+However, regions in exterior cells can overlap, therefore it's possible for the player to be in several regions simultaneously, and which this function will actually return is undefined. Therefore, [[GetCurrentRegions]] is the better function to use.
+In fact, this function was never actually documented in the OBSE command docs, so it is entirely possible that the OBSE team may decide to stop supporting it (unlike regular deprecated functions, which will usually still be supported even if they are not recommended).
   | name = GetCurrentRegion
   | returnVal = region