____                _       __
    / __ )____  _____   | |     / /___ ___________
   / __  / __ \/ ___/   | | /| / / __ `/ ___/ ___/
  / /_/ / /_/ (__  )    | |/ |/ / /_/ / /  (__  )
 /_____/\____/____/     |__/|__/\__,_/_/  /____/

       A futuristic real-time strategy game.
          This file is part of Bos Wars.
(C) Copyright 2001-2007 by the Bos Wars and Stratagus Project. Distributed under the "GNU General Public License"

trigger.h File Reference

The game trigger headerfile. More...

Go to the source code of this file.

Classes

class  CTimer
struct  TriggerDataType

Defines

#define ANY_UNIT   ((const CUnitType *)0)
#define ALL_UNITS   ((const CUnitType *)-1)
#define ALL_FOODUNITS   ((const CUnitType *)-2)
#define ALL_BUILDINGS   ((const CUnitType *)-3)

Functions

int TriggerGetPlayer (lua_State *l)
 get player number.
const CUnitTypeTriggerGetUnitType (lua_State *l)
 get the unit-type
void TriggersEachCycle (void)
 test triggers
void TriggerCclRegister (void)
 Register ccl features.
void SaveTriggers (CFile *file)
 Save the trigger module.
void InitTriggers (void)
 Setup triggers.
void CleanTriggers (void)
 Cleanup the trigger module.

Variables

CTimer GameTimer
 the game timer
TriggerDataType TriggerData
 Some data accessible for script during the game.


Detailed Description

The game trigger headerfile.

Definition in file trigger.h.


Define Documentation

#define ALL_BUILDINGS   ((const CUnitType *)-3)

#define ALL_FOODUNITS   ((const CUnitType *)-2)

#define ALL_UNITS   ((const CUnitType *)-1)

Definition at line 66 of file trigger.h.

Referenced by TriggerGetUnitType().

#define ANY_UNIT   ((const CUnitType *)0)


Function Documentation

void CleanTriggers ( void   ) 

Cleanup the trigger module.

Clean up the trigger module.

Definition at line 778 of file trigger.cpp.

References ActiveTriggers, Lua, CTimer::Reset(), and Trigger.

Referenced by CleanGame(), and CleanModules().

void InitTriggers ( void   ) 

Setup triggers.

Initialize the trigger module.

Definition at line 758 of file trigger.cpp.

References Lua, and LuaCall().

Referenced by CreateGame(), and InitModules().

void SaveTriggers ( CFile file  ) 

Save the trigger module.

Save the trigger module.

Parameters:
file Open file to print to

Definition at line 720 of file trigger.cpp.

References CTimer::Cycles, CTimer::Increasing, CTimer::Init, Lua, CFile::printf(), CTimer::Running, and Trigger.

Referenced by SaveGame().

void TriggerCclRegister ( void   ) 

Register ccl features.

Register CCL features for triggers.

Definition at line 705 of file trigger.cpp.

References CclAddTrigger(), CclGetNumUnitsAt(), CclIfNearUnit(), CclIfRescuedNearUnit(), CclSetActiveTriggers(), and Lua.

Referenced by InitCcl().

int TriggerGetPlayer ( lua_State *  l  ) 

get player number.

Get player number.

Parameters:
l Lua state.
Returns:
The player number, -1 matches any.

Definition at line 75 of file trigger.cpp.

References _C_, CPlayer::Index, LuaError, LuaToNumber(), LuaToString(), PlayerMax, and ThisPlayer.

Referenced by CclCreateUnit(), CclGetUnits(), CclIfNearUnit(), CclIfRescuedNearUnit(), CclKillUnit(), CclKillUnitAt(), and CclOrderUnit().

const CUnitType* TriggerGetUnitType ( lua_State *  l  ) 

get the unit-type

Get the unit-type.

Parameters:
l Lua state.
Returns:
The unit-type pointer.

Definition at line 105 of file trigger.cpp.

References ALL_BUILDINGS, ALL_FOODUNITS, ALL_UNITS, ANY_UNIT, CclGetUnitType(), and LuaToString().

Referenced by CclGetNumUnitsAt(), CclIfNearUnit(), CclIfRescuedNearUnit(), CclKillUnit(), CclKillUnitAt(), and CclOrderUnit().

void TriggersEachCycle ( void   ) 

test triggers

Check trigger each game cycle.

Definition at line 659 of file trigger.cpp.

References GamePaused, Lua, LuaCall(), Trigger, TriggerExecuteAction(), and TriggerRemoveTrigger().

Referenced by GameMainLoop().


Variable Documentation

the game timer

Definition at line 56 of file trigger.cpp.

Referenced by DrawTimer(), and UpdateTimer().

Some data accessible for script during the game.

Definition at line 61 of file trigger.cpp.


Generated on Sat Feb 21 00:28:21 2009 for Bos Wars by  doxygen 1.5.6