Latest Updates - Revision history

Phil at 17:48, 1 April 2026

2026-04-01T17:48:41Z

← Older revision		Revision as of 17:48, 1 April 2026
Line 1:		Line 1:
			= Auto LOD =
			The system can automatically generate LODs for map objects.
			This is disabled if bit 0 of the SYSTEMFLAGS tweak is set to zero.
			It can also be disabled by setting bit 0 of the GFXFlags option to 1.
			Per-object control happens via an LOD tag in the relevant OBJECTS.TXT file entry.
			LOD -1 // disable LODing for this object
			LOD 0 // use the default calculations
			LOD <N> // attempt to reduce this to N% of its face count (must be [1,100])

	= Command line handling =		= Command line handling =
	Command line must start with CUSTOM (that is CUSTOM followed by a space). The rest of the command line is passed to the function CUSTOM_COMMAND() in LOADINIT.BSF with the custom command line in the first work string. Note this is called after the LOADINIT function in the script, and after the main menu has come up (and in theory after any server messages etc). Added partly as a first part for AGEOD integration, and also could be hooked up to the player-driven campaign game app from the forums.		Command line must start with CUSTOM (that is CUSTOM followed by a space). The rest of the command line is passed to the function CUSTOM_COMMAND() in LOADINIT.BSF with the custom command line in the first work string. Note this is called after the LOADINIT function in the script, and after the main menu has come up (and in theory after any server messages etc). Added partly as a first part for AGEOD integration, and also could be hooked up to the player-driven campaign game app from the forums.

Phil: /* Multiplayer UI Callbacks */

2019-03-29T17:36:57Z

Multiplayer UI Callbacks

@@ Line 35: / Line 35: @@
 	// this allows correct disabling of games that the user cannot play based on their DLC ownership
 	// NOTE: if a game is accepted without the DLC being available it will still fail on battle start
 }</nowiki>
 = WriteScenarioFile =

Phil: /* Command line handling */

2018-07-31T16:27:05Z

Command line handling

← Older revision		Revision as of 16:27, 31 July 2018
Line 2:		Line 2:
	Command line must start with CUSTOM (that is CUSTOM followed by a space). The rest of the command line is passed to the function CUSTOM_COMMAND() in LOADINIT.BSF with the custom command line in the first work string. Note this is called after the LOADINIT function in the script, and after the main menu has come up (and in theory after any server messages etc). Added partly as a first part for AGEOD integration, and also could be hooked up to the player-driven campaign game app from the forums.		Command line must start with CUSTOM (that is CUSTOM followed by a space). The rest of the command line is passed to the function CUSTOM_COMMAND() in LOADINIT.BSF with the custom command line in the first work string. Note this is called after the LOADINIT function in the script, and after the main menu has come up (and in theory after any server messages etc). Added partly as a first part for AGEOD integration, and also could be hooked up to the player-driven campaign game app from the forums.
	[I am sure there will be some foibles trying to kick off battles from the main menu, but this provides a starting point.]		[I am sure there will be some foibles trying to kick off battles from the main menu, but this provides a starting point.]
			Note: the max length of the command line is 768 characters (not including the CUSTOM<space> header).

	= Multiplayer UI Callbacks =		= Multiplayer UI Callbacks =

Phil at 16:23, 31 July 2018

2018-07-31T16:23:43Z

← Older revision		Revision as of 16:23, 31 July 2018
Line 1:		Line 1:
			= Command line handling =
			Command line must start with CUSTOM (that is CUSTOM followed by a space). The rest of the command line is passed to the function CUSTOM_COMMAND() in LOADINIT.BSF with the custom command line in the first work string. Note this is called after the LOADINIT function in the script, and after the main menu has come up (and in theory after any server messages etc). Added partly as a first part for AGEOD integration, and also could be hooked up to the player-driven campaign game app from the forums.
			[I am sure there will be some foibles trying to kick off battles from the main menu, but this provides a starting point.]

	= Multiplayer UI Callbacks =		= Multiplayer UI Callbacks =
	There are a number of callbacks for MP UI use		There are a number of callbacks for MP UI use

Phil: /* Multiplayer UI Callbacks */

2017-11-15T16:48:28Z

Multiplayer UI Callbacks

← Older revision		Revision as of 16:48, 15 November 2017
Line 21:		Line 21:
	// if returns !=0 then appends the contents of the first UI string to the list entry		// if returns !=0 then appends the contents of the first UI string to the list entry
	return 0 ;		return 0 ;
			}

			FUNCTION MULTIPLAYER_PROT_ACCEPT_CALLBACK( [skirmish, side, prot] )
			{
			// this is called with the user data in the work array
			// the prot value is the bitfield passed from the challenge. Note that the top bit is always set and should be ignored.
			// it should return the prot value based on the sides etc
			// this allows correct disabling of games that the user cannot play based on their DLC ownership
			// NOTE: if a game is accepted without the DLC being available it will still fail on battle start
	}</nowiki>		}</nowiki>

Phil: /* Multiplayer UI Callbacks */

2017-09-21T14:35:09Z

Multiplayer UI Callbacks

← Older revision		Revision as of 14:35, 21 September 2017
Line 1:		Line 1:
	= Multiplayer UI Callbacks =		= Multiplayer UI Callbacks =
	There are a number of callbacks for MP UI use		There are a number of callbacks for MP UI use
	<nowiki>FUNCTION MULTIPLAYER_USERDATA_CALLBACK()		<nowiki>FUNCTION MULTIPLAYER_USERDATA_CALLBACK( [skirmish] )
	{		{
	// this should fill the work array with up to 16 values		// this should fill the work array with up to 16 values
Line 8:		Line 8:
	}		}

	FUNCTION MULTIPLAYER_USERDATA_TOOLTIP_CALLBACK()		FUNCTION MULTIPLAYER_USERDATA_TOOLTIP_CALLBACK( [skirmish])
	{		{
	// this is called with the user data in the work array, and should fill the UI string with the appropriate tooltip		// this is called with the user data in the work array, and should fill the UI string with the appropriate tooltip
Line 15:		Line 15:
	}		}

	FUNCTION MULTIPLAYER_USERDATA_ACCEPT_CALLBACK()		FUNCTION MULTIPLAYER_USERDATA_ACCEPT_CALLBACK( [skirmish, side] )
	{		{
	// this is called with the user data in the work array		// this is called with the user data in the work array
Line 22:		Line 22:
	return 0 ;		return 0 ;
	}</nowiki>		}</nowiki>


	= WriteScenarioFile =		= WriteScenarioFile =

Phil at 20:35, 20 September 2017

2017-09-20T20:35:52Z

← Older revision		Revision as of 20:35, 20 September 2017
Line 1:		Line 1:
			= Multiplayer UI Callbacks =
			There are a number of callbacks for MP UI use
			<nowiki>FUNCTION MULTIPLAYER_USERDATA_CALLBACK()
			{
			// this should fill the work array with up to 16 values
			// generally this would be driven by custom UI
			// these values are then available in the working array immediately after the battle loads
			}

			FUNCTION MULTIPLAYER_USERDATA_TOOLTIP_CALLBACK()
			{
			// this is called with the user data in the work array, and should fill the UI string with the appropriate tooltip
			// only adds a tooltip if it returns != 0
			return 1 ;
			}

			FUNCTION MULTIPLAYER_USERDATA_ACCEPT_CALLBACK()
			{
			// this is called with the user data in the work array
			// if returns 0 then no side string is shown in the accept list
			// if returns !=0 then appends the contents of the first UI string to the list entry
			return 0 ;
			}</nowiki>


	= WriteScenarioFile =		= WriteScenarioFile =
	This function can allow a scenario file to be created from the combination of a header string and the contents of a file. The command looks for the file in <campaign>/DATA/SCRIPTS and then DATA/SCRIPTS. It then creates a new .BSF file named for the scenario which is made up of the header followed by the contents of the template file.		This function can allow a scenario file to be created from the combination of a header string and the contents of a file. The command looks for the file in <campaign>/DATA/SCRIPTS and then DATA/SCRIPTS. It then creates a new .BSF file named for the scenario which is made up of the header followed by the contents of the template file.

Phil at 17:30, 20 July 2017

2017-07-20T17:30:30Z

← Older revision		Revision as of 17:30, 20 July 2017
Line 1:		Line 1:
			= WriteScenarioFile =
			This function can allow a scenario file to be created from the combination of a header string and the contents of a file. The command looks for the file in <campaign>/DATA/SCRIPTS and then DATA/SCRIPTS. It then creates a new .BSF file named for the scenario which is made up of the header followed by the contents of the template file.

			The calling script must handle overwrite confirms etc (if needed).

			//create a scenario file for the current editor scenario. The file is the headerSource followed by the contents of the templateFilename file. If overwrite !=0 then will overwrite any existing file, otherwise not. Returns -1 (failed), 0 (exists), 1 success. See wiki for more details.
			WriteScenarioFile(templateFilename, headerSource, overwrite)

			The header can include (e.g.) globals or defines which are then referenced in the template script.

	= Editor Font Customisation =		= Editor Font Customisation =
	You can now set up aliases for the fonts used in various modes for the main list (ScenEdTileList). Aliases must be in the global chunk (at the top) of the font file. They are of the form:		You can now set up aliases for the fonts used in various modes for the main list (ScenEdTileList). Aliases must be in the global chunk (at the top) of the font file. They are of the form:

Phil at 16:15, 20 July 2017

2017-07-20T16:15:26Z

← Older revision		Revision as of 16:15, 20 July 2017
Line 1:		Line 1:
			= Editor Font Customisation =
			You can now set up aliases for the fonts used in various modes for the main list (ScenEdTileList). Aliases must be in the global chunk (at the top) of the font file. They are of the form:

			ALIAS <name>=<actualFont>

			So an example (for the tile list in the editor) would be:

			ALIAS SmoothFont_EdTileSet=MyEdTileFont

			Note you will get an error if the aliased font does not exist. The currently defined aliases are

			SmoothFont_EdTileSet
			SmallFont_EdObjSet
			Default_EdUnitSet
			Default_EdBonusSet
			Default_EdCarrySet

			If no alias is defined, then the base (pre-underscore) name will be used for the font (e.g. SmoothFont for SmoothFont_EdTileSet).

	= Load/Save and Options Layout =		= Load/Save and Options Layout =
	If you include a screen whose root is called SystemMenu, then the default load/save etc functionality will be disabled somewhat. ESC will open this SystemMenu, or close either the LoadSave, Options, or SystemMenu screen (whichever is at the top level). This allows for finer control of the layout and use of the loadsave screens.		If you include a screen whose root is called SystemMenu, then the default load/save etc functionality will be disabled somewhat. ESC will open this SystemMenu, or close either the LoadSave, Options, or SystemMenu screen (whichever is at the top level). This allows for finer control of the layout and use of the loadsave screens.

Phil at 23:34, 8 May 2017

2017-05-08T23:34:20Z

← Older revision		Revision as of 23:34, 8 May 2017
Line 1:		Line 1:
			= Load/Save and Options Layout =
			If you include a screen whose root is called SystemMenu, then the default load/save etc functionality will be disabled somewhat. ESC will open this SystemMenu, or close either the LoadSave, Options, or SystemMenu screen (whichever is at the top level). This allows for finer control of the layout and use of the loadsave screens.

			Note, you can open a correctly set up loadsave or options screen by using custom command values 0 or 1 respectively. E.g.
			<nowiki>COMMAND CUSTOM 1</nowiki> attached to a button will open the options screen.

	= Unit Orientation =		= Unit Orientation =
	If you include a TerrainFollow attrib in the squads file, then for units with this attrib as non-zero they will align themselves with the terrain (i.e. hills etc)		If you include a TerrainFollow attrib in the squads file, then for units with this attrib as non-zero they will align themselves with the terrain (i.e. hills etc)