#include <plObjInterface.h>
Public Types | |
| enum | { kDisable } |
 Public Types inherited from plSynchedObject | |
| enum | Flags { kDontDirty = 0x1, kSendReliably = 0x2, kHasConstantNetGroup = 0x4, kDontSynchGameMessages = 0x8, kExcludePersistentState = 0x10, kExcludeAllPersistentState = 0x20, kLocalOnly = kExcludeAllPersistentState | kDontSynchGameMessages, kHasVolatileState = 0x40, kAllStateIsVolatile = 0x80 } |
| enum | SDLSendFlags { kBCastToClients = 0x1, kForceFullSend = 0x2, kSkipLocalOwnershipCheck = 0x4, kSendImmediately = 0x8, kDontPersistOnServer = 0x10, kUseRelevanceRegions = 0x20, kNewState = 0x40, kIsAvatarState = 0x80 } |
Public Member Functions | |
| plObjInterface () | |
| virtual void | read (hsStream *S, plResManager *mgr) |
| virtual void | write (hsStream *S, plResManager *mgr) |
| bool | getProperty (size_t prop) const |
| void | setProperty (size_t prop, bool value) |
| plKey | getOwner () const |
| void | setOwner (plKey owner) |
| Public Member Functions inherited from plSynchedObject | |
| plSynchedObject () | |
| int | getFlags () const |
| void | setFlags (int flags) |
| const std::vector< plString > & | getExcludes () const |
| const std::vector< plString > & | getVolatiles () const |
| void | setExclude (const plString &sdl) |
| void | setVolatile (const plString &sdl) |
| void | clearExcludes () |
| void | clearVolatiles () |
| Public Member Functions inherited from hsKeyedObject | |
| void | init (const plString &name) |
| plKey | getKey () const |
| void | setKey (plKey key) |
| Public Member Functions inherited from plCreatable | |
| plCreatable () | |
| virtual | ~plCreatable () |
| virtual short | ClassIndex () const =0 |
| short | ClassIndex (PlasmaVer ver) const |
| virtual const char * | ClassName () const |
| virtual bool | ClassInstance (short) const |
| virtual bool | isStub () const |
| virtual void | prcWrite (pfPrcHelper *prc) |
| virtual void | prcParse (const pfPrcTag *tag, plResManager *mgr) |
Protected Member Functions | |
| virtual void | IPrcWrite (pfPrcHelper *prc) |
| virtual void | IPrcParse (const pfPrcTag *tag, plResManager *mgr) |
Protected Attributes | |
| plKey | fOwner |
| hsBitVector | fProps |
| Protected Attributes inherited from plSynchedObject | |
| unsigned int | fSynchFlags |
| std::vector< plString > | fSDLExcludeList |
| std::vector< plString > | fSDLVolatileList |
Member Enumeration Documentation
Constructor & Destructor Documentation
| plObjInterface::plObjInterface | ( | ) |
Member Function Documentation
| plKey plObjInterface::getOwner | ( | ) | const |
| bool plObjInterface::getProperty | ( | size_t | prop | ) | const |
|
protectedvirtual |
This must be overloaded by subclasses to parse PRC data specific to the class from the PRC document. It is called once for each tag that is a child to the Creatable tag itself, so subclasses should check for each supported tag and handle it accordingly if it matches. If the tag is not recognized, it should be passed along to the parent class.
Reimplemented from plSynchedObject.
Reimplemented in plSoftVolumeComplex, plSwimStraightCurrentRegion, plMobileOccluder, plInstanceDrawInterface, plSoftVolumeSimple, plSpotLightInfo, plSwimCircularCurrentRegion, plActivePrintShape, plLightInfo, plHardRegionPlanes, plFilterCoordInterface, plSoftVolume, plShadowMaster, plCoordinateInterface, plSimulationInterface, plOccluder, plLimitedDirLightInfo, plBoundInterface, plHardRegionComplex, plRelevanceRegion, plVisRegion, plOmniLightInfo, plSwimRegionInterface, plDrawInterface, plPrintShape, plHKSubWorld, and plAudioInterface.
|
protectedvirtual |
This must be overloaded by subclasses to write PRC data specific to the class to the PRC document. Do not write the top-level creatable tag, that is handled by prcWrite().
Reimplemented from plSynchedObject.
Reimplemented in plSoftVolumeComplex, plSwimStraightCurrentRegion, plMobileOccluder, plInstanceDrawInterface, plSoftVolumeSimple, plSpotLightInfo, plSwimCircularCurrentRegion, plActivePrintShape, plLightInfo, plHardRegionPlanes, plFilterCoordInterface, plSoftVolume, plShadowMaster, plCoordinateInterface, plSimulationInterface, plOccluder, plLimitedDirLightInfo, plBoundInterface, plHardRegionComplex, plRelevanceRegion, plVisRegion, plOmniLightInfo, plSwimRegionInterface, plDrawInterface, plPrintShape, plHKSubWorld, and plAudioInterface.
|
virtual |
Reads this creatable directly from the stream. If any keys are read, they will be added to the plResManager automatically.
Reimplemented from plSynchedObject.
Reimplemented in plSoftVolumeComplex, plSwimStraightCurrentRegion, plMobileOccluder, plInstanceDrawInterface, plSoftVolumeSimple, plSpotLightInfo, plSwimCircularCurrentRegion, plActivePrintShape, plLightInfo, plHardRegionPlanes, plFilterCoordInterface, plSoftVolume, plShadowMaster, plCoordinateInterface, plSimulationInterface, plOccluder, plLimitedDirLightInfo, plBoundInterface, plHardRegionComplex, plRelevanceRegion, plVisRegion, plOmniLightInfo, plSwimRegionInterface, plDrawInterface, plPrintShape, plHKSubWorld, and plAudioInterface.
| void plObjInterface::setOwner | ( | plKey | owner | ) |
| void plObjInterface::setProperty | ( | size_t | prop, |
| bool | value | ||
| ) |
|
virtual |
Writes this creatable directly to the stream. The plResManager is used to manage any key references written by this creatable.
Reimplemented from plSynchedObject.
Reimplemented in plSoftVolumeComplex, plSwimStraightCurrentRegion, plMobileOccluder, plInstanceDrawInterface, plSoftVolumeSimple, plSpotLightInfo, plSwimCircularCurrentRegion, plActivePrintShape, plLightInfo, plHardRegionPlanes, plFilterCoordInterface, plSoftVolume, plShadowMaster, plCoordinateInterface, plSimulationInterface, plOccluder, plLimitedDirLightInfo, plBoundInterface, plHardRegionComplex, plRelevanceRegion, plVisRegion, plOmniLightInfo, plSwimRegionInterface, plDrawInterface, plPrintShape, plHKSubWorld, and plAudioInterface.
Member Data Documentation
|
protected |
|
protected |
The documentation for this class was generated from the following file:
- core/PRP/Object/plObjInterface.h
