iPcRegion Struct Reference
The representation of a region. More...
#include <propclass/region.h>
Public Member Functions | |
virtual void | SetWorldFile (const char *vfsdir, const char *name)=0 |
Set the world file to use for this region. | |
virtual const char * | GetWorldDir () const =0 |
Get the world dir that is used for this region. | |
virtual const char * | GetWorldFile () const =0 |
Get the world file that is used for this region. | |
virtual void | SetRegionName (const char *name)=0 |
Set the name of this region. | |
virtual const char * | GetRegionName () const =0 |
Get the name of this region. | |
virtual void | CreateEmptySector (const char *name)=0 |
Create empty sector. | |
virtual bool | Load ()=0 |
Load the region. | |
virtual void | Unload ()=0 |
Unload the region. | |
virtual iSector * | FindSector (const char *sectorname)=0 |
Returns a sector. | |
virtual iSector * | GetStartSector (const char *name=0)=0 |
Get start sector. | |
virtual csVector3 | GetStartPosition (const char *name=0)=0 |
Get start position. | |
virtual void | PointCamera (iPcCamera *pccamera, const char *name=0)=0 |
Update the given pccamera so that it points to the starting position in this region. | |
virtual iRegion * | GetRegion ()=0 |
Returns the CS region associated to this propclass. |
Detailed Description
The representation of a region.This property class supports the following actions (add prefix 'cel.action.' to get the ID of the action and add prefix 'cel.parameter.' to get the ID of the parameter):
- Load: no parameters.
This property class supports the following properties (add prefix 'cel.property.' to get the ID of the property:
- worlddir (string, read/write): the VFS directory of the world file.
- worldfile (string, read/write): the world filename.
- regionname (string, read/write): region name.
Definition at line 49 of file region.h.
Member Function Documentation
|
Create empty sector. Use this instead of SetWorldFile() if you want the region to have a single empty sector. The given name is the name of the sector. Note! In the current implementation you can only call this function once for a given region! |
|
Returns a sector.
|
|
Returns the CS region associated to this propclass. This function has a meaning only if the region has been loaded. |
|
Get the name of this region.
|
|
Get start position. The given name is the name of the starting position to use. If 0 is given then the default position will be used. |
|
Get start sector. The given name is the name of the starting position to use. If 0 is given then the default position will be used. |
|
Get the world dir that is used for this region.
|
|
Get the world file that is used for this region.
|
|
Load the region. This will create the empty sector if CreateEmptySector() is used. |
|
Update the given pccamera so that it points to the starting position in this region. The given name is the name of the starting position to use. If 0 is given then the default position will be used. |
|
Set the name of this region.
|
|
Set the world file to use for this region.
|
|
Unload the region.
|
The documentation for this struct was generated from the following file:
- propclass/region.h
Generated for CEL: Crystal Entity Layer by doxygen 1.4.4