[SA] Need help with GSX

19 Jul 2020, 08:01

Hey guys, I am developing this mod: CarStorage. If anyone here has any experience, I was wondering if they could help me with implementing GSX in my mod so that the CLEO+ extended vars are saved to and loaded from garages accordingly.

Here is the original GSX example code:

SpoilerAbrir

Código: Selecionar tudo

{$CLEO}

0AA2: 0@ = load_library "gsx.asi" // IF and SET
0AA4: 6@ = get_proc_address "getNewCarGrgForeach" library 0@ // IF and SET

const
   LOAD_CAR = 0
   SAVE_CAR = 1
end


while true
   wait 0

   // Other things

   0AC7: 13@ = var 16@ offset    // carInfo - 8 bytes
   0AC6: 14@ = label @positionRegister offset   // 8 bytes
   while true
       0AA7: call_function 6@ num_params 2 pop 2 13@ 14@ retorno 15@  // getNewCarGrgForeach / GSX::getNewCarForeach(i, out)
       if 15@ <> 0
       jf break

       0AD0: show_formatted_text_lowpriority "Teste car %.8X status %d" time 1500 16@ 17@  // status: 0 loaded / 1 saved
       wait 2000
   end


   // Other things
end

:carInfo
hex
   00 00 00 00  // veh ptr
   00 00 00 00  // status
end

:positionRegister
hex
    00 00 00 00 00 00 00 00
end

Here is the code I have written to make sense of it:

SpoilerAbrir

Código: Selecionar tudo

{$CLEO .cs}

const
    bGSXInstalled = 0@

    hProcGSXgetNewCarGrgForeach = 1@
    hProcGSXsetDataToSaveLaterVehPtr = 2@
    hProcGSXgetLoadDataByVehPtr = 3@

    iGSXVehicleStatusLoaded = 0
    iGSXVehicleStatusSaved = 1

    t0 = 20@
    t1 = 21@
    t2 = 22@
    t3 = 23@
    t4 = 24@
    t5 = 25@
    t6 = 26@
    t7 = 27@
end

bGSXInstalled = false
if 0AA2: t0 = load_library "gsx.asi"
then
    if and
        0AA4: hProcGSXgetNewCarGrgForeach = get_proc_address "getNewCarGrgForeach" library t0
        0AA4: hProcGSXsetDataToSaveLaterVehPtr = get_proc_address "setDataToSaveLaterVehPtr" library t0
        0AA4: hProcGSXgetLoadDataByVehPtr = get_proc_address "getLoadDataByVehPtr" library t0
    then
        bGSXInstalled = true
    end
end

//static int(__cdecl *getNewCarGrgForeach)(size_t *i, GSX::apiCarNotify *out) = nullptr;
//static void(__cdecl *setDataToSaveLaterVehPtr)(CVehicle *veh, const char *name, int size, void *ptr, bool forceCopyNow) = nullptr;
//static void* (__cdecl *getLoadDataByVehPtr)(CVehicle *veh, const char *name) = nullptr;

while true
    0AC7: t4 = var t0 offset
    0AC7: t5 = var t2 offset
    0AA7: call_function hProcGSXgetNewCarGrgForeach num_params 2 pop 2 t4 t5 t6
    if t6 <> 0
    then

        if t6 == iGSXVehicleStatusSaved
        then

        end
        if t6 == iGSXVehicleStatusLoaded
        then

        end

    end
    wait 0
    if 0ADC: test_cheat "RSGSX"
    then
        0ACE: show_formatted_text_box "GSX Script Reloaded Reloaded."
        0A92: create_custom_thread "GSXTest.cs"
        0A93: end_custom_thread
    end
end

An example script that saves and loads vehicle data with explanation would be extremely helpful. I only know basic C++, and I do not understand a thing.
I am not even sure if the above code is correct, and have no further idea of where to go. Any help would be appreciated.

09 Mai 2021, 01:32

Hi. Sorry, I saw your topic now.

Your code seems ok to start. I will comment somethings inside it.

Código: Selecionar tudo

{$CLEO .cs}

const
    bGSXInstalled = 0@

    hProcGSXgetNewCarGrgForeach = 1@
    hProcGSXsetDataToSaveLaterVehPtr = 2@
    hProcGSXgetLoadDataByVehPtr = 3@

    iGSXVehicleStatusLoaded = 0
    iGSXVehicleStatusSaved = 1

    t0 = 20@
    t1 = 21@
    t2 = 22@
    t3 = 23@
    t4 = 24@
    t5 = 25@
    t6 = 26@
    t7 = 27@
end

bGSXInstalled = false
if 0AA2: t0 = load_library "gsx.asi"
then
    if and
        0AA4: hProcGSXgetNewCarGrgForeach = get_proc_address "getNewCarGrgForeach" library t0
        0AA4: hProcGSXsetDataToSaveLaterVehPtr = get_proc_address "setDataToSaveLaterVehPtr" library t0
        0AA4: hProcGSXgetLoadDataByVehPtr = get_proc_address "getLoadDataByVehPtr" library t0
    then
        bGSXInstalled = true
    end
end

//static int(__cdecl *getNewCarGrgForeach)(size_t *i, GSX::apiCarNotify *out) = nullptr;
//static void(__cdecl *setDataToSaveLaterVehPtr)(CVehicle *veh, const char *name, int size, void *ptr, bool forceCopyNow) = nullptr;
//static void* (__cdecl *getLoadDataByVehPtr)(CVehicle *veh, const char *name) = nullptr;

while true
    0AC7: t4 = var t0 offset
    0AC7: t5 = var t2 offset
    0AA7: call_function hProcGSXgetNewCarGrgForeach num_params 2 pop 2 t4 t5 t6
    if t6 <> 0
    then

        if t6 == iGSXVehicleStatusSaved
        then

/// In this case the vehicle is already saved and despawned, may be not useful to your mod

        end
        if t6 == iGSXVehicleStatusLoaded
        then

//// Here vehicle was loaded, you can use the function getLoadDataByVehPtr to get a memory address for the data you saved before and copy it to variables using var offset and memcpy
//// I noticed now I didn't implement getLoadDataByVehPtr with memory copy, I don't have the CLEO tools here in the moment, but I think CLEO/CLEO+ have some opcode to copy memory, or you can read directly in the memory address GSX return

        end

    end
    wait 0
    if 0ADC: test_cheat "RSGSX"
    then
        0ACE: show_formatted_text_box "GSX Script Reloaded Reloaded."
        0A92: create_custom_thread "GSXTest.cs"
        0A93: end_custom_thread

/// Supose you modify some data and want to save with the vehicle.
/// You can use: pushDirectlyToSavedData(vehicle, "CarStorageData", SizeInBytesFromYourData, YourContinuousMemoryStorageForThisVehicle) 
/// pushDirectlyToSavedData copy your data instantly and will not try to copy again when you save the vehicle, you should use it when using temporary places to store the data
    end
end

Steps:
- LoadLibrary and GetProcAddress
- Check if some vehicle was loaded in the garages (in loop, you already did it in example script), if so, use the function getLoadDataByVehPtr(vehicle, "CarStorageData") to receive a pointer with the data, use the function getDataToLoadSize(vehicle, "CarStorageData") to get the data size in bytes. You can copy the data returned to other place or use read memory to get manually parts of the data.

- If you do anything that you want do be stored in the garage, use pushDirectlyToSavedData if you are storing the data in a temporary memory place. pushDirectlyToSavedData(vehicle, "CarStorageData", SizeInBytesFromYourData, YourContinuousMemoryStorageForThisVehicle)
- If you are using local variables you can use var n@ offset, I asked Junior about the contiguity of the memory for the CLEO+ variables. You may use a thread memory with label hex end or normal local variables.

Look the save license plate source code, there is another code that monitors the license plate creation and push the data directly from GSX.

Código: Selecionar tudo

// 0x006FDE50
RpMaterial *__cdecl platetext(RpMaterial *material, char a2)
{
	int v2 = a2;

	if (a2 == -1)
	{
		if (CWeather__CurrLevel == 1)
			v2 = 2;
		else
			v2 = CWeather__CurrLevel > 2 && CWeather__CurrLevel <= 4;
	}

///////////////////////////// GSX CHECK
	int *idptr = (int*)GSX::getSavedData(tempVeh, "licplateID");

	if (idptr != nullptr)
	{
		///v2 = *idptr; /// THE PLATE LOAD AND SET IS HANDLED IN OTHER AREA IN THIS VERSION
	}
	else
	{
		GSX::pushDirectlyToSavedData(tempVeh, "licplateID", sizeof(v2), &v2); /// SEND THE NEW PLATE TO THE GSX
	}
//////////////////////////////////////////////////

	RpMaterialSetTexture(material, plateTexts[v2]);
	return material;
}

14 Mai 2021, 10:07

Oh, I just realized now that this was my topic. I scrolled by thinking this was something else lol. Sorry about that, it was late when I checked the notification for your reply.

Thanks for the help. It has been a while since I wrote this post and I have learnt many new things about GTA SA, and coding in general. I will try again with your given code.

Off-topic:
I assume that you're aware of AutoID? Well, it has an issue with GSX: changes in the model ID of the vehicle will cause the GSX save data to be lost. Can you change it so that the save data doesn't depend on the model ID of the vehicle? It's really a shame that AutoID has a conflict with such a useful mod, but if I could fix it on AutoID side, I would have done so.

14 Mai 2021, 10:39

HzanRsxa2959 escreveu: ↑
14 Mai 2021, 10:07
Oh, I just realized now that this was my topic. I scrolled by thinking this was something else lol. Sorry about that, it was late when I checked the notification for your reply.

Thanks for the help. It has been a while since I wrote this post and I have learnt many new things about GTA SA, and coding in general. I will try again with your given code.

Off-topic:
I assume that you're aware of AutoID? Well, it has an issue with GSX: changes in the model ID of the vehicle will cause the GSX save data to be lost. Can you change it so that the save data doesn't depend on the model ID of the vehicle? It's really a shame that AutoID has a conflict with such a useful mod, but if I could fix it on AutoID side, I would have done so.

You are welcome. Any questions just let me know.

I see this mod, but I hadn't thought of that. I think I will work on some patches for GSX this weekend. Thank you for notifying.
Maybe I can improve de user experience with the GSX API too.

14 Mai 2021, 11:33

Fabio escreveu: ↑
14 Mai 2021, 10:39
You are welcome. Any questions just let me know.

I see this mod, but I hadn't thought of that. I think I will work on some patches for GSX this weekend. Thank you for notifying.
Maybe I can improve de user experience with the GSX API too.

Thanks so much for the help as well as the good news. I am working on the script, will ask if any help is needed.

16 Mai 2021, 01:54

HzanRsxa2959 escreveu: ↑
14 Mai 2021, 11:33
Fabio escreveu: ↑
14 Mai 2021, 10:39
You are welcome. Any questions just let me know.

I see this mod, but I hadn't thought of that. I think I will work on some patches for GSX this weekend. Thank you for notifying.
Maybe I can improve de user experience with the GSX API too.
Thanks so much for the help as well as the good news. I am working on the script, will ask if any help is needed.

You are welcome.

16 Mai 2021, 13:50

I updated the GSX.asi https://drive.google.com/file/d/1ZU16Nc ... sp=sharing

Source code https://github.com/Fabio3rs/Garage-Save-eXtender

New functions name (the old names still exists):

Código: Selecionar tudo

void __cdecl GSX_setScheduledVehicleData(CVehicle * veh, const char* name, int size, const void* ptr, bool forceCopyNow)
void __cdecl GSX_deleteScheduledVehicleData(CVehicle * veh, const char* name)
void __cdecl GSX_setVehicleData(CVehicle *veh, const char* name, int size, const void* ptr)
void __cdecl GSX_deleteVehicleData(CVehicle * veh, const char* name)
uint32_t __cdecl GSX_getVehicleData(CVehicle * veh, const char* name, uint8_t *ptr, uint32_t maxsize)
int __cdecl GSX_hasVehicleData(CVehicle * veh, const char* name)
int __cdecl GSX_hasScheduledVehicleData(CVehicle * veh, const char* name)

Scheduled means the data will be copied when the garage closes, don't use if you are using temporary addresses to the data. Prefer GSX_setVehicleData instead

Código: Selecionar tudo

// Sets a named data to the vehicle
void __cdecl GSX_setVehicleData(CVehicle *veh, const char* name, int size, const void* ptr)

Código: Selecionar tudo

/// Copy the data to the ptr and you can limit to maxsize, if you don't want to limit, pass a big value to maxsize. 0xFFFFFFFF for example
// Returns the size in bytes copied
uint32_t __cdecl GSX_getVehicleData(CVehicle * veh, const char* name, uint8_t *ptr, uint32_t maxsize)

Código: Selecionar tudo

// Returns the size if exists, 0 if not.
int __cdecl GSX_hasVehicleData(CVehicle * veh, const char* name)
int __cdecl GSX_hasScheduledVehicleData(CVehicle * veh, const char* name)

I not tested yet the new functions.

16 Mai 2021, 14:52

Amazing! The new update works flawlessly, now VehFuncs extras can be saved in garages for cars adapted to AutoID. Along with many other mods.
And these new functions look very helpful. I will try them and update.

16 Mai 2021, 15:23

HzanRsxa2959 escreveu: ↑
16 Mai 2021, 14:52
Amazing! The new update works flawlessly, now VehFuncs extras can be saved in garages for cars adapted to AutoID. Along with many other mods.
And these new functions look very helpful. I will try them and update.

Very good! Glad it worked flawlessly.

If you find any problem please advise me.

Forum.MixMods

[SA] Need help with GSX [SOLVED]

[SA] Need help with GSX

Re: [SA] Need help with GSX [SOLVED]

Re: [SA] Need help with GSX

Re: [SA] Need help with GSX

Re: [SA] Need help with GSX

Re: [SA] Need help with GSX

Re: [SA] Need help with GSX

Re: [SA] Need help with GSX

Re: [SA] Need help with GSX