doxygen: prevent GPL license block from being parsed as doxygen comment.
[blender.git] / source / gameengine / Ketsji / KX_SCA_EndObjectActuator.cpp
1 /*
2  * $Id$
3  * ***** BEGIN GPL LICENSE BLOCK *****
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software Foundation,
17  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18  *
19  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
20  * All rights reserved.
21  *
22  * The Original Code is: all of this file.
23  *
24  * Contributor(s): none yet.
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 //
30
31 // Remove the actuator's parent when triggered
32 //
33 // Previously existed as:
34 // \source\gameengine\GameLogic\SCA_EndObjectActuator.cpp
35 // Please look here for revision history.
36
37 #include "SCA_IActuator.h"
38 #include "KX_SCA_EndObjectActuator.h"
39 #include "SCA_IScene.h"
40
41 KX_SCA_EndObjectActuator::KX_SCA_EndObjectActuator(SCA_IObject *gameobj,
42                                                                                                    SCA_IScene* scene):
43         SCA_IActuator(gameobj, KX_ACT_END_OBJECT),
44         m_scene(scene)
45 {
46     // intentionally empty 
47 } /* End of constructor */
48
49
50
51 KX_SCA_EndObjectActuator::~KX_SCA_EndObjectActuator()
52
53         // there's nothing to be done here, really....
54 } /* end of destructor */
55
56
57
58 bool KX_SCA_EndObjectActuator::Update()
59 {
60         // bool result = false; /*unused*/
61         bool bNegativeEvent = IsNegativeEvent();
62         RemoveAllEvents();
63
64         if (bNegativeEvent)
65                 return false; // do nothing on negative events
66         m_scene->DelayedRemoveObject(GetParent());
67         
68         return false;
69 }
70
71
72
73 CValue* KX_SCA_EndObjectActuator::GetReplica()
74 {
75         KX_SCA_EndObjectActuator* replica = 
76                 new KX_SCA_EndObjectActuator(*this);
77         if (replica == NULL) return NULL;
78
79         replica->ProcessReplica();
80         return replica;
81 };
82
83 #ifdef WITH_PYTHON
84
85 /* ------------------------------------------------------------------------- */
86 /* Python functions : integration hooks                                      */
87 /* ------------------------------------------------------------------------- */
88
89 PyTypeObject KX_SCA_EndObjectActuator::Type = {
90         PyVarObject_HEAD_INIT(NULL, 0)
91         "KX_SCA_EndObjectActuator",
92         sizeof(PyObjectPlus_Proxy),
93         0,
94         py_base_dealloc,
95         0,
96         0,
97         0,
98         0,
99         py_base_repr,
100         0,0,0,0,0,0,0,0,0,
101         Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
102         0,0,0,0,0,0,0,
103         Methods,
104         0,
105         0,
106         &SCA_IActuator::Type,
107         0,0,0,0,0,0,
108         py_base_new
109 };
110
111 PyMethodDef KX_SCA_EndObjectActuator::Methods[] = {
112   {NULL,NULL} //Sentinel
113 };
114
115 PyAttributeDef KX_SCA_EndObjectActuator::Attributes[] = {
116         { NULL }        //Sentinel
117 };
118
119 #endif // WITH_PYTHON
120
121 /* eof */