pret / pokeplatinum

Decompilation of Pokémon Platinum
164 stars 56 forks source link

Standardize function names #213

Open lhearachel opened 1 month ago

lhearachel commented 1 month ago

Per discussion from Discord, we will be updating functions within the repository to follow a standard naming scheme for consistency. The new naming scheme for functions in the repository is: [<Module>_]<Imperative><Object>

Some common examples:

// Store the memory address of struct-member `bar` from `foo` in `out`.
void Foo_GetBarPtr(Foo *foo, int *out);

// Return the value of struct-member `bar`.
int Foo_GetBar(Foo *foo);

// Return the value of BOOL-typed struct-member `bar`.
BOOL Foo_IsBar(Foo *foo);

// Set the value of struct-member `bar` to `in`.
void Foo_SetBar(Foo *foo, int in);

// Loop through the elements of `foo->barArray` and return the first
// to match a condition.
int Foo_FindFirstBar(Foo *foo);