Difference between revisions of "Scripting"

From theFarWilds
Jump to: navigation, search
(New page: This is the start of the scripting API. It will be expanded over time. If you want something ask for it in the forum. Functions you can implement: void setupGame(); // Sets up the game s...)
 
 
(28 intermediate revisions by 4 users not shown)
Line 1: Line 1:
−
This is the start of the scripting API. It will be expanded over time. If you want something ask for it in the forum.
+
[[Category:Scripts]]
 +
Scripts are written in [http://www.angelcode.com/angelscript/sdk/docs/manual/index.html AngelScript] (current used version is 2.26.2), it has syntax similar to C.  Create your scripts [http://story.thefarwilds.com/login.html here].  If you want something ask for it in the [http://thefarwilds.com/forum/viewforum.php?f=14 forum].
  
−
Functions you can implement:
+
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.
  
−
void setupGame(); // Sets up the game state such as # of players, Map Size, if they need to set a deck or not, etc
+
== API ==
 +
* [[Preprocessor]]
 +
* [[Hook Functions]]
 +
* [[Global Functions]]
 +
* [[Config Functions]]
 +
* [[Player Functions]]
 +
* [[Entity Functions]]
 +
* [[Location Functions]]
 +
* [[DlgBox Functions]]
 +
* [[Card Functions]]
 +
* [[Action Functions]]
  
−
void beforeStart(); // Do things here before any action. Place creatures and buildings, change their decks etc.
+
== Examples ==
 +
[[Scripting Examples]]
  
−
void afterAction();
+
== Helpful Hints ==
−
 
+
[[Coordinate System]] : Coordinates in TFW are a bit weird. This page explains.
−
void playersTurn(IPlayer player);
+
−
 
+
−
 
+
−
Functions you can call:
+
−
 
+
−
 
+
−
Example Scripts:
+

Latest revision as of 15:35, 5 June 2013

Scripts are written in AngelScript (current used version is 2.26.2), it has syntax similar to C. Create your scripts here. If you want something ask for it in the 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

Examples

Scripting Examples

Helpful Hints

Coordinate System : Coordinates in TFW are a bit weird. This page explains.

Retrieved from "http://thefarwilds.com/wiki/index.php?title=Scripting&oldid=1642"