afxConsoleMessage.cpp

Public Functions

ConsoleDocClass(afxConsoleMessageData , "@brief A datablock that specifies <a href="/coding/file/pointer_8h/#pointer_8h_1aeeddce917cf130d62c370b8f216026dd">a</a> Console <a href="/coding/class/classmessage/">Message</a> <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">effect.\n\n</a>" "Console <a href="/coding/class/classmessage/">Message</a> effects are useful <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1a2732ab74fa0237854c2ba0f75f88a624">for</a> debugging purposes when you want <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> make sure that an effect with <a href="/coding/file/pointer_8h/#pointer_8h_1aeeddce917cf130d62c370b8f216026dd">a</a> certain kind " "of timing is actually getting executed and <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1a2732ab74fa0237854c2ba0f75f88a624">for</a> evaluating some kinds of field substitutions." "\<a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">n\n</a>" "@ingroup <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">afxEffects\n</a>" "@ingroup <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">AFX\n</a>" "@ingroup <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Datablocks\n</a>" )

IMPLEMENT_CO_DATABLOCK_V1(afxConsoleMessageData )

 1
 2
 3//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~~//
 4// Arcane-FX for MIT Licensed Open Source version of Torque 3D from GarageGames
 5// Copyright (C) 2015 Faust Logic, Inc.
 6//
 7// Permission is hereby granted, free of charge, to any person obtaining a copy
 8// of this software and associated documentation files (the "Software"), to
 9// deal in the Software without restriction, including without limitation the
10// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
11// sell copies of the Software, and to permit persons to whom the Software is
12// furnished to do so, subject to the following conditions:
13//
14// The above copyright notice and this permission notice shall be included in
15// all copies or substantial portions of the Software.
16//
17// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
22// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
23// IN THE SOFTWARE.
24//
25//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~~//
26
27#include "afx/arcaneFX.h"
28
29#include "console/consoleTypes.h"
30#include "core/stream/bitStream.h"
31
32#include "afx/ce/afxConsoleMessage.h"
33
34//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~~//
35// afxConsoleMessageData
36
37IMPLEMENT_CO_DATABLOCK_V1(afxConsoleMessageData);
38
39ConsoleDocClass( afxConsoleMessageData,
40   "@brief A datablock that specifies a Console Message effect.\n\n"
41
42   "Console Message effects are useful for debugging purposes when you want to make sure that an effect with a certain kind "
43   "of timing is actually getting executed and for evaluating some kinds of field substitutions."
44   "\n\n"
45
46   "@ingroup afxEffects\n"
47   "@ingroup AFX\n"
48   "@ingroup Datablocks\n"
49);
50
51afxConsoleMessageData::afxConsoleMessageData()
52{
53  message_str = ST_NULLSTRING;
54}
55
56afxConsoleMessageData::afxConsoleMessageData(const afxConsoleMessageData& other, bool temp_clone) : GameBaseData(other, temp_clone)
57{
58  message_str = other.message_str;
59}
60
61#define myOffset(field) Offset(field, afxConsoleMessageData)
62
63void afxConsoleMessageData::initPersistFields()
64{
65  addField("message",    TypeString,     myOffset(message_str),
66    "A text message to be displayed when the effect is executed.");
67
68  Parent::initPersistFields();
69}
70
71bool afxConsoleMessageData::onAdd()
72{
73  if (Parent::onAdd() == false)
74    return false;
75
76  return true;
77}
78
79void afxConsoleMessageData::packData(BitStream* stream)
80{
81   Parent::packData(stream);
82
83  stream->writeString(message_str);
84}
85
86void afxConsoleMessageData::unpackData(BitStream* stream)
87{
88  Parent::unpackData(stream);
89
90  message_str = stream->readSTString();
91}
92
93
94//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~~//
95