Main Page | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members
iPcPortal Struct Reference
This is a property class holding the representation of a portal. More...
#include <propclass/portal.h>
Public Member Functions | |
virtual bool | SetPortal (const char *mesh, const char *portal=0)=0 |
Set the portal to use. | |
virtual iPortal * | GetPortal ()=0 |
Get the portal. | |
virtual void | ClosePortal ()=0 |
Close portal. | |
virtual void | OpenPortal ()=0 |
Open portal. | |
virtual bool | IsPortalClosed () const =0 |
Is the portal closed? |
Detailed Description
This is a property class holding the representation of a portal.This is mainly useful in cases where you want to close a portal for performance reasons. Closing a portal can be useful in case you have a door that closes off the portal and it doesn't make sense to use the portal anyway.
This property class supports the following properties (add prefix 'cel.property.' to get the ID of the property:
- mesh (string, read/write): the name of the portal mesh.
- portal (string, read/write): the name of the portal.
- closed (bool, read/write): if the portal is closed or not.
Definition at line 45 of file portal.h.
Member Function Documentation
|
Close portal.
|
|
Get the portal.
|
|
Is the portal closed?
|
|
Open portal.
|
|
Set the portal to use.
|
The documentation for this struct was generated from the following file:
- propclass/portal.h
Generated for CEL: Crystal Entity Layer by doxygen 1.4.4