Global Functions - Revision history

Altren at 03:21, 27 October 2013

2013-10-27T03:21:55Z

Altren at 10:07, 24 June 2013

2013-06-24T10:07:41Z

Altren at 00:23, 31 May 2010

2010-05-31T00:23:13Z

Jed at 01:54, 8 May 2010

2010-05-08T01:54:29Z

Jed at 11:24, 18 April 2010

2010-04-18T11:24:33Z

Jed at 16:04, 5 April 2010

2010-04-05T16:04:57Z

Jed at 13:02, 5 April 2010

2010-04-05T13:02:39Z

Queeshai at 21:52, 3 April 2010

2010-04-03T21:52:06Z

Queeshai at 19:16, 3 April 2010

2010-04-03T19:16:40Z

Jed at 16:16, 27 March 2010

2010-03-27T16:16:02Z

@@ Line 59: / Line 59: @@
   // Talk to Altren or Grug if you want to use these
   // this is not going to work until campaigns are manually registered by Altren or Grug
-  int getCampID();
+  int '''getCampID()''';
-  void saveData(Player,int key,int value);
+  void '''saveData'''(Player,int key,int value);
-  int loadData(Player,int key);
+  int '''loadData'''(Player,int key);

@@ Line 57: / Line 57: @@
   // Functions for persisting data from game to game for a particular user
-  // Talk to Jed if you want to use these
+  // Talk to Altren or Grug if you want to use these
   int getCampID();
   void saveData(Player,int key,int value);
   int loadData(Player,int key);

@@ Line 57: / Line 57: @@
   // Functions for persisting data from game to game for a particular user
-  // Talk to me if you want to use these
+  // Talk to Jed if you want to use these
   int getCampID();
   void saveData(Player,int key,int value);
   int loadData(Player,int key);

← Older revision		Revision as of 01:54, 8 May 2010
Line 55:		Line 55:
	// sets the a range of spaces to light fog. A box from x1,y1 to x2,y2		// sets the a range of spaces to light fog. A box from x1,y1 to x2,y2
	// wont have any effect if called in configGame or beforeStart		// wont have any effect if called in configGame or beforeStart
		+
		+	// Functions for persisting data from game to game for a particular user
		+	// Talk to me if you want to use these
		+	int getCampID();
		+	void saveData(Player,int key,int value);
		+	int loadData(Player,int key);

← Older revision		Revision as of 11:24, 18 April 2010
Line 48:		Line 48:

	void '''wipeEffect'''();		void '''wipeEffect'''();
		+
		+	void '''fogMap'''();
		+	// All spaces are returned to deep fog for all players
		+
		+	void '''lightFog'''(Player player,int x1 ,int y1,int x2,int y2);
		+	// sets the a range of spaces to light fog. A box from x1,y1 to x2,y2
		+	// wont have any effect if called in configGame or beforeStart

@@ Line 7: / Line 7: @@
   Location '''createLocation'''( int x, int y );
   Player '''getAIPlayer'''( int index );
@@ Line 15: / Line 18: @@
   int '''getTopo'''( Location loc );
   int '''getVeg'''( Location loc );
-  // topo: ocean=1, soggy=2, flat=3, hills=4, mountain=5
+  // topo: OCEAN=1, SOGGY=2, FLAT=3, HILLS=4, MOUNTAIN=5
-  // veg: desert=1 ,grass=2 ,forest=3
+  // veg: DESERT=1 ,GRASS=2 ,TREES=3
   [[Entity_Functions|Entity]] '''getFigure'''( Location loc );

@@ Line 2: / Line 2: @@
 '''Global functions''' can be called from anywhere in your scripts.
-  Entity '''createEntity'''( string CardName, int x_coord, int y_coord, Player controller );
+  [[Entity_Functions|Entity]] '''createEntity'''( string CardName, int x_coord, int y_coord, Player controller );
-  Entity '''createEntity'''( string CardName,Location loc, Player controller );
+  [[Entity_Functions|Entity]] '''createEntity'''( string CardName,Location loc, Player controller );
-  Entity '''createEntity'''( string CardName,Location loc );
+  [[Entity_Functions|Entity]] '''createEntity'''( string CardName,Location loc );
   Location '''createLocation'''( int x, int y );
@@ Line 18: / Line 18: @@
   // veg: desert=1 ,grass=2 ,forest=3
-  Entity '''getFigure'''( Location loc );
+  [[Entity_Functions|Entity]] '''getFigure'''( Location loc );
   void '''forEachEntity'''();
-  // call [[Hook Functions|entityCallback()]] once for each Entity in the game.
+  // call [[Hook Functions|entityCallback()]] once for each [[Entity_Functions|Entity]] in the game.
-  void '''enchantEntity'''( Entity toEnchant, string enchantName, Player enchantController );
+  void '''enchantEntity'''( [[Entity_Functions|Entity]] toEnchant, string enchantName, Player enchantController );
   void '''endGame'''( Player winner );

@@ Line 31: / Line 31: @@
   // doesn't preserve global variables yet
-  int rand( int max );
+  int '''rand'''( int max );
   // return an integer from 0 to max-1
-  bool randChance( float chance );
+  bool '''randChance'''( float chance );
   // return true with probability equal to chance

@@ Line 1: / Line 1: @@
-[[Scripting]]
+[[Category:Scripts]]
-Global Functions that you can call from your scripts:
+'''Global functions''' can be called from anywhere in your scripts.
-  Entity '''createEntity'''(string CardName, int x_coord , int y_coord,Player controller );
+  Entity '''createEntity'''( string CardName, int x_coord, int y_coord, Player controller );
-  Entity '''createEntity'''(string CardName ,Location loc,Player controller);
+  Entity '''createEntity'''( string CardName,Location loc, Player controller );
-  Entity '''createEntity'''(string CardName ,Location loc);
+  Entity '''createEntity'''( string CardName,Location loc );
-  Location '''createLocation'''(int x,int y);
+  Location '''createLocation'''( int x, int y );
-  Player '''getAIPlayer'''(int index)
+  Player '''getAIPlayer'''( int index );
- Player '''getHumanPlayer'''(int index)
-  void '''setTerrain'''(Location loc,int topo,int veg)
+ Player '''getHumanPlayer'''( int index );
   int '''getTopo'''(Location loc);
-  int '''getVeg'''(Location loc);
+  void '''setTerrain'''( Location loc, int topo, int veg );
   // topo: ocean=1, soggy=2, flat=3, hills=4, mountain=5
   // veg: desert=1 ,grass=2 ,forest=3
-  Entity '''getFigure'''(Location where);
+  Entity '''getFigure'''( Location loc );
   void '''forEachEntity'''();
-  // this will cause the game to call the entityCallback() function you write
+  // call [[Hook Functions|entityCallback()]] once for each Entity in the game.
- // once for each Entity in the game.
-  void '''enchantEntity'''(Entity toEnchant,string enchantName,Player enchantController);
+  void '''enchantEntity'''( Entity toEnchant, string enchantName, Player enchantController );
-−
-  void '''endGame'''(Player winner);
+  void '''endGame'''( Player winner );
   void '''flipTheScript'''(int scriptID);
   // changes what script is being used for the game
   // doesn't preserve global variables yet
-  int rand(int max);
+  int rand( int max );
-  // returns an int from 0 to max-1
+  // return an integer from 0 to max-1
- bool randChance(float chance);
- // returns true with probability equal to chance
-  void '''infoBox'''(string title,string text);
+ bool randChance( float chance );
-  // displays text in a pop up box to all the players
+ // return true with probability equal to chance
   void '''statusMsg'''(Player from,string msg);
   // Prints a message from a player in the battle log.
   // just pass an empty player to make the message from the server
   void '''wipeEffect'''();