ACS directives - Revision history

Printz at 00:04, 15 July 2019

2019-07-15T00:04:12Z

← Older revision		Revision as of 20:04, 14 July 2019
Line 22:		Line 22:
	*'''<nowiki>#endregion</nowiki>'''		*'''<nowiki>#endregion</nowiki>'''
	:Define the start ({{c\|#region}}) and end ({{c\|#endregion}}) of a fold-able block of code. This is of use with text editors which support the ability to define ''code folders'' such as [https://doomwiki.org/wiki/Doom_Builder_2#Forks GZDoom Builder]'s script editor.		:Define the start ({{c\|#region}}) and end ({{c\|#endregion}}) of a fold-able block of code. This is of use with text editors which support the ability to define ''code folders'' such as [https://doomwiki.org/wiki/Doom_Builder_2#Forks GZDoom Builder]'s script editor.
			==See also==
			*[[ACS scripting]]
	[[Category:ACS]]		[[Category:ACS]]
	[[Category:Editing reference]]		[[Category:Editing reference]]

Printz: Added missing argument?

2017-04-08T09:54:46Z

Added missing argument?

← Older revision		Revision as of 05:54, 8 April 2017
Line 5:		Line 5:
	*'''<nowiki>#include</nowiki>''' ''filename''		*'''<nowiki>#include</nowiki>''' ''filename''
	:Includes the content of the given filename. It is generally used to include the common definition file ''zcommon.acs''.		:Includes the content of the given filename. It is generally used to include the common definition file ''zcommon.acs''.
	*'''<nowiki>#library</nowiki>'''		*'''<nowiki>#library</nowiki>''' ''name''
	:Defines the following code as a [[library]]. If used, it should be the very first directive, above even {{c\|#include "zcommon.acs"}}.		:Defines the following code as a [[library]]. If used, it should be the very first directive, above even {{c\|#include "zcommon.acs"}}.
	*'''<nowiki>#import</nowiki>''' ''~~library name~~''		*'''<nowiki>#import</nowiki>''' ''library_name''
	:Imports a [[library]]. This allows to use [[ACS\|scripts]], [[functions]], and [[constants]] defined in the library. Libraries should not be #included!		:Imports a [[library]]. This allows to use [[ACS\|scripts]], [[functions]], and [[constants]] defined in the library. Libraries should not be #included!
	*'''<nowiki>#define</nowiki>''' ''constant_name'' ''value''		*'''<nowiki>#define</nowiki>''' ''constant_name'' ''value''

Printz: Removed references to WadAuthor, because the editor was never tried on Eternity with ACS

2017-04-08T09:51:50Z

Removed references to WadAuthor, because the editor was never tried on Eternity with ACS

← Older revision		Revision as of 05:51, 8 April 2017
Line 16:		Line 16:
	:This directive prevents the compiler from "compacting" or "shrinking" the bytecode where possible. In effect, this forces it to use the ACSE format instead of the ACSe format. It has no effect if compiling in ACS0 format.		:This directive prevents the compiler from "compacting" or "shrinking" the bytecode where possible. In effect, this forces it to use the ACSE format instead of the ACSe format. It has no effect if compiling in ACS0 format.
	*'''<nowiki>#wadauthor</nowiki>'''		*'''<nowiki>#wadauthor</nowiki>'''
	:Forces the compiler to create a "valid" ACS0 stub (in addition to the ACSe or ACSE bytecode) so that ~~[https://doomwiki.org/wiki/WadAuthor WadAuthor]'s~~ error ~~checker~~ will not report ACS errors.		:Forces the compiler to create a "valid" ACS0 stub (in addition to the ACSe or ACSE bytecode) so that some old error checkers will not report ACS errors.
	*'''<nowiki>#nowadauthor</nowiki>'''		*'''<nowiki>#nowadauthor</nowiki>'''
	:Forces the compiler ''not'' to create a valid ACS0 stub. The bytecode will be slightly smaller as a result, but ~~WadAuthor's~~ error ~~checker~~ will mistakenly report that the compiled ACS is broken.		:Forces the compiler ''not'' to create a valid ACS0 stub. The bytecode will be slightly smaller as a result, but some old error checkers will mistakenly report that the compiled ACS is broken.
	*'''<nowiki>#region</nowiki>'''		*'''<nowiki>#region</nowiki>'''
	*'''<nowiki>#endregion</nowiki>'''		*'''<nowiki>#endregion</nowiki>'''

Printz at 09:49, 8 April 2017

2017-04-08T09:49:03Z

← Older revision		Revision as of 05:49, 8 April 2017
Line 22:		Line 22:
	*'''<nowiki>#endregion</nowiki>'''		*'''<nowiki>#endregion</nowiki>'''
	:Define the start ({{c\|#region}}) and end ({{c\|#endregion}}) of a fold-able block of code. This is of use with text editors which support the ability to define ''code folders'' such as [https://doomwiki.org/wiki/Doom_Builder_2#Forks GZDoom Builder]'s script editor.		:Define the start ({{c\|#region}}) and end ({{c\|#endregion}}) of a fold-able block of code. This is of use with text editors which support the ability to define ''code folders'' such as [https://doomwiki.org/wiki/Doom_Builder_2#Forks GZDoom Builder]'s script editor.
			[[Category:ACS]]
			[[Category:Editing reference]]

Printz: Added page from ZDoom's wiki.

2017-04-08T09:46:24Z

Added page from ZDoom's wiki.

New page

''This page contains text copied from the ZDoom wiki''

A '''directive''' in an [[ACS]] command beginning with a hash (or sharp) character (#); in the fashion of the {{wp|C preprocessor}} directives. Existing directives include:

*'''<nowiki>#include</nowiki>''' ''filename''
:Includes the content of the given filename. It is generally used to include the common definition file ''zcommon.acs''.
*'''<nowiki>#library</nowiki>'''
:Defines the following code as a [[library]]. If used, it should be the very first directive, above even {{c|#include "zcommon.acs"}}.
*'''<nowiki>#import</nowiki>''' ''library name''
:Imports a [[library]]. This allows to use [[ACS|scripts]], [[functions]], and [[constants]] defined in the library. Libraries should not be #included!
*'''<nowiki>#define</nowiki>''' ''constant_name'' ''value''
:This gives a text name to a value, allowing to make the code more readable and easier to update if a same value has to be used in several places. Constant names should only include uppercase letters, numerals, and underscores.
*'''<nowiki>#libdefine</nowiki>''' ''constant_name'' ''value''
:This is an alternative to #define which is used in libraries. A #libdefined constant can be used by scripts that #import the library that defined it.
*'''<nowiki>#nocompact</nowiki>'''
:This directive prevents the compiler from "compacting" or "shrinking" the bytecode where possible. In effect, this forces it to use the ACSE format instead of the ACSe format. It has no effect if compiling in ACS0 format.
*'''<nowiki>#wadauthor</nowiki>'''
:Forces the compiler to create a "valid" ACS0 stub (in addition to the ACSe or ACSE bytecode) so that [https://doomwiki.org/wiki/WadAuthor WadAuthor]'s error checker will not report ACS errors.
*'''<nowiki>#nowadauthor</nowiki>'''
:Forces the compiler ''not'' to create a valid ACS0 stub. The bytecode will be slightly smaller as a result, but WadAuthor's error checker will mistakenly report that the compiled ACS is broken.
*'''<nowiki>#region</nowiki>'''
*'''<nowiki>#endregion</nowiki>'''
:Define the start ({{c|#region}}) and end ({{c|#endregion}}) of a fold-able block of code. This is of use with text editors which support the ability to define ''code folders'' such as [https://doomwiki.org/wiki/Doom_Builder_2#Forks GZDoom Builder]'s script editor.