orxTrigger.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 _orxTRIGGER_H_
#define _orxTRIGGER_H_
 
 
#include "orxInclude.h"
#include "object/orxStructure.h"
 

#define orxTRIGGER_KC_SEPARATOR                 ':'
#define orxTRIGGER_KC_STOP_MARKER               '!'
 

typedef struct __orxTRIGGER_t                   orxTRIGGER;
 

typedef enum __orxTRIGGER_EVENT_t
{
  orxTRIGGER_EVENT_SET_ADD = 0,                 
  orxTRIGGER_EVENT_SET_REMOVE,                  
  orxTRIGGER_EVENT_FIRE,                        
 
  orxTRIGGER_EVENT_NUMBER,
 
  orxTRIGGER_EVENT_NONE = orxENUM_NONE
 
} orxTRIGGER_EVENT;

typedef struct __orxTRIGGER_EVENT_PAYLOAD_t
{
  orxTRIGGER       *pstTrigger;                 
  const orxSTRING   zSetName;                   
  const orxSTRING   zEventName;                 
  const orxSTRING   zEventValue;                
  const orxSTRING  *azRefinementList;           
  orxU32            u32RefinementCount;         
  orxU32            u32RefinementIndex;         
} orxTRIGGER_EVENT_PAYLOAD;
 

extern orxDLLAPI void orxFASTCALL               orxTrigger_Setup();

extern orxDLLAPI orxSTATUS orxFASTCALL          orxTrigger_Init();

extern orxDLLAPI void orxFASTCALL               orxTrigger_Exit();

extern orxDLLAPI orxTRIGGER *orxFASTCALL        orxTrigger_Create();

extern orxDLLAPI orxSTATUS orxFASTCALL          orxTrigger_Delete(orxTRIGGER *_pstTrigger);

extern orxDLLAPI orxSTATUS orxFASTCALL          orxTrigger_ClearCache();

extern orxDLLAPI void orxFASTCALL               orxTrigger_Enable(orxTRIGGER *_pstTrigger, orxBOOL _bEnable);

extern orxDLLAPI orxBOOL orxFASTCALL            orxTrigger_IsEnabled(const orxTRIGGER *_pstTrigger);

extern orxDLLAPI orxSTATUS orxFASTCALL          orxTrigger_AddSetFromConfig(orxTRIGGER *_pstTrigger, const orxSTRING _zConfigID);

extern orxDLLAPI orxSTATUS orxFASTCALL          orxTrigger_RemoveSetFromConfig(orxTRIGGER *_pstTrigger, const orxSTRING _zConfigID);

extern orxDLLAPI orxU32 orxFASTCALL             orxTrigger_GetCount(const orxTRIGGER *_pstTrigger);

extern orxDLLAPI orxSTATUS orxFASTCALL          orxTrigger_Fire(orxTRIGGER *_pstTrigger, const orxSTRING _zEvent, const orxSTRING *_azRefinementList, orxU32 _u32Count);
 
#endif /* _orxTRIGGER_H_ */