User:Altazimuth/Code Guide - Revision history

Altazimuth: Use new doomwiki template.

2016-10-02T08:11:30Z

Use new doomwiki template.

← Older revision		Revision as of 04:11, 2 October 2016
Line 16:		Line 16:
	\|-		\|-
	! AM_		! AM_
	\| Automap Code \|\| Code and functions associated with the Automap \|\| ~~[http://~~doomwiki~~.org/wiki/~~Automap ~~Automap]~~		\| Automap Code \|\| Code and functions associated with the Automap \|\| {{doomwiki\|Automap}}
	\|-		\|-
	! AMX_		! AMX_

Altazimuth: Update link to action specials.

2016-09-21T17:20:45Z

Update link to action specials.

← Older revision		Revision as of 13:20, 21 September 2016
Line 40:		Line 40:
	\|-		\|-
	!EV_		!EV_
	\| Events Code \|\| Code and functions handling in-game events, as well as the line system and sector specials \|\| [[~~Line actions~~]]		\| Events Code \|\| Code and functions handling in-game events, as well as the line system and sector specials \|\| [[Action specials]]
	\|-		\|-
	! F_		! F_

Altazimuth: Fixed stuff. Filled out the table more.

2016-06-07T16:56:50Z

Fixed stuff. Filled out the table more.

← Older revision		Revision as of 12:56, 7 June 2016
Line 28:		Line 28:
	\|-		\|-
	! Confuse		! Confuse
	\| libConfuse Code \|\| Code and functions associated with the libConfuse configuration file parser library \|\| ~~[https://github.com/martinh/libconfuse libConfuse on GitHub]~~		\| libConfuse Code \|\| Code and functions associated with the libConfuse configuration file parser library \|\|
	\|-		\|-
	! D_		! D_
	\| \|\| \|\|		\| Core Code \|\| Core engine code such as initialisation, main loop, and high-level netcode \|\|
	\|-		\|-
	! doom		! doom
	\| \|\| \|\|		\| Doom Code \|\| Files that came from the original Doom engine\|\|
	\|-		\|-
	! E_		! E_
Line 40:		Line 40:
	\|-		\|-
	!EV_		!EV_
	\| ~~Line Action~~ Code \|\| Code and functions handling the ~~generalised~~ line ~~action~~ system \|\| [[Line actions]]		\| Events Code \|\| Code and functions handling in-game events, as well as the line system and sector specials \|\| [[Line actions]]
	\|-		\|-
	! F_		! F_
Line 46:		Line 46:
	\|-		\|-
	! G_		! G_
	\| Game Code \|\| \|\|		\| Game State FSA Code \|\| Contains the finite-state automaton for game state, as well as demo playback and recording \|\|
	\|-		\|-
	! GL		! GL
Line 61:		Line 61:
	\|-		\|-
	! M_		! M_
	\| \|\| \|\|		\| Miscellaneous Utilities \|\| \|\|
	\|-		\|-
	! MetaAPI		! MetaAPI
	\| \|\| \|\|		\| Metatables and objects \|\| Handles stuff like storage of multiple types in an associative array, or provision of an adapter class for storage of qstrings as metatable properties \|\|
	\|-		\|-
	! Misc		! Misc
Line 73:		Line 73:
	\|-		\|-
	! P_		! P_
	\| \|\| \|\|		\| Playsim/Playloop \|\| Covers a huge range of stuff like animations, portals, chasecam, etc. \|\|
	\|-		\|-
	! R_		! R_

Altazimuth: Filled out table more. Put in basic control flow.

2016-06-07T12:55:31Z

Filled out table more. Put in basic control flow.

← Older revision		Revision as of 08:55, 7 June 2016
Line 1:		Line 1:
	Eternity's code is split into various prefixes. Each one refers to specific facets of the code. Functions from these files will also be appropriately prefixed (note that the files have lower case prefixes, which functions have upper case).		Eternity's code is built up of .cpp (C++ source code) and .h (header) files split into various prefixes (though dependencies such as libpng may use regular C source files). Each one refers to specific facets of the code. Functions from these files will also be appropriately prefixed (note that the files have lower case prefixes, which functions have upper case).

	{\| class="wikitable" style="text-align: center;"		{\| class="wikitable" style="text-align: center;"
Line 43:		Line 43:
	\|-		\|-
	! F_		! F_
	\| \|\| \|\|		\| Finale Code \|\| Code and functions that handle game completion, final screen animations, and screen wipe effects \|\|
	\|-		\|-
	! G_		! G_
	\| \|\| \|\|		\| Game Code \|\| \|\|
	\|-		\|-
	! GL		! GL
	\| \|\| \|\|		\| OpenGL Code \|\| Code and functions that initialise and handle the OpenGL backend of the engine \|\|
	\|-		\|-
	! HAL		! HAL
	\| \|\| \|\|		\| Hardware Abstraction Layer Code \|\| Code that introduces layers of abstraction between software and hardware \|\| [https://en.wikipedia.org/wiki/Hardware_abstraction_layer Hardware abstraction layer]
	\|-		\|-
	! HU_		! HU_
	\| \|\| \|\|		\| Head-up Display Code \|\| Code and functions that handle the overlay and display of the player's HUD \|\|
	\|-		\|-
	! IN		! IN
	\| \|\| \|\|		\| Intermission Code \|\| Code and functions that handle level intermission screens \|\|
	\|-		\|-
	! M_		! M_
Line 67:		Line 67:
	\|-		\|-
	! Misc		! Misc
	\| \|\| \|\|		\| Miscellaneous Code \|\| \|\|
	\|-		\|-
	! Mn_		! Mn_
	\| \|\| \|\|		\| Menu Code \|\| Code and functions that run the menu engine \|\|
	\|-		\|-
	! P_		! P_
Line 76:		Line 76:
	\|-		\|-
	! R_		! R_
	\| \|\| \|\|		\| Rendering Code \|\| Code and functions that handle the rendering of the game \|\|
	\|-		\|-
	! S_		! S_
	\| \|\| \|\|		\| Sound Code \|\| Code and functions that handle sound loading and playback \|\|
	\|-		\|-
	! SDL_		! SDL_
	\| \|\| \|\|		\| SDL Code \|\| Mid-level code that uses the Simple DirectMedia Layer \|\|
	\|-		\|-
	! ST_		! ST_
	\| \|\| \|\|		\| Status Bar Code \|\| Code and functions that handle and define the status bar and palette indicates (e.g. bersek) \|\|
	\|-		\|-
	! T_		! T_
	\| \|\| \|\|		\| Plane Mover Code \|\| General plane mover routines (e.g. crushers, platforms, lifts) \|\|
	\|-		\|-
	! TXT_		! TXT_
	\| \|\| \|\|		\| Text Code \|\| Code and functions that handle the display of text \|\|
	\|-		\|-
	! V_		! V_
	\| \|\| \|\|		\| Video Code \|\| Code and functions that load and verify patches/pngs, store images internally, handle buffers, and various other video functionality \|\|
	\|-		\|-
	! W_		! W_
	\| \|\| \|\|		\| WAD/Resource Code \|\| Code functions that define and handles WADs/ZIPs, their loading, their formats, lump handling \|\|
	\|-		\|-
	! Win32		! Win32
	\| \|\| \|\|		\| Windows Code \|\| Code needed specifically for Windows machines \|\|
	\|-		\|-
	! XL_		! XL_
	\| \|\| \|\|		\| Parsing Code \|\| Parsing code for EMAPINFO, Hexen MAPINFO, MUSINFO, Hexen Script Lumps (SNDINFO/MUSINFO), and SNDINFO \|\|
	\|-		\|-
	! Z_		! Z_
	\| \|\| \|\|		\| Zone Memory Allocation Code \|\| Code to perform zone memory allocation, and to define the zone API \|\|
	\|}		\|}

			== Basic Control Flow ==
			The "main" (where we start) is located in i_main.cpp. In here various systems are initialised and then the real main function where the program happens is called: D_DoomMain(), located in d_main.cpp. In here D_DoomInit() and some other initialisation is performed. From here the game enters its main game loop within the block of code after the while(1).

Altazimuth: Added all prefixes/VS folder names. Filled out table some more.

2016-06-07T11:52:35Z

Added all prefixes/VS folder names. Filled out table some more.

@@ Line 1: / Line 1: @@
-Eternity's code is split into various prefixes. Each one refers to specific facets of the code.
+Eternity's code is split into various prefixes. Each one refers to specific facets of the code. Functions from these files will also be appropriately prefixed (note that the files have lower case prefixes, which functions have upper case).
 {| class="wikitable" style="text-align: center;"
-|+ Source file prefixes
+|+ Source File Classification
 |-
-! Prefix
+! style="width: 100px;" | Prefix/Visual Studio Folder Name
 ! Meaning
 ! Explanation
-! Related Article
+! Further Reading
 |-
 ! A_
-| Action Pointer Functions || Functions that are associated with actor states/frames || [[List of codepointers]]
+| Action Pointer Code || Code and functions associated with actor states/frames || [[List of codepointers]]
 |-
 ! ACS_
-| ACS Functions || Functions that handle the loading and execution of Action Code Script || [[ACS scripting]]
+| ACS Code || Code and functions that handle the loading and execution of Action Code Script || [[ACS scripting]]
 |}

Altazimuth: Initial creation of page. Getting the ball rolling. Saving what's already there in case of crash.

2016-06-07T10:53:40Z

Initial creation of page. Getting the ball rolling. Saving what's already there in case of crash.

New page

Eternity's code is split into various prefixes. Each one refers to specific facets of the code.

{| class="wikitable" style="text-align: center;"
|+ Source file prefixes
|-
! Prefix
! Meaning
! Explanation
! Related Article
|-
! A_
| Action Pointer Functions || Functions that are associated with actor states/frames || [[List of codepointers]]
|-
! ACS_
| ACS Functions || Functions that handle the loading and execution of Action Code Script || [[ACS scripting]]
|}