#include <pfKIMsg.h>
Public Types |
| enum | {
kHACKChatMsg,
kEnterChatMode,
kSetChatFadeDelay,
kSetTextChatAdminMode,
kDisableKIandBB,
kEnableKIandBB,
kYesNoDialog,
kAddPlayerDevice,
kRemovePlayerDevice,
kUpgradeKILevel,
kDowngradeKILevel,
kRateIt,
kSetPrivateChatChannel,
kUnsetPrivateChatChannel,
kStartBookAlert,
kMiniBigKIToggle,
kKIPutAway,
kChatAreaPageUp,
kChatAreaPageDown,
kChatAreaGoToBegin,
kChatAreaGoToEnd,
kKITakePicture,
kKICreateJournalNote,
kKIToggleFade,
kKIToggleFadeEnable,
kKIChatStatusMsg,
kKILocalChatStatusMsg,
kKIUpSizeFont,
kKIDownSizeFont,
kKIOpenYeehsaBook,
kKIOpenKI,
kKIShowCCRHelp,
kKICreateMarker,
kKICreateMarkerFolder,
kKILocalChatErrorMsg,
kKIPhasedAllOn,
kKIPhasedAllOff,
kKIOKDialog,
kDisableYeeshaBook,
kEnableYeeshaBook,
kQuitDialog,
kTempDisableKIandBB,
kTempEnableKIandBB,
kDisableEntireYeeshaBook,
kEnableEntireYeeshaBook,
kKIOKDialogNoQuit,
kGZUpdated,
kGZInRange,
kGZOutRange,
kUpgradeKIMarkerLevel,
kKIShowMiniKI,
kGZFlashUpdate,
kStartJournalAlert,
kAddJournalBook,
kRemoveJournalBook,
kKIOpenJournalBook,
kMGStartCGZGame,
kMGStopCGZGame,
kKICreateMarkerNode,
kStartKIAlert,
kUpdatePelletScore,
kFriendInviteSent,
kRegisterImager,
kNoCommand
} |
| enum | Flags {
kPrivateMsg = 0x1,
kAdminMsg = 0x2,
kDead = 0x4,
kUNUSED1 = 0x8,
kStatusMsg = 0x10,
kNeighborMsg = 0x20,
kChannelMask = 0xFF00
} |
| enum | KILevels { kNanoKI,
kMicroKI,
kNormalKI
} |
| enum | plBCastFlags {
kBCastNone = 0x0,
kBCastByType = 0x1,
kBCastUNUSED_0 = 0x2,
kPropagateToChildren = 0x4,
kBCastByExactType = 0x8,
kPropagateToModifiers = 0x10,
kClearAfterBCast = 0x20,
kNetPropagate = 0x40,
kNetSent = 0x80,
kNetUseRelevanceRegions = 0x100,
kNetForce = 0x200,
kNetNonLocal = 0x400,
kLocalPropagate = 0x800,
kNetNonDeterministic = 0x200,
kMsgWatch = 0x1000,
kNetStartCascade = 0x2000,
kNetAllowInterAge = 0x4000,
kNetSendUnreliable = 0x8000,
kCCRSendToAllPlayers = 0x10000,
kNetCreatedRemotely = 0x20000
} |
Member Enumeration Documentation
- Enumerator:
| kHACKChatMsg |
|
| kEnterChatMode |
|
| kSetChatFadeDelay |
|
| kSetTextChatAdminMode |
|
| kDisableKIandBB |
|
| kEnableKIandBB |
|
| kYesNoDialog |
|
| kAddPlayerDevice |
|
| kRemovePlayerDevice |
|
| kUpgradeKILevel |
|
| kDowngradeKILevel |
|
| kRateIt |
|
| kSetPrivateChatChannel |
|
| kUnsetPrivateChatChannel |
|
| kStartBookAlert |
|
| kMiniBigKIToggle |
|
| kKIPutAway |
|
| kChatAreaPageUp |
|
| kChatAreaPageDown |
|
| kChatAreaGoToBegin |
|
| kChatAreaGoToEnd |
|
| kKITakePicture |
|
| kKICreateJournalNote |
|
| kKIToggleFade |
|
| kKIToggleFadeEnable |
|
| kKIChatStatusMsg |
|
| kKILocalChatStatusMsg |
|
| kKIUpSizeFont |
|
| kKIDownSizeFont |
|
| kKIOpenYeehsaBook |
|
| kKIOpenKI |
|
| kKIShowCCRHelp |
|
| kKICreateMarker |
|
| kKICreateMarkerFolder |
|
| kKILocalChatErrorMsg |
|
| kKIPhasedAllOn |
|
| kKIPhasedAllOff |
|
| kKIOKDialog |
|
| kDisableYeeshaBook |
|
| kEnableYeeshaBook |
|
| kQuitDialog |
|
| kTempDisableKIandBB |
|
| kTempEnableKIandBB |
|
| kDisableEntireYeeshaBook |
|
| kEnableEntireYeeshaBook |
|
| kKIOKDialogNoQuit |
|
| kGZUpdated |
|
| kGZInRange |
|
| kGZOutRange |
|
| kUpgradeKIMarkerLevel |
|
| kKIShowMiniKI |
|
| kGZFlashUpdate |
|
| kStartJournalAlert |
|
| kAddJournalBook |
|
| kRemoveJournalBook |
|
| kKIOpenJournalBook |
|
| kMGStartCGZGame |
|
| kMGStopCGZGame |
|
| kKICreateMarkerNode |
|
| kStartKIAlert |
|
| kUpdatePelletScore |
|
| kFriendInviteSent |
|
| kRegisterImager |
|
| kNoCommand |
|
- Enumerator:
| kPrivateMsg |
|
| kAdminMsg |
|
| kDead |
|
| kUNUSED1 |
|
| kStatusMsg |
|
| kNeighborMsg |
|
| kChannelMask |
|
- Enumerator:
| kNanoKI |
|
| kMicroKI |
|
| kNormalKI |
|
Constructor & Destructor Documentation
Member Function Documentation
| unsigned char pfKIMsg::getCommand |
( |
| ) |
const |
| float pfKIMsg::getDelay |
( |
| ) |
const |
| unsigned int pfKIMsg::getFlags |
( |
| ) |
const |
| unsigned int pfKIMsg::getPlayerID |
( |
| ) |
const |
| int pfKIMsg::getValue |
( |
| ) |
const |
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 plMessage.
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 plMessage.
Reads this creatable directly from the stream. If any keys are read, they will be added to the plResManager automatically.
Reimplemented from plMessage.
| void pfKIMsg::setCommand |
( |
unsigned char |
command | ) |
|
| void pfKIMsg::setDelay |
( |
float |
delay | ) |
|
| void pfKIMsg::setFlags |
( |
unsigned int |
flags | ) |
|
| void pfKIMsg::setPlayerID |
( |
unsigned int |
playerID | ) |
|
| void pfKIMsg::setString |
( |
const plString & |
str | ) |
|
| void pfKIMsg::setUser |
( |
const plString & |
user | ) |
|
| void pfKIMsg::setValue |
( |
int |
value | ) |
|
Writes this creatable directly to the stream. The plResManager is used to manage any key references written by this creatable.
Reimplemented from plMessage.
Member Data Documentation
| unsigned char pfKIMsg::fCommand |
|
protected |
| unsigned int pfKIMsg::fFlags |
|
protected |
| unsigned int pfKIMsg::fPlayerID |
|
protected |
The documentation for this class was generated from the following file:
Public Member Functions inherited from plMessage