mirror of
https://github.com/isledecomp/isle.git
synced 2024-11-22 15:48:09 -05:00
Update README.md [skip ci]
This commit is contained in:
parent
701c700d69
commit
9c0843e69b
1 changed files with 15 additions and 3 deletions
|
@ -71,7 +71,7 @@ Synthetic functions should be annotated with `SYNTHETIC`. A synthetic function i
|
|||
// MxList<MxRegionLeftRight *>::`scalar deleting destructor'
|
||||
```
|
||||
|
||||
## Virtual tables (**WIP**)
|
||||
## Virtual tables
|
||||
|
||||
Classes with a virtual table should be annotated using the `VTABLE` marker, which includes the module name and address of the virtual table. Additionally, virtual function declarations should be annotated with a comment indicating their relative offset. Please use the following example as a reference.
|
||||
|
||||
|
@ -86,7 +86,7 @@ public:
|
|||
virtual MxResult Create(MxU32 p_frequencyMS, MxBool p_createThread); // vtable+0x28
|
||||
```
|
||||
|
||||
## Class size (**WIP**)
|
||||
## Class size
|
||||
|
||||
Classes should be annotated using the `SIZE` marker to indicate their size. If you are unsure about the class size in the original binary, please use the currently available information (known member variables) and detail the circumstances in an extra comment if necessary.
|
||||
|
||||
|
@ -112,7 +112,7 @@ private:
|
|||
undefined4 m_unk0x14; // 0x14
|
||||
```
|
||||
|
||||
## Global variables (**WIP**)
|
||||
## Global variables
|
||||
|
||||
Global variables should be annotated using the `GLOBAL` marker, which includes the module name and address of the variable.
|
||||
|
||||
|
@ -127,6 +127,18 @@ MxAtomId* g_pz5Script = NULL;
|
|||
MxAtomId* g_introScript = NULL;
|
||||
```
|
||||
|
||||
## Strings
|
||||
|
||||
String values should be annotated using the `STRING` marker, which includes the module name and address of the string.
|
||||
|
||||
```
|
||||
inline virtual const char* ClassName() const override // vtable+0x0c
|
||||
{
|
||||
// STRING: LEGO1 0x100f03fc
|
||||
return "Act2PoliceStation";
|
||||
}
|
||||
```
|
||||
|
||||
# Tooling
|
||||
|
||||
Use `pip` to install the required packages to be able to use the Python tools found in this folder:
|
||||
|
|
Loading…
Reference in a new issue