blender/source/gameengine/Ketsji/KX_StateActuator.h
Benoit Bolsee 9a40f4d2a6 BGE: bookmark option on controller to make them run before all other controllers.
A new bookmark button is available on the controller UI. 
When set, the controller is guaranteed to execute before all
other non-bookmarked controllers, provided it is scheduled 
for execution. 

This is useful for initialization scripts that run once at startup or
scripts that must set some prerequisite for the other controllers at
the start of each logic frame.

This feature is also available at python level with the "bookmark"
attribute. It can be changed during the game.

Note that if several script are bookmarked, their relative order of 
execution is not guaranteed. Make sure they don't depend on each other.
2009-05-17 21:50:31 +00:00

103 lines
2.6 KiB
C++

/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*
* The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
* All rights reserved.
*
* The Original Code is: all of this file.
*
* Contributor(s): none yet.
*
* ***** END GPL LICENSE BLOCK *****
* Actuator to toggle visibility/invisibility of objects
*/
#ifndef __KX_STATEACTUATOR
#define __KX_STATEACTUATOR
#include "SCA_IActuator.h"
/*
* Use of SG_DList : element of actuator being deactivated
* Head: SCA_LogicManager::m_removedActuators
* Use of SG_QList : element of global activated state actuator list
* Head: KX_StateActuator::m_stateActuatorHead
*/
class KX_StateActuator : public SCA_IActuator
{
Py_Header;
/** Make visible? */
enum {
OP_NOP = -1,
OP_CPY = 0,
OP_SET,
OP_CLR,
OP_NEG,
OP_COUNT
};
// SG_Dlist: element of objects with active actuators, always put in front of the list
// Head: SCA_LogicManager::m_activeActuators
// SG_QList: Head of active state actuators list globally
// Elements: KX_StateActuator
static SG_QList m_stateActuatorHead;
int m_operation;
int m_mask;
public:
KX_StateActuator(
SCA_IObject* gameobj,
int operation,
unsigned int mask,
PyTypeObject* T=&Type
);
virtual
~KX_StateActuator(
void
);
virtual CValue*
GetReplica(
void
);
virtual bool
Update();
virtual void Deactivate();
virtual void Activate(SG_DList& head);
/* --------------------------------------------------------------------- */
/* Python interface ---------------------------------------------------- */
/* --------------------------------------------------------------------- */
virtual PyObject* py_getattro(PyObject *attr);
virtual PyObject* py_getattro_dict();
virtual int py_setattro(PyObject *attr, PyObject* value);
//KX_PYMETHOD_DOC
KX_PYMETHOD_DOC_VARARGS(KX_StateActuator,SetOperation);
KX_PYMETHOD_DOC_VARARGS(KX_StateActuator,SetMask);
};
#endif