Category:Event manipulation - Revision history

Doom64hunter: Clarify the information present + formatting

2021-01-12T09:47:04Z

Clarify the information present + formatting

← Older revision		Revision as of 02:47, 12 January 2021
Line 6:		Line 6:

	== Usage ==		== Usage ==

			<span {{code}}>'''onevent''' ''<EVENT_NAME>'' ... '''endevent'''</span>

			<span {{code}}>'''appendevent''' ''<EVENT_NAME>'' ... '''endevent''' </span>


	Used outside of all [[actor]]s and [[state]]s, '''onevent''' and '''appendevent''' define a special block of CON code to be executed when a specific [[event]] happens in the game code. '''endevent''' is used to end the block.		Used outside of all [[actor]]s and [[state]]s, '''onevent''' and '''appendevent''' define a special block of CON code to be executed when a specific [[event]] happens in the game code. '''endevent''' is used to end the block.

			The only difference between '''onevent''' and '''appendevent''' is in how multiple definitions for the same event type are chained together, see [[#event_chaining\|Event Chaining]].

	[[gamevar]] MYMEDPACK 100 1		[[gamevar]] MYMEDPACK 100 1
Line 24:		Line 31:
	Please see the [[EDuke32 event list]] for a complete list of all events available.		Please see the [[EDuke32 event list]] for a complete list of all events available.

	== Event Chaining ==		==Event Chaining==

	~~The keyword '''appendevent''' performs the same function as '''onevent'''~~, ~~but with the difference that successive definitions of events are ''prepended'' with '''onevent''', and ''appended'' with '''appendevent'''. This is useful for keeping~~ your ~~CONs organized~~, ~~as well as to facilitate~~ [[~~CON mutator~~]]s.		When writing a large modification, it makes sense to split up your code into separate files, using the [[include]] directive.

	~~For example:~~		This is useful for keeping your CONs organized, as well as to facilitate [[CON mutator]]s. However, doing so may require you to use the same type of event across multiple files.

	definequote 666 ~~Placeholder.~~		This is where the difference between '''onevent''' and '''appendevent''' becomes important. When using multiple instances of '''onevent''', each block of code will be prepended to the previously defined block. This means that the code blocks for this type of event will be executed in reverse program order, starting with the last event. For '''appendevent''', the inverse applies, and the code is instead appended to the previously defined block.

			It is hence recommended to only use '''appendevent''' when defining multiple instances for the same type of event, as this will ensure that the code is executed in the order it was defined inside the scripts, and will reduce the amount of headaches and confusion when bugs occur.

			====Example====

			definequote 666 placeholder

	appendevent EVENT_ENTERLEVEL		appendevent EVENT_ENTERLEVEL
Line 56:		Line 69:
	echo 666		echo 666
	endevent		endevent

			Console output when starting a level:

	-2		-2
Line 63:		Line 78:
	2		2

	~~The~~ two commands are identical when defining the first instance of an event found when the game parses the CONs.		Note that the two commands are identical when defining the first instance of an event found when the game parses the CONs.

	== Terminating Execution ==		== Terminating Execution ==
Line 69:		Line 84:
	=== [[break]] ===		=== [[break]] ===

	The [[break]] keyword can be used to terminate the current event block.		The [[break]] keyword can be used to terminate the current event block. Any blocks appended after this will still be executed!

	definequote 666 This will print.		definequote 666 This will print.
Line 98:		Line 113:
	=== [[return]] ===		=== [[return]] ===

	The [[return]] keyword will ~~prevent any further execution of the event in~~ the block chain. Use with caution!		The [[return]] keyword will abort the entire block chain from executing. Use with caution!

	definequote 666 This will print.		definequote 666 This will print.
Line 120:		Line 135:
	This will print.		This will print.

	~~The command~~ also ~~functions~~ from [[state]]s.		It also aborts the event chain when [[return]] is called from inside a [[state]]. This is not the case for the [[break]] statement.

			Take special care '''not to''' use the [[return]] statement as you would in another programming language!

	definequote 666 This will print.		definequote 666 This will print.

Doom64hunter: Alter intro section

2021-01-12T08:50:07Z

Alter intro section

← Older revision		Revision as of 01:50, 12 January 2021
Line 1:		Line 1:
	Events are special occurrences in the game engine, ~~including~~ a ~~tick~~ in the game's 30 Hz state machine, ~~key presses~~, display calls, etc.		Events are special occurrences in the game engine. They allow modifications to inject custom code outside of actor definitions, which is executed before or after the corresponding game event.

			Some events also allows the outcome of the occurrence to be changed. For instance, for [[EVENT_CHANGEMENU]], one can alter the destination of a specific menu transition.

			Example events include the passing of tic time in the game's 30 Hz state machine, player keypresses, display rendering calls, etc.

	== Usage ==		== Usage ==

Hendricks266: /* return */

2015-04-04T01:28:05Z

return

← Older revision		Revision as of 18:28, 3 April 2015
Line 105:		Line 105:
	appendevent EVENT_ENTERLEVEL		appendevent EVENT_ENTERLEVEL
	echo 666		echo 666
			return
			echo 616
	endevent		endevent

	appendevent EVENT_ENTERLEVEL		appendevent EVENT_ENTERLEVEL
			echo 616
			endevent

			This will print.
			This will print.

			The command also functions from [[state]]s.

			definequote 666 This will print.
			definequote 616 This will never print.

			state example_state
	return		return
			ends

			appendevent EVENT_ENTERLEVEL
			echo 666
	endevent		endevent

	appendevent EVENT_ENTERLEVEL		appendevent EVENT_ENTERLEVEL
			echo 666
			state example_state
	echo 616		echo 616
	endevent		endevent

Hendricks266: /* Usage */

2015-04-04T01:24:58Z

Usage

← Older revision		Revision as of 18:24, 3 April 2015
Line 10:		Line 10:
	[[palfrom]] 32 0 0 32		[[palfrom]] 32 0 0 32
	[[addphealth]] 5		[[addphealth]] 5
	[[subvar]] [[MYMEDPACK]] 5		[[subvar]] MYMEDPACK 5
	[[setvar]] [[RETURN]] -1		[[setvar]] [[RETURN]] -1
	'''endevent'''		'''endevent'''

Hendricks266 at 01:19, 4 April 2015

2015-04-04T01:19:22Z

@@ Line 1: / Line 1: @@
-Events are special occurences in the game engine, including specific key presses, display calls, etc.  Events are also the only of the three CON entry points (the other two being [[actor]] and [[eventloadactor]] code) that may recurse, for example through [[EVENT_EGS]], [[EVENT_SPAWN]] or [[EVENT_KILLIT]].
+Events are special occurrences in the game engine, including a tick in the game's 30 Hz state machine, key presses, display calls, etc.
-Please see the [[EDuke32 event list]] for a complete list of all currently valid events in EDuke32.
+== Usage ==
 [[Category:All commands]]

Hendricks266 at 01:03, 24 May 2012

2012-05-24T01:03:03Z

← Older revision		Revision as of 18:03, 23 May 2012
Line 1:		Line 1:
			Events are special occurences in the game engine, including specific key presses, display calls, etc. Events are also the only of the three CON entry points (the other two being [[actor]] and [[eventloadactor]] code) that may recurse, for example through [[EVENT_EGS]], [[EVENT_SPAWN]] or [[EVENT_KILLIT]].

			Please see the [[EDuke32 event list]] for a complete list of all currently valid events in EDuke32.

	[[Category:All commands]]		[[Category:All commands]]

TX at 02:32, 25 September 2005

2005-09-25T02:32:15Z

New page

[[Category:All commands]]