ACS scripting - Revision history

Printz at 19:28, 20 June 2019

2019-06-20T19:28:46Z

@@ Line 35: / Line 35: @@
 ACS scripts can be tested from the [[console]] by using the '''puke''' command.
 == ACS details ==
 *[[ACS spawn IDs]]

Printz: /* Doom (classic) format maps */ Removed extradata reference

2019-06-20T19:24:45Z

Doom (classic) format maps: Removed extradata reference

← Older revision		Revision as of 15:24, 20 June 2019
Line 11:		Line 11:
	This information does not apply for UDMF or Hexen format maps.		This information does not apply for UDMF or Hexen format maps.

	ACS scripts can be loaded with Doom-format maps through the help of [[MapInfo\|EMAPINFO~~]] and [[ExtraData~~]]. The MapInfo entry for the map needs ~~at least~~ a specifier for ~~its ExtraData lump and~~ compiled ACS lump (setting the ~~'''extradata''' and~~ '''acsscript''' ~~entries~~).		ACS scripts can be loaded with Doom-format maps through the help of [[MapInfo\|EMAPINFO]]. The MapInfo entry for the map needs a specifier for the compiled ACS lump (setting the '''acsscript''' entry).

	The script can be written in a text editor and compiled using the '''acc''' tool (see https://devbuilds.drdteam.org/ACC/). After obtaining the behavior lump (usually with the .o extension), import it in a wad and place it between lumps '''A_START''' and '''A_END'''. The '''acsscript''' entry from EMAPINFO should then reference this compiled lump.		The script can be written in a text editor and compiled using the '''acc''' tool (see https://devbuilds.drdteam.org/ACC/). After obtaining the behavior lump (usually with the .o extension), import it in a wad and place it between lumps '''A_START''' and '''A_END'''. The '''acsscript''' entry from EMAPINFO should then reference this compiled lump.

Printz: /* ACS details */

2017-04-08T11:02:15Z

ACS details

← Older revision		Revision as of 07:02, 8 April 2017
Line 40:		Line 40:
	*[[ACS constants]]		*[[ACS constants]]
	*[[ACS directives]]		*[[ACS directives]]
			*[[ACS libraries]]

	[[Category:ACS]]		[[Category:ACS]]
	[[Category:Editing reference]]		[[Category:Editing reference]]

Printz: /* ACS details */

2017-04-08T11:02:04Z

ACS details

← Older revision		Revision as of 07:02, 8 April 2017
Line 38:		Line 38:
	*[[ACS spawn IDs]]		*[[ACS spawn IDs]]
	*[[ACS built-in functions]]		*[[ACS built-in functions]]
			*[[ACS constants]]
	*[[ACS directives]]		*[[ACS directives]]

	[[Category:ACS]]		[[Category:ACS]]
	[[Category:Editing reference]]		[[Category:Editing reference]]

Printz at 09:48, 8 April 2017

2017-04-08T09:48:14Z

← Older revision		Revision as of 05:48, 8 April 2017
Line 40:		Line 40:
	*[[ACS directives]]		*[[ACS directives]]

			[[Category:ACS]]
	[[Category:Editing reference]]		[[Category:Editing reference]]
	~~[[Category:ACS]]~~

Printz at 09:46, 8 April 2017

2017-04-08T09:46:54Z

← Older revision		Revision as of 05:46, 8 April 2017
Line 41:		Line 41:

	[[Category:Editing reference]]		[[Category:Editing reference]]
			[[Category:ACS]]

Printz: /* ACS details */

2017-04-08T09:28:44Z

ACS details

← Older revision		Revision as of 05:28, 8 April 2017
Line 38:		Line 38:
	*[[ACS spawn IDs]]		*[[ACS spawn IDs]]
	*[[ACS built-in functions]]		*[[ACS built-in functions]]
			*[[ACS directives]]

	[[Category:Editing reference]]		[[Category:Editing reference]]

Printz: Updated the ACS info page

2017-04-08T09:28:03Z

Updated the ACS info page

← Older revision		Revision as of 05:28, 8 April 2017
Line 1:		Line 1:
	For the upcoming Hexen implementation, Eternity supports ACS scripts. As well as it can run the vanilla Hexen ACS script bytecodes, it can run the modern ACS as produced for ZDoom, and it's designed to be compatible with the functions and definitions provided in ''zcommon.acs''.		For the upcoming Hexen implementation, Eternity supports ACS scripts. As well as it can run the vanilla Hexen ACS script bytecodes, it can run the modern ACS as produced for ZDoom, and it's designed to be compatible with the functions and definitions provided in ''zcommon.acs''.

	Comprehensive information regarding the ACS language for Hexen can be found at the [http://doomlegacy.sourceforge.net/hosted/hexenspec09.txt Official Hexen Technical Specs] by Ben Morris and Ben Gokey.		Comprehensive information regarding the ACS language for Hexen can be found at the [http://doomlegacy.sourceforge.net/hosted/hexenspec09.txt Official Hexen Technical Specs] by Ben Morris and Ben Gokey.

	Most or all of the [[Detailed parameterized linedef specification\|parameterized]] specials can be called from ACS as functions, though the equivalent numbers they use (as listed in ''zspecial.acs'') are from the Hexen ~~namespace~~. This is also to keep easy compatibility with ''zcommon.acs'', so there will be as little need as possible to rewrite the include files.		Most or all of the [[Detailed parameterized linedef specification\|parameterized]] specials can be called from ACS as functions, though the equivalent numbers they use (as listed in ''zspecial.acs'') are from the Hexen and UDMF namespaces. This is also to keep easy compatibility with ''zcommon.acs'', so there will be as little need as possible to rewrite the include files.
	{{Backto\|Editing reference}}		{{Backto\|Editing reference}}

	== Using ACS for your map ==		== Using ACS for your map ==

			=== Doom (classic) format maps ===
			This information does not apply for UDMF or Hexen format maps.

	ACS scripts can be loaded with Doom-format maps through the help of [[MapInfo\|EMAPINFO]] and [[ExtraData]]. The MapInfo entry for the map needs at least a specifier for its ExtraData lump and compiled ACS lump (setting the '''extradata''' and '''acsscript''' entries).		ACS scripts can be loaded with Doom-format maps through the help of [[MapInfo\|EMAPINFO]] and [[ExtraData]]. The MapInfo entry for the map needs at least a specifier for its ExtraData lump and compiled ACS lump (setting the '''extradata''' and '''acsscript''' entries).

	The script can be written in a text editor and compiled using acc. ~~Wad tools like SLADE also have the capability to compile ACS scripts~~. After obtaining the behavior lump (usually with the .o extension), import it in a wad and place it between lumps '''A_START''' and '''A_END'''. The '''acsscript''' entry from EMAPINFO should then reference this compiled lump.		The script can be written in a text editor and compiled using the '''acc''' tool (see https://devbuilds.drdteam.org/ACC/). After obtaining the behavior lump (usually with the .o extension), import it in a wad and place it between lumps '''A_START''' and '''A_END'''. The '''acsscript''' entry from EMAPINFO should then reference this compiled lump.

			Wad tools like SLADE also have the capability to compile ACS scripts from source lumps, and will automatically place them inside '''A_START''' and '''A_END''', creating these marker lumps if necessary.

			''Important'': do not place the compiled ACS script as a BEHAVIOR lump after the level lumps, as it is done in Hexen or UDMF format maps. This will cause Eternity to assume your map is designed in the Hexen format (with Hexen-format THINGS and LINEDEFS), despite it being in the Doom format, resulting in errors or unpredictable effects when loading the level.

			ACS scripts will be callable from map linedefs by using the parameterized script specials or the legacy non-parameterized specials.

	''~~Important~~''~~: do not place~~ the ~~compiled ACS script as~~ a BEHAVIOR lump after the level ~~lumps, as it is done in Hexen-format maps. This will cause Eternity to assume your map is designed in the Hexen format~~ (~~with such specified THINGS and LINEDEFS~~)~~, despite it being in the Doom format, resulting in errors or unpredictable effects when loading the level~~.		=== Hexen format ===
			Most editors which support ZDoom and Hexen editing should have the ability to compile scripts built-in. Otherwise, you can still use the command-line '''acc''' tool and import the resulting '''.o''' file into a '''BEHAVIOR''' lump after the last level lump ('''BLOCKMAP''').

	~~ACS scripts will~~ be ~~callable from map linedefs by using~~ the ~~parameterized script specials or the legacy non~~-~~parameterized specials which used to call FraggleScript or Small before they were removed~~.		=== UDMF format ===
			This is similar to the Hexen format, except that '''BEHAVIOR''' has to be placed within the '''TEXTMAP''' - '''ENDMAP''' lump range.

	== Calling ACS scripts from actor frames ==		== Calling ACS scripts from actor frames ==

	Eternity actors can call ACS scripts directly, by using the [[StartScript]] codepointer.		Eternity actors can call ACS scripts directly, by using the [[StartScript]] codepointer. Named scripts are also supported, and generally recommended, using the [[StartScriptNamed]] codepointer.

	== Testing ACS scripts from console ==		== Testing ACS scripts from console ==

Printz: Updated the description, removed wrong or outdated information

2016-07-22T06:43:26Z

Updated the description, removed wrong or outdated information

← Older revision		Revision as of 02:43, 22 July 2016
Line 1:		Line 1:
	For the upcoming Hexen implementation, Eternity supports ACS scripts. ~~Note that unlike in ZDoom,~~ it ~~requires~~ the vanilla Hexen ~~format~~, ~~which~~ can ~~be compiled using~~ modern ~~ACC by using the -h command-line switch, or by using an old version of ACC. Comprehensive information regarding the~~ ACS ~~language~~ for ~~Hexen can~~ be ~~found at~~ the ~~[http://doomlegacy.sourceforge.net/hosted/hexenspec09~~.~~txt Official Hexen Technical Specs] by Ben Morris and Ben Gokey~~.		For the upcoming Hexen implementation, Eternity supports ACS scripts. As well as it can run the vanilla Hexen ACS script bytecodes, it can run the modern ACS as produced for ZDoom, and it's designed to be compatible with the functions and definitions provided in ''zcommon.acs''.

	~~All~~ [[Detailed parameterized linedef specification\|parameterized]] specials can be called from ACS as functions.		Comprehensive information regarding the ACS language for Hexen can be found at the [http://doomlegacy.sourceforge.net/hosted/hexenspec09.txt Official Hexen Technical Specs] by Ben Morris and Ben Gokey.

			Most or all of the [[Detailed parameterized linedef specification\|parameterized]] specials can be called from ACS as functions, though the equivalent numbers they use (as listed in ''zspecial.acs'') are from the Hexen namespace. This is also to keep easy compatibility with ''zcommon.acs'', so there will be as little need as possible to rewrite the include files.
	{{Backto\|Editing reference}}		{{Backto\|Editing reference}}

	== Using ACS for your map ==		== Using ACS for your map ==

	ACS scripts can be ~~used~~ with Doom-format maps through the help of [[MapInfo\|EMAPINFO]] and [[ExtraData]]. The MapInfo entry for the map needs at least a specifier for its ExtraData lump and compiled ACS lump (setting the '''extradata''' and '''acsscript''' entries).		ACS scripts can be loaded with Doom-format maps through the help of [[MapInfo\|EMAPINFO]] and [[ExtraData]]. The MapInfo entry for the map needs at least a specifier for its ExtraData lump and compiled ACS lump (setting the '''extradata''' and '''acsscript''' entries).

	The script can be written in a text editor and compiled using acc (or, in ~~new ACC~~'~~s case, acc -h)~~ and ~~imported with a tool like SLADE3, which supports editing your map with Doom Builder 2 simultaneously~~.		The script can be written in a text editor and compiled using acc. Wad tools like SLADE also have the capability to compile ACS scripts. After obtaining the behavior lump (usually with the .o extension), import it in a wad and place it between lumps '''A_START''' and '''A_END'''. The '''acsscript''' entry from EMAPINFO should then reference this compiled lump.

	''Important'': ~~don't set~~ the ~~acs~~ script ~~name to~~ BEHAVIOR ~~and put~~ it ~~after BLOCKMAP~~. This will ~~break forward compatibility of~~ your map ~~with future versions of Eternity that support~~ the Hexen format, ~~which can be identified by looking for~~ the ~~annexed BEHAVIOR lump. Only use BEHAVIOR when Hexen and/or UDMF~~ format ~~becomes possible~~ in ~~Eternity~~.		''Important'': do not place the compiled ACS script as a BEHAVIOR lump after the level lumps, as it is done in Hexen-format maps. This will cause Eternity to assume your map is designed in the Hexen format (with such specified THINGS and LINEDEFS), despite it being in the Doom format, resulting in errors or unpredictable effects when loading the level.

	ACS scripts will be callable from map linedefs by using the parameterized ~~365 ('''ACS_Execute''') special through an ExtraData record of~~ the ~~linedef. Note that currently there is no ACS_ExecuteAlways special~~.		ACS scripts will be callable from map linedefs by using the parameterized script specials or the legacy non-parameterized specials which used to call FraggleScript or Small before they were removed.

	== Calling ACS scripts from actor frames ==		== Calling ACS scripts from actor frames ==

Printz: added link to functions

2016-01-23T12:58:34Z

added link to functions

← Older revision		Revision as of 08:58, 23 January 2016
Line 22:		Line 22:
	ACS scripts can be tested from the [[console]] by using the '''puke''' command.		ACS scripts can be tested from the [[console]] by using the '''puke''' command.

	== ACS ~~spawn IDs~~ ==		== ACS details ==
	~~See~~ [[ACS spawn IDs]].		*[[ACS spawn IDs]]
			*[[ACS built-in functions]]

	[[Category:Editing reference]]		[[Category:Editing reference]]