Coding info: Difference between revisions

Latest revision as of 17:37, 12 March 2020

This page has information which would be useful for anyone who is doing coding for MTA SA. Coding guidelines also has a lot of useful info.

Also useful:

Our project is organised into a number of different directories which serve different purposes:

Client
Server
Shared: contains code shared between both the client and the server
utils: utilities used to automate certain tasks
vendor: unmodified third-party code and libraries (optionally linked to the appropriate third-party Git repository through Git submodules).

Client - Core: Typically UI elements like main menu etc and isn't ever unloaded.
Client - Deathmatch: Where MTA makes all it's functions and events do stuff.
Client - Game SA: Low level stuff which is mainly function calls to the game so each element will have a game_sa class like Vehicle, Ped, Object etc.
Client - GUI: It's just wrappers to CEGUI, you need not touch.
Client - Launch: Is the MTA executable which loads loader, you need not touch.
Client - Loader: You need not touch the loader either.
Client - Multiplayer SA: Hooks, code modification and that sort of low level things that lets us work.
Server - Core: Cazomino05: "I genuinely don't really know why we have server core."
Server - Dbconmy: Stuff to do with the db* functions, you need not touch.
Server - Deathmatch: All the server logic and storage classes for elements as well as Lua stuff.
Server - Launcher: Just an executable to load all the DLLs we need.
Shared - XML Module: XML module is just tinyxml and some high level wrapper functions for stuff we need.
Dependencies: Has a load of 3rd party code, modules like sqlite, curl, lua, ehs, etc.
CEGUI: Crazy Eddie's GUI system is a graphical user interface C++ library.

Some of the code may be explained in detail in pages under the this category: Classes (Blue)

MTA has some type definitions you can use (Can be found in Shared/sdk/SharedUtil.h)

MTA has some commands which you can use if you're running debug mode

@@ Line 2: / Line 2: @@
 This page has information which would be useful for anyone who is doing coding for MTA SA. [[Coding guidelines]] also has a lot of useful info.
+Also useful:
+* [[Compiling_MTASA|Compiling MTASA on Windows]]
+* [[Building_MTASA_Server_on_GNU_Linux|Compiling MTASA on GNU/Linux]]
+== Directory Structure ==
+Our project is organised into a number of different directories which serve different purposes:
+* '''Client'''
+* '''Server'''
+* '''Shared''': contains code shared between both the client and the server
+* '''utils''': utilities used to automate certain tasks
+* '''vendor''': unmodified third-party code and libraries (optionally linked to the appropriate third-party Git repository through Git submodules).
 == Projects explained ==
@@ Line 19: / Line 34: @@
 * Dependencies: Has a load of 3rd party code, modules like sqlite, curl, lua, ehs, etc.
 * CEGUI: Crazy Eddie's GUI system is a graphical user interface C++ library.
+Some of the code may be explained in detail in pages under the this category: [[:Category:Classes (Blue)|Classes (Blue)]]
 == Simplification of data types ==
@@ Line 77: / Line 94: @@
 * CCLIENTPED - Ped
 * CCLIENTPROJECTILE - Projectile
+* CCLIENTIFP - EngineIFP
 * CCLIENTGUI:
 * CGUI_BUTTON - GuiButton
@@ Line 108: / Line 126: @@
 * CCLIENTSCREENSOURCE - DxScreenSource
 * CCLIENTRENDERTARGET - DxRenderTarget
+[[Category: Development]]