theFarWilds - User contributions [en]

Entity Functions

2010-05-10T02:36:33Z

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

[[Category:Scripts]]
Each '''entity object''' represents a creature, building, enchantment, corpse, or ruin. Collectively, these objects define the current game state.

== Constructors ==
Entity createEntity( string cardName, int x_coord, int y_coord, [[Player Functions|Player]] controller );

Entity createEntity( string cardName, Location loc, [[Player Functions|Player]] controller );

Entity createEntity( string cardName, Location loc );

See also getFigure( Location loc ).

== Methods ==
bool '''isValid'''();
// check to see if entity was created successfully

bool '''doesExist'''();
// check to see if entity has been removed

string '''getName'''();

[[Player Functions|Player]] '''getController'''();

void '''setController'''( [[Player Functions|Player]] controller );

bool '''isType'''( int type );
// Types: CREATURE=1, BUILDING=2, ENCHANTMENT=3, ITEM=4, MARKER(Corpse,Flux Well,Ruin)=5, WORLD_ENCHANT=6

Location '''getLoc'''();

bool '''move'''( Location );
// returns false if unsuccessful (e.g., trying to move figure into occupied location)

void '''remove'''();

void '''destroy'''();

void '''sacrifice'''();

void '''setDim'''( bool dimOrNot );

bool '''isDim'''();

int '''addTokens'''(string tokenName,int delta);
// returns the number of that token after the add.
// delta can be negative
// some common tokens: attack,maxhp,vision,speed,range
// also: age,work,entrench,sleep,vigor,spawn,soul,termite
// you can look in helpers/counters.xml for a complete list
// Example: ent.addToken("attack",1);
// it is case sensitive

int '''numTokens'''(string tokenName);

int '''getCurHealth'''();

int '''getMaxHealth'''();

string '''otherName'''();
// returns the name of the corpse, ruin,
// or construction site building that this was or will be

Player Functions

2010-04-03T21:57:34Z

Queeshai:

[[Category:Scripts]]
Each '''player object''' represents a human or ai player.

== Constructors ==
Player getAIPlayer( int index );

Player getHumanPlayer( int index );

== Methods ==
bool '''isValid'''();

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

Global Functions

2010-04-03T21:52:06Z

Queeshai:

[[Category: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,Location loc, Player controller );
Entity '''createEntity'''( string CardName,Location loc );

Location '''createLocation'''( int x, int y );

Player '''getAIPlayer'''( int index );

Player '''getHumanPlayer'''( int index );

void '''setTerrain'''( Location loc, int topo, int veg );
int '''getTopo'''( Location loc );
int '''getVeg'''( Location loc );
// topo: ocean=1, soggy=2, flat=3, hills=4, mountain=5
// veg: desert=1 ,grass=2 ,forest=3

Entity '''getFigure'''( Location loc );

void '''forEachEntity'''();
// call [[Hook Functions|entityCallback()]] once for each Entity in the game.

void '''enchantEntity'''( Entity toEnchant, string enchantName, Player enchantController );

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 );
// return an integer from 0 to max-1

bool '''randChance'''( float chance );
// return true with probability equal to chance

void '''infoBox'''( string title, string text );
// display text in a pop up box to all the players

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'''();

Entity Functions

2010-04-03T21:30:25Z

Queeshai:

Entity Functions

2010-04-03T21:30:04Z

Queeshai:

Location Functions

2010-04-03T21:16:57Z

Queeshai:

[[Category:Scripts]]
A location object represents a particular hex on the playing map. Note that the TFW [[Coordinate System]] is transposed -- the x-axis is vertical and the y-axis is horizontal. Labeling starts from zero.

== Constructors ==
Location '''createLocation'''( int x, int y );

== Methods ==
bool '''isAloft'''();
// false if an Aloft guy is grounded after melee

bool '''isValid'''();

Config Functions

2010-04-03T21:11:50Z

Queeshai:

[[Category:Scripts]]
These '''config functions''' may only be called from inside [[Hook Functions|configGame()]].

== Methods ==
void '''addAIPlayer'''( string name, string avatar, int team );
// all parameters are ignored for now

void '''setMapSize'''( int x, int y );
// 3 <= x <= 17
// 3 <= y <= 17

void '''setNumPlayers'''( int numPlayers );
// 1 <= n <= 4

void '''setGloryGoal'''( int gloryGoal );

void '''setMapSeed'''( int mapSeed );
// you can set this if you always want the script to be on the same map

void '''setNumFluxWells'''( int numFluxWells );

void '''dontNeedDecks'''();
// won't ask the player to set a deck when they join

Config Functions

2010-04-03T21:10:53Z

Queeshai:

[[Category:Scripts]]
These '''config functions''' may only be called from inside [[Hook Functions|configGame()]].

== Methods ==
void '''addAIPlayer'''( string name, string avatar, int team );
// all parameters are ignored for now

void '''setMapSize'''( int x, int y );
// 3 <= x <= 17
// 3 <= y <= 17

void '''setNumPlayers'''( int n );
// 1 <= n <= 4

void '''setGloryGoal'''( int n );

void '''setMapSeed'''( int seed );
// you can set this if you always want the script to be on the same map

void '''setNumFluxWells'''( int numberOfWells );

void '''dontNeedDecks'''();
// won't ask the player to set a deck when they join

Location Functions

2010-04-03T21:02:13Z

Queeshai:

[[Category:Scripts]]
A location object represents a particular hex on the playing map. See the [[Coordinate System]] page for more info.

== Constructors ==
Location '''createLocation'''( int x, int y );

== Methods ==
bool '''isAloft'''();
// false if an Aloft guy is grounded after melee

bool '''isValid'''();

Location Functions

2010-04-03T21:01:37Z

Queeshai:

[[Category:Scripts]]
A location object represents a particular hex on the playing map. See the [[Coordinate System]] page for more info.

== Constructors ==
Location createLocation( int x, int y );

== Methods ==
bool '''isAloft'''();
// false if an Aloft guy is grounded after melee

bool '''isValid'''();

Card Functions

2010-04-03T21:01:19Z

Queeshai:

[[Category:Scripts]]
A card object represents a TFW playing card (and all the associated properties).

== Constructors ==
No global constructors; returned by Player.getHandCard() and Player.getDeckCard().

== Methods ==
string '''getName'''();
// returns the label of the card, e.g., "Tangler" or "Crypt Doctor"

Location Functions

2010-04-03T21:00:42Z

Queeshai:

[[Category:Scripts]]
A location object represents a particular hex on the playing map. See the [[Coordinate System]] page for more info.

== Constructors ==
Location createLocation( int x, int y );

== Methods ==
bool isAloft();
// false if an Aloft guy is grounded after melee

bool isValid();

Location Functions

2010-04-03T20:39:12Z

Queeshai:

[[Category:Scripts]]
Location objects represent a particular hex on the playing map. See the [[Coordinate System]] page for more info.

== Constructors ==
Location createLocation( int x, int y );

== Methods ==
bool isAloft();
// false if an Aloft guy is grounded after melee

bool isValid();

Location Functions

2010-04-03T20:35:48Z

Queeshai:

[[Category:Scripts]]

== Constructors ==
Location createLocation( int x, int y );

== Methods ==
bool isAloft();
// false if an Aloft guy is grounded after melee

bool isValid();

Global Functions

2010-04-03T19:16:40Z

Queeshai:

[[Category: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,Location loc, Player controller );
Entity '''createEntity'''( string CardName,Location loc );

Location '''createLocation'''( int x, int y );

Player '''getAIPlayer'''( int index );

Player '''getHumanPlayer'''( int index );

void '''setTerrain'''( Location loc, int topo, int veg );
int '''getTopo'''( Location loc );
int '''getVeg'''( Location loc );
// topo: ocean=1, soggy=2, flat=3, hills=4, mountain=5
// veg: desert=1 ,grass=2 ,forest=3

Entity '''getFigure'''( Location loc );

void '''forEachEntity'''();
// call [[Hook Functions|entityCallback()]] once for each Entity in the game.

void '''enchantEntity'''( Entity toEnchant, string enchantName, Player enchantController );

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 );
// return an integer from 0 to max-1

bool randChance( float chance );
// return true with probability equal to chance

void '''infoBox'''( string title, string text );
// display text in a pop up box to all the players

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'''();

Hook Functions

2010-04-03T18:51:16Z

Queeshai:

[[Category:Scripts]]
The scripts you write interact with the game via a collection of hook functions. These functions are called by the game at the appropriate times and execute your code.

== Implemented ==
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

void '''onPlayersTurn'''(Player player);

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

void '''onDialogResponse'''(Player player,int resp);

== Not implemented yet ==
void '''afterAction'''();

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

Scripting

2010-04-03T18:42:38Z

Queeshai: Fixed typo

[[Category:Scripts]]
Scripts are written in [http://www.angelcode.com/angelscript/sdk/docs/manual/index.html AngelScript], it has syntax similar to C. Create your scripts [http://thefarwilds.com/story/login.html here]. If you want something ask for it in the [http://thefarwilds.com/forum/viewforum.php?f=14 forum].

The scripts you write interact with the game via a collection of [[Hook Functions]]. These hook functions are called by the game at the appropriate times and execute your code. See the [[#Examples]] section for more details.

== API ==
* [[Hook Functions]]
* [[Global Functions]]
* [[Config Functions]]
* [[Player Functions]]
* [[Entity Functions]]
* [[Location Functions]]
* [[Card Functions]]
* [[Action Functions]]

== Examples ==
[[Scripting Examples]]

== Helpful Hints ==
[[Coordinate System]] : Coordinates in TFW are a bit weird. This page explains.

Scripting

2010-04-03T18:42:20Z

Queeshai: changed category name

[[Category:Scrips]]
Scripts are written in [http://www.angelcode.com/angelscript/sdk/docs/manual/index.html AngelScript], it has syntax similar to C. Create your scripts [http://thefarwilds.com/story/login.html here]. If you want something ask for it in the [http://thefarwilds.com/forum/viewforum.php?f=14 forum].

The scripts you write interact with the game via a collection of [[Hook Functions]]. These hook functions are called by the game at the appropriate times and execute your code. See the [[#Examples]] section for more details.

== API ==
* [[Hook Functions]]
* [[Global Functions]]
* [[Config Functions]]
* [[Player Functions]]
* [[Entity Functions]]
* [[Location Functions]]
* [[Card Functions]]
* [[Action Functions]]

== Examples ==
[[Scripting Examples]]

== Helpful Hints ==
[[Coordinate System]] : Coordinates in TFW are a bit weird. This page explains.

Scripting

2010-04-03T18:37:10Z

Queeshai: apparently mediawiki is case sensitive

[[Category:Scripting]]
Scripts are written in [http://www.angelcode.com/angelscript/sdk/docs/manual/index.html AngelScript], it has syntax similar to C. Create your scripts [http://thefarwilds.com/story/login.html here]. If you want something ask for it in the [http://thefarwilds.com/forum/viewforum.php?f=14 forum].

The scripts you write interact with the game via a collection of [[Hook Functions]]. These hook functions are called by the game at the appropriate times and execute your code. See the [[#Examples]] section for more details.

== API ==
* [[Hook Functions]]
* [[Global Functions]]
* [[Config Functions]]
* [[Player Functions]]
* [[Entity Functions]]
* [[Location Functions]]
* [[Card Functions]]
* [[Action Functions]]

== Examples ==
[[Scripting Examples]]

== Helpful Hints ==
[[Coordinate System]] : Coordinates in TFW are a bit weird. This page explains.

Scripting

2010-04-03T18:36:14Z

Queeshai: Added headings, cleaned up structure, referenced hook functions

[[Category:Scripting]]
Scripts are written in [http://www.angelcode.com/angelscript/sdk/docs/manual/index.html AngelScript], it has syntax similar to C. Create your scripts [http://thefarwilds.com/story/login.html here]. If you want something ask for it in the [http://thefarwilds.com/forum/viewforum.php?f=14 forum].

The scripts you write interact with the game via a collection of [[hook functions]]. These hook functions are called by the game at the appropriate times and execute your code. See the [[#Examples]] section for more details.

== API ==
* [[Hook Functions]]
* [[Global Functions]]
* [[Config Functions]]
* [[Player Functions]]
* [[Entity Functions]]
* [[Location Functions]]
* [[Card Functions]]
* [[Action Functions]]

== Examples ==
[[Scripting Examples]]

== Helpful Hints ==
[[Coordinate System]] : Coordinates in TFW are a bit weird. This page explains.

Hook Functions

2010-04-03T18:34:45Z

Queeshai: Script Functions moved to Hook Functions: "Script Functions" is kind of vague -- all functions are script functions, no?

[[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

void '''onPlayersTurn'''(Player player);
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

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.

Script Functions

2010-04-03T18:34:45Z

Queeshai: Script Functions moved to Hook Functions: "Script Functions" is kind of vague -- all functions are script functions, no?

#REDIRECT [[Hook Functions]]