LavishNav:Regions
Contents
Introduction
What is a region?
A region is an individual area or point in 3-dimensional space. LavishNav defines 6 efficient region types: point, radius, rect, sphere, box, universe.
All types of regions can have any number of sub-regions (children) without restriction, regardless of whether they are inside the defined area of the parent region. Certain characreristics of parent regions are inherited by child regions (such as avoidance flags).
Regions with no parents are actually children of an inaccessible "root" region.
Region Characteristics
- Note on terms used
- Attributes and Properties collectively describe characteristics of the region. The difference is that attributes are defined inside the region tag in XML, and properties would be sub-tags contained by the region tag.
Attributes
- Name
- All regions must have a name. The name must not be the same as any of its siblings, but may be the same as another region elsewhere (including this region's parent and children)
- Unique
- Regions may be identified as Unique to prevent any other region from being created with the same name. Note that it is possible to create regions with the same name before a Unique region is defined with that name, however they may become difficult to access.
Properties
None, see individual region types. Other characteristics are be available through the lnavregion object type
Notes on Region Names
A Fully-Qualified Name (FQN) is made up of a region's name and each of its parents' names (from this region to its outermost parent), separated by the . character. For example, if an region named "Bank" resides in a top-level region named "SomeCity", the region's FQN is "Bank.SomeCity".
