theFarWilds - User contributions [en]

DlgBox Functions

2010-08-11T01:56:44Z

Jed:

test 2

DlgBox Functions

2010-08-11T01:50:44Z

Jed: New page: test

test

Battle Draft

2010-07-09T14:36:19Z

Jed:

In a Battle Draft all the cards are shared between both players. You each see the same hand of 14 cards. When one person plays a card it is gone for both players.
The deck is 6 packs from 2 random domains.

Battle Drafting requires a different strategy than most other formats. You have a much better idea of what the enemy is capable of and must constantly work to spoil his plans. Often you must play cards just to prevent the enemy from using them.

Currently it costs 40 gold (or 4 [[Power]]) to enter and the winner gets 76 gold.

Card Functions

2010-06-10T13:30:29Z

Jed: /* Methods */

[[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 title of the card, e.g., "Tangler" or "Crypt Doctor"

int '''getType'''();
// returns the type of card: CREATURE,BUILDING,ENCHANTMENT,ITEM,SPELL

int '''getID'''();
// returns the ID of the Card

Card Functions

2010-06-10T11:58:17Z

Jed: /* Methods */

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

int '''getType'''();
// returns the type of card: CREATURE,BUILDING,ENCHANTMENT,ITEM,SPELL

Autodraw

2010-05-09T14:02:25Z

Jed:

The Far Wilds tries to make sure you are always able to increase your domain level. It does this by sometimes changing the next card you would draw.

1) When the game starts, any default base building (any [[Grove]], [[Graveyard]], etc.) in your Army is added to a list of External Cards.

2) If you don't have a Base in play or in your hand, you will draw the first available one from your Army if you have the domain to play it.

3) If you have a card in hand that you don't have the domain for and you don't have a card that gives you that domain in hand that you can play, you will draw a card from your Army that gives you that domain if you have one. If there isn't a card in your Army then you will draw one from your External Card list.

4) If you don't have a domain providing card in hand that you have the domain to play, you will draw the first domain providing card in your deck. If there isn't a card in your Army then you will draw one from your External Card list.

This means that if you start with one Grove in your Army and later it is destroyed. You will keep drawing Groves as long as you need them.

Global Functions

2010-05-08T01:54:29Z

Jed:

[[Category:Scripts]]
'''Global functions''' can be called from anywhere in your scripts.

[[Entity_Functions|Entity]] '''createEntity'''( string CardName, int x_coord, int y_coord, Player controller );
[[Entity_Functions|Entity]] '''createEntity'''( string CardName,Location loc, Player controller );
[[Entity_Functions|Entity]] '''createEntity'''( string CardName,Location loc );

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

int getMapWidth();
int getMapHeight();

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 ,TREES=3

[[Entity_Functions|Entity]] '''getFigure'''( Location loc );

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

void '''enchantEntity'''( [[Entity_Functions|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'''();

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

// 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);

Config Functions

2010-04-25T13:51:44Z

Jed: /* Methods */

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

void '''setTurnTime'''(int timeInSec);
void '''setPlayerTimeLimit'''(int timeInSec);
// time limit for the whole game

Hook Timeline

2010-04-23T16:40:35Z

Jed:

[[Category:Scripts]]

Player clicks the Play: link
game instance starts on the server
No players are connected to the game
Script is loaded
any #include is loaded
'''configGame'''() is called
map is created
wait for players to join
all players have joined and selected decks
'''beforeStart'''() is called
flux wells are placed
'''duringStart'''() is called
places with starting light fog are revealed to players
players draw their cards
'''afterStart'''() is called
Game on

Hook Functions

2010-04-23T16:38:06Z

Jed: /* Implemented */

[[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. [[Hook Timeline]]

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

bool '''isDeckValid'''([[Player Functions|Player]] player);
// if you want to implement non-standard deck requirements
// use statusMsg to tell them why their deck is invalid

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

bool '''duringStart'''();
// return true if you want the normal fog
// Should only need this to change the starting fog.

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

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

void '''onPlayersTurn'''([[Player Functions|Player]] player);

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

void '''onDialogResponse'''([[Player Functions|Player]] player,int resp);

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

bool '''canAct'''([[Player Functions|Player]] player,Action action);

void '''afterAction'''(Action action);

Global Functions

2010-04-18T11:24:33Z

Jed:

Hook Timeline

2010-04-17T20:21:26Z

Jed:

[[Category:Scripts]]

Player clicks the Play: link
game instance starts on the server
No players are connected to the game
Script is loaded
any #include is loaded
'''configGame'''() is called
wait for players to join
all players have joined and selected decks
'''beforeStart'''() is called
map is created
flux wells are placed
players draw their cards
'''afterStart'''() is called
Game on

Hook Timeline

2010-04-17T19:42:37Z

Jed:

[[Category:Scripts]]

Player clicks the Play: link
Script is loaded
any #include is loaded
'''configGame'''() is called
wait for others to join
all players have joined and selected decks
'''beforeStart'''() is called
map is created
flux wells are placed
players draw their cards
'''afterStart'''() is called
Game on

Hook Timeline

2010-04-17T19:40:55Z

Jed:

Hook Timeline

2010-04-17T19:33:11Z

Jed: New page: Category:Scripts Player clicks the Play: link Script is loaded any #include is loaded '''configGame'''() is called wait for others to join all players have joined and selected decks '...

Hook Functions

2010-04-17T19:16:23Z

Jed:

[[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. [[Hook Timeline]]

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

bool '''isDeckValid'''([[Player Functions|Player]] player);
// if you want to implement non-standard deck requirements
// use statusMsg to tell them why their deck is invalid

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 Functions|Player]] player);

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

void '''onDialogResponse'''([[Player Functions|Player]] player,int resp);

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

bool '''canAct'''([[Player Functions|Player]] player,Action action);

void '''afterAction'''(Action action);

Location Functions

2010-04-16T14:20:25Z

Jed: /* Methods */

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

int '''distance'''(Location);

int '''getX'''();
int '''getY'''();

Player '''getController'''();

Preprocessor

2010-04-14T20:23:08Z

Jed:

[[Category:Scripts]]

'''#include''' <scriptID>
this will include a script in with yours so you can make common function libraries

== Example ==
#include 236

void beforeStart()
{
some_function_defined_in_236();
}

Preprocessor

2010-04-14T20:22:43Z

Jed:

[[Category:Scripts]]

#'''include''' <scriptID>
this will include a script in with yours so you can make common function libraries

== Example ==
#include 236

void beforeStart()
{
some_function_defined_in_236();
}

Preprocessor

2010-04-14T19:15:23Z

Jed: New page: Category:Scripts //'''include''' <scriptID> this will include a script in with yours so you can make common function libraries == Example == //include 236 void beforeStart() {...

[[Category:Scripts]]

//'''include''' <scriptID>
this will include a script in with yours so you can make common function libraries

== Example ==
//include 236

void beforeStart()
{
some_function_defined_in_236();
}

Scripting

2010-04-14T19:12:41Z

Jed: /* API */

[[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 ==
* [[Preprocessor]]
* [[Hook Functions]]
* [[Global Functions]]
* [[Config Functions]]
* [[Player Functions]]
* [[Entity Functions]]
* [[Location Functions]]
* [[DlgBox 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-14T19:10:57Z

Jed: /* Implemented */

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

bool '''isDeckValid'''([[Player Functions|Player]] player);
// if you want to implement non-standard deck requirements
// use statusMsg to tell them why their deck is invalid

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 Functions|Player]] player);

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

void '''onDialogResponse'''([[Player Functions|Player]] player,int resp);

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

bool '''canAct'''([[Player Functions|Player]] player,Action action);

void '''afterAction'''(Action action);

Action Functions

2010-04-14T19:09:37Z

Jed: New page: Category:Scripts An action object represents an action either about to happen or that already happened or that you are building to have happen. == Example == void afterAction(Action ...

[[Category:Scripts]]
An action object represents an action either about to happen or that already happened or that you are building to have happen.

== Example ==
void afterAction(Action action)
{
if(action.getCardActor().getName()=="Bindweed")
{
Entity target=action.getEntityTarget(0);
if( target.getController()==gAIPlayer)
{
string msg="Bindweed on the enemy????";
statusMsg(nullPlayer,msg);
}
}
}

== Constructors ==

== Methods ==

int '''getType'''();
// possible values: MOVE, MELEE, SHOOT, OTHER

Player '''getController'''();

Card '''getCardActor'''();
// Card will be invalid if this wasn't a card that acted

Entity '''getEntityActor'''();
// Entity will be invalid if this wasn't an Entity that acted

Entity '''getEntityTarget'''(int index)

Location '''getLocTarget'''(int index)

Entity Functions

2010-04-14T18:53:21Z

Jed: /* Methods */

[[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 '''moveEntity'''( 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

Entity Functions

2010-04-14T12:46:37Z

Jed: /* Methods */

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

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

Player Functions

2010-04-13T02:05:26Z

Jed: /* Constructors */

[[Category:Scripts]]
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

Player Functions

2010-04-13T02:05:08Z

Jed: /* Constructors */

Player Functions

2010-04-13T02:04:28Z

Jed: /* Methods */

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

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

Player getHumanPlayer( 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

Hook Functions

2010-04-09T14:11:45Z

Jed:

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

bool '''isDeckValid'''([[Player Functions|Player]] player);
// if you want to implement non-standard deck requirements
// use statusMsg to tell them why their deck is invalid

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 Functions|Player]] player);

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

void '''onDialogResponse'''([[Player Functions|Player]] player,int resp);

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

bool '''canAct'''([[Player Functions|Player]] player,Action action);

Entity Functions

2010-04-08T01:50:46Z

Jed: /* Methods */

[[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 '''moveEntity'''( 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

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

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

Entity Functions

2010-04-08T01:42:50Z

Jed: /* Constructors */

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

void '''setController'''( 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 '''moveEntity'''( 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

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

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

Hook Functions

2010-04-08T01:42:10Z

Jed: /* Implemented */

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

bool '''isDeckValid'''([[Player Functions|Player]] player);
// if you want to implement non-standard deck requirements
// use statusMsg to tell them why their deck is invalid

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 Functions|Player]] player);

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

void '''onDialogResponse'''([[Player Functions|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.

Hook Functions

2010-04-07T18:04:36Z

Jed: /* Implemented */

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

bool '''isDeckValid'''(Player player);
// if you want to implement non-standard deck requirements
// use statusMsg to tell them why their deck is invalid

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.

Hook Functions

2010-04-07T18:04:20Z

Jed: /* Implemented */

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

bool isDeckValid(Player player);
// if you want to implement non-standard deck requirements
// use statusMsg to tell them why their deck is invalid

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.

Location Functions

2010-04-06T12:57:57Z

Jed: /* Methods */

Entity Functions

2010-04-06T12:56:15Z

Jed:

[[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 controller );

Entity createEntity( string cardName, Location loc, 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 '''getController'''();

void '''setController'''( 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 '''moveEntity'''( 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

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

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

Entity Functions

2010-04-05T16:06:18Z

Jed:

Global Functions

2010-04-05T16:04:57Z

Jed:

Scripting

2010-04-05T13:24:13Z

Jed: /* API */

[[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]]
* [[DlgBox Functions]]
* [[Card Functions]]
* [[Action Functions]]

== Examples ==
[[Scripting Examples]]

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

Global Functions

2010-04-05T13:02:39Z

Jed:

[[Category:Scripts]]
'''Global functions''' can be called from anywhere in your scripts.

[[Entity_Functions|Entity]] '''createEntity'''( string CardName, int x_coord, int y_coord, Player controller );
[[Entity_Functions|Entity]] '''createEntity'''( string CardName,Location loc, Player controller );
[[Entity_Functions|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_Functions|Entity]] '''getFigure'''( Location loc );

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

void '''enchantEntity'''( [[Entity_Functions|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'''();

Location Functions

2010-04-01T23:46:18Z

Jed:

[[Scripting]]

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

Global Functions

2010-03-27T16:16:02Z

Jed:

[[Scripting]]
Global Functions that you can call from 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 where);

void '''forEachEntity'''();
// this will cause the game to call the entityCallback() function you write
// 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);
// returns an int from 0 to max-1
bool randChance(float chance);
// returns true with probability equal to chance

void '''infoBox'''(string title,string text);
// displays 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-03-27T16:15:37Z

Jed:

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

Hook Functions

2010-03-27T16:15:00Z

Jed:

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

Global Functions

2010-03-26T18:11:28Z

Jed:

[[Scripting]]
Global Functions that you can call from 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 where);

void '''forEachEntity'''();
// this will cause the game to call the entityCallback() function you write
// once for each Entity in the game.

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

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);
// returns an int from 0 to max-1
bool randChance(float chance);
// returns true with probability equal to chance

void '''infoBox'''(string title,string text);
// displays 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-03-25T13:15:55Z

Jed:

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

Entity Functions

2010-03-23T20:50:16Z

Jed:

[[Scripting]]
Entity Functions are called on the Entity object. For example

Entity ent=getFigure(createLocation(3,3));
ent.remove();

List of functions:
bool '''isValid'''();
bool '''doesExist'''();
// isValid will tell you if the Entity returned by some other function is valid
// 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);

bool '''isType'''(int type);
// 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

void '''remove'''();
void '''destroy'''();
void '''sacrifice'''();

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

Player Functions

2010-03-23T20:45:58Z

Jed:

[[Scripting]]
Player Functions are called on the Player object. For example

Player player=getAIPlayer(0);
player.drawCard();

List of functions:
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);

Global Functions

2010-03-23T20:43:31Z

Jed:

[[Scripting]]
Global Functions that you can call from 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 where);

void '''forEachEntity'''();
// this will cause the game to call the entityCallback() function you write
// once for each Entity in the game.

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

void '''endGame'''(Player winner);
void '''flipTheScript'''(int scriptID);
// changes what script is being used for the game
// doesn't preserve global variables yet

void '''infoBox'''(string title,string text);
// displays 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'''();

Global Functions

2010-03-23T20:42:58Z

Jed:

[[Scripting]]
Global Functions that you can call from 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 where);

void '''forEachEntity'''();
// this will cause the game to call the entityCallback() function you write once for each Entity in the game.

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

void '''endGame'''(Player winner);
void '''flipTheScript'''(int scriptID);
// changes what script is being used for the game
// doesn't preserve global variables yet

void '''infoBox'''(string title,string text);
// displays 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'''();

Card Functions

2010-03-23T20:38:54Z

Jed: New page: Scripting Card Functions are called on the Card object. For example Card card=getAIPlayer(0).getHandCard(0); if(card.getName()=="Tangler") { // ... List of functions: string '''g...

[[Scripting]]
Card Functions are called on the Card object. For example

Card card=getAIPlayer(0).getHandCard(0);
if(card.getName()=="Tangler")
{ // ...

List of functions:
string '''getName'''();