Difference between revisions of "Hook Functions"

From theFarWilds
Jump to: navigation, search
Line 8: Line 8:
 
  void '''beforeStart'''();  
 
  void '''beforeStart'''();  
 
  // Do things here before any action. Place creatures and buildings, change their decks etc.
 
  // Do things here before any action. Place creatures and buildings, change their decks etc.
 +
 +
void '''afterStart'''();
 +
// Send any welcome messages here
 
   
 
   
 
  void '''onNewRound'''();
 
  void '''onNewRound'''();

Revision as of 16:15, 27 March 2010

Scripting These are functions you can implement in your scripts. They are call at the appropriate times by the game.

void configGame(); 
// Sets up the game state such as # of players, Map Size, if they need to set a deck or not, etc
Config Functions

void beforeStart(); 
// Do things here before any action. Place creatures and buildings, change their decks etc.

void afterStart();
// Send any welcome messages here

void onNewRound();
// called after all the new round events

bool entityCallback(Entity entity)
// called for each entity in the game if you call forEachEntity();

void onDialogResponse(Player player,int resp);
void afterAction(); // not yet

void onPlayersTurn(Player player);  // not yet

bool canPass(Player player); // not yet
// called when the real players try to pass. 
// This is so you can ensure they do a particular action before passing.