Difference between revisions of "GetCurrentRegion"
Jump to navigation
Jump to search
This script function is documented but either not implemented or else superceded by another function. Please do not use this function in your mod; alternatives are offered in the article.
imported>DragoonWraith m (it's hard to even call this deprecated, since I don't think it's intended at all.) |
imported>DragoonWraith m (dumb name for that template...) |
||
| Line 1: | Line 1: | ||
{{Deprecated}} | {{Deprecated Functions}} | ||
{{Function | {{Function | ||
| origin = OBSE | | origin = OBSE | ||
Latest revision as of 00:41, 7 January 2012
Deprecated Function
This script function is documented but either not implemented or else superceded by another function. Please do not use this function in your mod; alternatives are offered in the article.
< [[::Category:Functions|Category:Functions]]
A function added by the Oblivion Script Extender.
Syntax:
(region:form) GetCurrentRegion
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).