├── .gitignore
├── LICENSE
├── README.md
├── _export.js
└── client
├── fivem
├── core.lua
├── event.lua
├── misc.lua
├── ped.lua
├── player.lua
└── unique.lua
└── native
├── ai.lua
├── app.lua
├── audio.lua
├── brain.lua
├── cam.lua
├── cfx.lua
├── controls.lua
├── cutscene.lua
├── datafile.lua
├── decisionevent.lua
├── decorator.lua
├── dlc1.lua
├── dlc2.lua
├── entity.lua
├── fire.lua
├── gameplay.lua
├── graphics.lua
├── interior.lua
├── itemset.lua
├── mobile.lua
├── network.lua
├── networkcash.lua
├── object.lua
├── pathfind.lua
├── ped.lua
├── player.lua
├── rope.lua
├── script.lua
├── socialclub.lua
├── stats.lua
├── streaming.lua
├── system.lua
├── time.lua
├── ui.lua
├── unk.lua
├── unk1.lua
├── unk2.lua
├── unk3.lua
├── vehicle.lua
├── water.lua
├── weapon.lua
├── worldprobe.lua
└── zone.lua
/.gitignore:
--------------------------------------------------------------------------------
1 | /.idea
2 | *.iml
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) TanKode 2017
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # FiveM LUA SDK
2 |
3 | [FiveM Forum](https://forum.fivem.net/t/documented-fivem-lua-sdk/25957)
4 |
5 | ## Usage
6 | If you use [IntelliJ IDEA](https://www.jetbrains.com/idea) you have to install the [LUA Plugin](https://plugins.jetbrains.com/plugin/5055-lua). Via *Project Structure* => *SDKs* you can add the path to this SDK. After this you have to restart your IDE to reload the external libraries. From this point you will get all the functions as autocomplete and with a link to the SDK documentation.
7 |
8 | ## Sources
9 |
10 | * https://runtime.fivem.net/doc/reference.html
11 | * https://wiki.fivem.net/wiki/Server_functions
12 | * https://wiki.fivem.net/wiki/Client_functions
13 |
--------------------------------------------------------------------------------
/_export.js:
--------------------------------------------------------------------------------
1 | // https://runtime.fivem.net/doc/reference.html
2 | var script = document.createElement("script");
3 | script.type = "text/javascript";
4 | script.src = "https://code.jquery.com/jquery-3.2.1.min.js";
5 | document.head.appendChild(script);
6 | String.prototype.capitalize = function() {
7 | return this.charAt(0).toUpperCase() + this.slice(1);
8 | };
9 | $("main").each(function() {
10 | var doc = "";
11 | var $main = $(this);
12 | var module = $main.data("name").toLowerCase();
13 | var $sections = $main.find("section");
14 | $sections.each(function() {
15 | var $section = $(this);
16 | var original = $section.data("native");
17 | if(!original.startsWith("0x") && !original.startsWith("_")) {
18 | var method = {};
19 | method.module = "native";
20 | method.submodule = module;
21 | method.native = original;
22 | method.function = original.toLowerCase().capitalize().replace(/_([a-z])/g, function (g) { return g[1].toUpperCase(); });
23 | method.description = $section.find(".desc").text().trim();
24 | method.usage = $section.find(".code").text().trim().split("\n")[1].trim();
25 | var splittedUsage = method.usage.split(" ");
26 | method.return = splittedUsage.shift().trim();
27 | method.see = splittedUsage.join(" ").trim();
28 | method.params = {};
29 | $.each(method.see.match("\\((.*)\\)")[1].split(","), function() {
30 | if(this.trim() != "") {
31 | var param = this.trim().split(" ");
32 | method.params[param[1]] = param[0];
33 | }
34 | });
35 | console.log(method.params);
36 |
37 | var description = method.description.split("\n").join(" ").trim();
38 | doc += ""
39 | + "-- "+(description == "" ? "@todo" : description)+"\n"
40 | + "-- @module "+method.module+"\n"
41 | + "-- @submodule "+method.submodule+"\n"
42 | + "-- @see "+method.native+"\n"
43 | + "-- @usage "+method.usage+"\n";
44 | $.each(method.params, function(name, type) {
45 | doc += "-- @param "+name+" "+type+"\n";
46 | });
47 | doc += "-- @return "+method.return+"\n";
48 | var methodParams = "";
49 | if(Object.keys(method.params).length > 0) {
50 | methodParams = Object.keys(method.params).join(", ");
51 | }
52 | doc += "function "+method.function+"("+methodParams+") end"+"\n\n";
53 | }
54 | });
55 | $main.html(
56 | "
"+module+"
"
57 | );
58 | });
59 |
--------------------------------------------------------------------------------
/client/fivem/core.lua:
--------------------------------------------------------------------------------
1 | -- Create a new asynchronous thread
2 | -- @module fivem
3 | -- @submodule core
4 | -- @link https://wiki.fivem.net/wiki/Citizen.CreateThread
5 | -- @param callback function
6 | -- @return void
7 | function Citizen.CreateThread(callback) end
8 |
9 | -- Prints string in console
10 | -- @module fivem
11 | -- @submodule core
12 | -- @link https://wiki.fivem.net/wiki/Citizen.Trace
13 | -- @usage Citizen.Trace("Hello World!")
14 | -- @param string string
15 | -- @return void
16 | function Citizen.Trace(string) end
17 |
18 | -- Stop execution of a thread or script for the given milliseconds. This function can block an entire script, so use with caution! It is recommended to only block the relevant Thread.
19 | -- @module fivem
20 | -- @submodule core
21 | -- @link https://wiki.fivem.net/wiki/Citizen.Wait
22 | -- @usage Citizen.Wait(1000)
23 | -- @param duration int
24 | -- @return void
25 | function Citizen.Wait(duration) end
--------------------------------------------------------------------------------
/client/fivem/event.lua:
--------------------------------------------------------------------------------
1 | -- Registers an event name as being allowed to be called by the server. Specific to the Lua runtime.
2 | -- @module fivem
3 | -- @submodule event
4 | -- @link https://wiki.fivem.net/wiki/RegisterNetEvent
5 | -- @usage RegisterNetEvent('myEvent')
6 | -- @param eventName string
7 | -- @return void
8 | function RegisterNetEvent(eventName) end
9 |
10 | -- Adds an event handler to the current resource/scripting environment. Do note that, if the event is to be called from a remote source, it needs to be whitelisted with RegisterNetEvent (on the client) or RegisterServerEvent (on the server).
11 | -- @module fivem
12 | -- @submodule event
13 | -- @link https://wiki.fivem.net/wiki/AddEventHandler
14 | -- @usage myEvent = AddEventHandler('myEvent', function(text) print(('%s said %s'):format(GetPlayerName(source), text) end)
15 | -- @param eventName string
16 | -- @param eventHandler function
17 | -- @return eventData
18 | function AddEventHandler(eventName, eventHandler) end
19 |
20 | -- This function allow you to remove an eventHandler.
21 | -- @module fivem
22 | -- @submodule event
23 | -- @link https://wiki.fivem.net/wiki/RemoveEventHandler
24 | -- @usage RemoveEventHandler(myEvent)
25 | -- @param eventData eventData
26 | -- @return void
27 | function RemoveEventHandler(eventData) end
28 |
29 | -- @todo
30 | -- @module fivem
31 | -- @submodule event
32 | -- @link https://wiki.fivem.net/wiki/TriggerServerEvent
33 | -- @usage TriggerServerEvent('myEvent', 'Hello World!')
34 | -- @param eventName string
35 | -- @param arguments Arguments
36 | -- @return void
37 | function TriggerServerEvent(eventName) end
38 |
39 | -- Cancels the current event. Use WasEventCanceled to check if the last event was canceled.
40 | -- @module fivem
41 | -- @submodule event
42 | -- @link https://wiki.fivem.net/wiki/CancelEvent
43 | -- @usage CancelEvent()
44 | -- @return void
45 | function CancelEvent() end
46 |
47 | -- Checks if the last local event that executed was canceled (using CancelEvent).
48 | -- @module fivem
49 | -- @submodule event
50 | -- @link https://wiki.fivem.net/wiki/WasEventCanceled
51 | -- @usage eventCanceled = WasEventCanceled()
52 | -- @return bool
53 | function WasEventCanceled() end
--------------------------------------------------------------------------------
/client/fivem/misc.lua:
--------------------------------------------------------------------------------
1 | -- @todo
2 | -- @module fivem
3 | -- @submodule misc
4 | -- @link https://wiki.fivem.net/wiki/SetTextChatEnabled
5 | -- @return void
6 | function SetTextChatEnabled() end
--------------------------------------------------------------------------------
/client/fivem/ped.lua:
--------------------------------------------------------------------------------
1 | -- Sets the ped drunk sounds. This only sets the drunk sound to ped/player. To give the Ped a drunk effect with drunk walking animation try using SetPedMovementClipset
2 | -- @module fivem
3 | -- @submodule ped
4 | -- @link https://wiki.fivem.net/wiki/SetPedIsDrunk
5 | -- @param ped Ped
6 | -- @param toggle bool
7 | -- @return void
8 | function SetPedIsDrunk(ped, toggle) end
9 |
10 | -- Get information about if a ped is shooting or not
11 | -- @module fivem
12 | -- @submodule ped
13 | -- @link https://wiki.fivem.net/wiki/IsPedShooting
14 | -- @usage pedShooting = IsPedShooting(GetPlayerPed(-1))
15 | -- @param ped Ped
16 | -- @return bool
17 | function IsPedShooting(ped) end
18 |
19 | -- Give a weapon with ammo to ped
20 | -- @module fivem
21 | -- @submodule ped
22 | -- @link https://wiki.fivem.net/wiki/GiveWeaponToPed
23 | -- @usage GiveWeaponToPed(GetPlayerPed(-1), GetHashKey("weapon_pistol"), 100, false)
24 | -- @param ped Ped
25 | -- @param weaponHash hash
26 | -- @param ammo int
27 | -- @param unknown bool
28 | -- @return void
29 | function GiveWeaponToPed(ped, weaponHash, ammo, unknown) end
--------------------------------------------------------------------------------
/client/fivem/player.lua:
--------------------------------------------------------------------------------
1 | -- Returns player ID(handle) from server id.
2 | -- @module fivem
3 | -- @submodule player
4 | -- @link https://wiki.fivem.net/wiki/GetPlayerFromServerId
5 | -- @usage playerint = GetPlayerFromServerId(playerServerId)
6 | -- @param playerServerId int
7 | -- @return int
8 | function GetPlayerFromServerId(playerServerId) end
9 |
10 | -- Get server id from player.
11 | -- @module fivem
12 | -- @submodule player
13 | -- @link https://wiki.fivem.net/wiki/GetPlayerServerId
14 | -- @usage serverId = GetPlayerServerId(PlayerId())
15 | -- @param playerId int
16 | -- @return int
17 | function GetPlayerServerId(playerId) end
18 |
19 | -- Get ped from player.
20 | -- @module fivem
21 | -- @submodule player
22 | -- @link https://wiki.fivem.net/wiki/GetPlayerPed
23 | -- @usage ped = GetPlayerPed(PlayerId())
24 | -- @param playerId int
25 | -- @return ped
26 | function GetPlayerPed(playerId) end
27 |
28 | -- Return the player local id (different from the server ID).
29 | -- @module fivem
30 | -- @submodule player
31 | -- @link https://wiki.fivem.net/wiki/PlayerId
32 | -- @usage localPlayerId = PlayerId()
33 | -- @return int
34 | function PlayerId() end
35 |
36 | -- Sets the model of a player. You must first request it before actually using it.
37 | -- @module fivem
38 | -- @submodule player
39 | -- @link https://wiki.fivem.net/wiki/SetPlayerModel
40 | -- @usage SetPlayerModel(PlayerId(), GetHashKey(a_m_m_bevhills_02))
41 | -- @param playerId int
42 | -- @param model hash
43 | -- @return void
44 | function SetPlayerModel(playerId, model) end
--------------------------------------------------------------------------------
/client/fivem/unique.lua:
--------------------------------------------------------------------------------
1 | -- Sets the configuration for pop-up headlights for a vehicle model.
2 | -- @module fivem
3 | -- @submodule unique
4 | -- @link https://wiki.fivem.net/wiki/SetModelHeadlightConfiguration
5 | -- @usage SetModelHeadlightConfiguration('ruiner2', 120.0, 37.5, false)
6 | -- @usage SetModelHeadlightConfiguration('tropos', 30.0, 40.0, false)
7 | -- @param modelHash Model
8 | -- @param rotationPerSecond float
9 | -- @param rotation float
10 | -- @param invertRotation boolean
11 | -- @return void
12 | function SetModelHeadlightConfiguration(modelHash, rotationPerSecond, rotation, invertRotation) end
--------------------------------------------------------------------------------
/client/native/app.lua:
--------------------------------------------------------------------------------
1 | -- @todo
2 | -- @module native
3 | -- @submodule app
4 | -- @see APP_DATA_VALID
5 | -- @usage BOOL APP_DATA_VALID();
6 | -- @return BOOL
7 | function AppDataValid() end
8 |
9 | -- @todo
10 | -- @module native
11 | -- @submodule app
12 | -- @see APP_GET_INT
13 | -- @usage int APP_GET_INT(char* property);
14 | -- @param property char*
15 | -- @return int
16 | function AppGetInt(property) end
17 |
18 | -- @todo
19 | -- @module native
20 | -- @submodule app
21 | -- @see APP_GET_FLOAT
22 | -- @usage float APP_GET_FLOAT(char* property);
23 | -- @param property char*
24 | -- @return float
25 | function AppGetFloat(property) end
26 |
27 | -- @todo
28 | -- @module native
29 | -- @submodule app
30 | -- @see APP_GET_STRING
31 | -- @usage char* APP_GET_STRING(char* property);
32 | -- @param property char*
33 | -- @return char*
34 | function AppGetString(property) end
35 |
36 | -- @todo
37 | -- @module native
38 | -- @submodule app
39 | -- @see APP_SET_INT
40 | -- @usage void APP_SET_INT(char* property, int value);
41 | -- @param property char*
42 | -- @param value int
43 | -- @return void
44 | function AppSetInt(property, value) end
45 |
46 | -- @todo
47 | -- @module native
48 | -- @submodule app
49 | -- @see APP_SET_FLOAT
50 | -- @usage void APP_SET_FLOAT(char* property, float value);
51 | -- @param property char*
52 | -- @param value float
53 | -- @return void
54 | function AppSetFloat(property, value) end
55 |
56 | -- @todo
57 | -- @module native
58 | -- @submodule app
59 | -- @see APP_SET_STRING
60 | -- @usage void APP_SET_STRING(char* property, char* value);
61 | -- @param property char*
62 | -- @param value char*
63 | -- @return void
64 | function AppSetString(property, value) end
65 |
66 | -- Called in the gamescripts like: APP::APP_SET_APP("car"); APP::APP_SET_APP("dog");
67 | -- @module native
68 | -- @submodule app
69 | -- @see APP_SET_APP
70 | -- @usage void APP_SET_APP(char* appName);
71 | -- @param appName char*
72 | -- @return void
73 | function AppSetApp(appName) end
74 |
75 | -- @todo
76 | -- @module native
77 | -- @submodule app
78 | -- @see APP_SET_BLOCK
79 | -- @usage void APP_SET_BLOCK(char* blockName);
80 | -- @param blockName char*
81 | -- @return void
82 | function AppSetBlock(blockName) end
83 |
84 | -- @todo
85 | -- @module native
86 | -- @submodule app
87 | -- @see APP_CLEAR_BLOCK
88 | -- @usage void APP_CLEAR_BLOCK();
89 | -- @return void
90 | function AppClearBlock() end
91 |
92 | -- @todo
93 | -- @module native
94 | -- @submodule app
95 | -- @see APP_CLOSE_APP
96 | -- @usage void APP_CLOSE_APP();
97 | -- @return void
98 | function AppCloseApp() end
99 |
100 | -- @todo
101 | -- @module native
102 | -- @submodule app
103 | -- @see APP_CLOSE_BLOCK
104 | -- @usage void APP_CLOSE_BLOCK();
105 | -- @return void
106 | function AppCloseBlock() end
107 |
108 | -- @todo
109 | -- @module native
110 | -- @submodule app
111 | -- @see APP_HAS_LINKED_SOCIAL_CLUB_ACCOUNT
112 | -- @usage BOOL APP_HAS_LINKED_SOCIAL_CLUB_ACCOUNT();
113 | -- @return BOOL
114 | function AppHasLinkedSocialClubAccount() end
115 |
116 | -- @todo
117 | -- @module native
118 | -- @submodule app
119 | -- @see APP_HAS_SYNCED_DATA
120 | -- @usage BOOL APP_HAS_SYNCED_DATA(char* appName);
121 | -- @param appName char*
122 | -- @return BOOL
123 | function AppHasSyncedData(appName) end
124 |
125 | -- @todo
126 | -- @module native
127 | -- @submodule app
128 | -- @see APP_SAVE_DATA
129 | -- @usage void APP_SAVE_DATA();
130 | -- @return void
131 | function AppSaveData() end
132 |
133 | -- @todo
134 | -- @module native
135 | -- @submodule app
136 | -- @see APP_GET_DELETED_FILE_STATUS
137 | -- @usage Any APP_GET_DELETED_FILE_STATUS();
138 | -- @return Any
139 | function AppGetDeletedFileStatus() end
140 |
141 | -- @todo
142 | -- @module native
143 | -- @submodule app
144 | -- @see APP_DELETE_APP_DATA
145 | -- @usage BOOL APP_DELETE_APP_DATA(char* appName);
146 | -- @param appName char*
147 | -- @return BOOL
148 | function AppDeleteAppData(appName) end
--------------------------------------------------------------------------------
/client/native/brain.lua:
--------------------------------------------------------------------------------
1 | -- BRAIN::ADD_SCRIPT_TO_RANDOM_PED("pb_prostitute", ${s_f_y_hooker_01}, 100, 0); ----- Hardcoded to not work in Multiplayer.
2 | -- @module native
3 | -- @submodule brain
4 | -- @see ADD_SCRIPT_TO_RANDOM_PED
5 | -- @usage void ADD_SCRIPT_TO_RANDOM_PED(char* name, Hash model, float p2, float p3);
6 | -- @param name char*
7 | -- @param model Hash
8 | -- @param p2 float
9 | -- @param p3 float
10 | -- @return void
11 | function AddScriptToRandomPed(name, model, p2, p3) end
12 |
13 | -- Registers a script for any object with a specific model hash. BRAIN::REGISTER_OBJECT_SCRIPT_BRAIN("ob_telescope", ${prop_telescope_01}, 100, 4.0, -1, 9);
14 | -- @module native
15 | -- @submodule brain
16 | -- @see REGISTER_OBJECT_SCRIPT_BRAIN
17 | -- @usage void REGISTER_OBJECT_SCRIPT_BRAIN(char* scriptName, Hash objectName, int p2, float p3, int p4, int p5);
18 | -- @param scriptName char*
19 | -- @param objectName Hash
20 | -- @param p2 int
21 | -- @param p3 float
22 | -- @param p4 int
23 | -- @param p5 int
24 | -- @return void
25 | function RegisterObjectScriptBrain(scriptName, objectName, p2, p3, p4, p5) end
26 |
27 | -- @todo
28 | -- @module native
29 | -- @submodule brain
30 | -- @see IS_OBJECT_WITHIN_BRAIN_ACTIVATION_RANGE
31 | -- @usage BOOL IS_OBJECT_WITHIN_BRAIN_ACTIVATION_RANGE(Object object);
32 | -- @param object Object
33 | -- @return BOOL
34 | function IsObjectWithinBrainActivationRange(object) end
35 |
36 | -- @todo
37 | -- @module native
38 | -- @submodule brain
39 | -- @see REGISTER_WORLD_POINT_SCRIPT_BRAIN
40 | -- @usage void REGISTER_WORLD_POINT_SCRIPT_BRAIN(Any* p0, float p1, Any p2);
41 | -- @param p0 Any*
42 | -- @param p1 float
43 | -- @param p2 Any
44 | -- @return void
45 | function RegisterWorldPointScriptBrain(p0, p1, p2) end
46 |
47 | -- Gets whether the world point the calling script is registered to is within desired range of the player.
48 | -- @module native
49 | -- @submodule brain
50 | -- @see IS_WORLD_POINT_WITHIN_BRAIN_ACTIVATION_RANGE
51 | -- @usage BOOL IS_WORLD_POINT_WITHIN_BRAIN_ACTIVATION_RANGE();
52 | -- @return BOOL
53 | function IsWorldPointWithinBrainActivationRange() end
54 |
55 | -- @todo
56 | -- @module native
57 | -- @submodule brain
58 | -- @see ENABLE_SCRIPT_BRAIN_SET
59 | -- @usage void ENABLE_SCRIPT_BRAIN_SET(int brainSet);
60 | -- @param brainSet int
61 | -- @return void
62 | function EnableScriptBrainSet(brainSet) end
63 |
64 | -- @todo
65 | -- @module native
66 | -- @submodule brain
67 | -- @see DISABLE_SCRIPT_BRAIN_SET
68 | -- @usage void DISABLE_SCRIPT_BRAIN_SET(int brainSet);
69 | -- @param brainSet int
70 | -- @return void
71 | function DisableScriptBrainSet(brainSet) end
--------------------------------------------------------------------------------
/client/native/cfx.lua:
--------------------------------------------------------------------------------
1 | -- @todo
2 | -- @module native
3 | -- @submodule cfx
4 | -- @see PERFORM_HTTP_REQUEST_INTERNAL
5 | -- @usage int PERFORM_HTTP_REQUEST_INTERNAL(char* requestData, int requestDataLength);
6 | -- @param requestData char*
7 | -- @param requestDataLength int
8 | -- @return int
9 | function PerformHttpRequestInternal(requestData, requestDataLength) end
10 |
11 | -- @todo
12 | -- @module native
13 | -- @submodule cfx
14 | -- @see GET_INSTANCE_ID
15 | -- @usage int GET_INSTANCE_ID();
16 | -- @return int
17 | function GetInstanceId() end
18 |
19 | -- @todo
20 | -- @module native
21 | -- @submodule cfx
22 | -- @see SET_GAME_TYPE
23 | -- @usage void SET_GAME_TYPE(char* gametypeName);
24 | -- @param gametypeName char*
25 | -- @return void
26 | function SetGameType(gametypeName) end
27 |
28 | -- The backing function for TriggerServerEvent.
29 | -- @module native
30 | -- @submodule cfx
31 | -- @see TRIGGER_SERVER_EVENT_INTERNAL
32 | -- @usage void TRIGGER_SERVER_EVENT_INTERNAL(char* eventName, char* eventPayload, int payloadLength);
33 | -- @param eventName char*
34 | -- @param eventPayload char*
35 | -- @param payloadLength int
36 | -- @return void
37 | function TriggerServerEventInternal(eventName, eventPayload, payloadLength) end
38 |
39 | -- Registers a specified font name for use with text draw commands. Parameters:fontName: The name of the font in the GFx font library.Returns: An index to use with SET_TEXT_FONT and similar natives.
40 | -- @module native
41 | -- @submodule cfx
42 | -- @see REGISTER_FONT_ID
43 | -- @usage int REGISTER_FONT_ID(char* fontName);
44 | -- @param fontName char*
45 | -- @return int
46 | function RegisterFontId(fontName) end
47 |
48 | -- @todo
49 | -- @module native
50 | -- @submodule cfx
51 | -- @see SET_RESOURCE_KVP
52 | -- @usage void SET_RESOURCE_KVP(char* key, char* value);
53 | -- @param key char*
54 | -- @param value char*
55 | -- @return void
56 | function SetResourceKvp(key, value) end
57 |
58 | -- Reads the contents of a text file in a specified resource. If executed on the client, this file has to be included in files in the resource manifest. Example: local data = LoadResourceFile("devtools", "data.json") Parameters:resourceName: The resource name.fileName: The file in the resource.Returns: The file contents
59 | -- @module native
60 | -- @submodule cfx
61 | -- @see LOAD_RESOURCE_FILE
62 | -- @usage char* LOAD_RESOURCE_FILE(char* resourceName, char* fileName);
63 | -- @param resourceName char*
64 | -- @param fileName char*
65 | -- @return char*
66 | function LoadResourceFile(resourceName, fileName) end
67 |
68 | -- @todo
69 | -- @module native
70 | -- @submodule cfx
71 | -- @see GET_CONVAR
72 | -- @usage char* GET_CONVAR(char* varName, char* default);
73 | -- @param varName char*
74 | -- @param default char*
75 | -- @return char*
76 | function GetConvar(varName, default) end
77 |
78 | -- Gets the amount of metadata values with the specified key existing in the specified resource's manifest. See also: Resource manifest Parameters:resourceName: The resource name.metadataKey: The key to look up in the resource manifest.
79 | -- @module native
80 | -- @submodule cfx
81 | -- @see GET_NUM_RESOURCE_METADATA
82 | -- @usage int GET_NUM_RESOURCE_METADATA(char* resourceName, char* metadataKey);
83 | -- @param resourceName char*
84 | -- @param metadataKey char*
85 | -- @return int
86 | function GetNumResourceMetadata(resourceName, metadataKey) end
87 |
88 | -- @todo
89 | -- @module native
90 | -- @submodule cfx
91 | -- @see DELETE_FUNCTION_REFERENCE
92 | -- @usage void DELETE_FUNCTION_REFERENCE(char* referenceIdentity);
93 | -- @param referenceIdentity char*
94 | -- @return void
95 | function DeleteFunctionReference(referenceIdentity) end
96 |
97 | -- @todo
98 | -- @module native
99 | -- @submodule cfx
100 | -- @see SET_TEXT_CHAT_ENABLED
101 | -- @usage BOOL SET_TEXT_CHAT_ENABLED(BOOL enabled);
102 | -- @param enabled BOOL
103 | -- @return BOOL
104 | function SetTextChatEnabled(enabled) end
105 |
106 | -- @todo
107 | -- @module native
108 | -- @submodule cfx
109 | -- @see SEND_NUI_MESSAGE
110 | -- @usage BOOL SEND_NUI_MESSAGE(char* jsonString);
111 | -- @param jsonString char*
112 | -- @return BOOL
113 | function SendNuiMessage(jsonString) end
114 |
115 | -- @todo
116 | -- @module native
117 | -- @submodule cfx
118 | -- @see GET_INVOKING_RESOURCE
119 | -- @usage char* GET_INVOKING_RESOURCE();
120 | -- @return char*
121 | function GetInvokingResource() end
122 |
123 | -- @todo
124 | -- @module native
125 | -- @submodule cfx
126 | -- @see GET_PLAYER_SERVER_ID
127 | -- @usage int GET_PLAYER_SERVER_ID(Player player);
128 | -- @param player Player
129 | -- @return int
130 | function GetPlayerServerId(player) end
131 |
132 | -- @todo
133 | -- @module native
134 | -- @submodule cfx
135 | -- @see STOP_RESOURCE
136 | -- @usage BOOL STOP_RESOURCE(char* resourceName);
137 | -- @param resourceName char*
138 | -- @return BOOL
139 | function StopResource(resourceName) end
140 |
141 | -- @todo
142 | -- @module native
143 | -- @submodule cfx
144 | -- @see END_FIND_KVP
145 | -- @usage void END_FIND_KVP(int handle);
146 | -- @param handle int
147 | -- @return void
148 | function EndFindKvp(handle) end
149 |
150 | -- @todo
151 | -- @module native
152 | -- @submodule cfx
153 | -- @see FLAG_SERVER_AS_PRIVATE
154 | -- @usage void FLAG_SERVER_AS_PRIVATE(BOOL private);
155 | -- @param private BOOL
156 | -- @return void
157 | function FlagServerAsPrivate(private) end
158 |
159 | -- @todo
160 | -- @module native
161 | -- @submodule cfx
162 | -- @see GET_PASSWORD_HASH
163 | -- @usage char* GET_PASSWORD_HASH(char* password);
164 | -- @param password char*
165 | -- @return char*
166 | function GetPasswordHash(password) end
167 |
168 | -- @todo
169 | -- @module native
170 | -- @submodule cfx
171 | -- @see START_FIND_KVP
172 | -- @usage int START_FIND_KVP(char* prefix);
173 | -- @param prefix char*
174 | -- @return int
175 | function StartFindKvp(prefix) end
176 |
177 | -- Gets whether or not this is the CitizenFX server. Returns: A boolean value.
178 | -- @module native
179 | -- @submodule cfx
180 | -- @see IS_DUPLICITY_VERSION
181 | -- @usage BOOL IS_DUPLICITY_VERSION();
182 | -- @return BOOL
183 | function IsDuplicityVersion() end
184 |
185 | -- @todo
186 | -- @module native
187 | -- @submodule cfx
188 | -- @see DUPLICATE_FUNCTION_REFERENCE
189 | -- @usage char* DUPLICATE_FUNCTION_REFERENCE(char* referenceIdentity);
190 | -- @param referenceIdentity char*
191 | -- @return char*
192 | function DuplicateFunctionReference(referenceIdentity) end
193 |
194 | -- @todo
195 | -- @module native
196 | -- @submodule cfx
197 | -- @see GET_PLAYER_LAST_MSG
198 | -- @usage int GET_PLAYER_LAST_MSG(char* playerSrc);
199 | -- @param playerSrc char*
200 | -- @return int
201 | function GetPlayerLastMsg(playerSrc) end
202 |
203 | -- @todo
204 | -- @module native
205 | -- @submodule cfx
206 | -- @see GET_PLAYER_NAME
207 | -- @usage char* GET_PLAYER_NAME(char* playerSrc);
208 | -- @param playerSrc char*
209 | -- @return char*
210 | function GetPlayerName(playerSrc) end
211 |
212 | -- @todo
213 | -- @module native
214 | -- @submodule cfx
215 | -- @see GET_RESOURCE_BY_FIND_INDEX
216 | -- @usage char* GET_RESOURCE_BY_FIND_INDEX(int findIndex);
217 | -- @param findIndex int
218 | -- @return char*
219 | function GetResourceByFindIndex(findIndex) end
220 |
221 | -- Gets the current game timer in milliseconds. Returns: The game time.
222 | -- @module native
223 | -- @submodule cfx
224 | -- @see GET_GAME_TIMER
225 | -- @usage int GET_GAME_TIMER();
226 | -- @return int
227 | function GetGameTimer() end
228 |
229 | -- @todo
230 | -- @module native
231 | -- @submodule cfx
232 | -- @see GET_RESOURCE_KVP_INT
233 | -- @usage int GET_RESOURCE_KVP_INT(char* key);
234 | -- @param key char*
235 | -- @return int
236 | function GetResourceKvpInt(key) end
237 |
238 | -- @todo
239 | -- @module native
240 | -- @submodule cfx
241 | -- @see GET_CONVAR_INT
242 | -- @usage int GET_CONVAR_INT(char* varName, int default);
243 | -- @param varName char*
244 | -- @param default int
245 | -- @return int
246 | function GetConvarInt(varName, default) end
247 |
248 | -- @todo
249 | -- @module native
250 | -- @submodule cfx
251 | -- @see ADD_TEXT_ENTRY
252 | -- @usage void ADD_TEXT_ENTRY(char* entryKey, char* entryText);
253 | -- @param entryKey char*
254 | -- @param entryText char*
255 | -- @return void
256 | function AddTextEntry(entryKey, entryText) end
257 |
258 | -- @todo
259 | -- @module native
260 | -- @submodule cfx
261 | -- @see GET_RESOURCE_KVP_STRING
262 | -- @usage char* GET_RESOURCE_KVP_STRING(char* key);
263 | -- @param key char*
264 | -- @return char*
265 | function GetResourceKvpString(key) end
266 |
267 | -- Registers a specified .gfx file as GFx font library. The .gfx file has to be registered with the streamer already. Parameters:fileName: The name of the .gfx file, without extension.
268 | -- @module native
269 | -- @submodule cfx
270 | -- @see REGISTER_FONT_FILE
271 | -- @usage void REGISTER_FONT_FILE(char* fileName);
272 | -- @param fileName char*
273 | -- @return void
274 | function RegisterFontFile(fileName) end
275 |
276 | -- @todo
277 | -- @module native
278 | -- @submodule cfx
279 | -- @see GET_PLAYER_FROM_INDEX
280 | -- @usage char* GET_PLAYER_FROM_INDEX(int index);
281 | -- @param index int
282 | -- @return char*
283 | function GetPlayerFromIndex(index) end
284 |
285 | -- @todo
286 | -- @module native
287 | -- @submodule cfx
288 | -- @see GET_PLAYER_FROM_SERVER_ID
289 | -- @usage Player GET_PLAYER_FROM_SERVER_ID(int serverId);
290 | -- @param serverId int
291 | -- @return Player
292 | function GetPlayerFromServerId(serverId) end
293 |
294 | -- Cancels the currently executing event. See https://wiki.fivem.net/wiki/CancelEvent
295 | -- @module native
296 | -- @submodule cfx
297 | -- @see CANCEL_EVENT
298 | -- @usage void CANCEL_EVENT();
299 | -- @return void
300 | function CancelEvent() end
301 |
302 | -- @todo
303 | -- @module native
304 | -- @submodule cfx
305 | -- @see VERIFY_PASSWORD_HASH
306 | -- @usage BOOL VERIFY_PASSWORD_HASH(char* password, char* hash);
307 | -- @param password char*
308 | -- @param hash char*
309 | -- @return BOOL
310 | function VerifyPasswordHash(password, hash) end
311 |
312 | -- Returns whether or not the currently executing event was canceled. See https://wiki.fivem.net/wiki/WasEventCanceled Returns: A boolean.
313 | -- @module native
314 | -- @submodule cfx
315 | -- @see WAS_EVENT_CANCELED
316 | -- @usage BOOL WAS_EVENT_CANCELED();
317 | -- @return BOOL
318 | function WasEventCanceled() end
319 |
320 | -- @todo
321 | -- @module native
322 | -- @submodule cfx
323 | -- @see GET_HOST_ID
324 | -- @usage char* GET_HOST_ID();
325 | -- @return char*
326 | function GetHostId() end
327 |
328 | -- @todo
329 | -- @module native
330 | -- @submodule cfx
331 | -- @see GET_PLAYER_GUID
332 | -- @usage char* GET_PLAYER_GUID(char* playerSrc);
333 | -- @param playerSrc char*
334 | -- @return char*
335 | function GetPlayerGuid(playerSrc) end
336 |
337 | -- @todo
338 | -- @module native
339 | -- @submodule cfx
340 | -- @see SET_MAP_NAME
341 | -- @usage void SET_MAP_NAME(char* mapName);
342 | -- @param mapName char*
343 | -- @return void
344 | function SetMapName(mapName) end
345 |
346 | -- @todo
347 | -- @module native
348 | -- @submodule cfx
349 | -- @see GET_PLAYER_PING
350 | -- @usage int GET_PLAYER_PING(char* playerSrc);
351 | -- @param playerSrc char*
352 | -- @return int
353 | function GetPlayerPing(playerSrc) end
354 |
355 | -- The backing function for TriggerClientEvent.
356 | -- @module native
357 | -- @submodule cfx
358 | -- @see TRIGGER_CLIENT_EVENT_INTERNAL
359 | -- @usage void TRIGGER_CLIENT_EVENT_INTERNAL(char* eventName, char* eventTarget, char* eventPayload, int payloadLength);
360 | -- @param eventName char*
361 | -- @param eventTarget char*
362 | -- @param eventPayload char*
363 | -- @param payloadLength int
364 | -- @return void
365 | function TriggerClientEventInternal(eventName, eventTarget, eventPayload, payloadLength) end
366 |
367 | -- @todo
368 | -- @module native
369 | -- @submodule cfx
370 | -- @see DROP_PLAYER
371 | -- @usage void DROP_PLAYER(char* playerSrc, char* reason);
372 | -- @param playerSrc char*
373 | -- @param reason char*
374 | -- @return void
375 | function DropPlayer(playerSrc, reason) end
376 |
377 | -- @todo
378 | -- @module native
379 | -- @submodule cfx
380 | -- @see TEMP_BAN_PLAYER
381 | -- @usage void TEMP_BAN_PLAYER(char* playerSrc, char* reason);
382 | -- @param playerSrc char*
383 | -- @param reason char*
384 | -- @return void
385 | function TempBanPlayer(playerSrc, reason) end
386 |
387 | -- @todo
388 | -- @module native
389 | -- @submodule cfx
390 | -- @see GET_PLAYER_ENDPOINT
391 | -- @usage char* GET_PLAYER_ENDPOINT(char* playerSrc);
392 | -- @param playerSrc char*
393 | -- @return char*
394 | function GetPlayerEndpoint(playerSrc) end
395 |
396 | -- Returns the name of the currently executing resource. Returns: The name of the resource.
397 | -- @module native
398 | -- @submodule cfx
399 | -- @see GET_CURRENT_RESOURCE_NAME
400 | -- @usage char* GET_CURRENT_RESOURCE_NAME();
401 | -- @return char*
402 | function GetCurrentResourceName() end
403 |
404 | -- @todo
405 | -- @module native
406 | -- @submodule cfx
407 | -- @see START_RESOURCE
408 | -- @usage BOOL START_RESOURCE(char* resourceName);
409 | -- @param resourceName char*
410 | -- @return BOOL
411 | function StartResource(resourceName) end
412 |
413 | -- @todo
414 | -- @module native
415 | -- @submodule cfx
416 | -- @see ENABLE_ENHANCED_HOST_SUPPORT
417 | -- @usage void ENABLE_ENHANCED_HOST_SUPPORT(BOOL enabled);
418 | -- @param enabled BOOL
419 | -- @return void
420 | function EnableEnhancedHostSupport(enabled) end
421 |
422 | -- @todo
423 | -- @module native
424 | -- @submodule cfx
425 | -- @see ADD_TEXT_ENTRY_BY_HASH
426 | -- @usage void ADD_TEXT_ENTRY_BY_HASH(Hash entryKey, char* entryText);
427 | -- @param entryKey Hash
428 | -- @param entryText char*
429 | -- @return void
430 | function AddTextEntryByHash(entryKey, entryText) end
431 |
432 | -- @todo
433 | -- @module native
434 | -- @submodule cfx
435 | -- @see SET_SNAKEOIL_FOR_ENTRY
436 | -- @usage void SET_SNAKEOIL_FOR_ENTRY(char* name, char* path, char* data);
437 | -- @param name char*
438 | -- @param path char*
439 | -- @param data char*
440 | -- @return void
441 | function SetSnakeoilForEntry(name, path, data) end
442 |
443 | -- @todo
444 | -- @module native
445 | -- @submodule cfx
446 | -- @see SET_RESOURCE_KVP_FLOAT
447 | -- @usage void SET_RESOURCE_KVP_FLOAT(char* key, float value);
448 | -- @param key char*
449 | -- @param value float
450 | -- @return void
451 | function SetResourceKvpFloat(key, value) end
452 |
453 | -- @todo
454 | -- @module native
455 | -- @submodule cfx
456 | -- @see FIND_KVP
457 | -- @usage char* FIND_KVP(int handle);
458 | -- @param handle int
459 | -- @return char*
460 | function FindKvp(handle) end
461 |
462 | -- @todo
463 | -- @module native
464 | -- @submodule cfx
465 | -- @see GET_NUM_PLAYER_IDENTIFIERS
466 | -- @usage int GET_NUM_PLAYER_IDENTIFIERS(char* playerSrc);
467 | -- @param playerSrc char*
468 | -- @return int
469 | function GetNumPlayerIdentifiers(playerSrc) end
470 |
471 | -- @todo
472 | -- @module native
473 | -- @submodule cfx
474 | -- @see GET_PLAYER_IDENTIFIER
475 | -- @usage char* GET_PLAYER_IDENTIFIER(char* playerSrc, int identifier);
476 | -- @param playerSrc char*
477 | -- @param identifier int
478 | -- @return char*
479 | function GetPlayerIdentifier(playerSrc, identifier) end
480 |
481 | -- @todo
482 | -- @module native
483 | -- @submodule cfx
484 | -- @see SET_RESOURCE_KVP_INT
485 | -- @usage void SET_RESOURCE_KVP_INT(char* key, int value);
486 | -- @param key char*
487 | -- @param value int
488 | -- @return void
489 | function SetResourceKvpInt(key, value) end
490 |
491 | -- @todo
492 | -- @module native
493 | -- @submodule cfx
494 | -- @see SET_NUI_FOCUS
495 | -- @usage void SET_NUI_FOCUS(BOOL hasFocus);
496 | -- @param hasFocus BOOL
497 | -- @return void
498 | function SetNuiFocus(hasFocus) end
499 |
500 | -- @todo
501 | -- @module native
502 | -- @submodule cfx
503 | -- @see SET_MODEL_HEADLIGHT_CONFIGURATION
504 | -- @usage void SET_MODEL_HEADLIGHT_CONFIGURATION(Hash modelHash, float ratePerSecond, float headlightRotation, BOOL invertRotation);
505 | -- @param modelHash Hash
506 | -- @param ratePerSecond float
507 | -- @param headlightRotation float
508 | -- @param invertRotation BOOL
509 | -- @return void
510 | function SetModelHeadlightConfiguration(modelHash, ratePerSecond, headlightRotation, invertRotation) end
511 |
512 | -- @todo
513 | -- @module native
514 | -- @submodule cfx
515 | -- @see SET_CONVAR
516 | -- @usage void SET_CONVAR(char* varName, char* value);
517 | -- @param varName char*
518 | -- @param value char*
519 | -- @return void
520 | function SetConvar(varName, value) end
521 |
522 | -- @todo
523 | -- @module native
524 | -- @submodule cfx
525 | -- @see GET_NUM_PLAYER_INDICES
526 | -- @usage int GET_NUM_PLAYER_INDICES();
527 | -- @return int
528 | function GetNumPlayerIndices() end
529 |
530 | -- The backing function for TriggerEvent.
531 | -- @module native
532 | -- @submodule cfx
533 | -- @see TRIGGER_EVENT_INTERNAL
534 | -- @usage void TRIGGER_EVENT_INTERNAL(char* eventName, char* eventPayload, int payloadLength);
535 | -- @param eventName char*
536 | -- @param eventPayload char*
537 | -- @param payloadLength int
538 | -- @return void
539 | function TriggerEventInternal(eventName, eventPayload, payloadLength) end
540 |
541 | -- Writes the specified data to a file in the specified resource. Using a length of -1 will automatically detect the length assuming the data is a C string. Parameters:dataLength: The length of the written data.data: The data to write to the file.fileName: The name of the file.resourceName: The name of the resource.Returns: A value indicating if the write succeeded.
542 | -- @module native
543 | -- @submodule cfx
544 | -- @see SAVE_RESOURCE_FILE
545 | -- @usage BOOL SAVE_RESOURCE_FILE(char* resourceName, char* fileName, char* data, int dataLength);
546 | -- @param resourceName char*
547 | -- @param fileName char*
548 | -- @param data char*
549 | -- @param dataLength int
550 | -- @return BOOL
551 | function SaveResourceFile(resourceName, fileName, data, dataLength) end
552 |
553 | -- @todo
554 | -- @module native
555 | -- @submodule cfx
556 | -- @see REGISTER_NUI_CALLBACK_TYPE
557 | -- @usage void REGISTER_NUI_CALLBACK_TYPE(char* callbackType);
558 | -- @param callbackType char*
559 | -- @return void
560 | function RegisterNuiCallbackType(callbackType) end
561 |
562 | -- @todo
563 | -- @module native
564 | -- @submodule cfx
565 | -- @see GET_RESOURCE_KVP_FLOAT
566 | -- @usage float GET_RESOURCE_KVP_FLOAT(char* key);
567 | -- @param key char*
568 | -- @return float
569 | function GetResourceKvpFloat(key) end
570 |
571 | -- Gets the metadata value at a specified key/index from a resource's manifest. See also: Resource manifest Parameters:index: The value index, in a range from [0..GETNUMRESOURCE_METDATA-1].resourceName: The resource name.metadataKey: The key in the resource manifest.
572 | -- @module native
573 | -- @submodule cfx
574 | -- @see GET_RESOURCE_METADATA
575 | -- @usage char* GET_RESOURCE_METADATA(char* resourceName, char* metadataKey, int index);
576 | -- @param resourceName char*
577 | -- @param metadataKey char*
578 | -- @param index int
579 | -- @return char*
580 | function GetResourceMetadata(resourceName, metadataKey, index) end
581 |
582 | -- @todo
583 | -- @module native
584 | -- @submodule cfx
585 | -- @see GET_NUM_RESOURCES
586 | -- @usage int GET_NUM_RESOURCES();
587 | -- @return int
588 | function GetNumResources() end
589 |
590 | -- @todo
591 | -- @module native
592 | -- @submodule cfx
593 | -- @see INVOKE_FUNCTION_REFERENCE
594 | -- @usage char* INVOKE_FUNCTION_REFERENCE(char* referenceIdentity, char* argsSerialized, int argsLength, int* retvalLength);
595 | -- @param referenceIdentity char*
596 | -- @param argsSerialized char*
597 | -- @param argsLength int
598 | -- @param retvalLength int*
599 | -- @return char*
600 | function InvokeFunctionReference(referenceIdentity, argsSerialized, argsLength, retvalLength) end
601 |
602 | -- @todo
603 | -- @module native
604 | -- @submodule cfx
605 | -- @see DELETE_RESOURCE_KVP
606 | -- @usage void DELETE_RESOURCE_KVP(char* key);
607 | -- @param key char*
608 | -- @return void
609 | function DeleteResourceKvp(key) end
--------------------------------------------------------------------------------
/client/native/controls.lua:
--------------------------------------------------------------------------------
1 | -- Control Groups: enum InputGroups { INPUTGROUP_MOVE = 0, INPUTGROUP_LOOK = 1, INPUTGROUP_WHEEL = 2, INPUTGROUP_CELLPHONE_NAVIGATE = 3, INPUTGROUP_CELLPHONE_NAVIGATE_UD = 4, INPUTGROUP_CELLPHONE_NAVIGATE_LR = 5, INPUTGROUP_FRONTEND_DPAD_ALL = 6, INPUTGROUP_FRONTEND_DPAD_UD = 7, INPUTGROUP_FRONTEND_DPAD_LR = 8, INPUTGROUP_FRONTEND_LSTICK_ALL = 9, INPUTGROUP_FRONTEND_RSTICK_ALL = 10, INPUTGROUP_FRONTEND_GENERIC_UD = 11, INPUTGROUP_FRONTEND_GENERIC_LR = 12, INPUTGROUP_FRONTEND_GENERIC_ALL = 13, INPUTGROUP_FRONTEND_BUMPERS = 14, INPUTGROUP_FRONTEND_TRIGGERS = 15, INPUTGROUP_FRONTEND_STICKS = 16, INPUTGROUP_SCRIPT_DPAD_ALL = 17, INPUTGROUP_SCRIPT_DPAD_UD = 18, INPUTGROUP_SCRIPT_DPAD_LR = 19, INPUTGROUP_SCRIPT_LSTICK_ALL = 20, INPUTGROUP_SCRIPT_RSTICK_ALL = 21, INPUTGROUP_SCRIPT_BUMPERS = 22, INPUTGROUP_SCRIPT_TRIGGERS = 23, INPUTGROUP_WEAPON_WHEEL_CYCLE = 24, INPUTGROUP_FLY = 25, INPUTGROUP_SUB = 26, INPUTGROUP_VEH_MOVE_ALL = 27, INPUTGROUP_CURSOR = 28, INPUTGROUP_CURSOR_SCROLL = 29, INPUTGROUP_SNIPER_ZOOM_SECONDARY = 30, INPUTGROUP_VEH_HYDRAULICS_CONTROL = 31, MAX_INPUTGROUPS = 32, INPUTGROUP_INVALID = 33 }; 0, 1 and 2 used in the scripts.
2 | -- @module native
3 | -- @submodule controls
4 | -- @see IS_CONTROL_ENABLED
5 | -- @usage BOOL IS_CONTROL_ENABLED(int inputGroup, int control);
6 | -- @param inputGroup int
7 | -- @param control int
8 | -- @return BOOL
9 | function IsControlEnabled(inputGroup, control) end
10 |
11 | -- index always is 2 for xbox 360 controller and razerblade 0, 1 and 2 used in the scripts. 0 is by far the most common of them.
12 | -- @module native
13 | -- @submodule controls
14 | -- @see IS_CONTROL_PRESSED
15 | -- @usage BOOL IS_CONTROL_PRESSED(int inputGroup, int control);
16 | -- @param inputGroup int
17 | -- @param control int
18 | -- @return BOOL
19 | function IsControlPressed(inputGroup, control) end
20 |
21 | -- 0, 1 and 2 used in the scripts. 0 is by far the most common of them.
22 | -- @module native
23 | -- @submodule controls
24 | -- @see IS_CONTROL_RELEASED
25 | -- @usage BOOL IS_CONTROL_RELEASED(int inputGroup, int control);
26 | -- @param inputGroup int
27 | -- @param control int
28 | -- @return BOOL
29 | function IsControlReleased(inputGroup, control) end
30 |
31 | -- @todo
32 | -- @module native
33 | -- @submodule controls
34 | -- @see IS_CONTROL_JUST_PRESSED
35 | -- @usage BOOL IS_CONTROL_JUST_PRESSED(int inputGroup, int control);
36 | -- @param inputGroup int
37 | -- @param control int
38 | -- @return BOOL
39 | function IsControlJustPressed(inputGroup, control) end
40 |
41 | -- @todo
42 | -- @module native
43 | -- @submodule controls
44 | -- @see IS_CONTROL_JUST_RELEASED
45 | -- @usage BOOL IS_CONTROL_JUST_RELEASED(int inputGroup, int control);
46 | -- @param inputGroup int
47 | -- @param control int
48 | -- @return BOOL
49 | function IsControlJustReleased(inputGroup, control) end
50 |
51 | -- 0, 1 and 2 used in the scripts. 0 is by far the most common of them.
52 | -- @module native
53 | -- @submodule controls
54 | -- @see GET_CONTROL_VALUE
55 | -- @usage int GET_CONTROL_VALUE(int inputGroup, int control);
56 | -- @param inputGroup int
57 | -- @param control int
58 | -- @return int
59 | function GetControlValue(inputGroup, control) end
60 |
61 | -- Returns the value of CONTROLS::GET_CONTROL_VALUE Normalized (ie a real number value between -1 and 1) 0, 1 and 2 used in the scripts. 0 is by far the most common of them.
62 | -- @module native
63 | -- @submodule controls
64 | -- @see GET_CONTROL_NORMAL
65 | -- @usage float GET_CONTROL_NORMAL(int inputGroup, int control);
66 | -- @param inputGroup int
67 | -- @param control int
68 | -- @return float
69 | function GetControlNormal(inputGroup, control) end
70 |
71 | -- 0, 1 and 2 used in the scripts. 0 is by far the most common of them.
72 | -- @module native
73 | -- @submodule controls
74 | -- @see IS_DISABLED_CONTROL_PRESSED
75 | -- @usage BOOL IS_DISABLED_CONTROL_PRESSED(int inputGroup, int control);
76 | -- @param inputGroup int
77 | -- @param control int
78 | -- @return BOOL
79 | function IsDisabledControlPressed(inputGroup, control) end
80 |
81 | -- 0, 1 and 2 used in the scripts. 0 is by far the most common of them.
82 | -- @module native
83 | -- @submodule controls
84 | -- @see IS_DISABLED_CONTROL_JUST_PRESSED
85 | -- @usage BOOL IS_DISABLED_CONTROL_JUST_PRESSED(int inputGroup, int control);
86 | -- @param inputGroup int
87 | -- @param control int
88 | -- @return BOOL
89 | function IsDisabledControlJustPressed(inputGroup, control) end
90 |
91 | -- 0, 1 and 2 used in the scripts. 0 is by far the most common of them.
92 | -- @module native
93 | -- @submodule controls
94 | -- @see IS_DISABLED_CONTROL_JUST_RELEASED
95 | -- @usage BOOL IS_DISABLED_CONTROL_JUST_RELEASED(int inputGroup, int control);
96 | -- @param inputGroup int
97 | -- @param control int
98 | -- @return BOOL
99 | function IsDisabledControlJustReleased(inputGroup, control) end
100 |
101 | -- control - c# works with (int)GTA.Control.CursorY / (int)GTA.Control.CursorX and returns the mouse movement (additive). 0, 1 and 2 used in the scripts. 0 is by far the most common of them.
102 | -- @module native
103 | -- @submodule controls
104 | -- @see GET_DISABLED_CONTROL_NORMAL
105 | -- @usage float GET_DISABLED_CONTROL_NORMAL(int inputGroup, int control);
106 | -- @param inputGroup int
107 | -- @param control int
108 | -- @return float
109 | function GetDisabledControlNormal(inputGroup, control) end
110 |
111 | -- formerly called _GET_CONTROL_ACTION_NAME incorrectly p2 appears to always be true. p2 is unused variable in function. EG: GET_CONTROL_INSTRUCTIONAL_BUTTON (2, 201, 1) /*INPUT_FRONTEND_ACCEPT (e.g. Enter button)*/ GET_CONTROL_INSTRUCTIONAL_BUTTON (2, 202, 1) /*INPUT_FRONTEND_CANCEL (e.g. ESC button)*/ GET_CONTROL_INSTRUCTIONAL_BUTTON (2, 51, 1) /*INPUT_CONTEXT (e.g. E button)*/ gtaforums.com/topic/819070-c-draw-instructional-buttons-scaleform-movie/#entry1068197378 0, 1 and 2 used in the scripts. 0 is by far the most common of them.
112 | -- @module native
113 | -- @submodule controls
114 | -- @see GET_CONTROL_INSTRUCTIONAL_BUTTON
115 | -- @usage char* GET_CONTROL_INSTRUCTIONAL_BUTTON(int inputGroup, int control, BOOL p2);
116 | -- @param inputGroup int
117 | -- @param control int
118 | -- @param p2 BOOL
119 | -- @return char*
120 | function GetControlInstructionalButton(inputGroup, control, p2) end
121 |
122 | -- p0 always seems to be 0 duration in milliseconds frequency should range from about 10 (slow vibration) to 255 (very fast) appears to be a hash collision, though it does do what it says example: SET_PAD_SHAKE(0, 100, 200);
123 | -- @module native
124 | -- @submodule controls
125 | -- @see SET_PAD_SHAKE
126 | -- @usage void SET_PAD_SHAKE(int p0, int duration, int frequency);
127 | -- @param p0 int
128 | -- @param duration int
129 | -- @param frequency int
130 | -- @return void
131 | function SetPadShake(p0, duration, frequency) end
132 |
133 | -- @todo
134 | -- @module native
135 | -- @submodule controls
136 | -- @see STOP_PAD_SHAKE
137 | -- @usage void STOP_PAD_SHAKE(Any p0);
138 | -- @param p0 Any
139 | -- @return void
140 | function StopPadShake(p0) end
141 |
142 | -- @todo
143 | -- @module native
144 | -- @submodule controls
145 | -- @see IS_LOOK_INVERTED
146 | -- @usage BOOL IS_LOOK_INVERTED();
147 | -- @return BOOL
148 | function IsLookInverted() end
149 |
150 | -- @todo
151 | -- @module native
152 | -- @submodule controls
153 | -- @see GET_LOCAL_PLAYER_AIM_STATE
154 | -- @usage int GET_LOCAL_PLAYER_AIM_STATE();
155 | -- @return int
156 | function GetLocalPlayerAimState() end
157 |
158 | -- @todo
159 | -- @module native
160 | -- @submodule controls
161 | -- @see SET_PLAYERPAD_SHAKES_WHEN_CONTROLLER_DISABLED
162 | -- @usage void SET_PLAYERPAD_SHAKES_WHEN_CONTROLLER_DISABLED(BOOL toggle);
163 | -- @param toggle BOOL
164 | -- @return void
165 | function SetPlayerpadShakesWhenControllerDisabled(toggle) end
166 |
167 | -- @todo
168 | -- @module native
169 | -- @submodule controls
170 | -- @see SET_INPUT_EXCLUSIVE
171 | -- @usage void SET_INPUT_EXCLUSIVE(int inputGroup, int control);
172 | -- @param inputGroup int
173 | -- @param control int
174 | -- @return void
175 | function SetInputExclusive(inputGroup, control) end
176 |
177 | -- control values and meaning: github.com/crosire/scripthookvdotnet/blob/dev_v3/source/scripting/Controls.cs 0, 1 and 2 used in the scripts. 0 is by far the most common of them. Control values from the decompiled scripts: 0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27, 28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,53,5 4,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,76,77,78, 79,80,81,82,85,86,87,88,89,90,91,92,93,95,96,97,98,99,100,101,102,103,105, 107,108,109,110,111,112,113,114,115,116,117,118,119,123,126,129,130,131,132, 133,134,136,137,138,139,140,141,142,143,144,145,146,147,148,149,150,151,152, 153,154,155,156,157,158,159,160,161,162,163,164,165,166,167,168,169,171,172 ,177,187,188,189,190,195,196,199,200,201,202,203,205,207,208,209,211,212,213, 217,219,220,221,225,226,230,234,235,236,237,238,239,240,241,242,243,244,257, 261,262,263,264,265,270,271,272,273,274,278,279,280,281,282,283,284,285,286, 287,288,289,337. Example: CONTROLS::DISABLE_CONTROL_ACTION(2, 19, true) disables the switching UI from appearing both when using a keyboard and Xbox 360 controller. Needs to be executed each frame. Control group 1 and 0 gives the same results as 2. Same results for all players.
178 | -- @module native
179 | -- @submodule controls
180 | -- @see DISABLE_CONTROL_ACTION
181 | -- @usage void DISABLE_CONTROL_ACTION(int inputGroup, int control, BOOL disable);
182 | -- @param inputGroup int
183 | -- @param control int
184 | -- @param disable BOOL
185 | -- @return void
186 | function DisableControlAction(inputGroup, control, disable) end
187 |
188 | -- control values and meaning: github.com/crosire/scripthookvdotnet/blob/dev/source/scripting/Controls.hpp 0, 1 and 2 used in the scripts. Control values from the decompiled scripts: 0,1,2,3,4,5,6,8,9,10,11,14,15,16,17,19,21,22,24,25,26,30,31,32,33,34,35,36, 37,44,46,47,59,60,65,68,69,70,71,72,73,74,75,76,79,80,81,82,86,95,98,99,100 ,101,114,140,141,143,172,173,174,175,176,177,178,179,180,181,187,188,189,19 0,195,196,197,198,199,201,202,203,204,205,206,207,208,209,210,217,218,219,2 20,221,225,228,229,230,231,234,235,236,237,238,239,240,241,242,245,246,257, 261,262,263,264,286,287,288,289,337,338,339,340,341,342,343 INPUTGROUP_MOVE INPUTGROUP_LOOK INPUTGROUP_WHEEL INPUTGROUP_CELLPHONE_NAVIGATE INPUTGROUP_CELLPHONE_NAVIGATE_UD INPUTGROUP_CELLPHONE_NAVIGATE_LR INPUTGROUP_FRONTEND_DPAD_ALL INPUTGROUP_FRONTEND_DPAD_UD INPUTGROUP_FRONTEND_DPAD_LR INPUTGROUP_FRONTEND_LSTICK_ALL INPUTGROUP_FRONTEND_RSTICK_ALL INPUTGROUP_FRONTEND_GENERIC_UD INPUTGROUP_FRONTEND_GENERIC_LR INPUTGROUP_FRONTEND_GENERIC_ALL INPUTGROUP_FRONTEND_BUMPERS INPUTGROUP_FRONTEND_TRIGGERS INPUTGROUP_FRONTEND_STICKS INPUTGROUP_SCRIPT_DPAD_ALL INPUTGROUP_SCRIPT_DPAD_UD INPUTGROUP_SCRIPT_DPAD_LR INPUTGROUP_SCRIPT_LSTICK_ALL INPUTGROUP_SCRIPT_RSTICK_ALL INPUTGROUP_SCRIPT_BUMPERS INPUTGROUP_SCRIPT_TRIGGERS INPUTGROUP_WEAPON_WHEEL_CYCLE INPUTGROUP_FLY INPUTGROUP_SUB INPUTGROUP_VEH_MOVE_ALL INPUTGROUP_CURSOR INPUTGROUP_CURSOR_SCROLL INPUTGROUP_SNIPER_ZOOM_SECONDARY INPUTGROUP_VEH_HYDRAULICS_CONTROL Took those in IDA Pro.Not sure in which order they go
189 | -- @module native
190 | -- @submodule controls
191 | -- @see ENABLE_CONTROL_ACTION
192 | -- @usage void ENABLE_CONTROL_ACTION(int inputGroup, int control, BOOL enable);
193 | -- @param inputGroup int
194 | -- @param control int
195 | -- @param enable BOOL
196 | -- @return void
197 | function EnableControlAction(inputGroup, control, enable) end
198 |
199 | -- @todo
200 | -- @module native
201 | -- @submodule controls
202 | -- @see DISABLE_ALL_CONTROL_ACTIONS
203 | -- @usage void DISABLE_ALL_CONTROL_ACTIONS(int inputGroup);
204 | -- @param inputGroup int
205 | -- @return void
206 | function DisableAllControlActions(inputGroup) end
207 |
208 | -- @todo
209 | -- @module native
210 | -- @submodule controls
211 | -- @see ENABLE_ALL_CONTROL_ACTIONS
212 | -- @usage void ENABLE_ALL_CONTROL_ACTIONS(int inputGroup);
213 | -- @param inputGroup int
214 | -- @return void
215 | function EnableAllControlActions(inputGroup) end
--------------------------------------------------------------------------------
/client/native/cutscene.lua:
--------------------------------------------------------------------------------
1 | -- p1: usually 8
2 | -- @module native
3 | -- @submodule cutscene
4 | -- @see REQUEST_CUTSCENE
5 | -- @usage void REQUEST_CUTSCENE(char* cutsceneName, int p1);
6 | -- @param cutsceneName char*
7 | -- @param p1 int
8 | -- @return void
9 | function RequestCutscene(cutsceneName, p1) end
10 |
11 | -- @todo
12 | -- @module native
13 | -- @submodule cutscene
14 | -- @see REMOVE_CUTSCENE
15 | -- @usage void REMOVE_CUTSCENE();
16 | -- @return void
17 | function RemoveCutscene() end
18 |
19 | -- @todo
20 | -- @module native
21 | -- @submodule cutscene
22 | -- @see HAS_CUTSCENE_LOADED
23 | -- @usage BOOL HAS_CUTSCENE_LOADED();
24 | -- @return BOOL
25 | function HasCutsceneLoaded() end
26 |
27 | -- @todo
28 | -- @module native
29 | -- @submodule cutscene
30 | -- @see HAS_THIS_CUTSCENE_LOADED
31 | -- @usage BOOL HAS_THIS_CUTSCENE_LOADED(char* cutsceneName);
32 | -- @param cutsceneName char*
33 | -- @return BOOL
34 | function HasThisCutsceneLoaded(cutsceneName) end
35 |
36 | -- some kind of flag. Usually 0.
37 | -- @module native
38 | -- @submodule cutscene
39 | -- @see START_CUTSCENE
40 | -- @usage void START_CUTSCENE(int p0);
41 | -- @param p0 int
42 | -- @return void
43 | function StartCutscene(p0) end
44 |
45 | -- p3: some kind of flag. Usually 0.
46 | -- @module native
47 | -- @submodule cutscene
48 | -- @see START_CUTSCENE_AT_COORDS
49 | -- @usage void START_CUTSCENE_AT_COORDS(float x, float y, float z, int p3);
50 | -- @param x float
51 | -- @param y float
52 | -- @param z float
53 | -- @param p3 int
54 | -- @return void
55 | function StartCutsceneAtCoords(x, y, z, p3) end
56 |
57 | -- @todo
58 | -- @module native
59 | -- @submodule cutscene
60 | -- @see STOP_CUTSCENE
61 | -- @usage void STOP_CUTSCENE(BOOL p0);
62 | -- @param p0 BOOL
63 | -- @return void
64 | function StopCutscene(p0) end
65 |
66 | -- @todo
67 | -- @module native
68 | -- @submodule cutscene
69 | -- @see STOP_CUTSCENE_IMMEDIATELY
70 | -- @usage void STOP_CUTSCENE_IMMEDIATELY();
71 | -- @return void
72 | function StopCutsceneImmediately() end
73 |
74 | -- p3 could be heading. Needs more research.
75 | -- @module native
76 | -- @submodule cutscene
77 | -- @see SET_CUTSCENE_ORIGIN
78 | -- @usage void SET_CUTSCENE_ORIGIN(float x, float y, float z, float p3, int p4);
79 | -- @param x float
80 | -- @param y float
81 | -- @param z float
82 | -- @param p3 float
83 | -- @param p4 int
84 | -- @return void
85 | function SetCutsceneOrigin(x, y, z, p3, p4) end
86 |
87 | -- @todo
88 | -- @module native
89 | -- @submodule cutscene
90 | -- @see GET_CUTSCENE_TIME
91 | -- @usage int GET_CUTSCENE_TIME();
92 | -- @return int
93 | function GetCutsceneTime() end
94 |
95 | -- @todo
96 | -- @module native
97 | -- @submodule cutscene
98 | -- @see GET_CUTSCENE_TOTAL_DURATION
99 | -- @usage int GET_CUTSCENE_TOTAL_DURATION();
100 | -- @return int
101 | function GetCutsceneTotalDuration() end
102 |
103 | -- @todo
104 | -- @module native
105 | -- @submodule cutscene
106 | -- @see WAS_CUTSCENE_SKIPPED
107 | -- @usage BOOL WAS_CUTSCENE_SKIPPED();
108 | -- @return BOOL
109 | function WasCutsceneSkipped() end
110 |
111 | -- @todo
112 | -- @module native
113 | -- @submodule cutscene
114 | -- @see HAS_CUTSCENE_FINISHED
115 | -- @usage BOOL HAS_CUTSCENE_FINISHED();
116 | -- @return BOOL
117 | function HasCutsceneFinished() end
118 |
119 | -- @todo
120 | -- @module native
121 | -- @submodule cutscene
122 | -- @see IS_CUTSCENE_ACTIVE
123 | -- @usage BOOL IS_CUTSCENE_ACTIVE();
124 | -- @return BOOL
125 | function IsCutsceneActive() end
126 |
127 | -- @todo
128 | -- @module native
129 | -- @submodule cutscene
130 | -- @see IS_CUTSCENE_PLAYING
131 | -- @usage BOOL IS_CUTSCENE_PLAYING();
132 | -- @return BOOL
133 | function IsCutscenePlaying() end
134 |
135 | -- @todo
136 | -- @module native
137 | -- @submodule cutscene
138 | -- @see GET_CUTSCENE_SECTION_PLAYING
139 | -- @usage int GET_CUTSCENE_SECTION_PLAYING();
140 | -- @return int
141 | function GetCutsceneSectionPlaying() end
142 |
143 | -- @todo
144 | -- @module native
145 | -- @submodule cutscene
146 | -- @see GET_ENTITY_INDEX_OF_CUTSCENE_ENTITY
147 | -- @usage Entity GET_ENTITY_INDEX_OF_CUTSCENE_ENTITY(char* cutsceneEntName, Hash modelHash);
148 | -- @param cutsceneEntName char*
149 | -- @param modelHash Hash
150 | -- @return Entity
151 | function GetEntityIndexOfCutsceneEntity(cutsceneEntName, modelHash) end
152 |
153 | -- @todo
154 | -- @module native
155 | -- @submodule cutscene
156 | -- @see REGISTER_ENTITY_FOR_CUTSCENE
157 | -- @usage void REGISTER_ENTITY_FOR_CUTSCENE(Ped cutscenePed, char* cutsceneEntName, int p2, Hash modelHash, int p4);
158 | -- @param cutscenePed Ped
159 | -- @param cutsceneEntName char*
160 | -- @param p2 int
161 | -- @param modelHash Hash
162 | -- @param p4 int
163 | -- @return void
164 | function RegisterEntityForCutscene(cutscenePed, cutsceneEntName, p2, modelHash, p4) end
165 |
166 | -- @todo
167 | -- @module native
168 | -- @submodule cutscene
169 | -- @see GET_ENTITY_INDEX_OF_REGISTERED_ENTITY
170 | -- @usage Entity GET_ENTITY_INDEX_OF_REGISTERED_ENTITY(char* cutsceneEntName, Hash modelHash);
171 | -- @param cutsceneEntName char*
172 | -- @param modelHash Hash
173 | -- @return Entity
174 | function GetEntityIndexOfRegisteredEntity(cutsceneEntName, modelHash) end
175 |
176 | -- Only used twice in R* scripts
177 | -- @module native
178 | -- @submodule cutscene
179 | -- @see SET_CUTSCENE_TRIGGER_AREA
180 | -- @usage void SET_CUTSCENE_TRIGGER_AREA(float p0, float p1, float p2, float p3, float p4, float p5);
181 | -- @param p0 float
182 | -- @param p1 float
183 | -- @param p2 float
184 | -- @param p3 float
185 | -- @param p4 float
186 | -- @param p5 float
187 | -- @return void
188 | function SetCutsceneTriggerArea(p0, p1, p2, p3, p4, p5) end
189 |
190 | -- modelHash (p1) was always 0 in R* scripts
191 | -- @module native
192 | -- @submodule cutscene
193 | -- @see CAN_SET_ENTER_STATE_FOR_REGISTERED_ENTITY
194 | -- @usage BOOL CAN_SET_ENTER_STATE_FOR_REGISTERED_ENTITY(char* cutsceneEntName, Hash modelHash);
195 | -- @param cutsceneEntName char*
196 | -- @param modelHash Hash
197 | -- @return BOOL
198 | function CanSetEnterStateForRegisteredEntity(cutsceneEntName, modelHash) end
199 |
200 | -- @todo
201 | -- @module native
202 | -- @submodule cutscene
203 | -- @see CAN_SET_EXIT_STATE_FOR_REGISTERED_ENTITY
204 | -- @usage BOOL CAN_SET_EXIT_STATE_FOR_REGISTERED_ENTITY(char* cutsceneEntName, Hash modelHash);
205 | -- @param cutsceneEntName char*
206 | -- @param modelHash Hash
207 | -- @return BOOL
208 | function CanSetExitStateForRegisteredEntity(cutsceneEntName, modelHash) end
209 |
210 | -- @todo
211 | -- @module native
212 | -- @submodule cutscene
213 | -- @see CAN_SET_EXIT_STATE_FOR_CAMERA
214 | -- @usage BOOL CAN_SET_EXIT_STATE_FOR_CAMERA(BOOL p0);
215 | -- @param p0 BOOL
216 | -- @return BOOL
217 | function CanSetExitStateForCamera(p0) end
218 |
219 | -- @todo
220 | -- @module native
221 | -- @submodule cutscene
222 | -- @see SET_CUTSCENE_FADE_VALUES
223 | -- @usage void SET_CUTSCENE_FADE_VALUES(BOOL p0, BOOL p1, BOOL p2, BOOL p3);
224 | -- @param p0 BOOL
225 | -- @param p1 BOOL
226 | -- @param p2 BOOL
227 | -- @param p3 BOOL
228 | -- @return void
229 | function SetCutsceneFadeValues(p0, p1, p2, p3) end
230 |
231 | -- @todo
232 | -- @module native
233 | -- @submodule cutscene
234 | -- @see REGISTER_SYNCHRONISED_SCRIPT_SPEECH
235 | -- @usage void REGISTER_SYNCHRONISED_SCRIPT_SPEECH();
236 | -- @return void
237 | function RegisterSynchronisedScriptSpeech() end
238 |
239 | -- @todo
240 | -- @module native
241 | -- @submodule cutscene
242 | -- @see SET_CUTSCENE_PED_COMPONENT_VARIATION
243 | -- @usage void SET_CUTSCENE_PED_COMPONENT_VARIATION(char* cutsceneEntName, int p1, int p2, int p3, Hash modelHash);
244 | -- @param cutsceneEntName char*
245 | -- @param p1 int
246 | -- @param p2 int
247 | -- @param p3 int
248 | -- @param modelHash Hash
249 | -- @return void
250 | function SetCutscenePedComponentVariation(cutsceneEntName, p1, p2, p3, modelHash) end
251 |
252 | -- @todo
253 | -- @module native
254 | -- @submodule cutscene
255 | -- @see DOES_CUTSCENE_ENTITY_EXIST
256 | -- @usage BOOL DOES_CUTSCENE_ENTITY_EXIST(char* cutsceneEntName, Hash modelHash);
257 | -- @param cutsceneEntName char*
258 | -- @param modelHash Hash
259 | -- @return BOOL
260 | function DoesCutsceneEntityExist(cutsceneEntName, modelHash) end
261 |
262 | -- Thanks R*! ;) if ((l_161 == 0) || (l_161 == 2)) { sub_2ea27("Trying to set Jimmy prop variation"); CUTSCENE::_0546524ADE2E9723("Jimmy_Boston", 1, 0, 0, 0); }
263 | -- @module native
264 | -- @submodule cutscene
265 | -- @see SET_CUTSCENE_PED_PROP_VARIATION
266 | -- @usage void SET_CUTSCENE_PED_PROP_VARIATION(char* cutsceneEntName, int p1, int p2, int p3, Hash modelHash);
267 | -- @param cutsceneEntName char*
268 | -- @param p1 int
269 | -- @param p2 int
270 | -- @param p3 int
271 | -- @param modelHash Hash
272 | -- @return void
273 | function SetCutscenePedPropVariation(cutsceneEntName, p1, p2, p3, modelHash) end
--------------------------------------------------------------------------------
/client/native/datafile.lua:
--------------------------------------------------------------------------------
1 | -- @todo
2 | -- @module native
3 | -- @submodule datafile
4 | -- @see DATAFILE_CREATE
5 | -- @usage void DATAFILE_CREATE();
6 | -- @return void
7 | function DatafileCreate() end
8 |
9 | -- @todo
10 | -- @module native
11 | -- @submodule datafile
12 | -- @see DATAFILE_DELETE
13 | -- @usage void DATAFILE_DELETE();
14 | -- @return void
15 | function DatafileDelete() end
16 |
17 | -- @todo
18 | -- @module native
19 | -- @submodule datafile
20 | -- @see DATAFILE_GET_FILE_DICT
21 | -- @usage char* DATAFILE_GET_FILE_DICT();
22 | -- @return char*
23 | function DatafileGetFileDict() end
24 |
25 | -- Example: if (!DATAFILE::_BEDB96A7584AA8CF()) { if (!g_109E3) { if (((sub_d4f() == 2) == 0) && (!NETWORK::NETWORK_IS_GAME_IN_PROGRESS())) { if (NETWORK::NETWORK_IS_CLOUD_AVAILABLE()) { g_17A8B = 0; } if (!g_D52C) { sub_730(); } } } }
26 | -- @module native
27 | -- @submodule datafile
28 | -- @see DATAFILE_IS_SAVE_PENDING
29 | -- @usage BOOL DATAFILE_IS_SAVE_PENDING();
30 | -- @return BOOL
31 | function DatafileIsSavePending() end
--------------------------------------------------------------------------------
/client/native/decisionevent.lua:
--------------------------------------------------------------------------------
1 | -- @todo
2 | -- @module native
3 | -- @submodule decisionevent
4 | -- @see SET_DECISION_MAKER
5 | -- @usage void SET_DECISION_MAKER(Ped ped, Hash name);
6 | -- @param ped Ped
7 | -- @param name Hash
8 | -- @return void
9 | function SetDecisionMaker(ped, name) end
10 |
11 | -- @todo
12 | -- @module native
13 | -- @submodule decisionevent
14 | -- @see CLEAR_DECISION_MAKER_EVENT_RESPONSE
15 | -- @usage void CLEAR_DECISION_MAKER_EVENT_RESPONSE(Hash name, int type);
16 | -- @param name Hash
17 | -- @param type int
18 | -- @return void
19 | function ClearDecisionMakerEventResponse(name, type) end
20 |
21 | -- @todo
22 | -- @module native
23 | -- @submodule decisionevent
24 | -- @see BLOCK_DECISION_MAKER_EVENT
25 | -- @usage void BLOCK_DECISION_MAKER_EVENT(Hash name, int type);
26 | -- @param name Hash
27 | -- @param type int
28 | -- @return void
29 | function BlockDecisionMakerEvent(name, type) end
30 |
31 | -- @todo
32 | -- @module native
33 | -- @submodule decisionevent
34 | -- @see UNBLOCK_DECISION_MAKER_EVENT
35 | -- @usage void UNBLOCK_DECISION_MAKER_EVENT(Hash name, int type);
36 | -- @param name Hash
37 | -- @param type int
38 | -- @return void
39 | function UnblockDecisionMakerEvent(name, type) end
40 |
41 | -- duration is float here Event types- camx.me/gtav/tasks/shockingevents.txt
42 | -- @module native
43 | -- @submodule decisionevent
44 | -- @see ADD_SHOCKING_EVENT_AT_POSITION
45 | -- @usage ScrHandle ADD_SHOCKING_EVENT_AT_POSITION(int type, float x, float y, float z, float duration);
46 | -- @param type int
47 | -- @param x float
48 | -- @param y float
49 | -- @param z float
50 | -- @param duration float
51 | -- @return ScrHandle
52 | function AddShockingEventAtPosition(type, x, y, z, duration) end
53 |
54 | -- duration is float here Event types - camx.me/gtav/tasks/shockingevents.txt
55 | -- @module native
56 | -- @submodule decisionevent
57 | -- @see ADD_SHOCKING_EVENT_FOR_ENTITY
58 | -- @usage ScrHandle ADD_SHOCKING_EVENT_FOR_ENTITY(int type, Entity entity, float duration);
59 | -- @param type int
60 | -- @param entity Entity
61 | -- @param duration float
62 | -- @return ScrHandle
63 | function AddShockingEventForEntity(type, entity, duration) end
64 |
65 | -- Some events that i found, not sure about them, but seems to have logic based on my tests: '82 - dead body '86 '87 '88 - shooting, fire extinguisher in use '89 '93 - ped using horn '95 - ped receiving melee attack '102 - living ped receiving shot '104 - player thrown grenade, tear gas, smoke grenade, jerry can dropping gasoline '105 - melee attack against veh '106 - player running '108 - vehicle theft '112 - melee attack '113 - veh rollover ped '114 - dead ped receiving shot '116 - aiming at ped '121 Here is full dump of shocking event types from the exe camx.me/gtav/tasks/shockingevents.txt
66 | -- @module native
67 | -- @submodule decisionevent
68 | -- @see IS_SHOCKING_EVENT_IN_SPHERE
69 | -- @usage BOOL IS_SHOCKING_EVENT_IN_SPHERE(int type, float x, float y, float z, float radius);
70 | -- @param type int
71 | -- @param x float
72 | -- @param y float
73 | -- @param z float
74 | -- @param radius float
75 | -- @return BOOL
76 | function IsShockingEventInSphere(type, x, y, z, radius) end
77 |
78 | -- @todo
79 | -- @module native
80 | -- @submodule decisionevent
81 | -- @see REMOVE_SHOCKING_EVENT
82 | -- @usage BOOL REMOVE_SHOCKING_EVENT(ScrHandle event);
83 | -- @param event ScrHandle
84 | -- @return BOOL
85 | function RemoveShockingEvent(event) end
86 |
87 | -- @todo
88 | -- @module native
89 | -- @submodule decisionevent
90 | -- @see REMOVE_ALL_SHOCKING_EVENTS
91 | -- @usage void REMOVE_ALL_SHOCKING_EVENTS(BOOL p0);
92 | -- @param p0 BOOL
93 | -- @return void
94 | function RemoveAllShockingEvents(p0) end
95 |
96 | -- @todo
97 | -- @module native
98 | -- @submodule decisionevent
99 | -- @see REMOVE_SHOCKING_EVENT_SPAWN_BLOCKING_AREAS
100 | -- @usage void REMOVE_SHOCKING_EVENT_SPAWN_BLOCKING_AREAS();
101 | -- @return void
102 | function RemoveShockingEventSpawnBlockingAreas() end
103 |
104 | -- @todo
105 | -- @module native
106 | -- @submodule decisionevent
107 | -- @see SUPPRESS_SHOCKING_EVENTS_NEXT_FRAME
108 | -- @usage void SUPPRESS_SHOCKING_EVENTS_NEXT_FRAME();
109 | -- @return void
110 | function SuppressShockingEventsNextFrame() end
111 |
112 | -- @todo
113 | -- @module native
114 | -- @submodule decisionevent
115 | -- @see SUPPRESS_SHOCKING_EVENT_TYPE_NEXT_FRAME
116 | -- @usage void SUPPRESS_SHOCKING_EVENT_TYPE_NEXT_FRAME(int type);
117 | -- @param type int
118 | -- @return void
119 | function SuppressShockingEventTypeNextFrame(type) end
120 |
121 | -- @todo
122 | -- @module native
123 | -- @submodule decisionevent
124 | -- @see SUPPRESS_AGITATION_EVENTS_NEXT_FRAME
125 | -- @usage void SUPPRESS_AGITATION_EVENTS_NEXT_FRAME();
126 | -- @return void
127 | function SuppressAgitationEventsNextFrame() end
--------------------------------------------------------------------------------
/client/native/decorator.lua:
--------------------------------------------------------------------------------
1 | -- @todo
2 | -- @module native
3 | -- @submodule decorator
4 | -- @see DECOR_SET_TIME
5 | -- @usage BOOL DECOR_SET_TIME(Entity entity, char* propertyName, int timestamp);
6 | -- @param entity Entity
7 | -- @param propertyName char*
8 | -- @param timestamp int
9 | -- @return BOOL
10 | function DecorSetTime(entity, propertyName, timestamp) end
11 |
12 | -- This function sets metadata of type bool to specified entity.
13 | -- @module native
14 | -- @submodule decorator
15 | -- @see DECOR_SET_BOOL
16 | -- @usage BOOL DECOR_SET_BOOL(Entity entity, char* propertyName, BOOL value);
17 | -- @param entity Entity
18 | -- @param propertyName char*
19 | -- @param value BOOL
20 | -- @return BOOL
21 | function DecorSetBool(entity, propertyName, value) end
22 |
23 | -- Sets property to int.
24 | -- @module native
25 | -- @submodule decorator
26 | -- @see DECOR_SET_INT
27 | -- @usage BOOL DECOR_SET_INT(Entity entity, char* propertyName, int value);
28 | -- @param entity Entity
29 | -- @param propertyName char*
30 | -- @param value int
31 | -- @return BOOL
32 | function DecorSetInt(entity, propertyName, value) end
33 |
34 | -- @todo
35 | -- @module native
36 | -- @submodule decorator
37 | -- @see DECOR_GET_BOOL
38 | -- @usage BOOL DECOR_GET_BOOL(Entity entity, char* propertyName);
39 | -- @param entity Entity
40 | -- @param propertyName char*
41 | -- @return BOOL
42 | function DecorGetBool(entity, propertyName) end
43 |
44 | -- @todo
45 | -- @module native
46 | -- @submodule decorator
47 | -- @see DECOR_GET_INT
48 | -- @usage int DECOR_GET_INT(Entity entity, char* propertyName);
49 | -- @param entity Entity
50 | -- @param propertyName char*
51 | -- @return int
52 | function DecorGetInt(entity, propertyName) end
53 |
54 | -- Returns whether or not the specified property is set for the entity.
55 | -- @module native
56 | -- @submodule decorator
57 | -- @see DECOR_EXIST_ON
58 | -- @usage BOOL DECOR_EXIST_ON(Entity entity, char* propertyName);
59 | -- @param entity Entity
60 | -- @param propertyName char*
61 | -- @return BOOL
62 | function DecorExistOn(entity, propertyName) end
63 |
64 | -- @todo
65 | -- @module native
66 | -- @submodule decorator
67 | -- @see DECOR_REMOVE
68 | -- @usage BOOL DECOR_REMOVE(Entity entity, char* propertyName);
69 | -- @param entity Entity
70 | -- @param propertyName char*
71 | -- @return BOOL
72 | function DecorRemove(entity, propertyName) end
73 |
74 | -- Found this in standard_global_init.c4 line 1898 void sub_523a() { DECORATOR::DECOR_REGISTER("Player_Vehicle", 3); DECORATOR::DECOR_REGISTER("PV_Slot", 3); DECORATOR::DECOR_REGISTER("Previous_Owner", 3); DECORATOR::DECOR_REGISTER("Sprayed_Vehicle_Decorator", 2); DECORATOR::DECOR_REGISTER("Sprayed_Vehicle_Timer_Dec", 5); DECORATOR::DECOR_REGISTER("Vehicle_Reward", 3); DECORATOR::DECOR_REGISTER("Vehicle_Reward_Teams", 3); DECORATOR::DECOR_REGISTER("Skill_Blocker", 2); DECORATOR::DECOR_REGISTER("TargetPlayerForTeam", 3); DECORATOR::DECOR_REGISTER("XP_Blocker", 2); DECORATOR::DECOR_REGISTER("CrowdControlSetUp", 3); DECORATOR::DECOR_REGISTER("Bought_Drugs", 2); DECORATOR::DECOR_REGISTER("HeroinInPossession", 1); DECORATOR::DECOR_REGISTER("CokeInPossession", 1); DECORATOR::DECOR_REGISTER("WeedInPossession", 1); DECORATOR::DECOR_REGISTER("MethInPossession", 1); DECORATOR::DECOR_REGISTER("bombdec", 3); DECORATOR::DECOR_REGISTER("bombdec1", 3); DECORATOR::DECOR_REGISTER("bombowner", 3); DECORATOR::DECOR_REGISTER("noPlateScan", 2); DECORATOR::DECOR_REGISTER("prisonBreakBoss", 2); DECORATOR::DECOR_REGISTER("cashondeadbody", 3); DECORATOR::DECOR_REGISTER("MissionType", 3); DECORATOR::DECOR_REGISTER("MatchId", 3); DECORATOR::DECOR_REGISTER("TeamId", 3); DECORATOR::DECOR_REGISTER("Not_Allow_As_Saved_Veh", 3); DECORATOR::DECOR_REGISTER("Veh_Modded_By_Player", 3); DECORATOR::DECOR_REGISTER("MPBitset", 3); DECORATOR::DECOR_REGISTER("MC_EntityID", 3); DECORATOR::DECOR_REGISTER("MC_ChasePedID", 3); DECORATOR::DECOR_REGISTER("MC_Team0_VehDeliveredRules", 3); DECORATOR::DECOR_REGISTER("MC_Team1_VehDeliveredRules", 3); DECORATOR::DECOR_REGISTER("MC_Team2_VehDeliveredRules", 3); DECORATOR::DECOR_REGISTER("MC_Team3_VehDeliveredRules", 3); DECORATOR::DECOR_REGISTER("AttributeDamage", 3); DECORATOR::DECOR_REGISTER("GangBackup", 3); DECORATOR::DECOR_REGISTER("CreatedByPegasus", 2); DECORATOR::DECOR_REGISTER("BeforeCorona_0", 2); } ----------------------------------------------------------------------- Defines type of property for property name. 1 - float, 2 - bool, 3 5
75 | -- @module native
76 | -- @submodule decorator
77 | -- @see DECOR_REGISTER
78 | -- @usage void DECOR_REGISTER(char* propertyName, int type);
79 | -- @param propertyName char*
80 | -- @param type int
81 | -- @return void
82 | function DecorRegister(propertyName, type) end
83 |
84 | -- Is property of that type. 1 2 3 5
85 | -- @module native
86 | -- @submodule decorator
87 | -- @see DECOR_IS_REGISTERED_AS_TYPE
88 | -- @usage BOOL DECOR_IS_REGISTERED_AS_TYPE(char* propertyName, int type);
89 | -- @param propertyName char*
90 | -- @param type int
91 | -- @return BOOL
92 | function DecorIsRegisteredAsType(propertyName, type) end
93 |
94 | -- Called after all decorator type initializations.
95 | -- @module native
96 | -- @submodule decorator
97 | -- @see DECOR_REGISTER_LOCK
98 | -- @usage void DECOR_REGISTER_LOCK();
99 | -- @return void
100 | function DecorRegisterLock() end
--------------------------------------------------------------------------------
/client/native/dlc1.lua:
--------------------------------------------------------------------------------
1 | -- @todo
2 | -- @module native
3 | -- @submodule dlc1
4 | -- @see INIT_SHOP_PED_COMPONENT
5 | -- @usage void INIT_SHOP_PED_COMPONENT(int* outComponent);
6 | -- @param outComponent int*
7 | -- @return void
8 | function InitShopPedComponent(outComponent) end
9 |
10 | -- @todo
11 | -- @module native
12 | -- @submodule dlc1
13 | -- @see INIT_SHOP_PED_PROP
14 | -- @usage void INIT_SHOP_PED_PROP(int* outProp);
15 | -- @param outProp int*
16 | -- @return void
17 | function InitShopPedProp(outProp) end
18 |
19 | -- @todo
20 | -- @module native
21 | -- @submodule dlc1
22 | -- @see GET_SHOP_PED_QUERY_COMPONENT
23 | -- @usage void GET_SHOP_PED_QUERY_COMPONENT(int componentId, int* outComponent);
24 | -- @param componentId int
25 | -- @param outComponent int*
26 | -- @return void
27 | function GetShopPedQueryComponent(componentId, outComponent) end
28 |
29 | -- @todo
30 | -- @module native
31 | -- @submodule dlc1
32 | -- @see GET_SHOP_PED_COMPONENT
33 | -- @usage void GET_SHOP_PED_COMPONENT(Hash p0, Any* p1);
34 | -- @param p0 Hash
35 | -- @param p1 Any*
36 | -- @return void
37 | function GetShopPedComponent(p0, p1) end
38 |
39 | -- @todo
40 | -- @module native
41 | -- @submodule dlc1
42 | -- @see GET_SHOP_PED_QUERY_PROP
43 | -- @usage void GET_SHOP_PED_QUERY_PROP(Any p0, Any* p1);
44 | -- @param p0 Any
45 | -- @param p1 Any*
46 | -- @return void
47 | function GetShopPedQueryProp(p0, p1) end
48 |
49 | -- @todo
50 | -- @module native
51 | -- @submodule dlc1
52 | -- @see GET_HASH_NAME_FOR_COMPONENT
53 | -- @usage Hash GET_HASH_NAME_FOR_COMPONENT(Entity entity, int componentId, int drawableVariant, int textureVariant);
54 | -- @param entity Entity
55 | -- @param componentId int
56 | -- @param drawableVariant int
57 | -- @param textureVariant int
58 | -- @return Hash
59 | function GetHashNameForComponent(entity, componentId, drawableVariant, textureVariant) end
60 |
61 | -- @todo
62 | -- @module native
63 | -- @submodule dlc1
64 | -- @see GET_HASH_NAME_FOR_PROP
65 | -- @usage Hash GET_HASH_NAME_FOR_PROP(Entity entity, int componentId, int propIndex, int propTextureIndex);
66 | -- @param entity Entity
67 | -- @param componentId int
68 | -- @param propIndex int
69 | -- @param propTextureIndex int
70 | -- @return Hash
71 | function GetHashNameForProp(entity, componentId, propIndex, propTextureIndex) end
72 |
73 | -- @todo
74 | -- @module native
75 | -- @submodule dlc1
76 | -- @see GET_VARIANT_COMPONENT
77 | -- @usage void GET_VARIANT_COMPONENT(Hash componentHash, int componentId, Any* p2, Any* p3, Any* p4);
78 | -- @param componentHash Hash
79 | -- @param componentId int
80 | -- @param p2 Any*
81 | -- @param p3 Any*
82 | -- @param p4 Any*
83 | -- @return void
84 | function GetVariantComponent(componentHash, componentId, p2, p3, p4) end
85 |
86 | -- @todo
87 | -- @module native
88 | -- @submodule dlc1
89 | -- @see GET_FORCED_COMPONENT
90 | -- @usage void GET_FORCED_COMPONENT(Hash componentHash, int componentId, Any* p2, Any* p3, Any* p4);
91 | -- @param componentHash Hash
92 | -- @param componentId int
93 | -- @param p2 Any*
94 | -- @param p3 Any*
95 | -- @param p4 Any*
96 | -- @return void
97 | function GetForcedComponent(componentHash, componentId, p2, p3, p4) end
98 |
99 | -- struct Outfit_s { int mask, torso, pants, parachute, shoes, misc1, tops1, armour, crew, tops2, hat, glasses, earpiece; int maskTexture, torsoTexture, pantsTexture, parachuteTexture, shoesTexture, misc1Texture, tops1Texture, armourTexture, crewTexture, tops2Texture, hatTexture, glassesTexture, earpieceTexture; };
100 | -- @module native
101 | -- @submodule dlc1
102 | -- @see GET_SHOP_PED_QUERY_OUTFIT
103 | -- @usage void GET_SHOP_PED_QUERY_OUTFIT(Any p0, Any* outfit);
104 | -- @param p0 Any
105 | -- @param outfit Any*
106 | -- @return void
107 | function GetShopPedQueryOutfit(p0, outfit) end
108 |
109 | -- @todo
110 | -- @module native
111 | -- @submodule dlc1
112 | -- @see GET_SHOP_PED_OUTFIT
113 | -- @usage void GET_SHOP_PED_OUTFIT(Any p0, Any* p1);
114 | -- @param p0 Any
115 | -- @param p1 Any*
116 | -- @return void
117 | function GetShopPedOutfit(p0, p1) end
118 |
119 | -- @todo
120 | -- @module native
121 | -- @submodule dlc1
122 | -- @see GET_SHOP_PED_OUTFIT_LOCATE
123 | -- @usage Any GET_SHOP_PED_OUTFIT_LOCATE(Any p0);
124 | -- @param p0 Any
125 | -- @return Any
126 | function GetShopPedOutfitLocate(p0) end
127 |
128 | -- @todo
129 | -- @module native
130 | -- @submodule dlc1
131 | -- @see GET_NUM_DLC_VEHICLES
132 | -- @usage int GET_NUM_DLC_VEHICLES();
133 | -- @return int
134 | function GetNumDlcVehicles() end
135 |
136 | -- dlcVehicleIndex is 0 to GET_NUM_DLC_VEHICLS()
137 | -- @module native
138 | -- @submodule dlc1
139 | -- @see GET_DLC_VEHICLE_MODEL
140 | -- @usage Hash GET_DLC_VEHICLE_MODEL(int dlcVehicleIndex);
141 | -- @param dlcVehicleIndex int
142 | -- @return Hash
143 | function GetDlcVehicleModel(dlcVehicleIndex) end
144 |
145 | -- dlcVehicleIndex takes a number from 0 - GET_NUM_DLC_VEHICLES() - 1. outData is a struct of 3 8-byte items. The Second item in the struct *(Hash *)(outData + 1) is the vehicle hash.
146 | -- @module native
147 | -- @submodule dlc1
148 | -- @see GET_DLC_VEHICLE_DATA
149 | -- @usage BOOL GET_DLC_VEHICLE_DATA(int dlcVehicleIndex, int* outData);
150 | -- @param dlcVehicleIndex int
151 | -- @param outData int*
152 | -- @return BOOL
153 | function GetDlcVehicleData(dlcVehicleIndex, outData) end
154 |
155 | -- @todo
156 | -- @module native
157 | -- @submodule dlc1
158 | -- @see GET_DLC_VEHICLE_FLAGS
159 | -- @usage int GET_DLC_VEHICLE_FLAGS(int dlcVehicleIndex);
160 | -- @param dlcVehicleIndex int
161 | -- @return int
162 | function GetDlcVehicleFlags(dlcVehicleIndex) end
163 |
164 | -- Gets the total number of DLC weapons.
165 | -- @module native
166 | -- @submodule dlc1
167 | -- @see GET_NUM_DLC_WEAPONS
168 | -- @usage int GET_NUM_DLC_WEAPONS();
169 | -- @return int
170 | function GetNumDlcWeapons() end
171 |
172 | -- dlcWeaponIndex takes a number from 0 - GET_NUM_DLC_WEAPONS() - 1. struct DlcWeaponData { int emptyCheck; //use DLC1::_IS_DLC_DATA_EMPTY on this int padding1; int weaponHash; int padding2; int unk; int padding3; int weaponCost; int padding4; int ammoCost; int padding5; int ammoType; int padding6; int defaultClipSize; int padding7; char nameLabel[64]; char descLabel[64]; char desc2Label[64]; // usually "the" + name char upperCaseNameLabel[64]; };
173 | -- @module native
174 | -- @submodule dlc1
175 | -- @see GET_DLC_WEAPON_DATA
176 | -- @usage BOOL GET_DLC_WEAPON_DATA(int dlcWeaponIndex, int* outData);
177 | -- @param dlcWeaponIndex int
178 | -- @param outData int*
179 | -- @return BOOL
180 | function GetDlcWeaponData(dlcWeaponIndex, outData) end
181 |
182 | -- Allowed Values from 0 - DLC1::GET_NUM_DLC_WEAPONS()
183 | -- @module native
184 | -- @submodule dlc1
185 | -- @see GET_NUM_DLC_WEAPON_COMPONENTS
186 | -- @usage int GET_NUM_DLC_WEAPON_COMPONENTS(int dlcWeaponIndex);
187 | -- @param dlcWeaponIndex int
188 | -- @return int
189 | function GetNumDlcWeaponComponents(dlcWeaponIndex) end
190 |
191 | -- p0 seems to be the weapon index p1 seems to be the weapon component index struct DlcComponentData{ int attachBone; int padding1; int bActiveByDefault; int padding2; int unk; int padding3; int componentHash; int padding4; int unk2; int padding5; int componentCost; int padding6; char nameLabel[64]; char descLabel[64]; };
192 | -- @module native
193 | -- @submodule dlc1
194 | -- @see GET_DLC_WEAPON_COMPONENT_DATA
195 | -- @usage BOOL GET_DLC_WEAPON_COMPONENT_DATA(int dlcWeaponIndex, int dlcWeapCompIndex, int* ComponentDataPtr);
196 | -- @param dlcWeaponIndex int
197 | -- @param dlcWeapCompIndex int
198 | -- @param ComponentDataPtr int*
199 | -- @return BOOL
200 | function GetDlcWeaponComponentData(dlcWeaponIndex, dlcWeapCompIndex, ComponentDataPtr) end
201 |
202 | -- Use _GET_VEHICLE_MOD_DATA for modData
203 | -- @module native
204 | -- @submodule dlc1
205 | -- @see IS_DLC_VEHICLE_MOD
206 | -- @usage BOOL IS_DLC_VEHICLE_MOD(int modData);
207 | -- @param modData int
208 | -- @return BOOL
209 | function IsDlcVehicleMod(modData) end
--------------------------------------------------------------------------------
/client/native/dlc2.lua:
--------------------------------------------------------------------------------
1 | -- Example: DLC2::IS_DLC_PRESENT($\mpbusiness2\); ($ = gethashkey) bruteforce these: 0xB119F6D 0x96F02EE6
2 | -- @module native
3 | -- @submodule dlc2
4 | -- @see IS_DLC_PRESENT
5 | -- @usage BOOL IS_DLC_PRESENT(Hash dlcHash);
6 | -- @param dlcHash Hash
7 | -- @return BOOL
8 | function IsDlcPresent(dlcHash) end
9 |
10 | -- @todo
11 | -- @module native
12 | -- @submodule dlc2
13 | -- @see GET_IS_LOADING_SCREEN_ACTIVE
14 | -- @usage BOOL GET_IS_LOADING_SCREEN_ACTIVE();
15 | -- @return BOOL
16 | function GetIsLoadingScreenActive() end
--------------------------------------------------------------------------------
/client/native/fire.lua:
--------------------------------------------------------------------------------
1 | -- Starts a fire: xyz: Location of fire maxChildren: The max amount of times a fire can spread to other objects. Must be 25 or less, or the function will do nothing. isGasFire: Whether or not the fire is powered by gasoline.
2 | -- @module native
3 | -- @submodule fire
4 | -- @see START_SCRIPT_FIRE
5 | -- @usage int START_SCRIPT_FIRE(float X, float Y, float Z, int maxChildren, BOOL isGasFire);
6 | -- @param X float
7 | -- @param Y float
8 | -- @param Z float
9 | -- @param maxChildren int
10 | -- @param isGasFire BOOL
11 | -- @return int
12 | function StartScriptFire(X, Y, Z, maxChildren, isGasFire) end
13 |
14 | -- @todo
15 | -- @module native
16 | -- @submodule fire
17 | -- @see REMOVE_SCRIPT_FIRE
18 | -- @usage void REMOVE_SCRIPT_FIRE(int fireHandle);
19 | -- @param fireHandle int
20 | -- @return void
21 | function RemoveScriptFire(fireHandle) end
22 |
23 | -- @todo
24 | -- @module native
25 | -- @submodule fire
26 | -- @see START_ENTITY_FIRE
27 | -- @usage Any START_ENTITY_FIRE(Entity entity);
28 | -- @param entity Entity
29 | -- @return Any
30 | function StartEntityFire(entity) end
31 |
32 | -- @todo
33 | -- @module native
34 | -- @submodule fire
35 | -- @see STOP_ENTITY_FIRE
36 | -- @usage void STOP_ENTITY_FIRE(Entity entity);
37 | -- @param entity Entity
38 | -- @return void
39 | function StopEntityFire(entity) end
40 |
41 | -- @todo
42 | -- @module native
43 | -- @submodule fire
44 | -- @see IS_ENTITY_ON_FIRE
45 | -- @usage BOOL IS_ENTITY_ON_FIRE(Entity entity);
46 | -- @param entity Entity
47 | -- @return BOOL
48 | function IsEntityOnFire(entity) end
49 |
50 | -- @todo
51 | -- @module native
52 | -- @submodule fire
53 | -- @see GET_NUMBER_OF_FIRES_IN_RANGE
54 | -- @usage int GET_NUMBER_OF_FIRES_IN_RANGE(float x, float y, float z, float radius);
55 | -- @param x float
56 | -- @param y float
57 | -- @param z float
58 | -- @param radius float
59 | -- @return int
60 | function GetNumberOfFiresInRange(x, y, z, radius) end
61 |
62 | -- @todo
63 | -- @module native
64 | -- @submodule fire
65 | -- @see STOP_FIRE_IN_RANGE
66 | -- @usage void STOP_FIRE_IN_RANGE(float x, float y, float z, float radius);
67 | -- @param x float
68 | -- @param y float
69 | -- @param z float
70 | -- @param radius float
71 | -- @return void
72 | function StopFireInRange(x, y, z, radius) end
73 |
74 | -- Returns TRUE if it found something. FALSE if not.
75 | -- @module native
76 | -- @submodule fire
77 | -- @see GET_CLOSEST_FIRE_POS
78 | -- @usage BOOL GET_CLOSEST_FIRE_POS(Vector3* outPosition, float x, float y, float z);
79 | -- @param outPosition Vector3*
80 | -- @param x float
81 | -- @param y float
82 | -- @param z float
83 | -- @return BOOL
84 | function GetClosestFirePos(outPosition, x, y, z) end
85 |
86 | -- BOOL isAudible = If explosion makes a sound. BOOL isInvisible = If the explosion is invisible or not. this native is missing a new argument: noDamage nodamage = false: damage || nodamage = true: no damage enum ExplosionTypes { EXPLOSION_GRENADE, EXPLOSION_GRENADELAUNCHER, EXPLOSION_STICKYBOMB, EXPLOSION_MOLOTOV, EXPLOSION_ROCKET, EXPLOSION_TANKSHELL, EXPLOSION_HI_OCTANE, EXPLOSION_CAR, EXPLOSION_PLANE, EXPLOSION_PETROL_PUMP, EXPLOSION_BIKE, EXPLOSION_DIR_STEAM, EXPLOSION_DIR_FLAME, EXPLOSION_DIR_WATER_HYDRANT, EXPLOSION_DIR_GAS_CANISTER, EXPLOSION_BOAT, EXPLOSION_SHIP_DESTROY, EXPLOSION_TRUCK, EXPLOSION_BULLET, EXPLOSION_SMOKEGRENADELAUNCHER, EXPLOSION_SMOKEGRENADE, EXPLOSION_BZGAS, EXPLOSION_FLARE, EXPLOSION_GAS_CANISTER, EXPLOSION_EXTINGUISHER, EXPLOSION_PROGRAMMABLEAR, EXPLOSION_TRAIN, EXPLOSION_BARREL, EXPLOSION_PROPANE, EXPLOSION_BLIMP, EXPLOSION_DIR_FLAME_EXPLODE, EXPLOSION_TANKER, EXPLOSION_PLANE_ROCKET, EXPLOSION_VEHICLE_BULLET, EXPLOSION_GAS_TANK, EXPLOSION_BIRD_CRAP };
87 | -- @module native
88 | -- @submodule fire
89 | -- @see ADD_EXPLOSION
90 | -- @usage void ADD_EXPLOSION(float x, float y, float z, int explosionType, float damageScale, BOOL isAudible, BOOL isInvisible, float cameraShake);
91 | -- @param x float
92 | -- @param y float
93 | -- @param z float
94 | -- @param explosionType int
95 | -- @param damageScale float
96 | -- @param isAudible BOOL
97 | -- @param isInvisible BOOL
98 | -- @param cameraShake float
99 | -- @return void
100 | function AddExplosion(x, y, z, explosionType, damageScale, isAudible, isInvisible, cameraShake) end
101 |
102 | -- enum ExplosionTypes { EXPLOSION_GRENADE, EXPLOSION_GRENADELAUNCHER, EXPLOSION_STICKYBOMB, EXPLOSION_MOLOTOV, EXPLOSION_ROCKET, EXPLOSION_TANKSHELL, EXPLOSION_HI_OCTANE, EXPLOSION_CAR, EXPLOSION_PLANE, EXPLOSION_PETROL_PUMP, EXPLOSION_BIKE, EXPLOSION_DIR_STEAM, EXPLOSION_DIR_FLAME, EXPLOSION_DIR_WATER_HYDRANT, EXPLOSION_DIR_GAS_CANISTER, EXPLOSION_BOAT, EXPLOSION_SHIP_DESTROY, EXPLOSION_TRUCK, EXPLOSION_BULLET, EXPLOSION_SMOKEGRENADELAUNCHER, EXPLOSION_SMOKEGRENADE, EXPLOSION_BZGAS, EXPLOSION_FLARE, EXPLOSION_GAS_CANISTER, EXPLOSION_EXTINGUISHER, EXPLOSION_PROGRAMMABLEAR, EXPLOSION_TRAIN, EXPLOSION_BARREL, EXPLOSION_PROPANE, EXPLOSION_BLIMP, EXPLOSION_DIR_FLAME_EXPLODE, EXPLOSION_TANKER, EXPLOSION_PLANE_ROCKET, EXPLOSION_VEHICLE_BULLET, EXPLOSION_GAS_TANK, EXPLOSION_BIRD_CRAP }; BOOL isAudible = If explosion makes a sound. BOOL isInvisible = If the explosion is invisible or not.
103 | -- @module native
104 | -- @submodule fire
105 | -- @see ADD_OWNED_EXPLOSION
106 | -- @usage void ADD_OWNED_EXPLOSION(Ped ped, float x, float y, float z, int explosionType, float damageScale, BOOL isAudible, BOOL isInvisible, float cameraShake);
107 | -- @param ped Ped
108 | -- @param x float
109 | -- @param y float
110 | -- @param z float
111 | -- @param explosionType int
112 | -- @param damageScale float
113 | -- @param isAudible BOOL
114 | -- @param isInvisible BOOL
115 | -- @param cameraShake float
116 | -- @return void
117 | function AddOwnedExplosion(ped, x, y, z, explosionType, damageScale, isAudible, isInvisible, cameraShake) end
118 |
119 | -- @todo
120 | -- @module native
121 | -- @submodule fire
122 | -- @see ADD_EXPLOSION_WITH_USER_VFX
123 | -- @usage void ADD_EXPLOSION_WITH_USER_VFX(float x, float y, float z, int explosionType, Hash explosionFx, float damageScale, BOOL isAudible, BOOL isInvisible, float cameraShake);
124 | -- @param x float
125 | -- @param y float
126 | -- @param z float
127 | -- @param explosionType int
128 | -- @param explosionFx Hash
129 | -- @param damageScale float
130 | -- @param isAudible BOOL
131 | -- @param isInvisible BOOL
132 | -- @param cameraShake float
133 | -- @return void
134 | function AddExplosionWithUserVfx(x, y, z, explosionType, explosionFx, damageScale, isAudible, isInvisible, cameraShake) end
135 |
136 | -- @todo
137 | -- @module native
138 | -- @submodule fire
139 | -- @see IS_EXPLOSION_IN_AREA
140 | -- @usage BOOL IS_EXPLOSION_IN_AREA(int explosionType, float x1, float y1, float z1, float x2, float y2, float z2);
141 | -- @param explosionType int
142 | -- @param x1 float
143 | -- @param y1 float
144 | -- @param z1 float
145 | -- @param x2 float
146 | -- @param y2 float
147 | -- @param z2 float
148 | -- @return BOOL
149 | function IsExplosionInArea(explosionType, x1, y1, z1, x2, y2, z2) end
150 |
151 | -- @todo
152 | -- @module native
153 | -- @submodule fire
154 | -- @see IS_EXPLOSION_IN_SPHERE
155 | -- @usage BOOL IS_EXPLOSION_IN_SPHERE(int explosionType, float x, float y, float z, float radius);
156 | -- @param explosionType int
157 | -- @param x float
158 | -- @param y float
159 | -- @param z float
160 | -- @param radius float
161 | -- @return BOOL
162 | function IsExplosionInSphere(explosionType, x, y, z, radius) end
163 |
164 | -- @todo
165 | -- @module native
166 | -- @submodule fire
167 | -- @see IS_EXPLOSION_IN_ANGLED_AREA
168 | -- @usage BOOL IS_EXPLOSION_IN_ANGLED_AREA(int explosionType, float x1, float y1, float z1, float x2, float y2, float z2, float angle);
169 | -- @param explosionType int
170 | -- @param x1 float
171 | -- @param y1 float
172 | -- @param z1 float
173 | -- @param x2 float
174 | -- @param y2 float
175 | -- @param z2 float
176 | -- @param angle float
177 | -- @return BOOL
178 | function IsExplosionInAngledArea(explosionType, x1, y1, z1, x2, y2, z2, angle) end
--------------------------------------------------------------------------------
/client/native/interior.lua:
--------------------------------------------------------------------------------
1 | -- Returns the group ID of the specified interior. For example, regular interiors have group 0, subway interiors have group 1. There are a few other groups too.
2 | -- @module native
3 | -- @submodule interior
4 | -- @see GET_INTERIOR_GROUP_ID
5 | -- @usage int GET_INTERIOR_GROUP_ID(int interiorID);
6 | -- @param interiorID int
7 | -- @return int
8 | function GetInteriorGroupId(interiorID) end
9 |
10 | -- @todo
11 | -- @module native
12 | -- @submodule interior
13 | -- @see GET_OFFSET_FROM_INTERIOR_IN_WORLD_COORDS
14 | -- @usage Vector3 GET_OFFSET_FROM_INTERIOR_IN_WORLD_COORDS(int interiorID, float x, float y, float z);
15 | -- @param interiorID int
16 | -- @param x float
17 | -- @param y float
18 | -- @param z float
19 | -- @return Vector3
20 | function GetOffsetFromInteriorInWorldCoords(interiorID, x, y, z) end
21 |
22 | -- @todo
23 | -- @module native
24 | -- @submodule interior
25 | -- @see IS_INTERIOR_SCENE
26 | -- @usage BOOL IS_INTERIOR_SCENE();
27 | -- @return BOOL
28 | function IsInteriorScene() end
29 |
30 | -- Return if interior is valid.
31 | -- @module native
32 | -- @submodule interior
33 | -- @see IS_VALID_INTERIOR
34 | -- @usage BOOL IS_VALID_INTERIOR(int interiorID);
35 | -- @param interiorID int
36 | -- @return BOOL
37 | function IsValidInterior(interiorID) end
38 |
39 | -- @todo
40 | -- @module native
41 | -- @submodule interior
42 | -- @see CLEAR_ROOM_FOR_ENTITY
43 | -- @usage void CLEAR_ROOM_FOR_ENTITY(Entity entity);
44 | -- @param entity Entity
45 | -- @return void
46 | function ClearRoomForEntity(entity) end
47 |
48 | -- Does anyone know what this does? I know online modding isn't generally supported especially by the owner of this db, but I first thought this could be used to force ourselves into someones apartment, but I see now that isn't possible.
49 | -- @module native
50 | -- @submodule interior
51 | -- @see FORCE_ROOM_FOR_ENTITY
52 | -- @usage void FORCE_ROOM_FOR_ENTITY(Entity entity, int interiorID, Hash roomHashKey);
53 | -- @param entity Entity
54 | -- @param interiorID int
55 | -- @param roomHashKey Hash
56 | -- @return void
57 | function ForceRoomForEntity(entity, interiorID, roomHashKey) end
58 |
59 | -- Gets the room hash key from the room that the specified entity is in. Each room in every interior has a unique key. Returns 0 if the entity is outside.
60 | -- @module native
61 | -- @submodule interior
62 | -- @see GET_ROOM_KEY_FROM_ENTITY
63 | -- @usage Hash GET_ROOM_KEY_FROM_ENTITY(Entity entity);
64 | -- @param entity Entity
65 | -- @return Hash
66 | function GetRoomKeyFromEntity(entity) end
67 |
68 | -- Seems to do the exact same as INTERIOR::GET_ROOM_KEY_FROM_ENTITY
69 | -- @module native
70 | -- @submodule interior
71 | -- @see GET_KEY_FOR_ENTITY_IN_ROOM
72 | -- @usage Hash GET_KEY_FOR_ENTITY_IN_ROOM(Entity entity);
73 | -- @param entity Entity
74 | -- @return Hash
75 | function GetKeyForEntityInRoom(entity) end
76 |
77 | -- Returns the handle of the interior that the entity is in. Returns 0 if outside.
78 | -- @module native
79 | -- @submodule interior
80 | -- @see GET_INTERIOR_FROM_ENTITY
81 | -- @usage int GET_INTERIOR_FROM_ENTITY(Entity entity);
82 | -- @param entity Entity
83 | -- @return int
84 | function GetInteriorFromEntity(entity) end
85 |
86 | -- Returns interior ID from specified coordinates. If coordinates are outside, then it returns 0. Example for VB.NET Dim interiorID As Integer = Native.Function.Call(Of Integer)(Hash.GET_INTERIOR_AT_COORDS, X, Y, Z)
87 | -- @module native
88 | -- @submodule interior
89 | -- @see GET_INTERIOR_AT_COORDS
90 | -- @usage int GET_INTERIOR_AT_COORDS(float x, float y, float z);
91 | -- @param x float
92 | -- @param y float
93 | -- @param z float
94 | -- @return int
95 | function GetInteriorAtCoords(x, y, z) end
96 |
97 | -- @todo
98 | -- @module native
99 | -- @submodule interior
100 | -- @see ADD_PICKUP_TO_INTERIOR_ROOM_BY_NAME
101 | -- @usage void ADD_PICKUP_TO_INTERIOR_ROOM_BY_NAME(Pickup pickup, char* roomName);
102 | -- @param pickup Pickup
103 | -- @param roomName char*
104 | -- @return void
105 | function AddPickupToInteriorRoomByName(pickup, roomName) end
106 |
107 | -- Does something similar to INTERIOR::DISABLE_INTERIOR. You don't fall through the floor but everything is invisible inside and looks the same as when INTERIOR::DISABLE_INTERIOR is used. Peds behaves normally inside.
108 | -- @module native
109 | -- @submodule interior
110 | -- @see UNPIN_INTERIOR
111 | -- @usage void UNPIN_INTERIOR(int interiorID);
112 | -- @param interiorID int
113 | -- @return void
114 | function UnpinInterior(interiorID) end
115 |
116 | -- @todo
117 | -- @module native
118 | -- @submodule interior
119 | -- @see IS_INTERIOR_READY
120 | -- @usage BOOL IS_INTERIOR_READY(int interiorID);
121 | -- @param interiorID int
122 | -- @return BOOL
123 | function IsInteriorReady(interiorID) end
124 |
125 | -- Returns the interior ID representing the requested interior at that location (if found?). The supplied interior string is not the same as the one used to load the interior. Use: INTERIOR::UNPIN_INTERIOR(INTERIOR::GET_INTERIOR_AT_COORDS_WITH_TYPE(x, y, z, interior)) Interior types include: "V_Michael", "V_Franklins", "V_Franklinshouse", etc.. you can find them in the scripts. Not a very useful native as you could just use GET_INTERIOR_AT_COORDS instead and get the same result, without even having to specify the interior type.
126 | -- @module native
127 | -- @submodule interior
128 | -- @see GET_INTERIOR_AT_COORDS_WITH_TYPE
129 | -- @usage int GET_INTERIOR_AT_COORDS_WITH_TYPE(float x, float y, float z, char* interiorType);
130 | -- @param x float
131 | -- @param y float
132 | -- @param z float
133 | -- @param interiorType char*
134 | -- @return int
135 | function GetInteriorAtCoordsWithType(x, y, z, interiorType) end
136 |
137 | -- @todo
138 | -- @module native
139 | -- @submodule interior
140 | -- @see GET_INTERIOR_FROM_COLLISION
141 | -- @usage int GET_INTERIOR_FROM_COLLISION(float x, float y, float z);
142 | -- @param x float
143 | -- @param y float
144 | -- @param z float
145 | -- @return int
146 | function GetInteriorFromCollision(x, y, z) end
147 |
148 | -- @todo
149 | -- @module native
150 | -- @submodule interior
151 | -- @see REFRESH_INTERIOR
152 | -- @usage void REFRESH_INTERIOR(int interiorID);
153 | -- @param interiorID int
154 | -- @return void
155 | function RefreshInterior(interiorID) end
156 |
157 | -- Example: This removes the interior from the strip club and when trying to walk inside the player just falls: INTERIOR::DISABLE_INTERIOR(118018, true);
158 | -- @module native
159 | -- @submodule interior
160 | -- @see DISABLE_INTERIOR
161 | -- @usage void DISABLE_INTERIOR(int interiorID, BOOL toggle);
162 | -- @param interiorID int
163 | -- @param toggle BOOL
164 | -- @return void
165 | function DisableInterior(interiorID, toggle) end
166 |
167 | -- @todo
168 | -- @module native
169 | -- @submodule interior
170 | -- @see IS_INTERIOR_DISABLED
171 | -- @usage BOOL IS_INTERIOR_DISABLED(int interiorID);
172 | -- @param interiorID int
173 | -- @return BOOL
174 | function IsInteriorDisabled(interiorID) end
175 |
176 | -- Does something similar to INTERIOR::DISABLE_INTERIOR
177 | -- @module native
178 | -- @submodule interior
179 | -- @see CAP_INTERIOR
180 | -- @usage void CAP_INTERIOR(int interiorID, BOOL toggle);
181 | -- @param interiorID int
182 | -- @param toggle BOOL
183 | -- @return void
184 | function CapInterior(interiorID, toggle) end
185 |
186 | -- @todo
187 | -- @module native
188 | -- @submodule interior
189 | -- @see IS_INTERIOR_CAPPED
190 | -- @usage BOOL IS_INTERIOR_CAPPED(int interiorID);
191 | -- @param interiorID int
192 | -- @return BOOL
193 | function IsInteriorCapped(interiorID) end
--------------------------------------------------------------------------------
/client/native/itemset.lua:
--------------------------------------------------------------------------------
1 | -- @todo
2 | -- @module native
3 | -- @submodule itemset
4 | -- @see CREATE_ITEMSET
5 | -- @usage Any CREATE_ITEMSET(Vector3* distri);
6 | -- @param distri Vector3*
7 | -- @return Any
8 | function CreateItemset(distri) end
9 |
10 | -- @todo
11 | -- @module native
12 | -- @submodule itemset
13 | -- @see DESTROY_ITEMSET
14 | -- @usage void DESTROY_ITEMSET(Any p0);
15 | -- @param p0 Any
16 | -- @return void
17 | function DestroyItemset(p0) end
18 |
19 | -- @todo
20 | -- @module native
21 | -- @submodule itemset
22 | -- @see IS_ITEMSET_VALID
23 | -- @usage BOOL IS_ITEMSET_VALID(Any p0);
24 | -- @param p0 Any
25 | -- @return BOOL
26 | function IsItemsetValid(p0) end
27 |
28 | -- @todo
29 | -- @module native
30 | -- @submodule itemset
31 | -- @see ADD_TO_ITEMSET
32 | -- @usage BOOL ADD_TO_ITEMSET(Any p0, Any p1);
33 | -- @param p0 Any
34 | -- @param p1 Any
35 | -- @return BOOL
36 | function AddToItemset(p0, p1) end
37 |
38 | -- @todo
39 | -- @module native
40 | -- @submodule itemset
41 | -- @see REMOVE_FROM_ITEMSET
42 | -- @usage void REMOVE_FROM_ITEMSET(Any p0, Any p1);
43 | -- @param p0 Any
44 | -- @param p1 Any
45 | -- @return void
46 | function RemoveFromItemset(p0, p1) end
47 |
48 | -- @todo
49 | -- @module native
50 | -- @submodule itemset
51 | -- @see GET_ITEMSET_SIZE
52 | -- @usage Any GET_ITEMSET_SIZE(Any p0);
53 | -- @param p0 Any
54 | -- @return Any
55 | function GetItemsetSize(p0) end
56 |
57 | -- @todo
58 | -- @module native
59 | -- @submodule itemset
60 | -- @see GET_INDEXED_ITEM_IN_ITEMSET
61 | -- @usage Any GET_INDEXED_ITEM_IN_ITEMSET(Any p0, Any p1);
62 | -- @param p0 Any
63 | -- @param p1 Any
64 | -- @return Any
65 | function GetIndexedItemInItemset(p0, p1) end
66 |
67 | -- @todo
68 | -- @module native
69 | -- @submodule itemset
70 | -- @see IS_IN_ITEMSET
71 | -- @usage BOOL IS_IN_ITEMSET(Any p0, Any p1);
72 | -- @param p0 Any
73 | -- @param p1 Any
74 | -- @return BOOL
75 | function IsInItemset(p0, p1) end
76 |
77 | -- @todo
78 | -- @module native
79 | -- @submodule itemset
80 | -- @see CLEAN_ITEMSET
81 | -- @usage void CLEAN_ITEMSET(Any p0);
82 | -- @param p0 Any
83 | -- @return void
84 | function CleanItemset(p0) end
--------------------------------------------------------------------------------
/client/native/mobile.lua:
--------------------------------------------------------------------------------
1 | -- Creates a mobile phone of the specified type. Possible phone types: 0 - Default phone / Michael's phone 1 - Trevor's phone 2 - Franklin's phone 4 - Prologue phone These values represent bit flags, so a value of '3' would toggle Trevor and Franklin's phones together, causing unexpected behavior and most likely crash the game.
2 | -- @module native
3 | -- @submodule mobile
4 | -- @see CREATE_MOBILE_PHONE
5 | -- @usage void CREATE_MOBILE_PHONE(int phoneType);
6 | -- @param phoneType int
7 | -- @return void
8 | function CreateMobilePhone(phoneType) end
9 |
10 | -- Destroys the currently active mobile phone.
11 | -- @module native
12 | -- @submodule mobile
13 | -- @see DESTROY_MOBILE_PHONE
14 | -- @usage void DESTROY_MOBILE_PHONE();
15 | -- @return void
16 | function DestroyMobilePhone() end
17 |
18 | -- The minimum/default is 500.0f. If you plan to make it bigger set it's position as well. Also this seems to need to be called in a loop as when you close the phone the scale is reset. If not in a loop you'd need to call it everytime before you re-open the phone.
19 | -- @module native
20 | -- @submodule mobile
21 | -- @see SET_MOBILE_PHONE_SCALE
22 | -- @usage void SET_MOBILE_PHONE_SCALE(float scale);
23 | -- @param scale float
24 | -- @return void
25 | function SetMobilePhoneScale(scale) end
26 |
27 | -- Last parameter is unknown and always zero.
28 | -- @module native
29 | -- @submodule mobile
30 | -- @see SET_MOBILE_PHONE_ROTATION
31 | -- @usage void SET_MOBILE_PHONE_ROTATION(float rotX, float rotY, float rotZ, Any p3);
32 | -- @param rotX float
33 | -- @param rotY float
34 | -- @param rotZ float
35 | -- @param p3 Any
36 | -- @return void
37 | function SetMobilePhoneRotation(rotX, rotY, rotZ, p3) end
38 |
39 | -- @todo
40 | -- @module native
41 | -- @submodule mobile
42 | -- @see GET_MOBILE_PHONE_ROTATION
43 | -- @usage void GET_MOBILE_PHONE_ROTATION(Vector3* rotation, Any p1);
44 | -- @param rotation Vector3*
45 | -- @param p1 Any
46 | -- @return void
47 | function GetMobilePhoneRotation(rotation, p1) end
48 |
49 | -- @todo
50 | -- @module native
51 | -- @submodule mobile
52 | -- @see SET_MOBILE_PHONE_POSITION
53 | -- @usage void SET_MOBILE_PHONE_POSITION(float posX, float posY, float posZ);
54 | -- @param posX float
55 | -- @param posY float
56 | -- @param posZ float
57 | -- @return void
58 | function SetMobilePhonePosition(posX, posY, posZ) end
59 |
60 | -- @todo
61 | -- @module native
62 | -- @submodule mobile
63 | -- @see GET_MOBILE_PHONE_POSITION
64 | -- @usage void GET_MOBILE_PHONE_POSITION(Vector3* position);
65 | -- @param position Vector3*
66 | -- @return void
67 | function GetMobilePhonePosition(position) end
68 |
69 | -- If bool Toggle = true so the mobile is hide to screen. If bool Toggle = false so the mobile is show to screen.
70 | -- @module native
71 | -- @submodule mobile
72 | -- @see SCRIPT_IS_MOVING_MOBILE_PHONE_OFFSCREEN
73 | -- @usage void SCRIPT_IS_MOVING_MOBILE_PHONE_OFFSCREEN(BOOL toggle);
74 | -- @param toggle BOOL
75 | -- @return void
76 | function ScriptIsMovingMobilePhoneOffscreen(toggle) end
77 |
78 | -- This one is weird and seems to return a TRUE state regardless of whether the phone is visible on screen or tucked away. I can confirm the above. This function is hard-coded to always return 1.
79 | -- @module native
80 | -- @submodule mobile
81 | -- @see CAN_PHONE_BE_SEEN_ON_SCREEN
82 | -- @usage BOOL CAN_PHONE_BE_SEEN_ON_SCREEN();
83 | -- @return BOOL
84 | function CanPhoneBeSeenOnScreen() end
85 |
86 | -- @todo
87 | -- @module native
88 | -- @submodule mobile
89 | -- @see CELL_CAM_ACTIVATE
90 | -- @usage void CELL_CAM_ACTIVATE(BOOL p0, BOOL p1);
91 | -- @param p0 BOOL
92 | -- @param p1 BOOL
93 | -- @return void
94 | function CellCamActivate(p0, p1) end
95 |
96 | -- @todo
97 | -- @module native
98 | -- @submodule mobile
99 | -- @see CELL_CAM_IS_CHAR_VISIBLE_NO_FACE_CHECK
100 | -- @usage BOOL CELL_CAM_IS_CHAR_VISIBLE_NO_FACE_CHECK(Entity entity);
101 | -- @param entity Entity
102 | -- @return BOOL
103 | function CellCamIsCharVisibleNoFaceCheck(entity) end
104 |
105 | -- @todo
106 | -- @module native
107 | -- @submodule mobile
108 | -- @see GET_MOBILE_PHONE_RENDER_ID
109 | -- @usage void GET_MOBILE_PHONE_RENDER_ID(int* renderId);
110 | -- @param renderId int*
111 | -- @return void
112 | function GetMobilePhoneRenderId(renderId) end
--------------------------------------------------------------------------------
/client/native/object.lua:
--------------------------------------------------------------------------------
1 | -- p5 - last parameter does not mean object handle is returned maybe a quick view in disassembly will tell us what is actually does ---------- prop_tt_screenstatic (0xE2E039BC) is handled different. Not sure how yet but it I know it is. thx fr Xenus.oida
2 | -- @module native
3 | -- @submodule object
4 | -- @see CREATE_OBJECT
5 | -- @usage Object CREATE_OBJECT(Object modelHash, float x, float y, float z, BOOL isNetwork, BOOL p5, BOOL dynamic);
6 | -- @param modelHash Object
7 | -- @param x float
8 | -- @param y float
9 | -- @param z float
10 | -- @param isNetwork BOOL
11 | -- @param p5 BOOL
12 | -- @param dynamic BOOL
13 | -- @return Object
14 | function CreateObject(modelHash, x, y, z, isNetwork, p5, dynamic) end
15 |
16 | -- p5 - does not mean object handle is returned maybe a quick view in disassembly will tell us what is actually does
17 | -- @module native
18 | -- @submodule object
19 | -- @see CREATE_OBJECT_NO_OFFSET
20 | -- @usage Object CREATE_OBJECT_NO_OFFSET(Hash modelHash, float x, float y, float z, BOOL isNetwork, BOOL p5, BOOL dynamic);
21 | -- @param modelHash Hash
22 | -- @param x float
23 | -- @param y float
24 | -- @param z float
25 | -- @param isNetwork BOOL
26 | -- @param p5 BOOL
27 | -- @param dynamic BOOL
28 | -- @return Object
29 | function CreateObjectNoOffset(modelHash, x, y, z, isNetwork, p5, dynamic) end
30 |
31 | -- Deletes the specified object, then sets the handle pointed to by the pointer to NULL.
32 | -- @module native
33 | -- @submodule object
34 | -- @see DELETE_OBJECT
35 | -- @usage void DELETE_OBJECT(Object* object);
36 | -- @param object Object*
37 | -- @return void
38 | function DeleteObject(object) end
39 |
40 | -- @todo
41 | -- @module native
42 | -- @submodule object
43 | -- @see PLACE_OBJECT_ON_GROUND_PROPERLY
44 | -- @usage BOOL PLACE_OBJECT_ON_GROUND_PROPERLY(Object object);
45 | -- @param object Object
46 | -- @return BOOL
47 | function PlaceObjectOnGroundProperly(object) end
48 |
49 | -- Returns true if the object has finished moving. If false, moves the object towards the specified X, Y and Z coordinates with the specified X, Y and Z speed. See also: gtag.gtagaming.com/opcode-database/opcode/034E/
50 | -- @module native
51 | -- @submodule object
52 | -- @see SLIDE_OBJECT
53 | -- @usage BOOL SLIDE_OBJECT(Object object, float toX, float toY, float toZ, float speedX, float speedY, float speedZ, BOOL collision);
54 | -- @param object Object
55 | -- @param toX float
56 | -- @param toY float
57 | -- @param toZ float
58 | -- @param speedX float
59 | -- @param speedY float
60 | -- @param speedZ float
61 | -- @param collision BOOL
62 | -- @return BOOL
63 | function SlideObject(object, toX, toY, toZ, speedX, speedY, speedZ, collision) end
64 |
65 | -- @todo
66 | -- @module native
67 | -- @submodule object
68 | -- @see SET_OBJECT_TARGETTABLE
69 | -- @usage Any SET_OBJECT_TARGETTABLE(Object object, BOOL targettable);
70 | -- @param object Object
71 | -- @param targettable BOOL
72 | -- @return Any
73 | function SetObjectTargettable(object, targettable) end
74 |
75 | -- Has 8 params in the latest patches. isMission - if true doesn't return mission objects
76 | -- @module native
77 | -- @submodule object
78 | -- @see GET_CLOSEST_OBJECT_OF_TYPE
79 | -- @usage Object GET_CLOSEST_OBJECT_OF_TYPE(float x, float y, float z, float radius, Hash modelHash, BOOL isMission, BOOL p6, BOOL p7);
80 | -- @param x float
81 | -- @param y float
82 | -- @param z float
83 | -- @param radius float
84 | -- @param modelHash Hash
85 | -- @param isMission BOOL
86 | -- @param p6 BOOL
87 | -- @param p7 BOOL
88 | -- @return Object
89 | function GetClosestObjectOfType(x, y, z, radius, modelHash, isMission, p6, p7) end
90 |
91 | -- @todo
92 | -- @module native
93 | -- @submodule object
94 | -- @see HAS_OBJECT_BEEN_BROKEN
95 | -- @usage BOOL HAS_OBJECT_BEEN_BROKEN(Object object);
96 | -- @param object Object
97 | -- @return BOOL
98 | function HasObjectBeenBroken(object) end
99 |
100 | -- @todo
101 | -- @module native
102 | -- @submodule object
103 | -- @see HAS_CLOSEST_OBJECT_OF_TYPE_BEEN_BROKEN
104 | -- @usage BOOL HAS_CLOSEST_OBJECT_OF_TYPE_BEEN_BROKEN(float p0, float p1, float p2, float p3, Hash modelHash, Any p5);
105 | -- @param p0 float
106 | -- @param p1 float
107 | -- @param p2 float
108 | -- @param p3 float
109 | -- @param modelHash Hash
110 | -- @param p5 Any
111 | -- @return BOOL
112 | function HasClosestObjectOfTypeBeenBroken(p0, p1, p2, p3, modelHash, p5) end
113 |
114 | -- Hardcoded to not work in multiplayer. Used to lock/unlock doors to interior areas of the game. (Possible) Door Types: pastebin.com/9S2m3qA4 Heading is either 1, 0 or -1 in the scripts. Means default closed(0) or opened either into(1) or out(-1) of the interior. Locked means that the heading is locked. p6 is always 0. 225 door types, model names and coords found in stripclub.c4: pastebin.com/gywnbzsH get door info: pastebin.com/i14rbekD
115 | -- @module native
116 | -- @submodule object
117 | -- @see SET_STATE_OF_CLOSEST_DOOR_OF_TYPE
118 | -- @usage void SET_STATE_OF_CLOSEST_DOOR_OF_TYPE(Hash type, float x, float y, float z, BOOL locked, float heading, BOOL p6);
119 | -- @param type Hash
120 | -- @param x float
121 | -- @param y float
122 | -- @param z float
123 | -- @param locked BOOL
124 | -- @param heading float
125 | -- @param p6 BOOL
126 | -- @return void
127 | function SetStateOfClosestDoorOfType(type, x, y, z, locked, heading, p6) end
128 |
129 | -- locked is 0 if no door is found locked is 0 if door is unlocked locked is 1 if door is found and unlocked. ------------- the locked bool is either 0(unlocked)(false) or 1(locked)(true)
130 | -- @module native
131 | -- @submodule object
132 | -- @see GET_STATE_OF_CLOSEST_DOOR_OF_TYPE
133 | -- @usage void GET_STATE_OF_CLOSEST_DOOR_OF_TYPE(Hash type, float x, float y, float z, BOOL* locked, float* heading);
134 | -- @param type Hash
135 | -- @param x float
136 | -- @param y float
137 | -- @param z float
138 | -- @param locked BOOL*
139 | -- @param heading float*
140 | -- @return void
141 | function GetStateOfClosestDoorOfType(type, x, y, z, locked, heading) end
142 |
143 | -- @todo
144 | -- @module native
145 | -- @submodule object
146 | -- @see ADD_DOOR_TO_SYSTEM
147 | -- @usage void ADD_DOOR_TO_SYSTEM(Hash doorHash, Hash modelHash, float x, float y, float z, BOOL p5, BOOL p6, BOOL p7);
148 | -- @param doorHash Hash
149 | -- @param modelHash Hash
150 | -- @param x float
151 | -- @param y float
152 | -- @param z float
153 | -- @param p5 BOOL
154 | -- @param p6 BOOL
155 | -- @param p7 BOOL
156 | -- @return void
157 | function AddDoorToSystem(doorHash, modelHash, x, y, z, p5, p6, p7) end
158 |
159 | -- @todo
160 | -- @module native
161 | -- @submodule object
162 | -- @see REMOVE_DOOR_FROM_SYSTEM
163 | -- @usage void REMOVE_DOOR_FROM_SYSTEM(Hash doorHash);
164 | -- @param doorHash Hash
165 | -- @return void
166 | function RemoveDoorFromSystem(doorHash) end
167 |
168 | -- @todo
169 | -- @module native
170 | -- @submodule object
171 | -- @see IS_DOOR_CLOSED
172 | -- @usage BOOL IS_DOOR_CLOSED(Hash door);
173 | -- @param door Hash
174 | -- @return BOOL
175 | function IsDoorClosed(door) end
176 |
177 | -- @todo
178 | -- @module native
179 | -- @submodule object
180 | -- @see IS_GARAGE_EMPTY
181 | -- @usage BOOL IS_GARAGE_EMPTY(Any garage, BOOL p1, int p2);
182 | -- @param garage Any
183 | -- @param p1 BOOL
184 | -- @param p2 int
185 | -- @return BOOL
186 | function IsGarageEmpty(garage, p1, p2) end
187 |
188 | -- p5 is usually 0.
189 | -- @module native
190 | -- @submodule object
191 | -- @see DOES_OBJECT_OF_TYPE_EXIST_AT_COORDS
192 | -- @usage BOOL DOES_OBJECT_OF_TYPE_EXIST_AT_COORDS(float x, float y, float z, float radius, Hash hash, BOOL p5);
193 | -- @param x float
194 | -- @param y float
195 | -- @param z float
196 | -- @param radius float
197 | -- @param hash Hash
198 | -- @param p5 BOOL
199 | -- @return BOOL
200 | function DoesObjectOfTypeExistAtCoords(x, y, z, radius, hash, p5) end
201 |
202 | -- @todo
203 | -- @module native
204 | -- @submodule object
205 | -- @see IS_POINT_IN_ANGLED_AREA
206 | -- @usage BOOL IS_POINT_IN_ANGLED_AREA(float p0, float p1, float p2, float p3, float p4, float p5, float p6, float p7, float p8, float p9, BOOL p10, BOOL p11);
207 | -- @param p0 float
208 | -- @param p1 float
209 | -- @param p2 float
210 | -- @param p3 float
211 | -- @param p4 float
212 | -- @param p5 float
213 | -- @param p6 float
214 | -- @param p7 float
215 | -- @param p8 float
216 | -- @param p9 float
217 | -- @param p10 BOOL
218 | -- @param p11 BOOL
219 | -- @return BOOL
220 | function IsPointInAngledArea(p0, p1, p2, p3, p4, p5, p6, p7, p8, p9, p10, p11) end
221 |
222 | -- Adjust the physics parameters of a prop, or otherwise known as "object". This is useful for simulated gravity. Other parameters seem to be unknown. p2: seems to be weight and gravity related. Higher value makes the obj fall faster. Very sensitive? p3: seems similar to p2 p4: makes obj fall slower the higher the value p5: similar to p4
223 | -- @module native
224 | -- @submodule object
225 | -- @see SET_OBJECT_PHYSICS_PARAMS
226 | -- @usage void SET_OBJECT_PHYSICS_PARAMS(Object object, float weight, float p2, float p3, float p4, float p5, float gravity, float p7, float p8, float p9, float p10, float buoyancy);
227 | -- @param object Object
228 | -- @param weight float
229 | -- @param p2 float
230 | -- @param p3 float
231 | -- @param p4 float
232 | -- @param p5 float
233 | -- @param gravity float
234 | -- @param p7 float
235 | -- @param p8 float
236 | -- @param p9 float
237 | -- @param p10 float
238 | -- @param buoyancy float
239 | -- @return void
240 | function SetObjectPhysicsParams(object, weight, p2, p3, p4, p5, gravity, p7, p8, p9, p10, buoyancy) end
241 |
242 | -- @todo
243 | -- @module native
244 | -- @submodule object
245 | -- @see GET_OBJECT_FRAGMENT_DAMAGE_HEALTH
246 | -- @usage float GET_OBJECT_FRAGMENT_DAMAGE_HEALTH(Any p0, BOOL p1);
247 | -- @param p0 Any
248 | -- @param p1 BOOL
249 | -- @return float
250 | function GetObjectFragmentDamageHealth(p0, p1) end
251 |
252 | -- @todo
253 | -- @module native
254 | -- @submodule object
255 | -- @see SET_ACTIVATE_OBJECT_PHYSICS_AS_SOON_AS_IT_IS_UNFROZEN
256 | -- @usage void SET_ACTIVATE_OBJECT_PHYSICS_AS_SOON_AS_IT_IS_UNFROZEN(Object object, BOOL toggle);
257 | -- @param object Object
258 | -- @param toggle BOOL
259 | -- @return void
260 | function SetActivateObjectPhysicsAsSoonAsItIsUnfrozen(object, toggle) end
261 |
262 | -- @todo
263 | -- @module native
264 | -- @submodule object
265 | -- @see IS_ANY_OBJECT_NEAR_POINT
266 | -- @usage BOOL IS_ANY_OBJECT_NEAR_POINT(float x, float y, float z, float range, BOOL p4);
267 | -- @param x float
268 | -- @param y float
269 | -- @param z float
270 | -- @param range float
271 | -- @param p4 BOOL
272 | -- @return BOOL
273 | function IsAnyObjectNearPoint(x, y, z, range, p4) end
274 |
275 | -- @todo
276 | -- @module native
277 | -- @submodule object
278 | -- @see IS_OBJECT_NEAR_POINT
279 | -- @usage BOOL IS_OBJECT_NEAR_POINT(Hash objectHash, float x, float y, float z, float range);
280 | -- @param objectHash Hash
281 | -- @param x float
282 | -- @param y float
283 | -- @param z float
284 | -- @param range float
285 | -- @return BOOL
286 | function IsObjectNearPoint(objectHash, x, y, z, range) end
287 |
288 | -- @todo
289 | -- @module native
290 | -- @submodule object
291 | -- @see TRACK_OBJECT_VISIBILITY
292 | -- @usage void TRACK_OBJECT_VISIBILITY(Any p0);
293 | -- @param p0 Any
294 | -- @return void
295 | function TrackObjectVisibility(p0) end
296 |
297 | -- @todo
298 | -- @module native
299 | -- @submodule object
300 | -- @see IS_OBJECT_VISIBLE
301 | -- @usage BOOL IS_OBJECT_VISIBLE(Object object);
302 | -- @param object Object
303 | -- @return BOOL
304 | function IsObjectVisible(object) end
305 |
306 | -- Pickup hashes: pastebin.com/8EuSv2r1
307 | -- @module native
308 | -- @submodule object
309 | -- @see CREATE_PICKUP
310 | -- @usage Pickup CREATE_PICKUP(Hash pickupHash, float posX, float posY, float posZ, int p4, int value, BOOL p6, Hash modelHash);
311 | -- @param pickupHash Hash
312 | -- @param posX float
313 | -- @param posY float
314 | -- @param posZ float
315 | -- @param p4 int
316 | -- @param value int
317 | -- @param p6 BOOL
318 | -- @param modelHash Hash
319 | -- @return Pickup
320 | function CreatePickup(pickupHash, posX, posY, posZ, p4, value, p6, modelHash) end
321 |
322 | -- Pickup hashes: pastebin.com/8EuSv2r1 flags: 8 (1 << 3): place on ground 512 (1 << 9): spin around
323 | -- @module native
324 | -- @submodule object
325 | -- @see CREATE_PICKUP_ROTATE
326 | -- @usage Pickup CREATE_PICKUP_ROTATE(Hash pickupHash, float posX, float posY, float posZ, float rotX, float rotY, float rotZ, int flag, int amount, Any p9, BOOL p10, Hash modelHash);
327 | -- @param pickupHash Hash
328 | -- @param posX float
329 | -- @param posY float
330 | -- @param posZ float
331 | -- @param rotX float
332 | -- @param rotY float
333 | -- @param rotZ float
334 | -- @param flag int
335 | -- @param amount int
336 | -- @param p9 Any
337 | -- @param p10 BOOL
338 | -- @param modelHash Hash
339 | -- @return Pickup
340 | function CreatePickupRotate(pickupHash, posX, posY, posZ, rotX, rotY, rotZ, flag, amount, p9, p10, modelHash) end
341 |
342 | -- Used for doing money drop Pickup hashes: pastebin.com/8EuSv2r1
343 | -- @module native
344 | -- @submodule object
345 | -- @see CREATE_AMBIENT_PICKUP
346 | -- @usage Pickup CREATE_AMBIENT_PICKUP(Hash pickupHash, float posX, float posY, float posZ, int p4, int value, Hash modelHash, BOOL p7, BOOL p8);
347 | -- @param pickupHash Hash
348 | -- @param posX float
349 | -- @param posY float
350 | -- @param posZ float
351 | -- @param p4 int
352 | -- @param value int
353 | -- @param modelHash Hash
354 | -- @param p7 BOOL
355 | -- @param p8 BOOL
356 | -- @return Pickup
357 | function CreateAmbientPickup(pickupHash, posX, posY, posZ, p4, value, modelHash, p7, p8) end
358 |
359 | -- Pickup hashes: pastebin.com/8EuSv2r1
360 | -- @module native
361 | -- @submodule object
362 | -- @see CREATE_PORTABLE_PICKUP
363 | -- @usage Pickup CREATE_PORTABLE_PICKUP(Hash pickupHash, float x, float y, float z, BOOL placeOnGround, Hash modelHash);
364 | -- @param pickupHash Hash
365 | -- @param x float
366 | -- @param y float
367 | -- @param z float
368 | -- @param placeOnGround BOOL
369 | -- @param modelHash Hash
370 | -- @return Pickup
371 | function CreatePortablePickup(pickupHash, x, y, z, placeOnGround, modelHash) end
372 |
373 | -- @todo
374 | -- @module native
375 | -- @submodule object
376 | -- @see ATTACH_PORTABLE_PICKUP_TO_PED
377 | -- @usage void ATTACH_PORTABLE_PICKUP_TO_PED(Ped ped, Any p1);
378 | -- @param ped Ped
379 | -- @param p1 Any
380 | -- @return void
381 | function AttachPortablePickupToPed(ped, p1) end
382 |
383 | -- @todo
384 | -- @module native
385 | -- @submodule object
386 | -- @see DETACH_PORTABLE_PICKUP_FROM_PED
387 | -- @usage void DETACH_PORTABLE_PICKUP_FROM_PED(Ped ped);
388 | -- @param ped Ped
389 | -- @return void
390 | function DetachPortablePickupFromPed(ped) end
391 |
392 | -- @todo
393 | -- @module native
394 | -- @submodule object
395 | -- @see GET_SAFE_PICKUP_COORDS
396 | -- @usage Vector3 GET_SAFE_PICKUP_COORDS(float x, float y, float z, Any p3, Any p4);
397 | -- @param x float
398 | -- @param y float
399 | -- @param z float
400 | -- @param p3 Any
401 | -- @param p4 Any
402 | -- @return Vector3
403 | function GetSafePickupCoords(x, y, z, p3, p4) end
404 |
405 | -- @todo
406 | -- @module native
407 | -- @submodule object
408 | -- @see GET_PICKUP_COORDS
409 | -- @usage Vector3 GET_PICKUP_COORDS(Pickup pickup);
410 | -- @param pickup Pickup
411 | -- @return Vector3
412 | function GetPickupCoords(pickup) end
413 |
414 | -- Pickup hashes: pastebin.com/8EuSv2r1
415 | -- @module native
416 | -- @submodule object
417 | -- @see REMOVE_ALL_PICKUPS_OF_TYPE
418 | -- @usage void REMOVE_ALL_PICKUPS_OF_TYPE(Hash pickupHash);
419 | -- @param pickupHash Hash
420 | -- @return void
421 | function RemoveAllPickupsOfType(pickupHash) end
422 |
423 | -- @todo
424 | -- @module native
425 | -- @submodule object
426 | -- @see HAS_PICKUP_BEEN_COLLECTED
427 | -- @usage BOOL HAS_PICKUP_BEEN_COLLECTED(Pickup pickup);
428 | -- @param pickup Pickup
429 | -- @return BOOL
430 | function HasPickupBeenCollected(pickup) end
431 |
432 | -- @todo
433 | -- @module native
434 | -- @submodule object
435 | -- @see REMOVE_PICKUP
436 | -- @usage void REMOVE_PICKUP(Pickup pickup);
437 | -- @param pickup Pickup
438 | -- @return void
439 | function RemovePickup(pickup) end
440 |
441 | -- Spawns one or more money pickups. x: The X-component of the world position to spawn the money pickups at. y: The Y-component of the world position to spawn the money pickups at. z: The Z-component of the world position to spawn the money pickups at. value: The combined value of the pickups (in dollars). amount: The number of pickups to spawn. model: The model to use, or 0 for default money model. Example: CREATE_MONEY_PICKUPS(x, y, z, 1000, 3, 0x684a97ae); Spawns 3 spray cans that'll collectively give $1000 when picked up. (Three spray cans, each giving $334, $334, $332 = $1000). ============================================== Max is 2000 in MP. So if you put the amount to 20, but the value to $400,000 eg. They will only be able to pickup 20 - $2,000 bags. So, $40,000
442 | -- @module native
443 | -- @submodule object
444 | -- @see CREATE_MONEY_PICKUPS
445 | -- @usage void CREATE_MONEY_PICKUPS(float x, float y, float z, int value, int amount, Hash model);
446 | -- @param x float
447 | -- @param y float
448 | -- @param z float
449 | -- @param value int
450 | -- @param amount int
451 | -- @param model Hash
452 | -- @return void
453 | function CreateMoneyPickups(x, y, z, value, amount, model) end
454 |
455 | -- @todo
456 | -- @module native
457 | -- @submodule object
458 | -- @see DOES_PICKUP_EXIST
459 | -- @usage BOOL DOES_PICKUP_EXIST(Pickup pickup);
460 | -- @param pickup Pickup
461 | -- @return BOOL
462 | function DoesPickupExist(pickup) end
463 |
464 | -- @todo
465 | -- @module native
466 | -- @submodule object
467 | -- @see DOES_PICKUP_OBJECT_EXIST
468 | -- @usage BOOL DOES_PICKUP_OBJECT_EXIST(Object pickupObject);
469 | -- @param pickupObject Object
470 | -- @return BOOL
471 | function DoesPickupObjectExist(pickupObject) end
472 |
473 | -- @todo
474 | -- @module native
475 | -- @submodule object
476 | -- @see GET_PICKUP_OBJECT
477 | -- @usage Object GET_PICKUP_OBJECT(Pickup pickup);
478 | -- @param pickup Pickup
479 | -- @return Object
480 | function GetPickupObject(pickup) end
481 |
482 | -- @todo
483 | -- @module native
484 | -- @submodule object
485 | -- @see SET_PICKUP_REGENERATION_TIME
486 | -- @usage void SET_PICKUP_REGENERATION_TIME(Any p0, Any p1);
487 | -- @param p0 Any
488 | -- @param p1 Any
489 | -- @return void
490 | function SetPickupRegenerationTime(p0, p1) end
491 |
492 | -- @todo
493 | -- @module native
494 | -- @submodule object
495 | -- @see SET_TEAM_PICKUP_OBJECT
496 | -- @usage void SET_TEAM_PICKUP_OBJECT(Object object, Any p1, BOOL p2);
497 | -- @param object Object
498 | -- @param p1 Any
499 | -- @param p2 BOOL
500 | -- @return void
501 | function SetTeamPickupObject(object, p1, p2) end
502 |
503 | -- @todo
504 | -- @module native
505 | -- @submodule object
506 | -- @see SET_FORCE_OBJECT_THIS_FRAME
507 | -- @usage void SET_FORCE_OBJECT_THIS_FRAME(Any p0, Any p1, Any p2, Any p3);
508 | -- @param p0 Any
509 | -- @param p1 Any
510 | -- @param p2 Any
511 | -- @param p3 Any
512 | -- @return void
513 | function SetForceObjectThisFrame(p0, p1, p2, p3) end
--------------------------------------------------------------------------------
/client/native/rope.lua:
--------------------------------------------------------------------------------
1 | -- Creates a rope at the specific position, that extends in the specified direction when not attached to any entities. __ Add_Rope(pos.x,pos.y,pos.z,0.0,0.0,0.0,20.0,4,20.0,1.0,0.0,false,false,false,5.0,false,NULL) When attached, Position does not matter When attached, Angle does not matter Rope Type: 4 and bellow is a thick rope 5 and up are small metal wires 0 crashes the game Max_length - Rope is forced to this length, generally best to keep this the same as your rope length. Rigid - If max length is zero, and this is set to false the rope will become rigid (it will force a specific distance, what ever length is, between the objects). breakable - Whether or not shooting the rope will break it. unkPtr - unknown ptr, always 0 in orig scripts __ Lengths can be calculated like so: float distance = abs(x1 - x2) + abs(y1 - y2) + abs(z1 - z2); // Rope length NOTES: Rope does NOT interact with anything you attach it to, in some cases it make interact with the world AFTER it breaks (seems to occur if you set the type to -1). Rope will sometimes contract and fall to the ground like you'd expect it to, but since it doesn't interact with the world the effect is just jaring.
2 | -- @module native
3 | -- @submodule rope
4 | -- @see ADD_ROPE
5 | -- @usage Object ADD_ROPE(float x, float y, float z, float rotX, float rotY, float rotZ, float length, int ropeType, float maxLength, float minLength, float p10, BOOL p11, BOOL p12, BOOL rigid, float p14, BOOL breakWhenShot, Any* unkPtr);
6 | -- @param x float
7 | -- @param y float
8 | -- @param z float
9 | -- @param rotX float
10 | -- @param rotY float
11 | -- @param rotZ float
12 | -- @param length float
13 | -- @param ropeType int
14 | -- @param maxLength float
15 | -- @param minLength float
16 | -- @param p10 float
17 | -- @param p11 BOOL
18 | -- @param p12 BOOL
19 | -- @param rigid BOOL
20 | -- @param p14 float
21 | -- @param breakWhenShot BOOL
22 | -- @param unkPtr Any*
23 | -- @return Object
24 | function AddRope(x, y, z, rotX, rotY, rotZ, length, ropeType, maxLength, minLength, p10, p11, p12, rigid, p14, breakWhenShot, unkPtr) end
25 |
26 | -- @todo
27 | -- @module native
28 | -- @submodule rope
29 | -- @see DELETE_ROPE
30 | -- @usage void DELETE_ROPE(Object* rope);
31 | -- @param rope Object*
32 | -- @return void
33 | function DeleteRope(rope) end
34 |
35 | -- @todo
36 | -- @module native
37 | -- @submodule rope
38 | -- @see DELETE_CHILD_ROPE
39 | -- @usage Any DELETE_CHILD_ROPE(Object rope);
40 | -- @param rope Object
41 | -- @return Any
42 | function DeleteChildRope(rope) end
43 |
44 | -- Ptr is correct
45 | -- @module native
46 | -- @submodule rope
47 | -- @see DOES_ROPE_EXIST
48 | -- @usage BOOL DOES_ROPE_EXIST(Object* rope);
49 | -- @param rope Object*
50 | -- @return BOOL
51 | function DoesRopeExist(rope) end
52 |
53 | -- @todo
54 | -- @module native
55 | -- @submodule rope
56 | -- @see ROPE_DRAW_SHADOW_ENABLED
57 | -- @usage void ROPE_DRAW_SHADOW_ENABLED(Object* rope, BOOL toggle);
58 | -- @param rope Object*
59 | -- @param toggle BOOL
60 | -- @return void
61 | function RopeDrawShadowEnabled(rope, toggle) end
62 |
63 | -- Rope presets can be found in the gamefiles. One example is "ropeFamily3", it is NOT a hash but rather a string.
64 | -- @module native
65 | -- @submodule rope
66 | -- @see LOAD_ROPE_DATA
67 | -- @usage Any LOAD_ROPE_DATA(Object rope, char* rope_preset);
68 | -- @param rope Object
69 | -- @param rope_preset char*
70 | -- @return Any
71 | function LoadRopeData(rope, rope_preset) end
72 |
73 | -- @todo
74 | -- @module native
75 | -- @submodule rope
76 | -- @see PIN_ROPE_VERTEX
77 | -- @usage void PIN_ROPE_VERTEX(Object rope, int vertex, float x, float y, float z);
78 | -- @param rope Object
79 | -- @param vertex int
80 | -- @param x float
81 | -- @param y float
82 | -- @param z float
83 | -- @return void
84 | function PinRopeVertex(rope, vertex, x, y, z) end
85 |
86 | -- @todo
87 | -- @module native
88 | -- @submodule rope
89 | -- @see UNPIN_ROPE_VERTEX
90 | -- @usage Any UNPIN_ROPE_VERTEX(Object rope, int vertex);
91 | -- @param rope Object
92 | -- @param vertex int
93 | -- @return Any
94 | function UnpinRopeVertex(rope, vertex) end
95 |
96 | -- @todo
97 | -- @module native
98 | -- @submodule rope
99 | -- @see GET_ROPE_VERTEX_COUNT
100 | -- @usage int GET_ROPE_VERTEX_COUNT(Object rope);
101 | -- @param rope Object
102 | -- @return int
103 | function GetRopeVertexCount(rope) end
104 |
105 | -- Attaches entity 1 to entity 2.
106 | -- @module native
107 | -- @submodule rope
108 | -- @see ATTACH_ENTITIES_TO_ROPE
109 | -- @usage void ATTACH_ENTITIES_TO_ROPE(Object rope, Entity ent1, Entity ent2, float ent1_x, float ent1_y, float ent1_z, float ent2_x, float ent2_y, float ent2_z, float length, BOOL p10, BOOL p11, Any* p12, Any* p13);
110 | -- @param rope Object
111 | -- @param ent1 Entity
112 | -- @param ent2 Entity
113 | -- @param ent1_x float
114 | -- @param ent1_y float
115 | -- @param ent1_z float
116 | -- @param ent2_x float
117 | -- @param ent2_y float
118 | -- @param ent2_z float
119 | -- @param length float
120 | -- @param p10 BOOL
121 | -- @param p11 BOOL
122 | -- @param p12 Any*
123 | -- @param p13 Any*
124 | -- @return void
125 | function AttachEntitiesToRope(rope, ent1, ent2, ent1_x, ent1_y, ent1_z, ent2_x, ent2_y, ent2_z, length, p10, p11, p12, p13) end
126 |
127 | -- The position supplied can be anywhere, and the entity should anchor relative to that point from it's origin.
128 | -- @module native
129 | -- @submodule rope
130 | -- @see ATTACH_ROPE_TO_ENTITY
131 | -- @usage void ATTACH_ROPE_TO_ENTITY(Object rope, Entity entity, float x, float y, float z, BOOL p5);
132 | -- @param rope Object
133 | -- @param entity Entity
134 | -- @param x float
135 | -- @param y float
136 | -- @param z float
137 | -- @param p5 BOOL
138 | -- @return void
139 | function AttachRopeToEntity(rope, entity, x, y, z, p5) end
140 |
141 | -- @todo
142 | -- @module native
143 | -- @submodule rope
144 | -- @see DETACH_ROPE_FROM_ENTITY
145 | -- @usage void DETACH_ROPE_FROM_ENTITY(Object rope, Entity entity);
146 | -- @param rope Object
147 | -- @param entity Entity
148 | -- @return void
149 | function DetachRopeFromEntity(rope, entity) end
150 |
151 | -- @todo
152 | -- @module native
153 | -- @submodule rope
154 | -- @see ROPE_SET_UPDATE_PINVERTS
155 | -- @usage void ROPE_SET_UPDATE_PINVERTS(Object rope);
156 | -- @param rope Object
157 | -- @return void
158 | function RopeSetUpdatePinverts(rope) end
159 |
160 | -- @todo
161 | -- @module native
162 | -- @submodule rope
163 | -- @see GET_ROPE_LAST_VERTEX_COORD
164 | -- @usage Any GET_ROPE_LAST_VERTEX_COORD(Object rope);
165 | -- @param rope Object
166 | -- @return Any
167 | function GetRopeLastVertexCoord(rope) end
168 |
169 | -- @todo
170 | -- @module native
171 | -- @submodule rope
172 | -- @see GET_ROPE_VERTEX_COORD
173 | -- @usage Any GET_ROPE_VERTEX_COORD(Object rope, int vertex);
174 | -- @param rope Object
175 | -- @param vertex int
176 | -- @return Any
177 | function GetRopeVertexCoord(rope, vertex) end
178 |
179 | -- @todo
180 | -- @module native
181 | -- @submodule rope
182 | -- @see START_ROPE_WINDING
183 | -- @usage void START_ROPE_WINDING(Object rope);
184 | -- @param rope Object
185 | -- @return void
186 | function StartRopeWinding(rope) end
187 |
188 | -- @todo
189 | -- @module native
190 | -- @submodule rope
191 | -- @see STOP_ROPE_WINDING
192 | -- @usage void STOP_ROPE_WINDING(Object rope);
193 | -- @param rope Object
194 | -- @return void
195 | function StopRopeWinding(rope) end
196 |
197 | -- @todo
198 | -- @module native
199 | -- @submodule rope
200 | -- @see START_ROPE_UNWINDING_FRONT
201 | -- @usage void START_ROPE_UNWINDING_FRONT(Object rope);
202 | -- @param rope Object
203 | -- @return void
204 | function StartRopeUnwindingFront(rope) end
205 |
206 | -- @todo
207 | -- @module native
208 | -- @submodule rope
209 | -- @see STOP_ROPE_UNWINDING_FRONT
210 | -- @usage void STOP_ROPE_UNWINDING_FRONT(Object rope);
211 | -- @param rope Object
212 | -- @return void
213 | function StopRopeUnwindingFront(rope) end
214 |
215 | -- @todo
216 | -- @module native
217 | -- @submodule rope
218 | -- @see ROPE_CONVERT_TO_SIMPLE
219 | -- @usage void ROPE_CONVERT_TO_SIMPLE(Object rope);
220 | -- @param rope Object
221 | -- @return void
222 | function RopeConvertToSimple(rope) end
223 |
224 | -- Loads rope textures for all ropes in the current scene.
225 | -- @module native
226 | -- @submodule rope
227 | -- @see ROPE_LOAD_TEXTURES
228 | -- @usage Any ROPE_LOAD_TEXTURES();
229 | -- @return Any
230 | function RopeLoadTextures() end
231 |
232 | -- @todo
233 | -- @module native
234 | -- @submodule rope
235 | -- @see ROPE_ARE_TEXTURES_LOADED
236 | -- @usage BOOL ROPE_ARE_TEXTURES_LOADED();
237 | -- @return BOOL
238 | function RopeAreTexturesLoaded() end
239 |
240 | -- Unloads rope textures for all ropes in the current scene.
241 | -- @module native
242 | -- @submodule rope
243 | -- @see ROPE_UNLOAD_TEXTURES
244 | -- @usage Any ROPE_UNLOAD_TEXTURES();
245 | -- @return Any
246 | function RopeUnloadTextures() end
247 |
248 | -- Forces a rope to a certain length.
249 | -- @module native
250 | -- @submodule rope
251 | -- @see ROPE_FORCE_LENGTH
252 | -- @usage Any ROPE_FORCE_LENGTH(Object rope, float length);
253 | -- @param rope Object
254 | -- @param length float
255 | -- @return Any
256 | function RopeForceLength(rope, length) end
257 |
258 | -- Reset a rope to a certain length.
259 | -- @module native
260 | -- @submodule rope
261 | -- @see ROPE_RESET_LENGTH
262 | -- @usage Any ROPE_RESET_LENGTH(Object rope, BOOL length);
263 | -- @param rope Object
264 | -- @param length BOOL
265 | -- @return Any
266 | function RopeResetLength(rope, length) end
267 |
268 | -- @todo
269 | -- @module native
270 | -- @submodule rope
271 | -- @see APPLY_IMPULSE_TO_CLOTH
272 | -- @usage void APPLY_IMPULSE_TO_CLOTH(float posX, float posY, float posZ, float vecX, float vecY, float vecZ, float impulse);
273 | -- @param posX float
274 | -- @param posY float
275 | -- @param posZ float
276 | -- @param vecX float
277 | -- @param vecY float
278 | -- @param vecZ float
279 | -- @param impulse float
280 | -- @return void
281 | function ApplyImpulseToCloth(posX, posY, posZ, vecX, vecY, vecZ, impulse) end
282 |
283 | -- @todo
284 | -- @module native
285 | -- @submodule rope
286 | -- @see SET_DAMPING
287 | -- @usage void SET_DAMPING(Object rope, int vertex, float value);
288 | -- @param rope Object
289 | -- @param vertex int
290 | -- @param value float
291 | -- @return void
292 | function SetDamping(rope, vertex, value) end
293 |
294 | -- seems to be frequently used with the NETWORK::NET_TO_x natives, particularly with vehicles. It is often the only ROPE:: native in a script.
295 | -- @module native
296 | -- @submodule rope
297 | -- @see ACTIVATE_PHYSICS
298 | -- @usage void ACTIVATE_PHYSICS(Entity entity);
299 | -- @param entity Entity
300 | -- @return void
301 | function ActivatePhysics(entity) end
302 |
303 | -- @todo
304 | -- @module native
305 | -- @submodule rope
306 | -- @see SET_CGOFFSET
307 | -- @usage void SET_CGOFFSET(Object rope, float x, float y, float z);
308 | -- @param rope Object
309 | -- @param x float
310 | -- @param y float
311 | -- @param z float
312 | -- @return void
313 | function SetCgoffset(rope, x, y, z) end
314 |
315 | -- @todo
316 | -- @module native
317 | -- @submodule rope
318 | -- @see GET_CGOFFSET
319 | -- @usage Vector3 GET_CGOFFSET(Object rope);
320 | -- @param rope Object
321 | -- @return Vector3
322 | function GetCgoffset(rope) end
323 |
324 | -- @todo
325 | -- @module native
326 | -- @submodule rope
327 | -- @see SET_CG_AT_BOUNDCENTER
328 | -- @usage void SET_CG_AT_BOUNDCENTER(Object rope);
329 | -- @param rope Object
330 | -- @return void
331 | function SetCgAtBoundcenter(rope) end
332 |
333 | -- @todo
334 | -- @module native
335 | -- @submodule rope
336 | -- @see BREAK_ENTITY_GLASS
337 | -- @usage void BREAK_ENTITY_GLASS(Any p0, float p1, float p2, float p3, float p4, float p5, float p6, float p7, float p8, Any p9, BOOL p10);
338 | -- @param p0 Any
339 | -- @param p1 float
340 | -- @param p2 float
341 | -- @param p3 float
342 | -- @param p4 float
343 | -- @param p5 float
344 | -- @param p6 float
345 | -- @param p7 float
346 | -- @param p8 float
347 | -- @param p9 Any
348 | -- @param p10 BOOL
349 | -- @return void
350 | function BreakEntityGlass(p0, p1, p2, p3, p4, p5, p6, p7, p8, p9, p10) end
351 |
352 | -- @todo
353 | -- @module native
354 | -- @submodule rope
355 | -- @see SET_DISABLE_BREAKING
356 | -- @usage Any SET_DISABLE_BREAKING(Object rope, BOOL enabled);
357 | -- @param rope Object
358 | -- @param enabled BOOL
359 | -- @return Any
360 | function SetDisableBreaking(rope, enabled) end
361 |
362 | -- sometimes used used with NET_TO_OBJ hash collision last 2 words
363 | -- @module native
364 | -- @submodule rope
365 | -- @see SET_DISABLE_FRAG_DAMAGE
366 | -- @usage void SET_DISABLE_FRAG_DAMAGE(Object object, BOOL toggle);
367 | -- @param object Object
368 | -- @param toggle BOOL
369 | -- @return void
370 | function SetDisableFragDamage(object, toggle) end
--------------------------------------------------------------------------------
/client/native/script.lua:
--------------------------------------------------------------------------------
1 | -- For a full list, see here: pastebin.com/yLNWicUi
2 | -- @module native
3 | -- @submodule script
4 | -- @see REQUEST_SCRIPT
5 | -- @usage void REQUEST_SCRIPT(char* scriptName);
6 | -- @param scriptName char*
7 | -- @return void
8 | function RequestScript(scriptName) end
9 |
10 | -- For a full list, see here: pastebin.com/yLNWicUi
11 | -- @module native
12 | -- @submodule script
13 | -- @see SET_SCRIPT_AS_NO_LONGER_NEEDED
14 | -- @usage void SET_SCRIPT_AS_NO_LONGER_NEEDED(char* scriptName);
15 | -- @param scriptName char*
16 | -- @return void
17 | function SetScriptAsNoLongerNeeded(scriptName) end
18 |
19 | -- Returns if a script has been loaded into the game. Used to see if a script was loaded after requesting. For a full list, see here: pastebin.com/yLNWicUi
20 | -- @module native
21 | -- @submodule script
22 | -- @see HAS_SCRIPT_LOADED
23 | -- @usage BOOL HAS_SCRIPT_LOADED(char* scriptName);
24 | -- @param scriptName char*
25 | -- @return BOOL
26 | function HasScriptLoaded(scriptName) end
27 |
28 | -- For a full list, see here: pastebin.com/yLNWicUi
29 | -- @module native
30 | -- @submodule script
31 | -- @see DOES_SCRIPT_EXIST
32 | -- @usage BOOL DOES_SCRIPT_EXIST(char* scriptName);
33 | -- @param scriptName char*
34 | -- @return BOOL
35 | function DoesScriptExist(scriptName) end
36 |
37 | -- formerly _REQUEST_STREAMED_SCRIPT
38 | -- @module native
39 | -- @submodule script
40 | -- @see REQUEST_SCRIPT_WITH_NAME_HASH
41 | -- @usage void REQUEST_SCRIPT_WITH_NAME_HASH(Hash scriptHash);
42 | -- @param scriptHash Hash
43 | -- @return void
44 | function RequestScriptWithNameHash(scriptHash) end
45 |
46 | -- @todo
47 | -- @module native
48 | -- @submodule script
49 | -- @see SET_SCRIPT_WITH_NAME_HASH_AS_NO_LONGER_NEEDED
50 | -- @usage void SET_SCRIPT_WITH_NAME_HASH_AS_NO_LONGER_NEEDED(Hash scriptHash);
51 | -- @param scriptHash Hash
52 | -- @return void
53 | function SetScriptWithNameHashAsNoLongerNeeded(scriptHash) end
54 |
55 | -- @todo
56 | -- @module native
57 | -- @submodule script
58 | -- @see HAS_SCRIPT_WITH_NAME_HASH_LOADED
59 | -- @usage BOOL HAS_SCRIPT_WITH_NAME_HASH_LOADED(Hash scriptHash);
60 | -- @param scriptHash Hash
61 | -- @return BOOL
62 | function HasScriptWithNameHashLoaded(scriptHash) end
63 |
64 | -- @todo
65 | -- @module native
66 | -- @submodule script
67 | -- @see TERMINATE_THREAD
68 | -- @usage void TERMINATE_THREAD(int threadId);
69 | -- @param threadId int
70 | -- @return void
71 | function TerminateThread(threadId) end
72 |
73 | -- @todo
74 | -- @module native
75 | -- @submodule script
76 | -- @see IS_THREAD_ACTIVE
77 | -- @usage BOOL IS_THREAD_ACTIVE(int threadId);
78 | -- @param threadId int
79 | -- @return BOOL
80 | function IsThreadActive(threadId) end
81 |
82 | -- @todo
83 | -- @module native
84 | -- @submodule script
85 | -- @see GET_ID_OF_THIS_THREAD
86 | -- @usage int GET_ID_OF_THIS_THREAD();
87 | -- @return int
88 | function GetIdOfThisThread() end
89 |
90 | -- @todo
91 | -- @module native
92 | -- @submodule script
93 | -- @see TERMINATE_THIS_THREAD
94 | -- @usage void TERMINATE_THIS_THREAD();
95 | -- @return void
96 | function TerminateThisThread() end
97 |
98 | -- @todo
99 | -- @module native
100 | -- @submodule script
101 | -- @see GET_THIS_SCRIPT_NAME
102 | -- @usage char* GET_THIS_SCRIPT_NAME();
103 | -- @return char*
104 | function GetThisScriptName() end
105 |
106 | -- @todo
107 | -- @module native
108 | -- @submodule script
109 | -- @see GET_HASH_OF_THIS_SCRIPT_NAME
110 | -- @usage Hash GET_HASH_OF_THIS_SCRIPT_NAME();
111 | -- @return Hash
112 | function GetHashOfThisScriptName() end
113 |
114 | -- @todo
115 | -- @module native
116 | -- @submodule script
117 | -- @see GET_NUMBER_OF_EVENTS
118 | -- @usage int GET_NUMBER_OF_EVENTS(BOOL p0);
119 | -- @param p0 BOOL
120 | -- @return int
121 | function GetNumberOfEvents(p0) end
122 |
123 | -- @todo
124 | -- @module native
125 | -- @submodule script
126 | -- @see GET_EVENT_EXISTS
127 | -- @usage BOOL GET_EVENT_EXISTS(BOOL p0, int p1);
128 | -- @param p0 BOOL
129 | -- @param p1 int
130 | -- @return BOOL
131 | function GetEventExists(p0, p1) end
132 |
133 | -- @todo
134 | -- @module native
135 | -- @submodule script
136 | -- @see GET_EVENT_AT_INDEX
137 | -- @usage int GET_EVENT_AT_INDEX(BOOL p0, int eventNum);
138 | -- @param p0 BOOL
139 | -- @param eventNum int
140 | -- @return int
141 | function GetEventAtIndex(p0, eventNum) end
142 |
143 | -- @todo
144 | -- @module native
145 | -- @submodule script
146 | -- @see GET_EVENT_DATA
147 | -- @usage BOOL GET_EVENT_DATA(BOOL p0, int eventNum, int* argStruct, int argStructSize);
148 | -- @param p0 BOOL
149 | -- @param eventNum int
150 | -- @param argStruct int*
151 | -- @param argStructSize int
152 | -- @return BOOL
153 | function GetEventData(p0, eventNum, argStruct, argStructSize) end
154 |
155 | -- from scripts: int bitFlag = 0; int vVar0[3]; vVar0[0] = 2; //p0 vVar0[1] = PLAYER_ID(); //p1 0 player vVar0[2] = 53; //p2 SET_BIT(&bitFlag, selectedPlayer); TRIGGER_SCRIPT_EVENT(1, vVar0, 3, bitFlag);
156 | -- @module native
157 | -- @submodule script
158 | -- @see TRIGGER_SCRIPT_EVENT
159 | -- @usage void TRIGGER_SCRIPT_EVENT(BOOL p0, int* args, int argCount, int bitset);
160 | -- @param p0 BOOL
161 | -- @param args int*
162 | -- @param argCount int
163 | -- @param bitset int
164 | -- @return void
165 | function TriggerScriptEvent(p0, args, argCount, bitset) end
166 |
167 | -- @todo
168 | -- @module native
169 | -- @submodule script
170 | -- @see SHUTDOWN_LOADING_SCREEN
171 | -- @usage void SHUTDOWN_LOADING_SCREEN();
172 | -- @return void
173 | function ShutdownLoadingScreen() end
174 |
175 | -- @todo
176 | -- @module native
177 | -- @submodule script
178 | -- @see SET_NO_LOADING_SCREEN
179 | -- @usage void SET_NO_LOADING_SCREEN(BOOL toggle);
180 | -- @param toggle BOOL
181 | -- @return void
182 | function SetNoLoadingScreen(toggle) end
--------------------------------------------------------------------------------
/client/native/socialclub.lua:
--------------------------------------------------------------------------------
1 | -- @todo
2 | -- @module native
3 | -- @submodule socialclub
4 | -- @see SC_INBOX_MESSAGE_GET_DATA_INT
5 | -- @usage BOOL SC_INBOX_MESSAGE_GET_DATA_INT(int p0, char* context, int* out);
6 | -- @param p0 int
7 | -- @param context char*
8 | -- @param out int*
9 | -- @return BOOL
10 | function ScInboxMessageGetDataInt(p0, context, out) end
11 |
12 | -- @todo
13 | -- @module native
14 | -- @submodule socialclub
15 | -- @see SC_INBOX_MESSAGE_GET_DATA_STRING
16 | -- @usage BOOL SC_INBOX_MESSAGE_GET_DATA_STRING(int p0, char* context, char* out);
17 | -- @param p0 int
18 | -- @param context char*
19 | -- @param out char*
20 | -- @return BOOL
21 | function ScInboxMessageGetDataString(p0, context, out) end
22 |
23 | -- @todo
24 | -- @module native
25 | -- @submodule socialclub
26 | -- @see SC_INBOX_MESSAGE_GET_UGCDATA
27 | -- @usage BOOL SC_INBOX_MESSAGE_GET_UGCDATA(Any p0, Any* p1);
28 | -- @param p0 Any
29 | -- @param p1 Any*
30 | -- @return BOOL
31 | function ScInboxMessageGetUgcdata(p0, p1) end
32 |
33 | -- @todo
34 | -- @module native
35 | -- @submodule socialclub
36 | -- @see SC_EMAIL_MESSAGE_PUSH_GAMER_TO_RECIP_LIST
37 | -- @usage void SC_EMAIL_MESSAGE_PUSH_GAMER_TO_RECIP_LIST(Player* player);
38 | -- @param player Player*
39 | -- @return void
40 | function ScEmailMessagePushGamerToRecipList(player) end
41 |
42 | -- @todo
43 | -- @module native
44 | -- @submodule socialclub
45 | -- @see SC_EMAIL_MESSAGE_CLEAR_RECIP_LIST
46 | -- @usage void SC_EMAIL_MESSAGE_CLEAR_RECIP_LIST();
47 | -- @return void
48 | function ScEmailMessageClearRecipList() end
--------------------------------------------------------------------------------
/client/native/stats.lua:
--------------------------------------------------------------------------------
1 | -- Please change to "void"! --------------------------------- Example: for (v_2 = 0; v_2 <= 4; v_2 += 1) { STATS::STAT_CLEAR_SLOT_FOR_RELOAD(v_2); }
2 | -- @module native
3 | -- @submodule stats
4 | -- @see STAT_CLEAR_SLOT_FOR_RELOAD
5 | -- @usage Any STAT_CLEAR_SLOT_FOR_RELOAD(int statSlot);
6 | -- @param statSlot int
7 | -- @return Any
8 | function StatClearSlotForReload(statSlot) end
9 |
10 | -- @todo
11 | -- @module native
12 | -- @submodule stats
13 | -- @see STAT_LOAD
14 | -- @usage BOOL STAT_LOAD(int p0);
15 | -- @param p0 int
16 | -- @return BOOL
17 | function StatLoad(p0) end
18 |
19 | -- @todo
20 | -- @module native
21 | -- @submodule stats
22 | -- @see STAT_SAVE
23 | -- @usage BOOL STAT_SAVE(int p0, BOOL p1, int p2);
24 | -- @param p0 int
25 | -- @param p1 BOOL
26 | -- @param p2 int
27 | -- @return BOOL
28 | function StatSave(p0, p1, p2) end
29 |
30 | -- @todo
31 | -- @module native
32 | -- @submodule stats
33 | -- @see STAT_LOAD_PENDING
34 | -- @usage BOOL STAT_LOAD_PENDING(Any p0);
35 | -- @param p0 Any
36 | -- @return BOOL
37 | function StatLoadPending(p0) end
38 |
39 | -- @todo
40 | -- @module native
41 | -- @submodule stats
42 | -- @see STAT_SAVE_PENDING
43 | -- @usage Any STAT_SAVE_PENDING();
44 | -- @return Any
45 | function StatSavePending() end
46 |
47 | -- @todo
48 | -- @module native
49 | -- @submodule stats
50 | -- @see STAT_SAVE_PENDING_OR_REQUESTED
51 | -- @usage Any STAT_SAVE_PENDING_OR_REQUESTED();
52 | -- @return Any
53 | function StatSavePendingOrRequested() end
54 |
55 | -- @todo
56 | -- @module native
57 | -- @submodule stats
58 | -- @see STAT_DELETE_SLOT
59 | -- @usage Any STAT_DELETE_SLOT(Any p0);
60 | -- @param p0 Any
61 | -- @return Any
62 | function StatDeleteSlot(p0) end
63 |
64 | -- @todo
65 | -- @module native
66 | -- @submodule stats
67 | -- @see STAT_SLOT_IS_LOADED
68 | -- @usage BOOL STAT_SLOT_IS_LOADED(Any p0);
69 | -- @param p0 Any
70 | -- @return BOOL
71 | function StatSlotIsLoaded(p0) end
72 |
73 | -- Add Cash example: for (int i = 0; i < 3; i++) { char statNameFull[32]; sprintf_s(statNameFull, "SP%d_TOTAL_CASH", i); Hash hash = GAMEPLAY::GET_HASH_KEY(statNameFull); int val; STATS::STAT_GET_INT(hash, &val, -1); val += 1000000; STATS::STAT_SET_INT(hash, val, 1); }
74 | -- @module native
75 | -- @submodule stats
76 | -- @see STAT_SET_INT
77 | -- @usage BOOL STAT_SET_INT(Hash statName, int value, BOOL save);
78 | -- @param statName Hash
79 | -- @param value int
80 | -- @param save BOOL
81 | -- @return BOOL
82 | function StatSetInt(statName, value, save) end
83 |
84 | -- @todo
85 | -- @module native
86 | -- @submodule stats
87 | -- @see STAT_SET_FLOAT
88 | -- @usage BOOL STAT_SET_FLOAT(Hash statName, float value, BOOL save);
89 | -- @param statName Hash
90 | -- @param value float
91 | -- @param save BOOL
92 | -- @return BOOL
93 | function StatSetFloat(statName, value, save) end
94 |
95 | -- @todo
96 | -- @module native
97 | -- @submodule stats
98 | -- @see STAT_SET_BOOL
99 | -- @usage BOOL STAT_SET_BOOL(Hash statName, BOOL value, BOOL save);
100 | -- @param statName Hash
101 | -- @param value BOOL
102 | -- @param save BOOL
103 | -- @return BOOL
104 | function StatSetBool(statName, value, save) end
105 |
106 | -- The following values have been found in the decompiled scripts: "RC_ABI1" "RC_ABI2" "RC_BA1" "RC_BA2" "RC_BA3" "RC_BA3A" "RC_BA3C" "RC_BA4" "RC_DRE1" "RC_EPS1" "RC_EPS2" "RC_EPS3" "RC_EPS4" "RC_EPS5" "RC_EPS6" "RC_EPS7" "RC_EPS8" "RC_EXT1" "RC_EXT2" "RC_EXT3" "RC_EXT4" "RC_FAN1" "RC_FAN2" "RC_FAN3" "RC_HAO1" "RC_HUN1" "RC_HUN2" "RC_JOS1" "RC_JOS2" "RC_JOS3" "RC_JOS4" "RC_MAU1" "RC_MIN1" "RC_MIN2" "RC_MIN3" "RC_MRS1" "RC_MRS2" "RC_NI1" "RC_NI1A" "RC_NI1B" "RC_NI1C" "RC_NI1D" "RC_NI2" "RC_NI3" "RC_OME1" "RC_OME2" "RC_PA1" "RC_PA2" "RC_PA3" "RC_PA3A" "RC_PA3B" "RC_PA4" "RC_RAM1" "RC_RAM2" "RC_RAM3" "RC_RAM4" "RC_RAM5" "RC_SAS1" "RC_TON1" "RC_TON2" "RC_TON3" "RC_TON4" "RC_TON5"
107 | -- @module native
108 | -- @submodule stats
109 | -- @see STAT_SET_GXT_LABEL
110 | -- @usage BOOL STAT_SET_GXT_LABEL(Hash statName, char* value, BOOL save);
111 | -- @param statName Hash
112 | -- @param value char*
113 | -- @param save BOOL
114 | -- @return BOOL
115 | function StatSetGxtLabel(statName, value, save) end
116 |
117 | -- 'value' is a structure to a structure, 'numFields' is how many fields there are in said structure (usually 7). The structure looks like this: int year int month int day int hour int minute int second int millisecond The decompiled scripts use TIME::GET_POSIX_TIME to fill this structure.
118 | -- @module native
119 | -- @submodule stats
120 | -- @see STAT_SET_DATE
121 | -- @usage BOOL STAT_SET_DATE(Hash statName, Any* value, int numFields, BOOL save);
122 | -- @param statName Hash
123 | -- @param value Any*
124 | -- @param numFields int
125 | -- @param save BOOL
126 | -- @return BOOL
127 | function StatSetDate(statName, value, numFields, save) end
128 |
129 | -- @todo
130 | -- @module native
131 | -- @submodule stats
132 | -- @see STAT_SET_STRING
133 | -- @usage BOOL STAT_SET_STRING(Hash statName, char* value, BOOL save);
134 | -- @param statName Hash
135 | -- @param value char*
136 | -- @param save BOOL
137 | -- @return BOOL
138 | function StatSetString(statName, value, save) end
139 |
140 | -- @todo
141 | -- @module native
142 | -- @submodule stats
143 | -- @see STAT_SET_POS
144 | -- @usage BOOL STAT_SET_POS(Hash statName, float x, float y, float z, BOOL save);
145 | -- @param statName Hash
146 | -- @param x float
147 | -- @param y float
148 | -- @param z float
149 | -- @param save BOOL
150 | -- @return BOOL
151 | function StatSetPos(statName, x, y, z, save) end
152 |
153 | -- @todo
154 | -- @module native
155 | -- @submodule stats
156 | -- @see STAT_SET_MASKED_INT
157 | -- @usage BOOL STAT_SET_MASKED_INT(Hash statName, Any p1, Any p2, int p3, BOOL save);
158 | -- @param statName Hash
159 | -- @param p1 Any
160 | -- @param p2 Any
161 | -- @param p3 int
162 | -- @param save BOOL
163 | -- @return BOOL
164 | function StatSetMaskedInt(statName, p1, p2, p3, save) end
165 |
166 | -- @todo
167 | -- @module native
168 | -- @submodule stats
169 | -- @see STAT_SET_USER_ID
170 | -- @usage BOOL STAT_SET_USER_ID(Hash statName, char* value, BOOL save);
171 | -- @param statName Hash
172 | -- @param value char*
173 | -- @param save BOOL
174 | -- @return BOOL
175 | function StatSetUserId(statName, value, save) end
176 |
177 | -- p1 always true.
178 | -- @module native
179 | -- @submodule stats
180 | -- @see STAT_SET_CURRENT_POSIX_TIME
181 | -- @usage BOOL STAT_SET_CURRENT_POSIX_TIME(Hash statName, BOOL p1);
182 | -- @param statName Hash
183 | -- @param p1 BOOL
184 | -- @return BOOL
185 | function StatSetCurrentPosixTime(statName, p1) end
186 |
187 | -- p2 appears to always be -1
188 | -- @module native
189 | -- @submodule stats
190 | -- @see STAT_GET_INT
191 | -- @usage BOOL STAT_GET_INT(Hash statHash, int* outValue, int p2);
192 | -- @param statHash Hash
193 | -- @param outValue int*
194 | -- @param p2 int
195 | -- @return BOOL
196 | function StatGetInt(statHash, outValue, p2) end
197 |
198 | -- @todo
199 | -- @module native
200 | -- @submodule stats
201 | -- @see STAT_GET_FLOAT
202 | -- @usage BOOL STAT_GET_FLOAT(Hash statHash, float* outValue, Any p2);
203 | -- @param statHash Hash
204 | -- @param outValue float*
205 | -- @param p2 Any
206 | -- @return BOOL
207 | function StatGetFloat(statHash, outValue, p2) end
208 |
209 | -- @todo
210 | -- @module native
211 | -- @submodule stats
212 | -- @see STAT_GET_BOOL
213 | -- @usage BOOL STAT_GET_BOOL(Hash statHash, BOOL* outValue, Any p2);
214 | -- @param statHash Hash
215 | -- @param outValue BOOL*
216 | -- @param p2 Any
217 | -- @return BOOL
218 | function StatGetBool(statHash, outValue, p2) end
219 |
220 | -- @todo
221 | -- @module native
222 | -- @submodule stats
223 | -- @see STAT_GET_DATE
224 | -- @usage BOOL STAT_GET_DATE(Hash statHash, Any* p1, Any p2, Any p3);
225 | -- @param statHash Hash
226 | -- @param p1 Any*
227 | -- @param p2 Any
228 | -- @param p3 Any
229 | -- @return BOOL
230 | function StatGetDate(statHash, p1, p2, p3) end
231 |
232 | -- p1 is always -1 in the script files
233 | -- @module native
234 | -- @submodule stats
235 | -- @see STAT_GET_STRING
236 | -- @usage char* STAT_GET_STRING(Hash statHash, int p1);
237 | -- @param statHash Hash
238 | -- @param p1 int
239 | -- @return char*
240 | function StatGetString(statHash, p1) end
241 |
242 | -- @todo
243 | -- @module native
244 | -- @submodule stats
245 | -- @see STAT_GET_POS
246 | -- @usage BOOL STAT_GET_POS(Any p0, Any* p1, Any* p2, Any* p3, Any p4);
247 | -- @param p0 Any
248 | -- @param p1 Any*
249 | -- @param p2 Any*
250 | -- @param p3 Any*
251 | -- @param p4 Any
252 | -- @return BOOL
253 | function StatGetPos(p0, p1, p2, p3, p4) end
254 |
255 | -- @todo
256 | -- @module native
257 | -- @submodule stats
258 | -- @see STAT_GET_MASKED_INT
259 | -- @usage BOOL STAT_GET_MASKED_INT(Any p0, Any* p1, Any p2, Any p3, Any p4);
260 | -- @param p0 Any
261 | -- @param p1 Any*
262 | -- @param p2 Any
263 | -- @param p3 Any
264 | -- @param p4 Any
265 | -- @return BOOL
266 | function StatGetMaskedInt(p0, p1, p2, p3, p4) end
267 |
268 | -- Needs more research. Seems to return "STAT_UNKNOWN" if no such user id exists.
269 | -- @module native
270 | -- @submodule stats
271 | -- @see STAT_GET_USER_ID
272 | -- @usage char* STAT_GET_USER_ID(Any p0);
273 | -- @param p0 Any
274 | -- @return char*
275 | function StatGetUserId(p0) end
276 |
277 | -- @todo
278 | -- @module native
279 | -- @submodule stats
280 | -- @see STAT_GET_LICENSE_PLATE
281 | -- @usage char* STAT_GET_LICENSE_PLATE(Hash statName);
282 | -- @param statName Hash
283 | -- @return char*
284 | function StatGetLicensePlate(statName) end
285 |
286 | -- @todo
287 | -- @module native
288 | -- @submodule stats
289 | -- @see STAT_SET_LICENSE_PLATE
290 | -- @usage BOOL STAT_SET_LICENSE_PLATE(Hash statName, char* str);
291 | -- @param statName Hash
292 | -- @param str char*
293 | -- @return BOOL
294 | function StatSetLicensePlate(statName, str) end
295 |
296 | -- @todo
297 | -- @module native
298 | -- @submodule stats
299 | -- @see STAT_INCREMENT
300 | -- @usage void STAT_INCREMENT(Hash statName, float value);
301 | -- @param statName Hash
302 | -- @param value float
303 | -- @return void
304 | function StatIncrement(statName, value) end
305 |
306 | -- @todo
307 | -- @module native
308 | -- @submodule stats
309 | -- @see STAT_GET_NUMBER_OF_DAYS
310 | -- @usage int STAT_GET_NUMBER_OF_DAYS(Hash statName);
311 | -- @param statName Hash
312 | -- @return int
313 | function StatGetNumberOfDays(statName) end
314 |
315 | -- @todo
316 | -- @module native
317 | -- @submodule stats
318 | -- @see STAT_GET_NUMBER_OF_HOURS
319 | -- @usage int STAT_GET_NUMBER_OF_HOURS(Hash statName);
320 | -- @param statName Hash
321 | -- @return int
322 | function StatGetNumberOfHours(statName) end
323 |
324 | -- @todo
325 | -- @module native
326 | -- @submodule stats
327 | -- @see STAT_GET_NUMBER_OF_MINUTES
328 | -- @usage int STAT_GET_NUMBER_OF_MINUTES(Hash statName);
329 | -- @param statName Hash
330 | -- @return int
331 | function StatGetNumberOfMinutes(statName) end
332 |
333 | -- @todo
334 | -- @module native
335 | -- @submodule stats
336 | -- @see STAT_GET_NUMBER_OF_SECONDS
337 | -- @usage int STAT_GET_NUMBER_OF_SECONDS(Hash statName);
338 | -- @param statName Hash
339 | -- @return int
340 | function StatGetNumberOfSeconds(statName) end
341 |
342 | -- p2 - Default value? Seems to be -1 most of the time.
343 | -- @module native
344 | -- @submodule stats
345 | -- @see STAT_GET_BOOL_MASKED
346 | -- @usage BOOL STAT_GET_BOOL_MASKED(Hash statName, int mask, int p2);
347 | -- @param statName Hash
348 | -- @param mask int
349 | -- @param p2 int
350 | -- @return BOOL
351 | function StatGetBoolMasked(statName, mask, p2) end
352 |
353 | -- @todo
354 | -- @module native
355 | -- @submodule stats
356 | -- @see STAT_SET_BOOL_MASKED
357 | -- @usage BOOL STAT_SET_BOOL_MASKED(Hash statName, BOOL value, int mask, BOOL save);
358 | -- @param statName Hash
359 | -- @param value BOOL
360 | -- @param mask int
361 | -- @param save BOOL
362 | -- @return BOOL
363 | function StatSetBoolMasked(statName, value, mask, save) end
364 |
365 | -- @todo
366 | -- @module native
367 | -- @submodule stats
368 | -- @see PLAYSTATS_NPC_INVITE
369 | -- @usage void PLAYSTATS_NPC_INVITE(Any* p0);
370 | -- @param p0 Any*
371 | -- @return void
372 | function PlaystatsNpcInvite(p0) end
373 |
374 | -- @todo
375 | -- @module native
376 | -- @submodule stats
377 | -- @see PLAYSTATS_AWARD_XP
378 | -- @usage void PLAYSTATS_AWARD_XP(Any p0, Any p1, Any p2);
379 | -- @param p0 Any
380 | -- @param p1 Any
381 | -- @param p2 Any
382 | -- @return void
383 | function PlaystatsAwardXp(p0, p1, p2) end
384 |
385 | -- @todo
386 | -- @module native
387 | -- @submodule stats
388 | -- @see PLAYSTATS_RANK_UP
389 | -- @usage void PLAYSTATS_RANK_UP(Any p0);
390 | -- @param p0 Any
391 | -- @return void
392 | function PlaystatsRankUp(p0) end
393 |
394 | -- @todo
395 | -- @module native
396 | -- @submodule stats
397 | -- @see PLAYSTATS_MISSION_STARTED
398 | -- @usage void PLAYSTATS_MISSION_STARTED(Any* p0, Any p1, Any p2, BOOL p3);
399 | -- @param p0 Any*
400 | -- @param p1 Any
401 | -- @param p2 Any
402 | -- @param p3 BOOL
403 | -- @return void
404 | function PlaystatsMissionStarted(p0, p1, p2, p3) end
405 |
406 | -- @todo
407 | -- @module native
408 | -- @submodule stats
409 | -- @see PLAYSTATS_MISSION_OVER
410 | -- @usage void PLAYSTATS_MISSION_OVER(Any* p0, Any p1, Any p2, BOOL p3, BOOL p4, BOOL p5);
411 | -- @param p0 Any*
412 | -- @param p1 Any
413 | -- @param p2 Any
414 | -- @param p3 BOOL
415 | -- @param p4 BOOL
416 | -- @param p5 BOOL
417 | -- @return void
418 | function PlaystatsMissionOver(p0, p1, p2, p3, p4, p5) end
419 |
420 | -- @todo
421 | -- @module native
422 | -- @submodule stats
423 | -- @see PLAYSTATS_MISSION_CHECKPOINT
424 | -- @usage void PLAYSTATS_MISSION_CHECKPOINT(Any* p0, Any p1, Any p2, Any p3);
425 | -- @param p0 Any*
426 | -- @param p1 Any
427 | -- @param p2 Any
428 | -- @param p3 Any
429 | -- @return void
430 | function PlaystatsMissionCheckpoint(p0, p1, p2, p3) end
431 |
432 | -- @todo
433 | -- @module native
434 | -- @submodule stats
435 | -- @see PLAYSTATS_RACE_CHECKPOINT
436 | -- @usage void PLAYSTATS_RACE_CHECKPOINT(Any p0, Any p1, Any p2, Any p3, Any p4);
437 | -- @param p0 Any
438 | -- @param p1 Any
439 | -- @param p2 Any
440 | -- @param p3 Any
441 | -- @param p4 Any
442 | -- @return void
443 | function PlaystatsRaceCheckpoint(p0, p1, p2, p3, p4) end
444 |
445 | -- @todo
446 | -- @module native
447 | -- @submodule stats
448 | -- @see PLAYSTATS_MATCH_STARTED
449 | -- @usage void PLAYSTATS_MATCH_STARTED(Any p0, Any p1, Any p2, Any p3, Any p4, Any p5, Any p6);
450 | -- @param p0 Any
451 | -- @param p1 Any
452 | -- @param p2 Any
453 | -- @param p3 Any
454 | -- @param p4 Any
455 | -- @param p5 Any
456 | -- @param p6 Any
457 | -- @return void
458 | function PlaystatsMatchStarted(p0, p1, p2, p3, p4, p5, p6) end
459 |
460 | -- @todo
461 | -- @module native
462 | -- @submodule stats
463 | -- @see PLAYSTATS_SHOP_ITEM
464 | -- @usage void PLAYSTATS_SHOP_ITEM(Any p0, Any p1, Any p2, Any p3, Any p4);
465 | -- @param p0 Any
466 | -- @param p1 Any
467 | -- @param p2 Any
468 | -- @param p3 Any
469 | -- @param p4 Any
470 | -- @return void
471 | function PlaystatsShopItem(p0, p1, p2, p3, p4) end
472 |
473 | -- @todo
474 | -- @module native
475 | -- @submodule stats
476 | -- @see PLAYSTATS_WEBSITE_VISITED
477 | -- @usage void PLAYSTATS_WEBSITE_VISITED(Hash scaleformHash, int p1);
478 | -- @param scaleformHash Hash
479 | -- @param p1 int
480 | -- @return void
481 | function PlaystatsWebsiteVisited(scaleformHash, p1) end
482 |
483 | -- @todo
484 | -- @module native
485 | -- @submodule stats
486 | -- @see PLAYSTATS_FRIEND_ACTIVITY
487 | -- @usage void PLAYSTATS_FRIEND_ACTIVITY(Any p0, Any p1);
488 | -- @param p0 Any
489 | -- @param p1 Any
490 | -- @return void
491 | function PlaystatsFriendActivity(p0, p1) end
492 |
493 | -- @todo
494 | -- @module native
495 | -- @submodule stats
496 | -- @see PLAYSTATS_ODDJOB_DONE
497 | -- @usage void PLAYSTATS_ODDJOB_DONE(Any p0, Any p1, Any p2);
498 | -- @param p0 Any
499 | -- @param p1 Any
500 | -- @param p2 Any
501 | -- @return void
502 | function PlaystatsOddjobDone(p0, p1, p2) end
503 |
504 | -- @todo
505 | -- @module native
506 | -- @submodule stats
507 | -- @see PLAYSTATS_PROP_CHANGE
508 | -- @usage void PLAYSTATS_PROP_CHANGE(Any p0, Any p1, Any p2, Any p3);
509 | -- @param p0 Any
510 | -- @param p1 Any
511 | -- @param p2 Any
512 | -- @param p3 Any
513 | -- @return void
514 | function PlaystatsPropChange(p0, p1, p2, p3) end
515 |
516 | -- @todo
517 | -- @module native
518 | -- @submodule stats
519 | -- @see PLAYSTATS_CLOTH_CHANGE
520 | -- @usage void PLAYSTATS_CLOTH_CHANGE(Any p0, Any p1, Any p2, Any p3, Any p4);
521 | -- @param p0 Any
522 | -- @param p1 Any
523 | -- @param p2 Any
524 | -- @param p3 Any
525 | -- @param p4 Any
526 | -- @return void
527 | function PlaystatsClothChange(p0, p1, p2, p3, p4) end
528 |
529 | -- @todo
530 | -- @module native
531 | -- @submodule stats
532 | -- @see PLAYSTATS_CHEAT_APPLIED
533 | -- @usage void PLAYSTATS_CHEAT_APPLIED(char* cheat);
534 | -- @param cheat char*
535 | -- @return void
536 | function PlaystatsCheatApplied(cheat) end
537 |
538 | -- @todo
539 | -- @module native
540 | -- @submodule stats
541 | -- @see LEADERBOARDS_GET_NUMBER_OF_COLUMNS
542 | -- @usage Any LEADERBOARDS_GET_NUMBER_OF_COLUMNS(Any p0, Any p1);
543 | -- @param p0 Any
544 | -- @param p1 Any
545 | -- @return Any
546 | function LeaderboardsGetNumberOfColumns(p0, p1) end
547 |
548 | -- @todo
549 | -- @module native
550 | -- @submodule stats
551 | -- @see LEADERBOARDS_GET_COLUMN_ID
552 | -- @usage Any LEADERBOARDS_GET_COLUMN_ID(Any p0, Any p1, Any p2);
553 | -- @param p0 Any
554 | -- @param p1 Any
555 | -- @param p2 Any
556 | -- @return Any
557 | function LeaderboardsGetColumnId(p0, p1, p2) end
558 |
559 | -- @todo
560 | -- @module native
561 | -- @submodule stats
562 | -- @see LEADERBOARDS_GET_COLUMN_TYPE
563 | -- @usage Any LEADERBOARDS_GET_COLUMN_TYPE(Any p0, Any p1, Any p2);
564 | -- @param p0 Any
565 | -- @param p1 Any
566 | -- @param p2 Any
567 | -- @return Any
568 | function LeaderboardsGetColumnType(p0, p1, p2) end
569 |
570 | -- @todo
571 | -- @module native
572 | -- @submodule stats
573 | -- @see LEADERBOARDS_READ_CLEAR_ALL
574 | -- @usage Any LEADERBOARDS_READ_CLEAR_ALL();
575 | -- @return Any
576 | function LeaderboardsReadClearAll() end
577 |
578 | -- @todo
579 | -- @module native
580 | -- @submodule stats
581 | -- @see LEADERBOARDS_READ_CLEAR
582 | -- @usage Any LEADERBOARDS_READ_CLEAR(Any p0, Any p1, Any p2);
583 | -- @param p0 Any
584 | -- @param p1 Any
585 | -- @param p2 Any
586 | -- @return Any
587 | function LeaderboardsReadClear(p0, p1, p2) end
588 |
589 | -- @todo
590 | -- @module native
591 | -- @submodule stats
592 | -- @see LEADERBOARDS_READ_PENDING
593 | -- @usage BOOL LEADERBOARDS_READ_PENDING(Any p0, Any p1, Any p2);
594 | -- @param p0 Any
595 | -- @param p1 Any
596 | -- @param p2 Any
597 | -- @return BOOL
598 | function LeaderboardsReadPending(p0, p1, p2) end
599 |
600 | -- @todo
601 | -- @module native
602 | -- @submodule stats
603 | -- @see LEADERBOARDS_READ_SUCCESSFUL
604 | -- @usage BOOL LEADERBOARDS_READ_SUCCESSFUL(Any p0, Any p1, Any p2);
605 | -- @param p0 Any
606 | -- @param p1 Any
607 | -- @param p2 Any
608 | -- @return BOOL
609 | function LeaderboardsReadSuccessful(p0, p1, p2) end
610 |
611 | -- @todo
612 | -- @module native
613 | -- @submodule stats
614 | -- @see LEADERBOARDS2_READ_FRIENDS_BY_ROW
615 | -- @usage BOOL LEADERBOARDS2_READ_FRIENDS_BY_ROW(Any* p0, Any* p1, Any p2, BOOL p3, Any p4, Any p5);
616 | -- @param p0 Any*
617 | -- @param p1 Any*
618 | -- @param p2 Any
619 | -- @param p3 BOOL
620 | -- @param p4 Any
621 | -- @param p5 Any
622 | -- @return BOOL
623 | function Leaderboards2ReadFriendsByRow(p0, p1, p2, p3, p4, p5) end
624 |
625 | -- @todo
626 | -- @module native
627 | -- @submodule stats
628 | -- @see LEADERBOARDS2_READ_BY_HANDLE
629 | -- @usage BOOL LEADERBOARDS2_READ_BY_HANDLE(Any* p0, Any* p1);
630 | -- @param p0 Any*
631 | -- @param p1 Any*
632 | -- @return BOOL
633 | function Leaderboards2ReadByHandle(p0, p1) end
634 |
635 | -- @todo
636 | -- @module native
637 | -- @submodule stats
638 | -- @see LEADERBOARDS2_READ_BY_ROW
639 | -- @usage BOOL LEADERBOARDS2_READ_BY_ROW(Any* p0, Any* p1, Any p2, Any* p3, Any p4, Any* p5, Any p6);
640 | -- @param p0 Any*
641 | -- @param p1 Any*
642 | -- @param p2 Any
643 | -- @param p3 Any*
644 | -- @param p4 Any
645 | -- @param p5 Any*
646 | -- @param p6 Any
647 | -- @return BOOL
648 | function Leaderboards2ReadByRow(p0, p1, p2, p3, p4, p5, p6) end
649 |
650 | -- @todo
651 | -- @module native
652 | -- @submodule stats
653 | -- @see LEADERBOARDS2_READ_BY_RANK
654 | -- @usage BOOL LEADERBOARDS2_READ_BY_RANK(Any* p0, Any p1, Any p2);
655 | -- @param p0 Any*
656 | -- @param p1 Any
657 | -- @param p2 Any
658 | -- @return BOOL
659 | function Leaderboards2ReadByRank(p0, p1, p2) end
660 |
661 | -- @todo
662 | -- @module native
663 | -- @submodule stats
664 | -- @see LEADERBOARDS2_READ_BY_RADIUS
665 | -- @usage BOOL LEADERBOARDS2_READ_BY_RADIUS(Any* p0, Any p1, Any* p2);
666 | -- @param p0 Any*
667 | -- @param p1 Any
668 | -- @param p2 Any*
669 | -- @return BOOL
670 | function Leaderboards2ReadByRadius(p0, p1, p2) end
671 |
672 | -- @todo
673 | -- @module native
674 | -- @submodule stats
675 | -- @see LEADERBOARDS2_READ_BY_SCORE_INT
676 | -- @usage BOOL LEADERBOARDS2_READ_BY_SCORE_INT(Any* p0, Any p1, Any p2);
677 | -- @param p0 Any*
678 | -- @param p1 Any
679 | -- @param p2 Any
680 | -- @return BOOL
681 | function Leaderboards2ReadByScoreInt(p0, p1, p2) end
682 |
683 | -- @todo
684 | -- @module native
685 | -- @submodule stats
686 | -- @see LEADERBOARDS2_READ_BY_SCORE_FLOAT
687 | -- @usage BOOL LEADERBOARDS2_READ_BY_SCORE_FLOAT(Any* p0, float p1, Any p2);
688 | -- @param p0 Any*
689 | -- @param p1 float
690 | -- @param p2 Any
691 | -- @return BOOL
692 | function Leaderboards2ReadByScoreFloat(p0, p1, p2) end
693 |
694 | -- @todo
695 | -- @module native
696 | -- @submodule stats
697 | -- @see LEADERBOARDS2_WRITE_DATA
698 | -- @usage BOOL LEADERBOARDS2_WRITE_DATA(Any* p0);
699 | -- @param p0 Any*
700 | -- @return BOOL
701 | function Leaderboards2WriteData(p0) end
702 |
703 | -- @todo
704 | -- @module native
705 | -- @submodule stats
706 | -- @see LEADERBOARDS_CACHE_DATA_ROW
707 | -- @usage BOOL LEADERBOARDS_CACHE_DATA_ROW(Any* p0);
708 | -- @param p0 Any*
709 | -- @return BOOL
710 | function LeaderboardsCacheDataRow(p0) end
711 |
712 | -- @todo
713 | -- @module native
714 | -- @submodule stats
715 | -- @see LEADERBOARDS_CLEAR_CACHE_DATA
716 | -- @usage void LEADERBOARDS_CLEAR_CACHE_DATA();
717 | -- @return void
718 | function LeaderboardsClearCacheData() end
719 |
720 | -- @todo
721 | -- @module native
722 | -- @submodule stats
723 | -- @see LEADERBOARDS_GET_CACHE_EXISTS
724 | -- @usage BOOL LEADERBOARDS_GET_CACHE_EXISTS(Any p0);
725 | -- @param p0 Any
726 | -- @return BOOL
727 | function LeaderboardsGetCacheExists(p0) end
728 |
729 | -- @todo
730 | -- @module native
731 | -- @submodule stats
732 | -- @see LEADERBOARDS_GET_CACHE_TIME
733 | -- @usage Any LEADERBOARDS_GET_CACHE_TIME(Any p0);
734 | -- @param p0 Any
735 | -- @return Any
736 | function LeaderboardsGetCacheTime(p0) end
737 |
738 | -- @todo
739 | -- @module native
740 | -- @submodule stats
741 | -- @see LEADERBOARDS_GET_CACHE_DATA_ROW
742 | -- @usage BOOL LEADERBOARDS_GET_CACHE_DATA_ROW(Any p0, Any p1, Any* p2);
743 | -- @param p0 Any
744 | -- @param p1 Any
745 | -- @param p2 Any*
746 | -- @return BOOL
747 | function LeaderboardsGetCacheDataRow(p0, p1, p2) end
--------------------------------------------------------------------------------
/client/native/streaming.lua:
--------------------------------------------------------------------------------
1 | -- @todo
2 | -- @module native
3 | -- @submodule streaming
4 | -- @see LOAD_ALL_OBJECTS_NOW
5 | -- @usage void LOAD_ALL_OBJECTS_NOW();
6 | -- @return void
7 | function LoadAllObjectsNow() end
8 |
9 | -- @todo
10 | -- @module native
11 | -- @submodule streaming
12 | -- @see LOAD_SCENE
13 | -- @usage void LOAD_SCENE(float x, float y, float z);
14 | -- @param x float
15 | -- @param y float
16 | -- @param z float
17 | -- @return void
18 | function LoadScene(x, y, z) end
19 |
20 | -- @todo
21 | -- @module native
22 | -- @submodule streaming
23 | -- @see NETWORK_UPDATE_LOAD_SCENE
24 | -- @usage Any NETWORK_UPDATE_LOAD_SCENE();
25 | -- @return Any
26 | function NetworkUpdateLoadScene() end
27 |
28 | -- @todo
29 | -- @module native
30 | -- @submodule streaming
31 | -- @see NETWORK_STOP_LOAD_SCENE
32 | -- @usage void NETWORK_STOP_LOAD_SCENE();
33 | -- @return void
34 | function NetworkStopLoadScene() end
35 |
36 | -- @todo
37 | -- @module native
38 | -- @submodule streaming
39 | -- @see IS_NETWORK_LOADING_SCENE
40 | -- @usage BOOL IS_NETWORK_LOADING_SCENE();
41 | -- @return BOOL
42 | function IsNetworkLoadingScene() end
43 |
44 | -- @todo
45 | -- @module native
46 | -- @submodule streaming
47 | -- @see SET_INTERIOR_ACTIVE
48 | -- @usage void SET_INTERIOR_ACTIVE(int interiorID, BOOL toggle);
49 | -- @param interiorID int
50 | -- @param toggle BOOL
51 | -- @return void
52 | function SetInteriorActive(interiorID, toggle) end
53 |
54 | -- Request a model to be loaded into memory Looking it the disassembly, it seems like it actually returns the model if it's already loaded.
55 | -- @module native
56 | -- @submodule streaming
57 | -- @see REQUEST_MODEL
58 | -- @usage void REQUEST_MODEL(Hash model);
59 | -- @param model Hash
60 | -- @return void
61 | function RequestModel(model) end
62 |
63 | -- @todo
64 | -- @module native
65 | -- @submodule streaming
66 | -- @see REQUEST_MENU_PED_MODEL
67 | -- @usage void REQUEST_MENU_PED_MODEL(Hash model);
68 | -- @param model Hash
69 | -- @return void
70 | function RequestMenuPedModel(model) end
71 |
72 | -- Checks if the specified model has loaded into memory.
73 | -- @module native
74 | -- @submodule streaming
75 | -- @see HAS_MODEL_LOADED
76 | -- @usage BOOL HAS_MODEL_LOADED(Hash model);
77 | -- @param model Hash
78 | -- @return BOOL
79 | function HasModelLoaded(model) end
80 |
81 | -- Unloads model from memory
82 | -- @module native
83 | -- @submodule streaming
84 | -- @see SET_MODEL_AS_NO_LONGER_NEEDED
85 | -- @usage void SET_MODEL_AS_NO_LONGER_NEEDED(Hash model);
86 | -- @param model Hash
87 | -- @return void
88 | function SetModelAsNoLongerNeeded(model) end
89 |
90 | -- Check if model is in cdimage(rpf)
91 | -- @module native
92 | -- @submodule streaming
93 | -- @see IS_MODEL_IN_CDIMAGE
94 | -- @usage BOOL IS_MODEL_IN_CDIMAGE(Hash model);
95 | -- @param model Hash
96 | -- @return BOOL
97 | function IsModelInCdimage(model) end
98 |
99 | -- Returns whether the specified model exists in the game.
100 | -- @module native
101 | -- @submodule streaming
102 | -- @see IS_MODEL_VALID
103 | -- @usage BOOL IS_MODEL_VALID(Hash model);
104 | -- @param model Hash
105 | -- @return BOOL
106 | function IsModelValid(model) end
107 |
108 | -- Returns whether the specified model represents a vehicle.
109 | -- @module native
110 | -- @submodule streaming
111 | -- @see IS_MODEL_A_VEHICLE
112 | -- @usage BOOL IS_MODEL_A_VEHICLE(Hash model);
113 | -- @param model Hash
114 | -- @return BOOL
115 | function IsModelAVehicle(model) end
116 |
117 | -- @todo
118 | -- @module native
119 | -- @submodule streaming
120 | -- @see REQUEST_COLLISION_AT_COORD
121 | -- @usage Any REQUEST_COLLISION_AT_COORD(float x, float y, float z);
122 | -- @param x float
123 | -- @param y float
124 | -- @param z float
125 | -- @return Any
126 | function RequestCollisionAtCoord(x, y, z) end
127 |
128 | -- @todo
129 | -- @module native
130 | -- @submodule streaming
131 | -- @see REQUEST_COLLISION_FOR_MODEL
132 | -- @usage void REQUEST_COLLISION_FOR_MODEL(Hash model);
133 | -- @param model Hash
134 | -- @return void
135 | function RequestCollisionForModel(model) end
136 |
137 | -- @todo
138 | -- @module native
139 | -- @submodule streaming
140 | -- @see HAS_COLLISION_FOR_MODEL_LOADED
141 | -- @usage BOOL HAS_COLLISION_FOR_MODEL_LOADED(Hash model);
142 | -- @param model Hash
143 | -- @return BOOL
144 | function HasCollisionForModelLoaded(model) end
145 |
146 | -- MulleDK19: Alias of REQUEST_COLLISION_AT_COORD.
147 | -- @module native
148 | -- @submodule streaming
149 | -- @see REQUEST_ADDITIONAL_COLLISION_AT_COORD
150 | -- @usage void REQUEST_ADDITIONAL_COLLISION_AT_COORD(float p0, float p1, float p2);
151 | -- @param p0 float
152 | -- @param p1 float
153 | -- @param p2 float
154 | -- @return void
155 | function RequestAdditionalCollisionAtCoord(p0, p1, p2) end
156 |
157 | -- @todo
158 | -- @module native
159 | -- @submodule streaming
160 | -- @see DOES_ANIM_DICT_EXIST
161 | -- @usage BOOL DOES_ANIM_DICT_EXIST(char* animDict);
162 | -- @param animDict char*
163 | -- @return BOOL
164 | function DoesAnimDictExist(animDict) end
165 |
166 | -- @todo
167 | -- @module native
168 | -- @submodule streaming
169 | -- @see REQUEST_ANIM_DICT
170 | -- @usage void REQUEST_ANIM_DICT(char* animDict);
171 | -- @param animDict char*
172 | -- @return void
173 | function RequestAnimDict(animDict) end
174 |
175 | -- @todo
176 | -- @module native
177 | -- @submodule streaming
178 | -- @see HAS_ANIM_DICT_LOADED
179 | -- @usage BOOL HAS_ANIM_DICT_LOADED(char* animDict);
180 | -- @param animDict char*
181 | -- @return BOOL
182 | function HasAnimDictLoaded(animDict) end
183 |
184 | -- @todo
185 | -- @module native
186 | -- @submodule streaming
187 | -- @see REMOVE_ANIM_DICT
188 | -- @usage void REMOVE_ANIM_DICT(char* animDict);
189 | -- @param animDict char*
190 | -- @return void
191 | function RemoveAnimDict(animDict) end
192 |
193 | -- Starts loading the specified animation set. An animation set provides movement animations for a ped. See SET_PED_MOVEMENT_CLIPSET.
194 | -- @module native
195 | -- @submodule streaming
196 | -- @see REQUEST_ANIM_SET
197 | -- @usage void REQUEST_ANIM_SET(char* animSet);
198 | -- @param animSet char*
199 | -- @return void
200 | function RequestAnimSet(animSet) end
201 |
202 | -- Gets whether the specified animation set has finished loading. An animation set provides movement animations for a ped. See SET_PED_MOVEMENT_CLIPSET. Animation set and clip set are synonymous.
203 | -- @module native
204 | -- @submodule streaming
205 | -- @see HAS_ANIM_SET_LOADED
206 | -- @usage BOOL HAS_ANIM_SET_LOADED(char* animSet);
207 | -- @param animSet char*
208 | -- @return BOOL
209 | function HasAnimSetLoaded(animSet) end
210 |
211 | -- Unloads the specified animation set. An animation set provides movement animations for a ped. See SET_PED_MOVEMENT_CLIPSET. Animation set and clip set are synonymous.
212 | -- @module native
213 | -- @submodule streaming
214 | -- @see REMOVE_ANIM_SET
215 | -- @usage void REMOVE_ANIM_SET(char* animSet);
216 | -- @param animSet char*
217 | -- @return void
218 | function RemoveAnimSet(animSet) end
219 |
220 | -- @todo
221 | -- @module native
222 | -- @submodule streaming
223 | -- @see REQUEST_CLIP_SET
224 | -- @usage void REQUEST_CLIP_SET(char* clipSet);
225 | -- @param clipSet char*
226 | -- @return void
227 | function RequestClipSet(clipSet) end
228 |
229 | -- Alias for HAS_ANIM_SET_LOADED.
230 | -- @module native
231 | -- @submodule streaming
232 | -- @see HAS_CLIP_SET_LOADED
233 | -- @usage BOOL HAS_CLIP_SET_LOADED(char* clipSet);
234 | -- @param clipSet char*
235 | -- @return BOOL
236 | function HasClipSetLoaded(clipSet) end
237 |
238 | -- Alias for REMOVE_ANIM_SET.
239 | -- @module native
240 | -- @submodule streaming
241 | -- @see REMOVE_CLIP_SET
242 | -- @usage void REMOVE_CLIP_SET(char* clipSet);
243 | -- @param clipSet char*
244 | -- @return void
245 | function RemoveClipSet(clipSet) end
246 |
247 | -- Exemple: REQUEST_IPL("TrevorsTrailerTrash"); IPL + Coords: http://pastebin.com/FyV5mMma
248 | -- @module native
249 | -- @submodule streaming
250 | -- @see REQUEST_IPL
251 | -- @usage void REQUEST_IPL(char* iplName);
252 | -- @param iplName char*
253 | -- @return void
254 | function RequestIpl(iplName) end
255 |
256 | -- Removes an IPL from the map. IPL List: pastebin.com/pwkh0uRP Example: C#: Function.Call(Hash.REMOVE_IPL, "trevorstrailertidy"); C++: STREAMING::REMOVE_IPL("trevorstrailertidy"); iplName = Name of IPL you want to remove.
257 | -- @module native
258 | -- @submodule streaming
259 | -- @see REMOVE_IPL
260 | -- @usage void REMOVE_IPL(char* iplName);
261 | -- @param iplName char*
262 | -- @return void
263 | function RemoveIpl(iplName) end
264 |
265 | -- @todo
266 | -- @module native
267 | -- @submodule streaming
268 | -- @see IS_IPL_ACTIVE
269 | -- @usage BOOL IS_IPL_ACTIVE(char* iplName);
270 | -- @param iplName char*
271 | -- @return BOOL
272 | function IsIplActive(iplName) end
273 |
274 | -- @todo
275 | -- @module native
276 | -- @submodule streaming
277 | -- @see SET_STREAMING
278 | -- @usage void SET_STREAMING(BOOL toggle);
279 | -- @param toggle BOOL
280 | -- @return void
281 | function SetStreaming(toggle) end
282 |
283 | -- @todo
284 | -- @module native
285 | -- @submodule streaming
286 | -- @see SET_GAME_PAUSES_FOR_STREAMING
287 | -- @usage void SET_GAME_PAUSES_FOR_STREAMING(BOOL toggle);
288 | -- @param toggle BOOL
289 | -- @return void
290 | function SetGamePausesForStreaming(toggle) end
291 |
292 | -- @todo
293 | -- @module native
294 | -- @submodule streaming
295 | -- @see SET_REDUCE_PED_MODEL_BUDGET
296 | -- @usage void SET_REDUCE_PED_MODEL_BUDGET(BOOL toggle);
297 | -- @param toggle BOOL
298 | -- @return void
299 | function SetReducePedModelBudget(toggle) end
300 |
301 | -- @todo
302 | -- @module native
303 | -- @submodule streaming
304 | -- @see SET_REDUCE_VEHICLE_MODEL_BUDGET
305 | -- @usage void SET_REDUCE_VEHICLE_MODEL_BUDGET(BOOL toggle);
306 | -- @param toggle BOOL
307 | -- @return void
308 | function SetReduceVehicleModelBudget(toggle) end
309 |
310 | -- This is a NOP function. It does nothing at all.
311 | -- @module native
312 | -- @submodule streaming
313 | -- @see SET_DITCH_POLICE_MODELS
314 | -- @usage void SET_DITCH_POLICE_MODELS(BOOL toggle);
315 | -- @param toggle BOOL
316 | -- @return void
317 | function SetDitchPoliceModels(toggle) end
318 |
319 | -- @todo
320 | -- @module native
321 | -- @submodule streaming
322 | -- @see GET_NUMBER_OF_STREAMING_REQUESTS
323 | -- @usage int GET_NUMBER_OF_STREAMING_REQUESTS();
324 | -- @return int
325 | function GetNumberOfStreamingRequests() end
326 |
327 | -- maps script name (thread + 0xD0) by lookup via scriptfx.dat - does nothing when script name is empty
328 | -- @module native
329 | -- @submodule streaming
330 | -- @see REQUEST_PTFX_ASSET
331 | -- @usage Any REQUEST_PTFX_ASSET();
332 | -- @return Any
333 | function RequestPtfxAsset() end
334 |
335 | -- @todo
336 | -- @module native
337 | -- @submodule streaming
338 | -- @see HAS_PTFX_ASSET_LOADED
339 | -- @usage BOOL HAS_PTFX_ASSET_LOADED();
340 | -- @return BOOL
341 | function HasPtfxAssetLoaded() end
342 |
343 | -- @todo
344 | -- @module native
345 | -- @submodule streaming
346 | -- @see REMOVE_PTFX_ASSET
347 | -- @usage void REMOVE_PTFX_ASSET();
348 | -- @return void
349 | function RemovePtfxAsset() end
350 |
351 | -- From the b678d decompiled scripts: STREAMING::REQUEST_NAMED_PTFX_ASSET("core_snow"); STREAMING::REQUEST_NAMED_PTFX_ASSET("fm_mission_controler"); STREAMING::REQUEST_NAMED_PTFX_ASSET("proj_xmas_firework"); STREAMING::REQUEST_NAMED_PTFX_ASSET("scr_apartment_mp"); STREAMING::REQUEST_NAMED_PTFX_ASSET("scr_biolab_heist"); STREAMING::REQUEST_NAMED_PTFX_ASSET("scr_indep_fireworks"); STREAMING::REQUEST_NAMED_PTFX_ASSET("scr_indep_parachute"); STREAMING::REQUEST_NAMED_PTFX_ASSET("scr_indep_wheelsmoke"); STREAMING::REQUEST_NAMED_PTFX_ASSET("scr_mp_cig_plane"); STREAMING::REQUEST_NAMED_PTFX_ASSET("scr_mp_creator"); STREAMING::REQUEST_NAMED_PTFX_ASSET("scr_mp_tankbattle"); STREAMING::REQUEST_NAMED_PTFX_ASSET("scr_ornate_heist"); STREAMING::REQUEST_NAMED_PTFX_ASSET("scr_prison_break_heist_station");
352 | -- @module native
353 | -- @submodule streaming
354 | -- @see REQUEST_NAMED_PTFX_ASSET
355 | -- @usage void REQUEST_NAMED_PTFX_ASSET(char* fxName);
356 | -- @param fxName char*
357 | -- @return void
358 | function RequestNamedPtfxAsset(fxName) end
359 |
360 | -- @todo
361 | -- @module native
362 | -- @submodule streaming
363 | -- @see HAS_NAMED_PTFX_ASSET_LOADED
364 | -- @usage BOOL HAS_NAMED_PTFX_ASSET_LOADED(char* fxName);
365 | -- @param fxName char*
366 | -- @return BOOL
367 | function HasNamedPtfxAssetLoaded(fxName) end
368 |
369 | -- @todo
370 | -- @module native
371 | -- @submodule streaming
372 | -- @see SET_VEHICLE_POPULATION_BUDGET
373 | -- @usage void SET_VEHICLE_POPULATION_BUDGET(int p0);
374 | -- @param p0 int
375 | -- @return void
376 | function SetVehiclePopulationBudget(p0) end
377 |
378 | -- @todo
379 | -- @module native
380 | -- @submodule streaming
381 | -- @see SET_PED_POPULATION_BUDGET
382 | -- @usage void SET_PED_POPULATION_BUDGET(int p0);
383 | -- @param p0 int
384 | -- @return void
385 | function SetPedPopulationBudget(p0) end
386 |
387 | -- @todo
388 | -- @module native
389 | -- @submodule streaming
390 | -- @see CLEAR_FOCUS
391 | -- @usage void CLEAR_FOCUS();
392 | -- @return void
393 | function ClearFocus() end
394 |
395 | -- It seems to make the entity's coords mark the point from which LOD-distances are measured. In my testing, setting a vehicle as the focus entity and moving that vehicle more than 300 distance units away from the player will make the level of detail around the player go down drastically (shadows disappear, textures go extremely low res, etc). The player seems to be the default focus entity.
396 | -- @module native
397 | -- @submodule streaming
398 | -- @see SET_FOCUS_ENTITY
399 | -- @usage void SET_FOCUS_ENTITY(Entity entity);
400 | -- @param entity Entity
401 | -- @return void
402 | function SetFocusEntity(entity) end
403 |
404 | -- @todo
405 | -- @module native
406 | -- @submodule streaming
407 | -- @see IS_ENTITY_FOCUS
408 | -- @usage BOOL IS_ENTITY_FOCUS(Entity entity);
409 | -- @param entity Entity
410 | -- @return BOOL
411 | function IsEntityFocus(entity) end
412 |
413 | -- @todo
414 | -- @module native
415 | -- @submodule streaming
416 | -- @see FORMAT_FOCUS_HEADING
417 | -- @usage Any FORMAT_FOCUS_HEADING(float x, float y, float z, float rad, Any p4, Any p5);
418 | -- @param x float
419 | -- @param y float
420 | -- @param z float
421 | -- @param rad float
422 | -- @param p4 Any
423 | -- @param p5 Any
424 | -- @return Any
425 | function FormatFocusHeading(x, y, z, rad, p4, p5) end
426 |
427 | -- @todo
428 | -- @module native
429 | -- @submodule streaming
430 | -- @see NEW_LOAD_SCENE_START
431 | -- @usage BOOL NEW_LOAD_SCENE_START(float p0, float p1, float p2, float p3, float p4, float p5, float p6, Any p7);
432 | -- @param p0 float
433 | -- @param p1 float
434 | -- @param p2 float
435 | -- @param p3 float
436 | -- @param p4 float
437 | -- @param p5 float
438 | -- @param p6 float
439 | -- @param p7 Any
440 | -- @return BOOL
441 | function NewLoadSceneStart(p0, p1, p2, p3, p4, p5, p6, p7) end
442 |
443 | -- if (!sub_8f12("START LOAD SCENE SAFE")) { if (CUTSCENE::GET_CUTSCENE_TIME() > 4178) { STREAMING::_ACCFB4ACF53551B0(1973.845458984375, 3818.447265625, 32.43629837036133, 15.0, 2); sub_8e9e("START LOAD SCENE SAFE", 1); } } (Previously known as STREAMING::_NEW_LOAD_SCENE_START_SAFE)
444 | -- @module native
445 | -- @submodule streaming
446 | -- @see NEW_LOAD_SCENE_START_SPHERE
447 | -- @usage BOOL NEW_LOAD_SCENE_START_SPHERE(float x, float y, float z, float radius, Any p4);
448 | -- @param x float
449 | -- @param y float
450 | -- @param z float
451 | -- @param radius float
452 | -- @param p4 Any
453 | -- @return BOOL
454 | function NewLoadSceneStartSphere(x, y, z, radius, p4) end
455 |
456 | -- @todo
457 | -- @module native
458 | -- @submodule streaming
459 | -- @see NEW_LOAD_SCENE_STOP
460 | -- @usage void NEW_LOAD_SCENE_STOP();
461 | -- @return void
462 | function NewLoadSceneStop() end
463 |
464 | -- @todo
465 | -- @module native
466 | -- @submodule streaming
467 | -- @see IS_NEW_LOAD_SCENE_ACTIVE
468 | -- @usage BOOL IS_NEW_LOAD_SCENE_ACTIVE();
469 | -- @return BOOL
470 | function IsNewLoadSceneActive() end
471 |
472 | -- @todo
473 | -- @module native
474 | -- @submodule streaming
475 | -- @see IS_NEW_LOAD_SCENE_LOADED
476 | -- @usage BOOL IS_NEW_LOAD_SCENE_LOADED();
477 | -- @return BOOL
478 | function IsNewLoadSceneLoaded() end
479 |
480 | -- // this enum comes directly from R* so don't edit this enum ePlayerSwitchTypes { SWITCH_TYPE_AUTO, SWITCH_TYPE_LONG, SWITCH_TYPE_MEDIUM, SWITCH_TYPE_SHORT }; Use GET_IDEAL_PLAYER_SWITCH_TYPE for the best switch type. ---------------------------------------------------- Examples from the decompiled scripts: STREAMING::START_PLAYER_SWITCH(l_832._f3, PLAYER::PLAYER_PED_ID(), 0, 3); STREAMING::START_PLAYER_SWITCH(l_832._f3, PLAYER::PLAYER_PED_ID(), 2050, 3); STREAMING::START_PLAYER_SWITCH(PLAYER::PLAYER_PED_ID(), l_832._f3, 1024, 3); STREAMING::START_PLAYER_SWITCH(g_141F27, PLAYER::PLAYER_PED_ID(), 513, v_14); Note: DO NOT, use SWITCH_TYPE_LONG with flag 513. It leaves you stuck in the clouds. You'll have to call STOP_PLAYER_SWITCH() to return to your ped. Flag 8 w/ SWITCH_TYPE_LONG will zoom out 3 steps, then zoom in 2/3 steps and stop on the 3rd and just hang there. Flag 8 w/ SWITCH_TYPE_MEDIUM will zoom out 1 step, and just hang there.
481 | -- @module native
482 | -- @submodule streaming
483 | -- @see START_PLAYER_SWITCH
484 | -- @usage void START_PLAYER_SWITCH(Ped from, Ped to, int flags, int switchType);
485 | -- @param from Ped
486 | -- @param to Ped
487 | -- @param flags int
488 | -- @param switchType int
489 | -- @return void
490 | function StartPlayerSwitch(from, to, flags, switchType) end
491 |
492 | -- @todo
493 | -- @module native
494 | -- @submodule streaming
495 | -- @see STOP_PLAYER_SWITCH
496 | -- @usage void STOP_PLAYER_SWITCH();
497 | -- @return void
498 | function StopPlayerSwitch() end
499 |
500 | -- Returns true if the player is currently switching, false otherwise. (When the camera is in the sky moving from Trevor to Franklin for example)
501 | -- @module native
502 | -- @submodule streaming
503 | -- @see IS_PLAYER_SWITCH_IN_PROGRESS
504 | -- @usage BOOL IS_PLAYER_SWITCH_IN_PROGRESS();
505 | -- @return BOOL
506 | function IsPlayerSwitchInProgress() end
507 |
508 | -- @todo
509 | -- @module native
510 | -- @submodule streaming
511 | -- @see GET_PLAYER_SWITCH_TYPE
512 | -- @usage int GET_PLAYER_SWITCH_TYPE();
513 | -- @return int
514 | function GetPlayerSwitchType() end
515 |
516 | -- x1, y1, z1 -- Coords of your ped model x2, y2, z2 -- Coords of the ped you want to switch to
517 | -- @module native
518 | -- @submodule streaming
519 | -- @see GET_IDEAL_PLAYER_SWITCH_TYPE
520 | -- @usage int GET_IDEAL_PLAYER_SWITCH_TYPE(float x1, float y1, float z1, float x2, float y2, float z2);
521 | -- @param x1 float
522 | -- @param y1 float
523 | -- @param z1 float
524 | -- @param x2 float
525 | -- @param y2 float
526 | -- @param z2 float
527 | -- @return int
528 | function GetIdealPlayerSwitchType(x1, y1, z1, x2, y2, z2) end
529 |
530 | -- @todo
531 | -- @module native
532 | -- @submodule streaming
533 | -- @see GET_PLAYER_SWITCH_STATE
534 | -- @usage int GET_PLAYER_SWITCH_STATE();
535 | -- @return int
536 | function GetPlayerSwitchState() end
537 |
538 | -- @todo
539 | -- @module native
540 | -- @submodule streaming
541 | -- @see GET_PLAYER_SHORT_SWITCH_STATE
542 | -- @usage int GET_PLAYER_SHORT_SWITCH_STATE();
543 | -- @return int
544 | function GetPlayerShortSwitchState() end
545 |
546 | -- @todo
547 | -- @module native
548 | -- @submodule streaming
549 | -- @see SET_PLAYER_SWITCH_OUTRO
550 | -- @usage void SET_PLAYER_SWITCH_OUTRO(float p0, float p1, float p2, float p3, float p4, float p5, float p6, float p7, Any p8);
551 | -- @param p0 float
552 | -- @param p1 float
553 | -- @param p2 float
554 | -- @param p3 float
555 | -- @param p4 float
556 | -- @param p5 float
557 | -- @param p6 float
558 | -- @param p7 float
559 | -- @param p8 Any
560 | -- @return void
561 | function SetPlayerSwitchOutro(p0, p1, p2, p3, p4, p5, p6, p7, p8) end
562 |
563 | -- Hash collision
564 | -- @module native
565 | -- @submodule streaming
566 | -- @see SET_PLAYER_INVERTED_UP
567 | -- @usage int SET_PLAYER_INVERTED_UP();
568 | -- @return int
569 | function SetPlayerInvertedUp() end
570 |
571 | -- Hash collision
572 | -- @module native
573 | -- @submodule streaming
574 | -- @see DESTROY_PLAYER_IN_PAUSE_MENU
575 | -- @usage Any DESTROY_PLAYER_IN_PAUSE_MENU();
576 | -- @return Any
577 | function DestroyPlayerInPauseMenu() end
578 |
579 | -- @todo
580 | -- @module native
581 | -- @submodule streaming
582 | -- @see PREFETCH_SRL
583 | -- @usage void PREFETCH_SRL(char* srl);
584 | -- @param srl char*
585 | -- @return void
586 | function PrefetchSrl(srl) end
587 |
588 | -- @todo
589 | -- @module native
590 | -- @submodule streaming
591 | -- @see IS_SRL_LOADED
592 | -- @usage BOOL IS_SRL_LOADED();
593 | -- @return BOOL
594 | function IsSrlLoaded() end
595 |
596 | -- @todo
597 | -- @module native
598 | -- @submodule streaming
599 | -- @see BEGIN_SRL
600 | -- @usage void BEGIN_SRL();
601 | -- @return void
602 | function BeginSrl() end
603 |
604 | -- @todo
605 | -- @module native
606 | -- @submodule streaming
607 | -- @see END_SRL
608 | -- @usage void END_SRL();
609 | -- @return void
610 | function EndSrl() end
611 |
612 | -- @todo
613 | -- @module native
614 | -- @submodule streaming
615 | -- @see SET_SRL_TIME
616 | -- @usage void SET_SRL_TIME(float p0);
617 | -- @param p0 float
618 | -- @return void
619 | function SetSrlTime(p0) end
620 |
621 | -- @todo
622 | -- @module native
623 | -- @submodule streaming
624 | -- @see SET_HD_AREA
625 | -- @usage void SET_HD_AREA(float x, float y, float z, float ground);
626 | -- @param x float
627 | -- @param y float
628 | -- @param z float
629 | -- @param ground float
630 | -- @return void
631 | function SetHdArea(x, y, z, ground) end
632 |
633 | -- @todo
634 | -- @module native
635 | -- @submodule streaming
636 | -- @see CLEAR_HD_AREA
637 | -- @usage void CLEAR_HD_AREA();
638 | -- @return void
639 | function ClearHdArea() end
640 |
641 | -- @todo
642 | -- @module native
643 | -- @submodule streaming
644 | -- @see SHUTDOWN_CREATOR_BUDGET
645 | -- @usage void SHUTDOWN_CREATOR_BUDGET();
646 | -- @return void
647 | function ShutdownCreatorBudget() end
--------------------------------------------------------------------------------
/client/native/system.lua:
--------------------------------------------------------------------------------
1 | -- Pauses execution of the current script, please note this behavior is only seen when called from one of the game script files(ysc). In order to wait an asi script use static void WAIT(DWORD time); found in main.h -------------------------------------------------------------------- It does not actually seem to wait the amount of milliseconds stated like the normal WAIT() command does, but it does seem to make task sequences work more smoothly System native hashes do not change on gameupdate
2 | -- @module native
3 | -- @submodule system
4 | -- @see WAIT
5 | -- @usage void WAIT(int ms);
6 | -- @param ms int
7 | -- @return void
8 | function Wait(ms) end
9 |
10 | -- Examples: g_384A = SYSTEM::START_NEW_SCRIPT("cellphone_flashhand", 1424); l_10D = SYSTEM::START_NEW_SCRIPT("taxiService", 1828); SYSTEM::START_NEW_SCRIPT("AM_MP_YACHT", 5000); SYSTEM::START_NEW_SCRIPT("emergencycall", 512); SYSTEM::START_NEW_SCRIPT("emergencycall", 512); SYSTEM::START_NEW_SCRIPT("FM_maintain_cloud_header_data", 1424); SYSTEM::START_NEW_SCRIPT("FM_Mission_Controller", 31000); SYSTEM::START_NEW_SCRIPT("tennis_family", 3650); SYSTEM::START_NEW_SCRIPT("Celebrations", 3650); Decompiled examples of usage when starting a script: SCRIPT::REQUEST_SCRIPT(a_0); if (SCRIPT::HAS_SCRIPT_LOADED(a_0)) { SYSTEM::START_NEW_SCRIPT(a_0, v_3); SCRIPT::SET_SCRIPT_AS_NO_LONGER_NEEDED(a_0); return 1; } or: v_2 = "MrsPhilips2"; SCRIPT::REQUEST_SCRIPT(v_2); while (!SCRIPT::HAS_SCRIPT_LOADED(v_2)) { SCRIPT::REQUEST_SCRIPT(v_2); SYSTEM::WAIT(0); } sub_8792(36); SYSTEM::START_NEW_SCRIPT(v_2, 17000); SCRIPT::SET_SCRIPT_AS_NO_LONGER_NEEDED(v_2); All native script names: pastebin.com/K9adDsu4 and pastebin.com/yLNWicUi
11 | -- @module native
12 | -- @submodule system
13 | -- @see START_NEW_SCRIPT
14 | -- @usage int START_NEW_SCRIPT(char* scriptName, int stackSize);
15 | -- @param scriptName char*
16 | -- @param stackSize int
17 | -- @return int
18 | function StartNewScript(scriptName, stackSize) end
19 |
20 | -- return : script thread id, 0 if failed Pass pointer to struct of args in p1, size of struct goes into p2
21 | -- @module native
22 | -- @submodule system
23 | -- @see START_NEW_SCRIPT_WITH_ARGS
24 | -- @usage int START_NEW_SCRIPT_WITH_ARGS(char* scriptName, Any* args, int argCount, int stackSize);
25 | -- @param scriptName char*
26 | -- @param args Any*
27 | -- @param argCount int
28 | -- @param stackSize int
29 | -- @return int
30 | function StartNewScriptWithArgs(scriptName, args, argCount, stackSize) end
31 |
32 | -- @todo
33 | -- @module native
34 | -- @submodule system
35 | -- @see START_NEW_SCRIPT_WITH_NAME_HASH
36 | -- @usage int START_NEW_SCRIPT_WITH_NAME_HASH(Hash scriptHash, int stackSize);
37 | -- @param scriptHash Hash
38 | -- @param stackSize int
39 | -- @return int
40 | function StartNewScriptWithNameHash(scriptHash, stackSize) end
41 |
42 | -- @todo
43 | -- @module native
44 | -- @submodule system
45 | -- @see START_NEW_SCRIPT_WITH_NAME_HASH_AND_ARGS
46 | -- @usage int START_NEW_SCRIPT_WITH_NAME_HASH_AND_ARGS(Hash scriptHash, Any* args, int argCount, int stackSize);
47 | -- @param scriptHash Hash
48 | -- @param args Any*
49 | -- @param argCount int
50 | -- @param stackSize int
51 | -- @return int
52 | function StartNewScriptWithNameHashAndArgs(scriptHash, args, argCount, stackSize) end
53 |
54 | -- Counts up. Every 1000 is 1 real-time second. Use SETTIMERA(int value) to set the timer (e.g.: SETTIMERA(0)).
55 | -- @module native
56 | -- @submodule system
57 | -- @see TIMERA
58 | -- @usage int TIMERA();
59 | -- @return int
60 | function Timera() end
61 |
62 | -- @todo
63 | -- @module native
64 | -- @submodule system
65 | -- @see TIMERB
66 | -- @usage int TIMERB();
67 | -- @return int
68 | function Timerb() end
69 |
70 | -- @todo
71 | -- @module native
72 | -- @submodule system
73 | -- @see SETTIMERA
74 | -- @usage void SETTIMERA(int value);
75 | -- @param value int
76 | -- @return void
77 | function Settimera(value) end
78 |
79 | -- @todo
80 | -- @module native
81 | -- @submodule system
82 | -- @see SETTIMERB
83 | -- @usage void SETTIMERB(int value);
84 | -- @param value int
85 | -- @return void
86 | function Settimerb(value) end
87 |
88 | -- Gets the current frame time.
89 | -- @module native
90 | -- @submodule system
91 | -- @see TIMESTEP
92 | -- @usage float TIMESTEP();
93 | -- @return float
94 | function Timestep() end
95 |
96 | -- @todo
97 | -- @module native
98 | -- @submodule system
99 | -- @see SIN
100 | -- @usage float SIN(float value);
101 | -- @param value float
102 | -- @return float
103 | function Sin(value) end
104 |
105 | -- @todo
106 | -- @module native
107 | -- @submodule system
108 | -- @see COS
109 | -- @usage float COS(float value);
110 | -- @param value float
111 | -- @return float
112 | function Cos(value) end
113 |
114 | -- @todo
115 | -- @module native
116 | -- @submodule system
117 | -- @see SQRT
118 | -- @usage float SQRT(float value);
119 | -- @param value float
120 | -- @return float
121 | function Sqrt(value) end
122 |
123 | -- @todo
124 | -- @module native
125 | -- @submodule system
126 | -- @see POW
127 | -- @usage float POW(float base, float exponent);
128 | -- @param base float
129 | -- @param exponent float
130 | -- @return float
131 | function Pow(base, exponent) end
132 |
133 | -- Calculates the magnitude of a vector.
134 | -- @module native
135 | -- @submodule system
136 | -- @see VMAG
137 | -- @usage float VMAG(float x, float y, float z);
138 | -- @param x float
139 | -- @param y float
140 | -- @param z float
141 | -- @return float
142 | function Vmag(x, y, z) end
143 |
144 | -- Calculates the magnitude of a vector but does not perform Sqrt operations. (Its way faster)
145 | -- @module native
146 | -- @submodule system
147 | -- @see VMAG2
148 | -- @usage float VMAG2(float x, float y, float z);
149 | -- @param x float
150 | -- @param y float
151 | -- @param z float
152 | -- @return float
153 | function Vmag2(x, y, z) end
154 |
155 | -- Calculates distance between vectors.
156 | -- @module native
157 | -- @submodule system
158 | -- @see VDIST
159 | -- @usage float VDIST(float x1, float y1, float z1, float x2, float y2, float z2);
160 | -- @param x1 float
161 | -- @param y1 float
162 | -- @param z1 float
163 | -- @param x2 float
164 | -- @param y2 float
165 | -- @param z2 float
166 | -- @return float
167 | function Vdist(x1, y1, z1, x2, y2, z2) end
168 |
169 | -- Calculates distance between vectors but does not perform Sqrt operations. (Its way faster)
170 | -- @module native
171 | -- @submodule system
172 | -- @see VDIST2
173 | -- @usage float VDIST2(float x1, float y1, float z1, float x2, float y2, float z2);
174 | -- @param x1 float
175 | -- @param y1 float
176 | -- @param z1 float
177 | -- @param x2 float
178 | -- @param y2 float
179 | -- @param z2 float
180 | -- @return float
181 | function Vdist2(x1, y1, z1, x2, y2, z2) end
182 |
183 | -- @todo
184 | -- @module native
185 | -- @submodule system
186 | -- @see SHIFT_LEFT
187 | -- @usage int SHIFT_LEFT(int value, int bitShift);
188 | -- @param value int
189 | -- @param bitShift int
190 | -- @return int
191 | function ShiftLeft(value, bitShift) end
192 |
193 | -- @todo
194 | -- @module native
195 | -- @submodule system
196 | -- @see SHIFT_RIGHT
197 | -- @usage int SHIFT_RIGHT(int value, int bitShift);
198 | -- @param value int
199 | -- @param bitShift int
200 | -- @return int
201 | function ShiftRight(value, bitShift) end
202 |
203 | -- @todo
204 | -- @module native
205 | -- @submodule system
206 | -- @see FLOOR
207 | -- @usage int FLOOR(float value);
208 | -- @param value float
209 | -- @return int
210 | function Floor(value) end
211 |
212 | -- I'm guessing this rounds a float value up to the next whole number, and FLOOR rounds it down
213 | -- @module native
214 | -- @submodule system
215 | -- @see CEIL
216 | -- @usage int CEIL(float value);
217 | -- @param value float
218 | -- @return int
219 | function Ceil(value) end
220 |
221 | -- @todo
222 | -- @module native
223 | -- @submodule system
224 | -- @see ROUND
225 | -- @usage int ROUND(float value);
226 | -- @param value float
227 | -- @return int
228 | function Round(value) end
229 |
230 | -- @todo
231 | -- @module native
232 | -- @submodule system
233 | -- @see TO_FLOAT
234 | -- @usage float TO_FLOAT(int value);
235 | -- @param value int
236 | -- @return float
237 | function ToFloat(value) end
--------------------------------------------------------------------------------
/client/native/time.lua:
--------------------------------------------------------------------------------
1 | -- SET_CLOCK_TIME(12, 34, 56);
2 | -- @module native
3 | -- @submodule time
4 | -- @see SET_CLOCK_TIME
5 | -- @usage void SET_CLOCK_TIME(int hour, int minute, int second);
6 | -- @param hour int
7 | -- @param minute int
8 | -- @param second int
9 | -- @return void
10 | function SetClockTime(hour, minute, second) end
11 |
12 | -- @todo
13 | -- @module native
14 | -- @submodule time
15 | -- @see PAUSE_CLOCK
16 | -- @usage void PAUSE_CLOCK(BOOL toggle);
17 | -- @param toggle BOOL
18 | -- @return void
19 | function PauseClock(toggle) end
20 |
21 | -- @todo
22 | -- @module native
23 | -- @submodule time
24 | -- @see ADVANCE_CLOCK_TIME_TO
25 | -- @usage void ADVANCE_CLOCK_TIME_TO(int hour, int minute, int second);
26 | -- @param hour int
27 | -- @param minute int
28 | -- @param second int
29 | -- @return void
30 | function AdvanceClockTimeTo(hour, minute, second) end
31 |
32 | -- @todo
33 | -- @module native
34 | -- @submodule time
35 | -- @see ADD_TO_CLOCK_TIME
36 | -- @usage void ADD_TO_CLOCK_TIME(int hours, int minutes, int seconds);
37 | -- @param hours int
38 | -- @param minutes int
39 | -- @param seconds int
40 | -- @return void
41 | function AddToClockTime(hours, minutes, seconds) end
42 |
43 | -- Gets the current ingame hour, expressed without zeros. (09:34 will be represented as 9)
44 | -- @module native
45 | -- @submodule time
46 | -- @see GET_CLOCK_HOURS
47 | -- @usage int GET_CLOCK_HOURS();
48 | -- @return int
49 | function GetClockHours() end
50 |
51 | -- Gets the current ingame clock minute.
52 | -- @module native
53 | -- @submodule time
54 | -- @see GET_CLOCK_MINUTES
55 | -- @usage int GET_CLOCK_MINUTES();
56 | -- @return int
57 | function GetClockMinutes() end
58 |
59 | -- Gets the current ingame clock second. Note that ingame clock seconds change really fast since a day in GTA is only 48 minutes in real life.
60 | -- @module native
61 | -- @submodule time
62 | -- @see GET_CLOCK_SECONDS
63 | -- @usage int GET_CLOCK_SECONDS();
64 | -- @return int
65 | function GetClockSeconds() end
66 |
67 | -- @todo
68 | -- @module native
69 | -- @submodule time
70 | -- @see SET_CLOCK_DATE
71 | -- @usage void SET_CLOCK_DATE(int day, int month, int year);
72 | -- @param day int
73 | -- @param month int
74 | -- @param year int
75 | -- @return void
76 | function SetClockDate(day, month, year) end
77 |
78 | -- Gets the current day of the week. 0: Sunday 1: Monday 2: Tuesday 3: Wednesday 4: Thursday 5: Friday 6: Saturday
79 | -- @module native
80 | -- @submodule time
81 | -- @see GET_CLOCK_DAY_OF_WEEK
82 | -- @usage int GET_CLOCK_DAY_OF_WEEK();
83 | -- @return int
84 | function GetClockDayOfWeek() end
85 |
86 | -- @todo
87 | -- @module native
88 | -- @submodule time
89 | -- @see GET_CLOCK_DAY_OF_MONTH
90 | -- @usage int GET_CLOCK_DAY_OF_MONTH();
91 | -- @return int
92 | function GetClockDayOfMonth() end
93 |
94 | -- @todo
95 | -- @module native
96 | -- @submodule time
97 | -- @see GET_CLOCK_MONTH
98 | -- @usage int GET_CLOCK_MONTH();
99 | -- @return int
100 | function GetClockMonth() end
101 |
102 | -- @todo
103 | -- @module native
104 | -- @submodule time
105 | -- @see GET_CLOCK_YEAR
106 | -- @usage int GET_CLOCK_YEAR();
107 | -- @return int
108 | function GetClockYear() end
109 |
110 | -- @todo
111 | -- @module native
112 | -- @submodule time
113 | -- @see GET_MILLISECONDS_PER_GAME_MINUTE
114 | -- @usage int GET_MILLISECONDS_PER_GAME_MINUTE();
115 | -- @return int
116 | function GetMillisecondsPerGameMinute() end
117 |
118 | -- Gets system time as year, month, day, hour, minute and second. Example usage: int year; int month; int day; int hour; int minute; int second; TIME::GET_POSIX_TIME(&year, &month, &day, &hour, &minute, &second);
119 | -- @module native
120 | -- @submodule time
121 | -- @see GET_POSIX_TIME
122 | -- @usage void GET_POSIX_TIME(int* year, int* month, int* day, int* hour, int* minute, int* second);
123 | -- @param year int*
124 | -- @param month int*
125 | -- @param day int*
126 | -- @param hour int*
127 | -- @param minute int*
128 | -- @param second int*
129 | -- @return void
130 | function GetPosixTime(year, month, day, hour, minute, second) end
131 |
132 | -- Gets local system time as year, month, day, hour, minute and second. Example usage: int year; int month; int day; int hour; int minute; int second; or use std::tm struct TIME::GET_LOCAL_TIME(&year, &month, &day, &hour, &minute, &second);
133 | -- @module native
134 | -- @submodule time
135 | -- @see GET_LOCAL_TIME
136 | -- @usage void GET_LOCAL_TIME(int* year, int* month, int* day, int* hour, int* minute, int* second);
137 | -- @param year int*
138 | -- @param month int*
139 | -- @param day int*
140 | -- @param hour int*
141 | -- @param minute int*
142 | -- @param second int*
143 | -- @return void
144 | function GetLocalTime(year, month, day, hour, minute, second) end
--------------------------------------------------------------------------------
/client/native/unk.lua:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/TanKode/fivem-lua-sdk/6a30e597d9034140faec6a0496cbbd20e58d3687/client/native/unk.lua
--------------------------------------------------------------------------------
/client/native/unk1.lua:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/TanKode/fivem-lua-sdk/6a30e597d9034140faec6a0496cbbd20e58d3687/client/native/unk1.lua
--------------------------------------------------------------------------------
/client/native/unk2.lua:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/TanKode/fivem-lua-sdk/6a30e597d9034140faec6a0496cbbd20e58d3687/client/native/unk2.lua
--------------------------------------------------------------------------------
/client/native/unk3.lua:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/TanKode/fivem-lua-sdk/6a30e597d9034140faec6a0496cbbd20e58d3687/client/native/unk3.lua
--------------------------------------------------------------------------------
/client/native/water.lua:
--------------------------------------------------------------------------------
1 | -- This function set height to the value of z-axis of the water surface. This function works with sea and lake. However it does not work with shallow rivers (e.g. raton canyon will return -100000.0f) note: seems to return true when you are in water
2 | -- @module native
3 | -- @submodule water
4 | -- @see GET_WATER_HEIGHT
5 | -- @usage BOOL GET_WATER_HEIGHT(float x, float y, float z, float* height);
6 | -- @param x float
7 | -- @param y float
8 | -- @param z float
9 | -- @param height float*
10 | -- @return BOOL
11 | function GetWaterHeight(x, y, z, height) end
12 |
13 | -- @todo
14 | -- @module native
15 | -- @submodule water
16 | -- @see GET_WATER_HEIGHT_NO_WAVES
17 | -- @usage BOOL GET_WATER_HEIGHT_NO_WAVES(float x, float y, float z, float* height);
18 | -- @param x float
19 | -- @param y float
20 | -- @param z float
21 | -- @param height float*
22 | -- @return BOOL
23 | function GetWaterHeightNoWaves(x, y, z, height) end
24 |
25 | -- @todo
26 | -- @module native
27 | -- @submodule water
28 | -- @see TEST_PROBE_AGAINST_WATER
29 | -- @usage BOOL TEST_PROBE_AGAINST_WATER(float x1, float y1, float z1, float x2, float y2, float z2, Vector3* result);
30 | -- @param x1 float
31 | -- @param y1 float
32 | -- @param z1 float
33 | -- @param x2 float
34 | -- @param y2 float
35 | -- @param z2 float
36 | -- @param result Vector3*
37 | -- @return BOOL
38 | function TestProbeAgainstWater(x1, y1, z1, x2, y2, z2, result) end
39 |
40 | -- @todo
41 | -- @module native
42 | -- @submodule water
43 | -- @see TEST_PROBE_AGAINST_ALL_WATER
44 | -- @usage BOOL TEST_PROBE_AGAINST_ALL_WATER(Any p0, Any p1, Any p2, Any p3, Any p4, Any p5, Any p6, Any p7);
45 | -- @param p0 Any
46 | -- @param p1 Any
47 | -- @param p2 Any
48 | -- @param p3 Any
49 | -- @param p4 Any
50 | -- @param p5 Any
51 | -- @param p6 Any
52 | -- @param p7 Any
53 | -- @return BOOL
54 | function TestProbeAgainstAllWater(p0, p1, p2, p3, p4, p5, p6, p7) end
55 |
56 | -- @todo
57 | -- @module native
58 | -- @submodule water
59 | -- @see TEST_VERTICAL_PROBE_AGAINST_ALL_WATER
60 | -- @usage BOOL TEST_VERTICAL_PROBE_AGAINST_ALL_WATER(float x, float y, float z, Any p3, Any* p4);
61 | -- @param x float
62 | -- @param y float
63 | -- @param z float
64 | -- @param p3 Any
65 | -- @param p4 Any*
66 | -- @return BOOL
67 | function TestVerticalProbeAgainstAllWater(x, y, z, p3, p4) end
68 |
69 | -- Sets the water height for a given position and radius.
70 | -- @module native
71 | -- @submodule water
72 | -- @see MODIFY_WATER
73 | -- @usage void MODIFY_WATER(float x, float y, float radius, float height);
74 | -- @param x float
75 | -- @param y float
76 | -- @param radius float
77 | -- @param height float
78 | -- @return void
79 | function ModifyWater(x, y, radius, height) end
--------------------------------------------------------------------------------
/client/native/worldprobe.lua:
--------------------------------------------------------------------------------
1 | -- Returns a ray (?) going from x1, y1, z1 to x2, y2, z2. entity = 0 most of the time. p8 = 7 most of the time. Result of this function is passed to WORLDPROBE::_GET_RAYCAST_RESULT as a first argument.
2 | -- @module native
3 | -- @submodule worldprobe
4 | -- @see START_SHAPE_TEST_LOS_PROBE
5 | -- @usage int START_SHAPE_TEST_LOS_PROBE(float x1, float y1, float z1, float x2, float y2, float z2, int flags, Entity entity, int p8);
6 | -- @param x1 float
7 | -- @param y1 float
8 | -- @param z1 float
9 | -- @param x2 float
10 | -- @param y2 float
11 | -- @param z2 float
12 | -- @param flags int
13 | -- @param entity Entity
14 | -- @param p8 int
15 | -- @return int
16 | function StartShapeTestLosProbe(x1, y1, z1, x2, y2, z2, flags, entity, p8) end
17 |
18 | -- @todo
19 | -- @module native
20 | -- @submodule worldprobe
21 | -- @see START_SHAPE_TEST_BOUNDING_BOX
22 | -- @usage int START_SHAPE_TEST_BOUNDING_BOX(Entity entity, int flags1, int flags2);
23 | -- @param entity Entity
24 | -- @param flags1 int
25 | -- @param flags2 int
26 | -- @return int
27 | function StartShapeTestBoundingBox(entity, flags1, flags2) end
28 |
29 | -- @todo
30 | -- @module native
31 | -- @submodule worldprobe
32 | -- @see START_SHAPE_TEST_BOX
33 | -- @usage int START_SHAPE_TEST_BOX(float x, float y, float z, float x1, float y2, float z2, float rotX, float rotY, float rotZ, Any p9, Any p10, Any entity, Any p12);
34 | -- @param x float
35 | -- @param y float
36 | -- @param z float
37 | -- @param x1 float
38 | -- @param y2 float
39 | -- @param z2 float
40 | -- @param rotX float
41 | -- @param rotY float
42 | -- @param rotZ float
43 | -- @param p9 Any
44 | -- @param p10 Any
45 | -- @param entity Any
46 | -- @param p12 Any
47 | -- @return int
48 | function StartShapeTestBox(x, y, z, x1, y2, z2, rotX, rotY, rotZ, p9, p10, entity, p12) end
49 |
50 | -- @todo
51 | -- @module native
52 | -- @submodule worldprobe
53 | -- @see START_SHAPE_TEST_BOUND
54 | -- @usage int START_SHAPE_TEST_BOUND(Entity entity, int flags1, int flags2);
55 | -- @param entity Entity
56 | -- @param flags1 int
57 | -- @param flags2 int
58 | -- @return int
59 | function StartShapeTestBound(entity, flags1, flags2) end
60 |
61 | -- Raycast from point to point, where the ray has a radius. flags: vehicles=10 peds =12 Iterating through flags yields many ped / vehicle/ object combinations p9 = 7, but no idea what it does Entity is an entity to ignore
62 | -- @module native
63 | -- @submodule worldprobe
64 | -- @see START_SHAPE_TEST_CAPSULE
65 | -- @usage int START_SHAPE_TEST_CAPSULE(float x1, float y1, float z1, float x2, float y2, float z2, float radius, int flags, Entity entity, int p9);
66 | -- @param x1 float
67 | -- @param y1 float
68 | -- @param z1 float
69 | -- @param x2 float
70 | -- @param y2 float
71 | -- @param z2 float
72 | -- @param radius float
73 | -- @param flags int
74 | -- @param entity Entity
75 | -- @param p9 int
76 | -- @return int
77 | function StartShapeTestCapsule(x1, y1, z1, x2, y2, z2, radius, flags, entity, p9) end
78 |
79 | -- Parameters: rayHandle - Ray Handle from a casted ray, as returned by CAST_RAY_POINT_TO_POINT hit - Where to store whether or not it hit anything. False is when the ray reached its destination. endCoords - Where to store the world-coords of where the ray was stopped (by hitting its desired max range or by colliding with an entity/the map) surfaceNormal - Where to store the surface-normal coords (NOT relative to the game world) of where the entity was hit by the ray entityHit - Where to store the handle of the entity hit by the ray Returns: Result? Some type of enum. NOTE: To get the offset-coords of where the ray hit relative to the entity that it hit (which is NOT the same as surfaceNormal), you can use these two natives: Vector3 offset = ENTITY::GET_OFFSET_FROM_ENTITY_GIVEN_WORLD_COORDS(entityHit, endCoords.x, endCoords.y, endCoords.z); Vector3 entitySpotCoords = ENTITY::GET_OFFSET_FROM_ENTITY_IN_WORLD_COORDS(entityHit, offset.x, offset.y, offset.z); Use ENTITY::GET_ENTITY_TYPE(entityHit) to quickly distinguish what type of entity you hit (ped/vehicle/object - 1/2/3)
80 | -- @module native
81 | -- @submodule worldprobe
82 | -- @see GET_SHAPE_TEST_RESULT
83 | -- @usage int GET_SHAPE_TEST_RESULT(int rayHandle, BOOL* hit, Vector3* endCoords, Vector3* surfaceNormal, Entity* entityHit);
84 | -- @param rayHandle int
85 | -- @param hit BOOL*
86 | -- @param endCoords Vector3*
87 | -- @param surfaceNormal Vector3*
88 | -- @param entityHit Entity*
89 | -- @return int
90 | function GetShapeTestResult(rayHandle, hit, endCoords, surfaceNormal, entityHit) end
--------------------------------------------------------------------------------
/client/native/zone.lua:
--------------------------------------------------------------------------------
1 | -- @todo
2 | -- @module native
3 | -- @submodule zone
4 | -- @see GET_ZONE_AT_COORDS
5 | -- @usage int GET_ZONE_AT_COORDS(float x, float y, float z);
6 | -- @param x float
7 | -- @param y float
8 | -- @param z float
9 | -- @return int
10 | function GetZoneAtCoords(x, y, z) end
11 |
12 | -- 'zoneName' corresponds to an entry in 'popzone.ipl'. AIRP = Los Santos International Airport ALAMO = Alamo Sea ALTA = Alta ARMYB = Fort Zancudo BANHAMC = Banham Canyon Dr BANNING = Banning BEACH = Vespucci Beach BHAMCA = Banham Canyon BRADP = Braddock Pass BRADT = Braddock Tunnel BURTON = Burton CALAFB = Calafia Bridge CANNY = Raton Canyon CCREAK = Cassidy Creek CHAMH = Chamberlain Hills CHIL = Vinewood Hills CHU = Chumash CMSW = Chiliad Mountain State Wilderness CYPRE = Cypress Flats DAVIS = Davis DELBE = Del Perro Beach DELPE = Del Perro DELSOL = La Puerta DESRT = Grand Senora Desert DOWNT = Downtown DTVINE = Downtown Vinewood EAST_V = East Vinewood EBURO = El Burro Heights ELGORL = El Gordo Lighthouse ELYSIAN = Elysian Island GALFISH = Galilee GOLF = GWC and Golfing Society GRAPES = Grapeseed GREATC = Great Chaparral HARMO = Harmony HAWICK = Hawick HORS = Vinewood Racetrack HUMLAB = Humane Labs and Research JAIL = Bolingbroke Penitentiary KOREAT = Little Seoul LACT = Land Act Reservoir LAGO = Lago Zancudo LDAM = Land Act Dam LEGSQU = Legion Square LMESA = La Mesa LOSPUER = La Puerta MIRR = Mirror Park MORN = Morningwood MOVIE = Richards Majestic MTCHIL = Mount Chiliad MTGORDO = Mount Gordo MTJOSE = Mount Josiah MURRI = Murrieta Heights NCHU = North Chumash NOOSE = N.O.O.S.E OCEANA = Pacific Ocean PALCOV = Paleto Cove PALETO = Paleto Bay PALFOR = Paleto Forest PALHIGH = Palomino Highlands PALMPOW = Palmer-Taylor Power Station PBLUFF = Pacific Bluffs PBOX = Pillbox Hill PROCOB = Procopio Beach RANCHO = Rancho RGLEN = Richman Glen RICHM = Richman ROCKF = Rockford Hills RTRAK = Redwood Lights Track SANAND = San Andreas SANCHIA = San Chianski Mountain Range SANDY = Sandy Shores SKID = Mission Row SLAB = Stab City STAD = Maze Bank Arena STRAW = Strawberry TATAMO = Tataviam Mountains TERMINA = Terminal TEXTI = Textile City TONGVAH = Tongva Hills TONGVAV = Tongva Valley VCANA = Vespucci Canals VESP = Vespucci VINE = Vinewood WINDF = Ron Alternates Wind Farm WVINE = West Vinewood ZANCUDO = Zancudo River ZP_ORT = Port of South Los Santos ZQ_UAR = Davis Quartz
13 | -- @module native
14 | -- @submodule zone
15 | -- @see GET_ZONE_FROM_NAME_ID
16 | -- @usage int GET_ZONE_FROM_NAME_ID(char* zoneName);
17 | -- @param zoneName char*
18 | -- @return int
19 | function GetZoneFromNameId(zoneName) end
20 |
21 | -- @todo
22 | -- @module native
23 | -- @submodule zone
24 | -- @see GET_ZONE_POPSCHEDULE
25 | -- @usage int GET_ZONE_POPSCHEDULE(int zoneId);
26 | -- @param zoneId int
27 | -- @return int
28 | function GetZonePopschedule(zoneId) end
29 |
30 | -- AIRP = Los Santos International Airport ALAMO = Alamo Sea ALTA = Alta ARMYB = Fort Zancudo BANHAMC = Banham Canyon Dr BANNING = Banning BEACH = Vespucci Beach BHAMCA = Banham Canyon BRADP = Braddock Pass BRADT = Braddock Tunnel BURTON = Burton CALAFB = Calafia Bridge CANNY = Raton Canyon CCREAK = Cassidy Creek CHAMH = Chamberlain Hills CHIL = Vinewood Hills CHU = Chumash CMSW = Chiliad Mountain State Wilderness CYPRE = Cypress Flats DAVIS = Davis DELBE = Del Perro Beach DELPE = Del Perro DELSOL = La Puerta DESRT = Grand Senora Desert DOWNT = Downtown DTVINE = Downtown Vinewood EAST_V = East Vinewood EBURO = El Burro Heights ELGORL = El Gordo Lighthouse ELYSIAN = Elysian Island GALFISH = Galilee GOLF = GWC and Golfing Society GRAPES = Grapeseed GREATC = Great Chaparral HARMO = Harmony HAWICK = Hawick HORS = Vinewood Racetrack HUMLAB = Humane Labs and Research JAIL = Bolingbroke Penitentiary KOREAT = Little Seoul LACT = Land Act Reservoir LAGO = Lago Zancudo LDAM = Land Act Dam LEGSQU = Legion Square LMESA = La Mesa LOSPUER = La Puerta MIRR = Mirror Park MORN = Morningwood MOVIE = Richards Majestic MTCHIL = Mount Chiliad MTGORDO = Mount Gordo MTJOSE = Mount Josiah MURRI = Murrieta Heights NCHU = North Chumash NOOSE = N.O.O.S.E OCEANA = Pacific Ocean PALCOV = Paleto Cove PALETO = Paleto Bay PALFOR = Paleto Forest PALHIGH = Palomino Highlands PALMPOW = Palmer-Taylor Power Station PBLUFF = Pacific Bluffs PBOX = Pillbox Hill PROCOB = Procopio Beach RANCHO = Rancho RGLEN = Richman Glen RICHM = Richman ROCKF = Rockford Hills RTRAK = Redwood Lights Track SANAND = San Andreas SANCHIA = San Chianski Mountain Range SANDY = Sandy Shores SKID = Mission Row SLAB = Stab City STAD = Maze Bank Arena STRAW = Strawberry TATAMO = Tataviam Mountains TERMINA = Terminal TEXTI = Textile City TONGVAH = Tongva Hills TONGVAV = Tongva Valley VCANA = Vespucci Canals VESP = Vespucci VINE = Vinewood WINDF = Ron Alternates Wind Farm WVINE = West Vinewood ZANCUDO = Zancudo River ZP_ORT = Port of South Los Santos ZQ_UAR = Davis Quartz
31 | -- @module native
32 | -- @submodule zone
33 | -- @see GET_NAME_OF_ZONE
34 | -- @usage char* GET_NAME_OF_ZONE(float x, float y, float z);
35 | -- @param x float
36 | -- @param y float
37 | -- @param z float
38 | -- @return char*
39 | function GetNameOfZone(x, y, z) end
40 |
41 | -- @todo
42 | -- @module native
43 | -- @submodule zone
44 | -- @see SET_ZONE_ENABLED
45 | -- @usage void SET_ZONE_ENABLED(int zoneId, BOOL toggle);
46 | -- @param zoneId int
47 | -- @param toggle BOOL
48 | -- @return void
49 | function SetZoneEnabled(zoneId, toggle) end
50 |
51 | -- cellphone range 1- 5 used for signal bar in iFruit phone
52 | -- @module native
53 | -- @submodule zone
54 | -- @see GET_ZONE_SCUMMINESS
55 | -- @usage int GET_ZONE_SCUMMINESS(int zoneId);
56 | -- @param zoneId int
57 | -- @return int
58 | function GetZoneScumminess(zoneId) end
59 |
60 | -- Only used once in the decompiled scripts. Seems to be related to scripted vehicle generators. Modified example from "am_imp_exp.c4", line 6406: /* popSchedules[0] = ZONE::GET_ZONE_POPSCHEDULE(ZONE::GET_ZONE_AT_COORDS(891.3, 807.9, 188.1)); etc. */ ZONE::OVERRIDE_POPSCHEDULE_VEHICLE_MODEL(popSchedules[index], vehicleHash); STREAMING::REQUEST_MODEL(vehicleHash);
61 | -- @module native
62 | -- @submodule zone
63 | -- @see OVERRIDE_POPSCHEDULE_VEHICLE_MODEL
64 | -- @usage void OVERRIDE_POPSCHEDULE_VEHICLE_MODEL(int scheduleId, Hash vehicleHash);
65 | -- @param scheduleId int
66 | -- @param vehicleHash Hash
67 | -- @return void
68 | function OverridePopscheduleVehicleModel(scheduleId, vehicleHash) end
69 |
70 | -- Only used once in the decompiled scripts. Seems to be related to scripted vehicle generators. Modified example from "am_imp_exp.c4", line 6418: /* popSchedules[0] = ZONE::GET_ZONE_POPSCHEDULE(ZONE::GET_ZONE_AT_COORDS(891.3, 807.9, 188.1)); etc. */ STREAMING::SET_MODEL_AS_NO_LONGER_NEEDED(vehicleHash); ZONE::CLEAR_POPSCHEDULE_OVERRIDE_VEHICLE_MODEL(popSchedules[index]);
71 | -- @module native
72 | -- @submodule zone
73 | -- @see CLEAR_POPSCHEDULE_OVERRIDE_VEHICLE_MODEL
74 | -- @usage void CLEAR_POPSCHEDULE_OVERRIDE_VEHICLE_MODEL(int scheduleId);
75 | -- @param scheduleId int
76 | -- @return void
77 | function ClearPopscheduleOverrideVehicleModel(scheduleId) end
78 |
79 | -- Returns a hash representing which part of the map the given coords are located. Possible return values: (Hash of) city -> -289320599 (Hash of) countryside -> 2072609373 C# Example : Ped player = Game.Player.Character; Hash h = Function.Call(Hash.GET_HASH_OF_MAP_AREA_AT_COORDS, player.Position.X, player.Position.Y, player.Position.Z);
80 | -- @module native
81 | -- @submodule zone
82 | -- @see GET_HASH_OF_MAP_AREA_AT_COORDS
83 | -- @usage Hash GET_HASH_OF_MAP_AREA_AT_COORDS(float x, float y, float z);
84 | -- @param x float
85 | -- @param y float
86 | -- @param z float
87 | -- @return Hash
88 | function GetHashOfMapAreaAtCoords(x, y, z) end
--------------------------------------------------------------------------------