Zone¶
Used to find information about a particular zone.
Forms¶
currentzone Zone¶
- Retrieves the current zone information
zone Zone[N]¶
- Retrieves information about a zone by zone ID. If this zone is the current zone, then this will return currentzone.
zone Zone[ShortName]¶
- Retrieves information about a zone by short name. If this zone is the current zone, then this will return currentzone.
Associated DataTypes¶
zone¶
- Contains information related to the specified zone
-
Members
int
ID¶- ID of the zone
string
Name¶- Full zone name
string
ShortName¶- Short zone name
int64
ZoneFlags¶- Flags for this zone
string
To String¶- Same as Name
currentzone¶
- Extends the zone type with additional information about the current zone.
-
Members
This type inherits members from zone.
bool
Dungeon¶- Same as Indoor.
int
ID¶- the ID of the zone.
bool
Indoor¶- True if this is an Indoor zone.
float
MaxClip¶- Maximum clip plane allowed in zone.
float
MinClip¶- Minimum clip plane allowed in zone.
string
Name¶- Full zone name.
bool
NoBind¶- True if binding isn't allowed in this zone outside specified bindable areas.
bool
Outdoor¶- True if this is an outdoor zone.
string
ShortName¶- Short zone name
int
Type¶-
Zone type
Value Meaning 0 Indoor Dungeon 1 Outdoor 2 Outdoor City 3 Dungeon City 4 Indoor City 5 Outdoor Dungeon
int
ZoneType¶- Same as Type
string
To String¶- Same as Name
Usage¶
/echo ${Zone.Type}
Returns an integer representing the zone you are currently in.
/echo ${Zone.Indoor}
Returns TRUE if you're indoors, FALSE if not.
/echo ${Zone[zonename].ID}
Returns the ID of zonename, even if you aren't in the zone.
/echo ${Zone[zoneid].ShortName}
Returns the short name of the zone with ID zoneid.