orxSpawner.h

Go to the documentation of this file.

/* Orx - Portable Game Engine
 *
 * Copyright (c) 2008- Orx-Project
 *
 * This software is provided 'as-is', without any express or implied
 * warranty. In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 *    1. The origin of this software must not be misrepresented; you must not
 *    claim that you wrote the original software. If you use this software
 *    in a product, an acknowledgment in the product documentation would be
 *    appreciated but is not required.
 *
 *    2. Altered source versions must be plainly marked as such, and must not be
 *    misrepresented as being the original software.
 *
 *    3. This notice may not be removed or altered from any source
 *    distribution.
 */


 
 
#ifndef _orxSPAWNER_H_
#define _orxSPAWNER_H_
 
 
#include "orxInclude.h"
 
#include "object/orxStructure.h"
#include "object/orxFrame.h"
 

#define orxSPAWNER_KU32_FLAG_NONE                       0x00000000  
 
#define orxSPAWNER_KU32_FLAG_AUTO_DELETE                0x00000001  
#define orxSPAWNER_KU32_FLAG_AUTO_RESET_COUNT           0x00000002  
#define orxSPAWNER_KU32_FLAG_AUTO_RESET_DELAY           0x00000004  
#define orxSPAWNER_KU32_MASK_AUTO_RESET                 0x00000006  
 
#define orxSPAWNER_KU32_FLAG_CLEAN_ON_DELETE            0x00000008  
 
#define orxSPAWNER_KU32_FLAG_USE_ALPHA                  0x00000010  
#define orxSPAWNER_KU32_FLAG_USE_COLOR                  0x00000020  
#define orxSPAWNER_KU32_FLAG_USE_ROTATION               0x00000040  
#define orxSPAWNER_KU32_FLAG_USE_SCALE                  0x00000080  
 
#define orxSPAWNER_KU32_FLAG_USE_RELATIVE_SPEED_OBJECT  0x00000100  
#define orxSPAWNER_KU32_FLAG_USE_RELATIVE_SPEED_SPAWNER 0x00000200  
#define orxSPAWNER_KU32_MASK_USE_RELATIVE_SPEED         0x00000300  
 
#define orxSPAWNER_KU32_FLAG_USE_SELF_AS_PARENT         0x00000400  
#define orxSPAWNER_KU32_FLAG_INTERPOLATE                0x00000800  
 
#define orxSPAWNER_KU32_MASK_USER_ALL                   0x00000FFF  
 

typedef enum __orxSPAWNER_EVENT_t
{
  orxSPAWNER_EVENT_SPAWN = 0,
  orxSPAWNER_EVENT_CREATE,
  orxSPAWNER_EVENT_DELETE,
  orxSPAWNER_EVENT_RESET,
  orxSPAWNER_EVENT_EMPTY,
  orxSPAWNER_EVENT_WAVE_START,
  orxSPAWNER_EVENT_WAVE_STOP,
 
  orxSPAWNER_EVENT_NUMBER,
 
  orxSPAWNER_EVENT_NONE = orxENUM_NONE
 
} orxSPAWNER_EVENT;
 

typedef struct __orxSPAWNER_t               orxSPAWNER;
 

extern orxDLLAPI void orxFASTCALL           orxSpawner_Setup();

extern orxDLLAPI orxSTATUS orxFASTCALL      orxSpawner_Init();

extern orxDLLAPI void orxFASTCALL           orxSpawner_Exit();

extern orxDLLAPI orxSPAWNER *orxFASTCALL    orxSpawner_Create();

extern orxDLLAPI orxSPAWNER *orxFASTCALL    orxSpawner_CreateFromConfig(const orxSTRING _zConfigID);

extern orxDLLAPI orxSTATUS orxFASTCALL      orxSpawner_Delete(orxSPAWNER *_pstSpawner);

extern orxDLLAPI void orxFASTCALL           orxSpawner_Enable(orxSPAWNER *_pstSpawner, orxBOOL _bEnable);

extern orxDLLAPI orxBOOL orxFASTCALL        orxSpawner_IsEnabled(const orxSPAWNER *_pstSpawner);
 

extern orxDLLAPI void orxFASTCALL           orxSpawner_Reset(orxSPAWNER *_pstSpawner, orxBOOL _bResetCount, orxBOOL _bResetTimer);

extern orxDLLAPI orxSTATUS orxFASTCALL      orxSpawner_SetTotalObjectLimit(orxSPAWNER *_pstSpawner, orxU32 _u32TotalObjectLimit);

extern orxDLLAPI orxSTATUS orxFASTCALL      orxSpawner_SetActiveObjectLimit(orxSPAWNER *_pstSpawner, orxU32 _u32ActiveObjectLimit);

extern orxDLLAPI orxU32 orxFASTCALL         orxSpawner_GetTotalObjectLimit(const orxSPAWNER *_pstSpawner);

extern orxDLLAPI orxU32 orxFASTCALL         orxSpawner_GetActiveObjectLimit(const orxSPAWNER *_pstSpawner);

extern orxDLLAPI orxU32 orxFASTCALL         orxSpawner_GetTotalObjectCount(const orxSPAWNER *_pstSpawner);

extern orxDLLAPI orxU32 orxFASTCALL         orxSpawner_GetActiveObjectCount(const orxSPAWNER *_pstSpawner);
 

extern orxDLLAPI orxSTATUS orxFASTCALL      orxSpawner_SetWaveSize(orxSPAWNER *_pstSpawner, orxU32 _u32WaveSize);

extern orxDLLAPI orxSTATUS orxFASTCALL      orxSpawner_SetWaveDelay(orxSPAWNER *_pstSpawner, orxFLOAT _fWaveDelay);

extern orxDLLAPI orxSTATUS orxFASTCALL      orxSpawner_SetNextWaveDelay(orxSPAWNER *_pstSpawner, orxFLOAT _fWaveDelay);

extern orxDLLAPI orxU32 orxFASTCALL         orxSpawner_GetWaveSize(const orxSPAWNER *_pstSpawner);

extern orxDLLAPI orxFLOAT orxFASTCALL       orxSpawner_GetWaveDelay(const orxSPAWNER *_pstSpawner);

extern orxDLLAPI orxFLOAT orxFASTCALL       orxSpawner_GetNextWaveDelay(const orxSPAWNER *_pstSpawner);
 

extern orxDLLAPI orxSTATUS orxFASTCALL      orxSpawner_SetObjectSpeed(orxSPAWNER *_pstSpawner, const orxVECTOR *_pvObjectSpeed);

extern orxDLLAPI orxVECTOR *orxFASTCALL     orxSpawner_GetObjectSpeed(const orxSPAWNER *_pstSpawner, orxVECTOR *_pvObjectSpeed);
 

extern orxDLLAPI orxU32 orxFASTCALL         orxSpawner_Spawn(orxSPAWNER *_pstSpawner, orxU32 _u32Number);
 

extern orxDLLAPI orxFRAME *orxFASTCALL      orxSpawner_GetFrame(const orxSPAWNER *_pstSpawner);
 

extern orxDLLAPI orxSTATUS orxFASTCALL      orxSpawner_SetPosition(orxSPAWNER *_pstSpawner, const orxVECTOR *_pvPosition);

extern orxDLLAPI orxSTATUS orxFASTCALL      orxSpawner_SetRotation(orxSPAWNER *_pstSpawner, orxFLOAT _fRotation);

extern orxDLLAPI orxSTATUS orxFASTCALL      orxSpawner_SetScale(orxSPAWNER *_pstSpawner, const orxVECTOR *_pvScale);

extern orxDLLAPI orxVECTOR *orxFASTCALL     orxSpawner_GetPosition(const orxSPAWNER *_pstSpawner, orxVECTOR *_pvPosition);

extern orxDLLAPI orxVECTOR *orxFASTCALL     orxSpawner_GetWorldPosition(const orxSPAWNER *_pstSpawner, orxVECTOR *_pvPosition);

extern orxDLLAPI orxFLOAT orxFASTCALL       orxSpawner_GetRotation(const orxSPAWNER *_pstSpawner);

extern orxDLLAPI orxFLOAT orxFASTCALL       orxSpawner_GetWorldRotation(const orxSPAWNER *_pstSpawner);

extern orxDLLAPI orxVECTOR *orxFASTCALL     orxSpawner_GetScale(const orxSPAWNER *_pstSpawner, orxVECTOR *_pvScale);

extern orxDLLAPI orxVECTOR *orxFASTCALL     orxSpawner_GetWorldScale(const orxSPAWNER *_pstSpawner, orxVECTOR *_pvScale);
 

extern orxDLLAPI orxSTATUS orxFASTCALL      orxSpawner_SetParent(orxSPAWNER *_pstSpawner, void *_pParent);

extern orxDLLAPI orxSTRUCTURE *orxFASTCALL  orxSpawner_GetParent(const orxSPAWNER *_pstSpawner);
 

extern orxDLLAPI const orxSTRING orxFASTCALL orxSpawner_GetName(const orxSPAWNER *_pstSpawner);
 
#endif /* _orxSPAWNER_H_ */