orx  stable
Portable Game Engine
orxSpawner.h
Go to the documentation of this file.
1 /* Orx - Portable Game Engine
2  *
3  * Copyright (c) 2008-2017 Orx-Project
4  *
5  * This software is provided 'as-is', without any express or implied
6  * warranty. In no event will the authors be held liable for any damages
7  * arising from the use of this software.
8  *
9  * Permission is granted to anyone to use this software for any purpose,
10  * including commercial applications, and to alter it and redistribute it
11  * freely, subject to the following restrictions:
12  *
13  * 1. The origin of this software must not be misrepresented; you must not
14  * claim that you wrote the original software. If you use this software
15  * in a product, an acknowledgment in the product documentation would be
16  * appreciated but is not required.
17  *
18  * 2. Altered source versions must be plainly marked as such, and must not be
19  * misrepresented as being the original software.
20  *
21  * 3. This notice may not be removed or altered from any source
22  * distribution.
23  */
24 
44 #ifndef _orxSPAWNER_H_
45 #define _orxSPAWNER_H_
46 
47 
48 #include "orxInclude.h"
49 
50 #include "object/orxStructure.h"
51 #include "object/orxFrame.h"
52 
53 
56 #define orxSPAWNER_KU32_FLAG_NONE 0x00000000
58 #define orxSPAWNER_KU32_FLAG_AUTO_DELETE 0x00000001
59 #define orxSPAWNER_KU32_FLAG_AUTO_RESET 0x00000002
60 #define orxSPAWNER_KU32_FLAG_USE_ALPHA 0x00000004
61 #define orxSPAWNER_KU32_FLAG_USE_COLOR 0x00000008
62 #define orxSPAWNER_KU32_FLAG_USE_ROTATION 0x00000010
63 #define orxSPAWNER_KU32_FLAG_USE_SCALE 0x00000020
64 #define orxSPAWNER_KU32_FLAG_USE_RELATIVE_SPEED 0x00000040
65 #define orxSPAWNER_KU32_FLAG_USE_SELF_AS_PARENT 0x00000080
66 #define orxSPAWNER_KU32_FLAG_CLEAN_ON_DELETE 0x00000100
67 #define orxSPAWNER_KU32_FLAG_INTERPOLATE 0x00000200
69 #define orxSPAWNER_KU32_MASK_USER_ALL 0x000000FF
74 typedef enum __orxSPAWNER_EVENT_t
75 {
83 
85 
86  orxSPAWNER_EVENT_NONE = orxENUM_NONE
87 
89 
90 
92 typedef struct __orxSPAWNER_t orxSPAWNER;
93 
94 
97 extern orxDLLAPI void orxFASTCALL orxSpawner_Setup();
98 
102 extern orxDLLAPI orxSTATUS orxFASTCALL orxSpawner_Init();
103 
106 extern orxDLLAPI void orxFASTCALL orxSpawner_Exit();
107 
111 extern orxDLLAPI orxSPAWNER *orxFASTCALL orxSpawner_Create();
112 
117 extern orxDLLAPI orxSPAWNER *orxFASTCALL orxSpawner_CreateFromConfig(const orxSTRING _zConfigID);
118 
123 extern orxDLLAPI orxSTATUS orxFASTCALL orxSpawner_Delete(orxSPAWNER *_pstSpawner);
124 
129 extern orxDLLAPI void orxFASTCALL orxSpawner_Enable(orxSPAWNER *_pstSpawner, orxBOOL _bEnable);
130 
135 extern orxDLLAPI orxBOOL orxFASTCALL orxSpawner_IsEnabled(const orxSPAWNER *_pstSpawner);
136 
137 
141 extern orxDLLAPI void orxFASTCALL orxSpawner_Reset(orxSPAWNER *_pstSpawner);
142 
148 extern orxDLLAPI orxSTATUS orxFASTCALL orxSpawner_SetTotalObjectLimit(orxSPAWNER *_pstSpawner, orxU32 _u32TotalObjectLimit);
149 
155 extern orxDLLAPI orxSTATUS orxFASTCALL orxSpawner_SetActiveObjectLimit(orxSPAWNER *_pstSpawner, orxU32 _u32ActiveObjectLimit);
156 
161 extern orxDLLAPI orxU32 orxFASTCALL orxSpawner_GetTotalObjectLimit(const orxSPAWNER *_pstSpawner);
162 
167 extern orxDLLAPI orxU32 orxFASTCALL orxSpawner_GetActiveObjectLimit(const orxSPAWNER *_pstSpawner);
168 
173 extern orxDLLAPI orxU32 orxFASTCALL orxSpawner_GetTotalObjectCounter(const orxSPAWNER *_pstSpawner);
174 
179 extern orxDLLAPI orxU32 orxFASTCALL orxSpawner_GetActiveObjectCounter(const orxSPAWNER *_pstSpawner);
180 
181 
187 extern orxDLLAPI orxSTATUS orxFASTCALL orxSpawner_SetWaveSize(orxSPAWNER *_pstSpawner, orxU32 _u32WaveSize);
188 
194 extern orxDLLAPI orxSTATUS orxFASTCALL orxSpawner_SetWaveDelay(orxSPAWNER *_pstSpawner, orxFLOAT _fWaveDelay);
195 
200 extern orxDLLAPI orxU32 orxFASTCALL orxSpawner_GetWaveSize(const orxSPAWNER *_pstSpawner);
201 
206 extern orxDLLAPI orxFLOAT orxFASTCALL orxSpawner_GetWaveDelay(const orxSPAWNER *_pstSpawner);
207 
212 extern orxDLLAPI orxFLOAT orxFASTCALL orxSpawner_GetNextWaveDelay(const orxSPAWNER *_pstSpawner);
213 
214 
220 extern orxDLLAPI orxSTATUS orxFASTCALL orxSpawner_SetObjectSpeed(orxSPAWNER *_pstSpawner, const orxVECTOR *_pvObjectSpeed);
221 
227 extern orxDLLAPI orxVECTOR *orxFASTCALL orxSpawner_GetObjectSpeed(const orxSPAWNER *_pstSpawner, orxVECTOR *_pvObjectSpeed);
228 
229 
235 extern orxDLLAPI orxU32 orxFASTCALL orxSpawner_Spawn(orxSPAWNER *_pstSpawner, orxU32 _u32Number);
236 
237 
242 extern orxDLLAPI orxFRAME *orxFASTCALL orxSpawner_GetFrame(const orxSPAWNER *_pstSpawner);
243 
244 
250 extern orxDLLAPI orxSTATUS orxFASTCALL orxSpawner_SetPosition(orxSPAWNER *_pstSpawner, const orxVECTOR *_pvPosition);
251 
257 extern orxDLLAPI orxSTATUS orxFASTCALL orxSpawner_SetRotation(orxSPAWNER *_pstSpawner, orxFLOAT _fRotation);
258 
264 extern orxDLLAPI orxSTATUS orxFASTCALL orxSpawner_SetScale(orxSPAWNER *_pstSpawner, const orxVECTOR *_pvScale);
265 
271 extern orxDLLAPI orxVECTOR *orxFASTCALL orxSpawner_GetPosition(const orxSPAWNER *_pstSpawner, orxVECTOR *_pvPosition);
272 
278 extern orxDLLAPI orxVECTOR *orxFASTCALL orxSpawner_GetWorldPosition(const orxSPAWNER *_pstSpawner, orxVECTOR *_pvPosition);
279 
284 extern orxDLLAPI orxFLOAT orxFASTCALL orxSpawner_GetRotation(const orxSPAWNER *_pstSpawner);
285 
290 extern orxDLLAPI orxFLOAT orxFASTCALL orxSpawner_GetWorldRotation(const orxSPAWNER *_pstSpawner);
291 
297 extern orxDLLAPI orxVECTOR *orxFASTCALL orxSpawner_GetScale(const orxSPAWNER *_pstSpawner, orxVECTOR *_pvScale);
298 
304 extern orxDLLAPI orxVECTOR *orxFASTCALL orxSpawner_GetWorldScale(const orxSPAWNER *_pstSpawner, orxVECTOR *_pvScale);
305 
306 
312 extern orxDLLAPI orxSTATUS orxFASTCALL orxSpawner_SetParent(orxSPAWNER *_pstSpawner, void *_pParent);
313 
318 extern orxDLLAPI orxSTRUCTURE *orxFASTCALL orxSpawner_GetParent(const orxSPAWNER *_pstSpawner);
319 
320 
325 extern orxDLLAPI const orxSTRING orxFASTCALL orxSpawner_GetName(const orxSPAWNER *_pstSpawner);
326 
327 #endif /* _orxSPAWNER_H_ */
328 
orxDLLAPI orxFLOAT orxFASTCALL orxSpawner_GetRotation(const orxSPAWNER *_pstSpawner)
orxDLLAPI orxSTATUS orxFASTCALL orxSpawner_SetWaveSize(orxSPAWNER *_pstSpawner, orxU32 _u32WaveSize)
orxDLLAPI orxSTRUCTURE *orxFASTCALL orxSpawner_GetParent(const orxSPAWNER *_pstSpawner)
orxDLLAPI orxVECTOR *orxFASTCALL orxSpawner_GetObjectSpeed(const orxSPAWNER *_pstSpawner, orxVECTOR *_pvObjectSpeed)
orxDLLAPI orxU32 orxFASTCALL orxSpawner_GetActiveObjectLimit(const orxSPAWNER *_pstSpawner)
struct __orxFRAME_t orxFRAME
Definition: orxFrame.h:92
orxDLLAPI orxSTATUS orxFASTCALL orxSpawner_SetPosition(orxSPAWNER *_pstSpawner, const orxVECTOR *_pvPosition)
orxDLLAPI orxSTATUS orxFASTCALL orxSpawner_Init()
orxDLLAPI orxU32 orxFASTCALL orxSpawner_GetTotalObjectLimit(const orxSPAWNER *_pstSpawner)
orxDLLAPI orxVECTOR *orxFASTCALL orxSpawner_GetScale(const orxSPAWNER *_pstSpawner, orxVECTOR *_pvScale)
orxDLLAPI orxSTATUS orxFASTCALL orxSpawner_SetRotation(orxSPAWNER *_pstSpawner, orxFLOAT _fRotation)
orxDLLAPI orxFLOAT orxFASTCALL orxSpawner_GetWorldRotation(const orxSPAWNER *_pstSpawner)
orxDLLAPI orxU32 orxFASTCALL orxSpawner_Spawn(orxSPAWNER *_pstSpawner, orxU32 _u32Number)
orxDLLAPI void orxFASTCALL orxSpawner_Exit()
orxDLLAPI orxSPAWNER *orxFASTCALL orxSpawner_CreateFromConfig(const orxSTRING _zConfigID)
orxDLLAPI const orxSTRING orxFASTCALL orxSpawner_GetName(const orxSPAWNER *_pstSpawner)
orxDLLAPI orxVECTOR *orxFASTCALL orxSpawner_GetPosition(const orxSPAWNER *_pstSpawner, orxVECTOR *_pvPosition)
orxDLLAPI orxFLOAT orxFASTCALL orxSpawner_GetWaveDelay(const orxSPAWNER *_pstSpawner)
orxDLLAPI orxSTATUS orxFASTCALL orxSpawner_SetScale(orxSPAWNER *_pstSpawner, const orxVECTOR *_pvScale)
orxDLLAPI orxU32 orxFASTCALL orxSpawner_GetTotalObjectCounter(const orxSPAWNER *_pstSpawner)
orxSTATUS
Definition: orxType.h:243
orxDLLAPI orxSTATUS orxFASTCALL orxSpawner_SetTotalObjectLimit(orxSPAWNER *_pstSpawner, orxU32 _u32TotalObjectLimit)
orxDLLAPI orxSTATUS orxFASTCALL orxSpawner_SetWaveDelay(orxSPAWNER *_pstSpawner, orxFLOAT _fWaveDelay)
orxDLLAPI orxSTATUS orxFASTCALL orxSpawner_SetObjectSpeed(orxSPAWNER *_pstSpawner, const orxVECTOR *_pvObjectSpeed)
orxDLLAPI orxSPAWNER *orxFASTCALL orxSpawner_Create()
orxDLLAPI orxFLOAT orxFASTCALL orxSpawner_GetNextWaveDelay(const orxSPAWNER *_pstSpawner)
orxDLLAPI orxVECTOR *orxFASTCALL orxSpawner_GetWorldScale(const orxSPAWNER *_pstSpawner, orxVECTOR *_pvScale)
orxDLLAPI orxVECTOR *orxFASTCALL orxSpawner_GetWorldPosition(const orxSPAWNER *_pstSpawner, orxVECTOR *_pvPosition)
orxDLLAPI void orxFASTCALL orxSpawner_Reset(orxSPAWNER *_pstSpawner)
orxSPAWNER_EVENT
Definition: orxSpawner.h:74
#define orxDLLAPI
Definition: orxDecl.h:387
orxDLLAPI orxU32 orxFASTCALL orxSpawner_GetActiveObjectCounter(const orxSPAWNER *_pstSpawner)
orxDLLAPI orxFRAME *orxFASTCALL orxSpawner_GetFrame(const orxSPAWNER *_pstSpawner)
orxDLLAPI void orxFASTCALL orxSpawner_Enable(orxSPAWNER *_pstSpawner, orxBOOL _bEnable)
orxDLLAPI orxSTATUS orxFASTCALL orxSpawner_SetParent(orxSPAWNER *_pstSpawner, void *_pParent)
orxDLLAPI orxU32 orxFASTCALL orxSpawner_GetWaveSize(const orxSPAWNER *_pstSpawner)
orxDLLAPI void orxFASTCALL orxSpawner_Setup()
struct __orxSPAWNER_t orxSPAWNER
Definition: orxSpawner.h:92
orxDLLAPI orxSTATUS orxFASTCALL orxSpawner_Delete(orxSPAWNER *_pstSpawner)
orxDLLAPI orxSTATUS orxFASTCALL orxSpawner_SetActiveObjectLimit(orxSPAWNER *_pstSpawner, orxU32 _u32ActiveObjectLimit)
orxDLLAPI orxBOOL orxFASTCALL orxSpawner_IsEnabled(const orxSPAWNER *_pstSpawner)

Generated for orx by doxygen 1.5.6