behaviourlayer/behave.h

/*
    Crystal Space Entity Layer
    Copyright (C) 2001 by Jorrit Tyberghein
  
    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.
  
    This library 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
    Library General Public License for more details.
  
    You should have received a copy of the GNU Library General Public
    License along with this library; if not, write to the Free
    Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/

#ifndef __CEL_BL_BEHAVE__
#define __CEL_BL_BEHAVE__

#include <stdarg.h>
#include "cstypes.h"
#include "csutil/scf.h"
#include "csutil/strhash.h"

#include "physicallayer/datatype.h"

struct iCelBlLayer;
struct iCelPropertyClass;

struct iCelParameterBlock : public virtual iBase
{
  SCF_INTERFACE (iCelParameterBlock, 0, 0, 1);

  virtual size_t GetParameterCount () const = 0;

  virtual csStringID GetParameterDef (size_t idx, celDataType& t) const = 0;

  virtual const celData* GetParameter (csStringID id) const = 0;

  virtual const celData* GetParameterByIndex (size_t idx) const = 0;
};

struct iCelBehaviour : public virtual iBase
{
  SCF_INTERFACE (iCelBehaviour, 0, 0, 2);

  virtual const char* GetName () const = 0;

  virtual iCelBlLayer* GetBehaviourLayer () const = 0;

  virtual bool SendMessage (const char* msg_id,
        iCelPropertyClass* pc,
        celData& ret, iCelParameterBlock* params, ...) = 0;

  virtual bool SendMessageV (const char* msg_id,
        iCelPropertyClass* pc,
        celData& ret, iCelParameterBlock* params, va_list arg) = 0;

  virtual void* GetInternalObject () = 0;
};

#endif // __CEL_BL_BEHAVE__