Difference between revisions of "LavishNav:lnavregion (Object Type)"
Jump to navigation
Jump to search
| Line 2: | Line 2: | ||
== Members == | == Members == | ||
| − | *... '''Parent''': | + | *... '''Parent''': The region immediately containing this one |
| − | *... '''Children''': | + | *... '''Children''': The first child region in this region's tree |
| − | *... '''Next''': | + | *... '''Next''': The next sibling region |
| − | *... '''Previous''': | + | *... '''Previous''': The previous sibling region |
| − | *[[DataType:uint|uint]] '''ID''': | + | *[[DataType:uint|uint]] '''ID''': This region's unique identifier number |
| − | *[[DataType:string|string]] '''Name''': | + | *[[DataType:string|string]] '''Name''': This region's name |
| − | *[[DataType:string|string]] '''FQN''': | + | *[[DataType:string|string]] '''FQN''': The Fully-Qualified Name for this region |
| − | *[[DataType:bool|bool]] '''Unique''': | + | *[[DataType:bool|bool]] '''Unique''': Is this region unique? |
| − | *[[DataType:bool|bool]] '''Avoid''': | + | *[[DataType:bool|bool]] '''Avoid''': Is this region marked avoid? |
| − | *[[DataType:bool|bool]] '''InheritedAvoid''': | + | *[[DataType:bool|bool]] '''InheritedAvoid''': Is one of this region's ancestors marked avoid, thus allowing this region to inherit avoidance? |
| − | *[[DataType:bool|bool]] '''AnyAvoid''': | + | *[[DataType:bool|bool]] '''AnyAvoid''': Is this region marked avoid OR does it inherit avoidance (as above)? |
| − | *[[DataType:bool|bool]] '''AllPointsValid''': | + | *[[DataType:bool|bool]] '''AllPointsValid''': Is this region marked "All points valid", thus allowing safe random point generation within the bounds of this region? |
| − | *[[DataType:bool|bool]] '''Contains['''x''','''y''','''z''']''': | + | *[[DataType:bool|bool]] '''Contains['''x''','''y''','''z''']''': Does this region contain the given point (coordinates may be ommitted to check for x,0,0 or x,y,0)? |
| − | *[[DataType:string|string]] '''Type''': | + | *[[DataType:string|string]] '''Type''': The region type (point, rect, radius, box, etc) |
| − | *[[DataType:string|string]] '''Custom['''name''']''': | + | *[[DataType:string|string]] '''Custom['''name''']''': Value of the custom data point with this name |
*... '''AddChild['''type''','''name''','''...''']''': Adds a child region given a type (such as point) and a name. Extra parameters are used to construct the new region. To construct a unique region, use -unique. To construct a region that defines a coordinate system, use -coordinatesystem. These must be the first extra parameters, before any region type-specific parameters. | *... '''AddChild['''type''','''name''','''...''']''': Adds a child region given a type (such as point) and a name. Extra parameters are used to construct the new region. To construct a unique region, use -unique. To construct a region that defines a coordinate system, use -coordinatesystem. These must be the first extra parameters, before any region type-specific parameters. | ||
*... '''FindRegion['''search''']''': Finds a region with a relative [[LavishNav:Region Name Search|Region Name Search]] | *... '''FindRegion['''search''']''': Finds a region with a relative [[LavishNav:Region Name Search|Region Name Search]] | ||
| − | *point3f '''NearestPoint''': | + | *point3f '''NearestPoint['''x''','''y''','''z''']''': Retrieves the nearest point to the given location (coordinates may be ommitted to use x,0,0 or x,y,0) |
| − | *point3f '''CenterPoint''': | + | *point3f '''CenterPoint''': The center point |
| − | *... '''CoordinateSystem''': The region that defines the coordinate system for this particular region | + | *... '''CoordinateSystem''': The ancestor region that defines the coordinate system for this particular region |
| + | *[[DataType:bool|bool]] '''IsCoordinateSystem''': TRUE if this region defines a coordinate system for its descendant regions | ||
== Methods == | == Methods == | ||
| Line 29: | Line 30: | ||
*'''ExportChildren['''filename''']''': Exports this region's children to a LavishNav XML file | *'''ExportChildren['''filename''']''': Exports this region's children to a LavishNav XML file | ||
*'''Remove''': Removes the region | *'''Remove''': Removes the region | ||
| − | *''' | + | *'''Disconnect['''search''']''': not yet implemented |
| − | + | *'''SetCustom['''name''','''text''']''': Creates a custom data point with this name and value | |
| − | *'''SetCustom['''name''','''text''']''': Creates a custom data point | ||
*'''UnsetCustom['''name''']''': Removes a custom data point | *'''UnsetCustom['''name''']''': Removes a custom data point | ||
*'''SetAllPointsValid['''value''']''': Sets the "All points valid" flag | *'''SetAllPointsValid['''value''']''': Sets the "All points valid" flag | ||
*'''SetUnique['''value''']''': Sets the unique flag | *'''SetUnique['''value''']''': Sets the unique flag | ||
*'''SetAvoid['''value''']''': Sets the avoid flag | *'''SetAvoid['''value''']''': Sets the avoid flag | ||
| − | *'''AddChild['''type''','''name''','''...''']''': | + | *... '''AddChild['''type''','''name''','''...''']''': Adds a child region given a type (such as point) and a name. Extra parameters are used to construct the new region. To construct a unique region, use -unique. To construct a region that defines a coordinate system, use -coordinatesystem. These must be the first extra parameters, before any region type-specific parameters. |
| − | *'''Connect['''search''']''': | + | *'''Connect['''search''']''': Connects this region to the given region, using a relative [[LavishNav:Region Name Search|Region Name Search]] |
== Inherits == | == Inherits == | ||
Revision as of 18:49, 12 March 2006
Description
Members
- ... Parent: The region immediately containing this one
- ... Children: The first child region in this region's tree
- ... Next: The next sibling region
- ... Previous: The previous sibling region
- uint ID: This region's unique identifier number
- string Name: This region's name
- string FQN: The Fully-Qualified Name for this region
- bool Unique: Is this region unique?
- bool Avoid: Is this region marked avoid?
- bool InheritedAvoid: Is one of this region's ancestors marked avoid, thus allowing this region to inherit avoidance?
- bool AnyAvoid: Is this region marked avoid OR does it inherit avoidance (as above)?
- bool AllPointsValid: Is this region marked "All points valid", thus allowing safe random point generation within the bounds of this region?
- bool Contains[x,y,z]: Does this region contain the given point (coordinates may be ommitted to check for x,0,0 or x,y,0)?
- string Type: The region type (point, rect, radius, box, etc)
- string Custom[name]: Value of the custom data point with this name
- ... AddChild[type,name,...]: Adds a child region given a type (such as point) and a name. Extra parameters are used to construct the new region. To construct a unique region, use -unique. To construct a region that defines a coordinate system, use -coordinatesystem. These must be the first extra parameters, before any region type-specific parameters.
- ... FindRegion[search]: Finds a region with a relative Region Name Search
- point3f NearestPoint[x,y,z]: Retrieves the nearest point to the given location (coordinates may be ommitted to use x,0,0 or x,y,0)
- point3f CenterPoint: The center point
- ... CoordinateSystem: The ancestor region that defines the coordinate system for this particular region
- bool IsCoordinateSystem: TRUE if this region defines a coordinate system for its descendant regions
Methods
- Clear: Resets the region such that it will contain no child regions
- Import[filename]: Imports a LavishNav XML file as children of this region
- Export[filename]: Exports this region and its children to a LavishNav XML file
- ExportChildren[filename]: Exports this region's children to a LavishNav XML file
- Remove: Removes the region
- Disconnect[search]: not yet implemented
- SetCustom[name,text]: Creates a custom data point with this name and value
- UnsetCustom[name]: Removes a custom data point
- SetAllPointsValid[value]: Sets the "All points valid" flag
- SetUnique[value]: Sets the unique flag
- SetAvoid[value]: Sets the avoid flag
- ... AddChild[type,name,...]: Adds a child region given a type (such as point) and a name. Extra parameters are used to construct the new region. To construct a unique region, use -unique. To construct a region that defines a coordinate system, use -coordinatesystem. These must be the first extra parameters, before any region type-specific parameters.
- Connect[search]: Connects this region to the given region, using a relative Region Name Search
Inherits
none
Returns
NULL
