Scripting - Revision history

Phil: /* Singletons */

2026-04-20T21:20:18Z

Singletons

← Older revision		Revision as of 21:20, 20 April 2026
Line 168:		Line 168:

	<code>int gArray[3][2]={0,1,2,3,4,5} ;</code>		<code>int gArray[3][2]={0,1,2,3,4,5} ;</code>

			You can also use a const tag. This means that these variables will not be cleared to zero when loading script state. They WILL, however, be overwritten if there is data stored in the savegame.

			<code>const int gConstArray[3][2]={0,1,2,3,4,5} ;</code>

	=== The char Type ===		=== The char Type ===

2018-10-17T17:05:34Z

The Debugger

← Older revision		Revision as of 17:05, 17 October 2018
Line 193:		Line 193:

	intrinsic, as well as dynamic breakpoints you set yourself in the code.		intrinsic, as well as dynamic breakpoints you set yourself in the code.

			=== User Watch List ===
			To add an expression, type the expression in the edit box below the list, or you can hit W to add the current mouseover expression to the watch list. DEL should delete an entry in the list. The list is saved and loaded between sessions.

			Note that only expressions which evaluate to an integer or string are currently accepted (so you cannot enter an array element then explore it). I am planning to improve this.

			When maximum script debugging is enabled (only on builds built to support this) then add a # to the start of the expresion. E.g. to break on myBreakVar enter #myBreakVar into the editbox. Note that this requires the DEBUGMODE value in USER.TXT to be 32 or 64 (64 enables CTRL+0 (zero) to break into a running script. Enabling this causes a notable reduction in script performance.

	== Performance ==		== Performance ==

2018-02-27T18:01:28Z

← Older revision		Revision as of 18:01, 27 February 2018
Line 193:		Line 193:

	intrinsic, as well as dynamic breakpoints you set yourself in the code.		intrinsic, as well as dynamic breakpoints you set yourself in the code.

			== Performance ==
			=== For Loops ===
			Some loop constructs will execute more quickly than others. Specifically loops that are on a variable from a numeric start, with a less than test against either a numeric value or a simple variable, and a ++ increment.

			Faster
			for(i=0;i<10;i++)
			for(i=0;i<count;i++)

			Not faster
			for(i=0;i<=10;i+=1)
			for(i=x;i<array[7].count;i++)

2017-01-13T16:19:06Z

Including Files

← Older revision		Revision as of 16:19, 13 January 2017
Line 156:		Line 156:
	The script system will look for the file in the following places in the following order:		The script system will look for the file in the following places in the following order:

	same folder as the initial file		same folder as the initial file
	<campaign folder>/DATA/BATTLE/SCRIPTS		<campaign folder>/DATA/BATTLE/SCRIPTS
	<campaign folder>/DATA/SCRIPTS		<campaign folder>/DATA/SCRIPTS
	DATA/BATTLE/SCRIPTS		DATA/BATTLE/SCRIPTS
	DATA/SCRIPTS		DATA/SCRIPTS
	filename as provided		filename as provided

	=== Singletons ===		=== Singletons ===

2016-07-11T15:45:11Z

← Older revision		Revision as of 15:45, 11 July 2016
Line 146:		Line 146:


	Including Files		=== Including Files ===

	You can include other files in your scripts. These can contain useful utility functions, either of your own, or from the game. The syntax for including a file is:		You can include other files in your scripts. These can contain useful utility functions, either of your own, or from the game. The syntax for including a file is:

2016-05-12T12:36:27Z

Control

← Older revision		Revision as of 12:36, 12 May 2016
Line 144:		Line 144:

	+ All structures are passed by reference to functions (e.g. any changes to a passed in struct in a function will affect the passed in variable in the calling function).		+ All structures are passed by reference to functions (e.g. any changes to a passed in struct in a function will affect the passed in variable in the calling function).


	Including Files		Including Files

2016-03-03T17:50:47Z

The Debugger

← Older revision		Revision as of 17:50, 3 March 2016
Line 188:		Line 188:
	There is an integrated script debugger which can be activated with <b>CTRL+F3</b>. This allows you to check variable values, flow, etc. Note that the debugger is still work in progress. You can insert a breakpoint into your code using the		There is an integrated script debugger which can be activated with <b>CTRL+F3</b>. This allows you to check variable values, flow, etc. Note that the debugger is still work in progress. You can insert a breakpoint into your code using the

	<code>~~break~~ ;</code>		<code>DebugBreak;</code>

	intrinsic, as well as dynamic breakpoints you set yourself in the code.		intrinsic, as well as dynamic breakpoints you set yourself in the code.

2016-01-19T21:25:52Z

← Older revision		Revision as of 21:25, 19 January 2016
Line 184:		Line 184:

	char arrays must be multiples of 4 in size, multidimensional arrays are supported.		char arrays must be multiples of 4 in size, multidimensional arrays are supported.

			== The Debugger ==
			There is an integrated script debugger which can be activated with <b>CTRL+F3</b>. This allows you to check variable values, flow, etc. Note that the debugger is still work in progress. You can insert a breakpoint into your code using the

			<code>break ;</code>

			intrinsic, as well as dynamic breakpoints you set yourself in the code.

2015-11-10T16:53:35Z

The char Type

← Older revision		Revision as of 16:53, 10 November 2015
Line 183:		Line 183:
	Limitations to note:		Limitations to note:

	char arrays must be multiples of 4 in size		char arrays must be multiples of 4 in size, multidimensional arrays are supported.
	multidimensional ~~string~~ arrays are ~~not~~ supported ~~(possible they may be)~~.

2015-10-26T23:21:41Z

Added description of predefined macros

← Older revision		Revision as of 23:21, 26 October 2015
Line 42:		Line 42:
	<code>#define MAX_UNITS 256</code>		<code>#define MAX_UNITS 256</code>

	Structures		==== Predefined Macros ====

			Some macros may be predefined based on other data files. The names of these predefined macros will always begin with a $ character and all characters will be in uppercase.
			* Macros will be predefined for all colours specified in the COLOURDICTIONARY chunk of DATA/UISETTINGS.TXT that are appropriate for use where script commands expect colours as parameters.
			* Macros will be predefined for all fonts specified in SYSTEM/FONT.TXT that are appropriate for use where script commands expect fonts as parameters.

			For example, <code>DrawMapString(x, y, $SMALLFONT, $ALERTCOLOUR)</code>

			=== Structures ===

	You can define structures in a similar way to C. The format is:		You can define structures in a similar way to C. The format is: