afxEA_TLKLight.cpp

Classes:

class

Public Functions

ConsoleDocClass(sgLightObjectData , "@brief Allows legacy <a href="/coding/class/structsglightobjectdata/">sgLightObjectData</a> datablocks <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> appear in <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">scripts.\n\n</a>" "@ingroup <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">afxMisc\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(sgLightObjectData )

Detailed Description

Public Functions

ConsoleDocClass(sgLightObjectData , "@brief Allows legacy <a href="/coding/class/structsglightobjectdata/">sgLightObjectData</a> datablocks <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> appear in <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">scripts.\n\n</a>" "@ingroup <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">afxMisc\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(sgLightObjectData )

 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 <typeinfo>
28#include "afx/arcaneFX.h"
29
30#include "afx/afxEffectDefs.h"
31#include "afx/afxEffectWrapper.h"
32#include "afx/afxChoreographer.h"
33
34struct sgLightObjectData : public GameBaseData
35{
36  typedef GameBaseData Parent;
37  DECLARE_CONOBJECT(sgLightObjectData);
38  DECLARE_CATEGORY("AFX");
39};
40
41IMPLEMENT_CO_DATABLOCK_V1(sgLightObjectData);
42
43ConsoleDocClass( sgLightObjectData,
44   "@brief Allows legacy sgLightObjectData datablocks to appear in scripts.\n\n"
45
46   "@ingroup afxMisc\n"
47   "@ingroup AFX\n"
48   "@ingroup Datablocks\n"
49);
50
51//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~~//
52
53class afxEA_TLKLightDesc : public afxEffectAdapterDesc, public afxEffectDefs 
54{
55  static afxEA_TLKLightDesc desc;
56
57public:
58  virtual bool  testEffectType(const SimDataBlock*) const;
59  virtual bool  requiresStop(const afxEffectWrapperData*, const afxEffectTimingData&) const;
60  virtual bool  runsOnServer(const afxEffectWrapperData*) const { return false; }
61  virtual bool  runsOnClient(const afxEffectWrapperData*) const { return true; }
62
63  virtual afxEffectWrapper* create() const { return 0; }
64};
65
66afxEA_TLKLightDesc afxEA_TLKLightDesc::desc;
67
68//class sgUniversalStaticLightData;
69
70bool afxEA_TLKLightDesc::testEffectType(const SimDataBlock* db) const
71{
72  return (typeid(sgLightObjectData) == typeid(*db));
73}
74
75bool afxEA_TLKLightDesc::requiresStop(const afxEffectWrapperData* ew, const afxEffectTimingData& timing) const
76{
77  return (timing.lifetime < 0);
78}
79
80//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~~//
81