KX_NetworkMessageActuator.cpp

Go to the documentation of this file.

/*
 * ***** 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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 *****
 * Ketsji Logic Extenstion: Network Message Actuator generic implementation
 */

#include <stddef.h>

#include "NG_NetworkScene.h"
#include "KX_NetworkMessageActuator.h"

KX_NetworkMessageActuator::KX_NetworkMessageActuator(
    SCA_IObject* gameobj,       // the actuator controlling object
    NG_NetworkScene* networkscene,  // needed for replication
    const STR_String &toPropName,
    const STR_String &subject,
    int bodyType,
    const STR_String &body) :
    SCA_IActuator(gameobj, KX_ACT_MESSAGE),
    m_networkscene(networkscene),
    m_toPropName(toPropName),
    m_subject(subject),
    m_bPropBody(bodyType),
    m_body(body)
{
}

KX_NetworkMessageActuator::~KX_NetworkMessageActuator()
{
}

// returns true if the actuators needs to be running over several frames
bool KX_NetworkMessageActuator::Update()
{
    //printf("update messageactuator\n");
    bool bNegativeEvent = IsNegativeEvent();
    RemoveAllEvents();

    if (bNegativeEvent) {
        return false; // do nothing on negative events
        //printf("messageactuator false event\n");
    }
    //printf("messageactuator true event\n");

    if (m_bPropBody) // ACT_MESG_PROP in DNA_actuator_types.h
    {
        m_networkscene->SendMessage(
            m_toPropName,
            GetParent()->GetName(),
            m_subject,
            GetParent()->GetPropertyText(m_body));
    } else
    {
        m_networkscene->SendMessage(
            m_toPropName,
            GetParent()->GetName(),
            m_subject,
            m_body);
    }
    return false;
}

CValue* KX_NetworkMessageActuator::GetReplica()
{
    KX_NetworkMessageActuator* replica = new KX_NetworkMessageActuator(*this);
    replica->ProcessReplica();

    return replica;
}

#ifdef WITH_PYTHON

/* -------------------------------------------------------------------- */
/* Python interface --------------------------------------------------- */
/* -------------------------------------------------------------------- */

/* Integration hooks -------------------------------------------------- */
PyTypeObject KX_NetworkMessageActuator::Type = {
    PyVarObject_HEAD_INIT(NULL, 0)
    "KX_NetworkMessageActuator",
    sizeof(PyObjectPlus_Proxy),
    0,
    py_base_dealloc,
    0,
    0,
    0,
    0,
    py_base_repr,
    0,0,0,0,0,0,0,0,0,
    Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
    0,0,0,0,0,0,0,
    Methods,
    0,
    0,
    &SCA_IActuator::Type,
    0,0,0,0,0,0,
    py_base_new
};

PyMethodDef KX_NetworkMessageActuator::Methods[] = {
    {NULL,NULL} // Sentinel
};

PyAttributeDef KX_NetworkMessageActuator::Attributes[] = {
    KX_PYATTRIBUTE_STRING_RW("propName", 0, MAX_PROP_NAME, false, KX_NetworkMessageActuator, m_toPropName),
    KX_PYATTRIBUTE_STRING_RW("subject", 0, 100, false, KX_NetworkMessageActuator, m_subject),
    KX_PYATTRIBUTE_BOOL_RW("usePropBody", KX_NetworkMessageActuator, m_bPropBody),
    KX_PYATTRIBUTE_STRING_RW("body", 0, 16384, false, KX_NetworkMessageActuator, m_body),
    { NULL }    //Sentinel
};

#endif // WITH_PYTHON