Mirrors/re3
1
0
Fork 0
mirror of https://github.com/GTAmodding/re3.git synced 2021-02-19 17:49:54 +01:00
Code Issues Projects Releases Wiki Activity

updated guidelines

Browse Source
This commit is contained in:
aap 2019-06-16 23:33:20 +02:00
parent 93223b2bac
commit e8c5f7da52
1 changed files with 37 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@ -24,6 +24,7 @@ to reverse at the time, calling the original functions is acceptable.
This is a list of some things that have been reversed to some non-trivial extent. This is a list of some things that have been reversed to some non-trivial extent.
Not everything is listed, check the code. Not everything is listed, check the code.
(TODO: keep this list at least a bit up to date...)
``` ```
CPool CPool
@ -52,6 +53,11 @@ CPathFind
CCam CCam
CParticle CParticle
CParticleMgr CParticleMgr
CPointLights
CCoronas
CAntennas
CClouds
CHud
``` ```
# Low hanging fruit # Low hanging fruit
@ -79,9 +85,12 @@ functionname(args)
if(a == b){ if(a == b){
s1; s1;
s2; s2;
}else{
s3;
s4;
} }
if(x != y) if(x != y)
s3; s5;
} }
type functionname(args) type functionname(args)
@ -89,9 +98,12 @@ type functionname(args)
if (a == b) { if (a == b) {
s1; s1;
s2; s2;
} else {
s3;
s4;
} }
if (x != y) if (x != y)
s3; s5;
} }
``` ```
@ -105,14 +117,31 @@ type functionname ( args )
s1; s1;
s2; s2;
} }
if ( x != y ) else
{ {
s3; s3;
s4;
}
if ( x != y )
{
s5;
} }
} }
``` ```
Indentation is done with TABS. i.e.
* Put the brace on the same line as control statements
* Put the brace on the next line after function definitions and structs/classes
* Put an `else` on the same line with the braces
* Don't put braces around single statements
* Put the function return type on a separate line
* Indent with TABS
As for the less cosmetic choices, here are some guidelines how the code should look: As for the less cosmetic choices, here are some guidelines how the code should look:
@ -124,6 +153,8 @@ since `4` will be used in other places and you can't easily see where else the e
* Use the right types. In particular: * Use the right types. In particular:
* use the lower case types! (unless you're Fire_Head)
* don't use types like `__int16`, we have `int16` for that * don't use types like `__int16`, we have `int16` for that
* don't use `unsigned`, we have typedefs for that * don't use `unsigned`, we have typedefs for that
@ -132,6 +163,8 @@ since `4` will be used in other places and you can't easily see where else the e
* don't even think about using win32 types (`BYTE`, `WORD`, &c.) unless you're writing win32 specific code * don't even think about using win32 types (`BYTE`, `WORD`, &c.) unless you're writing win32 specific code
* declare pointers like `int *ptr;`, not `int* ptr;`
* As for variable names, the original gta source code was not written in a uniform style, * As for variable names, the original gta source code was not written in a uniform style,
but here are some observations: but here are some observations: