Entity Functions - Revision history

Queeshai: moveEntity doesn't exist. fixed to reflect actual method name.

2010-05-10T02:36:33Z

moveEntity doesn't exist. fixed to reflect actual method name.

Jed: /* Methods */

2010-04-14T18:53:21Z

‎Methods

Jed: /* Methods */

2010-04-14T12:46:37Z

‎Methods

Jed: /* Methods */

2010-04-08T01:50:46Z

‎Methods

Jed: /* Constructors */

2010-04-08T01:42:50Z

‎Constructors

Jed at 12:56, 6 April 2010

2010-04-06T12:56:15Z

Jed at 16:06, 5 April 2010

2010-04-05T16:06:18Z

Queeshai at 21:30, 3 April 2010

2010-04-03T21:30:25Z

Queeshai at 21:30, 3 April 2010

2010-04-03T21:30:04Z

Jed at 20:50, 23 March 2010

2010-03-23T20:50:16Z

@@ Line 29: / Line 29: @@
   Location '''getLoc'''();
-  bool '''moveEntity'''( Location );
+  bool '''move'''( Location );
   // returns false if unsuccessful (e.g., trying to move figure into occupied location)

@@ Line 52: / Line 52: @@
   int '''numTokens'''(string tokenName);
   string '''otherName'''();
   // returns the name of the corpse, ruin,
   // or construction site building that this was or will be

@@ Line 45: / Line 45: @@
   // returns the number of that token after the add.
   // delta can be negative
   int '''numTokens'''(string tokenName);

@@ Line 20: / Line 20: @@
   string '''getName'''();
-  Player '''getController'''();
+  [[Player Functions|Player]] '''getController'''();
-  void '''setController'''( Player controller );
+  void '''setController'''( [[Player Functions|Player]] controller );
   bool '''isType'''( int type );

@@ Line 3: / Line 3: @@
 == Constructors ==
-  Entity createEntity( string cardName, int x_coord, int y_coord, Player controller );
+  Entity createEntity( string cardName, int x_coord, int y_coord, [[Player Functions|Player]] controller );
-  Entity createEntity( string cardName, Location loc, Player controller );
+  Entity createEntity( string cardName, Location loc, [[Player Functions|Player]] controller );
   Entity createEntity( string cardName, Location loc );

@@ Line 17: / Line 17: @@
   bool '''doesExist'''();
   // check to see if entity has been removed
-−
   string '''getName'''();
@@ Line 41: / Line 41: @@
   bool '''isDim'''();

@@ Line 25: / Line 25: @@
   bool '''isType'''( int type );
-  // Types: Creature=1, Building=2, Enchantment=3, Item=4, (Corpse,Flux Well,Ruin)=5, World Enchantment=6
+  // Types: CREATURE=1, BUILDING=2, ENCHANTMENT=3, ITEM=4, MARKER(Corpse,Flux Well,Ruin)=5, WORLD_ENCHANT=6
   Location '''getLoc'''();

← Older revision		Revision as of 21:30, 3 April 2010
Line 21:		Line 21:

	Player '''getController'''();		Player '''getController'''();
		+
	void '''setController'''( Player controller );		void '''setController'''( Player controller );

@@ Line 1: / Line 1: @@
-[[Scripting]]
+[[Category:Scripts]]
-Entity Functions are called on the Entity object. For example
+Each '''entity object''' represents a creature, building, enchantment, corpse, or ruin.  Collectively, these objects define the current game state.
-  Entity ent=getFigure(createLocation(3,3));
+== Constructors ==
-  ent.remove();
+  Entity createEntity( string cardName, int x_coord, int y_coord, Player controller );
-List of functions:
+== Methods ==
   bool '''isValid'''();
   bool '''doesExist'''();
-  // isValid will tell you if the Entity returned by some other function is valid
+  // check to see if entity has been removed
- // doesExist can be used where you are holding on to an Entity for awhile
- // it checks to see if it has been removed from the game
- // getName() and other functions will work on an Entity that is valid but doesn't exist
   string '''getName'''();
   Player '''getController'''();
-  void '''setController'''(Player);
+  void '''setController'''( Player controller );
-  bool '''isType'''(int type);
+  bool '''isType'''( int type );
-  // Types: Creature=1, Building=2,Enchantment=3,Item=4,(Corpse,Flux Well,Ruin)=5,World Enchantment=6
+  // Types: Creature=1, Building=2, Enchantment=3, Item=4, (Corpse,Flux Well,Ruin)=5, World Enchantment=6
   Location '''getLoc'''();
   bool '''moveEntity'''(Location);
-  // returns false if it can't move there
+  bool '''moveEntity'''( Location );
   void '''remove'''();
   void '''destroy'''();
   void '''sacrifice'''();
-  void '''setDim'''(bool dimOrNot);
+  void '''setDim'''( bool dimOrNot );
   bool '''isDim'''();