Console Script Grammar - Revision history

UTurista: /* CRD Argument Type */

2022-08-14T14:36:13Z

CRD Argument Type

← Older revision		Revision as of 14:36, 14 August 2022
Line 24:		Line 24:
	The first argument says what type of distribution should be used, the second and third depend on the type and the latter is called symmetry, and can affect any of the distributions; it will be explained later.		The first argument says what type of distribution should be used, the second and third depend on the type and the latter is called symmetry, and can affect any of the distributions; it will be explained later.

	The meaning of the second and third arguments, which are always '''~~integers~~''', varies depending on the type of distribution property specified. The four types for this first argument are:		The meaning of the second and third arguments, which are always '''numbers''', varies depending on the type of distribution property specified. The four types for this first argument are:
	CRD_NONE - do not vary the argument at all, just return the first number.		CRD_NONE - do not vary the argument at all, just return the first number.
	CRD_UNIFORM - uniform random distribution, between the two numbers specified.		CRD_UNIFORM - uniform random distribution, between the two numbers specified.

UTurista: Adds CRD Argument Type

2022-08-14T14:35:29Z

Adds CRD Argument Type

@@ Line 10: / Line 10: @@
 == Statements ==
-Statements are a command followed by a number of optionally "quoted", whitespace-seperated arguments. The number of arguments may be variable or strictly limited by the command in use.  The available commands is beyond the scope of this page, but a good portion of them are included with the editor. A full list is available by running GNU <code>strings</code> against your bf2.exe ;)
+Statements are a command followed by a number of optionally "quoted", whitespace-seperated arguments.
 == Variables ==

UTurista: /* include and run */

2022-08-12T08:08:29Z

include and run

← Older revision		Revision as of 08:08, 12 August 2022
Line 46:		Line 46:

	== <code>include</code> and <code>run</code> ==		== <code>include</code> and <code>run</code> ==
	Both <code>include</code> and <code>run</code> trigger the interpretation of another .con file. They also have the ability to set ''arguments'', which are a special type of mutable variable. For example:		Both <code>include</code> and <code>run</code> trigger the interpretation of another .con file.
			They also have the ability to set ''arguments'', which are a special type of mutable variable. For example:
	run test.con 1 2 3		run test.con 1 2 3
	Runs test.con. In test.con, the variables <code>v_arg1</code>, <code>v_arg2</code> and <code>v_arg3</code> are set to <code>1</code>, <code>2</code> and <code>3</code> respectively.		Runs test.con. In test.con, the variables <code>v_arg1</code>, <code>v_arg2</code> and <code>v_arg3</code> are set to <code>1</code>, <code>2</code> and <code>3</code> respectively.

UTurista: Adds difference

2022-08-12T08:08:12Z

Adds difference

← Older revision		Revision as of 08:08, 12 August 2022
Line 46:		Line 46:

	== <code>include</code> and <code>run</code> ==		== <code>include</code> and <code>run</code> ==
	<code>include</code> and <code>run</code> ~~do similar things and may in fact be identical. These~~ trigger the interpretation of another .con file. They also have the ability to set ''arguments'', which are a special type of mutable variable. For example:		Both <code>include</code> and <code>run</code> trigger the interpretation of another .con file. They also have the ability to set ''arguments'', which are a special type of mutable variable. For example:
	run test.con 1 2 3		run test.con 1 2 3
	Runs test.con. In test.con, the variables <code>v_arg1</code>, <code>v_arg2</code> and <code>v_arg3</code> are set to <code>1</code>, <code>2</code> and <code>3</code> respectively. Typically this is used along with a conditional to do something for the editor mode, or to do something different for single player mode (a common use in BF1942, where this method also existed).		Runs test.con. In test.con, the variables <code>v_arg1</code>, <code>v_arg2</code> and <code>v_arg3</code> are set to <code>1</code>, <code>2</code> and <code>3</code> respectively.
			Typically this is used along with a conditional to do something for the editor mode, or to do something different for single player mode (a common use in BF1942, where this method also existed).

			As for differences, <code>run</code> seems to create a new scope while <code>include</code> does not.

	== An Example ==		== An Example ==

Pireax at 21:30, 26 April 2018

2018-04-26T21:30:36Z

← Older revision		Revision as of 21:30, 26 April 2018
Line 1:		Line 1:
	Con files are the core of how Battlefield 2 (and 1942 before it) configures its weapons, maps, objects, players and other game assets. These files can be run by the engine or from within the in-game console. The in-game console uses the exact same syntax with the notable difference that multi-line commands like `beginRem` do not work. With Battlefield 2, the console grammar has extended into a rudimentry scripting language, with loops and full conditionals. Battlefield 1942 had only very rudimentry conditionals.		Con files are the core of how Battlefield 2 (and 1942 before it) configures its weapons, maps, objects, players and other game assets. These files can be run by the engine or from within the in-game console. The in-game console uses the exact same syntax with the notable difference that multi-line commands like <code>beginRem</code> do not work. With Battlefield 2, the console grammar has extended into a rudimentry scripting language, with loops and full conditionals. Battlefield 1942 had only very rudimentry conditionals.

	== Comments ==		== Comments ==

Pireax at 21:26, 26 April 2018

2018-04-26T21:26:19Z

← Older revision		Revision as of 21:26, 26 April 2018
Line 1:		Line 1:
	Con files are the core of how Battlefield 2 (and 1942 before it) configures its weapons, maps, objects, players and other game assets. With Battlefield 2, the ~~con~~ grammar has extended into a rudimentry scripting language, with loops and full conditionals. Battlefield 1942 had only very rudimentry conditionals.		Con files are the core of how Battlefield 2 (and 1942 before it) configures its weapons, maps, objects, players and other game assets. These files can be run by the engine or from within the in-game console. The in-game console uses the exact same syntax with the notable difference that multi-line commands like `beginRem` do not work. With Battlefield 2, the console grammar has extended into a rudimentry scripting language, with loops and full conditionals. Battlefield 1942 had only very rudimentry conditionals.

	== Comments ==		== Comments ==

Pireax: Pireax moved page ConGrammar to Console Script Grammar

2018-04-26T21:21:44Z

Pireax moved page ConGrammar to Console Script Grammar

← Older revision	Revision as of 21:21, 26 April 2018
(No difference)

UTurista: Creating page

2017-09-09T23:07:09Z

Creating page

New page

Con files are the core of how Battlefield 2 (and 1942 before it) configures its weapons, maps, objects, players and other game assets. With Battlefield 2, the con grammar has extended into a rudimentry scripting language, with loops and full conditionals. Battlefield 1942 had only very rudimentry conditionals.

== Comments ==
There exist two classes of comments, block:
beginRem
this text is ignored
endRem
and line:
rem this text is ignored

== Statements ==
Statements are a command followed by a number of optionally "quoted", whitespace-seperated arguments. The number of arguments may be variable or strictly limited by the command in use. The available commands is beyond the scope of this page, but a good portion of them are included with the editor. A full list is available by running GNU <code>strings</code> against your bf2.exe ;)

== Variables ==
Variables must be predefined, and have a strict naming system. All mutable variables must begin with <code>v_</code> whereas all immutable variables or ''constants'' must begin with <code>c_</code>. It's a simple form of [[wikipedia:Hungarian Notation]].

=== Mutable Variables ===
The code:
var v_dongs = test
Defines a new variable called ''dongs'' or ''v_dongs'' depending on your point of view with the value "test". When defining a variable you can omit the default value however:
var v_dongs
is a value construct for example.

=== Immutable Variables ===
const c_butts = test
Defines a constant called, again, ''butts'' or ''c_butts'' with the value "test". Obviously, this variable cannot be changed.

=== <code>const</code> vs. <code>var</code> and assignments ===
Assigning to a variable is as simple as appending <code> -> v_varname</code> to any command. However, many commands do not return a value. The ones that do generally return either a boolean value (<code>0</code> or <code>1</code>) or a simple string.

Clearly, trying to assign to a <code>const</code> variable is an error and will not work.

== Conditionals ==
Conditionals include the standard <code>if ... endIf</code>, <code>if ... elseIf ... endIf</code> and <code>while ... endWhile</code> constructs. These evaluate an ''expression''.

=== Expressions ===
The grammar of an expression is roughly:
<variable> <comparator> <value>
Where
* ''variable'' is any variable name beginning with <code>v_</code> or <code>c_</code>.
* ''comparator'' is one of <code>==</code>, <code>!=</code>, <code>></code>, <code>>=</code>, <code><</code> or <code><=</code> or their textual equivalents: <code>lessOrEqualThan</code>, <code>lessThan</code>, <code>greaterOrEqualThan</code>, <code>greaterThan</code>, <code>notEquals</code>, <code>equals</code>.
* ''value'' is any literal string, quoted if neccessary.

== Return ==
You may cease interpretation of the current .con file by using the command <code>return</code>. This resumes interpretation from the calling file. It is an error to use this unless the file was called with...

== <code>include</code> and <code>run</code> ==
<code>include</code> and <code>run</code> do similar things and may in fact be identical. These trigger the interpretation of another .con file. They also have the ability to set ''arguments'', which are a special type of mutable variable. For example:
run test.con 1 2 3
Runs test.con. In test.con, the variables <code>v_arg1</code>, <code>v_arg2</code> and <code>v_arg3</code> are set to <code>1</code>, <code>2</code> and <code>3</code> respectively. Typically this is used along with a conditional to do something for the editor mode, or to do something different for single player mode (a common use in BF1942, where this method also existed).

== An Example ==
var v_tst
fileManager.fileExists movies/menu.bik -> v_tst
if v_tst == 0
fileManager.copyFile ../../mods/bf2/movies/menu.bik movies/menu.bik
fileManager.copyFile ../../mods/bf2/movies/menu_loggedin.bik movies/menu_loggedin.bik
endIf
This example checks if movies/menu.bik exists, and if it doesn't copies two files from the <code>bf2</code> mod to the current mod.