Scripting - Revision history

Hendricks266: /* Drawing to the screen */

2014-01-31T19:58:15Z

Drawing to the screen

← Older revision		Revision as of 12:58, 31 January 2014
Line 104:		Line 104:

	*[[rotatesprite]]		*[[rotatesprite]]
	*[[~~gametext]]~~		*[[screentext]]
	*[[minitext]]
	*[[digitalnumber]]

	===Custom projectiles===		===Custom projectiles===

Hendricks266: /* Formatting */

2012-12-03T04:23:29Z

Formatting

← Older revision		Revision as of 21:23, 2 December 2012
Line 135:		Line 135:
	*Only use '''{''' braces '''}''' for if conditions when you intend to execute more than one command if the condition is true. If you only have one command, do not use braces. Braces tell the CON compiler specifically to branch, which slows down your code a tiny fraction. Another if condition counts as one command.		*Only use '''{''' braces '''}''' for if conditions when you intend to execute more than one command if the condition is true. If you only have one command, do not use braces. Braces tell the CON compiler specifically to branch, which slows down your code a tiny fraction. Another if condition counts as one command.
	**The exception is that if you have an [[else]] following multiple non-braced if conditions where it may be ambiguous, you need to add braces to ensure the else is used correctly.		**The exception is that if you have an [[else]] following multiple non-braced if conditions where it may be ambiguous, you need to add braces to ensure the else is used correctly.
	*Because [[event]]s can be defined multiple times in an additive fashion, keep separate instances in your own organization scheme based on ~~what~~ your events do. Writing a con file named '''events.con''' is HIGHLY discouraged.		*Because [[event]]s can be defined multiple times in an additive fashion, keep separate instances in your own organization scheme based on the '''function''' of your events. Writing a con file named '''events.con''' is HIGHLY discouraged.

	===Methodology===		===Methodology===

Hendricks266 at 00:13, 8 July 2012

2012-07-08T00:13:09Z

← Older revision		Revision as of 17:13, 7 July 2012
Line 82:		Line 82:
	The '''input''' structure holds data about what game-defined control functions are being operated.		The '''input''' structure holds data about what game-defined control functions are being operated.

	Check out the pages linked above for a full index of the various ~~structure~~ available in scripting.		Check out the pages linked above for a full index of the various structures available in scripting.

	===Events===		===Events===
Line 118:		Line 118:
	===String manipulation===		===String manipulation===

	[[:Category:String manipulation\|Strings]] (lines of text) are called "quotes" in Duke Nukem 3D. String manipulation consists of some simple copying and concatenation commands, as well as the ability to print the text to the screen.		[[:Category:String manipulation\|Strings]] (lines of text) are called "quotes" in Duke Nukem 3D. String manipulation consists of some simple copying and concatenation commands, as well as the ability to print the text to the screen and to the log file.

	==Scripting Guidelines==		==Scripting Guidelines==
Line 129:		Line 129:

	===Formatting===		===Formatting===
	*Always comment your code! It will help you and ~~other~~ later, and it will also help keep the code straightforward.		*Always comment your code! It will help you and others later, and it will also help keep the code straightforward.
	*Indentation is key. Every level of code ("if" and "[[switch]]" statements, loops, and [[:Category:All commands#Block Delimiting\|delimited blocks]]) should be indented with four spaces. TAB characters should be avoided.		*Indentation is key. Every level of code ("if" and "[[switch]]" statements, loops, and [[:Category:All commands#Block Delimiting\|delimited blocks]]) should be indented with four spaces. TAB characters should be avoided.
	*[[Label]]s, [[gamevar]]s, [[action]]s, [[move]]s, and [[AI]]s are case-sensitive and cannot start with numbers. Do not use the same names as CON commands.		*[[Label]]s, [[gamevar]]s, [[action]]s, [[move]]s, and [[AI]]s are case-sensitive and cannot start with numbers. Do not use the same names as CON commands.
	*<code>if<something> [[nullop]] [[else]] (...)</code> is a common construction used when an if condition lacks a NOT variant.		*<code>if<something> [[nullop]] [[else]] (...)</code> is a common construction used when an if condition lacks a NOT variant.
	*Only use '''{''' braces '''}''' for if conditions when you intend to execute more than one command if the condition is true. If you only have one command, do not use braces. Braces tell the CON compiler specifically to branch, which slows down your code a tiny fraction. Another if condition counts as one command.		*Only use '''{''' braces '''}''' for if conditions when you intend to execute more than one command if the condition is true. If you only have one command, do not use braces. Braces tell the CON compiler specifically to branch, which slows down your code a tiny fraction. Another if condition counts as one command.
	**The exception is that if you have an [[else]] ~~with~~ multiple non-braced conditions where it may be ambiguous, you need to add braces to ensure the else is used correctly.		**The exception is that if you have an [[else]] following multiple non-braced if conditions where it may be ambiguous, you need to add braces to ensure the else is used correctly.
	*Because [[event]]s can be defined multiple times in an additive fashion, keep separate instances in your own organization scheme based on what your events do. Writing a con file named '''events.con''' is HIGHLY discouraged.		*Because [[event]]s can be defined multiple times in an additive fashion, keep separate instances in your own organization scheme based on what your events do. Writing a con file named '''events.con''' is HIGHLY discouraged.

Hendricks266 at 02:10, 25 May 2012

2012-05-25T02:10:56Z

← Older revision		Revision as of 19:10, 24 May 2012
Line 152:		Line 152:
	*[[defineprojectile\|projectile information]]		*[[defineprojectile\|projectile information]]
	*[[Tutorials]]		*[[Tutorials]]

			[[Category:Scripting documentation]]

Hendricks266: /* Formatting */

2012-05-25T00:31:34Z

Formatting

← Older revision		Revision as of 17:31, 24 May 2012
Line 129:		Line 129:

	===Formatting===		===Formatting===
	*Always comment your code! It will help you and other later, and it will also help the code straightforward.		*Always comment your code! It will help you and other later, and it will also help keep the code straightforward.
	*Indentation is key. Every level of code ("if" and "[[switch]]" statements, loops, and [[:Category:All commands#Block Delimiting\|delimited blocks]]) should be indented with four spaces. TAB characters should be avoided.		*Indentation is key. Every level of code ("if" and "[[switch]]" statements, loops, and [[:Category:All commands#Block Delimiting\|delimited blocks]]) should be indented with four spaces. TAB characters should be avoided.
	*[[Label]]s, [[gamevar]]s, [[action]]s, [[move]]s, and [[AI]]s are case-sensitive and cannot start with numbers. Do not use the same names as CON commands.		*[[Label]]s, [[gamevar]]s, [[action]]s, [[move]]s, and [[AI]]s are case-sensitive and cannot start with numbers. Do not use the same names as CON commands.

Hendricks266 at 01:04, 24 May 2012

2012-05-24T01:04:34Z

Show changes

Hendricks266: /* Scripting Guidelines */

2012-05-24T00:03:18Z

Scripting Guidelines

← Older revision		Revision as of 17:03, 23 May 2012
Line 150:		Line 150:
	When scripting, there are guidelines that you should follow in order to keep your code clean, concise, correct, and optimized.		When scripting, there are guidelines that you should follow in order to keep your code clean, concise, correct, and optimized.

			===Design===

			*If you are making a mini-mod, consider creating a [[CON mutator]].

			===Formatting===
	*Always comment your code! It will help you and other later, and it will also help the code straightforward.		*Always comment your code! It will help you and other later, and it will also help the code straightforward.
	*~~If you~~ are ~~making a mini~~-~~mod, consider creating a~~ [[~~CON mutator~~]].		*Indentation is key. Every level of code ("if" and "[[switch]]" statements, loops, and [[:Category:All commands#Block Delimiting\|delimited blocks]]) should be indented with four spaces. TAB characters should be avoided.
	*Only use '''{''' braces '''}''' for if conditions when you intend to execute more than one command if the condition is true. If you only have one command, do not use braces. Braces tell the CON compiler specifically to branch, which slows down your code a tiny fraction. Another if condition counts as one command. ~~However,~~ if you have an [[else]] with multiple non-braced conditions where it may be ambiguous, you need to add braces to ensure the else is used correctly.		*[[Label]]s, [[gamevar]]s, [[action]]s, [[move]]s, and [[AI]]s are case-sensitive and cannot start with numbers. Do not use the same names as CON commands.
			*<code>if<something> [[nullop]] [[else]] (...)</code> is a common construction used when an if condition lacks a NOT variant.
			*Only use '''{''' braces '''}''' for if conditions when you intend to execute more than one command if the condition is true. If you only have one command, do not use braces. Braces tell the CON compiler specifically to branch, which slows down your code a tiny fraction. Another if condition counts as one command.
			**The exception is that if you have an [[else]] with multiple non-braced conditions where it may be ambiguous, you need to add braces to ensure the else is used correctly.
			*Because [[event]]s can be defined multiple times in an additive fashion, keep separate instances in your own organization scheme based on what your events do. Writing a con file named '''events.con''' is HIGHLY discouraged.

			===Methodology===
	*Not all "temp" variables are created equal. [[Gamevar]]s used only to perform a mathematical calculations and not to store values afterwards should be declared GLOBAL to save memory. Remember, the game VM that runs CON code will always be single-threaded by nature. If you are using a [[gamevar]] to store a value to be preserved between [[tic]]s, simply to save it for use later, or for a construct like a counter, it should be declared PERACTOR.		*Not all "temp" variables are created equal. [[Gamevar]]s used only to perform a mathematical calculations and not to store values afterwards should be declared GLOBAL to save memory. Remember, the game VM that runs CON code will always be single-threaded by nature. If you are using a [[gamevar]] to store a value to be preserved between [[tic]]s, simply to save it for use later, or for a construct like a counter, it should be declared PERACTOR.

Hendricks266 at 23:34, 23 May 2012

2012-05-23T23:34:24Z

Show changes

Hank: /* CON Basics */

2012-02-17T23:24:50Z

CON Basics

← Older revision		Revision as of 16:24, 17 February 2012
Line 13:		Line 13:

	Another good source of basic information is the following FAQ:		Another good source of basic information is the following FAQ:
	* [http://~~rtcm.thecomitatus~~.com/knowledge-base/downloads-rtcm/duke3d-faqs-con/~~H_CONFAQ~~.zip Con Editing Information v1.3 by James Ferry]		* [http://dukertcm.com/knowledge-base/downloads-rtcm/duke3d-faqs-con/confaq42.zip Con Editing Information v1.3 by James Ferry]

	==Gamevars==		==Gamevars==

Hendricks266 at 03:18, 20 August 2011

2011-08-20T03:18:16Z

← Older revision		Revision as of 20:18, 19 August 2011
Line 40:		Line 40:
	* '''Per-player variable''': If a variable is declared as per-player, there is one copy of it for each player in the game, meaning that the variable is set independently for each player. If a player performs an action that triggers a per-player variable change within an event or the APLAYER actor code, it will only change for the player that initiated that action. If an actor changes a per-player variable, it will change for the closest player to the actor what changed it. You can use the [[setplayervar]] command to set a per-player var for a particular player who is not the closest one, but this is only necessary in multiplayer games (and even then it is seldom necessary). In single player games, there is little practical difference between a global gamevar and a per-player variable.		* '''Per-player variable''': If a variable is declared as per-player, there is one copy of it for each player in the game, meaning that the variable is set independently for each player. If a player performs an action that triggers a per-player variable change within an event or the APLAYER actor code, it will only change for the player that initiated that action. If an actor changes a per-player variable, it will change for the closest player to the actor what changed it. You can use the [[setplayervar]] command to set a per-player var for a particular player who is not the closest one, but this is only necessary in multiplayer games (and even then it is seldom necessary). In single player games, there is little practical difference between a global gamevar and a per-player variable.

	* '''Per-actor variable''': If a variable is declared as per-actor, then there is separate copy of it for each sprite in the game. That means that every monster, projectile, player, decorative sprite -- pretty much anything in the game that isn't a wall or sector -- has its own copy of the variable. This is useful if you want to have actors other than the player store information for more than one ~~tick~~. For example, suppose you want each monster to keep track of how many bullets it has fired:		* '''Per-actor variable''': If a variable is declared as per-actor, then there is separate copy of it for each sprite in the game. That means that every monster, projectile, player, decorative sprite -- pretty much anything in the game that isn't a wall or sector -- has its own copy of the variable. This is useful if you want to have actors other than the player store information for more than one [[tic]]. For example, suppose you want each monster to keep track of how many bullets it has fired:

	gamevar shots_fired 0 2		gamevar shots_fired 0 2