Difference between revisions of "Player Functions"

From theFarWilds
Jump to: navigation, search
m
(Constructors)
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Scripting]]
+
[[Category:Scripts]]
Player Functions are called on the Player object. For example
+
Each '''player object''' represents a human or ai player.
  
  Player player=getAIPlayer(0);
+
== Constructors ==
  player.drawCard();
+
  Player '''getAIPlayer'''( int index );
 +
   
 +
Player '''getHumanPlayer'''( int index );
 +
 +
Player '''getPlayer'''( int index );
  
List of functions:
+
== Methods ==
 
  bool '''isValid'''();
 
  bool '''isValid'''();
  void '''addToHand'''(string cardName)
+
  void '''addToDeck'''(string cardName,int index)
+
bool '''isHuman'''();
  Card '''getDeckCard'''(int index)
+
  Card '''getHandCard'''(int index)
+
  void '''addToHand'''( string cardName );
  void '''removeHandCard'''(int index)
+
  void '''removeDeckCard'''(int index)
+
  void '''addToDeck'''( string cardName, int index );
  void '''drawCard'''()
+
  void '''shuffleDeck'''()
+
  Card '''getDeckCard'''( int index );
  int '''deckSize'''()
+
  int '''handSize'''()
+
  Card '''getHandCard'''( int index );
  void '''addFlux'''(int delta)
+
  void '''addGlory'''(int delta)
+
  void '''removeHandCard'''( int index );
  int '''getFlux'''()
+
  int '''getGlory'''()
+
  void '''removeDeckCard'''( int index );
  void '''setTeam'''(int teamID);
+
  // note: teamID 0 is no team
+
  void '''drawCard'''();
 +
 +
  void '''shuffleDeck'''();
 +
 +
  int '''deckSize'''();
 +
 +
  int '''handSize'''();
 +
 +
  void '''addFlux'''( int delta );
 +
 +
  void '''addGlory'''( int delta );
 +
 +
  int '''getFlux'''();
 +
 +
  int '''getGlory'''();
 +
 +
  void '''setTeam'''( int teamId );
 +
  // set to zero for no team

Latest revision as of 02:05, 13 April 2010

Each player object represents a human or ai player.

Constructors

Player getAIPlayer( int index );

Player getHumanPlayer( int index );

Player getPlayer( int index );

Methods

bool isValid();

bool isHuman();

void addToHand( string cardName );

void addToDeck( string cardName, int index );

Card getDeckCard( int index );

Card getHandCard( int index );

void removeHandCard( int index );

void removeDeckCard( int index );

void drawCard();

void shuffleDeck();

int deckSize();

int handSize();

void addFlux( int delta );

void addGlory( int delta );

int getFlux();

int getGlory();

void setTeam( int teamId );
// set to zero for no team