This repository has been archived on 2024-10-22. You can view files and clone it, but cannot push or open issues or pull requests.
YimMenu/docs/lua/tables/scr_function.md
Arthur 09b91ca6d7
Some checks are pending
Nightly Build / Build Nightly (push) Blocked by required conditions
Nightly Build / Recreate Release (push) Blocked by required conditions
Nightly Build / Check Recent Commit (push) Successful in 20s
Add Return Value Support for Script Functions (#3479)
* Add Return Value Support for Script Functions
* Removed address-of operator on instruction_pointer parameter, as sol is pass-by-value.
* Fixed reset_session_data & start_creator_script
* Added support for Vector3 and updated casting for bool type for proper conversion to Lua boolean
* Updated documentation for scr_function
* Added get_int method and updated param names for script functions
* Fix #3497 graceful landing not saved.
* Added a check in view_lsc to see if the vehicle can accept clan logos first.
* Fixed vehicle clan logo SP bypass not working properly.
* Fixed COPY VEHICLE not giving persist_car_service::spawn_vehicle_json the target's ped so it can copy their clan logo and not ours.
Fixed spawn_vehicle_json calling add_clan_logo_to_vehicle with our logo and not the ped parameter's logo.
* Added Clone Player Car.
* Fixed has_clan_logo check in view_lsc being given the wrong parameter.

---------

Co-authored-by: gir489 <100792176+gir489returns@users.noreply.github.com>
2024-08-06 14:46:48 +02:00

1.9 KiB

Table: scr_function

Table for calling GTA script functions. Needs to be called in the fiber pool or a GTA script. Only call the function when necessary.

Functions (2)

call_script_function(script_name, function_name, pattern, return_type_string, args_)

Calls a script function with the given arguments. Returns the return value as the given type.

  • Parameters:
    • script_name (string): Name of the script.
    • function_name (string): Name of the function. This parameter needs to be unique.
    • pattern (string): Pattern to scan for within the script.
    • return_type_string (string): Return type of the function. Supported types are "int", "bool", "const char*/string", "ptr/pointer/*", "float", and "vector3". Anything different will be rejected.
    • _args (table): Arguments to pass to the function. Supported types are the same as return types.

Example Usage:

local value = scr_function.call_script_function("freemode", "wear_sunglasses_at_night", "69 42 06 66", "bool", {
  { "int", 69 },
  { "float", 4.20 },
  { "int", 666 }
})

call_script_function(script_name, instruction_pointer, return_type_string, args_)

Calls a script function directly using the function position with the given arguments. Returns the return value as the given type.

  • Parameters:
    • script_name (string): Name of the script.
    • function_name (string): Name of the function.
    • instruction_pointer (integer): Position of the function within the script.
    • return_type_string (string): Return type of the function. Supported types are "int", "bool", "const char*/string", "ptr/pointer/*", "float", and "vector3". Anything different will be rejected.
    • _args (table): Arguments to pass to the function. Supported types are the same as return types.

Example Usage:

local value = scr_function.call_script_function("freemode", 0xE792, "string", {
  { "int", 191 }
})