Location.
More...
Detailed Description
Location.
This is the circles on a global map of the world have witnessed a definite place. Each location may contain a lot of maps. Information on the locations contained in a file CITY.TXT.
- See also:
- Map
List of all members.
Public Member Functions |
uint16 | GetProtoId () |
| Returns location prototype number.
|
uint | GetMapCount () |
| Returns number of maps in location.
|
Map | GetMap (uint16 mapPid) |
| Returns map given its prototype number.
|
Map | GetMapByIndex (uint index) |
| Returns map from location that is stored at given index (specified in CITY.TXT).
|
uint | GetMaps (Map@[]@+ maps) |
| Gets all maps from location.
|
bool | Reload () |
| Reloads all maps from within a location.
|
void | Save (bool withMaps) |
| Saves location info (and maps info if withMaps == true).
|
void | Update () |
Public Attributes |
const uint | Id |
uint | Color |
const bool | IsNotValid |
| Allows to check whether underlying object is valid.
|
uint16 | WorldX |
| X coordinate on worldmap.
|
uint16 | WorldY |
| Y coordinate on worldmap.
|
bool | Visible |
| Visible/invisible on worldmap.
|
bool | GeckEnabled |
int | GeckCount |
| Number of "GECK" items in location.
|
uint8 | Radius |
| Radius of the location green circle.
|
bool | AutoGarbage |
| Удалять ли карту, когда на ней не осталось ни одного игрока, местного NPC или предмета с флагом ITEM_GECK.
|
Member Function Documentation
Returns location prototype number.
Returns number of maps in location.
Map GetMap |
( |
uint16 |
mapPid |
) |
|
Returns map given its prototype number.
- Parameters:
-
- Returns:
- Pointer to map instance.
Map GetMapByIndex |
( |
uint |
index |
) |
|
Returns map from location that is stored at given index (specified in CITY.TXT).
uint GetMaps |
( |
Map@[]@+ |
maps |
) |
|
Gets all maps from location.
- Returns:
- Number of maps.
Reloads all maps from within a location.
void Save |
( |
bool |
withMaps |
) |
|
Saves location info (and maps info if withMaps == true).
Member Data Documentation
Allows to check whether underlying object is valid.
X coordinate on worldmap.
Y coordinate on worldmap.
Visible/invisible on worldmap.
Number of "GECK" items in location.
Radius of the location green circle.
Удалять ли карту, когда на ней не осталось ни одного игрока, местного NPC или предмета с флагом ITEM_GECK.
Актуально при geck_visible == 1
.