-- Native definitions
native "APP_CLEAR_BLOCK"
hash "0x5FE1DF3342DB7DBA"
jhash (0xDAB86A18)
ns "APP"
returns "void"
doc [[!
]]
native "APP_CLOSE_APP"
hash "0xE41C65E07A5F05FC"
jhash (0x03767C7A)
ns "APP"
returns "void"
doc [[!
]]
native "APP_CLOSE_BLOCK"
hash "0xE8E3FCF72EAC0EF8"
jhash (0xED97B202)
ns "APP"
returns "void"
doc [[!
]]
native "APP_DATA_VALID"
hash "0x846AA8E7D55EE5B6"
jhash (0x72BDE002)
ns "APP"
annotations [=[ {"cs_type":"int"} ]=]
returns "BOOL"
doc [[!
]]
native "APP_DELETE_APP_DATA"
hash "0x44151AEA95C8A003"
jhash (0x2A2FBD1C)
arguments {
charPtr "appName" [=[ {} ]=],
}
ns "APP"
returns "BOOL"
doc [[!
]]
native "APP_GET_DELETED_FILE_STATUS"
hash "0xC9853A2BE3DED1A6"
jhash (0x784D550B)
ns "APP"
returns "int"
doc [[!
]]
native "APP_GET_FLOAT"
hash "0x1514FB24C02C2322"
jhash (0xD87F3A1C)
arguments {
charPtr "property" [=[ {} ]=],
}
ns "APP"
returns "float"
doc [[!
]]
native "APP_GET_INT"
hash "0xD3A58A12C77D9D4B"
jhash (0x2942AAD2)
arguments {
charPtr "property" [=[ {"cs_type":"ScrHandle"} ]=],
}
ns "APP"
annotations [=[ {"cs_type":"void"} ]=]
returns "int"
doc [[!
]]
native "APP_GET_STRING"
hash "0x749B023950D2311C"
jhash (0x849CEB80)
arguments {
charPtr "property" [=[ {} ]=],
}
ns "APP"
returns "charPtr"
doc [[!
]]
native "APP_HAS_LINKED_SOCIAL_CLUB_ACCOUNT"
hash "0x71EEE69745088DA0"
jhash (0xD368BA15)
ns "APP"
returns "BOOL"
doc [[!
]]
native "APP_HAS_SYNCED_DATA"
hash "0xCA52279A7271517F"
jhash (0x1DE2A63D)
arguments {
charPtr "appName" [=[ {} ]=],
}
ns "APP"
returns "BOOL"
doc [[!
]]
native "APP_SAVE_DATA"
hash "0x95C5D356CDA6E85F"
jhash (0x84A3918D)
ns "APP"
returns "void"
doc [[!
]]
native "APP_SET_APP"
hash "0xCFD0406ADAF90D2B"
jhash (0x8BAC4146)
arguments {
charPtr "appName" [=[ {} ]=],
}
ns "APP"
returns "void"
doc [[!
```
Called in the gamescripts like:
APP::APP_SET_APP("car");
APP::APP_SET_APP("dog");
```
]]
native "APP_SET_BLOCK"
hash "0x262AB456A3D21F93"
jhash (0xC2D54DD9)
arguments {
charPtr "blockName" [=[ {} ]=],
}
ns "APP"
returns "void"
doc [[!
]]
native "APP_SET_FLOAT"
hash "0x25D7687C68E0DAA4"
jhash (0xF3076135)
arguments {
charPtr "property" [=[ {} ]=],
float "value" [=[ {} ]=],
}
ns "APP"
returns "void"
doc [[!
]]
native "APP_SET_INT"
hash "0x607E8E3D3E4F9611"
jhash (0x1B509C32)
arguments {
charPtr "property" [=[ {} ]=],
int "value" [=[ {} ]=],
}
ns "APP"
returns "void"
doc [[!
]]
native "APP_SET_STRING"
hash "0x3FF2FCEC4B7721B4"
jhash (0x23DF19A8)
arguments {
charPtr "property" [=[ {} ]=],
charPtr "value" [=[ {} ]=],
}
ns "APP"
returns "void"
doc [[!
]]
native "ADD_SCRIPT_TO_RANDOM_PED"
hash "0x4EE5367468A65CCC"
jhash (0xECC76C3D)
arguments {
charPtr "name" [=[ {} ]=],
Hash "model" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
}
ns "BRAIN"
returns "void"
doc [[!
```
BRAIN::ADD_SCRIPT_TO_RANDOM_PED("pb_prostitute", ${s_f_y_hooker_01}, 100, 0);
- Nacorpio
-----
Hardcoded to not work in Multiplayer.
```
]]
native "DISABLE_SCRIPT_BRAIN_SET"
hash "0x14D8518E9760F08F"
jhash (0xFBD13FAD)
arguments {
int "brainSet" [=[ {} ]=],
}
ns "BRAIN"
returns "void"
doc [[!
]]
native "ENABLE_SCRIPT_BRAIN_SET"
hash "0x67AA4D73F0CFA86B"
jhash (0x2765919F)
arguments {
int "brainSet" [=[ {} ]=],
}
ns "BRAIN"
returns "void"
doc [[!
]]
native "IS_OBJECT_WITHIN_BRAIN_ACTIVATION_RANGE"
hash "0xCCBA154209823057"
jhash (0xBA4CAA56)
arguments {
Object "object" [=[ {} ]=],
}
ns "BRAIN"
returns "BOOL"
doc [[!
]]
native "IS_WORLD_POINT_WITHIN_BRAIN_ACTIVATION_RANGE"
hash "0xC5042CC6F5E3D450"
jhash (0x2CF305A0)
ns "BRAIN"
returns "BOOL"
doc [[!
```
Gets whether the world point the calling script is registered to is within desired range of the player.
```
]]
native "REGISTER_OBJECT_SCRIPT_BRAIN"
hash "0x0BE84C318BA6EC22"
jhash (0xB6BCC608)
arguments {
charPtr "scriptName" [=[ {} ]=],
Hash "modelHash" [=[ {} ]=],
int "p2" [=[ {} ]=],
float "activationRange" [=[ {} ]=],
int "p4" [=[ {} ]=],
int "p5" [=[ {} ]=],
}
ns "BRAIN"
returns "void"
doc [[!
```
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);
```
]]
native "REGISTER_WORLD_POINT_SCRIPT_BRAIN"
hash "0x3CDC7136613284BD"
jhash (0x725D91F7)
arguments {
charPtr "scriptName" [=[ {"cs_type":"AnyPtr"} ]=],
float "activationRange" [=[ {} ]=],
int "p2" [=[ {} ]=],
}
ns "BRAIN"
returns "void"
doc [[!
]]
native "0x0B40ED49D7D6FF84"
hash "0x0B40ED49D7D6FF84"
jhash (0x19B27825)
ns "BRAIN"
returns "void"
doc [[!
]]
native "0x4D953DF78EBF8158"
hash "0x4D953DF78EBF8158"
jhash (0xF3A3AB08)
ns "BRAIN"
returns "void"
doc [[!
```
Something like flush_all_scripts
Most of time comes after NETWORK_END_TUTORIAL_SESSION() or before TERMINATE_THIS_THREAD()
```
]]
native "0x6D6840CEE8845831"
hash "0x6D6840CEE8845831"
jhash (0x949FE53E)
arguments {
charPtr "action" [=[ {} ]=],
}
ns "BRAIN"
returns "void"
doc [[!
```
Possible values:
act_cinema
am_mp_carwash_launch
am_mp_carwash_control
am_mp_property_ext
chop
fairgroundHub
launcher_BasejumpHeli
launcher_BasejumpPack
launcher_CarWash
launcher_golf
launcher_Hunting_Ambient
launcher_MrsPhilips
launcher_OffroadRacing
launcher_pilotschool
launcher_Racing
launcher_rampage
launcher_rampage
launcher_range
launcher_stunts
launcher_stunts
launcher_tennis
launcher_Tonya
launcher_Triathlon
launcher_Yoga
ob_mp_bed_low
ob_mp_bed_med
```
]]
native "0x6E91B04E08773030"
hash "0x6E91B04E08773030"
jhash (0x29CE8BAA)
arguments {
charPtr "action" [=[ {} ]=],
}
ns "BRAIN"
returns "void"
doc [[!
```
Looks like a cousin of above function _6D6840CEE8845831 as it was found among them. Must be similar
Here are possible values of argument -
"ob_tv"
"launcher_Darts"
```
]]
native "ACTIVATE_AUDIO_SLOWMO_MODE"
hash "0xD01005D2BA2EB778"
jhash (0x59A3A17D)
arguments {
charPtr "mode" [=[ {} ]=],
}
alias "0xD01005D2BA2EB778"
ns "AUDIO"
returns "void"
doc [[!
Below is a list of modes and their respective hashes.
| Mode (string) | Hash |
|-----------------------------|--------------------|
| SLOWMO_BIG_SCORE_JUMP | 0x2B981B0C |
| JSH_EXIT_TUNNEL_SLOWMO | 0x2562AA6 |
| SLOW_MO_METH_HOUSE_RAYFIRE | 0xDB9E1909 |
| SLOWMO_FIB4\_TRUCK_SMASH | 0x9E144347 |
| SLOWMO_PROLOGUE_VAULT | 0xEA2E68E1 |
| SLOWMO_T1\_RAYFIRE_EXPLOSION | 0xD6D358F3 |
| SLOWMO_T1\_TRAILER_SMASH | 0xBE607345 |
| BARRY\_01\_SLOWMO | 0xD59540D4 |
| BARRY\_02\_SLOWMO | 0x12F140B3 |
| SLOWMO_EXTREME\_04 | 0xF562EA50 |
| NIGEL\_02\_SLOWMO_SETTING | 0x384689B0 |
A string indicating the audio slow motion mode to use, *see the table*.
]]
native "ADD_ENTITY_TO_AUDIO_MIX_GROUP"
hash "0x153973AB99FE8980"
jhash (0x2BC93264)
arguments {
Entity "entity" [=[ {} ]=],
charPtr "groupName" [=[ {} ]=],
float "fadeIn" [=[ {} ]=],
}
alias "0x153973AB99FE8980"
alias "_DYNAMIC_MIXER_RELATED_FN"
ns "AUDIO"
returns "void"
doc [[!
```
All found occurrences in b678d:
pastebin.com/ceu67jz8
```
]]
native "ADD_LINE_TO_CONVERSATION"
hash "0xC5EF963405593646"
jhash (0x96CD0513)
arguments {
int "speakerConversationIndex" [=[ {} ]=],
charPtr "context" [=[ {} ]=],
charPtr "subtitle" [=[ {} ]=],
int "listenerNumber" [=[ {} ]=],
int "volumeType" [=[ {} ]=],
BOOL "isRandom" [=[ {} ]=],
BOOL "interruptible" [=[ {} ]=],
BOOL "ducksRadio" [=[ {} ]=],
BOOL "ducksScore" [=[ {} ]=],
int "audibility" [=[ {} ]=],
BOOL "headset" [=[ {} ]=],
BOOL "dontInterruptForSpecialAbility" [=[ {} ]=],
BOOL "isPadSpeakerRoute" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
```cpp
enum eAudibility {
AUD_AUDIBILITY_NORMAL = 0,
AUD_AUDIBILITY_CLEAR = 1,
AUD_AUDIBILITY_CRITICAL = 2,
AUD_AUDIBILITY_LEAD_IN = 3
}
```
See eAudibility
]]
native "ADD_PED_TO_CONVERSATION"
hash "0x95D9F4BC443956E7"
jhash (0xF8D5EB86)
arguments {
int "speakerConversationIndex" [=[ {} ]=],
Ped "ped" [=[ {} ]=],
charPtr "voiceName" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
]]
native "AUDIO_IS_SCRIPTED_MUSIC_PLAYING"
hash "0x845FFC3A4FEEFA3E"
jhash (0x86E995D1)
alias "0x3D120012440E6683"
ns "AUDIO"
annotations [=[ {"cs_type":"Any"} ]=]
returns "BOOL"
doc [[!
]]
native "BLIP_SIREN"
hash "0x1B9025BDA76822B6"
jhash (0xC0EB6924)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
Plays a siren blip from the vehicle when you double press the horn key.
This only works on vehicles with sirens.
]]
native "BLOCK_ALL_SPEECH_FROM_PED"
hash "0xF8AD2EED7C47E8FE"
arguments {
Ped "ped" [=[ {} ]=],
BOOL "shouldBlock" [=[ {} ]=],
BOOL "suppressOutgoingNetworkSpeech" [=[ {} ]=],
}
alias "0xF8AD2EED7C47E8FE"
ns "AUDIO"
returns "void"
doc [[!
Blocks *all* speech playing on the given ped, including speech triggered by natives such as [PLAY_PED_AMBIENT_SPEECH_WITH_VOICE_NATIVE](#\_0x3523634255FC3318)
The flag itself is not synced, it must be called on each machine that wishes to suppress the speech.
The `SuppressOutgoingNetworkSpeech` flag can be set to `false` if you want speech triggered locally through `PLAY_PED_AMBIENT_SPEECH_*` related native calls to still be audible on remote machines, even though it was blocked on the local one.
Defaults to `true`.
]]
native "BLOCK_DEATH_JINGLE"
hash "0xF154B8D1775B2DEC"
jhash (0xD2858D8A)
arguments {
BOOL "blocked" [=[ {} ]=],
}
alias "0xF154B8D1775B2DEC"
ns "AUDIO"
returns "void"
doc [[!
Sets if the death jingle can play when a player dies or not
]]
native "BLOCK_SPEECH_CONTEXT_GROUP"
hash "0xA8A7D434AFB4B97B"
arguments {
charPtr "groupName" [=[ {} ]=],
int "contextBlockTarget" [=[ {} ]=],
}
alias "0xA8A7D434AFB4B97B"
ns "AUDIO"
returns "void"
doc [[!
```cpp
enum eAudContextBlockTarget {
AUD_CONTEXT_BLOCK_PLAYER = 0,
AUD_CONTEXT_BLOCK_NPCS = 1,
AUD_CONTEXT_BLOCK_BUDDYS = 2,
AUD_CONTEXT_BLOCK_EVERYONE = 3,
AUD_CONTEXT_BLOCK_TARGETS_TOTAL
}
```
Stop a certain group of peds from using a certain group of speech contexts.
Note that the block will be automatically removed when the calling script finishes
the name of the context group to be blocked
the group of peds that should be used (refer to eAudContextBlockTarget)
]]
native "CAN_VEHICLE_RECEIVE_CB_RADIO"
hash "0x032A116663A4D5AC"
jhash (0xCBA99F4A)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "_IS_VEHICLE_RADIO_LOUD"
ns "AUDIO"
returns "BOOL"
doc [[!
Returns true if the vehicle can currently receive CB radio (ie. it has a capable radio and is in range of a transmitter)
]]
native "CANCEL_ALL_POLICE_REPORTS"
hash "0xB4F90FAF7670B16F"
alias "0xB4F90FAF7670B16F"
alias "_DISABLE_POLICE_REPORTS"
alias "_CANCEL_CURRENT_POLICE_REPORT"
ns "AUDIO"
returns "void"
doc [[!
]]
native "CANCEL_MUSIC_EVENT"
hash "0x5B17A90291133DA5"
jhash (0x89FF942D)
arguments {
charPtr "eventName" [=[ {} ]=],
}
ns "AUDIO"
returns "BOOL"
doc [[!
```
All music event names found in the b617d scripts: pastebin.com/GnYt0R3P
```
the name of the event to cancel
True of the event was cancelled, false otherwise.
]]
native "CLEAR_ALL_BROKEN_GLASS"
hash "0xB32209EFFDC04913"
jhash (0xE6B033BF)
ns "AUDIO"
returns "void"
doc [[!
]]
native "CLEAR_AMBIENT_ZONE_LIST_STATE"
hash "0x120C48C614909FA4"
jhash (0x38B9B8D4)
arguments {
charPtr "zoneListName" [=[ {"cs_type":"AnyPtr"} ]=],
BOOL "forceUpdate" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
Resets the list of ambients zones enabled/disabled status to its value before it was modified by this script.
Default behaviour is that any state change only gets applied once the player leaves the zone.
The zone name to clear
Whether ot not to force a zone to become disabled even if its currently active
]]
native "CLEAR_AMBIENT_ZONE_STATE"
hash "0x218DD44AAAC964FF"
jhash (0xCDFF3C82)
arguments {
charPtr "zoneName" [=[ {} ]=],
BOOL "forceUpdate" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
Resets the ambient zone enabled/disabled status to its value before it was modified by this script
Default behaviour is that any state change only gets applied once the player leaves the zone.
the zone name to clear
Whether ot not to force a zone to become disabled even if its currently active
]]
native "CLEAR_CUSTOM_RADIO_TRACK_LIST"
hash "0x1654F24A88A8E3FE"
jhash (0x1D766976)
arguments {
charPtr "radioStation" [=[ {} ]=],
}
alias "0x1654F24A88A8E3FE"
ns "AUDIO"
returns "void"
doc [[!
Clears the previously queued custom track lost for the given radio station.
]]
native "CREATE_NEW_SCRIPTED_CONVERSATION"
hash "0xD2C91A0B572AAE56"
jhash (0xB2BC25F8)
ns "AUDIO"
returns "void"
doc [[!
]]
native "DEACTIVATE_AUDIO_SLOWMO_MODE"
hash "0xDDC635D5B3262C56"
jhash (0x0E387BFE)
arguments {
charPtr "mode" [=[ {} ]=],
}
alias "0xDDC635D5B3262C56"
ns "AUDIO"
returns "void"
doc [[!
Deactivates the named slowmo mode.
name of the mode to deactivate
]]
native "DISABLE_PED_PAIN_AUDIO"
hash "0xA9A41C1E940FB0E8"
jhash (0x3B8E2D5F)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "shouldDisable" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
]]
native "DISTANT_COP_CAR_SIRENS"
hash "0x552369F549563AD5"
jhash (0x13EB5861)
arguments {
BOOL "shouldPlay" [=[ {} ]=],
}
alias "0x552369F549563AD5"
alias "_FORCE_AMBIENT_SIREN"
ns "AUDIO"
returns "void"
doc [[!
Toggles fake distant siren sounds
True will play distand sounds, false will disable them.
]]
native "DOES_CONTEXT_EXIST_FOR_THIS_PED"
hash "0x49B99BF3FDA89A7A"
jhash (0x8BD5F11E)
arguments {
Ped "ped" [=[ {} ]=],
charPtr "speechName" [=[ {} ]=],
BOOL "allowBackupPVGs" [=[ {} ]=],
}
alias "0x49B99BF3FDA89A7A"
alias "_CAN_PED_SPEAK"
ns "AUDIO"
returns "BOOL"
doc [[!
Checks if the context exists for the ped, searching through the voices in its PedVoiceGroup.
The final argument can be set to true to allow searching in backup PVGs
True of the PedVoiceGroup exists, false otherwise.
]]
native "DOES_PLAYER_VEH_HAVE_RADIO"
hash "0x109697E2FFBAC8A1"
jhash (0x46B0C696)
alias "0x109697E2FFBAC8A1"
ns "AUDIO"
returns "BOOL"
doc [[!
]]
native "ENABLE_STALL_WARNING_SOUNDS"
hash "0xC15907D667F7CFB2"
jhash (0x563B635D)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "enable" [=[ {} ]=],
}
alias "0xC15907D667F7CFB2"
ns "AUDIO"
returns "void"
doc [[!
Enable or disable the plane stall warning sounds
]]
native "ENABLE_STUNT_JUMP_AUDIO"
hash "0xB81CF134AEB56FFB"
alias "0xB81CF134AEB56FFB"
ns "AUDIO"
returns "void"
doc [[!
Enable the stunt jump audio detection code
This native is meant to be called per-frame for as long as detection is wanted.
]]
native "ENABLE_VEHICLE_EXHAUST_POPS"
hash "0x2BE4BC731D039D5A"
jhash (0x2A60A90E)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x2BE4BC731D039D5A"
ns "AUDIO"
returns "void"
doc [[!
Enable or disable exhaust pops on the given vehicle.
Enables or disables exaust pops.
]]
native "ENABLE_VEHICLE_FANBELT_DAMAGE"
hash "0x1C073274E065C6D2"
jhash (0x9365E042)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "enableFanbeltDamage" [=[ {} ]=],
}
alias "0x1C073274E065C6D2"
ns "AUDIO"
returns "void"
doc [[!
Enables fanbelt damage
]]
native "FIND_RADIO_STATION_INDEX"
hash "0x8D67489793FF428B"
jhash (0xECA1512F)
arguments {
int "stationNameHash" [=[ {} ]=],
}
ns "AUDIO"
returns "int"
doc [[!
the station name hash to search for
The station index for the specified hash, or 254 if the radio station did not exist.
]]
native "FORCE_MUSIC_TRACK_LIST"
hash "0x4E0AF9114608257C"
arguments {
charPtr "radioStation" [=[ {} ]=],
charPtr "trackListName" [=[ {} ]=],
int "timeOffsetMilliseconds" [=[ {} ]=],
}
alias "0x4E0AF9114608257C"
alias "_FORCE_RADIO_TRACK_LIST_POSITION"
ns "AUDIO"
returns "void"
doc [[!
Forces the chosen station to paly the given music track list. All other music track lists will be locked.
]]
native "FORCE_PED_PANIC_WALLA"
hash "0x062D5EAD4DA2FA6A"
jhash (0xD87AF337)
alias "0x062D5EAD4DA2FA6A"
ns "AUDIO"
returns "void"
doc [[!
Forces the ambient peds into their panic walla state
]]
native "FORCE_USE_AUDIO_GAME_OBJECT"
hash "0x4F0C413926060B38"
jhash (0x33B0B007)
arguments {
Vehicle "vehicle" [=[ {} ]=],
charPtr "gameObjectName" [=[ {} ]=],
}
alias "0x4F0C413926060B38"
alias "_SET_VEHICLE_AUDIO"
alias "_FORCE_VEHICLE_ENGINE_AUDIO"
ns "AUDIO"
returns "void"
doc [[!
This native sets the audio to the specific vehicle hash's audioNameHash.
]]
native "FREEZE_MICROPHONE"
hash "0xD57AAAE0E2214D11"
jhash (0x2B9D91E8)
alias "0xD57AAAE0E2214D11"
ns "AUDIO"
returns "void"
doc [[!
Allows script to freeze the microphone for a single frame, mantaining its current transform/settings.
This native should be called every frame you want to keep the microphone frozen, when you stop calling it it will automatically unfreeze
]]
native "FREEZE_RADIO_STATION"
hash "0x344F393B027E38C3"
jhash (0x286BF543)
arguments {
charPtr "radioStation" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
]]
native "GET_AMBIENT_VOICE_NAME_HASH"
hash "0x5E203DA2BA15D436"
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0x5E203DA2BA15D436"
alias "_GET_AMBIENT_VOICE_NAME_HASH"
ns "AUDIO"
annotations [=[ {"cs_type":"Any"} ]=]
returns "Hash"
doc [[!
The hash of the voice name in use by the ped.
]]
native "GET_AUDIBLE_MUSIC_TRACK_TEXT_ID"
hash "0x50B196FC9ED6545B"
jhash (0xA2B88CA7)
ns "AUDIO"
returns "int"
doc [[!
]]
native "GET_CURRENT_SCRIPTED_CONVERSATION_LINE"
hash "0x480357EE890C295A"
jhash (0x9620E41F)
ns "AUDIO"
returns "int"
doc [[!
]]
native "GET_CURRENT_TRACK_SOUND_NAME"
hash "0x34D66BC058019CE0"
arguments {
charPtr "radioStationName" [=[ {} ]=],
}
alias "0x34D66BC058019CE0"
alias "_GET_CURRENT_RADIO_TRACK_NAME"
ns "AUDIO"
returns "Hash"
doc [[!
The current sound name as a hash for the currently playing track on the given station.
]]
native "GET_IS_PRELOADED_CONVERSATION_READY"
hash "0xE73364DB90778FFA"
jhash (0x336F3D35)
alias "0xE73364DB90778FFA"
ns "AUDIO"
returns "BOOL"
doc [[!
Returns true if the preloaded conversation has finished preparing.
]]
native "GET_MUSIC_PLAYTIME"
hash "0xE7A0D23DC414507B"
jhash (0xD633C809)
ns "AUDIO"
returns "int"
doc [[!
Returns the play time in milliseconds of the current score track.
]]
native "GET_MUSIC_VOL_SLIDER"
hash "0x3A48AB4445D499BE"
jhash (0x93A44A1F)
alias "0x3A48AB4445D499BE"
ns "AUDIO"
returns "int"
doc [[!
Returns the current volume slider position from 0 to 10
]]
native "GET_NETWORK_ID_FROM_SOUND_ID"
hash "0x2DE3F0A134FFBC0D"
jhash (0x2576F610)
arguments {
int "soundId" [=[ {} ]=],
}
ns "AUDIO"
returns "int"
doc [[!
Returns the network id for the specific sound
]]
native "GET_NEXT_AUDIBLE_BEAT"
hash "0xC64A06D939F826F5"
arguments {
floatPtr "timeInSeconds" [=[ {} ]=],
floatPtr "bpm" [=[ {"cs_type":"AnyPtr"} ]=],
intPtr "beatNum" [=[ {} ]=],
}
alias "0xC64A06D939F826F5"
ns "AUDIO"
returns "BOOL"
doc [[!
time in seconds until the start of the next beat
current tempo in beats per minute,
integer beat within the bar
Returns information on beat information for any audible music.
]]
native "GET_NUM_UNLOCKED_RADIO_STATIONS"
hash "0xF1620ECB50E01DE7"
jhash (0xCC91FCF5)
alias "_MAX_RADIO_STATION_INDEX"
ns "AUDIO"
returns "int"
doc [[!
Returns the number of radio stations currently unlocked in the game. This can change as a result of DLC and/or script calls.
]]
native "GET_PLAYER_RADIO_STATION_GENRE"
hash "0xA571991A7FE6CCEB"
jhash (0x872CF0EA)
ns "AUDIO"
returns "int"
doc [[!
Returns the genre of the players current radio station
]]
native "GET_PLAYER_RADIO_STATION_INDEX"
hash "0xE8AF77C4C06ADC93"
jhash (0x1C4946AC)
ns "AUDIO"
returns "int"
doc [[!
Returns the index of the current players radio station, or 255 if the radio is off
]]
native "GET_PLAYER_RADIO_STATION_NAME"
hash "0xF6D733C32076AD03"
jhash (0xD909C107)
ns "AUDIO"
returns "charPtr"
doc [[!
Returns the name of the players radio station. This serves as the text label.
]]
native "GET_RADIO_STATION_NAME"
hash "0xB28ECA15046CA8B9"
jhash (0x3DF493BC)
arguments {
int "stationIndex" [=[ {} ]=],
}
ns "AUDIO"
returns "charPtr"
doc [[!
Returns the name of the radio station with the specified index. This serves as the text label.
]]
native "GET_SOUND_ID"
hash "0x430386FE9BF80B45"
jhash (0x6AE0AD56)
ns "AUDIO"
returns "int"
doc [[!
If a playback function has a soundId field but the sound doesn't need to be altered after triggering then pass a value of -1 for fire-and-forget playback, rather than getting a soundId.
SoundId's can be reused, without needing to release them and grab a new one.
If a sound's finished playing, you can reuse its SoundId to kick off another one.
If the sound's not finished playing, it'll be stopped first (fading out or whatever is set up in RAVE by the sound designer), and the new one kicked off; usually it is safer to just get a new SoundId.
SoundId's are not automatically cleaned up, you must use [RELEASE_SOUND_ID](#\_0x353FC880830B88FA) after you've finished using them to allow the engine to recycle the sound id.
Returns a sound id which can be used to control the sound after its has started playing.
]]
native "GET_SOUND_ID_FROM_NETWORK_ID"
hash "0x75262FD12D0A1C84"
jhash (0xD064D4DC)
arguments {
int "netId" [=[ {} ]=],
}
alias "0x75262FD12D0A1C84"
ns "AUDIO"
returns "int"
doc [[!
Counterpart: [`GET_NETWORK_ID_FROM_SOUND_ID`](#\_0x2DE3F0A134FFBC0D).
Network ID of sound.
Integer representing a sound id, -1 on failure.
]]
native "GET_STREAM_PLAY_TIME"
hash "0x4E72BBDBCA58A3DB"
jhash (0xB4F0AD56)
ns "AUDIO"
returns "int"
doc [[!
Returns the currently playing stream's play time
]]
native "GET_VARIATION_CHOSEN_FOR_SCRIPTED_LINE"
hash "0xAA19F5572C38B564"
jhash (0xB58B8FF3)
arguments {
charPtr "textLabel" [=[ {"cs_type":"AnyPtr"} ]=],
}
alias "0xAA19F5572C38B564"
ns "AUDIO"
returns "int"
doc [[!
all the text labels for filenames in `AmericanDialogueFiles.txt` appear to end with the letter 'A', it is the script's responsibility to add this 'A' before calling `GET_VARIATION_CHOSEN_FOR_SCRIPTED_LINE`.
Returns the variation chosen for a given script speech line, or `0` if it hasn't been chosen yet.Returns `-1` if there is no conversation active or if the active conversation doesn't contain this line or if the text label can't be found in the currently loaded text blocks
]]
native "GET_VEHICLE_DEFAULT_HORN"
hash "0x02165D55000219AC"
jhash (0xE84ABC19)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "AUDIO"
returns "Hash"
doc [[!
Returns the horn sound hash
]]
native "GET_VEHICLE_DEFAULT_HORN_IGNORE_MODS"
hash "0xACB5DCCA1EC76840"
jhash (0xFD4B5B3B)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0xACB5DCCA1EC76840"
alias "_GET_VEHICLE_HORN_HASH"
ns "AUDIO"
returns "Hash"
doc [[!
Returns the horn sound hash ignoring any horn mods applied to the car
]]
native "GET_VEHICLE_HORN_SOUND_INDEX"
hash "0xD53F3A29BCE2580E"
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0xD53F3A29BCE2580E"
alias "0x22FECB546C276A30"
alias "_GET_VEHICLE_DEFAULT_HORN_VARIATION"
ns "AUDIO"
returns "int"
doc [[!
```
NativeDB Introduced: v1365
```
The current horn sound index being used by the given vehicle
]]
native "HAS_LOADED_MP_DATA_SET"
hash "0x544810ED9DB6BBE6"
alias "0x544810ED9DB6BBE6"
alias "_HAS_MULTIPLAYER_AUDIO_DATA_LOADED"
ns "AUDIO"
returns "BOOL"
doc [[!
Returns true if the audio for the Multiplayer data set has loaded
]]
native "HAS_LOADED_SP_DATA_SET"
hash "0x5B50ABB1FE3746F4"
alias "0x5B50ABB1FE3746F4"
alias "_HAS_MULTIPLAYER_AUDIO_DATA_UNLOADED"
ns "AUDIO"
returns "BOOL"
doc [[!
Returns true if the audio for the Single Player data set has loaded
]]
native "HAS_SOUND_FINISHED"
hash "0xFCBDCE714A7C88E5"
jhash (0xE85AEC2E)
arguments {
int "soundId" [=[ {} ]=],
}
ns "AUDIO"
returns "BOOL"
doc [[!
Returns true if the sound has finished playing, false otherwise.
]]
native "HINT_AMBIENT_AUDIO_BANK"
hash "0x8F8C0E370AE62F5C"
jhash (0xF1850DDC)
arguments {
charPtr "bankName" [=[ {"cs_type":"Any"} ]=],
BOOL "bOverNetwork" [=[ {"cs_type":"Any"} ]=],
}
ns "AUDIO"
annotations [=[ {"cs_type":"Any"} ]=]
returns "BOOL"
doc [[!
This native is marked as a deprecated native internally, use [HINT_SCRIPT_AUDIO_BANK](#\_0xFB380A29641EC31A) instead
]]
native "HINT_MISSION_AUDIO_BANK"
hash "0x40763EA7B9B783E7"
arguments {
charPtr "bankName" [=[ {} ]=],
BOOL "bOverNetwork" [=[ {"cs_type":"int"} ]=],
int "playerBits" [=[ {} ]=],
}
alias "0x40763EA7B9B783E7"
ns "AUDIO"
annotations [=[ {"cs_type":"Any"} ]=]
returns "BOOL"
doc [[!
This is marked as a deprecated function internally, please use [HINT_SCRIPT_AUDIO_BANK](#\_0xFB380A29641EC31A) instead.
]]
native "HINT_SCRIPT_AUDIO_BANK"
hash "0xFB380A29641EC31A"
jhash (0x41FA0E51)
arguments {
charPtr "bankName" [=[ {"cs_type":"Any"} ]=],
BOOL "bOverNetwork" [=[ {"cs_type":"int"} ]=],
}
ns "AUDIO"
annotations [=[ {"cs_type":"Any"} ]=]
returns "BOOL"
doc [[!
Hints that this bank would be good to load if there are free slots.
Does not guarentee loading of the bank, [REQUEST_SCRIPT_AUDIO_BANK](#\_0xFE02FFBED8CA9D99) MUST be used as normal before triggering sounds"
This native has a new argument on newer game builds:
* **playerBits**: likely used to specifiy players to sync to as a bit mask (1 << (0-128))
]]
native "INIT_SYNCH_SCENE_AUDIO_WITH_ENTITY"
hash "0x950A154B8DAB6185"
jhash (0xA17F9AB0)
arguments {
charPtr "audioName" [=[ {} ]=],
Entity "entity" [=[ {} ]=],
}
alias "0x950A154B8DAB6185"
alias "_SET_SYNCHRONIZED_AUDIO_EVENT_POSITION_THIS_FRAME"
ns "AUDIO"
returns "void"
doc [[!
]]
native "INIT_SYNCH_SCENE_AUDIO_WITH_POSITION"
hash "0xC8EDE9BDBCCBA6D4"
jhash (0x55A21772)
arguments {
charPtr "audioName" [=[ {"cs_type":"AnyPtr"} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
alias "0xC8EDE9BDBCCBA6D4"
ns "AUDIO"
returns "void"
doc [[!
]]
native "INTERRUPT_CONVERSATION"
hash "0xA018A12E5C5C2FA6"
jhash (0xF3A67AF3)
arguments {
Ped "interrupterPed" [=[ {} ]=],
charPtr "context" [=[ {"cs_type":"AnyPtr"} ]=],
charPtr "voiceName" [=[ {"cs_type":"AnyPtr"} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
Handles conversation interrupts, using the code-side system for improved timing and to minimize unfriendly logic interactions.
the ped speaking
the line to use
the voicename for the audio asset
]]
native "INTERRUPT_CONVERSATION_AND_PAUSE"
hash "0x8A694D7A68F8DC38"
jhash (0xDD4A3F1F)
arguments {
Ped "interrupterPed" [=[ {} ]=],
charPtr "context" [=[ {} ]=],
charPtr "voiceName" [=[ {} ]=],
}
alias "0x8A694D7A68F8DC38"
ns "AUDIO"
returns "void"
doc [[!
Handles conversation interrupts and pauses, using the code-side system for improved timing and to minimize unfriendly logic interactions.
the ped speaking
the line to use
the voicename for the audio asset
]]
native "IS_ALARM_PLAYING"
hash "0x226435CB96CCFC8C"
jhash (0x9D8E1D23)
arguments {
charPtr "alarmName" [=[ {} ]=],
}
ns "AUDIO"
returns "BOOL"
doc [[!
Returns true if an alarm is currently playing with the specified name
]]
native "IS_AMBIENT_SPEECH_DISABLED"
hash "0x932C2D096A2C3FFF"
jhash (0x109D1F89)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "AUDIO"
returns "BOOL"
doc [[!
Returns true if ambient speech for the ped has been disabled
]]
native "IS_AMBIENT_SPEECH_PLAYING"
hash "0x9072C8B49907BFAD"
jhash (0x1972E8AA)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "AUDIO"
returns "BOOL"
doc [[!
Returns true if the ped is currently playing ambient speech
]]
native "IS_AMBIENT_ZONE_ENABLED"
hash "0x01E2817A479A7F9B"
jhash (0xBFABD872)
arguments {
charPtr "ambientZone" [=[ {} ]=],
}
ns "AUDIO"
returns "BOOL"
doc [[!
Returns true if the given ambient zone is allowed to be active
]]
native "IS_ANIMAL_VOCALIZATION_PLAYING"
hash "0xC265DF9FB44A9FBD"
jhash (0x0CBAF2EF)
arguments {
Ped "pedHandle" [=[ {} ]=],
}
alias "0xC265DF9FB44A9FBD"
ns "AUDIO"
returns "BOOL"
doc [[!
Returns true of the ped is currently playing animal sounds
]]
native "IS_ANY_POSITIONAL_SPEECH_PLAYING"
hash "0x30CA2EF91D15ADF8"
alias "0x30CA2EF91D15ADF8"
ns "AUDIO"
annotations [=[ {"cs_type":"Any"} ]=]
returns "BOOL"
doc [[!
Determines if any ped-independent, positionally-based scripted speech is currently active. This typically includes speech events triggered using [`PLAY_AMBIENT_SPEECH_FROM_POSITION_NATIVE`](#\_0xED640017ED337E45).
```
NativeDB Introduced: v2189
```
Returns `true` if any ped-independent positional scripted speech (i.e. triggered using [PLAY_AMBIENT_SPEECH_FROM_POSITION_NATIVE](#\_0xED640017ED337E45)) is currently playing, `false` otherwise.
]]
native "IS_ANY_SPEECH_PLAYING"
hash "0x729072355FA39EC9"
jhash (0x2B74A6D6)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "AUDIO"
returns "BOOL"
doc [[!
Returns true if the specified ped is playing any speech
]]
native "IS_AUDIO_SCENE_ACTIVE"
hash "0xB65B60556E2A9225"
jhash (0xACBED05C)
arguments {
charPtr "scene" [=[ {} ]=],
}
ns "AUDIO"
returns "BOOL"
doc [[!
the name of the scene
Returns true if the script is already running the named scene, false otherwise
]]
native "IS_GAME_IN_CONTROL_OF_MUSIC"
hash "0x6D28DC1671E334FD"
jhash (0x7643170D)
ns "AUDIO"
returns "BOOL"
doc [[!
```
Hardcoded to return 1
```
]]
native "IS_HORN_ACTIVE"
hash "0x9D6BFC12B05C6121"
jhash (0x20E2BDD0)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "AUDIO"
returns "BOOL"
doc [[!
Returns true if the vehicle is currently playing a horn sound
]]
native "IS_MISSION_COMPLETE_PLAYING"
hash "0x19A30C23F5827F8A"
jhash (0x939982A1)
ns "AUDIO"
returns "BOOL"
doc [[!
Returns true if the mission complete audio is playing
]]
native "IS_MISSION_COMPLETE_READY_FOR_UI"
hash "0x6F259F82D873B8B8"
jhash (0xCBE09AEC)
alias "0x6F259F82D873B8B8"
ns "AUDIO"
returns "BOOL"
doc [[!
Returns true if the script should draw the mission complete UI to be in sync with audio.
]]
native "IS_MISSION_NEWS_STORY_UNLOCKED"
hash "0x66E49BF55B4B1874"
jhash (0x27305D37)
arguments {
int "newsStory" [=[ {} ]=],
}
alias "GET_NUMBER_OF_PASSENGER_VOICE_VARIATIONS"
ns "AUDIO"
annotations [=[ {"cs_type":"int"} ]=]
returns "BOOL"
doc [[!
Returns true of the specific story is available to be played back
]]
native "IS_MOBILE_INTERFERENCE_ACTIVE"
hash "0xC8B1B2425604CDD0"
jhash (0x16FB88B5)
alias "0xC8B1B2425604CDD0"
ns "AUDIO"
returns "BOOL"
doc [[!
Returns true of mobile phone interference is currently happening
]]
native "IS_MOBILE_PHONE_CALL_ONGOING"
hash "0x7497D2CE2C30D24C"
jhash (0x4ED1400A)
ns "AUDIO"
returns "BOOL"
doc [[!
Returns true of a mobile phone call is currently happening.
]]
native "IS_MOBILE_PHONE_RADIO_ACTIVE"
hash "0xB35CE999E8EF317E"
jhash (0x6E502A5B)
ns "AUDIO"
returns "BOOL"
doc [[!
Returns true if the mobile phone radio is active
]]
native "IS_MUSIC_ONESHOT_PLAYING"
hash "0xA097AB275061FB21"
jhash (0x2705C4D5)
alias "0xA097AB275061FB21"
ns "AUDIO"
returns "BOOL"
doc [[!
Returns true if a one shot is currently playing or prepared
]]
native "IS_PED_IN_CURRENT_CONVERSATION"
hash "0x049E937F18F4020C"
jhash (0x7B2F0743)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "AUDIO"
returns "BOOL"
doc [[!
Returns true if the ped is in the currently playing conversation
]]
native "IS_PED_RINGTONE_PLAYING"
hash "0x1E8E5E20937E3137"
jhash (0xFE576EE4)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "AUDIO"
returns "BOOL"
doc [[!
Returns true if the peds ringtone is currently playing
]]
native "IS_PLAYER_VEH_RADIO_ENABLE"
hash "0x5F43D83FD6738741"
jhash (0x2A3E5E8B)
alias "0x5F43D83FD6738741"
alias "_IS_PLAYER_VEHICLE_RADIO_ENABLED"
ns "AUDIO"
returns "BOOL"
doc [[!
]]
native "IS_RADIO_FADED_OUT"
hash "0x0626A247D2405330"
jhash (0x815CAE99)
alias "0x0626A247D2405330"
ns "AUDIO"
returns "BOOL"
doc [[!
Returns true if the radio is currently faded out
]]
native "IS_RADIO_RETUNING"
hash "0xA151A7394A214E65"
jhash (0xCF29097B)
ns "AUDIO"
returns "BOOL"
doc [[!
Returns true if the radio is tuning to a station
]]
native "IS_RADIO_STATION_FAVOURITED"
hash "0x2B1784DB08AFEA79"
arguments {
charPtr "radioStation" [=[ {} ]=],
}
alias "_IS_RADIO_STATION_VISIBLE"
ns "AUDIO"
returns "BOOL"
doc [[!
Returns whether a radio station is a favourite.
]]
native "IS_SCRIPTED_CONVERSATION_LOADED"
hash "0xDF0D54BE7A776737"
jhash (0xE1870EA9)
ns "AUDIO"
returns "BOOL"
doc [[!
Returns true if the first batch of lines for the currently requested conversation have loaded successfully.
]]
native "IS_SCRIPTED_CONVERSATION_ONGOING"
hash "0x16754C556D2EDE3D"
jhash (0xCB8FD96F)
ns "AUDIO"
returns "BOOL"
doc [[!
]]
native "IS_SCRIPTED_SPEECH_PLAYING"
hash "0xCC9AA18DCC7084F4"
jhash (0x2C653904)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "AUDIO"
returns "BOOL"
doc [[!
Returns true if scripted speech is currently playing from the given ped.
]]
native "IS_STREAM_PLAYING"
hash "0xD11FA52EB849D978"
jhash (0xF1F51A14)
ns "AUDIO"
returns "BOOL"
doc [[!
Returns true if the script is currently playing a stream.
]]
native "IS_VEHICLE_AUDIBLY_DAMAGED"
hash "0x5DB8010EE71FDEF2"
jhash (0x6E660D3F)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0x5DB8010EE71FDEF2"
ns "AUDIO"
returns "BOOL"
doc [[!
Returns true if the vehicle has any audible damage effects applied to it.
]]
native "IS_VEHICLE_RADIO_ON"
hash "0x0BE4BE946463F917"
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0x0BE4BE946463F917"
alias "_IS_VEHICLE_RADIO_ENABLED"
ns "AUDIO"
returns "BOOL"
doc [[!
The vehicle to check
Returns true if the given vehicle's radio on
]]
native "LINK_STATIC_EMITTER_TO_ENTITY"
hash "0x651D3228960D08AF"
arguments {
charPtr "emitterName" [=[ {} ]=],
Entity "entity" [=[ {} ]=],
}
alias "0x651D3228960D08AF"
alias "_LINK_STATIC_EMITTER_TO_ENTITY"
ns "AUDIO"
returns "void"
doc [[!
Links a static emitter to the given entity
]]
native "LOAD_STREAM"
hash "0x1F1F957154EC51DF"
jhash (0x0D89599D)
arguments {
charPtr "streamName" [=[ {} ]=],
charPtr "soundSet" [=[ {} ]=],
}
ns "AUDIO"
returns "BOOL"
doc [[!
Load in named stream. Optionally can specify a sound set which contains the sound specified by name.
Names for the streams can be found [here](https://gist.github.com/4mmonium/2bd2c9c54d6ca5cbdb7b156a82a3a85a), the list will be updated as more are found.
an optional sound set, default is null
]]
native "LOAD_STREAM_WITH_START_OFFSET"
hash "0x59C16B79F53B3712"
jhash (0xE5B5745C)
arguments {
charPtr "streamName" [=[ {} ]=],
int "startOffset" [=[ {} ]=],
charPtr "soundSet" [=[ {} ]=],
}
ns "AUDIO"
returns "BOOL"
doc [[!
Load in named stream. Optionally can specify a sound set which contains the sound specified by name.
]]
native "LOCK_RADIO_STATION"
hash "0x477D9DB48F889591"
arguments {
charPtr "radioStationName" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x94f2e83ead7e6b82"
alias "_SET_RADIO_STATION_DISABLED"
alias "_LOCK_RADIO_STATION"
ns "AUDIO"
returns "void"
doc [[!
This disables the radio station completely - it won't be selectable on the radio wheel or ever be heard coming from a vehicle/ambient emitter
```
NativeDB Introduced: v1493
```
]]
native "LOCK_RADIO_STATION_TRACK_LIST"
hash "0xFF5E5EA2DCEEACF3"
arguments {
charPtr "radioStation" [=[ {} ]=],
charPtr "trackListName" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
]]
native "OVERRIDE_MICROPHONE_SETTINGS"
hash "0x75773E11BA459E90"
arguments {
Hash "hash" [=[ {"cs_type":"Any"} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x75773E11BA459E90"
alias "_OVERRIDE_MICROPHONE_SETTINGS"
ns "AUDIO"
returns "void"
doc [[!
Sets audio flag "OverrideMicrophoneSettings"
Allows the script to ovverride the current microphone settings
]]
native "OVERRIDE_PLAYER_GROUND_MATERIAL"
hash "0xD2CC78CD3D0B50F9"
jhash (0xC307D531)
arguments {
Hash "overriddenMaterialHash" [=[ {"cs_type":"Any"} ]=],
BOOL "scriptOverrides" [=[ {} ]=],
}
alias "0xD2CC78CD3D0B50F9"
ns "AUDIO"
returns "void"
doc [[!
Sets the footstep tuning modes
True to override with the given overridenMaterialHash, false to stop overriding
]]
native "OVERRIDE_TREVOR_RAGE"
hash "0x13AD665062541A7E"
jhash (0x05B9B5CF)
arguments {
charPtr "voiceEffect" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
This native enables the audio flag "TrevorRageIsOverridden" and sets the voice effect to `voiceEffect`
To clear the override use [RESET_TREVOR_RAGE](#\_0xE78503B10C4314E0)
]]
native "OVERRIDE_UNDERWATER_STREAM"
hash "0xF2A9CDABCEA04BD6"
jhash (0x9A083B7E)
arguments {
charPtr "streamName" [=[ {"cs_type":"AnyPtr"} ]=],
BOOL "override" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
This native allows a scripter to override the current underwater stream.
It needs to be called before going into the water
It needs to also be called with OVERRIDE_UNDERWATER_STREAM("", false) in order to stop overriding.
]]
native "OVERRIDE_VEH_HORN"
hash "0x3CDC1E622CCE0356"
jhash (0x2ACAB783)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "override" [=[ {} ]=],
int "hornHash" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
Overrides the vehicle's horn hash.
When changing this hash on a vehicle, [`_GET_VEHICLE_HORN_HASH`](#\_0xACB5DCCA1EC76840) will **not** return the 'overwritten' hash. It will still always return the default horn hash (same as [`GET_VEHICLE_DEFAULT_HORN`](#\_0x02165D55000219AC)).
List of possible hashes (found in decompiled scripts):
| signed | unsigned | hex |
|--------------:|-------------:|:------------:|
| `1604822495` | `1604822495` | `0x5FA7A5DF` |
| `-1262465009` | `3032502287` | `0xB4C0500F` |
| `-889553789` | `3405413507` | `0xCAFA7C83` |
| `-1557943086` | `2737024210` | `0xA323ACD2` |
| `-1318696617` | `2976270679` | `0xB1664957` |
| `-7740003` | `4287227293` | `0xFF89E59D` |
| `-1815146967` | `2479820329` | `0x93CF0E29` |
| `-339919356` | `3955047940` | `0xEBBD3E04` |
The vehicle you want to change the horn on.
Must be set to true. If set to false, the default horn hash will be restored.
A horn hash.
]]
native "PAUSE_SCRIPTED_CONVERSATION"
hash "0x8530AD776CD72B12"
jhash (0xE2C9C6F8)
arguments {
BOOL "finishCurrentLine" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
To resume the conversation use [RESTART_SCRIPTED_CONVERSATION](#\_0x9AEB285D1818C9AC)
]]
native "PLAY_AMBIENT_SPEECH_FROM_POSITION_NATIVE"
hash "0xED640017ED337E45"
jhash (0xA1A1402E)
arguments {
charPtr "speechName" [=[ {} ]=],
charPtr "voiceName" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
charPtr "speechParam" [=[ {} ]=],
}
alias "0xED640017ED337E45"
alias "_PLAY_AMBIENT_SPEECH_AT_COORDS"
ns "AUDIO"
returns "void"
doc [[!
See [`PLAY_PED_AMBIENT_SPEECH_NATIVE`](#\_0x8E04FEDD28D42462) for params
]]
native "PLAY_ANIMAL_VOCALIZATION"
hash "0xEE066C7006C49C0A"
jhash (0x498849F3)
arguments {
Ped "pedHandle" [=[ {} ]=],
int "animalType" [=[ {} ]=],
charPtr "speechName" [=[ {} ]=],
}
alias "0xEE066C7006C49C0A"
ns "AUDIO"
returns "void"
doc [[!
```cpp
enum eAudAnimalType {
AUD_ANIMAL_NONE = -1,
AUD_ANIMAL_BOAR = 0,
AUD_ANIMAL_CHICKEN = 1,
AUD_ANIMAL_DOG = 2,
AUD_ANIMAL_DOG_ROTTWEILER = 3,
AUD_ANIMAL_HORSE = 4,
AUD_NUM_ANIMALS = 5
}
```
]]
native "PLAY_DEFERRED_SOUND_FRONTEND"
hash "0xCADA5A0D0702381E"
jhash (0xC70E6CFA)
arguments {
charPtr "soundName" [=[ {} ]=],
charPtr "soundsetName" [=[ {} ]=],
}
alias "0xCADA5A0D0702381E"
ns "AUDIO"
returns "void"
doc [[!
]]
native "PLAY_END_CREDITS_MUSIC"
hash "0xCD536C4D33DCC900"
jhash (0x8E88B3CC)
arguments {
BOOL "bActive" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
]]
native "PLAY_MISSION_COMPLETE_AUDIO"
hash "0xB138AAB8A70D3C69"
jhash (0x3033EA1D)
arguments {
charPtr "audioName" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
```
Called 38 times in the scripts. There are 5 different audioNames used.
One unknown removed below.
AUDIO::PLAY_MISSION_COMPLETE_AUDIO("DEAD");
AUDIO::PLAY_MISSION_COMPLETE_AUDIO("FRANKLIN_BIG_01");
AUDIO::PLAY_MISSION_COMPLETE_AUDIO("GENERIC_FAILED");
AUDIO::PLAY_MISSION_COMPLETE_AUDIO("TREVOR_SMALL_01");
```
]]
native "PLAY_PAIN"
hash "0xBC9AE166038A5CEC"
jhash (0x874BD6CB)
arguments {
Ped "ped" [=[ {} ]=],
int "damageReason" [=[ {} ]=],
float "rawDamage" [=[ {"cs_type":"int"} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
This native had a 4th parameter added in newer game builds
`syncOverNetwork` creates a `CPedPlayPainEvent` when set to true, by default this variable is false.
You won't be able to use this for clones (remote pedestrians that are not owned by you) or migrating peds if `syncOverNetwork` is set to true; it simply won't execute.
The `ped` should also have speech for this to work.
```cpp
enum eAudDamageReason {
AUD_DAMAGE_REASON_DEFAULT = 0,
AUD_DAMAGE_REASON_FALLING = 1,
AUD_DAMAGE_REASON_SUPER_FALLING = 2,
AUD_DAMAGE_REASON_SCREAM_PANIC = 3,
AUD_DAMAGE_REASON_SCREAM_PANIC_SHORT = 4,
AUD_DAMAGE_REASON_SCREAM_SCARED = 5,
AUD_DAMAGE_REASON_SCREAM_SHOCKED = 6,
AUD_DAMAGE_REASON_SCREAM_TERROR = 7,
AUD_DAMAGE_REASON_ON_FIRE = 8,
AUD_DAMAGE_REASON_DROWNING = 9,
// drowning on the surface of water, after we time out
AUD_DAMAGE_REASON_SURFACE_DROWNING = 10,
AUD_DAMAGE_REASON_INHALE = 11,
AUD_DAMAGE_REASON_EXHALE = 12,
AUD_DAMAGE_REASON_POST_FALL_GRUNT = 13,
AUD_DAMAGE_REASON_ENTERING_RAGDOLL_DEATH = 14,
AUD_DAMAGE_REASON_EXPLOSION = 15,
AUD_DAMAGE_REASON_MELEE = 16,
AUD_DAMAGE_REASON_SHOVE = 17,
AUD_DAMAGE_REASON_WHEEZE = 18,
AUD_DAMAGE_REASON_COUGH = 19,
AUD_DAMAGE_REASON_TAZER = 20,
AUD_DAMAGE_REASON_EXHAUSTION = 21,
AUD_DAMAGE_REASON_CLIMB_LARGE = 22,
AUD_DAMAGE_REASON_CLIMB_SMALL = 23,
AUD_DAMAGE_REASON_JUMP = 24,
AUD_DAMAGE_REASON_COWER = 25,
AUD_DAMAGE_REASON_WHIMPER = 26,
AUD_DAMAGE_REASON_DYING_MOAN = 27,
AUD_DAMAGE_REASON_CYCLING_EXHALE = 28,
AUD_DAMAGE_REASON_PAIN_RAPIDS = 29,
AUD_DAMAGE_REASON_SNEEZE = 30,
AUD_DAMAGE_REASON_MELEE_SMALL_GRUNT = 31,
AUD_DAMAGE_REASON_MELEE_LARGE_GRUNT = 32,
AUD_DAMAGE_REASON_POST_FALL_GRUNT_LOW = 33
}
```
The ped entity.
The damage reason/type, refer to eAudDamageReason
Damage value, defaults to 0.0
]]
native "PLAY_PED_AMBIENT_SPEECH_AND_CLONE_NATIVE"
hash "0xC6941B4A3A8FBBB9"
jhash (0x444180DB)
arguments {
Ped "ped" [=[ {} ]=],
charPtr "speechName" [=[ {} ]=],
charPtr "speechParam" [=[ {} ]=],
}
alias "_PLAY_AMBIENT_SPEECH2"
ns "AUDIO"
returns "void"
doc [[!
See [`PLAY_PED_AMBIENT_SPEECH_NATIVE`](#\_0x8E04FEDD28D42462) for parameter specifications.
```
NativeDB Added Parameter 4: Any p3
```
]]
native "PLAY_PED_AMBIENT_SPEECH_NATIVE"
hash "0x8E04FEDD28D42462"
jhash (0x5C57B85D)
arguments {
Ped "ped" [=[ {} ]=],
charPtr "speechName" [=[ {} ]=],
charPtr "speechParam" [=[ {} ]=],
}
alias "_PLAY_AMBIENT_SPEECH1"
ns "AUDIO"
returns "void"
doc [[!
Plays ambient speech; see also [`PLAY_PED_AMBIENT_SPEECH_AND_CLONE_NATIVE`](#\_0xC6941B4A3A8FBBB9). Some speeches only play on certain ped models.
A full list of speech names can be found [here](https://docs.fivem.net/docs/game-references/speeches/).
```cpp
static const char *SpeechParams[] = {
"SPEECH_PARAMS_ADD_BLIP",
"SPEECH_PARAMS_ADD_BLIP_ALLOW_REPEAT",
"SPEECH_PARAMS_ADD_BLIP_FORCE",
"SPEECH_PARAMS_ADD_BLIP_INTERRUPT",
"SPEECH_PARAMS_ADD_BLIP_INTERRUPT_FORCE",
"SPEECH_PARAMS_ADD_BLIP_SHOUTED",
"SPEECH_PARAMS_ADD_BLIP_SHOUTED_FORCE",
"SPEECH_PARAMS_ALLOW_REPEAT",
"SPEECH_PARAMS_BEAT",
"SPEECH_PARAMS_FORCE",
"SPEECH_PARAMS_FORCE_FRONTEND",
"SPEECH_PARAMS_FORCE_HELI",
"SPEECH_PARAMS_FORCE_MEGAPHONE",
"SPEECH_PARAMS_FORCE_NO_REPEAT_FRONTEND",
"SPEECH_PARAMS_FORCE_NORMAL",
"SPEECH_PARAMS_FORCE_NORMAL_CLEAR",
"SPEECH_PARAMS_FORCE_NORMAL_CRITICAL",
"SPEECH_PARAMS_FORCE_PRELOAD_ONLY",
"SPEECH_PARAMS_FORCE_PRELOAD_ONLY_SHOUTED",
"SPEECH_PARAMS_FORCE_PRELOAD_ONLY_SHOUTED_CLEAR",
"SPEECH_PARAMS_FORCE_PRELOAD_ONLY_SHOUTED_CRITICAL",
"SPEECH_PARAMS_FORCE_SHOUTED",
"SPEECH_PARAMS_FORCE_SHOUTED_CLEAR",
"SPEECH_PARAMS_FORCE_SHOUTED_CRITICAL",
"SPEECH_PARAMS_HELI",
"SPEECH_PARAMS_INTERRUPT",
"SPEECH_PARAMS_INTERRUPT_FRONTEND",
"SPEECH_PARAMS_INTERRUPT_NO_FORCE",
"SPEECH_PARAMS_INTERRUPT_NO_FORCE_FRONTEND",
"SPEECH_PARAMS_INTERRUPT_SHOUTED",
"SPEECH_PARAMS_INTERRUPT_SHOUTED_CLEAR",
"SPEECH_PARAMS_INTERRUPT_SHOUTED_CRITICAL",
"SPEECH_PARAMS_MEGAPHONE",
"SPEECH_PARAMS_SHOUTED",
"SPEECH_PARAMS_SHOUTED_CLEAR",
"SPEECH_PARAMS_SHOUTED_CRITICAL",
"SPEECH_PARAMS_STANDARD"
}
```
The ped to play the ambient speech.
Name of the speech to play, eg. "GENERIC_HI".
Name of the speechParam rage game object to look to for various details on how the speech should be played.
]]
native "PLAY_PED_AMBIENT_SPEECH_WITH_VOICE_NATIVE"
hash "0x3523634255FC3318"
jhash (0x8386AE28)
arguments {
Ped "ped" [=[ {} ]=],
charPtr "speechName" [=[ {} ]=],
charPtr "voiceName" [=[ {} ]=],
charPtr "speechParam" [=[ {} ]=],
BOOL "p4" [=[ {} ]=],
}
alias "_PLAY_AMBIENT_SPEECH_WITH_VOICE"
ns "AUDIO"
returns "void"
doc [[!
```
This is the same as PLAY_PED_AMBIENT_SPEECH_NATIVE and PLAY_PED_AMBIENT_SPEECH_AND_CLONE_NATIVE but it will allow you to play a speech file from a specific voice file. It works on players and all peds, even animals.
EX (C#):
GTA.Native.Function.Call(Hash._0x3523634255FC3318, Game.Player.Character, "GENERIC_INSULT_HIGH", "s_m_y_sheriff_01_white_full_01", "SPEECH_PARAMS_FORCE_SHOUTED", 0);
The first param is the ped you want to play it on, the second is the speech name, the third is the voice name, the fourth is the speech param, and the last param is usually always 0.
```
]]
native "PLAY_PED_RINGTONE"
hash "0xF9E56683CA8E11A5"
jhash (0x1D530E47)
arguments {
charPtr "ringtoneName" [=[ {} ]=],
Ped "ped" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
```
All found occurrences in b617d, sorted alphabetically and identical lines removed: pastebin.com/RFb4GTny
AUDIO::PLAY_PED_RINGTONE("Remote_Ring", PLAYER::PLAYER_PED_ID(), 1);
AUDIO::PLAY_PED_RINGTONE("Dial_and_Remote_Ring", PLAYER::PLAYER_PED_ID(), 1);
```
]]
native "PLAY_POLICE_REPORT"
hash "0xDFEBD56D9BD1EB16"
jhash (0x3F277B62)
arguments {
charPtr "name" [=[ {} ]=],
float "p1" [=[ {} ]=],
}
ns "AUDIO"
returns "int"
doc [[!
```
Plays the given police radio message.
All found occurrences in b617d, sorted alphabetically and identical lines removed: pastebin.com/GBnsQ5hr
```
]]
native "PLAY_SOUND"
hash "0x7FF4944CC209192D"
jhash (0xB6E1917F)
arguments {
int "soundId" [=[ {} ]=],
charPtr "audioName" [=[ {} ]=],
charPtr "audioRef" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
BOOL "p5" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
```
All found occurrences in b617d, sorted alphabetically and identical lines removed: pastebin.com/A8Ny8AHZ
```
]]
native "PLAY_SOUND_FROM_COORD"
hash "0x8D8686B622B88120"
jhash (0xCAD3E2D5)
arguments {
int "soundId" [=[ {} ]=],
charPtr "audioName" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
charPtr "audioRef" [=[ {} ]=],
BOOL "isNetwork" [=[ {} ]=],
int "range" [=[ {} ]=],
BOOL "p8" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
```
All found occurrences in b617d, sorted alphabetically and identical lines removed: pastebin.com/eeFc5DiW
gtaforums.com/topic/795622-audio-for-mods
```
]]
native "PLAY_SOUND_FROM_ENTITY"
hash "0xE65F427EB70AB1ED"
jhash (0x95AE00F8)
arguments {
int "soundId" [=[ {} ]=],
charPtr "audioName" [=[ {} ]=],
Entity "entity" [=[ {} ]=],
charPtr "audioRef" [=[ {} ]=],
BOOL "isNetwork" [=[ {} ]=],
Any "p5" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
```
All found occurrences in b617d, sorted alphabetically and identical lines removed: pastebin.com/f2A7vTj0
No changes made in b678d.
gtaforums.com/topic/795622-audio-for-mods
```
]]
native "PLAY_SOUND_FRONTEND"
hash "0x67C540AA08E4A6F5"
jhash (0x2E458F74)
arguments {
int "soundId" [=[ {} ]=],
charPtr "audioName" [=[ {} ]=],
charPtr "audioRef" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
```
List: https://pastebin.com/DCeRiaLJ
All occurrences as of Cayo Perico Heist DLC (b2189), sorted alphabetically and identical lines removed: https://git.io/JtLxM
```
]]
native "PLAY_STREAM_FROM_OBJECT"
hash "0xEBAA9B64D76356FD"
jhash (0xC5266BF7)
arguments {
Object "object" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
Plays a preloaded stream back from the specified object.
]]
native "PLAY_STREAM_FROM_PED"
hash "0x89049DD63C08B5D1"
jhash (0xA1D7FABE)
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0x89049DD63C08B5D1"
ns "AUDIO"
returns "void"
doc [[!
Plays a preloaded stream back from the specified ped.
]]
native "PLAY_STREAM_FROM_POSITION"
hash "0x21442F412E8DE56B"
jhash (0x6FE5D865)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
alias "SPECIAL_FRONTEND_EQUAL"
ns "AUDIO"
returns "void"
doc [[!
Plays a preloaded stream back from the specified Vector3.
]]
native "PLAY_STREAM_FROM_VEHICLE"
hash "0xB70374A758007DFA"
jhash (0xF8E4BDA2)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
Plays a preloaded stream back from the specified ped vehicle
]]
native "PLAY_STREAM_FRONTEND"
hash "0x58FCE43488F9F5F4"
jhash (0x2C2A16BC)
ns "AUDIO"
returns "void"
doc [[!
]]
native "PLAY_SYNCHRONIZED_AUDIO_EVENT"
hash "0x8B2FD4560E55DD2D"
jhash (0x507F3241)
arguments {
int "sceneId" [=[ {} ]=],
}
ns "AUDIO"
returns "BOOL"
doc [[!
]]
native "PLAY_VEHICLE_DOOR_CLOSE_SOUND"
hash "0x62A456AA4769EF34"
jhash (0xBA2CF407)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "doorIndex" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
]]
native "PLAY_VEHICLE_DOOR_OPEN_SOUND"
hash "0x3A539D52857EA82D"
jhash (0x84930330)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "doorIndex" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
]]
native "PRELOAD_SCRIPT_CONVERSATION"
hash "0x3B3CAD6166916D87"
jhash (0xDDF5C579)
arguments {
BOOL "displaySubtitles" [=[ {} ]=],
BOOL "addToBriefScreen" [=[ {} ]=],
BOOL "cloneConversation" [=[ {} ]=],
BOOL "interruptible" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
Similar to [START_SCRIPT_CONVERSATION](#\_0x6B17C62C9635D2DC), except that is starts the conversation off paused.
A scripter can then kick off the conversation by calling [START_PRELOADED_CONVERSATION](#\_0x23641AFE870AF385).
If they want to check that the conversation is done preloading, they can use [GET_IS_PRELOADED_CONVERSATION_READY](#\_0xE73364DB90778FFA)
Defaults to true
Defaults to false
Defaults to true
]]
native "PRELOAD_SCRIPT_PHONE_CONVERSATION"
hash "0x6004BCB0E226AAEA"
jhash (0x9ACB213A)
arguments {
BOOL "displaySubtitles" [=[ {} ]=],
BOOL "addToBriefScreen" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
Defaults to true
]]
native "PRELOAD_VEHICLE_AUDIO_BANK"
hash "0xCA4CEA6AE0000A7E"
arguments {
Hash "model" [=[ {} ]=],
}
alias "0xCA4CEA6AE0000A7E"
alias "_PRELOAD_VEHICLE_AUDIO"
ns "AUDIO"
returns "void"
doc [[!
Request that we preload the required audio bank for a given vehicle model.
```
NativeDB Introduced: v1180
```
]]
native "PREPARE_ALARM"
hash "0x9D74AE343DB65533"
jhash (0x084932E8)
arguments {
charPtr "alarmName" [=[ {} ]=],
}
ns "AUDIO"
returns "BOOL"
doc [[!
Prepares any banks required to play the given alarm
Returns true if the alarm was successfully prepared
]]
native "PREPARE_MUSIC_EVENT"
hash "0x1E5185B72EF5158A"
jhash (0x534A5C1C)
arguments {
charPtr "eventName" [=[ {} ]=],
}
ns "AUDIO"
returns "BOOL"
doc [[!
Prepares the specified music event. Preparing it in advance will preload any required data so that it's ready to play immediately.
Returns true if the event is prepared, false otherwise
]]
native "PREPARE_SYNCHRONIZED_AUDIO_EVENT"
hash "0xC7ABCACA4985A766"
jhash (0xE1D91FD0)
arguments {
charPtr "audioEvent" [=[ {} ]=],
int "startOffsetMs" [=[ {} ]=],
}
ns "AUDIO"
annotations [=[ {"cs_type":"Any"} ]=]
returns "BOOL"
doc [[!
The audio event name.
Unused parameter (since v323)
]]
native "PREPARE_SYNCHRONIZED_AUDIO_EVENT_FOR_SCENE"
hash "0x029FE7CD1B7E2E75"
jhash (0x7652DD49)
arguments {
int "sceneId" [=[ {} ]=],
charPtr "audioEvent" [=[ {"cs_type":"AnyPtr"} ]=],
}
ns "AUDIO"
returns "BOOL"
doc [[!
Returns true if prepared, false otherwise
]]
native "RECORD_BROKEN_GLASS"
hash "0xFBE20329593DEC9D"
jhash (0x53FC3FEC)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "radius" [=[ {} ]=],
}
alias "0xFBE20329593DEC9D"
ns "AUDIO"
returns "void"
doc [[!
Creates a broken glass area
]]
native "REFRESH_CLOSEST_OCEAN_SHORELINE"
hash "0x5D2BFAAB8D956E0E"
alias "0x5D2BFAAB8D956E0E"
ns "AUDIO"
returns "void"
doc [[!
Refreshes the closest shoreline using the nearest road position.
]]
native "REGISTER_SCRIPT_WITH_AUDIO"
hash "0xC6ED9D5092438D91"
jhash (0xA6203643)
arguments {
BOOL "inChargeOfAudio" [=[ {"cs_type":"int"} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
**This native does absolutely nothing, just a nullsub**
]]
native "RELEASE_AMBIENT_AUDIO_BANK"
hash "0x65475A218FFAA93D"
jhash (0x8C938784)
ns "AUDIO"
returns "void"
doc [[!
This native has been marked as deprecated internally, please use [RELEASE_SCRIPT_AUDIO_BANK](#\_0x7A2D8AD0A9EB9C3F) instead.
]]
native "RELEASE_MISSION_AUDIO_BANK"
hash "0x0EC92A1BF0857187"
jhash (0x8E8824C7)
ns "AUDIO"
returns "void"
doc [[!
This native has been marked as deprecated internally, please use [RELEASE_SCRIPT_AUDIO_BANK](#\_0x7A2D8AD0A9EB9C3F) instead.
]]
native "RELEASE_NAMED_SCRIPT_AUDIO_BANK"
hash "0x77ED170667F50170"
jhash (0x16707ABC)
arguments {
charPtr "audioBank" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
Unloads the specified audioBank
]]
native "RELEASE_SCRIPT_AUDIO_BANK"
hash "0x7A2D8AD0A9EB9C3F"
jhash (0x22F865E5)
ns "AUDIO"
returns "void"
doc [[!
Unloads all audio banks requested by this script.
]]
native "RELEASE_SOUND_ID"
hash "0x353FC880830B88FA"
jhash (0x9C080899)
arguments {
int "soundId" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
This should be called once a sound has finished being manipulated by the script so that its SoundId can be released and re-used.
]]
native "RELEASE_WEAPON_AUDIO"
hash "0xCE4AC0439F607045"
jhash (0x6096504C)
ns "AUDIO"
returns "void"
doc [[!
```
NativeDB Introduced: v323
```
]]
native "REMOVE_ENTITY_FROM_AUDIO_MIX_GROUP"
hash "0x18EB48CFC41F2EA0"
jhash (0x308ED0EC)
arguments {
Entity "entity" [=[ {} ]=],
float "fadeOut" [=[ {} ]=],
}
alias "0x18EB48CFC41F2EA0"
ns "AUDIO"
returns "void"
doc [[!
Removes an entity from its current mix group.
Defaults to 0.0
]]
native "REMOVE_PORTAL_SETTINGS_OVERRIDE"
hash "0xB4BBFD9CD8B3922B"
jhash (0xD24B4D0C)
arguments {
charPtr "portalSettingsName" [=[ {} ]=],
}
alias "0xB4BBFD9CD8B3922B"
ns "AUDIO"
returns "void"
doc [[!
```
Found in the b617d scripts, duplicates removed:
AUDIO::_B4BBFD9CD8B3922B("V_CARSHOWROOM_PS_WINDOW_UNBROKEN");
AUDIO::_B4BBFD9CD8B3922B("V_CIA_PS_WINDOW_UNBROKEN");
AUDIO::_B4BBFD9CD8B3922B("V_DLC_HEIST_APARTMENT_DOOR_CLOSED");
AUDIO::_B4BBFD9CD8B3922B("V_FINALEBANK_PS_VAULT_INTACT");
AUDIO::_B4BBFD9CD8B3922B("V_MICHAEL_PS_BATHROOM_WITH_WINDOW");
```
For events like cars driving through windows, allows script to unocclude that window
]]
native "REQUEST_AMBIENT_AUDIO_BANK"
hash "0xFE02FFBED8CA9D99"
jhash (0x23C88BC7)
arguments {
charPtr "bankName" [=[ {} ]=],
BOOL "bOverNetwork" [=[ {} ]=],
}
ns "AUDIO"
returns "BOOL"
doc [[!
This native is marked as deprecated internally, please use [REQUEST_SCRIPT_AUDIO_BANK](#\_0x2F844A8B08D76685)
This native has a new argument on newer game builds:
* **playerBits**:
]]
native "REQUEST_MISSION_AUDIO_BANK"
hash "0x7345BDD95E62E0F2"
jhash (0x916E37CA)
arguments {
charPtr "bankName" [=[ {} ]=],
BOOL "bOverNetwork" [=[ {} ]=],
}
ns "AUDIO"
returns "BOOL"
doc [[!
This native is marked as deprecated internally, please use [REQUEST_SCRIPT_AUDIO_BANK](#\_0x2F844A8B08D76685)
This native has a new argument on newer game builds:
* **playerBits**:
]]
native "REQUEST_SCRIPT_AUDIO_BANK"
hash "0x2F844A8B08D76685"
jhash (0x21322887)
arguments {
charPtr "bankName" [=[ {} ]=],
BOOL "bOverNetwork" [=[ {} ]=],
}
ns "AUDIO"
returns "BOOL"
doc [[!
This native has a new argument on newer game builds:
* **playerBits**:
Requests and returns true/false if the script audio bank has laoded
]]
native "REQUEST_TENNIS_BANKS"
hash "0x4ADA3F19BE4A6047"
jhash (0x13777A0B)
arguments {
Ped "opponentPed" [=[ {} ]=],
}
alias "0x4ADA3F19BE4A6047"
alias "_SET_PED_TALK"
ns "AUDIO"
returns "void"
doc [[!
Loads the tennis vocalization banks into a couple animal slots.
]]
native "RESET_PED_AUDIO_FLAGS"
hash "0xF54BB7B61036F335"
jhash (0xDF720C86)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
]]
native "RESET_TREVOR_RAGE"
hash "0xE78503B10C4314E0"
jhash (0xE80CF0D4)
ns "AUDIO"
returns "void"
doc [[!
Clears the override set by [OVERRIDE_TREVOR_RAGE](#\_0x13AD665062541A7E)
]]
native "RESET_VEHICLE_STARTUP_REV_SOUND"
hash "0xD2DCCD8E16E20997"
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0xD2DCCD8E16E20997"
ns "AUDIO"
returns "void"
doc [[!
Resets the override for [SET_VEHICLE_STARTUP_REV_SOUND](#\_0xF1F8157B8C3F171C)
]]
native "RESTART_SCRIPTED_CONVERSATION"
hash "0x9AEB285D1818C9AC"
jhash (0x6CB24B56)
ns "AUDIO"
returns "void"
doc [[!
Restarts a conversation that was previously paused with [PAUSE_SCRIPTED_CONVERSATION](#\_0x8530AD776CD72B12)
]]
native "SCRIPT_OVERRIDES_WIND_ELEVATION"
hash "0x70B8EC8FC108A634"
jhash (0x95050CAD)
arguments {
BOOL "override" [=[ {} ]=],
Hash "windElevationHashName" [=[ {"cs_type":"Any"} ]=],
}
alias "0x70B8EC8FC108A634"
ns "AUDIO"
returns "void"
doc [[!
Overrides wind elevation sounds
]]
native "SET_AGGRESSIVE_HORNS"
hash "0x395BF71085D1B1D9"
jhash (0x01D6EABE)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
Makes pedestrians sound their horn longer, faster and more agressive when they use their horn.
]]
native "SET_AMBIENT_VOICE_NAME"
hash "0x6C8065A3B780185B"
jhash (0xBD2EA1A1)
arguments {
Ped "ped" [=[ {} ]=],
charPtr "voiceName" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
Sets the specified ped to use a specific voice different to the one associated with their model.
]]
native "SET_AMBIENT_VOICE_NAME_HASH"
hash "0x9A53DED9921DE990"
arguments {
Ped "ped" [=[ {} ]=],
Hash "hash" [=[ {"cs_type":"Any"} ]=],
}
alias "0x9A53DED9921DE990"
alias "_SET_AMBIENT_VOICE_NAME_HASH"
ns "AUDIO"
returns "void"
doc [[!
Sets the specified ped to use a specific voice different to the one associated with their model.
]]
native "SET_AMBIENT_ZONE_LIST_STATE"
hash "0x9748FA4DE50CCE3E"
jhash (0xBF80B412)
arguments {
charPtr "zoneListName" [=[ {} ]=],
BOOL "enabled" [=[ {} ]=],
BOOL "forceUpdate" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
Enables/disables a list of ambient zones for the duration of this script
Set to true to force a zone to become disabled even if its currently active, default behaviour is to only change state when the player leaves the zone.
]]
native "SET_AMBIENT_ZONE_LIST_STATE_PERSISTENT"
hash "0xF3638DAE8C4045E1"
jhash (0x5F5A2605)
arguments {
charPtr "ambientZone" [=[ {} ]=],
BOOL "enabled" [=[ {} ]=],
BOOL "forceUpdate" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
Enables/disables a list of ambient zones persistently
Set to true to force a zone to become disabled even if its currently active, default behaviour is to only change state when the player leaves the zone.
]]
native "SET_AMBIENT_ZONE_STATE"
hash "0xBDA07E5950085E46"
jhash (0x2849CAC9)
arguments {
charPtr "zoneName" [=[ {"cs_type":"AnyPtr"} ]=],
BOOL "enabled" [=[ {} ]=],
BOOL "forceUpdate" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
Enables/disables an ambient zone for the duration of this script
Set to true to force a zone to become disabled even if its currently active, default behaviour is to only change state when the player leaves the zone.
]]
native "SET_AMBIENT_ZONE_STATE_PERSISTENT"
hash "0x1D6650420CEC9D3B"
jhash (0xC1FFB672)
arguments {
charPtr "zoneName" [=[ {} ]=],
BOOL "enabled" [=[ {} ]=],
BOOL "forceUpdate" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
Enables/disables an ambient zone for the duration of this script
Set to true to force a zone to become disabled even if its currently active, default behaviour is to only change state when the player leaves the zone.
]]
native "SET_ANIMAL_MOOD"
hash "0xCC97B29285B1DC3B"
jhash (0x3EA7C6CB)
arguments {
Ped "animal" [=[ {} ]=],
int "mood" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
```cpp
enum eAudAnimalMood {
AUD_ANIMAL_MOOD_ANGRY = 0,
AUD_ANIMAL_MOOD_PLAYFUL = 1,
AUD_ANIMAL_MOOD_NUM_MOODS = 2
}
```
Refer to `eAudAnimalMood`
]]
native "SET_AUDIO_FLAG"
hash "0xB9EFD5C25018725A"
jhash (0x1C09C9E0)
arguments {
charPtr "flagName" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
Generic interface to toggle audio functionality, with auto-reset on script termination and support for multiple script threads
Flags used in game scripts:
| Flag Name | Description of Usage |
| ----- | -------- |
| ActivateSwitchWheelAudio | |
| AllowAmbientSpeechInSlowMo | |
| AllowCutsceneOverScreenFade | |
| AllowForceRadioAfterRetune | |
| AllowPainAndAmbientSpeechToPlayDuringCutscene | |
| AllowPlayerAIOnMission | |
| AllowPoliceScannerWhenPlayerHasNoControl | |
| AllowRadioDuringSwitch | |
| AllowRadioOverScreenFade | |
| AllowScoreAndRadio | |
| AllowScriptedSpeechInSlowMo | |
| AvoidMissionCompleteDelay | |
| DisableAbortConversationForDeathAndInjury | |
| DisableAbortConversationForRagdoll | |
| DisableBarks | |
| DisableFlightMusic | |
| DisableNPCHeadsetSpeechAttenuation | |
| DisableReplayScriptStreamRecording | |
| EnableHeadsetBeep | |
| EnableMissileLockWarningForAllVehicles | |
| ForceConversationInterrupt | |
| ForceSeamlessRadioSwitch | |
| ForceSniperAudio | |
| FrontendRadioDisabled | |
| HoldMissionCompleteWhenPrepared | |
| IsDirectorModeActive | Allows you to play speech infinitely without any pauses like in Director Mode. |
| IsPlayerOnMissionForSpeech | |
| ListenerReverbDisabled | |
| LoadMPData | |
| MobileRadioInGame | |
| OnlyAllowScriptTriggerPoliceScanner | |
| PlayerOnDLCHeist4Island | |
| PlayMenuMusic | |
| PoliceScannerDisabled | |
| ScriptedConvListenerMaySpeak | |
| SpeechDucksScore | |
| SuppressPlayerScubaBreathing | |
| UseQuietSceneSoftVersion | |
| WantedMusicDisabled | |
| WantedMusicOnMission | |
```
All flag IDs and hashes:
ID: 01 | Hash: 0x20A7858F
ID: 02 | Hash: 0xA11C2259
ID: 03 | Hash: 0x08DE4700
ID: 04 | Hash: 0x989F652F
ID: 05 | Hash: 0x3C9E76BA
ID: 06 | Hash: 0xA805FEB0
ID: 07 | Hash: 0x4B94EA26
ID: 08 | Hash: 0x803ACD34
ID: 09 | Hash: 0x7C741226
ID: 10 | Hash: 0x31DB9EBD
ID: 11 | Hash: 0xDF386F18
ID: 12 | Hash: 0x669CED42
ID: 13 | Hash: 0x51F22743
ID: 14 | Hash: 0x2052B35C
ID: 15 | Hash: 0x071472DC
ID: 16 | Hash: 0xF9928BCC
ID: 17 | Hash: 0x7ADBDD48
ID: 18 | Hash: 0xA959BA1A
ID: 19 | Hash: 0xBBE89B60
ID: 20 | Hash: 0x87A08871
ID: 21 | Hash: 0xED1057CE
ID: 22 | Hash: 0x1584AD7A
ID: 23 | Hash: 0x8582CFCB
ID: 24 | Hash: 0x7E5E2FB0
ID: 25 | Hash: 0xAE4F72DB
ID: 26 | Hash: 0x5D16D1FA
ID: 27 | Hash: 0x06B2F4B8
ID: 28 | Hash: 0x5D4CDC96
ID: 29 | Hash: 0x8B5A48BA
ID: 30 | Hash: 0x98FBD539
ID: 31 | Hash: 0xD8CB0473
ID: 32 | Hash: 0x5CBB4874
ID: 33 | Hash: 0x2E9F93A9
ID: 34 | Hash: 0xD93BEA86
ID: 35 | Hash: 0x92109B7D
ID: 36 | Hash: 0xB7EC9E4D
ID: 37 | Hash: 0xCABDBB1D
ID: 38 | Hash: 0xB3FD4A52
ID: 39 | Hash: 0x370D94E5
ID: 40 | Hash: 0xA0F7938F
ID: 41 | Hash: 0xCBE1CE81
ID: 42 | Hash: 0xC27F1271
ID: 43 | Hash: 0x9E3258EB
ID: 44 | Hash: 0x551CDA5B
ID: 45 | Hash: 0xCB6D663C
ID: 46 | Hash: 0x7DACE87F
ID: 47 | Hash: 0xF9DE416F
ID: 48 | Hash: 0x882E6E9E
ID: 49 | Hash: 0x16B447E7
ID: 50 | Hash: 0xBD867739
ID: 51 | Hash: 0xA3A58604
ID: 52 | Hash: 0x7E046BBC
ID: 53 | Hash: 0xD95FDB98
ID: 54 | Hash: 0x5842C0ED
ID: 55 | Hash: 0x285FECC6
ID: 56 | Hash: 0x9351AC43
ID: 57 | Hash: 0x50032E75
ID: 58 | Hash: 0xAE6D0D59
ID: 59 | Hash: 0xD6351785
ID: 60 | Hash: 0xD25D71BC
ID: 61 | Hash: 0x1F7F6423
ID: 62 | Hash: 0xE24C3AA6
ID: 63 | Hash: 0xBFFDD2B7
```
]]
native "SET_AUDIO_SCENE_VARIABLE"
hash "0xEF21A9EF089A2668"
jhash (0x19BB3CE8)
arguments {
charPtr "scene" [=[ {} ]=],
charPtr "variableName" [=[ {} ]=],
float "value" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
name of the scene
name of the variable to add/change
value to set the variable to
]]
native "SET_AUDIO_SCRIPT_CLEANUP_TIME"
hash "0xA5F377B175A699C5"
jhash (0xE812925D)
arguments {
int "timeMs" [=[ {} ]=],
}
alias "0xA5F377B175A699C5"
ns "AUDIO"
returns "void"
doc [[!
Set a delay in milliseconds for the audio to be cleaned up when the script finishes.
]]
native "SET_AUDIO_SPECIAL_EFFECT_MODE"
hash "0x12561FCBB62D5B9C"
jhash (0x62B43677)
arguments {
int "mode" [=[ {} ]=],
}
alias "0x12561FCBB62D5B9C"
ns "AUDIO"
returns "void"
doc [[!
Needs to be called every frame.
```cpp
enum eAudSpecialEffectMode
{
kSpecialEffectModeNormal = 0,
kSpecialEffectModeUnderwater = 1,
kSpecialEffectModeStoned = 2,
kSpecialEffectModePauseMenu = 3,
kSpecialEffectModeSlowMotion = 4,
kSpecialEffectModeDrunkStage01 = 5,
kSpecialEffectModeDrunkStage02 = 6,
kSpecialEffectModeDrunkStage03 = 7,
NUM_AUDSPECIALEFFECTMODE
};
```
Audio mode to apply this frame
]]
native "SET_AUDIO_VEHICLE_PRIORITY"
hash "0xE5564483E407F914"
jhash (0x271A9766)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "priority" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
Sets the priority for the given vehicle. This is a hint for the audio system as to what LOD the
vehicle should use.
'High' priority will bump up the activation range significantly and prevent it
from dropping when the vehicle is not within the view frustrum.
'Max' will attempt to keep the vehicle at maximum LOD regardless of how far it is from the listener or what it is currently doing. Be careful with this!
There is a hard limit of 5 simulataneous granular cars (including the player) so we are quite limited on the number
we can play at once, so setting vehicles to max priority will reduce the number of engines availble for regular NPC vehicles
```cpp
enum eAudVehiclePriority {
AUDIO_VEHICLE_PRIORITY_NORMAL = 0,
AUDIO_VEHICLE_PRIORITY_MEDIUM = 1,
AUDIO_VEHICLE_PRIORITY_MAX = 2,
AUDIO_VEHICLE_PRIORITY_HIGH = 3,
}
```
]]
native "SET_CONVERSATION_AUDIO_CONTROLLED_BY_ANIM"
hash "0x0B568201DD99F0EB"
jhash (0x1193ED6E)
arguments {
BOOL "enable" [=[ {} ]=],
}
alias "0x0B568201DD99F0EB"
ns "AUDIO"
returns "void"
doc [[!
Sets whether or not scripted conversation flow should be controlled by anim triggers
Pass in true to set conversation flow to be controlled by animation triggers.
]]
native "SET_CONVERSATION_AUDIO_PLACEHOLDER"
hash "0x61631F5DF50D1C34"
arguments {
BOOL "isPlaceHolder" [=[ {} ]=],
}
alias "0x61631F5DF50D1C34"
ns "AUDIO"
returns "void"
doc [[!
Used to determine whether conversation should use robot speech or not
Whether or not the conversation should use robot speech or not
]]
native "SET_CUSTOM_RADIO_TRACK_LIST"
hash "0x4E404A9361F75BB2"
jhash (0x128C3873)
arguments {
charPtr "radioStation" [=[ {} ]=],
charPtr "trackListName" [=[ {} ]=],
BOOL "forceNow" [=[ {} ]=],
}
alias "0x4E404A9361F75BB2"
ns "AUDIO"
returns "void"
doc [[!
Queues up a custom track list on the specified radio station. The content in the track list will be played as soon as possible.
The station does not have to be frozen.
wheter or not to interrupt the current track on the tracklist
]]
native "SET_CUTSCENE_AUDIO_OVERRIDE"
hash "0x3B4BF5F0859204D9"
jhash (0xCE1332B7)
arguments {
charPtr "name" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
```
All occurrences found in b617d, sorted alphabetically and identical lines removed:
AUDIO::SET_CUTSCENE_AUDIO_OVERRIDE("_AK");
AUDIO::SET_CUTSCENE_AUDIO_OVERRIDE("_CUSTOM");
AUDIO::SET_CUTSCENE_AUDIO_OVERRIDE("_TOOTHLESS");
```
Add a suffix to the cutscene audio name. Call before loading the cutscene.
]]
native "SET_EMITTER_RADIO_STATION"
hash "0xACF57305B12AF907"
jhash (0x87431585)
arguments {
charPtr "emitterName" [=[ {} ]=],
charPtr "radioStation" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
Retunes a named static emitter to the specified station
]]
native "SET_ENTITY_FOR_NULL_CONV_PED"
hash "0x892B6AB8F33606F5"
jhash (0x88203DDA)
arguments {
int "speakerConversationIndex" [=[ {} ]=],
Entity "entity" [=[ {} ]=],
}
alias "0x892B6AB8F33606F5"
ns "AUDIO"
returns "void"
doc [[!
]]
native "SET_FRONTEND_RADIO_ACTIVE"
hash "0xF7F26C6E9CC9EBB8"
jhash (0xB1172075)
arguments {
BOOL "active" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
Allows the radio to be played in the frontend.
]]
native "SET_GLOBAL_RADIO_SIGNAL_LEVEL"
hash "0x159B7318403A1CD8"
arguments {
float "signalLevel" [=[ {"cs_type":"Any"} ]=],
}
alias "0x159B7318403A1CD8"
ns "AUDIO"
returns "void"
doc [[!
Sets the global radio signal level, lower value will cause radio static.
Used only a handful of times in scripts.
Radio signal level.
]]
native "SET_GPS_ACTIVE"
hash "0x3BD3F52BA9B1E4E8"
jhash (0x0FC3379A)
arguments {
BOOL "active" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
]]
native "SET_HORN_ENABLED"
hash "0x76D683C108594D0E"
jhash (0x6EB92D05)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
]]
native "SET_INITIAL_PLAYER_STATION"
hash "0x88795F13FACDA88D"
jhash (0x9B069233)
arguments {
charPtr "radioStation" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
]]
native "SET_MICROPHONE_POSITION"
hash "0xB6AE90EDDE95C762"
jhash (0xAD7BB191)
arguments {
BOOL "p0" [=[ {} ]=],
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
float "x3" [=[ {} ]=],
float "y3" [=[ {} ]=],
float "z3" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
```
If this is the correct name, what microphone? I know your TV isn't going to reach out and adjust your headset so..
```
]]
native "SET_MOBILE_PHONE_RADIO_STATE"
hash "0xBF286C554784F3DF"
jhash (0xE1E0ED34)
arguments {
BOOL "state" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
]]
native "SET_MOBILE_RADIO_ENABLED_DURING_GAMEPLAY"
hash "0x1098355A16064BB3"
jhash (0x990085F0)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
]]
native "SET_PED_CLOTH_EVENTS_ENABLED"
hash "0x29DA3CA8D8B2692D"
arguments {
Ped "ped" [=[ {} ]=],
BOOL "enabled" [=[ {} ]=],
}
alias "0x29DA3CA8D8B2692D"
alias "_SET_PED_AUDIO_FOOTSTEP_QUIET"
ns "AUDIO"
returns "void"
doc [[!
```
NativeDB Introduced: v1493
```
]]
native "SET_PED_IS_DRUNK"
hash "0x95D2D383D5396B8A"
jhash (0xD2EA77A3)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
Sets the ped so they sound drunk
]]
native "SET_PED_RACE_AND_VOICE_GROUP"
hash "0x1B7ABE26CBCBF8C7"
arguments {
Ped "ped" [=[ {} ]=],
int "pedRace" [=[ {} ]=],
int "pvgHash" [=[ {} ]=],
}
alias "0x1B7ABE26CBCBF8C7"
ns "AUDIO"
returns "void"
doc [[!
PedVoiceGroup hash, defaults to 0
]]
native "SET_PED_VOICE_FULL"
hash "0x40CF0D12D142A9E8"
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0x40CF0D12D142A9E8"
alias "_SET_PED_SCREAM"
ns "AUDIO"
returns "void"
doc [[!
Calls the same internal function [`_SET_PED_VOICE_GROUP`](#\_0x7CDC8C3B89F661B3) calls, but passes `voiceGroupHash` (defined as a parameter in the referenced native) as `0`.
]]
native "SET_PED_WALLA_DENSITY"
hash "0x149AEE66F0CB3A99"
jhash (0xE64F97A0)
arguments {
float "density" [=[ {} ]=],
float "applyValue" [=[ {} ]=],
}
alias "0x149AEE66F0CB3A99"
ns "AUDIO"
returns "void"
doc [[!
Overrides the calculated ped density that is used to modulate the ambient ped walla sounds (in exteriors only)
If you want to use this for interiors, use [SET_PED_INTERIOR_WALLA_DENSITY](#\_0x8BF907833BE275DE)
desired walla density
how much the desired density affects the actual one
]]
native "SET_PLAYER_ANGRY"
hash "0xEA241BB04110F091"
jhash (0x782CA58D)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "isAngry" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
Sets a player ped to use his ANGRY speech contexts
]]
native "SET_PLAYER_VEHICLE_ALARM_AUDIO_ACTIVE"
hash "0x6FDDAD856E36988A"
jhash (0x934BE749)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "active" [=[ {} ]=],
}
alias "0x6FDDAD856E36988A"
ns "AUDIO"
returns "void"
doc [[!
Enable player vehicle specific alarm disarm/arm sound triggering
]]
native "SET_PORTAL_SETTINGS_OVERRIDE"
hash "0x044DBAD7A7FA2BE5"
jhash (0x8AD670EC)
arguments {
charPtr "oldPortalSettingsName" [=[ {} ]=],
charPtr "newPortalSettingsName" [=[ {} ]=],
}
alias "0x044DBAD7A7FA2BE5"
ns "AUDIO"
returns "void"
doc [[!
]]
native "SET_POSITION_FOR_NULL_CONV_PED"
hash "0x33E3C6C6F2F0B506"
jhash (0x73C6F979)
arguments {
int "speakerConversationIndex" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
alias "0x33E3C6C6F2F0B506"
ns "AUDIO"
returns "void"
doc [[!
]]
native "SET_POSITIONED_PLAYER_VEHICLE_RADIO_EMITTER_ENABLED"
hash "0xDA07819E452FFE8F"
arguments {
BOOL "enabled" [=[ {"cs_type":"Any"} ]=],
}
alias "0xDA07819E452FFE8F"
ns "AUDIO"
returns "void"
doc [[!
enables/disables a positioned emitter for the player vehicle radio
]]
native "SET_RADIO_AUTO_UNFREEZE"
hash "0xC1AA9F53CE982990"
jhash (0xA40196BF)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
if true the radio will automatically unfreeze as soon as the player gets in a vehicle
]]
native "SET_RADIO_FRONTEND_FADE_TIME"
hash "0x2C96CDB04FCA358E"
jhash (0xC8B514E2)
arguments {
float "fadeTime" [=[ {} ]=],
}
alias "0x2C96CDB04FCA358E"
ns "AUDIO"
returns "void"
doc [[!
]]
native "SET_RADIO_RETUNE_DOWN"
hash "0xDD6BCF9E94425DF9"
jhash (0xD70ECC80)
alias "0xDD6BCF9E94425DF9"
ns "AUDIO"
returns "void"
doc [[!
Sets radio to tune down. (Changes radio station)
]]
native "SET_RADIO_RETUNE_UP"
hash "0xFF266D1D0EB1195D"
jhash (0x53DB6994)
alias "0xFF266D1D0EB1195D"
ns "AUDIO"
returns "void"
doc [[!
Sets the radio to tune up. (changes radio station)
]]
native "SET_RADIO_STATION_MUSIC_ONLY"
hash "0x774BD811F656A122"
jhash (0xB1FF7137)
arguments {
charPtr "radioStation" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x774BD811F656A122"
ns "AUDIO"
returns "void"
doc [[!
```
6 calls in the b617d scripts, removed identical lines:
AUDIO::SET_RADIO_STATION_MUSIC_ONLY("RADIO_01_CLASS_ROCK", 1);
AUDIO::SET_RADIO_STATION_MUSIC_ONLY(AUDIO::GET_RADIO_STATION_NAME(10), 0);
AUDIO::SET_RADIO_STATION_MUSIC_ONLY(AUDIO::GET_RADIO_STATION_NAME(10), 1);
```
]]
native "SET_RADIO_TO_STATION_INDEX"
hash "0xA619B168B8A8570F"
jhash (0x1D82766D)
arguments {
int "radioStation" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
```
Sets radio station by index.
```
]]
native "SET_RADIO_TO_STATION_NAME"
hash "0xC69EDA28699D5107"
jhash (0x7B36E35E)
arguments {
charPtr "stationName" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
Find the radio station list [here](https://gist.github.com/4mmonium/b47d6512a2d992cbf4eea15d9038b581)
]]
native "SET_RADIO_TRACK"
hash "0xB39786F201FEE30B"
jhash (0x76E96212)
arguments {
charPtr "radioStation" [=[ {} ]=],
charPtr "radioTrack" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
```
Only found this one in the decompiled scripts:
AUDIO::SET_RADIO_TRACK("RADIO_03_HIPHOP_NEW", "ARM1_RADIO_STARTS");
```
]]
native "SET_SCRIPT_UPDATE_DOOR_AUDIO"
hash "0x06C0023BED16DD6B"
jhash (0xE61110A2)
arguments {
Hash "doorHash" [=[ {"cs_type":"Any"} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x06C0023BED16DD6B"
ns "AUDIO"
returns "void"
doc [[!
]]
native "SET_SIREN_WITH_NO_DRIVER"
hash "0x1FEF0683B96EBCF2"
jhash (0x77182D58)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {"cs_type":"ScrHandlePtr"} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
]]
native "SET_STATIC_EMITTER_ENABLED"
hash "0x399D2D3B33F1B8EB"
jhash (0x91F72E92)
arguments {
charPtr "emitterName" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
```
Example:
AUDIO::SET_STATIC_EMITTER_ENABLED((Any*)"LOS_SANTOS_VANILLA_UNICORN_01_STAGE", false); AUDIO::SET_STATIC_EMITTER_ENABLED((Any*)"LOS_SANTOS_VANILLA_UNICORN_02_MAIN_ROOM", false); AUDIO::SET_STATIC_EMITTER_ENABLED((Any*)"LOS_SANTOS_VANILLA_UNICORN_03_BACK_ROOM", false);
This turns off surrounding sounds not connected directly to peds.
```
]]
native "SET_USER_RADIO_CONTROL_ENABLED"
hash "0x19F21E63AE6EAE4E"
jhash (0x52E054CE)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
]]
native "SET_VARIABLE_ON_SOUND"
hash "0xAD6B3148A78AE9B6"
jhash (0x606EE5FA)
arguments {
int "soundId" [=[ {} ]=],
charPtr "variableName" [=[ {} ]=],
float "value" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
]]
native "SET_VARIABLE_ON_STREAM"
hash "0x2F9D3834AEB9EF79"
jhash (0xF67BB44C)
arguments {
charPtr "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
```
From the scripts, p0:
"ArmWrestlingIntensity",
"INOUT",
"Monkey_Stream",
"ZoomLevel"
```
]]
native "SET_VARIABLE_ON_UNDER_WATER_STREAM"
hash "0x733ADF241531E5C2"
jhash (0x62D026BE)
arguments {
charPtr "variableName" [=[ {} ]=],
float "value" [=[ {} ]=],
}
alias "0x733ADF241531E5C2"
ns "AUDIO"
returns "void"
doc [[!
```
AUDIO::SET_VARIABLE_ON_UNDER_WATER_STREAM("inTunnel", 1.0);
AUDIO::SET_VARIABLE_ON_UNDER_WATER_STREAM("inTunnel", 0.0);
```
]]
native "SET_VEH_RADIO_STATION"
hash "0x1B9C0099CB942AC6"
jhash (0xE391F55F)
arguments {
Vehicle "vehicle" [=[ {} ]=],
charPtr "radioStation" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
Find the radio station list [here](https://gist.github.com/4mmonium/b47d6512a2d992cbf4eea15d9038b581)
]]
native "SET_VEHICLE_AUDIO_BODY_DAMAGE_FACTOR"
hash "0x01BB4D577D38BD9E"
jhash (0xE81FAC68)
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "intensity" [=[ {} ]=],
}
alias "0x01BB4D577D38BD9E"
ns "AUDIO"
returns "void"
doc [[!
Vehicle will make a 'rattling' noise when decelerating
Vehicle to modify
A value 0.0 - 1.0. Higher the value, the more likely the vehicle is to make the sound while decelerating
]]
native "SET_VEHICLE_AUDIO_ENGINE_DAMAGE_FACTOR"
hash "0x59E7B488451F4D3A"
jhash (0x23BE6432)
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "damageFactor" [=[ {} ]=],
}
alias "0x59E7B488451F4D3A"
ns "AUDIO"
returns "void"
doc [[!
]]
native "SET_VEHICLE_BOOST_ACTIVE"
hash "0x4A04DE7CAB2739A1"
jhash (0x072F15F2)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
```
SET_VEHICLE_BOOST_ACTIVE(vehicle, 1, 0);
SET_VEHICLE_BOOST_ACTIVE(vehicle, 0, 0);
Will give a boost-soundeffect.
```
]]
native "SET_VEHICLE_MISSILE_WARNING_ENABLED"
hash "0xF3365489E0DD50F9"
jhash (0x8AFC488D)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0xF3365489E0DD50F9"
ns "AUDIO"
returns "void"
doc [[!
Toggles the incoming missile warning system for specified vehicle.
Vehicle to toggle warning system for.
`true` to enable, `false` to disable.
]]
native "SET_VEHICLE_RADIO_ENABLED"
hash "0x3B988190C0AA6C0B"
jhash (0x6F812CAB)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
```
can't seem to enable radio on cop cars etc
```
]]
native "SET_VEHICLE_RADIO_LOUD"
hash "0xBB6F1CAEC68B0BCE"
jhash (0x8D9EDD99)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "loud" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
]]
native "SET_VEHICLE_STARTUP_REV_SOUND"
hash "0xF1F8157B8C3F171C"
jhash (0x1C0C5E4C)
arguments {
Vehicle "vehicle" [=[ {} ]=],
charPtr "soundName" [=[ {} ]=],
charPtr "setName" [=[ {} ]=],
}
alias "0xF1F8157B8C3F171C"
ns "AUDIO"
returns "void"
doc [[!
Overrides the vehicle's startup engine rev sound.
You can reset this with [RESET_VEHICLE_STARTUP_REV_SOUND](#\_0xD2DCCD8E16E20997)
]]
native "SKIP_RADIO_FORWARD"
hash "0x6DDBBDD98E2E9C25"
jhash (0x10D36630)
ns "AUDIO"
returns "void"
doc [[!
]]
native "SKIP_TO_NEXT_SCRIPTED_CONVERSATION_LINE"
hash "0x9663FE6B7A61EB00"
jhash (0x85C98304)
ns "AUDIO"
returns "void"
doc [[!
]]
native "START_ALARM"
hash "0x0355EF116C4C97B2"
jhash (0x703F524B)
arguments {
charPtr "alarmName" [=[ {} ]=],
BOOL "skipStartup" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
You should call [PREPARE_ALARM](#\_0x9D74AE343DB65533) and wait for its value to be true before using this
]]
native "START_AUDIO_SCENE"
hash "0x013A80FC08F6E4F2"
jhash (0xE48D757B)
arguments {
charPtr "scene" [=[ {} ]=],
}
ns "AUDIO"
returns "BOOL"
doc [[!
```
Used to prepare a scene where the surrounding sound is muted or a bit changed. This does not play any sound.
List of all usable scene names found in b617d. Sorted alphabetically and identical names removed: pastebin.com/MtM9N9CC
```
]]
native "START_PRELOADED_CONVERSATION"
hash "0x23641AFE870AF385"
jhash (0xA170261B)
ns "AUDIO"
returns "void"
doc [[!
For use with [PRELOAD_SCRIPT_CONVERSATION](#\_0x3B3CAD6166916D87) and [GET_IS_PRELOADED_CONVERSATION_READY](#\_0xE73364DB90778FFA)
]]
native "START_SCRIPT_CONVERSATION"
hash "0x6B17C62C9635D2DC"
jhash (0xE5DE7D9D)
arguments {
BOOL "displaySubtitles" [=[ {} ]=],
BOOL "addToBriefScreen" [=[ {} ]=],
BOOL "cloneConversation" [=[ {} ]=],
BOOL "interruptible" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
Defaults to true
Defaults to false
Defaults to true
]]
native "START_SCRIPT_PHONE_CONVERSATION"
hash "0x252E5F915EABB675"
jhash (0x38E42D07)
arguments {
BOOL "displaySubtitles" [=[ {} ]=],
BOOL "addToBriefScreen" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
Defaults to true
]]
native "STOP_ALARM"
hash "0xA1CADDCD98415A41"
jhash (0xF987BE8C)
arguments {
charPtr "alarmName" [=[ {} ]=],
BOOL "instantStop" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
Whether to kill the alarm instantly, or to let the audio system turn it off when it becomes inaudible
]]
native "STOP_ALL_ALARMS"
hash "0x2F794A877ADD4C92"
jhash (0xC3CB9DC6)
arguments {
BOOL "instantStop" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
Whether to kill the alarm instantly, or to let the audio system turn it off when it becomes inaudible
]]
native "STOP_AUDIO_SCENE"
hash "0xDFE8422B3B94E688"
jhash (0xA08D8C58)
arguments {
charPtr "sceneName" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
Stops the named mixing scene (which was previously started by this script)
]]
native "STOP_AUDIO_SCENES"
hash "0xBAC7FC81A75EC1A1"
jhash (0xF6C7342A)
ns "AUDIO"
returns "void"
doc [[!
Stops all mixed scenes which were previously started by this script
]]
native "STOP_CURRENT_PLAYING_AMBIENT_SPEECH"
hash "0xB8BEC0CA6F0EDB0F"
jhash (0xBB8E64BF)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
Stops currently playing ambient speech.
]]
native "STOP_CURRENT_PLAYING_SPEECH"
hash "0x7A73D05A607734C7"
jhash (0x5B7463F4)
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0x7A73D05A607734C7"
alias "_SET_PED_MUTE"
ns "AUDIO"
returns "void"
doc [[!
Stops currently playing speech (Pain, ambient, scripted, breathing).
]]
native "STOP_CUTSCENE_AUDIO"
hash "0x806058BBDC136E06"
jhash (0x55461BE6)
alias "0x806058BBDC136E06"
ns "AUDIO"
returns "void"
doc [[!
Stops audio for the current cutscene.
]]
native "STOP_PED_RINGTONE"
hash "0x6C5AE23EFA885092"
jhash (0xFEEA107C)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
Stops a ped's ringtone from playing
]]
native "STOP_PED_SPEAKING"
hash "0x9D64D7405520E3D3"
jhash (0xFF92B49D)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "shouldDisable" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
This doesn't stop a piece of dialogue that has been triggered.
This stops the ability to force ambient dialogue if set to true - however setting it to false, then triggering a context, then setting it to true again will allow this.
Nb. This does not sync over the network, it will only affect peds locally. Use [STOP_PED_SPEAKING_SYNCED](#\_0xAB6781A5F3101470) if you need to affect peds on other machines too.
]]
native "STOP_PED_SPEAKING_SYNCED"
hash "0xAB6781A5F3101470"
arguments {
Ped "ped" [=[ {} ]=],
BOOL "shouldDisable" [=[ {"cs_type":"Any"} ]=],
}
alias "0xAB6781A5F3101470"
ns "AUDIO"
returns "void"
doc [[!
This doesn't stop a piece of dialogue that has been triggered.
This stops the ability to force ambient dialogue if set to true - however setting it to false, then triggering a context, then setting it to true again will allow this.
The ped will also be prevented from speaking on remote machines. Use [STOP_PED_SPEAKING](#\_0x9D64D7405520E3D3) if you just want to affect the local machine.
]]
native "STOP_SCRIPTED_CONVERSATION"
hash "0xD79DEEFB53455EBA"
jhash (0xAB77DA7D)
arguments {
BOOL "finishCurrentLine" [=[ {} ]=],
}
ns "AUDIO"
returns "int"
doc [[!
]]
native "STOP_SMOKE_GRENADE_EXPLOSION_SOUNDS"
hash "0xE4E6DD5566D28C82"
jhash (0x7262B5BA)
alias "0xE4E6DD5566D28C82"
ns "AUDIO"
returns "void"
doc [[!
Stops all smoke grenade sounds
]]
native "STOP_SOUND"
hash "0xA3B0C41BA5CC0BB5"
jhash (0xCD7F4030)
arguments {
int "soundId" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
Stops the sound from currently playing, there isn't a way to resume a sound
after stopping it.
The sound id to stop
]]
native "STOP_STREAM"
hash "0xA4718A1419D18151"
jhash (0xD1E364DE)
ns "AUDIO"
returns "void"
doc [[!
]]
native "STOP_SYNCHRONIZED_AUDIO_EVENT"
hash "0x92D6A88E64A94430"
jhash (0xADEED2B4)
arguments {
Any "p0" [=[ {} ]=],
}
ns "AUDIO"
returns "BOOL"
doc [[!
]]
native "TRIGGER_MUSIC_EVENT"
hash "0x706D57B0F50DA710"
jhash (0xB6094948)
arguments {
charPtr "eventName" [=[ {} ]=],
}
ns "AUDIO"
returns "BOOL"
doc [[!
```
List of all usable event names found in b617d used with this native. Sorted alphabetically and identical names removed: pastebin.com/RzDFmB1W
All music event names found in the b617d scripts: pastebin.com/GnYt0R3P
```
]]
native "UNBLOCK_SPEECH_CONTEXT_GROUP"
hash "0x2ACABED337622DF2"
arguments {
charPtr "groupName" [=[ {} ]=],
}
alias "0x2ACABED337622DF2"
ns "AUDIO"
returns "void"
doc [[!
```
NativeDB Introduced: v1493
```
Removes all instances of a given context block.
Context group name to unblock.
]]
native "UNFREEZE_RADIO_STATION"
hash "0xFC00454CF60B91DD"
jhash (0x4D46202C)
arguments {
charPtr "radioStation" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
]]
native "UNLOCK_MISSION_NEWS_STORY"
hash "0xB165AB7C248B2DC1"
jhash (0xCCD9ABE4)
arguments {
int "newsStory" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
]]
native "UNLOCK_RADIO_STATION_TRACK_LIST"
hash "0x031ACB6ABA18C729"
jhash (0xBE998184)
arguments {
charPtr "radioStation" [=[ {} ]=],
charPtr "trackListName" [=[ {} ]=],
}
alias "0x031ACB6ABA18C729"
ns "AUDIO"
returns "void"
doc [[!
```
AUDIO::UNLOCK_RADIO_STATION_TRACK_LIST("RADIO_16_SILVERLAKE", "MIRRORPARK_LOCKED");
```
]]
native "UNREGISTER_SCRIPT_WITH_AUDIO"
hash "0xA8638BE228D4751A"
jhash (0x66728EFE)
ns "AUDIO"
returns "void"
doc [[!
**This native does absolutely nothing, just a nullsub**
```
On last-gen this just runs blr and this func is called by several other functions other then the native's table.
```
]]
native "UNREQUEST_TENNIS_BANKS"
hash "0x0150B6FF25A9E2E5"
jhash (0x1134F68B)
alias "0x0150B6FF25A9E2E5"
ns "AUDIO"
returns "void"
doc [[!
Unloads tennis vocalization banks loaded with [`REQUEST_TENNIS_BANKS`](#\_0x4ADA3F19BE4A6047).
]]
native "UPDATE_SOUND_COORD"
hash "0x7EC3C679D0E7E46B"
arguments {
int "soundId" [=[ {} ]=],
float "x" [=[ {"cs_type":"Any"} ]=],
float "y" [=[ {"cs_type":"Any"} ]=],
float "z" [=[ {"cs_type":"Any"} ]=],
}
alias "0x7EC3C679D0E7E46B"
ns "AUDIO"
returns "void"
doc [[!
Updates a playing sounds absolute position.
]]
native "UPDATE_UNLOCKABLE_DJ_RADIO_TRACKS"
hash "0x47AED84213A47510"
arguments {
BOOL "allowTrackReprioritization" [=[ {} ]=],
}
alias "_UPDATE_LSUR"
ns "AUDIO"
returns "void"
doc [[!
Unlocks any available DJ radio tracks based on the tuneable status
```
NativeDB Introduced: v1493
```
]]
native "USE_FOOTSTEP_SCRIPT_SWEETENERS"
hash "0xBF4DC1784BE94DFA"
jhash (0xD99E275B)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "useSweetner" [=[ {} ]=],
Hash "soundSetHash" [=[ {"cs_type":"Any"} ]=],
}
alias "0xBF4DC1784BE94DFA"
ns "AUDIO"
returns "void"
doc [[!
Allows script to trigger a sweetener footstep sound
]]
native "USE_SIREN_AS_HORN"
hash "0xFA932DE350266EF8"
jhash (0xC6BC16F3)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "sirenAsHorn" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
]]
native "_FORCE_VEHICLE_ENGINE_SYNTH"
hash "0xEB7D0E1FCC8FE17A"
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "force" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
This native is used alongside with [`SET_VEHICLE_TYRE_BURST`](#\_0xEC6A202EE4960385).
```
NativeDB Introduced: v3258
```
]]
native "_GET_CURRENT_RADIO_TRACK_PLAYBACK_TIME"
hash "0x3E65CDE5215832C1"
arguments {
charPtr "radioStationName" [=[ {} ]=],
}
alias "0x3E65CDE5215832C1"
alias "_GET_CURRENT_RADIO_STATION_HASH"
ns "AUDIO"
returns "int"
doc [[!
```
Return the playback time (in milliseconds) of the radio stations current track.
NativeDB Introduced: v1493
```
]]
native "_SET_PED_AUDIO_FOOTSTEP_LOUD"
hash "0x0653B735BFBDFE87"
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x0653B735BFBDFE87"
ns "AUDIO"
returns "void"
doc [[!
```
Enables/disables ped's "loud" footstep sound.
```
```
NativeDB Introduced: v1493
```
]]
native "_SET_PED_AUDIO_GENDER"
hash "0xA5342D390CDA41D6"
arguments {
Ped "ped" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
alias "0xA5342D390CDA41D6"
ns "AUDIO"
returns "void"
doc [[!
]]
native "_SET_PED_VOICE_GROUP"
hash "0x7CDC8C3B89F661B3"
arguments {
Ped "ped" [=[ {} ]=],
Hash "voiceGroupHash" [=[ {} ]=],
}
alias "0x7CDC8C3B89F661B3"
ns "AUDIO"
returns "void"
doc [[!
```
From the scripts:
AUDIO::_SET_PED_VOICE_GROUP(PLAYER::PLAYER_PED_ID(), MISC::GET_HASH_KEY("PAIGE_PVG"));
AUDIO::_SET_PED_VOICE_GROUP(PLAYER::PLAYER_PED_ID(), MISC::GET_HASH_KEY("TALINA_PVG"));
AUDIO::_SET_PED_VOICE_GROUP(PLAYER::PLAYER_PED_ID(), MISC::GET_HASH_KEY("FEMALE_LOST_BLACK_PVG"));
AUDIO::_SET_PED_VOICE_GROUP(PLAYER::PLAYER_PED_ID(), MISC::GET_HASH_KEY("FEMALE_LOST_WHITE_PVG"));
```
]]
native "_SET_PED_VOICE_GROUP_RACE"
hash "0x0BABC1345ABBFB16"
arguments {
Ped "ped" [=[ {} ]=],
Hash "voiceGroupHash" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
```
Dat151RelType == 29
```
```
NativeDB Introduced: v2699
```
]]
native "_SET_RADIO_STATION_IS_VISIBLE"
hash "0x4CAFEBFA21EC188D"
arguments {
charPtr "radioStation" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
Doesn't have an effect in Story Mode.
```
NativeDB Introduced: v2372
```
]]
native "_SET_RADIO_TRACK_MIX"
hash "0x2CB0075110BE1E56"
arguments {
charPtr "radioStationName" [=[ {} ]=],
charPtr "mixName" [=[ {} ]=],
int "p2" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
```
NativeDB Introduced: v1493
```
]]
native "_SET_SIREN_KEEP_ON"
hash "0xF584CF8529B51434"
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0xF584CF8529B51434"
ns "AUDIO"
returns "void"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "_SET_VARIABLE_ON_CUTSCENE_AUDIO"
hash "0xBCC29F935ED07688"
jhash (0xD63CF33A)
arguments {
charPtr "variableName" [=[ {} ]=],
float "value" [=[ {} ]=],
}
alias "GET_PLAYER_HEADSET_SOUND_ALTERNATE"
ns "AUDIO"
returns "void"
doc [[!
```
SET_VARIABLE_ON_*
```
]]
native "_SET_VEH_HAS_RADIO_OVERRIDE"
hash "0x3E45765F3FBB582F"
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0x3E45765F3FBB582F"
ns "AUDIO"
returns "void"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "_SET_VEHICLE_HORN_VARIATION"
hash "0x0350E7E17BA767D0"
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "value" [=[ {} ]=],
}
alias "0x0350E7E17BA767D0"
alias "0xCDA42C4BB9BDE779"
ns "AUDIO"
returns "void"
doc [[!
```
NativeDB Introduced: v1365
```
]]
native "_SOUND_VEHICLE_HORN_THIS_FRAME"
hash "0x9C11908013EA4715"
jhash (0xDE8BA3CD)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0x9C11908013EA4715"
ns "AUDIO"
returns "void"
doc [[!
```
SET_*
```
]]
native "_TRIGGER_SIREN"
hash "0x66C3FB05206041BA"
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0x66C3FB05206041BA"
ns "AUDIO"
returns "void"
doc [[!
... When not in a vehicle
```
NativeDB Introduced: v1290
```
]]
native "0x02E93C796ABD3A97"
hash "0x02E93C796ABD3A97"
jhash (0x3C395AEE)
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
**This native does absolutely nothing, just a nullsub**
]]
native "0x11579D940949C49E"
hash "0x11579D940949C49E"
arguments {
Any "p0" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
]]
native "0x19AF7ED9B9D23058"
hash "0x19AF7ED9B9D23058"
jhash (0xA58BBF4F)
ns "AUDIO"
returns "void"
doc [[!
]]
native "0x2DD39BF3E2F9C47F"
hash "0x2DD39BF3E2F9C47F"
ns "AUDIO"
returns "Any"
doc [[!
```
NativeDB Introduced: v463
```
]]
native "0x43FA0DFC5DF87815"
hash "0x43FA0DFC5DF87815"
jhash (0x7BED1872)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
]]
native "0x55ECF4D13D9903B0"
hash "0x55ECF4D13D9903B0"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
```
NativeDB Introduced: v1868
```
]]
native "0x58BB377BEC7CD5F4"
hash "0x58BB377BEC7CD5F4"
jhash (0x8CE63FA1)
arguments {
BOOL "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
]]
native "0x5B9853296731E88D"
hash "0x5B9853296731E88D"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
]]
native "0x8BF907833BE275DE"
hash "0x8BF907833BE275DE"
jhash (0x2CD26D69)
arguments {
float "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
]]
native "0x97FFB4ADEED08066"
hash "0x97FFB4ADEED08066"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "0x9AC92EED5E4793AB"
hash "0x9AC92EED5E4793AB"
jhash (0xE67446E9)
ns "AUDIO"
returns "void"
doc [[!
]]
native "0x9BD7BD55E4533183"
hash "0x9BD7BD55E4533183"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "0x9D3AF56E94C9AE98"
hash "0x9D3AF56E94C9AE98"
jhash (0x2F0A16D1)
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "p1" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
```
SET_H*
```
]]
native "0xB542DE8C3D1CB210"
hash "0xB542DE8C3D1CB210"
jhash (0x789D8C6C)
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
]]
native "0xBEF34B1D9624D5DD"
hash "0xBEF34B1D9624D5DD"
jhash (0xE0047BFD)
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
]]
native "0xC1805D05E6D4FE10"
hash "0xC1805D05E6D4FE10"
jhash (0x7ABB89D2)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "AUDIO"
returns "void"
doc [[!
```
SET_VEH*
```
]]
native "ADD_TO_CLOCK_TIME"
hash "0xD716F30D8C8980E2"
jhash (0xCC40D20D)
arguments {
int "hours" [=[ {} ]=],
int "minutes" [=[ {} ]=],
int "seconds" [=[ {} ]=],
}
ns "CLOCK"
returns "void"
doc [[!
]]
native "ADVANCE_CLOCK_TIME_TO"
hash "0xC8CA9670B9D83B3B"
jhash (0x57B8DA7C)
arguments {
int "hour" [=[ {} ]=],
int "minute" [=[ {} ]=],
int "second" [=[ {} ]=],
}
ns "CLOCK"
returns "void"
doc [[!
]]
native "GET_CLOCK_DAY_OF_MONTH"
hash "0x3D10BC92A4DB1D35"
jhash (0xC7A5ACB7)
ns "CLOCK"
returns "int"
doc [[!
]]
native "GET_CLOCK_DAY_OF_WEEK"
hash "0xD972E4BD7AEB235F"
jhash (0x84E4A289)
ns "CLOCK"
returns "int"
doc [[!
```
Gets the current day of the week.
0: Sunday
1: Monday
2: Tuesday
3: Wednesday
4: Thursday
5: Friday
6: Saturday
```
]]
native "GET_CLOCK_HOURS"
hash "0x25223CA6B4D20B7F"
jhash (0x7EF8316F)
ns "CLOCK"
returns "int"
doc [[!
```
Gets the current ingame hour, expressed without zeros. (09:34 will be represented as 9)
```
]]
native "GET_CLOCK_MINUTES"
hash "0x13D2B8ADD79640F2"
jhash (0x94AAC486)
ns "CLOCK"
returns "int"
doc [[!
```
Gets the current ingame clock minute.
```
]]
native "GET_CLOCK_MONTH"
hash "0xBBC72712E80257A1"
jhash (0x3C48A3D5)
ns "CLOCK"
returns "int"
doc [[!
]]
native "GET_CLOCK_SECONDS"
hash "0x494E97C2EF27C470"
jhash (0x099C927E)
ns "CLOCK"
returns "int"
doc [[!
```
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.
```
]]
native "GET_CLOCK_YEAR"
hash "0x961777E64BDAF717"
jhash (0xB8BECF15)
ns "CLOCK"
returns "int"
doc [[!
]]
native "GET_LOCAL_TIME"
hash "0x50C7A99057A69748"
jhash (0x124BCFA2)
arguments {
intPtr "year" [=[ {} ]=],
intPtr "month" [=[ {} ]=],
intPtr "day" [=[ {} ]=],
intPtr "hour" [=[ {} ]=],
intPtr "minute" [=[ {} ]=],
intPtr "second" [=[ {} ]=],
}
ns "CLOCK"
returns "void"
doc [[!
```
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);
```
]]
native "GET_MILLISECONDS_PER_GAME_MINUTE"
hash "0x2F8B4D1C595B11DB"
jhash (0x3B74095C)
ns "CLOCK"
returns "int"
doc [[!
Returns how many real ms are equal to one game minute.
A getter for [`SetMillisecondsPerGameMinute`](#\_0x36CA2554).
A number of milliseconds that equals to one game minute.
]]
native "GET_POSIX_TIME"
hash "0xDA488F299A5B164E"
jhash (0xE15A5281)
arguments {
intPtr "year" [=[ {} ]=],
intPtr "month" [=[ {} ]=],
intPtr "day" [=[ {} ]=],
intPtr "hour" [=[ {} ]=],
intPtr "minute" [=[ {} ]=],
intPtr "second" [=[ {} ]=],
}
ns "CLOCK"
returns "void"
doc [[!
```
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);
```
]]
native "GET_UTC_TIME"
hash "0x8117E09A19EEF4D3"
jhash (0xC589CD7D)
arguments {
intPtr "year" [=[ {} ]=],
intPtr "month" [=[ {} ]=],
intPtr "day" [=[ {} ]=],
intPtr "hour" [=[ {} ]=],
intPtr "minute" [=[ {} ]=],
intPtr "second" [=[ {} ]=],
}
alias "_GET_UTC_TIME"
ns "CLOCK"
returns "void"
doc [[!
```
Gets current UTC time
```
]]
native "PAUSE_CLOCK"
hash "0x4055E40BD2DBEC1D"
jhash (0xB02D6124)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "CLOCK"
returns "void"
doc [[!
]]
native "SET_CLOCK_DATE"
hash "0xB096419DF0D06CE7"
jhash (0x96891C94)
arguments {
int "day" [=[ {} ]=],
int "month" [=[ {} ]=],
int "year" [=[ {} ]=],
}
ns "CLOCK"
returns "void"
doc [[!
]]
native "SET_CLOCK_TIME"
hash "0x47C3B5848C3E45D8"
jhash (0x26F6AF14)
arguments {
int "hour" [=[ {} ]=],
int "minute" [=[ {} ]=],
int "second" [=[ {} ]=],
}
ns "CLOCK"
returns "void"
doc [[!
```
SET_CLOCK_TIME(12, 34, 56);
```
]]
native "CAN_REQUEST_ASSETS_FOR_CUTSCENE_ENTITY"
hash "0xB56BBBCC2955D9CB"
jhash (0xDD8878E9)
alias "0xB56BBBCC2955D9CB"
ns "CUTSCENE"
returns "BOOL"
doc [[!
Returns when it is safe to start applying changes to cutscene entities.
Should always be used for applying components.
See [`SET_CUTSCENE_PED_COMPONENT_VARIATION_FROM_PED`](#\_0x2A56C06EBEF2B0D9) and [`REGISTER_ENTITY_FOR_CUTSCENE`](#\_0xE40C1C56DF95C2E8) for an example.
This will be true before the cutscene is considered loaded
Whether you can request assets for cutscene entities, like components.
]]
native "CAN_SET_ENTER_STATE_FOR_REGISTERED_ENTITY"
hash "0x645D0B458D8E17B5"
jhash (0x55C30B26)
arguments {
charPtr "cutsceneEntName" [=[ {} ]=],
Hash "modelHash" [=[ {} ]=],
}
ns "CUTSCENE"
returns "BOOL"
doc [[!
```
modelHash (p1) was always 0 in R* scripts
```
]]
native "CAN_SET_EXIT_STATE_FOR_CAMERA"
hash "0xB2CBCD0930DFB420"
jhash (0xEDAE6C02)
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "CUTSCENE"
returns "BOOL"
doc [[!
Whether or not it is safe to run functions on the camera,
as the camera is now no longer being used by the cutscene.
]]
native "CAN_SET_EXIT_STATE_FOR_REGISTERED_ENTITY"
hash "0x4C6A6451C79E4662"
jhash (0x8FF5D3C4)
arguments {
charPtr "cutsceneEntName" [=[ {} ]=],
Hash "modelHash" [=[ {} ]=],
}
ns "CUTSCENE"
returns "BOOL"
doc [[!
Returns if the script can begin interacting with the registered entity. Primarly used for lead-outs of cutscenes.
Returns on frame after cutscene ends, so you cannot get is while using IsCutsceneActive()
Whether it is safe to start doing scripted actions on the entity, like simulating walking out of a cutscene.
Name of the entity cHandle in the cutscene
Can be 0
Whether or not it is safe to begin interacting with the entity
]]
native "DOES_CUTSCENE_ENTITY_EXIST"
hash "0x499EF20C5DB25C59"
jhash (0x58E67409)
arguments {
charPtr "cutsceneEntName" [=[ {} ]=],
Hash "modelHash" [=[ {} ]=],
}
ns "CUTSCENE"
returns "BOOL"
doc [[!
]]
native "GET_CUTSCENE_END_TIME"
hash "0x971D7B15BCDBEF99"
alias "0x971D7B15BCDBEF99"
alias "_GET_CUTSCENE_END_TIME"
ns "CUTSCENE"
returns "int"
doc [[!
Returns the time of the cutscene's end accounting for [`REQUEST_CUTSCENE_WITH_PLAYBACK_LIST`](#\_0xC23DE0E91C30B58C)
If a cutscene is laid out with 10 second sections, and section 0 and 1 are enabled then it would be 20000ms.
```
NativeDB Introduced: v1734
```
]]
native "GET_CUTSCENE_PLAY_TIME"
hash "0x710286BC5EF4D6E1"
ns "CUTSCENE"
returns "int"
doc [[!
Gets the current time of the cutscene.
```
NativeDB Introduced: v3258
```
Returns the current play time of the cutscene in milliseconds.
]]
native "GET_CUTSCENE_SECTION_PLAYING"
hash "0x49010A6A396553D8"
jhash (0x1026F0D6)
ns "CUTSCENE"
returns "int"
doc [[!
]]
native "GET_CUTSCENE_TIME"
hash "0xE625BEABBAFFDAB9"
jhash (0x53F5B5AB)
ns "CUTSCENE"
returns "int"
doc [[!
Gets the elapsed time of the current cutscene in
Elapsed time in milliseconds
]]
native "GET_CUTSCENE_TOTAL_DURATION"
hash "0xEE53B14A19E480D4"
jhash (0x0824EBE8)
ns "CUTSCENE"
returns "int"
doc [[!
Gets the total length of the cutscene irrespective of playback list in milliseconds
To account for sections, see [`GET_CUTSCENE_END_TIME`](#\_0x971D7B15BCDBEF99)
Cutscene total length in milliseconds
]]
native "GET_ENTITY_INDEX_OF_CUTSCENE_ENTITY"
hash "0x0A2E9FDB9A8C62F6"
jhash (0x1D09ABC7)
arguments {
charPtr "cutsceneEntName" [=[ {} ]=],
Hash "modelHash" [=[ {} ]=],
}
ns "CUTSCENE"
returns "Entity"
doc [[!
Returns the handle of a cutscene entity, can be ped
I.E MP\_1, MP\_4, Michael, Trevor
Not strictly neccasary, can get 0
Returns entity handle
]]
native "GET_ENTITY_INDEX_OF_REGISTERED_ENTITY"
hash "0xC0741A26499654CD"
jhash (0x46D18755)
arguments {
charPtr "cutsceneEntName" [=[ {} ]=],
Hash "modelHash" [=[ {} ]=],
}
ns "CUTSCENE"
returns "Entity"
doc [[!
]]
native "HAS_CUT_FILE_LOADED"
hash "0xA1C996C2A744262E"
jhash (0x56D5B144)
arguments {
charPtr "cutsceneName" [=[ {} ]=],
}
alias "0xA1C996C2A744262E"
ns "CUTSCENE"
returns "BOOL"
doc [[!
```
Simply checks if the cutscene has loaded and doesn't check via CutSceneManager as opposed to HAS_[THIS]_CUTSCENE_LOADED.
```
]]
native "HAS_CUTSCENE_CUT_THIS_FRAME"
hash "0x708BDD8CD795B043"
jhash (0x4315A7C5)
alias "0x708BDD8CD795B043"
ns "CUTSCENE"
returns "BOOL"
doc [[!
]]
native "HAS_CUTSCENE_FINISHED"
hash "0x7C0A893088881D57"
jhash (0x5DED14B4)
ns "CUTSCENE"
returns "BOOL"
doc [[!
]]
native "HAS_CUTSCENE_LOADED"
hash "0xC59F528E9AB9F339"
jhash (0xF9998582)
ns "CUTSCENE"
returns "BOOL"
doc [[!
]]
native "HAS_THIS_CUTSCENE_LOADED"
hash "0x228D3D94F8A11C3C"
jhash (0x3C5619F2)
arguments {
charPtr "cutsceneName" [=[ {} ]=],
}
ns "CUTSCENE"
returns "BOOL"
doc [[!
]]
native "IS_CUTSCENE_ACTIVE"
hash "0x991251AFC3981F84"
jhash (0xCCE2FE9D)
ns "CUTSCENE"
returns "BOOL"
doc [[!
]]
native "IS_CUTSCENE_PLAYBACK_FLAG_SET"
hash "0x71B74D2AE19338D0"
jhash (0x7B93CDAA)
arguments {
int "flag" [=[ {} ]=],
}
alias "0x71B74D2AE19338D0"
ns "CUTSCENE"
returns "BOOL"
doc [[!
]]
native "IS_CUTSCENE_PLAYING"
hash "0xD3C2E180A40F031E"
jhash (0xA3A78392)
ns "CUTSCENE"
returns "BOOL"
doc [[!
]]
native "REGISTER_ENTITY_FOR_CUTSCENE"
hash "0xE40C1C56DF95C2E8"
jhash (0x7CBC3EC7)
arguments {
Entity "cutsceneEntity" [=[ {} ]=],
charPtr "cutsceneEntName" [=[ {} ]=],
int "p2" [=[ {} ]=],
Hash "modelHash" [=[ {} ]=],
int "p4" [=[ {} ]=],
}
ns "CUTSCENE"
returns "void"
doc [[!
This can only be run once [`CAN_REQUEST_ASSETS_FOR_CUTSCENE_ENTITY`](#\_0xB56BBBCC2955D9CB) is true, but can be run before [`HAS_CUTSCENE_LOADED`](#\_0xC59F528E9AB9F339)
Entity to put into the cutscene.
cHandle of cutscene entity, i.e Michael, MP\_1, MP\_4, Lamar
Not strictly neccasary, often 0 in R\* scripts
0 for SP, 64 for MP seemingly
]]
native "REGISTER_SYNCHRONISED_SCRIPT_SPEECH"
hash "0x2131046957F31B04"
jhash (0xB60CFBB9)
ns "CUTSCENE"
returns "void"
doc [[!
Only used twice in armenian1.c
]]
native "REMOVE_CUT_FILE"
hash "0xD00D76A7DFC9D852"
jhash (0xB70D7C6D)
arguments {
charPtr "cutsceneName" [=[ {} ]=],
}
alias "0xD00D76A7DFC9D852"
ns "CUTSCENE"
returns "void"
doc [[!
```
Simply unloads the cutscene and doesn't do extra stuff that REMOVE_CUTSCENE does.
```
]]
native "REMOVE_CUTSCENE"
hash "0x440AF51A3462B86F"
jhash (0x8052F533)
ns "CUTSCENE"
returns "void"
doc [[!
]]
native "REQUEST_CUT_FILE"
hash "0x06A3524161C502BA"
jhash (0x0D732CD6)
arguments {
charPtr "cutsceneName" [=[ {} ]=],
}
alias "0x06A3524161C502BA"
ns "CUTSCENE"
returns "void"
doc [[!
```
Simply loads the cutscene and doesn't do extra stuff that REQUEST_CUTSCENE does.
```
]]
native "REQUEST_CUTSCENE"
hash "0x7A86743F475D9E09"
jhash (0xB5977853)
arguments {
charPtr "cutsceneName" [=[ {} ]=],
int "flags" [=[ {} ]=],
}
ns "CUTSCENE"
returns "void"
doc [[!
Case insensitive name of the .cut file
Usually 8
]]
native "REQUEST_CUTSCENE_WITH_PLAYBACK_LIST"
hash "0xC23DE0E91C30B58C"
jhash (0xD98F656A)
arguments {
charPtr "cutsceneName" [=[ {} ]=],
int "playbackFlags" [=[ {} ]=],
int "flags" [=[ {} ]=],
}
alias "0xC23DE0E91C30B58C"
alias "_REQUEST_CUTSCENE_EX"
ns "CUTSCENE"
returns "void"
doc [[!
```
playbackFlags: Which scenes should be played.
Example: 0x105 (bit 0, 2 and 8 set) will enable scene 1, 3 and 9.
```
Usually 8
]]
native "SET_CUTSCENE_CAN_BE_SKIPPED"
hash "0x41FAA8FB2ECE8720"
jhash (0x28D54A7F)
arguments {
BOOL "p0" [=[ {} ]=],
}
alias "0x41FAA8FB2ECE8720"
ns "CUTSCENE"
returns "void"
doc [[!
]]
native "SET_CUTSCENE_ENTITY_STREAMING_FLAGS"
hash "0x4C61C75BEE8184C2"
jhash (0x47DB08A9)
arguments {
charPtr "cutsceneEntName" [=[ {} ]=],
int "p1" [=[ {} ]=],
int "p2" [=[ {} ]=],
}
alias "0x4C61C75BEE8184C2"
ns "CUTSCENE"
returns "void"
doc [[!
Only used in networked environment with MP cutscenes
MP\_1, MP\_2, etc
Always 0 in R\* scripts
Always 1 in R\* scripts
]]
native "SET_CUTSCENE_FADE_VALUES"
hash "0x8093F23ABACCC7D4"
jhash (0xD19EF0DD)
arguments {
BOOL "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
}
ns "CUTSCENE"
returns "void"
doc [[!
]]
native "SET_CUTSCENE_ORIGIN"
hash "0xB812B3FD1C01CF27"
jhash (0xB0AD7792)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "heading" [=[ {} ]=],
int "p4" [=[ {} ]=],
}
ns "CUTSCENE"
returns "void"
doc [[!
Sets cutscene location, used for multiplayer apartments/businesses.
Often -1, 0 or 1
]]
native "SET_CUTSCENE_ORIGIN_AND_ORIENTATION"
hash "0x011883F41211432A"
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
int "p6" [=[ {} ]=],
}
alias "0x011883F41211432A"
ns "CUTSCENE"
returns "void"
doc [[!
]]
native "SET_CUTSCENE_PED_COMPONENT_VARIATION"
hash "0xBA01E7B6DEEFBBC9"
jhash (0x6AF994A1)
arguments {
charPtr "cutsceneEntName" [=[ {} ]=],
int "componentId" [=[ {} ]=],
int "drawableId" [=[ {} ]=],
int "textureId" [=[ {} ]=],
Hash "modelHash" [=[ {} ]=],
}
ns "CUTSCENE"
returns "void"
doc [[!
See [`SET_PED_COMPONENT_VARIATION`](#\_0x262B14F48D29DE80)
]]
native "SET_CUTSCENE_PED_COMPONENT_VARIATION_FROM_PED"
hash "0x2A56C06EBEF2B0D9"
jhash (0x1E7DA95E)
arguments {
charPtr "cutsceneEntName" [=[ {} ]=],
Ped "ped" [=[ {} ]=],
Hash "modelHash" [=[ {} ]=],
}
alias "0x2A56C06EBEF2B0D9"
ns "CUTSCENE"
returns "void"
doc [[!
Sets the components for a cutscene ped, this will take precendence over the cutscene's component overrides. This does not require the entity be registered.
See [`REGISTER_ENTITY_FOR_CUTSCENE`](#\_0xE40C1C56DF95C2E8) for an example.
Cutscene file cHandle, i.e Michael, Lamar, Franklin, MP\_1-MP\_4
Ped to copy components from
Not strictly neccasary, can be 0
]]
native "SET_CUTSCENE_PED_PROP_VARIATION"
hash "0x0546524ADE2E9723"
jhash (0x22E9A9DE)
arguments {
charPtr "cutsceneEntName" [=[ {} ]=],
int "componentId" [=[ {} ]=],
int "drawableId" [=[ {} ]=],
int "textureId" [=[ {} ]=],
Hash "modelHash" [=[ {} ]=],
}
alias "0x0546524ADE2E9723"
ns "CUTSCENE"
returns "void"
doc [[!
See [`SET_PED_PROP_INDEX`](#\_0x93376B65A266EB5F)
i.e Michael, Trevor, MP\_1, MP\_4
]]
native "SET_CUTSCENE_TRIGGER_AREA"
hash "0x9896CE4721BE84BA"
jhash (0x9D76D9DE)
arguments {
float "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
float "p4" [=[ {} ]=],
float "p5" [=[ {} ]=],
}
ns "CUTSCENE"
returns "void"
doc [[!
```
Only used twice in R* scripts
```
]]
native "START_CUTSCENE"
hash "0x186D5CB5E7B0FF7B"
jhash (0x210106F6)
arguments {
int "flags" [=[ {} ]=],
}
ns "CUTSCENE"
returns "void"
doc [[!
```
flags: Usually 0.
```
]]
native "START_CUTSCENE_AT_COORDS"
hash "0x1C9ADDA3244A1FBF"
jhash (0x58BEA436)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
int "flags" [=[ {} ]=],
}
ns "CUTSCENE"
returns "void"
doc [[!
Similar to [`SET_CUTSCENE_ORIGIN`](#\_0xB812B3FD1C01CF27) but without heading and doesn't need [`START_CUTSCENE`](#\_0x186D5CB5E7B0FF7B)
Usually 0
]]
native "STOP_CUTSCENE"
hash "0xC7272775B4DC786E"
jhash (0x5EE84DC7)
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "CUTSCENE"
returns "void"
doc [[!
Always false
]]
native "STOP_CUTSCENE_IMMEDIATELY"
hash "0xD220BDD222AC4A1E"
jhash (0xF528A2AD)
ns "CUTSCENE"
returns "void"
doc [[!
Stop cutscene instantly, will dump registered entities right where they were when ran.
]]
native "WAS_CUTSCENE_SKIPPED"
hash "0x40C8656EDAEDD569"
jhash (0xC9B6949D)
ns "CUTSCENE"
returns "BOOL"
doc [[!
]]
native "_GET_CUT_FILE_NUM_SECTIONS"
hash "0x0ABC54DE641DC0FC"
jhash (0xFD8B1AC2)
arguments {
charPtr "cutsceneName" [=[ {} ]=],
}
alias "0x0ABC54DE641DC0FC"
ns "CUTSCENE"
returns "int"
doc [[!
]]
native "0x06EE9048FD080382"
hash "0x06EE9048FD080382"
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "CUTSCENE"
returns "void"
doc [[!
]]
native "0x20746F7B1032A3C7"
hash "0x20746F7B1032A3C7"
arguments {
BOOL "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
}
ns "CUTSCENE"
returns "void"
doc [[!
]]
native "0x2F137B508DE238F2"
hash "0x2F137B508DE238F2"
jhash (0x8338DA1D)
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "CUTSCENE"
returns "void"
doc [[!
]]
native "0x4CEBC1ED31E8925E"
hash "0x4CEBC1ED31E8925E"
arguments {
charPtr "cutsceneName" [=[ {} ]=],
}
ns "CUTSCENE"
returns "BOOL"
doc [[!
```
This function is hard-coded to always return 1.
```
]]
native "0x4FCD976DA686580C"
hash "0x4FCD976DA686580C"
arguments {
Any "p0" [=[ {} ]=],
}
ns "CUTSCENE"
returns "Any"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "0x583DF8E3D4AFBD98"
hash "0x583DF8E3D4AFBD98"
jhash (0x5AE68AE6)
ns "CUTSCENE"
returns "int"
doc [[!
]]
native "0x5EDEF0CF8C1DAB3C"
hash "0x5EDEF0CF8C1DAB3C"
jhash (0xDBD88708)
ns "CUTSCENE"
returns "BOOL"
doc [[!
]]
native "0x7F96F23FA9B73327"
hash "0x7F96F23FA9B73327"
arguments {
Hash "modelHash" [=[ {} ]=],
}
ns "CUTSCENE"
returns "void"
doc [[!
```
SET_VEHICLE_*
```
]]
native "0x8D9DF6ECA8768583"
hash "0x8D9DF6ECA8768583"
jhash (0x25A2CABC)
arguments {
int "threadId" [=[ {} ]=],
}
ns "CUTSCENE"
returns "void"
doc [[!
```
SET_SCRIPT_*
Sets the cutscene's owning thread ID.
```
]]
native "0xA0FE76168A189DDB"
hash "0xA0FE76168A189DDB"
ns "CUTSCENE"
returns "int"
doc [[!
]]
native "0xC61B86C9F61EB404"
hash "0xC61B86C9F61EB404"
jhash (0x35721A08)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "CUTSCENE"
returns "void"
doc [[!
```
Toggles a value (bool) for cutscenes.
SET_*
```
]]
native "0xE36A98D8AB3D3C66"
hash "0xE36A98D8AB3D3C66"
jhash (0x04377C10)
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "CUTSCENE"
returns "void"
doc [[!
]]
native "ADD_CAM_SPLINE_NODE"
hash "0x8609C75EC438FB3B"
jhash (0xAD3C7EAA)
arguments {
Cam "camera" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "xRot" [=[ {} ]=],
float "yRot" [=[ {} ]=],
float "zRot" [=[ {} ]=],
int "length" [=[ {} ]=],
int "p8" [=[ {} ]=],
int "transitionType" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
```
I filled p1-p6 (the floats) as they are as other natives with 6 floats in a row are similar and I see no other method. So if a test from anyone proves them wrong please correct.
p7 (length) determines the length of the spline, affects camera path and duration of transition between previous node and this one
p8 big values ~100 will slow down the camera movement before reaching this node
p9 != 0 seems to override the rotation/pitch (bool?)
```
]]
native "ADD_CAM_SPLINE_NODE_USING_CAMERA"
hash "0x0FB82563989CF4FB"
jhash (0xBA6C085B)
arguments {
Cam "cam" [=[ {} ]=],
Cam "cam2" [=[ {} ]=],
int "length" [=[ {} ]=],
int "p3" [=[ {} ]=],
}
alias "0x0FB82563989CF4FB"
ns "CAM"
returns "void"
doc [[!
Takes a camera and uses the information from it as a camera spline node.
Camera to add cam2 as a node to
Camera used for reference
Duration used for transition, has no effect for the first node.
]]
native "ADD_CAM_SPLINE_NODE_USING_CAMERA_FRAME"
hash "0x0A9F2A468B328E74"
jhash (0x30510511)
arguments {
Cam "cam" [=[ {} ]=],
Cam "cam2" [=[ {} ]=],
int "p2" [=[ {} ]=],
int "p3" [=[ {} ]=],
}
alias "0x0A9F2A468B328E74"
ns "CAM"
returns "void"
doc [[!
]]
native "ADD_CAM_SPLINE_NODE_USING_GAMEPLAY_FRAME"
hash "0x609278246A29CA34"
jhash (0xB4737F03)
arguments {
Cam "cam" [=[ {} ]=],
int "p1" [=[ {} ]=],
int "p2" [=[ {} ]=],
}
alias "0x609278246A29CA34"
ns "CAM"
returns "void"
doc [[!
]]
native "ANIMATED_SHAKE_CAM"
hash "0xA2746EEAE3E577CD"
jhash (0xE1168767)
arguments {
Cam "cam" [=[ {} ]=],
charPtr "p1" [=[ {} ]=],
charPtr "p2" [=[ {} ]=],
charPtr "p3" [=[ {} ]=],
float "amplitude" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
```
Example from michael2 script.
CAM::ANIMATED_SHAKE_CAM(l_5069, "shake_cam_all@", "light", "", 1f);
```
]]
native "ANIMATED_SHAKE_SCRIPT_GLOBAL"
hash "0xC2EAE3FB8CDBED31"
jhash (0xCB75BD9C)
arguments {
charPtr "p0" [=[ {} ]=],
charPtr "p1" [=[ {} ]=],
charPtr "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
}
alias "0xC2EAE3FB8CDBED31"
ns "CAM"
returns "void"
doc [[!
```
CAM::ANIMATED_SHAKE_SCRIPT_GLOBAL("SHAKE_CAM_medium", "medium", "", 0.5f);
```
]]
native "ATTACH_CAM_TO_ENTITY"
hash "0xFEDB7D269E8C60E3"
jhash (0xAD7C45F6)
arguments {
Cam "cam" [=[ {} ]=],
Entity "entity" [=[ {} ]=],
float "xOffset" [=[ {} ]=],
float "yOffset" [=[ {} ]=],
float "zOffset" [=[ {} ]=],
BOOL "isRelative" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
```
Last param determines if its relative to the Entity
```
The camera handle.
The entity handle.
X-axis offset
Y-axis offset
Z-axis offset
Whether or not the camera will be relative to the entity
]]
native "ATTACH_CAM_TO_PED_BONE"
hash "0x61A3DBA14AB7F411"
jhash (0x506BB35C)
arguments {
Cam "cam" [=[ {} ]=],
Ped "ped" [=[ {} ]=],
int "boneIndex" [=[ {} ]=],
float "xOffset" [=[ {} ]=],
float "yOffset" [=[ {} ]=],
float "zOffset" [=[ {} ]=],
BOOL "isRelative" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
This native works with peds only.
The camera handle.
The ped handle.
This is different to boneID, use ['GET_PED_BONE_INDEX'](#\_0x3F428D08BE5AAE31) to get the index from the ID. use the index for attaching to specific bones. `cam` will be attached to the center of `ped` if bone index given doesn't correspond to bone indexes for that entity type.
X-axis offset
Y-axis offset
Z-axis offset
Whether or not the camera will be relative to the bone
]]
native "CREATE_CAM"
hash "0xC3981DCE61D9E13F"
jhash (0xE9BF2A7D)
arguments {
charPtr "camName" [=[ {} ]=],
BOOL "active" [=[ {} ]=],
}
ns "CAM"
returns "Cam"
doc [[!
Creates a camera with the specified cam name, You can use `SET_CAM_` natives to manipulate the camera.\
Make sure to call [RENDER_SCRIPT_CAMS](#\_0x07E5B515DB0636FC) once the camera is created, or this won't have any visible effect.
### Camera names:
* DEFAULT_SCRIPTED_CAMERA
* DEFAULT_ANIMATED_CAMERA
* DEFAULT_SPLINE_CAMERA
* DEFAULT_SCRIPTED_FLY_CAMERA
* TIMED_SPLINE_CAMERA
* CUSTOM_TIMED_SPLINE_CAMERA
* ROUNDED_SPLINE_CAMERA
* SMOOTHED_SPLINE_CAMERA
A string representing the camera type, the game will convert the string into a joaat hash upon native execution.
Set to true if you wish to make this new camera the active camera.
A camera handle referencing the camera that was created.
]]
native "CREATE_CAM_WITH_PARAMS"
hash "0xB51194800B257161"
jhash (0x23B02F15)
arguments {
charPtr "camName" [=[ {} ]=],
float "posX" [=[ {} ]=],
float "posY" [=[ {} ]=],
float "posZ" [=[ {} ]=],
float "rotX" [=[ {} ]=],
float "rotY" [=[ {} ]=],
float "rotZ" [=[ {} ]=],
float "fov" [=[ {} ]=],
BOOL "active" [=[ {} ]=],
int "rotationOrder" [=[ {} ]=],
}
ns "CAM"
returns "Cam"
doc [[!
Create a camera with the specified cam name/type, You can use `SET_CAM_` natives to manipulate the camera.
Take a look at [CREATE_CAM](#\_0xC3981DCE61D9E13F) if you would like to see the available camera names.
A string representing the camera type, the game will convert the string into a joaat hash upon native execution.
The x position of the camera (you can also send a vector3 instead of the bulk coordinates)
The y position of the camera (you can also send a vector3 instead of the bulk coordinates)
The z position of the camera (you can also send a vector3 instead of the bulk coordinates)
The x rotation of the camera
The y rotation of the camera
The z rotation of the camera
The Field Of View of the camera, is the observable world that is seen
Set to true if you wish to make this new camera the active camera.
The order of rotation, see [`GET_ENTITY_ROTATION`](#\_0xAFBD61CC738D9EB9)
A camera handle.
]]
native "CREATE_CAMERA"
hash "0x5E3CF89C6BCCA67D"
jhash (0x5D6739AE)
arguments {
Hash "camHash" [=[ {} ]=],
BOOL "active" [=[ {} ]=],
}
ns "CAM"
returns "Cam"
doc [[!
Creates a camera with the specified camera hash, You can use `SET_CAM_` natives to manipulate the camera.
Make sure to call [RENDER_SCRIPT_CAMS](#\_0x07E5B515DB0636FC) once the camera is created, or this won't have any visible effect.
Take a look at [CREATE_CAM](#\_0xC3981DCE61D9E13F) if you would like to see the available camera names.
```
NativeDB Introduced: v323
```
The hash of the camera type, use [GET_HASH_KEY](#\_0xD24D37CC275948CC) to get the camera hash from the name.
Set to true if you wish to make this new camera the active camera.
A camera handle referencing the camera that was created.
]]
native "CREATE_CAMERA_WITH_PARAMS"
hash "0x6ABFA3E16460F22D"
jhash (0x0688BE9A)
arguments {
Hash "camHash" [=[ {} ]=],
float "posX" [=[ {} ]=],
float "posY" [=[ {} ]=],
float "posZ" [=[ {} ]=],
float "rotX" [=[ {} ]=],
float "rotY" [=[ {} ]=],
float "rotZ" [=[ {} ]=],
float "fov" [=[ {} ]=],
BOOL "active" [=[ {} ]=],
int "rotationOrder" [=[ {} ]=],
}
ns "CAM"
returns "Cam"
doc [[!
Create a camera with the specified camera hash, You can use `SET_CAM_` natives to manipulate the camera.
Make sure to call [RENDER_SCRIPT_CAMS](#\_0x07E5B515DB0636FC) once the camera is created, or this won't have any visible effect.
Take a look at [CREATE_CAM](#\_0xC3981DCE61D9E13F) if you would like to see the available camera names.
```
NativeDB Introduced: v323
```
The hash of the camera type, use [GET_HASH_KEY](#\_0xD24D37CC275948CC) to get the camera hash from the name.
The x position of the camera.
The y position of the camera.
The z position of the camera.
The x rotation of the camera.
The y rotation of the camera.
The z rotation of the camera.
The Field Of View of the camera, is the observable world that is seen.
Set to true if you wish to make this new camera the active camera.
The order of rotation, see [`GET_ENTITY_ROTATION`](#\_0xAFBD61CC738D9EB9).
A camera handle.
]]
native "CREATE_CINEMATIC_SHOT"
hash "0x741B0129D4560F31"
jhash (0xAC494E35)
arguments {
Any "p0" [=[ {} ]=],
int "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Entity "entity" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
]]
native "CUSTOM_MENU_COORDINATES"
hash "0x487A82C650EB7799"
jhash (0xA6E73135)
arguments {
float "p0" [=[ {} ]=],
}
alias "0x487A82C650EB7799"
ns "CAM"
returns "void"
doc [[!
```
some camera effect that is used in the drunk-cheat, and turned off (by setting it to 0.0) along with the shaking effects once the drunk cheat is disabled.
```
]]
native "DESTROY_ALL_CAMS"
hash "0x8E5FB15663F79120"
jhash (0x10C151CE)
arguments {
BOOL "bScriptHostCam" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
```
BOOL param indicates whether the cam should be destroyed if it belongs to the calling script.
```
]]
native "DESTROY_CAM"
hash "0x865908C81A2C22E9"
jhash (0xC39302BD)
arguments {
Cam "cam" [=[ {} ]=],
BOOL "bScriptHostCam" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
```
BOOL param indicates whether the cam should be destroyed if it belongs to the calling script.
```
]]
native "DETACH_CAM"
hash "0xA2FABBE87F4BAD82"
jhash (0xF4FBF14A)
arguments {
Cam "cam" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
]]
native "DISABLE_AIM_CAM_THIS_UPDATE"
hash "0x1A31FE0049E542F6"
jhash (0x1BAA7182)
alias "0x1A31FE0049E542F6"
ns "CAM"
returns "void"
doc [[!
]]
native "DISABLE_CAM_COLLISION_FOR_OBJECT"
hash "0x49482F9FCD825AAA"
jhash (0xC4736ED3)
arguments {
Entity "entity" [=[ {} ]=],
}
alias "0x49482F9FCD825AAA"
ns "CAM"
returns "void"
doc [[!
]]
native "DISABLE_CINEMATIC_BONNET_CAMERA_THIS_UPDATE"
hash "0xADFF1B2A555F5FBA"
jhash (0x5AC6DAC9)
alias "_DISABLE_VEHICLE_FIRST_PERSON_CAM_THIS_FRAME"
ns "CAM"
returns "void"
doc [[!
Disables first person camera while in a vehicle for the current tick.
]]
native "DISABLE_ON_FOOT_FIRST_PERSON_VIEW_THIS_UPDATE"
hash "0xDE2EF5DA284CC8DF"
alias "_DISABLE_FIRST_PERSON_CAM_THIS_FRAME"
ns "CAM"
returns "void"
doc [[!
Disables first person camera while on foot for the current tick.
]]
native "DO_SCREEN_FADE_IN"
hash "0xD4E8E24955024033"
jhash (0x66C1BDEE)
arguments {
int "duration" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
```
Fades the screen in.
duration: The time the fade should take, in milliseconds.
```
]]
native "DO_SCREEN_FADE_OUT"
hash "0x891B5B39AC6302AF"
jhash (0x89D01805)
arguments {
int "duration" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
```
Fades the screen out.
duration: The time the fade should take, in milliseconds.
```
]]
native "DOES_CAM_EXIST"
hash "0xA7A932170592B50E"
jhash (0x1EF89DC0)
arguments {
Cam "cam" [=[ {} ]=],
}
ns "CAM"
returns "BOOL"
doc [[!
Looks up a camera handle in the current camera pool and returns `true` if the handle is found, otherwise it returns `false`.
The camera handle to look for.
A boolean value representing whether the camera exists or not.
]]
native "FORCE_CINEMATIC_RENDERING_THIS_UPDATE"
hash "0xA41BCD7213805AAC"
jhash (0xFBB85E02)
arguments {
BOOL "enable" [=[ {} ]=],
}
alias "0xA41BCD7213805AAC"
ns "CAM"
returns "void"
doc [[!
Forces the camera to be in cinematic mode while the player is in a car. This has to be called every frame, e.g. in a `Wait(0)` loop.
Whether it should force the cinematic rendering or not.
]]
native "GET_CAM_ANIM_CURRENT_PHASE"
hash "0xA10B2DB49E92A6B0"
jhash (0x345F72D0)
arguments {
Cam "cam" [=[ {} ]=],
}
ns "CAM"
returns "float"
doc [[!
]]
native "GET_CAM_COORD"
hash "0xBAC038F7459AE5AE"
jhash (0x7C40F09C)
arguments {
Cam "cam" [=[ {} ]=],
}
ns "CAM"
returns "Vector3"
doc [[!
]]
native "GET_CAM_FAR_CLIP"
hash "0xB60A9CFEB21CA6AA"
jhash (0x09F119B8)
arguments {
Cam "cam" [=[ {} ]=],
}
ns "CAM"
returns "float"
doc [[!
]]
native "GET_CAM_FAR_DOF"
hash "0x255F8DAFD540D397"
jhash (0x98C5CCE9)
arguments {
Cam "cam" [=[ {} ]=],
}
ns "CAM"
returns "float"
doc [[!
]]
native "GET_CAM_FOV"
hash "0xC3330A45CCCDB26A"
jhash (0xD6E9FCF5)
arguments {
Cam "cam" [=[ {} ]=],
}
ns "CAM"
returns "float"
doc [[!
]]
native "GET_CAM_NEAR_CLIP"
hash "0xC520A34DAFBF24B1"
jhash (0xCFCD35EE)
arguments {
Cam "cam" [=[ {} ]=],
}
ns "CAM"
returns "float"
doc [[!
]]
native "GET_CAM_ROT"
hash "0x7D304C1C955E3E12"
jhash (0xDAC84C9F)
arguments {
Cam "cam" [=[ {} ]=],
int "rotationOrder" [=[ {} ]=],
}
ns "CAM"
returns "Vector3"
doc [[!
Gets a camera's rotation by handle (`cam`) lookup, outputs a `Vector3` in degrees.
The camera handle.
The order of rotation, see [`GET_ENTITY_ROTATION`](#\_0xAFBD61CC738D9EB9)
A `Vector3` representing the camera rotation in degrees.
]]
native "GET_CAM_SPLINE_NODE_INDEX"
hash "0xB22B17DF858716A6"
jhash (0xF8AEB6BD)
arguments {
Cam "cam" [=[ {} ]=],
}
ns "CAM"
returns "int"
doc [[!
]]
native "GET_CAM_SPLINE_NODE_PHASE"
hash "0xD9D0E694C8282C96"
jhash (0x7B9522F6)
arguments {
Cam "cam" [=[ {} ]=],
}
ns "CAM"
returns "float"
doc [[!
```
I'm pretty sure the parameter is the camera as usual, but I am not certain so I'm going to leave it as is.
```
]]
native "GET_CAM_SPLINE_PHASE"
hash "0xB5349E36C546509A"
jhash (0x39784DD9)
arguments {
Cam "cam" [=[ {} ]=],
}
ns "CAM"
returns "float"
doc [[!
```
Can use this with SET_CAM_SPLINE_PHASE to set the float it this native returns.
(returns 1.0f when no nodes has been added, reached end of non existing spline)
```
]]
native "GET_CAM_VIEW_MODE_FOR_CONTEXT"
hash "0xEE778F8C7E1142E2"
jhash (0xF3B148A6)
arguments {
int "context" [=[ {} ]=],
}
alias "0xEE778F8C7E1142E2"
ns "CAM"
returns "int"
doc [[!
See [`GET_FOLLOW_PED_CAM_VIEW_MODE`](#\_0x8D4D46230B2C353A) for the view mode enum.
See [`_GET_CAM_ACTIVE_VIEW_MODE_CONTEXT`](#\_0x19CAFA3C87F7C2FF).
]]
native "GET_FINAL_RENDERED_CAM_COORD"
hash "0xA200EB1EE790F448"
jhash (0x9C84BDA0)
alias "_GET_GAMEPLAY_CAM_COORDS"
ns "CAM"
returns "Vector3"
doc [[!
]]
native "GET_FINAL_RENDERED_CAM_FAR_CLIP"
hash "0xDFC8CBC606FDB0FC"
jhash (0x46CB3A49)
alias "0xDFC8CBC606FDB0FC"
alias "_GET_GAMEPLAY_CAM_FAR_CLIP"
ns "CAM"
returns "float"
doc [[!
]]
native "GET_FINAL_RENDERED_CAM_FAR_DOF"
hash "0x9780F32BCAF72431"
jhash (0xF24777CA)
alias "0x9780F32BCAF72431"
alias "_GET_GAMEPLAY_CAM_FAR_DOF"
ns "CAM"
returns "float"
doc [[!
]]
native "GET_FINAL_RENDERED_CAM_FOV"
hash "0x80EC114669DAEFF4"
jhash (0x721B763B)
alias "0x80EC114669DAEFF4"
ns "CAM"
returns "float"
doc [[!
]]
native "GET_FINAL_RENDERED_CAM_MOTION_BLUR_STRENGTH"
hash "0x162F9D995753DC19"
jhash (0x38992E83)
alias "0x162F9D995753DC19"
alias "_GET_GAMEPLAY_CAM_FAR_CLIP_2"
ns "CAM"
returns "float"
doc [[!
]]
native "GET_FINAL_RENDERED_CAM_NEAR_CLIP"
hash "0xD0082607100D7193"
jhash (0x457AE195)
alias "0xD0082607100D7193"
alias "_GET_GAMEPLAY_CAM_NEAR_CLIP"
ns "CAM"
returns "float"
doc [[!
]]
native "GET_FINAL_RENDERED_CAM_NEAR_DOF"
hash "0xA03502FC581F7D9B"
jhash (0x19297A7A)
alias "0xA03502FC581F7D9B"
alias "_GET_GAMEPLAY_CAM_NEAR_DOF"
ns "CAM"
returns "float"
doc [[!
]]
native "GET_FINAL_RENDERED_CAM_ROT"
hash "0x5B4E4C817FCC2DFB"
jhash (0x1FFBEFC5)
arguments {
int "rotationOrder" [=[ {} ]=],
}
alias "_GET_GAMEPLAY_CAM_ROT_2"
ns "CAM"
returns "Vector3"
doc [[!
]]
native "GET_FINAL_RENDERED_IN_WHEN_FRIENDLY_FOV"
hash "0x5F35F6732C3FBBA0"
jhash (0x23E3F106)
arguments {
Player "player" [=[ {} ]=],
}
alias "0x5F35F6732C3FBBA0"
ns "CAM"
returns "float"
doc [[!
]]
native "GET_FINAL_RENDERED_IN_WHEN_FRIENDLY_ROT"
hash "0x26903D9CD1175F2C"
jhash (0xACADF916)
arguments {
Player "player" [=[ {} ]=],
int "rotationOrder" [=[ {} ]=],
}
alias "0x26903D9CD1175F2C"
ns "CAM"
returns "Vector3"
doc [[!
]]
native "GET_FIRST_PERSON_AIM_CAM_ZOOM_FACTOR"
hash "0x7EC52CC40597D170"
jhash (0x33951005)
alias "_GET_GAMEPLAY_CAM_ZOOM"
ns "CAM"
returns "float"
doc [[!
]]
native "GET_FOCUS_PED_ON_SCREEN"
hash "0x89215EC747DF244A"
jhash (0xFD99BE2B)
arguments {
float "p0" [=[ {} ]=],
int "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
float "p4" [=[ {} ]=],
float "p5" [=[ {} ]=],
float "p6" [=[ {} ]=],
int "p7" [=[ {} ]=],
int "p8" [=[ {} ]=],
}
alias "0x89215EC747DF244A"
ns "CAM"
returns "Ped"
doc [[!
]]
native "GET_FOLLOW_PED_CAM_VIEW_MODE"
hash "0x8D4D46230B2C353A"
jhash (0xA65FF946)
ns "CAM"
returns "int"
doc [[!
```cpp
// view mode enumeration
enum eCamViewMode
{
THIRD_PERSON_NEAR = 0,
THIRD_PERSON_MEDIUM = 1,
THIRD_PERSON_FAR = 2,
CINEMATIC = 3,
FIRST_PERSON = 4,
};
```
Returns a value from the view mode enumeration
]]
native "GET_FOLLOW_PED_CAM_ZOOM_LEVEL"
hash "0x33E6C8EFD0CD93E9"
jhash (0x57583DF1)
ns "CAM"
returns "int"
doc [[!
See [`GET_FOLLOW_PED_CAM_VIEW_MODE`](#\_0x8D4D46230B2C353A) for the follow mode enum.
]]
native "GET_FOLLOW_VEHICLE_CAM_VIEW_MODE"
hash "0xA4FF579AC0E3AAAE"
jhash (0xA4B4DB03)
ns "CAM"
returns "int"
doc [[!
See [`GET_FOLLOW_PED_CAM_VIEW_MODE`](#\_0x8D4D46230B2C353A) for the follow mode enum.
]]
native "GET_FOLLOW_VEHICLE_CAM_ZOOM_LEVEL"
hash "0xEE82280AB767B690"
jhash (0x8CD67DE3)
ns "CAM"
returns "int"
doc [[!
See [`GET_FOLLOW_PED_CAM_VIEW_MODE`](#\_0x8D4D46230B2C353A) for the follow mode enum.
]]
native "GET_GAMEPLAY_CAM_COORD"
hash "0x14D6F5678D8F1B37"
jhash (0x9388CF79)
ns "CAM"
returns "Vector3"
doc [[!
]]
native "GET_GAMEPLAY_CAM_FOV"
hash "0x65019750A0324133"
jhash (0x4D6B3BFA)
ns "CAM"
returns "float"
doc [[!
]]
native "GET_GAMEPLAY_CAM_RELATIVE_HEADING"
hash "0x743607648ADD4587"
jhash (0xCAF839C2)
ns "CAM"
returns "float"
doc [[!
]]
native "GET_GAMEPLAY_CAM_RELATIVE_PITCH"
hash "0x3A6867B4845BEDA2"
jhash (0xFC5A4946)
ns "CAM"
returns "float"
doc [[!
Returns the relative pitch of the gameplay camera
]]
native "GET_GAMEPLAY_CAM_ROT"
hash "0x837765A25378F0BB"
jhash (0x13A010B5)
arguments {
int "rotationOrder" [=[ {} ]=],
}
ns "CAM"
returns "Vector3"
doc [[!
This function takes a rotation order and outputs a `Vector3` in degrees.
It first calls a game function to calculate these values given the rotation order and effectively multiplies those values by `180/PI`, hence degrees since the function it calls outputs radians which are then converted to degrees.
The order of rotation, see [`GET_ENTITY_ROTATION`](#\_0xAFBD61CC738D9EB9)
A `Vector3` representing the gameplay camera rotation in degrees.
]]
native "GET_RENDERING_CAM"
hash "0x5234F9F10919EABA"
jhash (0x0FCF4DF1)
ns "CAM"
returns "Cam"
doc [[!
]]
native "HARD_ATTACH_CAM_TO_ENTITY"
hash "0x202A5ED9CE01D6E7"
arguments {
Cam "cam" [=[ {} ]=],
Entity "entity" [=[ {} ]=],
float "xRot" [=[ {} ]=],
float "yRot" [=[ {} ]=],
float "zRot" [=[ {} ]=],
float "xOffset" [=[ {} ]=],
float "yOffset" [=[ {} ]=],
float "zOffset" [=[ {} ]=],
BOOL "isRelative" [=[ {} ]=],
}
alias "0x202A5ED9CE01D6E7"
ns "CAM"
returns "void"
doc [[!
Attaches a camera to an entity, including full matrix transformations for both rotation and position offsets.
```
NativeDB Introduced: v2189
```
The camera handle.
The entity handle.
X-axis rotation.
Y-axis rotation.
Z-axis rotation.
X-axis offset
Y-axis offset
Z-axis offset
Whether or not the camera position will be relative to the entity rotation
]]
native "HARD_ATTACH_CAM_TO_PED_BONE"
hash "0x149916F50C34A40D"
arguments {
Cam "cam" [=[ {} ]=],
Ped "ped" [=[ {} ]=],
int "boneIndex" [=[ {} ]=],
float "xRot" [=[ {} ]=],
float "yRot" [=[ {} ]=],
float "zRot" [=[ {} ]=],
float "xOffset" [=[ {} ]=],
float "yOffset" [=[ {} ]=],
float "zOffset" [=[ {} ]=],
BOOL "isRelative" [=[ {} ]=],
}
alias "0x149916F50C34A40D"
alias "_ATTACH_CAM_TO_PED_BONE_2"
ns "CAM"
returns "void"
doc [[!
Attaches a camera to a specific bone of a Ped, including full matrix transformations for both rotation and position offsets.
This native works with peds only.
```
NativeDB Introduced: v1180
```
The camera handle.
The ped handle.
This is different to boneID, use [`GET_PED_BONE_INDEX`](#\_0x3F428D08BE5AAE31) to get the index from the ID. use the index for attaching to specific bones. `cam` will be attached to the center of `ped` if bone index given doesn't correspond to bone indexes for that entity type.
X-axis rotation.
Y-axis rotation.
Z-axis rotation.
X-axis offset.
Y-axis offset.
Z-axis offset.
Whether or not the camera position will be relative to the bone rotation.
]]
native "IGNORE_MENU_PREFERENCE_FOR_BONNET_CAMERA_THIS_UPDATE"
hash "0x7B8A361C1813FBEF"
alias "0x7B8A361C1813FBEF"
ns "CAM"
returns "void"
doc [[!
]]
native "INVALIDATE_IDLE_CAM"
hash "0xF4F2C0D4EE209E20"
jhash (0xD75CDD75)
alias "0xF4F2C0D4EE209E20"
ns "CAM"
returns "void"
doc [[!
Resets the idle camera timer. Calling that in a loop once every few seconds is enough to disable the idle cinematic camera.
]]
native "IS_AIM_CAM_ACTIVE"
hash "0x68EDDA28A5976D07"
jhash (0xC24B4F6F)
ns "CAM"
returns "BOOL"
doc [[!
]]
native "IS_ALLOWED_INDEPENDENT_CAMERA_MODES"
hash "0xEAF0FA793D05C592"
alias "0xEAF0FA793D05C592"
ns "CAM"
annotations [=[ {"cs_type":"Any"} ]=]
returns "BOOL"
doc [[!
Returns if the "Allow Independent Camera Modes" setting in Pause Menu is turned On or Off.
]]
native "IS_BONNET_CINEMATIC_CAM_RENDERING"
hash "0xD7360051C885628B"
jhash (0x1DD55F13)
alias "0xD7360051C885628B"
ns "CAM"
returns "BOOL"
doc [[!
]]
native "IS_CAM_ACTIVE"
hash "0xDFB2B516207D3534"
jhash (0x4B58F177)
arguments {
Cam "cam" [=[ {} ]=],
}
ns "CAM"
returns "BOOL"
doc [[!
```
Returns whether or not the passed camera handle is active.
```
]]
native "IS_CAM_INTERPOLATING"
hash "0x036F97C908C2B52C"
jhash (0x7159CB5D)
arguments {
Cam "cam" [=[ {} ]=],
}
ns "CAM"
returns "BOOL"
doc [[!
]]
native "IS_CAM_PLAYING_ANIM"
hash "0xC90621D8A0CEECF2"
jhash (0xB998CB49)
arguments {
Cam "cam" [=[ {} ]=],
charPtr "animName" [=[ {} ]=],
charPtr "animDictionary" [=[ {} ]=],
}
ns "CAM"
returns "BOOL"
doc [[!
[Animations list](https://alexguirre.github.io/animations-list/)
]]
native "IS_CAM_RENDERING"
hash "0x02EC0AF5C5A49B7A"
jhash (0x6EC6B5B2)
arguments {
Cam "cam" [=[ {} ]=],
}
ns "CAM"
returns "BOOL"
doc [[!
]]
native "IS_CAM_SHAKING"
hash "0x6B24BFE83A2BE47B"
jhash (0x0961FD9B)
arguments {
Cam "cam" [=[ {} ]=],
}
ns "CAM"
returns "BOOL"
doc [[!
]]
native "IS_CAM_SPLINE_PAUSED"
hash "0x0290F35C0AD97864"
jhash (0x60B34FF5)
arguments {
Any "p0" [=[ {} ]=],
}
ns "CAM"
returns "BOOL"
doc [[!
]]
native "IS_CINEMATIC_CAM_INPUT_ACTIVE"
hash "0xF5F1E89A970B7796"
jhash (0x01A900C8)
alias "0xF5F1E89A970B7796"
alias "_IS_CINEMATIC_CAM_ACTIVE"
ns "CAM"
returns "BOOL"
doc [[!
```
NativeDB Introduced: v1493
```
]]
native "IS_CINEMATIC_CAM_RENDERING"
hash "0xB15162CB5826E9E8"
jhash (0x80471AD9)
ns "CAM"
returns "BOOL"
doc [[!
]]
native "IS_CINEMATIC_CAM_SHAKING"
hash "0xBBC08F6B4CB8FF0A"
jhash (0x8376D939)
ns "CAM"
returns "BOOL"
doc [[!
]]
native "IS_CINEMATIC_IDLE_CAM_RENDERING"
hash "0xCA9D2AA3E326D720"
jhash (0x96A07066)
alias "0xCA9D2AA3E326D720"
ns "CAM"
returns "BOOL"
doc [[!
]]
native "IS_CINEMATIC_SHOT_ACTIVE"
hash "0xCC9F3371A7C28BC9"
jhash (0xA4049042)
arguments {
Any "p0" [=[ {} ]=],
}
ns "CAM"
returns "BOOL"
doc [[!
]]
native "IS_FIRST_PERSON_AIM_CAM_ACTIVE"
hash "0x5E346D934122613F"
jhash (0xD6280468)
ns "CAM"
returns "BOOL"
doc [[!
]]
native "IS_FOLLOW_PED_CAM_ACTIVE"
hash "0xC6D3D26810C8E0F9"
jhash (0x9F9E856C)
ns "CAM"
returns "BOOL"
doc [[!
]]
native "IS_FOLLOW_VEHICLE_CAM_ACTIVE"
hash "0xCBBDE6D335D6D496"
jhash (0x8DD49B77)
ns "CAM"
returns "BOOL"
doc [[!
]]
native "IS_GAMEPLAY_CAM_LOOKING_BEHIND"
hash "0x70FDA869F3317EA9"
jhash (0x33C83F17)
ns "CAM"
returns "BOOL"
doc [[!
]]
native "IS_GAMEPLAY_CAM_RENDERING"
hash "0x39B5D1B10383F0C8"
jhash (0x0EF276DA)
ns "CAM"
returns "BOOL"
doc [[!
```
Examples when this function will return 0 are:
- During busted screen.
- When player is coming out from a hospital.
- When player is coming out from a police station.
- When player is buying gun from AmmuNation.
```
]]
native "IS_GAMEPLAY_CAM_SHAKING"
hash "0x016C090630DF1F89"
jhash (0x3457D681)
ns "CAM"
returns "BOOL"
doc [[!
]]
native "IS_GAMEPLAY_HINT_ACTIVE"
hash "0xE520FF1AD2785B40"
jhash (0xAD8DA205)
ns "CAM"
returns "BOOL"
doc [[!
]]
native "IS_SCREEN_FADED_IN"
hash "0x5A859503B0C08678"
jhash (0x4F37276D)
ns "CAM"
returns "BOOL"
doc [[!
]]
native "IS_SCREEN_FADED_OUT"
hash "0xB16FCE9DDC7BA182"
jhash (0x9CAA05FA)
ns "CAM"
returns "BOOL"
doc [[!
]]
native "IS_SCREEN_FADING_IN"
hash "0x5C544BC6C57AC575"
jhash (0xC7C82800)
ns "CAM"
returns "BOOL"
doc [[!
]]
native "IS_SCREEN_FADING_OUT"
hash "0x797AC7CB535BA28F"
jhash (0x79275A57)
ns "CAM"
returns "BOOL"
doc [[!
]]
native "IS_SCRIPT_GLOBAL_SHAKING"
hash "0xC912AF078AF19212"
jhash (0x6AEFE6A5)
alias "0xC912AF078AF19212"
ns "CAM"
returns "BOOL"
doc [[!
Determines if a global camera shake is currently active. You can stop the currently active global camera shake using [STOP_SCRIPT_GLOBAL_SHAKING](#\_0x1C9D7949FA533490).
```
NativeDB Introduced: v323
```
Returns `true` if a scripted global camera shake is currently in effect, otherwise `false`.
]]
native "IS_SPHERE_VISIBLE"
hash "0xE33D59DA70B58FDF"
jhash (0xDD1329E2)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "radius" [=[ {} ]=],
}
ns "CAM"
returns "BOOL"
doc [[!
]]
native "OVERRIDE_CAM_SPLINE_MOTION_BLUR"
hash "0x7DCF7C708D292D55"
jhash (0x633179E6)
arguments {
Cam "cam" [=[ {} ]=],
int "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
```
Max value for p1 is 15.
```
]]
native "OVERRIDE_CAM_SPLINE_VELOCITY"
hash "0x40B62FA033EB0346"
jhash (0x326A17E2)
arguments {
Cam "cam" [=[ {} ]=],
int "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
]]
native "PLAY_CAM_ANIM"
hash "0x9A2D0FB2E7852392"
jhash (0xBCEFB87E)
arguments {
Cam "cam" [=[ {} ]=],
charPtr "animName" [=[ {} ]=],
charPtr "animDictionary" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "xRot" [=[ {} ]=],
float "yRot" [=[ {} ]=],
float "zRot" [=[ {} ]=],
BOOL "p9" [=[ {} ]=],
int "p10" [=[ {} ]=],
}
ns "CAM"
returns "BOOL"
doc [[!
```
Atleast one time in a script for the zRot Rockstar uses GET_ENTITY_HEADING to help fill the parameter.
p9 is unknown at this time.
p10 throughout all the X360 Scripts is always 2.
```
[Animations list](https://alexguirre.github.io/animations-list/)
]]
native "PLAY_SYNCHRONIZED_CAM_ANIM"
hash "0xE32EFE9AB4A9AA0C"
jhash (0x9458459E)
arguments {
Cam "camera" [=[ {} ]=],
int "scene" [=[ {} ]=],
charPtr "animName" [=[ {} ]=],
charPtr "animDictionary" [=[ {} ]=],
}
ns "CAM"
returns "BOOL"
doc [[!
```
Examples:
CAM::PLAY_SYNCHRONIZED_CAM_ANIM(l_2734, NETWORK::_02C40BF885C567B6(l_2739), "PLAYER_EXIT_L_CAM", "mp_doorbell");
CAM::PLAY_SYNCHRONIZED_CAM_ANIM(l_F0D[7/*1*/], l_F4D[15/*1*/], "ah3b_attackheli_cam2", "missheistfbi3b_helicrash");
```
[Animations list](https://alexguirre.github.io/animations-list/)
]]
native "POINT_CAM_AT_COORD"
hash "0xF75497BB865F0803"
jhash (0x914BC21A)
arguments {
Cam "cam" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
]]
native "POINT_CAM_AT_ENTITY"
hash "0x5640BFF86B16E8DC"
jhash (0x7597A0F7)
arguments {
Cam "cam" [=[ {} ]=],
Entity "entity" [=[ {} ]=],
float "offsetX" [=[ {} ]=],
float "offsetY" [=[ {} ]=],
float "offsetZ" [=[ {} ]=],
BOOL "p5" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
Points the camera at the specified entity.
Offset works like [GET_OFFSET_FROM_ENTITY_IN_WORLD_COORDS](#\_0x1899F328B0E12848).
Cam (Return value of CREATE_CAM or CREATE_CAM_WITH_PARAMS).
Entity for the camera to point at.
X offset for the camera (left/right).
Y offset for the camera (forward/backward).
Z offset for the camera (up/down).
Always seems to be 1 (true).
]]
native "POINT_CAM_AT_PED_BONE"
hash "0x68B2B5F33BA63C41"
jhash (0x09F47049)
arguments {
Cam "cam" [=[ {} ]=],
Ped "ped" [=[ {} ]=],
int "boneIndex" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
BOOL "p6" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
```
Parameters p0-p5 seems correct. The bool p6 is unknown, but through every X360 script it's always 1. Please correct p0-p5 if any prove to be wrong.
```
]]
native "RENDER_SCRIPT_CAMS"
hash "0x07E5B515DB0636FC"
jhash (0x74337969)
arguments {
BOOL "render" [=[ {} ]=],
BOOL "ease" [=[ {} ]=],
int "easeTime" [=[ {} ]=],
BOOL "easeCoordsAnim" [=[ {} ]=],
BOOL "p4" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
Renders the camera previously created with [CREATE_CAM](#\_0xC3981DCE61D9E13F) or [CREATE_CAMERA](#\_0x5E3CF89C6BCCA67D)
```
NativeDB Added Parameter 6: Any p5
```
Whether to render the cams or not.
If true it will make a smooth transition between the current camera and the new rendered camera.
The in milliseconds for the transition to happen.
If false it will only do the smooth transition to the rotation and the coords will be set instantly.
Doesn't seem to change anything.
]]
native "SET_CAM_ACTIVE"
hash "0x026FB97D0A425F84"
jhash (0x064659C2)
arguments {
Cam "cam" [=[ {} ]=],
BOOL "active" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
```
Set camera as active/inactive.
```
]]
native "SET_CAM_ACTIVE_WITH_INTERP"
hash "0x9FBDA379383A52A4"
jhash (0x7983E7F0)
arguments {
Cam "camTo" [=[ {} ]=],
Cam "camFrom" [=[ {} ]=],
int "duration" [=[ {} ]=],
int "easeLocation" [=[ {} ]=],
int "easeRotation" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
```
Previous declaration void SET_CAM_ACTIVE_WITH_INTERP(Cam camTo, Cam camFrom, int duration, BOOL easeLocation, BOOL easeRotation) is completely wrong. The last two params are integers not BOOLs...
```
]]
native "SET_CAM_AFFECTS_AIMING"
hash "0x8C1DC7770C51DC8D"
jhash (0x0C74F9AF)
arguments {
Cam "cam" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
```
Allows you to aim and shoot at the direction the camera is facing.
```
]]
native "SET_CAM_ANIM_CURRENT_PHASE"
hash "0x4145A4C44FF3B5A6"
jhash (0x3CB1D17F)
arguments {
Cam "cam" [=[ {} ]=],
float "phase" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
]]
native "SET_CAM_CONTROLS_MINI_MAP_HEADING"
hash "0x661B5C8654ADD825"
jhash (0xE1A0B2F1)
arguments {
Cam "cam" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x661B5C8654ADD825"
ns "CAM"
returns "void"
doc [[!
Makes the minimap follow a scripted camera's rotation instead of the gameplay cam.
Cam handle returned by [CREATE_CAM](#\_0xC3981DCE61D9E13F)
Whether or not this camera should control the minimap heading.
]]
native "SET_CAM_COORD"
hash "0x4D41783FB745E42E"
jhash (0x7A8053AF)
arguments {
Cam "cam" [=[ {} ]=],
float "posX" [=[ {} ]=],
float "posY" [=[ {} ]=],
float "posZ" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
```
Sets the position of the cam.
```
]]
native "SET_CAM_DEBUG_NAME"
hash "0x1B93E0107865DD40"
jhash (0x9B00DF3F)
arguments {
Cam "camera" [=[ {} ]=],
charPtr "name" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
```
NOTE: Debugging functions are not present in the retail version of the game.
```
]]
native "SET_CAM_DOF_PLANES"
hash "0x3CF48F6F96E749DC"
jhash (0xAD6C2B8F)
arguments {
Cam "cam" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
float "p4" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
]]
native "SET_CAM_DOF_STRENGTH"
hash "0x5EE29B4D7D5DF897"
jhash (0x3CC4EB3F)
arguments {
Cam "cam" [=[ {} ]=],
float "dofStrength" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
Specifies how much the DoF effect should be applied (Set using [`SET_CAM_NEAR_DOF`](#\_0x3FA4BF0A7AB7DE2C), [`SET_CAM_FAR_DOF`](#\_0xEDD91296CD01AEE0), etc.)
The camera handle
Depth of Field strength (between 0.0 and 1.0)
]]
native "SET_CAM_FAR_CLIP"
hash "0xAE306F2A904BF86E"
jhash (0x0D23E381)
arguments {
Cam "cam" [=[ {} ]=],
float "farClip" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
]]
native "SET_CAM_FAR_DOF"
hash "0xEDD91296CD01AEE0"
jhash (0x58515E8E)
arguments {
Cam "cam" [=[ {} ]=],
float "farDOF" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
Specifies when the camera should stop being in focus. Can be used together with [`SET_USE_HI_DOF`](#\_0xA13B0222F3D94A94), [`SET_CAM_NEAR_DOF`](#\_0x3FA4BF0A7AB7DE2C), [`SET_CAM_USE_SHALLOW_DOF_MODE`](#\_0x16A96863A17552BB), [`SET_CAM_DOF_STRENGTH`](#\_0x5EE29B4D7D5DF897) and other DoF related natives.
### Usage Example
A usage example for this native can be found in the following native documentation: [`SET_CAM_DOF_STRENGTH`](#\_0x5EE29B4D7D5DF897).
The camera handle
Distance in in standard units
]]
native "SET_CAM_FOV"
hash "0xB13C14F66A00D047"
jhash (0xD3D5D74F)
arguments {
Cam "cam" [=[ {} ]=],
float "fieldOfView" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
Adjusts the field of view (FOV) for a specified camera, allowing for a wider or narrower perspective of the game world. The field of view is measured in degrees and affects how much of the game world is visible at any given moment through the camera.
```
NativeDB Introduced: v323
```
The camera whose FOV is being set.
The new FOV value, in degrees. Valid range is from `1.0f` (minimum FOV, for a very narrow view) to `130.0f` (maximum FOV, for a very wide view).
]]
native "SET_CAM_INHERIT_ROLL_VEHICLE"
hash "0x45F1DE9C34B93AE6"
jhash (0xE4BD5342)
arguments {
Cam "cam" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
```
The native seems to only be called once.
The native is used as so,
CAM::SET_CAM_INHERIT_ROLL_VEHICLE(l_544, getElem(2, &l_525, 4));
In the exile1 script.
```
]]
native "SET_CAM_MOTION_BLUR_STRENGTH"
hash "0x6F0F77FBA9A8F2E6"
jhash (0xFD6E0D67)
arguments {
Cam "cam" [=[ {} ]=],
float "strength" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
]]
native "SET_CAM_NEAR_CLIP"
hash "0xC7848EFCCC545182"
jhash (0x46DB13B1)
arguments {
Cam "cam" [=[ {} ]=],
float "nearClip" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
]]
native "SET_CAM_NEAR_DOF"
hash "0x3FA4BF0A7AB7DE2C"
jhash (0xF28254DF)
arguments {
Cam "cam" [=[ {} ]=],
float "nearDOF" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
Specifies when the camera should start being in focus. Can be used together with [`SET_USE_HI_DOF`](#\_0xA13B0222F3D94A94), [`SET_CAM_FAR_DOF`](#\_0xEDD91296CD01AEE0), [`SET_CAM_USE_SHALLOW_DOF_MODE`](#\_0x16A96863A17552BB), [`SET_CAM_DOF_STRENGTH`](#\_0x5EE29B4D7D5DF897) and other DoF related natives.
### Usage Example
A usage example for this native can be found in the following native documentation: [`SET_CAM_DOF_STRENGTH`](#\_0x5EE29B4D7D5DF897).
The camera handle
Distance in in standard units
]]
native "SET_CAM_PARAMS"
hash "0xBFD8727AEA3CCEBA"
jhash (0x2167CEBF)
arguments {
Cam "cam" [=[ {} ]=],
float "posX" [=[ {} ]=],
float "posY" [=[ {} ]=],
float "posZ" [=[ {} ]=],
float "rotX" [=[ {} ]=],
float "rotY" [=[ {} ]=],
float "rotZ" [=[ {} ]=],
float "fieldOfView" [=[ {} ]=],
int "transitionSpeed" [=[ {} ]=],
int "p9" [=[ {} ]=],
int "p10" [=[ {} ]=],
int "rotationOrder" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
The speed of transition/interpolation to these new values
The order of rotation, see [`GET_ENTITY_ROTATION`](#\_0xAFBD61CC738D9EB9)
]]
native "SET_CAM_ROT"
hash "0x85973643155D0B07"
jhash (0xEE38B3C1)
arguments {
Cam "cam" [=[ {} ]=],
float "rotX" [=[ {} ]=],
float "rotY" [=[ {} ]=],
float "rotZ" [=[ {} ]=],
int "rotationOrder" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
Sets the rotation of the camera.
The camera handle to use, in order to change the rotation
Rotation on X
Rotation on Y
Rotation on Z
The order of rotation, see [`GET_ENTITY_ROTATION`](#\_0xAFBD61CC738D9EB9)
]]
native "SET_CAM_SHAKE_AMPLITUDE"
hash "0xD93DB43B82BC0D00"
jhash (0x60FF6382)
arguments {
Cam "cam" [=[ {} ]=],
float "amplitude" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
]]
native "SET_CAM_SPLINE_DURATION"
hash "0x1381539FEE034CDA"
jhash (0x3E91FC8A)
arguments {
Cam "cam" [=[ {} ]=],
int "timeDuration" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
```
I named p1 as timeDuration as it is obvious. I'm assuming tho it is ran in ms(Milliseconds) as usual.
```
]]
native "SET_CAM_SPLINE_NODE_EASE"
hash "0x83B8201ED82A9A2D"
jhash (0x21D275DA)
arguments {
Cam "cam" [=[ {} ]=],
int "p1" [=[ {} ]=],
int "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
}
alias "0x83B8201ED82A9A2D"
ns "CAM"
returns "void"
doc [[!
]]
native "SET_CAM_SPLINE_NODE_EXTRA_FLAGS"
hash "0x7BF1A54AE67AC070"
jhash (0xC90B2DDC)
arguments {
Cam "cam" [=[ {} ]=],
int "p1" [=[ {} ]=],
int "flags" [=[ {} ]=],
}
alias "0x7BF1A54AE67AC070"
ns "CAM"
returns "void"
doc [[!
]]
native "SET_CAM_SPLINE_NODE_VELOCITY_SCALE"
hash "0xA6385DEB180F319F"
jhash (0xA3BD9E94)
arguments {
Cam "cam" [=[ {} ]=],
int "p1" [=[ {} ]=],
float "scale" [=[ {} ]=],
}
alias "0xA6385DEB180F319F"
ns "CAM"
returns "void"
doc [[!
]]
native "SET_CAM_SPLINE_PHASE"
hash "0x242B5874F0A4E052"
jhash (0xF0AED233)
arguments {
Cam "cam" [=[ {} ]=],
float "p1" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
]]
native "SET_CAM_SPLINE_SMOOTHING_STYLE"
hash "0xD1B0F412F109EA5D"
jhash (0x15E141CE)
arguments {
Cam "cam" [=[ {} ]=],
int "smoothingStyle" [=[ {} ]=],
}
alias "0xD1B0F412F109EA5D"
ns "CAM"
returns "void"
doc [[!
Sets the smoothing style for a DEFAULT_SPLINE_CAMERA
Ranges from 0 to 3 in rockstar scripts although there are actually 26
```
0: No lead-in or lead-out smoothing
1: Smooth lead-in
2: Smooth lead-out
3: Both lead-in and lead-out are smoothed
4-6: Longer speed up, lead-in, lead-out, and both in order as above.
6: see above, but missed a node in testing(?)
7: Smoothed lead-in, longer smoothed lead-out
8: Longer lead-in and lead-out than 6, didn't drop node
9: Constant acceleration
10: Constant deceleration. Dropped 2 nodes in testing.
11: Same as 0
12: 10 but slower lead-in, reaches end node less early
13: Extremely close to 3, slightly longer lead-in/lead-out
14: Constant acceleration, dropped last 2 nodes in testing and halted (?)
15: Very similar to 10, did not drop any nodes.
16: Long lead-in, dropped 2 nodes in testing, very long leadout.
17: Constant acceleration, slower speed-up than 9
18: Same as 17 is to 9, slightly longer lead-out, lingers at end node
19: Very long lead in and out
20: Very long, gradual lead-in acceleration at start, gets extremely fast
21: Same as 20 but for constant deceleration
22: 20 and 21 combined, long linger at end node. Dropped 2 nodes in testing
23: Constant acceleration, doesn't complete path before it stops
24: Same as 23 but with constant deceleration, but completes path
25: 23 and 24 combined, insanely fast at middle.
26: No noticable lead-in, misses last 2 nodes in testing
27+: Alternates between 0 and 26
```
The above is documented and graphed at [Spline Cam Interp Graphs](https://docs.google.com/spreadsheets/d/1ejyiMcEYrhhQOL0mLe8664UN-vU4Oh-SBqQnVcKlFIk/edit?usp=sharing)
```
Using 1-3 will result in misalignment from the passed durations for the spline nodes, the overall duration will remain but other nodes will be shortened if smoothing anything.
Graph below demonstrates interpolation between 0-1000 and back 10 times.

## Parameters
* **cam**: The DEFAULT_SPLINE_CAMERA to apply the smoothing to
* **smoothingStyle**: 0 to 3, 0 no additional smoothing, 1 smooth lead-in, 2 smooth lead-out, 3 smooth lead-in & lead-out
```
]]
native "SET_CAM_USE_SHALLOW_DOF_MODE"
hash "0x16A96863A17552BB"
jhash (0x8306C256)
arguments {
Cam "cam" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
Enables or disables the usage of a shallow DOF. Needs to be set to true to use [`SET_CAM_NEAR_DOF`](#\_0x3FA4BF0A7AB7DE2C), [`SET_CAM_FAR_DOF`](#\_0xEDD91296CD01AEE0), etc. Doesn't need to be called every tick.
### Usage Example
A usage example for this native can be found in the following native documentation: [`SET_CAM_DOF_STRENGTH`](#\_0x5EE29B4D7D5DF897).
The camera handle
Boolean if the camera should use a shallow depth of field or not
]]
native "SET_CAM_VIEW_MODE_FOR_CONTEXT"
hash "0x2A2173E46DAECD12"
jhash (0x1DEBCB45)
arguments {
int "context" [=[ {} ]=],
int "viewMode" [=[ {} ]=],
}
alias "0x2A2173E46DAECD12"
ns "CAM"
returns "void"
doc [[!
The view context; see [`_GET_CAM_ACTIVE_VIEW_MODE_CONTEXT`](#\_0x19CAFA3C87F7C2FF).
The view mode; see [`GET_FOLLOW_PED_CAM_VIEW_MODE`](#\_0x8D4D46230B2C353A).
]]
native "SET_CINEMATIC_BUTTON_ACTIVE"
hash "0x51669F7D1FB53D9F"
jhash (0x3FBC5D00)
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
]]
native "SET_CINEMATIC_CAM_SHAKE_AMPLITUDE"
hash "0xC724C701C30B2FE7"
jhash (0x67510C4B)
arguments {
float "p0" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
]]
native "SET_CINEMATIC_MODE_ACTIVE"
hash "0xDCF0754AC3D6FD4E"
jhash (0x2009E747)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
```
Toggles the vehicle cinematic cam; requires the player ped to be in a vehicle to work.
```
]]
native "SET_CINEMATIC_NEWS_CHANNEL_ACTIVE_THIS_UPDATE"
hash "0xDC9DA9E8789F5246"
jhash (0x4938C82F)
alias "0xDC9DA9E8789F5246"
ns "CAM"
returns "void"
doc [[!
]]
native "SET_FIRST_PERSON_AIM_CAM_NEAR_CLIP_THIS_UPDATE"
hash "0x0AF7B437918103B3"
jhash (0x0E21069D)
arguments {
float "distance" [=[ {} ]=],
}
alias "0x0AF7B437918103B3"
alias "_SET_FIRST_PERSON_CAM_NEAR_CLIP"
ns "CAM"
returns "void"
doc [[!
]]
native "SET_FIRST_PERSON_AIM_CAM_ZOOM_FACTOR"
hash "0x70894BD0915C5BCA"
jhash (0x9F4AF763)
arguments {
float "zoomFactor" [=[ {} ]=],
}
alias "0x70894BD0915C5BCA"
ns "CAM"
returns "void"
doc [[!
]]
native "SET_FLY_CAM_COORD_AND_CONSTRAIN"
hash "0xC91C6C55199308CA"
jhash (0x60B345DE)
arguments {
Cam "cam" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
alias "0xC91C6C55199308CA"
ns "CAM"
returns "void"
doc [[!
]]
native "SET_FLY_CAM_HORIZONTAL_RESPONSE"
hash "0x503F5920162365B2"
jhash (0x56F9ED27)
arguments {
Cam "cam" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
}
alias "0x503F5920162365B2"
ns "CAM"
returns "void"
doc [[!
]]
native "SET_FLY_CAM_MAX_HEIGHT"
hash "0xF9D02130ECDD1D77"
jhash (0x71570DBA)
arguments {
Cam "cam" [=[ {} ]=],
float "height" [=[ {} ]=],
}
alias "0xF9D02130ECDD1D77"
alias "_SET_CAMERA_RANGE"
ns "CAM"
returns "void"
doc [[!
]]
native "SET_FOLLOW_PED_CAM_THIS_UPDATE"
hash "0x44A113DD6FFC48D1"
jhash (0x1425F6AC)
arguments {
charPtr "camName" [=[ {} ]=],
int "easeTime" [=[ {} ]=],
}
alias "SET_FOLLOW_PED_CAM_CUTSCENE_CHAT"
ns "CAM"
returns "BOOL"
doc [[!
Overrides the ped follow camera (not first person camera) with the specified camera. The game loads all camera metadata from `update/update.rpf/x64/data/metadata/cameras.ymt` and `x64a.rpf/data/metadata/cameras.ymt` with the ped follow cameras being of type `camFollowPedCameraMetadata`.
| Follow Camera Names |
|----------------------------------------------|
| DEFAULT_FOLLOW_PED_CAMERA |
| FOLLOW_PED_ATTACHED_TO_ROPE_CAMERA |
| FOLLOW_PED_ON_EXILE1\_LADDER_CAMERA |
| FOLLOW_PED_SKY_DIVING_CAMERA |
| FOLLOW_PED_SKY_DIVING_FAMILY5\_CAMERA |
| NIGHTCLUB_FOLLOW_PED_CAMERA |
| FOLLOW_PED_INTIMIDATION_CAMERA |
| FOLLOW_PED_IN_WATER_CAMERA |
| FOLLOW_PED_PRONE_CAMERA |
| FOLLOW_PED_ON_SEAT_CAMERA |
| FOLLOW_PED_HANGING_UPSIDE_DOWN_CAMERA |
| FOLLOW_PED_ATTACHED_TO_ROPE_CAMERA |
| CUSTOM_TRANSITION_AFTER_WARP_SKY_DIVE_CAMERA |
| FOLLOW_PED_ON_HORSE_CAMERA |
| FOLLOW_PED_ON_LOUNGER_CAMERA |
Other camera hashes (names not found yet)
```cpp
// 0x5DBBFB6E
// 0xA38DB056
// 0x16B702A3
// 0x41D72A2E
```
The name of the camera to use this update
The time in milliseconds to ease in the camera
Return `true` if the camera is set successfully and `false` otherwise.
]]
native "SET_FOLLOW_PED_CAM_VIEW_MODE"
hash "0x5A4F9EDF1673F704"
jhash (0x495DBE8D)
arguments {
int "viewMode" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
See [`GET_FOLLOW_PED_CAM_VIEW_MODE`](#\_0x8D4D46230B2C353A) for the follow mode enum.
]]
native "SET_FOLLOW_VEHICLE_CAM_VIEW_MODE"
hash "0xAC253D7842768F48"
jhash (0xC4FBBBD3)
arguments {
int "viewMode" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
See [`GET_FOLLOW_PED_CAM_VIEW_MODE`](#\_0x8D4D46230B2C353A) for the follow mode enum.
]]
native "SET_FOLLOW_VEHICLE_CAM_ZOOM_LEVEL"
hash "0x19464CB6E4078C8A"
jhash (0x8F55EBBE)
arguments {
int "zoomLevel" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
See [`GET_FOLLOW_PED_CAM_VIEW_MODE`](#\_0x8D4D46230B2C353A) for the follow mode enum.
]]
native "SET_GAMEPLAY_CAM_FOLLOW_PED_THIS_UPDATE"
hash "0x8BBACBF51DA047A8"
jhash (0x7D3007A2)
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0x8BBACBF51DA047A8"
ns "CAM"
returns "void"
doc [[!
]]
native "SET_GAMEPLAY_CAM_RELATIVE_HEADING"
hash "0xB4EC2312F4E5B1F1"
jhash (0x20C6217C)
arguments {
float "heading" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
```
Sets the camera position relative to heading in float from -360 to +360.
Heading is alwyas 0 in aiming camera.
```
]]
native "SET_GAMEPLAY_CAM_RELATIVE_PITCH"
hash "0x6D0858B8EDFD2B7D"
jhash (0x6381B963)
arguments {
float "angle" [=[ {} ]=],
float "scalingFactor" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
This native sets the camera's pitch (rotation on the x-axis).
the angle to rotate the camera by
always seems to be set to 1.0 in native calls
]]
native "SET_GAMEPLAY_CAM_SHAKE_AMPLITUDE"
hash "0xA87E00932DB4D85D"
jhash (0x9219D44A)
arguments {
float "amplitude" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
```
Sets the amplitude for the gameplay (i.e. 3rd or 1st) camera to shake. Used in script "drunk_controller.ysc.c4" to simulate making the player drunk.
```
]]
native "SET_GAMEPLAY_COORD_HINT"
hash "0xD51ADCD2D8BC0FB3"
jhash (0xF27483C9)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
int "duration" [=[ {} ]=],
int "blendOutDuration" [=[ {} ]=],
int "blendInDuration" [=[ {} ]=],
int "unk" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
]]
native "SET_GAMEPLAY_ENTITY_HINT"
hash "0x189E955A8313E298"
jhash (0x66C32306)
arguments {
Entity "entity" [=[ {} ]=],
float "xOffset" [=[ {} ]=],
float "yOffset" [=[ {} ]=],
float "zOffset" [=[ {} ]=],
BOOL "p4" [=[ {} ]=],
int "p5" [=[ {} ]=],
int "p6" [=[ {} ]=],
int "p7" [=[ {} ]=],
Any "p8" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
```
p6 & p7 - possibly length or time
```
]]
native "SET_GAMEPLAY_HINT_BASE_ORBIT_PITCH_OFFSET"
hash "0xD1F8363DFAD03848"
jhash (0x79472AE3)
arguments {
float "value" [=[ {} ]=],
}
alias "0xD1F8363DFAD03848"
alias "_SET_GAMEPLAY_HINT_ANGLE"
ns "CAM"
returns "void"
doc [[!
]]
native "SET_GAMEPLAY_HINT_FOLLOW_DISTANCE_SCALAR"
hash "0xF8BDBF3D573049A1"
jhash (0x72E8CD3A)
arguments {
float "value" [=[ {} ]=],
}
alias "0xF8BDBF3D573049A1"
alias "_SET_GAMEPLAY_HINT_ANIM_OFFSETZ"
ns "CAM"
returns "void"
doc [[!
]]
native "SET_GAMEPLAY_HINT_FOV"
hash "0x513403FB9C56211F"
jhash (0x96FD173B)
arguments {
float "FOV" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
]]
native "SET_GAMEPLAY_OBJECT_HINT"
hash "0x83E87508A2CA2AC6"
jhash (0x2ED5E2F8)
arguments {
Any "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
BOOL "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
Any "p6" [=[ {} ]=],
Any "p7" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
]]
native "SET_GAMEPLAY_PED_HINT"
hash "0x2B486269ACD548D3"
jhash (0x7C27343E)
arguments {
Ped "p0" [=[ {} ]=],
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
BOOL "p4" [=[ {} ]=],
int "duration" [=[ {} ]=],
int "blendOutDuration" [=[ {} ]=],
int "blendInDuration" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
]]
native "SET_GAMEPLAY_VEHICLE_HINT"
hash "0xA2297E18F3E71C2E"
jhash (0x2C9A11D8)
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "offsetX" [=[ {} ]=],
float "offsetY" [=[ {} ]=],
float "offsetZ" [=[ {} ]=],
BOOL "p4" [=[ {} ]=],
int "time" [=[ {} ]=],
int "easeInTime" [=[ {} ]=],
int "easeOutTime" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
Focuses the camera on the specified vehicle.
The vehicle to focus on.
Position offset X
Position offset Y
Position offset Z
Effect duration
Effect fade in duration
EFfect fade out duration
]]
native "SET_IN_VEHICLE_CAM_STATE_THIS_UPDATE"
hash "0xE9EA16D6E54CDCA4"
jhash (0x4B22C5CB)
arguments {
Vehicle "p0" [=[ {} ]=],
int "p1" [=[ {} ]=],
}
alias "0xE9EA16D6E54CDCA4"
ns "CAM"
returns "void"
doc [[!
]]
native "SET_TABLE_GAMES_CAMERA_THIS_UPDATE"
hash "0x79C0E43EB9B944E2"
arguments {
Hash "hash" [=[ {} ]=],
}
alias "0x79C0E43EB9B944E2"
ns "CAM"
returns "BOOL"
doc [[!
Override the camera work of the third-person camera to table game for current frame only.
| HashKey | Hash | Game |
| :---------------------------------: | :-----------:| :-------------: |
| `CASINO_LUCKY_WHEEL_CAMERA` | `5891389` | Lucky Wheel |
| `CASINO_SLOT_MACHINE_CAMERA` | `518572876` | Slots |
| `CASINO_ROULETTE_CAMERA` | `71681063` | Roulette |
| `CASINO_BLACKJACK_CAMERA` | `-2124244681` | Blackjack |
| `CASINO_POKER_CAMERA` | `-1938411241` | Three Cards |
| `CASINO_INSIDE_TRACK_CAMERA` | `1929822423` | Inside Track |
| `ARCADE_LOVE_PROFESSOR_P1_CAMERA` | `545868034` | LoveProfessorP1 |
| `ARCADE_LOVE_PROFESSOR_P2_CAMERA` | `935304251` | LoveProfessorP2 |
Hash for table game
Returns a boolean value indicating if the camera settings were successfully overriden for this current frame.
]]
native "SET_THIRD_PERSON_AIM_CAM_NEAR_CLIP_THIS_UPDATE"
hash "0x42156508606DE65E"
jhash (0x71E9C63E)
arguments {
float "distance" [=[ {} ]=],
}
alias "0x42156508606DE65E"
alias "_SET_THIRD_PERSON_AIM_CAM_NEAR_CLIP"
ns "CAM"
returns "void"
doc [[!
]]
native "SET_USE_HI_DOF"
hash "0xA13B0222F3D94A94"
jhash (0x8BBF2950)
ns "CAM"
returns "void"
doc [[!
Needs to be called every tick to make the active camera use a high depth of field.\
The DoF can be customized using [`SET_CAM_NEAR_DOF`](#\_0x3FA4BF0A7AB7DE2C), [`SET_CAM_FAR_DOF`](#\_0xEDD91296CD01AEE0), [`SET_CAM_USE_SHALLOW_DOF_MODE`](#\_0x16A96863A17552BB), [`SET_CAM_DOF_STRENGTH`](#\_0x5EE29B4D7D5DF897) and other DoF related natives.
### Usage Example
A usage example for this native can be found in the following native documentation: [`SET_CAM_DOF_STRENGTH`](#\_0x5EE29B4D7D5DF897).
]]
native "SET_WIDESCREEN_BORDERS"
hash "0xDCD4EA924F42D01A"
jhash (0x1A75DC9A)
arguments {
BOOL "p0" [=[ {} ]=],
int "p1" [=[ {} ]=],
}
ns "CAM"
annotations [=[ {"cs_type":"Any"} ]=]
returns "void"
doc [[!
]]
native "SHAKE_CAM"
hash "0x6A25241C340D3822"
jhash (0x1D4211B0)
arguments {
Cam "cam" [=[ {} ]=],
charPtr "shakeName" [=[ {} ]=],
float "intensity" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
See [`SHAKE_GAMEPLAY_CAM`](#\_0xFD55E49555E017CF) for a full list of camera shakes.
The camera handle.
The name of the shake.
The intensity of the shake.
]]
native "SHAKE_CINEMATIC_CAM"
hash "0xDCE214D9ED58F3CF"
jhash (0x61815F31)
arguments {
charPtr "shakeName" [=[ {} ]=],
float "intensity" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
See [`SHAKE_GAMEPLAY_CAM`](#\_0xFD55E49555E017CF) for a full list of camera shakes.
The name of the shake.
The intensity of the shake.
]]
native "SHAKE_GAMEPLAY_CAM"
hash "0xFD55E49555E017CF"
jhash (0xF2EFE660)
arguments {
charPtr "shakeName" [=[ {} ]=],
float "intensity" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
Shakes the gameplay cam with the specified shake name and intensity.
List of camera shake names:
```
ASSAULT_RIFLE_RECOIL_SHAKE
BOAT_WATER_ENTRY_SHAKE
CAMERA_OPERATOR_SHAKE_X
CAMERA_OPERATOR_SHAKE_Z
CAMERA_OPERATOR_TURBULENCE_SHAKE
CARBINE_RIFLE_ACCURACY_OFFSET_SHAKE
CARBINE_RIFLE_RECOIL_SHAKE
CINEMATIC_SHOOTING_RUN_SHAKE
DAMPED_HAND_SHAKE
DEATH_FAIL_IN_EFFECT_SHAKE
DEATH_FAIL_OUT_EFFECT_SHAKE
DEFAULT_DEPLOY_PARACHUTE_SHAKE
DEFAULT_FIRST_PERSON_RECOIL_SHAKE
DEFAULT_KILL_EFFECT_SHAKE
DEFAULT_THIRD_PERSON_ACCURACY_OFFSET_SHAKE
DEFAULT_THIRD_PERSON_RECOIL_SHAKE
DRUNK_SHAKE
FAMILY5_DRUG_TRIP_SHAKE
FIRST_PERSON_AIM_SHAKE
FIRST_PERSON_DEPLOY_PARACHUTE_SHAKE
FOLLOW_RUN_SHAKE
FOLLOW_SWIM_SHAKE
FPS_ASSAULT_RIFLE_RECOIL_SHAKE
FPS_BOLT_RELOAD_SHAKE
FPS_BULLET_HIT_SHAKE
FPS_DEATH_SHAKE
FPS_GRENADE_LAUNCHER_RECOIL_SHAKE
FPS_MAG_DROP_SHAKE
FPS_MAG_RELOAD_SHAKE
FPS_MELEE_HIT_SHAKE
FPS_MG_RECOIL_SHAKE
FPS_MINIGUN_RECOIL_SHAKE
FPS_PISTOL_RECOIL_SHAKE
FPS_RPG_RECOIL_SHAKE
FPS_SHOTGUN_PUMP_SHAKE
FPS_SHOTGUN_RECOIL_SHAKE
FPS_SMG_RECOIL_SHAKE
FPS_STEERING_WHEEL_HIT_SHAKE
FPS_TANK_RECOIL_SHAKE
FPS_THROW_SHAKE
FPS_VEHICLE_HIT_SHAKE
FPS_ZOOM_IN_SHAKE
GAMEPLAY_EXPLOSION_SHAKE
GRENADE_EXPLOSION_SHAKE
GRENADE_LAUNCHER_RECOIL_SHAKE
HAND_SHAKE
HAND_SHAKE_ROLL
HIGH_DIVE_SHAKE
HIGH_FALL_SHAKE
HIGH_SPEED_BOAT_SHAKE
HIGH_SPEED_POV_SHAKE
HIGH_SPEED_VEHICLE_SHAKE
HIGH_SPEED_VIBRATION_POV_SHAKE
IDLE_HAND_SHAKE
JOLT_SHAKE
KILL_SHOT_SHAKE
LARGE_EXPLOSION_SHAKE
LOW_ORBIT_HIGH_SPEED_CAMERA_SHAKE
LOW_ORBIT_INACCURACY_CAMERA_SHAKE
MEDIUM_EXPLOSION_SHAKE
MG_RECOIL_SHAKE
MINIGUN_RECOIL_SHAKE
PARACHUTING_SHAKE
PISTOL_RECOIL_SHAKE
PLANE_PART_SPEED_SHAKE
POV_IDLE_SHAKE
REPLAY_DRUNK_SHAKE
REPLAY_EXPLOSION_SHAKE
REPLAY_HAND_SHAKE
REPLAY_HIGH_SPEED_VEHICLE_SHAKE
REPLAY_SKY_DIVING_SHAKE
ROAD_VIBRATION_SHAKE
RPG_RECOIL_SHAKE
SHOTGUN_RECOIL_SHAKE
SKY_DIVING_SHAKE
SMALL_EXPLOSION_SHAKE
SMG_RECOIL_SHAKE
STUNT_HAND_SHAKE
SWITCH_HAND_SHAKE
TANK_RECOIL_SHAKE
VEH_IMPACT_HEADING_SHAKE
VEH_IMPACT_PITCH_HEADING_SHAKE_FPS
VEH_IMPACT_PITCH_SHAKE
VIBRATE_SHAKE
WATER_BOB_SHAKE
WOBBLY_SHAKE
```
The name of the shake.
The intensity of the shake.
]]
native "SHAKE_SCRIPT_GLOBAL"
hash "0xF4C8CF9E353AFECA"
jhash (0x2B0F05CD)
arguments {
charPtr "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
}
alias "0xF4C8CF9E353AFECA"
ns "CAM"
returns "void"
doc [[!
```
CAM::SHAKE_SCRIPT_GLOBAL("HAND_SHAKE", 0.2);
```
]]
native "STOP_CAM_POINTING"
hash "0xF33AB75780BA57DE"
jhash (0x5435F6A5)
arguments {
Cam "cam" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
]]
native "STOP_CAM_SHAKING"
hash "0xBDECF64367884AC3"
jhash (0x40D0EB87)
arguments {
Cam "cam" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
]]
native "STOP_CINEMATIC_CAM_SHAKING"
hash "0x2238E588E588A6D7"
jhash (0x71C12904)
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
]]
native "STOP_CINEMATIC_SHOT"
hash "0x7660C6E75D3A078E"
jhash (0xD78358C5)
arguments {
Hash "p0" [=[ {"cs_type":"Any"} ]=],
}
ns "CAM"
returns "void"
doc [[!
]]
native "STOP_CUTSCENE_CAM_SHAKING"
hash "0xDB629FFD9285FA06"
jhash (0xF07D603D)
ns "CAM"
returns "void"
doc [[!
]]
native "STOP_GAMEPLAY_CAM_SHAKING"
hash "0x0EF93E9F3D08C178"
jhash (0xFD569E4E)
arguments {
BOOL "bStopImmediately" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
Should the shake stop this frame.
]]
native "STOP_GAMEPLAY_HINT"
hash "0xF46C581C61718916"
jhash (0x1BC28B7B)
arguments {
BOOL "bStopImmediately" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
Terminates the current gameplay hint camera, with an option for immediate cessation or a gradual fade out.
```
NativeDB Introduced: v323
```
Specifies whether the gameplay hint camera should stop instantly `true` or gradually transition out `false`.
]]
native "STOP_RENDERING_SCRIPT_CAMS_USING_CATCH_UP"
hash "0xC819F3CBB62BF692"
jhash (0xD3C08183)
arguments {
BOOL "bShouldApplyAcrossAllThreads" [=[ {} ]=],
float "distanceToBlend" [=[ {} ]=],
int "blendType" [=[ {} ]=],
}
alias "0xC819F3CBB62BF692"
alias "_RENDER_FIRST_PERSON_CAM"
ns "CAM"
returns "void"
doc [[!
Instructs the game engine to stop rendering scripted cameras and transition back to the gameplay camera, optionally applying custom blending and rendering options.
```cpp
enum eRenderingOptionFlags {
RO_NO_OPTIONS = 0,
RO_STOP_RENDERING_OPTION_WHEN_PLAYER_EXITS_INTO_COVER = 1
};
```
```cpp
enum eCamSplineSmoothingFlags {
// No smoothing just moves at a constant rate
CAM_SPLINE_NO_SMOOTH = 0,
// Decelerates when approaching a node
CAM_SPLINE_SLOW_IN_SMOOTH = 1,
// Accelerates slowly when leaving a node
CAM_SPLINE_SLOW_OUT_SMOOTH = 2,
// Decelerates when approaching a node and accelerates slowly when leaving a node
CAM_SPLINE_SLOW_IN_OUT_SMOOTH = 3,
CAM_SPLINE_VERY_SLOW_IN = 4,
CAM_SPLINE_VERY_SLOW_OUT = 5,
CAM_SPLINE_VERY_SLOW_IN_SLOW_OUT = 6,
CAM_SPLINE_SLOW_IN_VERY_SLOW_OUT = 7,
CAM_SPLINE_VERY_SLOW_IN_VERY_SLOW_OUT = 8,
CAM_SPLINE_EASE_IN = 9,
CAM_SPLINE_EASE_OUT = 10,
CAM_SPLINE_QUADRATIC_EASE_IN = 11,
CAM_SPLINE_QUADRATIC_EASE_OUT = 12,
CAM_SPLINE_QUADRATIC_EASE_IN_OUT = 13,
CAM_SPLINE_CUBIC_EASE_IN = 14,
CAM_SPLINE_CUBIC_EASE_OUT = 15,
CAM_SPLINE_CUBIC_EASE_IN_OUT = 16,
CAM_SPLINE_QUARTIC_EASE_IN = 17,
CAM_SPLINE_QUARTIC_EASE_OUT = 18,
CAM_SPLINE_QUARTIC_EASE_IN_OUT = 19,
CAM_SPLINE_QUINTIC_EASE_IN = 20,
CAM_SPLINE_QUINTIC_EASE_OUT = 21,
CAM_SPLINE_QUINTIC_EASE_IN_OUT = 22,
CAM_SPLINE_CIRCULAR_EASE_IN = 23,
CAM_SPLINE_CIRCULAR_EASE_OUT = 24,
CAM_SPLINE_CIRCULAR_EASE_IN_OUT = 25
};
```
```
NativeDB Added Parameter 4: int renderingOptions : An integer bitmask of eRenderingOptionFlags to apply specific rendering behaviors during the transition. RO_NO_OPTIONS signifies no special options are applied.
```
```
NativeDB Introduced: v323
```
If `true`, ensures that the rendering stop request is enforced regardless of other script threads that might still expect rendering to be active. Use with caution to avoid conflicts.
Specifies the distance over which the camera should blend from the scripted camera back to the gameplay camera. A value of `0.0` uses the game's default blending distance.
An integer representing `eCamSplineSmoothingFlags` to determine the smoothness of the camera transition. Common values include `CAM_SPLINE_SLOW_IN_OUT_SMOOTH` among others, defining the easing of the blend.
]]
native "STOP_SCRIPT_GLOBAL_SHAKING"
hash "0x1C9D7949FA533490"
jhash (0x26FCFB96)
arguments {
BOOL "bStopImmediately" [=[ {} ]=],
}
alias "0x1C9D7949FA533490"
ns "CAM"
returns "void"
doc [[!
Stops the currently active global camera shake that was initiated by a script. You can check if a global camera shake is active using [IS_SCRIPT_GLOBAL_SHAKING](#\_0xC912AF078AF19212).
```
NativeDB Introduced: v323
```
A boolean indicating whether the camera shake should stop instantly (TRUE) or gradually fade out (FALSE).
]]
native "USE_SCRIPT_CAM_FOR_AMBIENT_POPULATION_ORIGIN_THIS_FRAME"
hash "0x271401846BD26E92"
jhash (0x8DC53629)
arguments {
BOOL "vehicles" [=[ {} ]=],
BOOL "peds" [=[ {} ]=],
}
alias "0x271401846BD26E92"
ns "CAM"
returns "void"
doc [[!
Sets the ambient ped & vehicle population spawning origin to be based around the active scripted camera for this frame
This will prevent vehicles from being created close to the camera and/or on-screen
]]
native "USE_VEHICLE_CAM_STUNT_SETTINGS_THIS_UPDATE"
hash "0x6493CF69859B116A"
alias "0x6493CF69859B116A"
alias "_USE_STUNT_CAMERA_THIS_FRAME"
ns "CAM"
returns "void"
doc [[!
Applies a predefined set of vehicle camera settings optimized for capturing stunts, effective for the current game update/frame.
```
NativeDB Introduced: v791
```
]]
native "_ACTIVATE_CAM_WITH_INTERP_AND_FOV_CURVE"
hash "0x34CFC4C2A38E83E3"
arguments {
Cam "camTo" [=[ {} ]=],
Cam "camFrom" [=[ {} ]=],
int "duration" [=[ {} ]=],
int "easeLocation" [=[ {} ]=],
int "easeRotation" [=[ {} ]=],
int "easeFove" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
```
NativeDB Introduced: v3258
```
]]
native "_ANIMATE_GAMEPLAY_CAM_ZOOM"
hash "0xDF2E1F7742402E81"
jhash (0x77340650)
arguments {
float "p0" [=[ {} ]=],
float "distance" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
```
Seems to animate the gameplay camera zoom.
Eg. _ANIMATE_GAMEPLAY_CAM_ZOOM(1f, 1000f);
will animate the camera zooming in from 1000 meters away.
Game scripts use it like this:
// Setting this to 1 prevents V key from changing zoom
PLAYER::SET_PLAYER_FORCED_ZOOM(PLAYER::PLAYER_ID(), 1);
// These restrict how far you can move cam up/down left/right
CAM::_CLAMP_GAMEPLAY_CAM_YAW(-20f, 50f);
CAM::_CLAMP_GAMEPLAY_CAM_PITCH(-60f, 0f);
CAM::_ANIMATE_GAMEPLAY_CAM_ZOOM(1f, 1f);
```
]]
native "_ATTACH_CAM_TO_VEHICLE_BONE"
hash "0x8DB3F12A02CAEF72"
arguments {
Cam "cam" [=[ {} ]=],
Vehicle "vehicle" [=[ {} ]=],
int "boneIndex" [=[ {} ]=],
BOOL "relativeRotation" [=[ {} ]=],
float "rotX" [=[ {} ]=],
float "rotY" [=[ {} ]=],
float "rotZ" [=[ {} ]=],
float "offX" [=[ {} ]=],
float "offY" [=[ {} ]=],
float "offZ" [=[ {} ]=],
BOOL "fixedDirection" [=[ {} ]=],
}
alias "0x8DB3F12A02CAEF72"
ns "CAM"
returns "void"
doc [[!
This native works with vehicles only.
Bone indexes are usually given by this native [GET_ENTITY_BONE_INDEX_BY_NAME](#\_0xFB71170B7E76ACBA).
The camera handle.
The vehicle handle.
Whether or not the camera rotation will relative the vehicle rotation.
The X rotation.
The Y rotation.
The Z rotation.
The X offset direction.
The Y offset direction.
The Z offset direction.
Whether or not the camera direction will relative to the vehicle direction.
]]
native "_CLAMP_GAMEPLAY_CAM_PITCH"
hash "0xA516C198B7DCA1E1"
jhash (0xFA3A16E7)
arguments {
float "minimum" [=[ {} ]=],
float "maximum" [=[ {} ]=],
}
ns "CAM"
annotations [=[ {"cs_type":"Any"} ]=]
returns "void"
doc [[!
```
minimum: Degrees between -90f and 90f.
maximum: Degrees between -90f and 90f.
Clamps the gameplay camera's current pitch.
Eg. _CLAMP_GAMEPLAY_CAM_PITCH(0.0f, 0.0f) will set the vertical angle directly behind the player.
```
]]
native "_CLAMP_GAMEPLAY_CAM_YAW"
hash "0x8F993D26E0CA5E8E"
jhash (0x749909AC)
arguments {
float "minimum" [=[ {} ]=],
float "maximum" [=[ {} ]=],
}
ns "CAM"
annotations [=[ {"cs_type":"Any"} ]=]
returns "void"
doc [[!
```
minimum: Degrees between -180f and 180f.
maximum: Degrees between -180f and 180f.
Clamps the gameplay camera's current yaw.
Eg. _CLAMP_GAMEPLAY_CAM_YAW(0.0f, 0.0f) will set the horizontal angle directly behind the player.
```
]]
native "_DISABLE_CAM_COLLISION_FOR_ENTITY"
hash "0x2AED6301F67007D5"
jhash (0x2701A9AD)
arguments {
Entity "entity" [=[ {} ]=],
}
alias "0x2AED6301F67007D5"
ns "CAM"
returns "void"
doc [[!
]]
native "_ENABLE_CROSSHAIR_THIS_FRAME"
hash "0xEA7F0AD7E9BA676F"
jhash (0xA61FF9AC)
ns "CAM"
returns "void"
doc [[!
```
Shows the crosshair even if it wouldn't show normally. Only works for one frame, so make sure to call it repeatedly.
```
]]
native "_GET_CAM_ACTIVE_VIEW_MODE_CONTEXT"
hash "0x19CAFA3C87F7C2FF"
alias "0x19CAFA3C87F7C2FF"
ns "CAM"
returns "int"
doc [[!
Enumerated type defined in camControlHelperMetadataViewModes:
```cpp
enum eContext {
ON_FOOT = 0, // [G|S]ET_FOLLOW_PED_CAM_*
IN_VEHICLE = 1, // [G|S]ET_FOLLOW_VEHICLE_CAM_*
ON_BIKE = 2,
IN_BOAT = 3,
IN_AIRCRAFT = 4,
IN_SUBMARINE = 5,
IN_HELI = 6,
IN_TURRET = 7,
}
```
The active view mode context.
]]
native "_GET_CAM_DOF_STRENGTH"
hash "0x06D153C0B99B6128"
arguments {
Cam "cam" [=[ {} ]=],
}
ns "CAM"
returns "float"
doc [[!
```
NativeDB Introduced: v2699
```
]]
native "_GET_CAM_NEAR_DOF"
hash "0xC2612D223D915A1C"
arguments {
Cam "cam" [=[ {} ]=],
}
ns "CAM"
returns "float"
doc [[!
```
NativeDB Introduced: v2699
```
]]
native "_GET_DEBUG_CAMERA"
hash "0x77C3CEC46BE286F6"
alias "0x77C3CEC46BE286F6"
ns "CAM"
returns "Cam"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "_INTERPOLATE_CAM_WITH_PARAMS"
hash "0xDDA77EE33C005AAF"
arguments {
Cam "camera" [=[ {} ]=],
float "camPosX" [=[ {} ]=],
float "camPosY" [=[ {} ]=],
float "camPosZ" [=[ {} ]=],
float "camRotX" [=[ {} ]=],
float "camRotY" [=[ {} ]=],
float "camRotZ" [=[ {} ]=],
float "fov" [=[ {} ]=],
int "duration" [=[ {} ]=],
int "posCurveType" [=[ {} ]=],
int "rotCurveType" [=[ {} ]=],
int "rotOrder" [=[ {} ]=],
int "fovCurveType" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
Interpolates the camera to specified parameters over a set duration using various curve types for position, rotation, and fov.
```
NativeDB Introduced: v3258
```
]]
native "_INVALIDATE_VEHICLE_IDLE_CAM"
hash "0x9E4CFFF989258472"
jhash (0x65DDE8AF)
alias "0x9E4CFFF989258472"
ns "CAM"
returns "void"
doc [[!
Resets the vehicle idle camera timer. Calling this in a loop will disable the idle camera.
]]
native "_IS_AIM_CAM_THIRD_PERSON_ACTIVE"
hash "0x74BD83EA840F6BC9"
jhash (0x8F320DE4)
alias "0x74BD83EA840F6BC9"
ns "CAM"
returns "BOOL"
doc [[!
```
IS_A*
```
]]
native "_IS_IN_VEHICLE_CAM_DISABLED"
hash "0x4F32C0D5A90A9B40"
alias "0x4F32C0D5A90A9B40"
ns "CAM"
returns "BOOL"
doc [[!
]]
native "_REPLAY_FREE_CAM_GET_MAX_RANGE"
hash "0x8BFCEB5EA1B161B6"
alias "0x8BFCEB5EA1B161B6"
ns "CAM"
returns "float"
doc [[!
]]
native "_SET_CAM_DOF_FNUMBER_OF_LENS"
hash "0x7DD234D6F3914C5B"
arguments {
Cam "camera" [=[ {} ]=],
float "p1" [=[ {} ]=],
}
alias "0x7DD234D6F3914C5B"
ns "CAM"
returns "void"
doc [[!
```
This native has its name defined inside its codE
```
]]
native "_SET_CAM_DOF_FOCAL_LENGTH_MULTIPLIER"
hash "0x47B595D60664CFFA"
arguments {
Cam "camera" [=[ {} ]=],
float "multiplier" [=[ {} ]=],
}
alias "0x47B595D60664CFFA"
ns "CAM"
returns "void"
doc [[!
```
Native name labeled within its code
```
]]
native "_SET_CAM_DOF_FOCUS_DISTANCE_BIAS"
hash "0xC669EEA5D031B7DE"
arguments {
Cam "camera" [=[ {} ]=],
float "p1" [=[ {} ]=],
}
alias "0xC669EEA5D031B7DE"
ns "CAM"
returns "void"
doc [[!
```
This native has a name defined inside its code
```
]]
native "_SET_CAM_DOF_MAX_NEAR_IN_FOCUS_DISTANCE"
hash "0xC3654A441402562D"
arguments {
Cam "camera" [=[ {} ]=],
float "p1" [=[ {} ]=],
}
alias "0xC3654A441402562D"
ns "CAM"
returns "void"
doc [[!
```
This native has a name defined inside its code
```
]]
native "_SET_CAM_DOF_MAX_NEAR_IN_FOCUS_DISTANCE_BLEND_LEVEL"
hash "0x2C654B4943BDDF7C"
arguments {
Cam "camera" [=[ {} ]=],
float "p1" [=[ {} ]=],
}
alias "0x2C654B4943BDDF7C"
ns "CAM"
returns "void"
doc [[!
```
This native has a name defined inside its code
```
]]
native "_SET_CAM_EFFECT"
hash "0x80C8B1846639BB19"
jhash (0xB06CCD38)
arguments {
int "p0" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
```
if p0 is 0, effect is cancelled
if p0 is 1, effect zooms in, gradually tilts cam clockwise apx 30 degrees, wobbles slowly. Motion blur is active until cancelled.
if p0 is 2, effect immediately tilts cam clockwise apx 30 degrees, begins to wobble slowly, then gradually tilts cam back to normal. The wobbling will continue until the effect is cancelled.
```
]]
native "_SET_FIRST_PERSON_CAM_PITCH_RANGE"
hash "0xBCFC632DB7673BF0"
jhash (0x76DAC96C)
arguments {
float "minAngle" [=[ {} ]=],
float "maxAngle" [=[ {} ]=],
}
alias "0xBCFC632DB7673BF0"
ns "CAM"
returns "void"
doc [[!
]]
native "_SET_FLY_CAM_VERTICAL_SPEED_MULTIPLIER"
hash "0xE827B9382CFB41BA"
arguments {
Cam "cam" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
}
alias "0xE827B9382CFB41BA"
ns "CAM"
returns "void"
doc [[!
]]
native "_SET_FOLLOW_TURRET_SEAT_CAM"
hash "0x5C90CAB09951A12F"
arguments {
int "seatIndex" [=[ {} ]=],
}
alias "0x5C90CAB09951A12F"
ns "CAM"
returns "void"
doc [[!
```
NativeDB Introduced: v1365
```
See [IS_TURRET_SEAT](#\_0xE33FFA906CE74880)
]]
native "_SET_GAMEPLAY_CAM_HASH"
hash "0x425A920FDB9A0DDA"
arguments {
charPtr "camName" [=[ {} ]=],
}
alias "0x425A920FDB9A0DDA"
ns "CAM"
returns "void"
doc [[!
```
Sets gameplay camera to hash
```
```
NativeDB Introduced: v1180
```
]]
native "_SET_GAMEPLAY_CAM_RAW_PITCH"
hash "0x759E13EBC1C15C5A"
arguments {
float "pitch" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
]]
native "_SET_GAMEPLAY_CAM_RAW_YAW"
hash "0x103991D4A307D472"
arguments {
float "yaw" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
```
Does nothing
```
```
NativeDB Added Parameter 2: Any p1
```
]]
native "_SET_GAMEPLAY_CAM_RELATIVE_ROTATION"
hash "0x48608C3464F58AB4"
arguments {
float "roll" [=[ {} ]=],
float "pitch" [=[ {} ]=],
float "yaw" [=[ {} ]=],
}
alias "0x48608C3464F58AB4"
ns "CAM"
returns "void"
doc [[!
]]
native "_SET_GAMEPLAY_CAM_VEHICLE_CAMERA"
hash "0x21E253A7F8DA5DFB"
arguments {
charPtr "vehicleName" [=[ {} ]=],
}
alias "0x21E253A7F8DA5DFB"
ns "CAM"
returns "void"
doc [[!
```
From b617 scripts:
CAM::_21E253A7F8DA5DFB("DINGHY");
CAM::_21E253A7F8DA5DFB("ISSI2");
CAM::_21E253A7F8DA5DFB("SPEEDO");
```
]]
native "_SET_GAMEPLAY_CAM_VEHICLE_CAMERA_NAME"
hash "0x11FA5D3479C7DD47"
arguments {
Hash "vehicleModel" [=[ {"cs_type":"Any"} ]=],
}
alias "0x11FA5D3479C7DD47"
ns "CAM"
returns "void"
doc [[!
]]
native "_SET_GAMEPLAY_HINT_ANIM_CLOSEUP"
hash "0xE3433EADAAF7EE40"
jhash (0x2F0CE859)
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "GET_IS_MULTIPLAYER_BRIEF"
alias "0xE3433EADAAF7EE40"
ns "CAM"
returns "void"
doc [[!
]]
native "_SET_GAMEPLAY_HINT_ANIM_OFFSETX"
hash "0x5D7B620DAE436138"
jhash (0xFC7464A0)
arguments {
float "xOffset" [=[ {} ]=],
}
alias "0x5D7B620DAE436138"
ns "CAM"
returns "void"
doc [[!
]]
native "_SET_GAMEPLAY_HINT_ANIM_OFFSETY"
hash "0xC92717EF615B6704"
jhash (0x3554AA0E)
arguments {
float "yOffset" [=[ {} ]=],
}
alias "0xC92717EF615B6704"
ns "CAM"
returns "void"
doc [[!
]]
native "_SET_USE_HI_DOF_IN_CUTSCENE"
hash "0x731A880555DA3647"
ns "CAM"
returns "void"
doc [[!
```
Only used in R* Script fm_mission_controller_2020
```
```
NativeDB Introduced: v2699
```
]]
native "0x0225778816FDC28C"
hash "0x0225778816FDC28C"
jhash (0x1126E37C)
arguments {
float "p0" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
```
some camera effect that is (also) used in the drunk-cheat, and turned off (by setting it to 0.0) along with the shaking effects once the drunk cheat is disabled. Possibly a cinematic or script-cam version of _0x487A82C650EB7799
```
]]
native "0x0AA27680A0BD43FA"
hash "0x0AA27680A0BD43FA"
ns "CAM"
returns "void"
doc [[!
]]
native "0x12DED8CA53D47EA5"
hash "0x12DED8CA53D47EA5"
jhash (0x067BA6F5)
arguments {
float "p0" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
```
Hardcoded to only work in multiplayer.
```
]]
native "0x17FCA7199A530203"
hash "0x17FCA7199A530203"
jhash (0xF26E339C)
ns "CAM"
returns "void"
doc [[!
]]
native "0x1F2300CB7FA7B7F6"
hash "0x1F2300CB7FA7B7F6"
jhash (0x6739AD55)
ns "CAM"
returns "Any"
doc [[!
]]
native "0x247ACBC4ABBC9D1C"
hash "0x247ACBC4ABBC9D1C"
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
]]
native "0x271017B9BA825366"
hash "0x271017B9BA825366"
jhash (0x43220969)
arguments {
Any "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
]]
native "0x28B022A17B068A3A"
hash "0x28B022A17B068A3A"
arguments {
float "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
F\*
```
NativeDB Introduced: v1734
```
]]
native "0x2F7F2B26DD3F18EE"
hash "0x2F7F2B26DD3F18EE"
jhash (0x2F29F0D5)
arguments {
float "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
]]
native "0x3044240D2E0FA842"
hash "0x3044240D2E0FA842"
jhash (0xC0B00C20)
ns "CAM"
returns "BOOL"
doc [[!
]]
native "0x324C5AA411DA7737"
hash "0x324C5AA411DA7737"
arguments {
Any "p0" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
```
NativeDB Introduced: v323
```
]]
native "0x380B4968D1E09E55"
hash "0x380B4968D1E09E55"
ns "CAM"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "0x4008EDF7D6E48175"
hash "0x4008EDF7D6E48175"
jhash (0xD1EEBC45)
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
]]
native "0x469F2ECDEC046337"
hash "0x469F2ECDEC046337"
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
]]
native "0x4879E4FE39074CDF"
hash "0x4879E4FE39074CDF"
ns "CAM"
returns "BOOL"
doc [[!
```
A*
```
]]
native "0x59424BD75174C9B1"
hash "0x59424BD75174C9B1"
ns "CAM"
returns "void"
doc [[!
]]
native "0x5A43C76F7FC7BA5F"
hash "0x5A43C76F7FC7BA5F"
jhash (0xE206C450)
ns "CAM"
returns "void"
doc [[!
]]
native "0x5C41E6BABC9E2112"
hash "0x5C41E6BABC9E2112"
arguments {
Any "p0" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
]]
native "0x5C48A1D6E3B33179"
hash "0x5C48A1D6E3B33179"
jhash (0xDA931D65)
arguments {
Cam "cam" [=[ {} ]=],
}
ns "CAM"
returns "BOOL"
doc [[!
```
W*
```
]]
native "0x5D96CFB59DA076A0"
hash "0x5D96CFB59DA076A0"
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
p1: 0..16
```
NativeDB Introduced: v2060
```
]]
native "0x62374889A4D59F72"
hash "0x62374889A4D59F72"
ns "CAM"
returns "void"
doc [[!
]]
native "0x62ECFCFDEE7885D6"
hash "0x62ECFCFDEE7885D6"
jhash (0x837F8581)
ns "CAM"
returns "void"
doc [[!
]]
native "0x705A276EBFF3133D"
hash "0x705A276EBFF3133D"
jhash (0x60C23785)
ns "CAM"
returns "BOOL"
doc [[!
]]
native "0x7295C203DD659DFE"
hash "0x7295C203DD659DFE"
ns "CAM"
returns "void"
doc [[!
```
_RESET_*
_RESET_GAMEPLAY_CAM_RELATIVE_ORBIT_HOLD_TIME?
```
```
NativeDB Introduced: v2699
```
]]
native "0x91EF6EE6419E5B97"
hash "0x91EF6EE6419E5B97"
jhash (0x9DB5D391)
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
]]
native "0x9DFE13ECDC1EC196"
hash "0x9DFE13ECDC1EC196"
jhash (0x92302899)
arguments {
BOOL "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
alias "SET_TIME_IDLE_DROP"
ns "CAM"
returns "void"
doc [[!
```
SET_FOLLOW_*
```
]]
native "0x9F97DA93681F87EA"
hash "0x9F97DA93681F87EA"
ns "CAM"
returns "void"
doc [[!
B\*
```
NativeDB Introduced: v1734
```
]]
native "0xA2767257A320FC82"
hash "0xA2767257A320FC82"
arguments {
Any "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
]]
native "0xA7092AFE81944852"
hash "0xA7092AFE81944852"
ns "CAM"
returns "void"
doc [[!
```
NativeDB Introduced: v2189
```
]]
native "0xAABD62873FFB1A33"
hash "0xAABD62873FFB1A33"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
```
NativeDB Introduced: v2189
```
]]
native "0xB1381B97F70C7B30"
hash "0xB1381B97F70C7B30"
ns "CAM"
returns "void"
doc [[!
```
NativeDB Introduced: v1180
```
]]
native "0xBF72910D0F26F025"
hash "0xBF72910D0F26F025"
ns "CAM"
returns "Any"
doc [[!
]]
native "0xC8391C309684595A"
hash "0xC8391C309684595A"
jhash (0x1F9DE6E4)
ns "CAM"
returns "void"
doc [[!
]]
native "0xC8B5C4A79CC18B94"
hash "0xC8B5C4A79CC18B94"
jhash (0x44473EFC)
arguments {
Cam "cam" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
]]
native "0xCCD078C2665D2973"
hash "0xCCD078C2665D2973"
jhash (0xCAFEE798)
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
**This native does absolutely nothing, just a nullsub**
]]
native "0xCED08CBE8EBB97C7"
hash "0xCED08CBE8EBB97C7"
jhash (0x68BA0730)
arguments {
float "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
]]
native "0xDB90C6CCA48940F1"
hash "0xDB90C6CCA48940F1"
jhash (0x20BFF6E5)
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
]]
native "0xDD79DF9F4D26E1C9"
hash "0xDD79DF9F4D26E1C9"
jhash (0x6B0E9D57)
ns "CAM"
returns "void"
doc [[!
]]
native "0xE111A7C0D200CBC5"
hash "0xE111A7C0D200CBC5"
arguments {
Any "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
]]
native "0xF55E4046F6F831DC"
hash "0xF55E4046F6F831DC"
arguments {
Any "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
]]
native "0xFD3151CD37EA2245"
hash "0xFD3151CD37EA2245"
arguments {
Entity "entity" [=[ {} ]=],
}
ns "CAM"
returns "void"
doc [[!
]]
native "DATAARRAY_ADD_BOOL"
hash "0xF8B0F5A43E928C76"
jhash (0x08174B90)
arguments {
AnyPtr "arrayData" [=[ {} ]=],
BOOL "value" [=[ {} ]=],
}
alias "_ARRAY_VALUE_ADD_BOOLEAN"
ns "DATAFILE"
returns "void"
doc [[!
]]
native "DATAARRAY_ADD_DICT"
hash "0x6889498B3E19C797"
jhash (0xC174C71B)
arguments {
AnyPtr "arrayData" [=[ {} ]=],
}
alias "_ARRAY_VALUE_ADD_OBJECT"
ns "DATAFILE"
returns "AnyPtr"
doc [[!
]]
native "DATAARRAY_ADD_FLOAT"
hash "0x57A995FD75D37F56"
jhash (0xE4302123)
arguments {
AnyPtr "arrayData" [=[ {} ]=],
float "value" [=[ {} ]=],
}
alias "_ARRAY_VALUE_ADD_FLOAT"
ns "DATAFILE"
returns "void"
doc [[!
]]
native "DATAARRAY_ADD_INT"
hash "0xCABDB751D86FE93B"
jhash (0xF29C0B36)
arguments {
AnyPtr "arrayData" [=[ {} ]=],
int "value" [=[ {} ]=],
}
alias "_ARRAY_VALUE_ADD_INTEGER"
ns "DATAFILE"
returns "void"
doc [[!
]]
native "DATAARRAY_ADD_STRING"
hash "0x2F0661C155AEEEAA"
jhash (0xF3C01350)
arguments {
AnyPtr "arrayData" [=[ {} ]=],
charPtr "value" [=[ {} ]=],
}
alias "_ARRAY_VALUE_ADD_STRING"
ns "DATAFILE"
returns "void"
doc [[!
]]
native "DATAARRAY_ADD_VECTOR"
hash "0x407F8D034F70F0C2"
jhash (0x16F464B6)
arguments {
AnyPtr "arrayData" [=[ {} ]=],
float "valueX" [=[ {} ]=],
float "valueY" [=[ {} ]=],
float "valueZ" [=[ {} ]=],
}
alias "_ARRAY_VALUE_ADD_VECTOR3"
ns "DATAFILE"
returns "void"
doc [[!
]]
native "DATAARRAY_GET_BOOL"
hash "0x50C1B2874E50C114"
jhash (0xA2E5F921)
arguments {
AnyPtr "arrayData" [=[ {} ]=],
int "arrayIndex" [=[ {} ]=],
}
alias "_ARRAY_VALUE_GET_BOOLEAN"
ns "DATAFILE"
returns "BOOL"
doc [[!
]]
native "DATAARRAY_GET_COUNT"
hash "0x065DB281590CEA2D"
jhash (0xA8A21766)
arguments {
AnyPtr "arrayData" [=[ {} ]=],
}
alias "_ARRAY_VALUE_GET_SIZE"
ns "DATAFILE"
returns "int"
doc [[!
]]
native "DATAARRAY_GET_DICT"
hash "0x8B5FADCC4E3A145F"
jhash (0xECE81278)
arguments {
AnyPtr "arrayData" [=[ {} ]=],
int "arrayIndex" [=[ {} ]=],
}
alias "_ARRAY_VALUE_GET_OBJECT"
ns "DATAFILE"
returns "AnyPtr"
doc [[!
]]
native "DATAARRAY_GET_FLOAT"
hash "0xC0C527B525D7CFB5"
jhash (0x08AD2CC2)
arguments {
AnyPtr "arrayData" [=[ {} ]=],
int "arrayIndex" [=[ {} ]=],
}
alias "_ARRAY_VALUE_GET_FLOAT"
ns "DATAFILE"
returns "float"
doc [[!
]]
native "DATAARRAY_GET_INT"
hash "0x3E5AE19425CD74BE"
jhash (0xBB120CFC)
arguments {
AnyPtr "arrayData" [=[ {} ]=],
int "arrayIndex" [=[ {} ]=],
}
alias "_ARRAY_VALUE_GET_INTEGER"
ns "DATAFILE"
returns "int"
doc [[!
]]
native "DATAARRAY_GET_STRING"
hash "0xD3F2FFEB8D836F52"
jhash (0x93F985A6)
arguments {
AnyPtr "arrayData" [=[ {} ]=],
int "arrayIndex" [=[ {} ]=],
}
alias "_ARRAY_VALUE_GET_STRING"
ns "DATAFILE"
returns "charPtr"
doc [[!
]]
native "DATAARRAY_GET_TYPE"
hash "0x3A0014ADB172A3C5"
jhash (0xFA2402C8)
arguments {
AnyPtr "arrayData" [=[ {} ]=],
int "arrayIndex" [=[ {} ]=],
}
alias "_ARRAY_VALUE_GET_TYPE"
ns "DATAFILE"
returns "int"
doc [[!
```
Types:
1 = Boolean
2 = Integer
3 = Float
4 = String
5 = Vector3
6 = Object
7 = Array
```
]]
native "DATAARRAY_GET_VECTOR"
hash "0x8D2064E5B64A628A"
jhash (0x80E3DA55)
arguments {
AnyPtr "arrayData" [=[ {} ]=],
int "arrayIndex" [=[ {} ]=],
}
alias "_ARRAY_VALUE_GET_VECTOR3"
ns "DATAFILE"
returns "Vector3"
doc [[!
]]
native "DATADICT_CREATE_ARRAY"
hash "0x5B11728527CA6E5F"
jhash (0x03939B8D)
arguments {
AnyPtr "objectData" [=[ {} ]=],
charPtr "key" [=[ {} ]=],
}
alias "_OBJECT_VALUE_ADD_ARRAY"
ns "DATAFILE"
returns "AnyPtr"
doc [[!
]]
native "DATADICT_CREATE_DICT"
hash "0xA358F56F10732EE1"
jhash (0x96A8E05F)
arguments {
AnyPtr "objectData" [=[ {} ]=],
charPtr "key" [=[ {} ]=],
}
alias "_OBJECT_VALUE_ADD_OBJECT"
ns "DATAFILE"
returns "AnyPtr"
doc [[!
]]
native "DATADICT_GET_ARRAY"
hash "0x7A983AA9DA2659ED"
jhash (0x1F2F7D00)
arguments {
AnyPtr "objectData" [=[ {} ]=],
charPtr "key" [=[ {} ]=],
}
alias "_OBJECT_VALUE_GET_ARRAY"
ns "DATAFILE"
returns "AnyPtr"
doc [[!
]]
native "DATADICT_GET_BOOL"
hash "0x1186940ED72FFEEC"
jhash (0x8876C872)
arguments {
AnyPtr "objectData" [=[ {} ]=],
charPtr "key" [=[ {} ]=],
}
alias "_OBJECT_VALUE_GET_BOOLEAN"
ns "DATAFILE"
returns "BOOL"
doc [[!
]]
native "DATADICT_GET_DICT"
hash "0xB6B9DDC412FCEEE2"
jhash (0xC9C13D8D)
arguments {
AnyPtr "objectData" [=[ {} ]=],
charPtr "key" [=[ {} ]=],
}
alias "_OBJECT_VALUE_GET_OBJECT"
ns "DATAFILE"
returns "AnyPtr"
doc [[!
]]
native "DATADICT_GET_FLOAT"
hash "0x06610343E73B9727"
jhash (0xA92C1AF4)
arguments {
AnyPtr "objectData" [=[ {} ]=],
charPtr "key" [=[ {} ]=],
}
alias "_OBJECT_VALUE_GET_FLOAT"
ns "DATAFILE"
returns "float"
doc [[!
]]
native "DATADICT_GET_INT"
hash "0x78F06F6B1FB5A80C"
jhash (0xA6C68693)
arguments {
AnyPtr "objectData" [=[ {} ]=],
charPtr "key" [=[ {} ]=],
}
alias "_OBJECT_VALUE_GET_INTEGER"
ns "DATAFILE"
returns "int"
doc [[!
]]
native "DATADICT_GET_STRING"
hash "0x3D2FD9E763B24472"
jhash (0x942160EC)
arguments {
AnyPtr "objectData" [=[ {} ]=],
charPtr "key" [=[ {} ]=],
}
alias "_OBJECT_VALUE_GET_STRING"
ns "DATAFILE"
returns "charPtr"
doc [[!
]]
native "DATADICT_GET_TYPE"
hash "0x031C55ED33227371"
jhash (0x2678342A)
arguments {
AnyPtr "objectData" [=[ {} ]=],
charPtr "key" [=[ {} ]=],
}
alias "_OBJECT_VALUE_GET_TYPE"
ns "DATAFILE"
returns "int"
doc [[!
```
Types:
1 = Boolean
2 = Integer
3 = Float
4 = String
5 = Vector3
6 = Object
7 = Array
```
]]
native "DATADICT_GET_VECTOR"
hash "0x46CD3CB66E0825CC"
jhash (0xE84A127A)
arguments {
AnyPtr "objectData" [=[ {} ]=],
charPtr "key" [=[ {} ]=],
}
alias "_OBJECT_VALUE_GET_VECTOR3"
ns "DATAFILE"
returns "Vector3"
doc [[!
]]
native "DATADICT_SET_BOOL"
hash "0x35124302A556A325"
jhash (0x9B29D99B)
arguments {
AnyPtr "objectData" [=[ {} ]=],
charPtr "key" [=[ {} ]=],
BOOL "value" [=[ {} ]=],
}
alias "_OBJECT_VALUE_ADD_BOOLEAN"
ns "DATAFILE"
returns "void"
doc [[!
]]
native "DATADICT_SET_FLOAT"
hash "0xC27E1CC2D795105E"
jhash (0xE972CACF)
arguments {
AnyPtr "objectData" [=[ {} ]=],
charPtr "key" [=[ {} ]=],
float "value" [=[ {} ]=],
}
alias "_OBJECT_VALUE_ADD_FLOAT"
ns "DATAFILE"
returns "void"
doc [[!
]]
native "DATADICT_SET_INT"
hash "0xE7E035450A7948D5"
jhash (0xEFCF554A)
arguments {
AnyPtr "objectData" [=[ {} ]=],
charPtr "key" [=[ {} ]=],
int "value" [=[ {} ]=],
}
alias "_OBJECT_VALUE_ADD_INTEGER"
ns "DATAFILE"
returns "void"
doc [[!
]]
native "DATADICT_SET_STRING"
hash "0x8FF3847DADD8E30C"
jhash (0xD437615C)
arguments {
AnyPtr "objectData" [=[ {} ]=],
charPtr "key" [=[ {} ]=],
charPtr "value" [=[ {} ]=],
}
alias "_OBJECT_VALUE_ADD_STRING"
ns "DATAFILE"
returns "void"
doc [[!
]]
native "DATADICT_SET_VECTOR"
hash "0x4CD49B76338C7DEE"
jhash (0x75FC6C3C)
arguments {
AnyPtr "objectData" [=[ {} ]=],
charPtr "key" [=[ {} ]=],
float "valueX" [=[ {} ]=],
float "valueY" [=[ {} ]=],
float "valueZ" [=[ {} ]=],
}
alias "_OBJECT_VALUE_ADD_VECTOR3"
ns "DATAFILE"
returns "void"
doc [[!
]]
native "DATAFILE_CLEAR_WATCH_LIST"
hash "0x6CC86E78358D5119"
jhash (0x5B39D0AC)
alias "0x6CC86E78358D5119"
ns "DATAFILE"
returns "void"
doc [[!
]]
native "DATAFILE_CREATE"
hash "0xD27058A1CA2B13EE"
jhash (0x95F8A221)
ns "DATAFILE"
returns "void"
doc [[!
```
NativeDB Added Parameter 1: int p0
```
]]
native "DATAFILE_DELETE"
hash "0x9AB9C1CFC8862DFB"
jhash (0xDEF31B0A)
ns "DATAFILE"
returns "void"
doc [[!
```
NativeDB Added Parameter 1: int p0
```
]]
native "DATAFILE_DELETE_REQUESTED_FILE"
hash "0x8F5EA1C01D65A100"
jhash (0x9DB63CFF)
arguments {
Any "p0" [=[ {} ]=],
}
alias "0x8F5EA1C01D65A100"
ns "DATAFILE"
returns "BOOL"
doc [[!
]]
native "DATAFILE_FLUSH_MISSION_HEADER"
hash "0xC55854C7D7274882"
jhash (0xF11F956F)
alias "0xC55854C7D7274882"
ns "DATAFILE"
returns "void"
doc [[!
]]
native "DATAFILE_GET_FILE_DICT"
hash "0x906B778CA1DC72B6"
jhash (0x86DDF9C2)
alias "0x906B778CA1DC72B6"
ns "DATAFILE"
returns "charPtr"
doc [[!
```
NativeDB Added Parameter 1: int p0
```
]]
native "DATAFILE_HAS_LOADED_FILE_DATA"
hash "0x15FF52B809DB2353"
jhash (0x36FB8B3F)
arguments {
Any "p0" [=[ {} ]=],
}
alias "0x15FF52B809DB2353"
ns "DATAFILE"
returns "BOOL"
doc [[!
]]
native "DATAFILE_HAS_VALID_FILE_DATA"
hash "0xF8CC1EBE0B62E29F"
jhash (0x2A9411DA)
arguments {
Any "p0" [=[ {} ]=],
}
alias "0xF8CC1EBE0B62E29F"
ns "DATAFILE"
returns "BOOL"
doc [[!
]]
native "DATAFILE_IS_SAVE_PENDING"
hash "0xBEDB96A7584AA8CF"
jhash (0x5DCD0796)
alias "0xBEDB96A7584AA8CF"
ns "DATAFILE"
returns "BOOL"
doc [[!
```
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();
}
}
}
}
```
]]
native "DATAFILE_IS_VALID_REQUEST_ID"
hash "0xFCCAE5B92A830878"
jhash (0x01393D16)
arguments {
int "index" [=[ {} ]=],
}
alias "0xFCCAE5B92A830878"
ns "DATAFILE"
returns "BOOL"
doc [[!
]]
native "DATAFILE_LOAD_OFFLINE_UGC"
hash "0xC5238C011AF405E4"
jhash (0x660C468E)
arguments {
charPtr "filename" [=[ {} ]=],
}
alias "_LOAD_UGC_FILE"
ns "DATAFILE"
returns "BOOL"
doc [[!
```
Loads a User-Generated Content (UGC) file. These files can be found in "[GTA5]\data\ugc" and "[GTA5]\common\patch\ugc". They seem to follow a naming convention, most likely of "[name]_[part].ugc". See example below for usage.
Returns whether or not the file was successfully loaded.
Example:
DATAFILE::_LOAD_UGC_FILE("RockstarPlaylists") // loads "rockstarplaylists_00.ugc"
```
```
NativeDB Added Parameter 2: Any p1
```
]]
native "DATAFILE_SELECT_ACTIVE_FILE"
hash "0x22DA66936E0FFF37"
jhash (0xB41064A4)
arguments {
Any "p0" [=[ {} ]=],
}
alias "0x22DA66936E0FFF37"
ns "DATAFILE"
returns "BOOL"
doc [[!
```
NativeDB Added Parameter 2: Any p1
```
]]
native "DATAFILE_SELECT_CREATOR_STATS"
hash "0x01095C95CD46B624"
jhash (0xB8515B2F)
arguments {
int "p0" [=[ {} ]=],
}
alias "0x01095C95CD46B624"
ns "DATAFILE"
returns "BOOL"
doc [[!
```
NativeDB Added Parameter 2: Any p1
```
]]
native "DATAFILE_SELECT_UGC_DATA"
hash "0xA69AC4ADE82B57A4"
jhash (0xE8D56DA2)
arguments {
int "p0" [=[ {} ]=],
}
alias "0xA69AC4ADE82B57A4"
ns "DATAFILE"
returns "BOOL"
doc [[!
```
NativeDB Added Parameter 2: Any p1
```
]]
native "DATAFILE_SELECT_UGC_PLAYER_DATA"
hash "0x52818819057F2B40"
jhash (0xA4D1B30E)
arguments {
int "p0" [=[ {} ]=],
}
alias "0x52818819057F2B40"
ns "DATAFILE"
returns "BOOL"
doc [[!
```
NativeDB Added Parameter 2: Any p1
```
]]
native "DATAFILE_SELECT_UGC_STATS"
hash "0x9CB0BFA7A9342C3D"
jhash (0xCB6A351E)
arguments {
int "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
alias "0x9CB0BFA7A9342C3D"
ns "DATAFILE"
returns "BOOL"
doc [[!
```
NativeDB Added Parameter 3: Any p2
```
]]
native "DATAFILE_START_SAVE_TO_CLOUD"
hash "0x83BCCE3224735F05"
jhash (0x768CBB35)
arguments {
charPtr "filename" [=[ {} ]=],
}
alias "0x83BCCE3224735F05"
ns "DATAFILE"
returns "BOOL"
doc [[!
```
NativeDB Added Parameter 2: Any p1
```
]]
native "DATAFILE_STORE_MISSION_HEADER"
hash "0x2ED61456317B8178"
jhash (0x4E03F632)
alias "0x2ED61456317B8178"
ns "DATAFILE"
returns "void"
doc [[!
```
NativeDB Added Parameter 1: int p0
```
]]
native "DATAFILE_UPDATE_SAVE_TO_CLOUD"
hash "0x4DFDD9EB705F8140"
jhash (0x0B4087F7)
arguments {
BOOLPtr "p0" [=[ {} ]=],
}
alias "0x4DFDD9EB705F8140"
ns "DATAFILE"
returns "BOOL"
doc [[!
]]
native "DATAFILE_WATCH_REQUEST_ID"
hash "0xAD6875BBC0FC899C"
jhash (0x621388FF)
arguments {
int "id" [=[ {} ]=],
}
alias "0xAD6875BBC0FC899C"
ns "DATAFILE"
returns "void"
doc [[!
```
Adds the given request ID to the watch list.
```
]]
native "UGC_CREATE_CONTENT"
hash "0xC84527E235FCA219"
jhash (0xF09157B0)
arguments {
charPtr "data" [=[ {} ]=],
int "dataCount" [=[ {"cs_type":"BOOL"} ]=],
charPtr "contentName" [=[ {} ]=],
charPtr "description" [=[ {} ]=],
charPtr "tagsCsv" [=[ {} ]=],
charPtr "contentTypeName" [=[ {} ]=],
BOOL "publish" [=[ {} ]=],
}
alias "0xC84527E235FCA219"
ns "DATAFILE"
returns "BOOL"
doc [[!
```
NativeDB Added Parameter 8: Any p7
```
]]
native "UGC_CREATE_MISSION"
hash "0xA5EFC3E847D60507"
jhash (0xD96860FC)
arguments {
charPtr "contentName" [=[ {} ]=],
charPtr "description" [=[ {} ]=],
charPtr "tagsCsv" [=[ {} ]=],
charPtr "contentTypeName" [=[ {} ]=],
BOOL "publish" [=[ {} ]=],
}
alias "0xA5EFC3E847D60507"
ns "DATAFILE"
returns "BOOL"
doc [[!
```
NativeDB Added Parameter 6: Any p5
```
]]
native "UGC_SET_PLAYER_DATA"
hash "0x692D808C34A82143"
jhash (0xBB6321BD)
arguments {
charPtr "contentId" [=[ {} ]=],
float "rating" [=[ {} ]=],
charPtr "contentTypeName" [=[ {} ]=],
}
alias "0x692D808C34A82143"
ns "DATAFILE"
returns "BOOL"
doc [[!
```
NativeDB Added Parameter 4: Any p3
```
]]
native "UGC_UPDATE_CONTENT"
hash "0x648E7A5434AF7969"
jhash (0x459F2683)
arguments {
charPtr "contentId" [=[ {} ]=],
AnyPtr "data" [=[ {} ]=],
int "dataCount" [=[ {"cs_type":"BOOL"} ]=],
charPtr "contentName" [=[ {} ]=],
charPtr "description" [=[ {} ]=],
charPtr "tagsCsv" [=[ {} ]=],
charPtr "contentTypeName" [=[ {} ]=],
}
alias "0x648E7A5434AF7969"
ns "DATAFILE"
returns "BOOL"
doc [[!
```
NativeDB Added Parameter 8: Any p7
```
]]
native "UGC_UPDATE_MISSION"
hash "0x4645DE9980999E93"
jhash (0xDBB83E2B)
arguments {
charPtr "contentId" [=[ {} ]=],
charPtr "contentName" [=[ {} ]=],
charPtr "description" [=[ {} ]=],
charPtr "tagsCsv" [=[ {} ]=],
charPtr "contentTypeName" [=[ {} ]=],
}
alias "0x4645DE9980999E93"
ns "DATAFILE"
returns "BOOL"
doc [[!
```
NativeDB Added Parameter 6: Any p5
```
]]
native "0x6AD0BD5E087866CB"
hash "0x6AD0BD5E087866CB"
arguments {
Any "p0" [=[ {} ]=],
}
ns "DATAFILE"
returns "void"
doc [[!
```
NativeDB Introduced: v2189
```
]]
native "0xA6EEF01087181EDD"
hash "0xA6EEF01087181EDD"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "DATAFILE"
returns "Any"
doc [[!
```
NativeDB Introduced: v2189
```
]]
native "0xDBF860CF1DB8E599"
hash "0xDBF860CF1DB8E599"
arguments {
Any "p0" [=[ {} ]=],
}
ns "DATAFILE"
returns "Any"
doc [[!
```
NativeDB Introduced: v2189
```
]]
native "DECOR_EXIST_ON"
hash "0x05661B80A8C9165F"
jhash (0x74EF9C40)
arguments {
Entity "entity" [=[ {} ]=],
charPtr "propertyName" [=[ {} ]=],
}
ns "DECORATOR"
returns "BOOL"
doc [[!
```
Returns whether or not the specified property is set for the entity.
```
]]
native "DECOR_GET_BOOL"
hash "0xDACE671663F2F5DB"
jhash (0xDBCE51E0)
arguments {
Entity "entity" [=[ {} ]=],
charPtr "propertyName" [=[ {} ]=],
}
ns "DECORATOR"
returns "BOOL"
doc [[!
]]
native "DECOR_GET_FLOAT"
hash "0x6524A2F114706F43"
jhash (0x8DE5382F)
arguments {
Entity "entity" [=[ {} ]=],
charPtr "propertyName" [=[ {} ]=],
}
alias "_DECOR_GET_FLOAT"
ns "DECORATOR"
returns "float"
doc [[!
]]
native "DECOR_GET_INT"
hash "0xA06C969B02A97298"
jhash (0xDDDE59B5)
arguments {
Entity "entity" [=[ {} ]=],
charPtr "propertyName" [=[ {} ]=],
}
ns "DECORATOR"
returns "int"
doc [[!
]]
native "DECOR_IS_REGISTERED_AS_TYPE"
hash "0x4F14F9F870D6FBC8"
jhash (0x7CF0971D)
arguments {
charPtr "propertyName" [=[ {} ]=],
int "type" [=[ {} ]=],
}
ns "DECORATOR"
returns "BOOL"
doc [[!
See [`DECOR_REGISTER`](#\_0x9FD90732F56403CE).
]]
native "DECOR_REGISTER"
hash "0x9FD90732F56403CE"
jhash (0x68BD42A9)
arguments {
charPtr "propertyName" [=[ {} ]=],
int "type" [=[ {} ]=],
}
ns "DECORATOR"
returns "void"
doc [[!
```cpp
enum eDecorType
{
DECOR_TYPE_FLOAT = 1,
DECOR_TYPE_BOOL = 2,
DECOR_TYPE_INT = 3,
DECOR_TYPE_STRING = 4,
DECOR_TYPE_TIME = 5
};
```
]]
native "DECOR_REGISTER_LOCK"
hash "0xA9D14EEA259F9248"
jhash (0x7F3F1C02)
ns "DECORATOR"
returns "void"
doc [[!
```
Called after all decorator type initializations.
```
]]
native "DECOR_REMOVE"
hash "0x00EE9F297C738720"
jhash (0xE0E2640B)
arguments {
Entity "entity" [=[ {} ]=],
charPtr "propertyName" [=[ {} ]=],
}
ns "DECORATOR"
returns "BOOL"
doc [[!
]]
native "DECOR_SET_BOOL"
hash "0x6B1E8E2ED1335B71"
jhash (0x8E101F5C)
arguments {
Entity "entity" [=[ {} ]=],
charPtr "propertyName" [=[ {} ]=],
BOOL "value" [=[ {} ]=],
}
ns "DECORATOR"
returns "BOOL"
doc [[!
```
This function sets metadata of type bool to specified entity.
```
]]
native "DECOR_SET_FLOAT"
hash "0x211AB1DD8D0F363A"
jhash (0xBC7BD5CB)
arguments {
Entity "entity" [=[ {} ]=],
charPtr "propertyName" [=[ {} ]=],
float "value" [=[ {} ]=],
}
alias "_DECOR_SET_FLOAT"
ns "DECORATOR"
returns "BOOL"
doc [[!
]]
native "DECOR_SET_INT"
hash "0x0CE3AA5E1CA19E10"
jhash (0xDB718B21)
arguments {
Entity "entity" [=[ {} ]=],
charPtr "propertyName" [=[ {} ]=],
int "value" [=[ {} ]=],
}
ns "DECORATOR"
returns "BOOL"
doc [[!
```
Sets property to int.
```
]]
native "DECOR_SET_TIME"
hash "0x95AED7B8E39ECAA4"
jhash (0xBBAEEF94)
arguments {
Entity "entity" [=[ {} ]=],
charPtr "propertyName" [=[ {} ]=],
int "timestamp" [=[ {} ]=],
}
ns "DECORATOR"
returns "BOOL"
doc [[!
]]
native "GET_IS_LOADING_SCREEN_ACTIVE"
hash "0x10D0A8F259E93EC9"
jhash (0x517B601B)
ns "DLC"
returns "BOOL"
doc [[!
]]
native "HAS_CLOUD_REQUESTS_FINISHED"
hash "0x46E2B844905BC5F0"
jhash (0x6087C10C)
arguments {
BOOLPtr "variable" [=[ {"cs_type":"AnyPtr"} ]=],
Any "unused" [=[ {} ]=],
}
alias "_NULLIFY"
ns "DLC"
returns "BOOL"
doc [[!
```
Sets the value of the specified variable to 0.
Always returns true.
```
]]
native "IS_DLC_PRESENT"
hash "0x812595A0644CE1DE"
jhash (0x1F321943)
arguments {
Hash "dlcHash" [=[ {} ]=],
}
ns "DLC"
returns "BOOL"
doc [[!
```
Example:
DLC::IS_DLC_PRESENT($\mpbusiness2\);
($ = gethashkey)
bruteforce these:
0xB119F6D
0x96F02EE6
```
]]
native "ON_ENTER_MP"
hash "0x0888C3502DBBEEF5"
jhash (0xC65586A9)
alias "_LOAD_MP_DLC_MAPS"
ns "DLC"
returns "void"
doc [[!
```
This loads the GTA:O dlc map parts (high end garages, apartments).
Works in singleplayer.
In order to use GTA:O heist IPL's you have to call this native with the following params: SET_INSTANCE_PRIORITY_MODE(1);
```
]]
native "ON_ENTER_SP"
hash "0xD7C10C4A637992C9"
jhash (0x8BF60FC3)
alias "0xD7C10C4A637992C9"
alias "_LOAD_SP_DLC_MAPS"
ns "DLC"
returns "void"
doc [[!
```
Unloads GROUP_MAP (GTAO/MP) DLC data and loads GROUP_MAP_SP DLC. Neither are loaded by default, 0888C3502DBBEEF5 is a cognate to this function and loads MP DLC (and unloads SP DLC by extension).
The original (and wrong) definition is below:
This unload the GTA:O DLC map parts (like high end garages/apartments).
Works in singleplayer.
```
]]
native "_GET_EXTRA_CONTENT_PACK_HAS_BEEN_INSTALLED"
hash "0x8D30F648014A92B5"
jhash (0xF69B729C)
alias "0x8D30F648014A92B5"
ns "DLC"
returns "BOOL"
doc [[!
]]
native "0x241FCA5B1AA14F75"
hash "0x241FCA5B1AA14F75"
jhash (0x0AF83036)
ns "DLC"
returns "BOOL"
doc [[!
```
Only used once in scripts, in maintransition.
maintransition.c4, line ~82432:
if (PED::_7350823473013C02(PLAYER::PLAYER_PED_ID()) && (DECORATOR::_241FCA5B1AA14F75() == 0)) {
g_2542A5 = a_1; // 'g_2542A5' used in 'building_controller.ysc' for IPL stuff?
return 1;
}
Likely used solely for the players ped. The function it's in seems to only be used for initialization/quitting. Called among natives to discard scaleforms, disable frontend, fading in/out, etc. Neighboring strings to some calls include "HUD_JOINING", "HUD_QUITTING".
Most likely ARE_*
```
]]
native "0x9489659372A81585"
hash "0x9489659372A81585"
jhash (0xC2169164)
ns "DLC"
returns "BOOL"
doc [[!
Hard-coded to always return 0.
]]
native "0xA213B11DFF526300"
hash "0xA213B11DFF526300"
jhash (0xF79A97F5)
ns "DLC"
returns "BOOL"
doc [[!
Hard-coded to always return 1.
]]
native "0xC4637A6D03C24CC3"
hash "0xC4637A6D03C24CC3"
ns "DLC"
returns "BOOL"
doc [[!
GET_IS_LOADING_\*
```
NativeDB Introduced: v1734
```
]]
native "0xF2E07819EF1A5289"
hash "0xF2E07819EF1A5289"
jhash (0x881B1FDB)
ns "DLC"
returns "BOOL"
doc [[!
Hard-coded to always return 1.
]]
native "ADD_SHOCKING_EVENT_AT_POSITION"
hash "0xD9F8455409B525E9"
jhash (0x0B30F779)
arguments {
int "eventType" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "duration" [=[ {} ]=],
}
ns "EVENT"
returns "ScrHandle"
doc [[!
```
eventType: https://alloc8or.re/gta5/doc/enums/eEventType.txt
```
]]
native "ADD_SHOCKING_EVENT_FOR_ENTITY"
hash "0x7FD8F3BE76F89422"
jhash (0xA81B5B71)
arguments {
int "eventType" [=[ {} ]=],
Entity "entity" [=[ {} ]=],
float "duration" [=[ {} ]=],
}
ns "EVENT"
returns "ScrHandle"
doc [[!
```
eventType: https://alloc8or.re/gta5/doc/enums/eEventType.txt
```
]]
native "BLOCK_DECISION_MAKER_EVENT"
hash "0xE42FCDFD0E4196F7"
jhash (0x57506EA6)
arguments {
Hash "name" [=[ {} ]=],
int "eventType" [=[ {} ]=],
}
ns "EVENT"
returns "void"
doc [[!
```
eventType: https://alloc8or.re/gta5/doc/enums/eEventType.txt
This is limited to 4 blocked events at a time.
```
]]
native "CLEAR_DECISION_MAKER_EVENT_RESPONSE"
hash "0x4FC9381A7AEE8968"
jhash (0x07ABD94D)
arguments {
Hash "name" [=[ {} ]=],
int "eventType" [=[ {} ]=],
}
ns "EVENT"
returns "void"
doc [[!
```
eventType: https://alloc8or.re/gta5/doc/enums/eEventType.txt
```
]]
native "IS_SHOCKING_EVENT_IN_SPHERE"
hash "0x1374ABB7C15BAB92"
jhash (0x2F98823E)
arguments {
int "eventType" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "radius" [=[ {} ]=],
}
ns "EVENT"
returns "BOOL"
doc [[!
```
eventType: https://alloc8or.re/gta5/doc/enums/eEventType.txt
```
]]
native "REMOVE_ALL_SHOCKING_EVENTS"
hash "0xEAABE8FDFA21274C"
jhash (0x64DF6282)
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "EVENT"
returns "void"
doc [[!
]]
native "REMOVE_SHOCKING_EVENT"
hash "0x2CDA538C44C6CCE5"
jhash (0xF82D5A87)
arguments {
ScrHandle "event" [=[ {} ]=],
}
ns "EVENT"
returns "BOOL"
doc [[!
]]
native "REMOVE_SHOCKING_EVENT_SPAWN_BLOCKING_AREAS"
hash "0x340F1415B68AEADE"
jhash (0xA0CE89C8)
ns "EVENT"
returns "void"
doc [[!
]]
native "SET_DECISION_MAKER"
hash "0xB604A2942ADED0EE"
jhash (0x19CEAC9E)
arguments {
Ped "ped" [=[ {} ]=],
Hash "name" [=[ {} ]=],
}
ns "EVENT"
returns "void"
doc [[!
]]
native "SUPPRESS_AGITATION_EVENTS_NEXT_FRAME"
hash "0x5F3B7749C112D552"
jhash (0x80340396)
ns "EVENT"
returns "void"
doc [[!
]]
native "SUPPRESS_SHOCKING_EVENT_TYPE_NEXT_FRAME"
hash "0x3FD2EC8BF1F1CF30"
jhash (0xA0FDCB82)
arguments {
int "eventType" [=[ {} ]=],
}
ns "EVENT"
returns "void"
doc [[!
```
eventType: https://alloc8or.re/gta5/doc/enums/eEventType.txt
```
]]
native "SUPPRESS_SHOCKING_EVENTS_NEXT_FRAME"
hash "0x2F9A292AD0A3BD89"
jhash (0x4CC674B5)
ns "EVENT"
returns "void"
doc [[!
]]
native "UNBLOCK_DECISION_MAKER_EVENT"
hash "0xD7CD9CF34F2C99E8"
jhash (0x62A3161D)
arguments {
Hash "name" [=[ {} ]=],
int "eventType" [=[ {} ]=],
}
ns "EVENT"
returns "void"
doc [[!
```
eventType: https://alloc8or.re/gta5/doc/enums/eEventType.txt
```
]]
native "APPLY_FORCE_TO_ENTITY"
hash "0xC5F68BE9613E2D18"
jhash (0xC1C0855A)
arguments {
Entity "entity" [=[ {} ]=],
int "forceType" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "offX" [=[ {} ]=],
float "offY" [=[ {} ]=],
float "offZ" [=[ {} ]=],
int "nComponent" [=[ {} ]=],
BOOL "bLocalForce" [=[ {} ]=],
BOOL "bLocalOffset" [=[ {} ]=],
BOOL "bScaleByMass" [=[ {} ]=],
BOOL "bPlayAudio" [=[ {} ]=],
BOOL "bScaleByTimeWarp" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
```cpp
enum eApplyForceTypes {
APPLY_TYPE_FORCE = 0,
APPLY_TYPE_IMPULSE = 1,
APPLY_TYPE_EXTERNAL_FORCE = 2,
APPLY_TYPE_EXTERNAL_IMPULSE = 3,
APPLY_TYPE_TORQUE = 4,
APPLY_TYPE_ANGULAR_IMPULSE = 5
}
```
The entity handle
The force type
The x component of the force to apply
The y component of the force to apply
The z component of the force to apply
Offset from center of entity (X)
Offset from center of entity (Y)
Offset from center of entity (Z)
Component of the entity to apply the force too. Only matters for breakable or articulated (ragdoll) physics. 0 means the root or parent component
Specifies whether the force vector passed in is in local or world coordinates. `true` means the force will get automatically transformed into world space before being applied
Specifies whether the offset passed in is in local or world coordinates
Specifies whether to scale the force by mass
Specifies whether to play audio events related to the force being applied. The audio will depend on the entity type. Currently vehicles are the only entity types supported, and will play a suspension squeal depending on the magnitude of the force
Specifies whether to scale the force by time warp. Default is `true`
]]
native "APPLY_FORCE_TO_ENTITY_CENTER_OF_MASS"
hash "0x18FF00FC7EFF559E"
jhash (0x28924E98)
arguments {
Entity "entity" [=[ {} ]=],
int "forceType" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
int "nComponent" [=[ {"cs_type":"BOOL"} ]=],
BOOL "bLocalForce" [=[ {} ]=],
BOOL "bScaleByMass" [=[ {} ]=],
BOOL "bApplyToChildren" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
Apply a force to an entities center of mass.
The entity handle
The force type, see [`APPLY_FORCE_TO_ENTITY`](#\_0xC5F68BE9613E2D18)
The x component of the force to apply
The y component of the force to apply
The z component of the force to apply
Component of the entity to apply the force too. Only matters for breakable or articulated (ragdoll) physics. 0 means the root or parent component
Specifies whether the force vector passed in is in local or world coordinates. `true` means the force will get automatically transformed into world space before being applied
Specifies whether to scale the force by mass
Default `false`. If the force should be applied to any attached children
]]
native "ATTACH_ENTITY_TO_ENTITY"
hash "0x6B9BBD38AB0796DF"
jhash (0xEC024237)
arguments {
Entity "entity1" [=[ {} ]=],
Entity "entity2" [=[ {} ]=],
int "boneIndex" [=[ {} ]=],
float "xPos" [=[ {} ]=],
float "yPos" [=[ {} ]=],
float "zPos" [=[ {} ]=],
float "xRot" [=[ {} ]=],
float "yRot" [=[ {} ]=],
float "zRot" [=[ {} ]=],
BOOL "p9" [=[ {} ]=],
BOOL "useSoftPinning" [=[ {} ]=],
BOOL "collision" [=[ {} ]=],
BOOL "isPed" [=[ {} ]=],
int "rotationOrder" [=[ {} ]=],
BOOL "syncRot" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
Attach an entity to the specified entity.
Entity to attach.
Entity to attach `entity1` with.
This is different to boneID, use ['GET_PED_BONE_INDEX'](#\_0x3F428D08BE5AAE31) to get the index from the ID. use the index for attaching to specific bones. `entity1` will be attached to the center of `entity2` if bone index given doesn't correspond to bone indexes for that entity type.
X-axis offset from the center of `entity2`.
Y-axis offset from the center of `entity2`.
Z-axis offset from the center of `entity2`.
X-axis rotation.
Y-axis rotation.
Z-axis rotation.
Unknown. Does not seem to have any effect.
If set to false attached entity will not detach when fixed.
Controls collision between the two entities (FALSE disables collision).
Pitch doesnt work when false and roll will only work on negative numbers (only peds)
The order in which the rotation is applied. See [`GET_ENTITY_ROTATION`](#\_0xAFBD61CC738D9EB9)
If false it ignores entity rotation.
]]
native "ATTACH_ENTITY_TO_ENTITY_PHYSICALLY"
hash "0xC3675780C92F90F9"
jhash (0x0547417F)
arguments {
Entity "entity1" [=[ {} ]=],
Entity "entity2" [=[ {} ]=],
int "boneIndex1" [=[ {} ]=],
int "boneIndex2" [=[ {} ]=],
float "xPos1" [=[ {} ]=],
float "yPos1" [=[ {} ]=],
float "zPos1" [=[ {} ]=],
float "xPos2" [=[ {} ]=],
float "yPos2" [=[ {} ]=],
float "zPos2" [=[ {} ]=],
float "xRot" [=[ {} ]=],
float "yRot" [=[ {} ]=],
float "zRot" [=[ {} ]=],
float "breakForce" [=[ {} ]=],
BOOL "fixedRot" [=[ {} ]=],
BOOL "p15" [=[ {} ]=],
BOOL "collision" [=[ {} ]=],
BOOL "teleport" [=[ {} ]=],
int "p18" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
```
breakForce is the amount of force required to break the bond.
p14 - is always 1 in scripts
p15 - is 1 or 0 in scripts - unknown what it does
p16 - controls collision between the two entities (FALSE disables collision).
p17 - do not teleport entity to be attached to the position of the bone Index of the target entity (if 1, entity will not be teleported to target bone)
p18 - is always 2 in scripts.
```
]]
native "CLEAR_ENTITY_LAST_DAMAGE_ENTITY"
hash "0xA72CD9CA74A5ECBA"
jhash (0x2B83F43B)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
annotations [=[ {"cs_type":"Any"} ]=]
returns "void"
doc [[!
This native **could affect** the arguments of the `CEventNetworkEntityDamage` game event, by clearing the damaging entity before the event is fired.
The entity to clear the last damaging entity from.
]]
native "CREATE_FORCED_OBJECT"
hash "0x150E808B375A385A"
jhash (0x335190A2)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Hash "modelHash" [=[ {} ]=],
BOOL "p5" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
]]
native "CREATE_MODEL_HIDE"
hash "0x8A97BCA30A0CE478"
jhash (0x7BD5CF2F)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "radius" [=[ {} ]=],
Hash "model" [=[ {} ]=],
BOOL "surviveMapReload" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
Hides all objects of the specified model intersecting a sphere centered at (x, y, z) with the given radius.
Network players do not see changes done with this.
Use [`CREATE_MODEL_HIDE_EXCLUDING_SCRIPT_OBJECTS`](#\_0x3A52AE588830BF7F) if you only want to hide map objects and exclude those created by scripts.
Use [`REMOVE_MODEL_HIDE`](#\_0xD9E3006FB3CBD765) to make hidden objects visible again.
X Coordinate of the hiding sphere center.
Y Coordinate of the hiding sphere center.
Z Coordinate of the hiding sphere center.
Radius of the hiding sphere.
The object's model hash to hide.
If false, only currently loaded objects are hidden. If their map unloads (e.g. by moving away) and reloads, the objects will reappear.
]]
native "CREATE_MODEL_HIDE_EXCLUDING_SCRIPT_OBJECTS"
hash "0x3A52AE588830BF7F"
jhash (0x07AAF22C)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "radius" [=[ {} ]=],
Hash "model" [=[ {} ]=],
BOOL "surviveMapReload" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
Hides all objects of the specified model intersecting a sphere centered at (x, y, z) with the given radius, excluding objects created by scripts.
Network players do not see changes done with this.
Use [`REMOVE_MODEL_HIDE`](#\_0xD9E3006FB3CBD765) to make hidden objects visible again.
X Coordinate of the hiding sphere center.
Y Coordinate of the hiding sphere center.
Z Coordinate of the hiding sphere center.
Radius of the hiding sphere.
The object's model hash to hide.
If false, only currently loaded objects are hidden. If their map unloads (e.g. by moving away) and reloads, the objects will reappear.
]]
native "CREATE_MODEL_SWAP"
hash "0x92C47782FDA8B2A3"
jhash (0x0BC12F9E)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "radius" [=[ {} ]=],
Hash "originalModel" [=[ {} ]=],
Hash "newModel" [=[ {} ]=],
BOOL "bSurviveMapReload" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
```
Only works with objects!
Network players do not see changes done with this.
```
]]
native "DELETE_ENTITY"
hash "0xAE3CBE5BF394C9C9"
jhash (0xFAA3D236)
arguments {
EntityPtr "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
Delete the specified entity, and invalidate the passed handle (i.e., the in/out argument).
You might want to check if the entity exists before with [DOES_ENTITY_EXIST](#\_0x7239B21A38F536BA).
The entity to delete.
]]
native "DETACH_ENTITY"
hash "0x961AC54BF0613F5D"
jhash (0xC8EFCB41)
arguments {
Entity "entity" [=[ {} ]=],
BOOL "dynamic" [=[ {} ]=],
BOOL "collision" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
Set to `true` to keep velocity after detaching
]]
native "DOES_ENTITY_BELONG_TO_THIS_SCRIPT"
hash "0xDDE6DF5AE89981D2"
jhash (0xACFEB3F9)
arguments {
Entity "entity" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
]]
native "DOES_ENTITY_EXIST"
hash "0x7239B21A38F536BA"
jhash (0x3AC90869)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
Checks whether an entity exists in the game world.
The entity to check if it exists.
Whether the entity exists or not.
]]
native "DOES_ENTITY_HAVE_DRAWABLE"
hash "0x060D6E96F8B8E48D"
jhash (0xA5B33300)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
]]
native "DOES_ENTITY_HAVE_PHYSICS"
hash "0xDA95EA3317CC5064"
jhash (0x9BCD2979)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
]]
native "FIND_ANIM_EVENT_PHASE"
hash "0x07F1BE2BCCAA27A7"
jhash (0xC41DDA62)
arguments {
charPtr "animDictionary" [=[ {} ]=],
charPtr "animName" [=[ {} ]=],
charPtr "p2" [=[ {} ]=],
AnyPtr "p3" [=[ {} ]=],
AnyPtr "p4" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
```
In the script "player_scene_t_bbfight.c4":
"if (ENTITY::FIND_ANIM_EVENT_PHASE(&l_16E, &l_19F[v_4/*16*/], v_9, &v_A, &v_B))"
-- &l_16E (p0) is requested as an anim dictionary earlier in the script.
-- &l_19F[v_4/*16*/] (p1) is used in other natives in the script as the "animation" param.
-- v_9 (p2) is instantiated as "victim_fall"; I'm guessing that's another anim
--v_A and v_B (p3 & p4) are both set as -1.0, but v_A is used immediately after this native for:
"if (v_A < ENTITY::GET_ENTITY_ANIM_CURRENT_TIME(...))"
Both v_A and v_B are seemingly used to contain both Vector3's and floats, so I can't say what either really is other than that they are both output parameters. p4 looks more like a *Vector3 though
-alphazolam
```
[Animations list](https://alexguirre.github.io/animations-list/)
]]
native "FORCE_ENTITY_AI_AND_ANIMATION_UPDATE"
hash "0x40FDEDB72F8293B2"
jhash (0x58D9775F)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
```
Based on carmod_shop script decompile this takes a vehicle parameter. It is called when repair is done on initial enter.
```
]]
native "FREEZE_ENTITY_POSITION"
hash "0x428CA6DBD1094446"
jhash (0x65C16D57)
arguments {
Entity "entity" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
Freezes or unfreezes an entity preventing its coordinates to change by the player if set to `true`. You can still change the entity position using [`SET_ENTITY_COORDS`](#\_0x06843DA7060A026B).
The entity to freeze/unfreeze.
Freeze or unfreeze entity.
]]
native "GET_ANIM_DURATION"
hash "0xFEDDF04D62B8D790"
jhash (0x8B5E3E3D)
arguments {
charPtr "animDict" [=[ {} ]=],
charPtr "animName" [=[ {} ]=],
}
alias "_GET_ANIM_DURATION"
ns "ENTITY"
returns "float"
doc [[!
[Animations list](https://alexguirre.github.io/animations-list/)
]]
native "GET_COLLISION_NORMAL_OF_LAST_HIT_FOR_ENTITY"
hash "0xE465D4AB7CA6AE72"
jhash (0xAB415C07)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "Vector3"
doc [[!
]]
native "GET_ENTITY_ALPHA"
hash "0x5A47B3B5E63E94C6"
jhash (0x1560B017)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "int"
doc [[!
]]
native "GET_ENTITY_ANIM_CURRENT_TIME"
hash "0x346D81500D088F42"
jhash (0x83943F41)
arguments {
Entity "entity" [=[ {} ]=],
charPtr "animDict" [=[ {} ]=],
charPtr "animName" [=[ {} ]=],
}
ns "ENTITY"
returns "float"
doc [[!
```
Returns a float value representing animation's current playtime with respect to its total playtime. This value increasing in a range from [0 to 1] and wrap back to 0 when it reach 1.
Example:
0.000000 - mark the starting of animation.
0.500000 - mark the midpoint of the animation.
1.000000 - mark the end of animation.
```
[Animations list](https://alexguirre.github.io/animations-list/)
]]
native "GET_ENTITY_ANIM_TOTAL_TIME"
hash "0x50BD2730B191E360"
jhash (0x433A9D18)
arguments {
Entity "entity" [=[ {} ]=],
charPtr "animDict" [=[ {} ]=],
charPtr "animName" [=[ {} ]=],
}
ns "ENTITY"
returns "float"
doc [[!
```
Returns a float value representing animation's total playtime in milliseconds.
Example:
GET_ENTITY_ANIM_TOTAL_TIME(PLAYER_ID(),"amb@world_human_yoga@female@base","base_b")
return 20800.000000
```
[Animations list](https://alexguirre.github.io/animations-list/)
]]
native "GET_ENTITY_ATTACHED_TO"
hash "0x48C2BED9180FE123"
jhash (0xFE1589F9)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "Entity"
doc [[!
]]
native "GET_ENTITY_BONE_INDEX_BY_NAME"
hash "0xFB71170B7E76ACBA"
jhash (0xE4ECAC22)
arguments {
Entity "entity" [=[ {} ]=],
charPtr "boneName" [=[ {} ]=],
}
ns "ENTITY"
returns "int"
doc [[!
```
Returns the index of the bone. If the bone was not found, -1 will be returned.
list:
pastebin.com/D7JMnX1g
BoneNames:
chassis,
windscreen,
seat_pside_r,
seat_dside_r,
bodyshell,
suspension_lm,
suspension_lr,
platelight,
attach_female,
attach_male,
bonnet,
boot,
chassis_dummy, //Center of the dummy
chassis_Control, //Not found yet
door_dside_f, //Door left, front
door_dside_r, //Door left, back
door_pside_f, //Door right, front
door_pside_r, //Door right, back
Gun_GripR,
windscreen_f,
platelight, //Position where the light above the numberplate is located
VFX_Emitter,
window_lf, //Window left, front
window_lr, //Window left, back
window_rf, //Window right, front
window_rr, //Window right, back
engine, //Position of the engine
gun_ammo,
ROPE_ATTATCH, //Not misspelled. In script "finale_heist2b.c4".
wheel_lf, //Wheel left, front
wheel_lr, //Wheel left, back
wheel_rf, //Wheel right, front
wheel_rr, //Wheel right, back
exhaust, //Exhaust. shows only the position of the stock-exhaust
overheat, //A position on the engine(not exactly sure, how to name it)
misc_e, //Not a car-bone.
seat_dside_f, //Driver-seat
seat_pside_f, //Seat next to driver
Gun_Nuzzle,
seat_r
I doubt that the function is case-sensitive, since I found a "Chassis" and a "chassis". - Just tested: Definitely not case-sensitive.
```
]]
native "GET_ENTITY_CAN_BE_DAMAGED"
hash "0xD95CC5D2AB15A09F"
jhash (0xE4938B5D)
arguments {
Entity "entity" [=[ {} ]=],
}
alias "0xD95CC5D2AB15A09F"
ns "ENTITY"
returns "BOOL"
doc [[!
]]
native "GET_ENTITY_COLLISION_DISABLED"
hash "0xCCF1E97BEFDAE480"
jhash (0xE8C0C629)
arguments {
Entity "entity" [=[ {} ]=],
}
alias "0xCCF1E97BEFDAE480"
alias "_GET_ENTITY_COLLISON_DISABLED"
ns "ENTITY"
returns "BOOL"
doc [[!
]]
native "GET_ENTITY_COORDS"
hash "0x3FEF770D40960D5A"
jhash (0x1647F1CB)
arguments {
Entity "entity" [=[ {} ]=],
BOOL "alive" [=[ {} ]=],
}
ns "ENTITY"
apiset "client"
returns "Vector3"
doc [[!
Gets the current coordinates (world position) for a specified entity.
The entity to get the coordinates from.
Unused by the game, potentially used by debug builds of GTA in order to assert whether or not an entity was alive.
The current entity coordinates.
]]
native "GET_ENTITY_FORWARD_VECTOR"
hash "0x0A794A5A57F8DF91"
jhash (0x84DCECBF)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "Vector3"
doc [[!
```
Gets the entity's forward vector.
```
The entity to get the forward vector for.
The forward vector.
]]
native "GET_ENTITY_FORWARD_X"
hash "0x8BB4EF4214E0E6D5"
jhash (0x49FAE914)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "float"
doc [[!
```
Gets the X-component of the entity's forward vector.
```
]]
native "GET_ENTITY_FORWARD_Y"
hash "0x866A4A5FAE349510"
jhash (0x9E2F917C)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "float"
doc [[!
```
Gets the Y-component of the entity's forward vector.
```
]]
native "GET_ENTITY_HEADING"
hash "0xE83D4F9BA2A38914"
jhash (0x972CC383)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "float"
doc [[!
```
Returns the heading of the entity in degrees. Also know as the "Yaw" of an entity.
```
The entity to get the heading from.
The current entity heading.
]]
native "GET_ENTITY_HEADING_FROM_EULERS"
hash "0x846BF6291198A71E"
jhash (0x9320E642)
arguments {
Entity "entity" [=[ {} ]=],
}
alias "0x846BF6291198A71E"
alias "_GET_ENTITY_PHYSICS_HEADING"
ns "ENTITY"
returns "float"
doc [[!
Gets the heading of the entity physics in degrees, which tends to be more accurate than just [`GET_ENTITY_HEADING`](#\_0xE83D4F9BA2A38914). This can be clearly seen while, for example, ragdolling a ped/player.
The entity to get the heading from.
Returns a float representing the entity's heading from eulers.
]]
native "GET_ENTITY_HEALTH"
hash "0xEEF059FAD016D209"
jhash (0x8E3222B7)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "int"
doc [[!
```
Returns an integer value of entity's current health.
Example of range for ped:
- Player [0 to 200]
- Ped [100 to 200]
- Vehicle [0 to 1000]
- Object [0 to 1000]
Health is actually a float value but this native casts it to int.
In order to get the actual value, do:
float health = *(float *)(entityAddress + 0x280);
```
The entity to get the health from.
The current entity health.
]]
native "GET_ENTITY_HEIGHT"
hash "0x5A504562485944DD"
jhash (0xEE443481)
arguments {
Entity "entity" [=[ {} ]=],
float "X" [=[ {} ]=],
float "Y" [=[ {} ]=],
float "Z" [=[ {} ]=],
BOOL "atTop" [=[ {} ]=],
BOOL "inWorldCoords" [=[ {} ]=],
}
ns "ENTITY"
returns "float"
doc [[!
]]
native "GET_ENTITY_HEIGHT_ABOVE_GROUND"
hash "0x1DD55701034110E5"
jhash (0x57F56A4D)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "float"
doc [[!
```
Return height (z-dimension) above ground.
Example: The pilot in a titan plane is 1.844176 above ground.
How can i convert it to meters?
Everything seems to be in meters, probably this too.
```
]]
native "GET_ENTITY_LOD_DIST"
hash "0x4159C2762B5791D6"
jhash (0x4DA3D51F)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "int"
doc [[!
```
Returns the LOD distance of an entity.
```
]]
native "GET_ENTITY_MATRIX"
hash "0xECB2FC7235A7D137"
jhash (0xEB9EB001)
arguments {
Entity "entity" [=[ {} ]=],
Vector3Ptr "forwardVector" [=[ {} ]=],
Vector3Ptr "rightVector" [=[ {} ]=],
Vector3Ptr "upVector" [=[ {} ]=],
Vector3Ptr "position" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
]]
native "GET_ENTITY_MAX_HEALTH"
hash "0x15D757606D170C3C"
jhash (0xC7AE6AA1)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "int"
doc [[!
```
Return an integer value of entity's maximum health.
Example:
- Player = 200
```
]]
native "GET_ENTITY_MODEL"
hash "0x9F47B058362C84B5"
jhash (0xDAFCB3EC)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "Hash"
doc [[!
Returns the model hash from an entity.
The entity to get the model for.
The model hash of the entity.
]]
native "GET_ENTITY_PITCH"
hash "0xD45DC2893621E1FE"
jhash (0xFCE6ECE5)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "float"
doc [[!
]]
native "GET_ENTITY_POPULATION_TYPE"
hash "0xF6F5161F4534EDFF"
jhash (0xFC30DDFF)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "int"
doc [[!
A population type, from the following enum: https://alloc8or.re/gta5/doc/enums/ePopulationType.txt
The entity to obtain the population type from.
A population type, from the enumeration above.
]]
native "GET_ENTITY_QUATERNION"
hash "0x7B3703D2D32DFA18"
jhash (0x5154EC90)
arguments {
Entity "entity" [=[ {} ]=],
floatPtr "x" [=[ {} ]=],
floatPtr "y" [=[ {} ]=],
floatPtr "z" [=[ {} ]=],
floatPtr "w" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
```
w is the correct parameter name!
```
]]
native "GET_ENTITY_ROLL"
hash "0x831E0242595560DF"
jhash (0x36610842)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "float"
doc [[!
```
Displays the current ROLL axis of the entity [-180.0000/180.0000+]
(Sideways Roll) such as a vehicle tipped on its side
```
]]
native "GET_ENTITY_ROTATION"
hash "0xAFBD61CC738D9EB9"
jhash (0x8FF45B04)
arguments {
Entity "entity" [=[ {} ]=],
int "rotationOrder" [=[ {} ]=],
}
ns "ENTITY"
returns "Vector3"
doc [[!
**NOTE**: What you use for rotationOrder when getting must be the same as rotationOrder when setting the rotation.
```cpp
enum eRotationOrder {
// Rotate around the z-axis, then the y-axis and finally the x-axis.
ROT_ZYX = 0,
// Rotate around the y-axis, then the z-axis and finally the x-axis.
ROT_YZX = 1,
// Rotate around the z-axis, then the x-axis and finally the y-axis.
ROT_ZXY = 2,
// Rotate around the x-axis, then the z-axis and finally the y-axis.
ROT_XZY = 3,
// Rotate around the y-axis, then the x-axis and finally the z-axis.
ROT_YXZ = 4,
// Rotate around the x-axis, then the y-axis and finally the z-axis.
ROT_XYZ = 5,
}
```
The entity to get the rotation for.
The order yaw, pitch and roll is applied. Usually 2.
A vector where the Z coordinate is the yaw.
]]
native "GET_ENTITY_ROTATION_VELOCITY"
hash "0x213B91045D09B983"
jhash (0x9BF8A73F)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "Vector3"
doc [[!
]]
native "GET_ENTITY_SCRIPT"
hash "0xA6E9C38DB51D7748"
jhash (0xB7F70784)
arguments {
Entity "entity" [=[ {} ]=],
ScrHandlePtr "script" [=[ {} ]=],
}
ns "ENTITY"
returns "charPtr"
doc [[!
```
All ambient entities in-world seem to have the same value for the second argument (Any *script), depending on when the scripthook was activated/re-activated. I've seen numbers from ~5 to almost 70 when the value was translated with to_string. The function return value seems to always be 0.
```
]]
native "GET_ENTITY_SPEED"
hash "0xD5037BA82E12416F"
jhash (0x9E1E4798)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "float"
doc [[!
Get the speed of a entity.
Entity id you want to test for speed.
Speed of a entity in m/s. You can convert to km/h using the value you get and multiply by 3.6, and miles/h by 2.236936. Also, the float returned is the length of [GET_ENTITY_SPEED_VECTOR](#\_0x9A8D700A51CB7B0D)
]]
native "GET_ENTITY_SPEED_VECTOR"
hash "0x9A8D700A51CB7B0D"
jhash (0x3ED2B997)
arguments {
Entity "entity" [=[ {} ]=],
BOOL "relative" [=[ {} ]=],
}
ns "ENTITY"
returns "Vector3"
doc [[!
```
Relative can be used for getting speed relative to the frame of the vehicle, to determine for example, if you are going in reverse (-y speed) or not (+y speed).
```
]]
native "GET_ENTITY_SUBMERGED_LEVEL"
hash "0xE81AFC1BC4CC41CE"
jhash (0x0170F68C)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "float"
doc [[!
```
Get how much of the entity is submerged. 1.0f is whole entity.
```
]]
native "GET_ENTITY_TYPE"
hash "0x8ACD366038D14505"
jhash (0x0B1BD08D)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "int"
doc [[!
```
Returns:
0 = no entity
1 = ped
2 = vehicle
3 = object
```
]]
native "GET_ENTITY_UPRIGHT_VALUE"
hash "0x95EED5A694951F9F"
jhash (0xF4268190)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "float"
doc [[!
]]
native "GET_ENTITY_VELOCITY"
hash "0x4805D2B1D8CF94A9"
jhash (0xC14C9B6B)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "Vector3"
doc [[!
]]
native "GET_LAST_MATERIAL_HIT_BY_ENTITY"
hash "0x5C3D0A935F535C4C"
jhash (0xC0E3AA47)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "Hash"
doc [[!
]]
native "GET_NEAREST_PLAYER_TO_ENTITY"
hash "0x7196842CB375CDB3"
jhash (0xCE17FDEC)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "Player"
doc [[!
]]
native "GET_NEAREST_PLAYER_TO_ENTITY_ON_TEAM"
hash "0x4DC9A62F844D9337"
jhash (0xB1808F56)
arguments {
Entity "entity" [=[ {} ]=],
int "team" [=[ {} ]=],
}
ns "ENTITY"
returns "Player"
doc [[!
]]
native "GET_OBJECT_INDEX_FROM_ENTITY_INDEX"
hash "0xD7E3B9735C0F89D6"
jhash (0xBC5A9C58)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "Object"
doc [[!
```
Simply returns whatever is passed to it (Regardless of whether the handle is valid or not).
```
]]
native "GET_OFFSET_FROM_ENTITY_GIVEN_WORLD_COORDS"
hash "0x2274BC1C4885E333"
jhash (0x6477EC9E)
arguments {
Entity "entity" [=[ {} ]=],
float "posX" [=[ {} ]=],
float "posY" [=[ {} ]=],
float "posZ" [=[ {} ]=],
}
ns "ENTITY"
returns "Vector3"
doc [[!
```
Converts world coords (posX - Z) to coords relative to the entity
Example:
posX = 50
posY = 1000
posZ = 60
Entity's coords are: x=30, y=1000, z=60.
All three returned coords will then be in range of [-20,20] depending on rotation of the entity.
```
]]
native "GET_OFFSET_FROM_ENTITY_IN_WORLD_COORDS"
hash "0x1899F328B0E12848"
jhash (0xABCF043A)
arguments {
Entity "entity" [=[ {} ]=],
float "offsetX" [=[ {} ]=],
float "offsetY" [=[ {} ]=],
float "offsetZ" [=[ {} ]=],
}
ns "ENTITY"
returns "Vector3"
doc [[!
```
Offset values are relative to the entity.
x = left/right
y = forward/backward
z = up/down
```
]]
native "GET_PED_INDEX_FROM_ENTITY_INDEX"
hash "0x04A2A40C73395041"
jhash (0xC46F74AC)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "Ped"
doc [[!
```
Simply returns whatever is passed to it (Regardless of whether the handle is valid or not).
```
]]
native "GET_VEHICLE_INDEX_FROM_ENTITY_INDEX"
hash "0x4B53F92932ADFAC0"
jhash (0xC69CF43D)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "Vehicle"
doc [[!
```
Simply returns whatever is passed to it (Regardless of whether the handle is valid or not).
```
]]
native "GET_WORLD_POSITION_OF_ENTITY_BONE"
hash "0x44A8FCB8ED227738"
jhash (0x7C6339DF)
arguments {
Entity "entity" [=[ {} ]=],
int "boneIndex" [=[ {} ]=],
}
ns "ENTITY"
returns "Vector3"
doc [[!
```
Returns the coordinates of an entity-bone.
```
]]
native "HAS_ANIM_EVENT_FIRED"
hash "0xEAF4CD9EA3E7E922"
jhash (0x66571CA0)
arguments {
Entity "entity" [=[ {} ]=],
Hash "actionHash" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
```
if (ENTITY::HAS_ANIM_EVENT_FIRED(PLAYER::PLAYER_PED_ID(), MISC::GET_HASH_KEY("CreateObject")))
```
]]
native "HAS_COLLISION_LOADED_AROUND_ENTITY"
hash "0xE9676F61BC0B3321"
jhash (0x851687F9)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
]]
native "HAS_ENTITY_ANIM_FINISHED"
hash "0x20B711662962B472"
jhash (0x1D9CAB92)
arguments {
Entity "entity" [=[ {} ]=],
charPtr "animDict" [=[ {} ]=],
charPtr "animName" [=[ {} ]=],
int "p3" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
```
P3 is always 3 as far as i cant tell
```
[Animations list](https://alexguirre.github.io/animations-list/)
]]
native "HAS_ENTITY_BEEN_DAMAGED_BY_ANY_OBJECT"
hash "0x95EB9964FF5C5C65"
jhash (0x6B74582E)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
]]
native "HAS_ENTITY_BEEN_DAMAGED_BY_ANY_PED"
hash "0x605F5A140F202491"
jhash (0x53FD4A25)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
]]
native "HAS_ENTITY_BEEN_DAMAGED_BY_ANY_VEHICLE"
hash "0xDFD5033FDBA0A9C8"
jhash (0x878C2CE0)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
]]
native "HAS_ENTITY_BEEN_DAMAGED_BY_ENTITY"
hash "0xC86D67D52A707CF8"
jhash (0x07FC77E0)
arguments {
Entity "entity" [=[ {} ]=],
Entity "damager" [=[ {} ]=],
BOOL "bCheckDamagerVehicle" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
The entity to check.
The entity that caused the damage.
If the damager is driving a vehicle then check to see if the entity was damaged by the vehicle.
Returns true if the entity has been damaged by the specified entity.
]]
native "HAS_ENTITY_CLEAR_LOS_TO_ENTITY"
hash "0xFCDFF7B72D23A1AC"
jhash (0x53576FA7)
arguments {
Entity "entity1" [=[ {} ]=],
Entity "entity2" [=[ {} ]=],
int "flags" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
Checks if entity1 has a clear line of sight to entity2. So a simple raycast which if it collides with any of the given colliderTypes returns false.
The direction of the check matters with for example bushes, so checking from inside to outside a bush with traceType 256 returns true, but the other way around returns false.
Entity to start from
Entity to check to
A bit mask with bits 1, 2, 4, etc, relating to collider types (see: [START_EXPENSIVE_SYNCHRONOUS_SHAPE_TEST_LOS_PROBE](#\_0x377906D8A31E5586)). 17 is most common in GTA scripts.
Returns `true` if no collider of specified bitmask is hit.
]]
native "HAS_ENTITY_CLEAR_LOS_TO_ENTITY_IN_FRONT"
hash "0x0267D00AF114F17A"
jhash (0x210D87C8)
arguments {
Entity "entity1" [=[ {} ]=],
Entity "entity2" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
```
Has the entity1 got a clear line of sight to the other entity2 from the direction entity1 is facing.
This is one of the most CPU demanding BOOL natives in the game; avoid calling this in things like nested for-loops
```
]]
native "HAS_ENTITY_COLLIDED_WITH_ANYTHING"
hash "0x8BAD02F0368D9E14"
jhash (0x662A2F41)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
```
Called on tick.
Tested with vehicles, returns true whenever the vehicle is touching any entity.
Note: for vehicles, the wheels can touch the ground and it will still return false, but if the body of the vehicle touches the ground, it will return true.
```
]]
native "IS_AN_ENTITY"
hash "0x731EC8A916BD11A1"
jhash (0xD4B9715A)
arguments {
int "handle" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
]]
native "IS_ENTITY_A_MISSION_ENTITY"
hash "0x0A7B270912999B3C"
jhash (0x2632E124)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
]]
native "IS_ENTITY_A_PED"
hash "0x524AC5ECEA15343E"
jhash (0x55D33EAB)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
The entity to check if it's a Ped.
Whether the entity is a Ped.
]]
native "IS_ENTITY_A_VEHICLE"
hash "0x6AC7003FA6E5575E"
jhash (0xBE800B01)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
]]
native "IS_ENTITY_AN_OBJECT"
hash "0x8D68C8FD0FACA94E"
jhash (0x3F52E561)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
]]
native "IS_ENTITY_AT_COORD"
hash "0x20B60995556D004F"
jhash (0xD749B606)
arguments {
Entity "entity" [=[ {} ]=],
float "xPos" [=[ {} ]=],
float "yPos" [=[ {} ]=],
float "zPos" [=[ {} ]=],
float "xSize" [=[ {} ]=],
float "ySize" [=[ {} ]=],
float "zSize" [=[ {} ]=],
BOOL "highlightArea" [=[ {} ]=],
BOOL "do3dCheck" [=[ {} ]=],
int "transportMode" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
Checks if the entity is within the given square of size xSize, ySize, zSize centered around the given coordinates.
The sizes given are the apothem (half of side) of the square, so a size of 5 would result in a square of 10x10, not 5x5.
For the highlightArea, if do3dCheck is true, the marker will be drawn at the bottom of the target area. So if the square is centered on the ground with a zSize larger than 0, the marker will appear under the ground.
The marker also doesn't scale, so it is always the same size (around half a meter).
So unfortunately the marker isn't that useful as it doesn't convey the correct information about the area (the marker doesn't reflect when the player is actually in the marker or not)
The entity to check the position of
The position of the square along the x-axis
The position of the square along the y-axis
The position of the square along the z-axis (only applicable if do3dCheck is true)
The apothem of the square along the x-axis
The apothem of the square along the y-axis
The apothem of the square along the z-axis (only applicable if do3dCheck is true)
Whether to draw a marker (yellow cylindrical marker at the given coords)
Whether to check the z-axis
Checks the transport mode the ped is using, only does something if entity is a ped. Transport modes are: 0 (any), 1 (on foot), 2 (in vehicle)
A boolean value which represents if the entity is within the given square area.
]]
native "IS_ENTITY_AT_ENTITY"
hash "0x751B70C3D034E187"
jhash (0xDABDCB52)
arguments {
Entity "entity" [=[ {} ]=],
Entity "target" [=[ {} ]=],
float "xSize" [=[ {} ]=],
float "ySize" [=[ {} ]=],
float "zSize" [=[ {} ]=],
BOOL "highlightArea" [=[ {} ]=],
BOOL "do3dCheck" [=[ {} ]=],
int "transportMode" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
Checks if entity is within the specified axis aligned box around the target entity.
```cpp
enum eTransportMode {
SCRIPT_TM_ANY = 0,
SCRIPT_TM_ON_FOOT = 1,
SCRIPT_TM_IN_VEHICLE = 2
};
```
The source entity handle.
The target entity handle.
The x size of the axis aligned box around the target entity to check.
The y size of the axis aligned box around the target entity to check.
The z size of the axis aligned box around the target entity to check.
If the check should be 2d or 3d.
The transport mode. Returns early if the entity is not in that mode of transportation.
]]
native "IS_ENTITY_ATTACHED"
hash "0xB346476EF1A64897"
jhash (0xEC1479D5)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
The entity to check if it is attached to another entity.
Whether the entity is attached to another entity.
]]
native "IS_ENTITY_ATTACHED_TO_ANY_OBJECT"
hash "0xCF511840CEEDE0CC"
jhash (0x0B5DE340)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
]]
native "IS_ENTITY_ATTACHED_TO_ANY_PED"
hash "0xB1632E9A5F988D11"
jhash (0x9D7A609C)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
]]
native "IS_ENTITY_ATTACHED_TO_ANY_VEHICLE"
hash "0x26AA915AD89BFB4B"
jhash (0xDE5C995E)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
]]
native "IS_ENTITY_ATTACHED_TO_ENTITY"
hash "0xEFBE71898A993728"
jhash (0xB0ABFEA8)
arguments {
Entity "from" [=[ {} ]=],
Entity "to" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
]]
native "IS_ENTITY_DEAD"
hash "0x5F9532F3B5CC2551"
jhash (0xB6F7CBAC)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
```
NativeDB Added Parameter 2: BOOL p1
```
]]
native "IS_ENTITY_IN_AIR"
hash "0x886E37EC497200B6"
jhash (0xA4157987)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
]]
native "IS_ENTITY_IN_ANGLED_AREA"
hash "0x51210CED3DA1C78A"
jhash (0x883622FA)
arguments {
Entity "entity" [=[ {} ]=],
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
float "width" [=[ {} ]=],
BOOL "debug" [=[ {} ]=],
BOOL "includez" [=[ {} ]=],
Any "p10" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
p10 is some entity flag check, also used in [`IS_ENTITY_AT_ENTITY`](#\_0x751B70C3D034E187), [`IS_ENTITY_IN_AREA`](#\_0x54736AA40E271165) and [`IS_ENTITY_AT_COORD`](#\_0x20B60995556D004F).
See [`IS_POINT_IN_ANGLED_AREA`](#\_0x2A70BAE8883E4C81) for the definition of an angled area.
X dimension of the angled area 'origin'
Y dimension of the angled area 'origin'
Z dimension of the angled area 'origin'
X dimension of the angled area 'extent'
Y dimension of the angled area 'extent'
Z dimension of the angled area 'extent'
Width of the angled area
a debug flag invoking functions in the same path as `DRAW_MARKER`
If true, include the Z dimension when doing the height check; otherwise the query becomes two-dimensional
]]
native "IS_ENTITY_IN_AREA"
hash "0x54736AA40E271165"
jhash (0x8C2DFA9D)
arguments {
Entity "entity" [=[ {} ]=],
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
BOOL "p7" [=[ {} ]=],
BOOL "p8" [=[ {} ]=],
Any "p9" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
]]
native "IS_ENTITY_IN_WATER"
hash "0xCFB0A0D8EDD145A3"
jhash (0x4C3C2508)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
]]
native "IS_ENTITY_IN_ZONE"
hash "0xB6463CF6AF527071"
jhash (0x45C82B21)
arguments {
Entity "entity" [=[ {} ]=],
charPtr "zone" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
]]
native "IS_ENTITY_OCCLUDED"
hash "0xE31C2C72B8692B64"
jhash (0x46BC5B40)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
]]
native "IS_ENTITY_ON_SCREEN"
hash "0xE659E47AF827484B"
jhash (0xC1FEC5ED)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
Determines whether the screen position of the specified entity is within the 2D bounds of the screen.
This native will not check if the entity is not visible due to being occluded (for example, behind a wall). To check if a entity is on screen and is not occluded, use [IS_ENTITY_OCCLUDED](#\_0xE31C2C72B8692B64).
The entity to check.
Returns `true` if the the entity is in between the minimum and maximum values for the 2D screen bound coords; otherwise, `false`.
]]
native "IS_ENTITY_PLAYING_ANIM"
hash "0x1F0B79228E461EC9"
jhash (0x0D130D34)
arguments {
Entity "entity" [=[ {} ]=],
charPtr "animDict" [=[ {} ]=],
charPtr "animName" [=[ {} ]=],
int "taskFlag" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
See also [`IS_SCRIPTED_SCENARIO_PED_USING_CONDITIONAL_ANIM`](#\_0x6EC47A344923E1ED)
```
Taken from ENTITY::IS_ENTITY_PLAYING_ANIM(PLAYER::PLAYER_PED_ID(), "creatures@shark@move", "attack_player", 3)
p4 is always 3 in the scripts.
taskFlag:
2 - Check synchronized scene
```
[Animations list](https://alexguirre.github.io/animations-list/)
]]
native "IS_ENTITY_STATIC"
hash "0x1218E6886D3D8327"
jhash (0x928E12E9)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
```
A static ped will not react to natives like "APPLY_FORCE_TO_ENTITY" or "SET_ENTITY_VELOCITY" and oftentimes will not react to task-natives like "AI::TASK_COMBAT_PED". The only way I know of to make one of these peds react is to ragdoll them (or sometimes to use CLEAR_PED_TASKS_IMMEDIATELY(). Static peds include almost all far-away peds, beach-combers, peds in certain scenarios, peds crossing a crosswalk, peds walking to get back into their cars, and others. If anyone knows how to make a ped non-static without ragdolling them, please edit this with the solution.
^ Attach a phCollider to the ped.
```
]]
native "IS_ENTITY_TOUCHING_ENTITY"
hash "0x17FFC1B2BA35A494"
jhash (0x6B931477)
arguments {
Entity "entity" [=[ {} ]=],
Entity "targetEntity" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
]]
native "IS_ENTITY_TOUCHING_MODEL"
hash "0x0F42323798A58C8C"
jhash (0x307E7611)
arguments {
Entity "entity" [=[ {} ]=],
Hash "modelHash" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
]]
native "IS_ENTITY_UPRIGHT"
hash "0x5333F526F6AB19AA"
jhash (0x3BCDF4E1)
arguments {
Entity "entity" [=[ {} ]=],
float "angle" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
]]
native "IS_ENTITY_UPSIDEDOWN"
hash "0x1DBD58820FA61D71"
jhash (0x5ACAA48F)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
]]
native "IS_ENTITY_VISIBLE"
hash "0x47D6F43D77935C75"
jhash (0x120B4ED5)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
]]
native "IS_ENTITY_VISIBLE_TO_SCRIPT"
hash "0xD796CB5BA8F20E32"
jhash (0x5D240E9D)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
]]
native "IS_ENTITY_WAITING_FOR_WORLD_COLLISION"
hash "0xD05BFF0C0A12C68F"
jhash (0x00AB7A4A)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
]]
native "PLAY_ENTITY_ANIM"
hash "0x7FB218262B810701"
jhash (0x878753D5)
arguments {
Entity "entity" [=[ {} ]=],
charPtr "animName" [=[ {} ]=],
charPtr "animDict" [=[ {} ]=],
float "fBlendDelta" [=[ {} ]=],
BOOL "bLoop" [=[ {} ]=],
BOOL "bHoldLastFrame" [=[ {} ]=],
BOOL "bDriveToPose" [=[ {} ]=],
float "fStartPhase" [=[ {} ]=],
int "iFlags" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
[Animations list](https://alexguirre.github.io/animations-list/)
The entity handle to play the animation on.
The name of the animation to play.
The name of the animation dictionary to use.
Blend in and out time.
Sets `AF_LOOPING` in the flags.
Sets `AF_HOLD_LAST_FRAME` in the flags.
unused
Clamped between `0.0` and `1.0`. Sets the start phase of the animation.
The flags to use when playing the animation. See [`TASK_PLAY_ANIM`](#\_0xEA47FE3719165B94).
]]
native "PLAY_SYNCHRONIZED_ENTITY_ANIM"
hash "0xC77720A12FE14A86"
jhash (0x012760AA)
arguments {
Entity "entity" [=[ {} ]=],
int "syncedScene" [=[ {} ]=],
charPtr "animName" [=[ {} ]=],
charPtr "animDictName" [=[ {} ]=],
float "fBlendInDelta" [=[ {} ]=],
float "fBlendOutDelta" [=[ {} ]=],
int "iFlags" [=[ {} ]=],
float "fMoverBlendInDelta" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
[Animations list](https://alexguirre.github.io/animations-list/)
The entity handle to play the animation on.
The name of the animation to play.
The name of the animation dictionary to use.
Blend in time.
Blend out time.
The flags to use when playing the animation. See [`TASK_PLAY_ANIM`](#\_0xEA47FE3719165B94).
]]
native "PLAY_SYNCHRONIZED_MAP_ENTITY_ANIM"
hash "0xB9C54555ED30FBC4"
jhash (0xEB4CBA74)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "radius" [=[ {} ]=],
Hash "objectModelHash" [=[ {"cs_type":"Any"} ]=],
int "sceneId" [=[ {} ]=],
charPtr "pAnimName" [=[ {"cs_type":"AnyPtr"} ]=],
charPtr "pAnimDictName" [=[ {"cs_type":"AnyPtr"} ]=],
float "fBlendDelta" [=[ {} ]=],
float "fBlendOutDelta" [=[ {} ]=],
int "flags" [=[ {} ]=],
float "fMoverBlendInDelta" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
[Animations list](https://alexguirre.github.io/animations-list/)
The name of the animation to play.
The name of the animation dictionary to use.
Blend in time.
Blend out time.
The flags to use when playing the animation. See [`TASK_PLAY_ANIM`](#\_0xEA47FE3719165B94).
]]
native "PROCESS_ENTITY_ATTACHMENTS"
hash "0xF4080490ADC51C6F"
jhash (0x6909BA59)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
```
Called to update entity attachments.
```
]]
native "REMOVE_FORCED_OBJECT"
hash "0x61B6775E83C0DB6F"
jhash (0xAED73ADD)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
]]
native "REMOVE_MODEL_HIDE"
hash "0xD9E3006FB3CBD765"
jhash (0x993DBC10)
arguments {
float "x" [=[ {"cs_type":"Any"} ]=],
float "y" [=[ {"cs_type":"Any"} ]=],
float "z" [=[ {"cs_type":"Any"} ]=],
float "radius" [=[ {"cs_type":"Any"} ]=],
Hash "model" [=[ {"cs_type":"Any"} ]=],
BOOL "lazy" [=[ {"cs_type":"Any"} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
Makes all objects of the specified model that were hidden using [`CREATE_MODEL_HIDE`](#\_0x8A97BCA30A0CE478) or [`CREATE_MODEL_HIDE_EXCLUDING_SCRIPT_OBJECTS`](#\_0x3A52AE588830BF7F) visible again.
If lazy is false, all matching objects currently in scope are restored immediately.
If lazy is true, objects will only reappear when their map is reloaded.
X Coordinate of the sphere center.
Y Coordinate of the sphere center.
Z Coordinate of the sphere center.
Radius of the sphere.
The model hash to make visible again.
false to apply the change immediately.
]]
native "REMOVE_MODEL_SWAP"
hash "0x033C0F9A64E229AE"
jhash (0xCE0AA8BC)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "radius" [=[ {} ]=],
Hash "oldModelHash" [=[ {} ]=],
Hash "newModelHash" [=[ {} ]=],
BOOL "bLazy" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
]]
native "RESET_ENTITY_ALPHA"
hash "0x9B1E824FFBB7027A"
jhash (0x8A30761C)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
annotations [=[ {"cs_type":"Any"} ]=]
returns "void"
doc [[!
]]
native "SET_CAN_AUTO_VAULT_ON_ENTITY"
hash "0xE12ABE5E3A389A6C"
jhash (0x44767B31)
arguments {
Entity "entity" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0xE12ABE5E3A389A6C"
ns "ENTITY"
returns "void"
doc [[!
]]
native "SET_CAN_CLIMB_ON_ENTITY"
hash "0xA80AE305E0A3044F"
jhash (0xE224A6A5)
arguments {
Entity "entity" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0xA80AE305E0A3044F"
ns "ENTITY"
returns "void"
doc [[!
]]
native "SET_ENTITY_ALPHA"
hash "0x44A0870B7E92D7C0"
jhash (0xAE667CB0)
arguments {
Entity "entity" [=[ {} ]=],
int "alphaLevel" [=[ {} ]=],
BOOL "skin" [=[ {"cs_type":"int"} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
This native sets the entity's alpha level.
The entity to change the alpha for.
The alpha level ranges from 0 to 255, but changes occur every 20% (every 51).
Whether or not to change the alpha of the entity's skin.
]]
native "SET_ENTITY_ALWAYS_PRERENDER"
hash "0xACAD101E1FB66689"
jhash (0xD8FF798A)
arguments {
Entity "entity" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
]]
native "SET_ENTITY_ANIM_CURRENT_TIME"
hash "0x4487C259F0F70977"
jhash (0x99D90735)
arguments {
Entity "entity" [=[ {} ]=],
charPtr "animDictionary" [=[ {} ]=],
charPtr "animName" [=[ {} ]=],
float "time" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
[Animations list](https://alexguirre.github.io/animations-list/)
]]
native "SET_ENTITY_ANIM_SPEED"
hash "0x28D1A16553C51776"
jhash (0x3990C90A)
arguments {
Entity "entity" [=[ {} ]=],
charPtr "animDictionary" [=[ {} ]=],
charPtr "animName" [=[ {} ]=],
float "speedMultiplier" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
]]
native "SET_ENTITY_AS_MISSION_ENTITY"
hash "0xAD738C3085FE7E11"
jhash (0x5D1F9E0F)
arguments {
Entity "entity" [=[ {} ]=],
BOOL "scriptHostObject" [=[ {} ]=],
BOOL "bGrabFromOtherScript" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
Assigns an existing entity to be owned by the current script. If the entity was not owned by a script yet, this also means the entity will remain persistent until released.
Note that this is not needed right after creating an entity as a script-created entity will automatically be assigned.
An entity handle.
Whether or not to assign script info to this entity, if set to false the entity will only be protected from despawning locally.
Changes the entity so it's owned by the current script if the entity is already a mission entity. This will only work on entities the machine has control of (non-remote entities).
]]
native "SET_ENTITY_AS_NO_LONGER_NEEDED"
hash "0xB736A491E64A32CF"
jhash (0xADF2267C)
arguments {
EntityPtr "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
```
Marks the specified entity (ped, vehicle or object) as no longer needed.
Entities marked as no longer needed, will be deleted as the engine sees fit.
```
]]
native "SET_ENTITY_CAN_BE_DAMAGED"
hash "0x1760FFA8AB074D66"
jhash (0x60B6E744)
arguments {
Entity "entity" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
]]
native "SET_ENTITY_CAN_BE_DAMAGED_BY_RELATIONSHIP_GROUP"
hash "0xE22D8FDE858B8119"
jhash (0x34165B5D)
arguments {
Entity "entity" [=[ {} ]=],
BOOL "bCanBeDamaged" [=[ {} ]=],
int "relGroup" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
]]
native "SET_ENTITY_CAN_BE_TARGETED_WITHOUT_LOS"
hash "0xD3997889736FD899"
jhash (0x3B13797C)
arguments {
Entity "entity" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
```
Sets whether the entity can be targeted without being in line-of-sight.
```
]]
native "SET_ENTITY_COLLISION"
hash "0x1A9205C1B9EE827F"
jhash (0x139FD37D)
arguments {
Entity "entity" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
BOOL "keepPhysics" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
]]
native "SET_ENTITY_COMPLETELY_DISABLE_COLLISION"
hash "0x9EBC85ED0FFFE51C"
jhash (0xBD0D4831)
arguments {
Entity "entity" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
BOOL "keepPhysics" [=[ {} ]=],
}
alias "0x9EBC85ED0FFFE51C"
alias "_SET_ENTITY_COLLISION_2"
ns "ENTITY"
returns "void"
doc [[!
]]
native "SET_ENTITY_COORDS"
hash "0x06843DA7060A026B"
jhash (0xDF70B41B)
arguments {
Entity "entity" [=[ {} ]=],
float "xPos" [=[ {} ]=],
float "yPos" [=[ {} ]=],
float "zPos" [=[ {} ]=],
BOOL "alive" [=[ {} ]=],
BOOL "deadFlag" [=[ {} ]=],
BOOL "ragdollFlag" [=[ {} ]=],
BOOL "clearArea" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
Sets the coordinates (world position) for a specified entity, offset by the radius of the entity on the Z axis.
The entity to change coordinates for.
The X coordinate.
The Y coordinate.
The Z coordinate, ground level.
Unused by the game, potentially used by debug builds of GTA in order to assert whether or not an entity was alive.
Whether to disable physics for dead peds, too, and not just living peds.
A special flag used for ragdolling peds.
Whether to clear any entities in the target area.
]]
native "SET_ENTITY_COORDS_NO_OFFSET"
hash "0x239A3351AC1DA385"
jhash (0x4C83DE8D)
arguments {
Entity "entity" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
BOOL "keepTasks" [=[ {} ]=],
BOOL "keepIK" [=[ {} ]=],
BOOL "doWarp" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
Teleports an entity to specified coordinates directly, with options to maintain certain behaviors post-teleportation.
**Note**:
* This native allows precise placement of entities without the usual adjustments for collision or interaction with the environment that may occur with other teleportation natives.
* The `keepTasks` and `keepIK` parameters are specifically useful for maintaining the current state of a ped, ensuring actions or animations are not abruptly stopped due to the teleportation.
* Setting `doWarp` to `false` is useful when simulating continuous movement or when the entity should interact with its immediate surroundings upon arrival.
The entity to reposition.
X coordinate for the new position.
Y coordinate for the new position.
Z coordinate for the new position.
If `true`, the tasks currently assigned to the ped are not removed upon teleportation. Applies only to peds.
If `true`, the Inverse Kinematics (IK) on the ped are not reset upon teleportation. Applies only to peds.
If `false`, the entity will maintain continuous motion and will not clear contacts nor create space for itself upon teleportation.
]]
native "SET_ENTITY_COORDS_WITHOUT_PLANTS_RESET"
hash "0x621873ECE1178967"
jhash (0x749B282E)
arguments {
Entity "entity" [=[ {} ]=],
float "xPos" [=[ {} ]=],
float "yPos" [=[ {} ]=],
float "zPos" [=[ {} ]=],
BOOL "alive" [=[ {} ]=],
BOOL "deadFlag" [=[ {} ]=],
BOOL "ragdollFlag" [=[ {} ]=],
BOOL "clearArea" [=[ {} ]=],
}
alias "_SET_ENTITY_COORDS_2"
ns "ENTITY"
returns "void"
doc [[!
]]
native "SET_ENTITY_DYNAMIC"
hash "0x1718DE8E3F2823CA"
jhash (0x236F525B)
arguments {
Entity "entity" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
]]
native "SET_ENTITY_HAS_GRAVITY"
hash "0x4A4722448F18EEF5"
jhash (0xE2F262BF)
arguments {
Entity "entity" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
]]
native "SET_ENTITY_HEADING"
hash "0x8E2530AA8ADA980E"
jhash (0xE0FF064D)
arguments {
Entity "entity" [=[ {} ]=],
float "heading" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
Set the heading of an entity in degrees also known as "Yaw".
The entity to set the heading for.
The heading in degrees.
]]
native "SET_ENTITY_HEALTH"
hash "0x6B76DC1F3AE6E6A3"
jhash (0xFBCD1831)
arguments {
Entity "entity" [=[ {} ]=],
int "health" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
When setting health for a player ped, the game will clamp the health value to ensure it does not exceed the maximum health. This maximum health can be retrieved by calling [`GET_PED_MAX_HEALTH`](#\_0x4700A416E8324EF3). It can also be modified by calling [`SET_PED_MAX_HEALTH`](#\_0xF5F6378C4F3419D3).
When setting the health for non-player peds or entities, the maximum health will be increased if the new health value exceeds the current maximum.
Default health for male peds is `200`, for female peds it is `175`.
### Added parameters
* **inflictor**: The handle for the entity that caused the damage.
The entity handle.
The health we should set this entity to.
]]
native "SET_ENTITY_INVINCIBLE"
hash "0x3882114BDE571AD4"
jhash (0xC1213A21)
arguments {
Entity "entity" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
```
Sets a ped or an object totally invincible. It doesn't take any kind of damage. Peds will not ragdoll on explosions and the tazer animation won't apply either.
If you use this for a ped and you want Ragdoll to stay enabled, then do:
*(DWORD *)(pedAddress + 0x188) |= (1 << 9);
Use this if you want to get the invincibility status:
bool IsPedInvincible(Ped ped)
{
auto addr = getScriptHandleBaseAddress(ped);
if (addr)
{
DWORD flag = *(DWORD *)(addr + 0x188);
return ((flag & (1 << 8)) != 0) || ((flag & (1 << 9)) != 0);
}
return false;
}
```
]]
native "SET_ENTITY_IS_TARGET_PRIORITY"
hash "0xEA02E132F5C68722"
jhash (0x9729EE32)
arguments {
Entity "entity" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
]]
native "SET_ENTITY_LIGHTS"
hash "0x7CFBA6A80BDF3874"
jhash (0xE8FC85AF)
arguments {
Entity "entity" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
]]
native "SET_ENTITY_LOAD_COLLISION_FLAG"
hash "0x0DC7CABAB1E9B67E"
jhash (0xC52F295B)
arguments {
Entity "entity" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
Loads collision grid for an entity spawned outside of a player's loaded area. This allows peds to execute tasks rather than sit dormant because of a lack of a physics grid.
Certainly not the main usage of this native but when set to true for a Vehicle, it will prevent the vehicle to explode if it is spawned far away from the player.
```
NativeDB Added Parameter 3: Any p2
```
]]
native "SET_ENTITY_LOD_DIST"
hash "0x5927F96A78577363"
jhash (0xD7ACC7AD)
arguments {
Entity "entity" [=[ {} ]=],
int "value" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
```
LOD distance can be 0 to 0xFFFF (higher values will result in 0xFFFF) as it is actually stored as a 16-bit value (aka uint16_t).
```
]]
native "SET_ENTITY_MAX_HEALTH"
hash "0x166E7CF68597D8B5"
jhash (0x96F84DF8)
arguments {
Entity "entity" [=[ {} ]=],
int "value" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
```
For instance: ENTITY::SET_ENTITY_MAX_HEALTH(PLAYER::PLAYER_PED_ID(), 200); // director_mode.c4: 67849
```
]]
native "SET_ENTITY_MAX_SPEED"
hash "0x0E46A3FCBDE2A1B1"
jhash (0x46AFFED3)
arguments {
Entity "entity" [=[ {} ]=],
float "speed" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
Entity to apply a maximum speed on
Speed in meters per second
]]
native "SET_ENTITY_MOTION_BLUR"
hash "0x295D82A8559F9150"
jhash (0xE90005B8)
arguments {
Entity "entity" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
]]
native "SET_ENTITY_NO_COLLISION_ENTITY"
hash "0xA53ED5520C07654A"
jhash (0x1E11BFE9)
arguments {
Entity "entity1" [=[ {} ]=],
Entity "entity2" [=[ {} ]=],
BOOL "thisFrameOnly" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
```
Calling this function disables collision between two entities.
The importance of the order for entity1 and entity2 is unclear.
The third parameter, `thisFrame`, decides whether the collision is to be disabled until it is turned back on, or if it's just this frame.
```
]]
native "SET_ENTITY_ONLY_DAMAGED_BY_PLAYER"
hash "0x79F020FF9EDC0748"
jhash (0x4B707F50)
arguments {
Entity "entity" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
]]
native "SET_ENTITY_ONLY_DAMAGED_BY_RELATIONSHIP_GROUP"
hash "0x7022BD828FA0B082"
jhash (0x202237E2)
arguments {
Entity "entity" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
Hash "relationshipHash" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
]]
native "SET_ENTITY_PROOFS"
hash "0xFAEE099C6F890BB8"
jhash (0x7E9EAB66)
arguments {
Entity "entity" [=[ {} ]=],
BOOL "bulletProof" [=[ {} ]=],
BOOL "fireProof" [=[ {} ]=],
BOOL "explosionProof" [=[ {} ]=],
BOOL "collisionProof" [=[ {} ]=],
BOOL "meleeProof" [=[ {} ]=],
BOOL "steamProof" [=[ {} ]=],
BOOL "p7" [=[ {} ]=],
BOOL "drownProof" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
```
Enable / disable each type of damage.
--------------
p7 is to to '1' in am_mp_property_ext/int: entity::set_entity_proofs(uParam0->f_19, true, true, true, true, true, true, 1, true);
```
]]
native "SET_ENTITY_QUATERNION"
hash "0x77B21BE7AC540F07"
jhash (0x83B6046F)
arguments {
Entity "entity" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "w" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
```
w is the correct parameter name!
```
]]
native "SET_ENTITY_RECORDS_COLLISIONS"
hash "0x0A50A1EEDAD01E65"
jhash (0x6B189A1A)
arguments {
Entity "entity" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
]]
native "SET_ENTITY_RENDER_SCORCHED"
hash "0x730F5F8D3F0F2050"
jhash (0xAAC9317B)
arguments {
Entity "entity" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
]]
native "SET_ENTITY_REQUIRES_MORE_EXPENSIVE_RIVER_CHECK"
hash "0x694E00132F2823ED"
jhash (0x40C84A74)
arguments {
Entity "entity" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x694E00132F2823ED"
ns "ENTITY"
returns "void"
doc [[!
]]
native "SET_ENTITY_ROTATION"
hash "0x8524A8B0171D5E07"
jhash (0x0A345EFE)
arguments {
Entity "entity" [=[ {} ]=],
float "pitch" [=[ {} ]=],
float "roll" [=[ {} ]=],
float "yaw" [=[ {} ]=],
int "rotationOrder" [=[ {} ]=],
BOOL "bDeadCheck" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
Sets the rotation of a specified entity in the game world.
```
NativeDB Introduced: v323
```
The entity to rotate.
The pitch (X-axis) rotation in degrees.
The roll (Y-axis) rotation in degrees.
The yaw (Z-axis) rotation in degrees.
Specifies the order in which yaw, pitch, and roll are applied, see [`GET_ENTITY_ROTATION`](#\_0xAFBD61CC738D9EB9) for the available rotation orders.
Usually set to `true`. Determines whether to check if the entity is dead before applying the rotation.
]]
native "SET_ENTITY_TRAFFICLIGHT_OVERRIDE"
hash "0x57C5DB656185EAC4"
jhash (0xC47F5B91)
arguments {
Entity "entity" [=[ {} ]=],
int "state" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
Changing traffic-lights will not change the behavior of NPCs.
Example: [here](https://www.gtaforums.com/topic/830463-help-with-turning-lights-green-and-causing-peds-to-crash-into-each-other/#entry1068211340)
```cpp
enum eTrafficlightOverrideMode
{
TLO_RED = 0,
TLO_AMBER = 1,
TLO_GREEN = 2,
TLO_NONE = 3
}
```
]]
native "SET_ENTITY_VELOCITY"
hash "0x1C99BB7B6E96D16F"
jhash (0xFF5A1988)
arguments {
Entity "entity" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
```
Note that the third parameter(denoted as z) is "up and down" with positive numbers encouraging upwards movement.
```
]]
native "SET_ENTITY_VISIBLE"
hash "0xEA1C610A04DB6BBB"
jhash (0xD043E8E1)
arguments {
Entity "entity" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
BOOL "unk" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
Toggle the visibility of a given entity.
The entity to change the visibility of
Whether or not the entity will be visible
Always 0 in scripts
]]
native "SET_OBJECT_AS_NO_LONGER_NEEDED"
hash "0x3AE22DEB5BA5A3E6"
jhash (0x3F6B949F)
arguments {
ObjectPtr "object" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
```
This is an alias of SET_ENTITY_AS_NO_LONGER_NEEDED.
```
]]
native "SET_PED_AS_NO_LONGER_NEEDED"
hash "0x2595DD4236549CE3"
jhash (0x9A388380)
arguments {
PedPtr "ped" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
```
This is an alias of SET_ENTITY_AS_NO_LONGER_NEEDED.
```
]]
native "SET_PICK_UP_BY_CARGOBOB_DISABLED"
hash "0xD7B80E7C3BEFC396"
arguments {
Entity "entity" [=[ {} ]=],
BOOL "toggle" [=[ {"cs_type":"Any"} ]=],
}
alias "0xD7B80E7C3BEFC396"
ns "ENTITY"
returns "void"
doc [[!
Configures an entity to either allow or prevent it from being picked up by Cargobobs.
```
NativeDB Introduced: v1180
```
The entity to be configured for pick up by Cargobob.
A boolean value where `true` prevents the entity from being picked up by Cargobobs, and `false` allows it.
]]
native "SET_VEHICLE_AS_NO_LONGER_NEEDED"
hash "0x629BFA74418D6239"
jhash (0x9B0E10BE)
arguments {
VehiclePtr "vehicle" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
```
This is an alias of SET_ENTITY_AS_NO_LONGER_NEEDED.
```
]]
native "SET_WAIT_FOR_COLLISIONS_BEFORE_PROBE"
hash "0xDC6F8601FAF2E893"
jhash (0xA0466A69)
arguments {
Entity "entity" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0xDC6F8601FAF2E893"
ns "ENTITY"
returns "void"
doc [[!
```
SET_*
Only called within 1 script for x360. 'fm_mission_controller' and it used on an object.
Ran after these 2 natives,
set_object_targettable(uParam0, 0);
set_entity_invincible(uParam0, 1);
```
]]
native "STOP_ENTITY_ANIM"
hash "0x28004F88151E03E0"
jhash (0xC4769830)
arguments {
Entity "entity" [=[ {} ]=],
charPtr "animation" [=[ {} ]=],
charPtr "animGroup" [=[ {} ]=],
float "p3" [=[ {} ]=],
}
ns "ENTITY"
returns "Any"
doc [[!
```
RAGEPluginHook list: docs.ragepluginhook.net/html/62951c37-a440-478c-b389-c471230ddfc5.htm
```
]]
native "STOP_SYNCHRONIZED_ENTITY_ANIM"
hash "0x43D3807C077261E3"
jhash (0xE27D2FC1)
arguments {
Entity "entity" [=[ {} ]=],
float "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
```
p1 sync task id?
```
]]
native "STOP_SYNCHRONIZED_MAP_ENTITY_ANIM"
hash "0x11E79CAB7183B6F5"
jhash (0x7253D5B2)
arguments {
float "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
float "p5" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
]]
native "WOULD_ENTITY_BE_OCCLUDED"
hash "0xEE5D2A122E09EC42"
jhash (0xEA127CBC)
arguments {
Hash "entityModelHash" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
BOOL "p4" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
]]
native "_ATTACH_ENTITY_BONE_TO_ENTITY_BONE"
hash "0x5C48B75732C8456C"
arguments {
Entity "entity1" [=[ {} ]=],
Entity "entity2" [=[ {} ]=],
int "entityBone" [=[ {} ]=],
int "entityBone2" [=[ {} ]=],
BOOL "p4" [=[ {} ]=],
BOOL "p5" [=[ {} ]=],
}
alias "0x5C48B75732C8456C"
ns "ENTITY"
returns "void"
doc [[!
]]
native "_ATTACH_ENTITY_BONE_TO_ENTITY_BONE_PHYSICALLY"
hash "0xFD1695C5D3B05439"
arguments {
Entity "entity1" [=[ {} ]=],
Entity "entity2" [=[ {} ]=],
int "entityBone" [=[ {} ]=],
int "entityBone2" [=[ {} ]=],
BOOL "p4" [=[ {} ]=],
BOOL "p5" [=[ {} ]=],
}
alias "0xFD1695C5D3B05439"
ns "ENTITY"
returns "void"
doc [[!
]]
native "_DOES_ENTITY_HAVE_ANIM_DIRECTOR"
hash "0x2158E81A6AF65EA9"
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
```
NativeDB Introduced: v2699
```
]]
native "_DOES_ENTITY_HAVE_SKELETON_DATA"
hash "0x764EB96874EFFDC1"
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
```
NativeDB Introduced: v2699
```
]]
native "_ENABLE_ENTITY_UNK"
hash "0x6CE177D014502E8A"
arguments {
Entity "entity" [=[ {} ]=],
}
alias "0x6CE177D014502E8A"
ns "ENTITY"
returns "void"
doc [[!
```
ENABLE_*
```
]]
native "_GET_ENTITY_BONE_COUNT"
hash "0xB328DCC3A3AA401B"
arguments {
Entity "entity" [=[ {} ]=],
}
alias "0xB328DCC3A3AA401B"
ns "ENTITY"
returns "int"
doc [[!
]]
native "_GET_ENTITY_BONE_POSITION_2"
hash "0x46F8696933A63C9B"
arguments {
Entity "entity" [=[ {} ]=],
int "boneIndex" [=[ {} ]=],
}
alias "0x46F8696933A63C9B"
alias "_GET_WORLD_POSITION_OF_ENTITY_BONE_2"
ns "ENTITY"
returns "Vector3"
doc [[!
```
Gets the world rotation of the specified bone of the specified entity.
This native is used in casinoroulette.c but I don't know yet what is the difference with _GET_ENTITY_BONE_ROTATION
```
]]
native "_GET_ENTITY_BONE_ROTATION"
hash "0xCE6294A232D03786"
arguments {
Entity "entity" [=[ {} ]=],
int "boneIndex" [=[ {} ]=],
}
alias "0xCE6294A232D03786"
alias "_GET_WORLD_ROTATION_OF_ENTITY_BONE"
ns "ENTITY"
returns "Vector3"
doc [[!
```
Gets the world rotation of the specified bone of the specified entity.
```
]]
native "_GET_ENTITY_BONE_ROTATION_LOCAL"
hash "0xBD8D32550E5CEBFE"
arguments {
Entity "entity" [=[ {} ]=],
int "boneIndex" [=[ {} ]=],
}
ns "ENTITY"
returns "Vector3"
doc [[!
Gets the local rotation of the specified bone of the specified entity.
```
NativeDB Introduced: v1734
```
]]
native "_GET_ENTITY_PICKUP"
hash "0x1F922734E259BD26"
arguments {
Entity "entity" [=[ {} ]=],
Hash "modelHash" [=[ {} ]=],
}
ns "ENTITY"
returns "Entity"
doc [[!
```
GET_ENTITY_*
Seems to return the handle of the entity's portable pickup.
NativeDB Introduced: v1180
```
]]
native "_GET_ENTITY_PROOFS"
hash "0xBE8CD9BE829BBEBF"
arguments {
Entity "entity" [=[ {} ]=],
BOOLPtr "bulletProof" [=[ {} ]=],
BOOLPtr "fireProof" [=[ {} ]=],
BOOLPtr "explosionProof" [=[ {} ]=],
BOOLPtr "collisionProof" [=[ {} ]=],
BOOLPtr "meleeProof" [=[ {} ]=],
BOOLPtr "steamProof" [=[ {} ]=],
BOOLPtr "p7" [=[ {} ]=],
BOOLPtr "drownProof" [=[ {} ]=],
}
ns "ENTITY"
returns "BOOL"
doc [[!
```
NativeDB Introduced: v1604
```
]]
native "_HAS_ENTITY_CLEAR_LOS_TO_ENTITY_2"
hash "0x394BDE2A7BBA031E"
arguments {
Entity "entity1" [=[ {} ]=],
Entity "entity2" [=[ {} ]=],
int "traceType" [=[ {} ]=],
}
alias "0x394BDE2A7BBA031E"
ns "ENTITY"
returns "Any"
doc [[!
```
NativeDB Introduced: v1868
```
]]
native "_SET_ENTITY_ANGULAR_VELOCITY"
hash "0x8339643499D1222E"
arguments {
Entity "entity" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
alias "0x8339643499D1222E"
ns "ENTITY"
returns "void"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "_SET_ENTITY_CLEANUP_BY_ENGINE"
hash "0x3910051CCECDB00C"
jhash (0xD3850671)
arguments {
Entity "entity" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x3910051CCECDB00C"
alias "_SET_ENTITY_REGISTER"
alias "_SET_ENTITY_SOMETHING"
ns "ENTITY"
returns "void"
doc [[!
```
True means it can be deleted by the engine when switching lobbies/missions/etc, false means the script is expected to clean it up.
```
]]
native "_SET_ENTITY_DECALS_DISABLED"
hash "0x2C2E3DC128F44309"
arguments {
Entity "entity" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
alias "0x2C2E3DC128F44309"
ns "ENTITY"
returns "void"
doc [[!
```
SET_ENTITY_*
```
]]
native "_SET_ENTITY_NO_COLLISION_WITH_NETWORKED_ENTITY"
hash "0x0A27A7827347B3B1"
arguments {
Entity "entity1" [=[ {} ]=],
Entity "entity2" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
```
NativeDB Introduced: v3407
```
]]
native "0x1A092BB0C3808B96"
hash "0x1A092BB0C3808B96"
arguments {
Entity "entity" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
```
SET_ENTITY_*
```
]]
native "0x352E2B5CF420BF3B"
hash "0x352E2B5CF420BF3B"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
]]
native "0x36F32DE87082343E"
hash "0x36F32DE87082343E"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
]]
native "0x490861B88F4FD846"
hash "0x490861B88F4FD846"
arguments {
Any "p0" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
```
Does nothing (essentially a nullsub).
```
]]
native "0x5C3B791D580E0BC2"
hash "0x5C3B791D580E0BC2"
arguments {
Entity "entity" [=[ {} ]=],
float "p1" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
```
Only called once in the scripts.
Related to weapon objects.
```
]]
native "0x68B562E124CC0AEF"
hash "0x68B562E124CC0AEF"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
```
NativeDB Introduced: v1180
```
]]
native "0x78E8E3A640178255"
hash "0x78E8E3A640178255"
arguments {
Entity "entity" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
```
Related to cutscene entities. Unsure about the use.
SET_ENTITY_*
```
]]
native "0xB17BC6453F6CF5AC"
hash "0xB17BC6453F6CF5AC"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
]]
native "0xC34BC448DA29F5E9"
hash "0xC34BC448DA29F5E9"
arguments {
Entity "entity" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
```
SET_ENTITY_*
```
]]
native "0xCEA7C8E1B48FF68C"
hash "0xCEA7C8E1B48FF68C"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
]]
native "0xE66377CDDADA4810"
hash "0xE66377CDDADA4810"
arguments {
Entity "entity" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "ENTITY"
returns "void"
doc [[!
SET_ENTITY_M\*
```
NativeDB Introduced: v1734
```
]]
native "DOES_SHOP_PED_APPAREL_HAVE_RESTRICTION_TAG"
hash "0x341DE7ED1D2A1BFD"
jhash (0x8E2C7FD5)
arguments {
Hash "componentHash" [=[ {} ]=],
Hash "restrictionTagHash" [=[ {} ]=],
int "componentId" [=[ {} ]=],
}
alias "0x341DE7ED1D2A1BFD"
ns "FILES"
returns "BOOL"
doc [[!
]]
native "GET_DLC_VEHICLE_DATA"
hash "0x33468EDC08E371F6"
jhash (0xCF428FA4)
arguments {
int "dlcVehicleIndex" [=[ {} ]=],
AnyPtr "outData" [=[ {} ]=],
}
ns "FILES"
returns "BOOL"
doc [[!
The Second item in the struct `*(Hash *)(outData + 1)` is the vehicle hash.
takes a number from 0 to `GET_NUM_DLC_VEHICLES()` - 1.
a struct of 3 8-byte items.
A boolean value return if find or not the dlcVehicleIndex.
]]
native "GET_DLC_VEHICLE_FLAGS"
hash "0x5549EE11FA22FCF2"
jhash (0xAB12738C)
arguments {
int "dlcVehicleIndex" [=[ {} ]=],
}
ns "FILES"
returns "int"
doc [[!
]]
native "GET_DLC_VEHICLE_MOD_LOCK_HASH"
hash "0xC098810437312FFF"
jhash (0x59352658)
arguments {
Hash "hash" [=[ {"cs_type":"int"} ]=],
}
alias "0xC098810437312FFF"
ns "FILES"
annotations [=[ {"cs_type":"int"} ]=]
returns "Hash"
doc [[!
]]
native "GET_DLC_VEHICLE_MODEL"
hash "0xECC01B7C5763333C"
jhash (0xA2201E09)
arguments {
int "dlcVehicleIndex" [=[ {} ]=],
}
ns "FILES"
returns "Hash"
doc [[!
```
dlcVehicleIndex is 0 to GET_NUM_DLC_VEHICLS()
```
]]
native "GET_DLC_WEAPON_COMPONENT_DATA"
hash "0x6CF598A2957C2BF8"
jhash (0x4B83FCAF)
arguments {
int "dlcWeaponIndex" [=[ {} ]=],
int "dlcWeapCompIndex" [=[ {} ]=],
intPtr "ComponentDataPtr" [=[ {"cs_type":"AnyPtr"} ]=],
}
ns "FILES"
returns "BOOL"
doc [[!
```
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];
};
```
]]
native "GET_DLC_WEAPON_DATA"
hash "0x79923CD21BECE14E"
jhash (0xD88EC8EA)
arguments {
int "dlcWeaponIndex" [=[ {} ]=],
intPtr "outData" [=[ {} ]=],
}
ns "FILES"
returns "BOOL"
doc [[!
```
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];
};
```
]]
native "GET_FORCED_COMPONENT"
hash "0x6C93ED8C2F74859B"
jhash (0x382C70BE)
arguments {
Hash "componentHash" [=[ {} ]=],
int "forcedComponentIndex" [=[ {} ]=],
HashPtr "nameHash" [=[ {"cs_type":"AnyPtr"} ]=],
intPtr "enumValue" [=[ {"cs_type":"AnyPtr"} ]=],
intPtr "componentType" [=[ {"cs_type":"AnyPtr"} ]=],
}
ns "FILES"
returns "void"
doc [[!
]]
native "GET_FORCED_PROP"
hash "0xE1CA84EBF72E691D"
jhash (0x22DAE257)
arguments {
Hash "componentHash" [=[ {"cs_type":"Any"} ]=],
int "forcedPropIndex" [=[ {} ]=],
HashPtr "nameHash" [=[ {"cs_type":"AnyPtr"} ]=],
intPtr "enumValue" [=[ {"cs_type":"AnyPtr"} ]=],
intPtr "anchorPoint" [=[ {"cs_type":"AnyPtr"} ]=],
}
alias "0xE1CA84EBF72E691D"
ns "FILES"
returns "void"
doc [[!
]]
native "GET_HASH_NAME_FOR_COMPONENT"
hash "0x0368B3A838070348"
jhash (0xC8A4BF12)
arguments {
Entity "entity" [=[ {} ]=],
int "componentId" [=[ {} ]=],
int "drawableVariant" [=[ {} ]=],
int "textureVariant" [=[ {} ]=],
}
ns "FILES"
returns "Hash"
doc [[!
]]
native "GET_HASH_NAME_FOR_PROP"
hash "0x5D6160275CAEC8DD"
jhash (0x7D876DC0)
arguments {
Entity "entity" [=[ {} ]=],
int "componentId" [=[ {} ]=],
int "propIndex" [=[ {} ]=],
int "propTextureIndex" [=[ {} ]=],
}
ns "FILES"
returns "Hash"
doc [[!
]]
native "GET_NUM_DLC_VEHICLES"
hash "0xA7A866D21CD2329B"
jhash (0x8EAF9CF6)
ns "FILES"
returns "int"
doc [[!
Returns the total number of DLC vehicles.
]]
native "GET_NUM_DLC_WEAPON_COMPONENTS"
hash "0x405425358A7D61FE"
jhash (0x476B23A9)
arguments {
int "dlcWeaponIndex" [=[ {} ]=],
}
ns "FILES"
returns "int"
doc [[!
```
Returns the total number of DLC weapon components.
```
]]
native "GET_NUM_DLC_WEAPONS"
hash "0xEE47635F352DA367"
jhash (0x2B757E6C)
ns "FILES"
returns "int"
doc [[!
```
Returns the total number of DLC weapons.
```
]]
native "GET_NUM_TATTOO_SHOP_DLC_ITEMS"
hash "0x278F76C3B0A8F109"
jhash (0x71D0CF3E)
arguments {
int "character" [=[ {} ]=],
}
alias "0x278F76C3B0A8F109"
alias "_GET_NUM_DECORATIONS"
ns "FILES"
returns "int"
doc [[!
```
Character types:
0 = Michael,
1 = Franklin,
2 = Trevor,
3 = MPMale,
4 = MPFemale
```
]]
native "GET_SHOP_PED_APPAREL_FORCED_COMPONENT_COUNT"
hash "0xC6B9DB42C04DD8C3"
jhash (0xCE70F183)
arguments {
Hash "componentHash" [=[ {} ]=],
}
alias "_GET_NUM_FORCED_COMPONENTS"
ns "FILES"
returns "int"
doc [[!
```
Returns number of possible values of the forcedComponentIndex argument of GET_FORCED_COMPONENT.
```
]]
native "GET_SHOP_PED_APPAREL_FORCED_PROP_COUNT"
hash "0x017568A8182D98A6"
jhash (0xC560D7C0)
arguments {
Hash "componentHash" [=[ {"cs_type":"Any"} ]=],
}
alias "0x017568A8182D98A6"
ns "FILES"
returns "int"
doc [[!
```
Returns number of possible values of the forcedPropIndex argument of GET_FORCED_PROP.
```
]]
native "GET_SHOP_PED_APPAREL_VARIANT_COMPONENT_COUNT"
hash "0xC17AD0E5752BECDA"
jhash (0x159751B4)
arguments {
Hash "componentHash" [=[ {} ]=],
}
alias "0xC17AD0E5752BECDA"
ns "FILES"
returns "int"
doc [[!
]]
native "GET_SHOP_PED_COMPONENT"
hash "0x74C0E2A57EC66760"
jhash (0xB39677C5)
arguments {
Hash "componentHash" [=[ {} ]=],
AnyPtr "outComponent" [=[ {} ]=],
}
ns "FILES"
returns "void"
doc [[!
```
More info here: https://gist.github.com/root-cause/3b80234367b0c856d60bf5cb4b826f86
```
]]
native "GET_SHOP_PED_OUTFIT"
hash "0xB7952076E444979D"
jhash (0xCAFE9209)
arguments {
Any "p0" [=[ {} ]=],
AnyPtr "p1" [=[ {} ]=],
}
ns "FILES"
returns "void"
doc [[!
]]
native "GET_SHOP_PED_OUTFIT_COMPONENT_VARIANT"
hash "0x19F2A026EDF0013F"
jhash (0x818534AC)
arguments {
Hash "outfit" [=[ {"cs_type":"Any"} ]=],
int "slot" [=[ {} ]=],
AnyPtr "outComponentVariant" [=[ {} ]=],
}
alias "_GET_PROP_FROM_OUTFIT"
ns "FILES"
returns "BOOL"
doc [[!
A structure, see [`GET_SHOP_PED_QUERY_OUTFIT`](#\_0x6D793F03A631FE56).
outfit slot.
]]
native "GET_SHOP_PED_OUTFIT_LOCATE"
hash "0x073CA26B079F956E"
jhash (0x2798F56F)
arguments {
Any "p0" [=[ {} ]=],
}
alias "0x073CA26B079F956E"
ns "FILES"
returns "int"
doc [[!
]]
native "GET_SHOP_PED_OUTFIT_PROP_VARIANT"
hash "0xA9F9C2E0FDE11CBB"
jhash (0x6641A864)
arguments {
Hash "outfitHash" [=[ {"cs_type":"Any"} ]=],
int "variantIndex" [=[ {} ]=],
AnyPtr "outPropVariant" [=[ {} ]=],
}
alias "0xA9F9C2E0FDE11CBB"
ns "FILES"
returns "BOOL"
doc [[!
]]
native "GET_SHOP_PED_PROP"
hash "0x5D5CAFF661DDF6FC"
jhash (0xDB0A7A58)
arguments {
Hash "componentHash" [=[ {"cs_type":"Any"} ]=],
AnyPtr "outProp" [=[ {} ]=],
}
alias "0x5D5CAFF661DDF6FC"
ns "FILES"
returns "void"
doc [[!
]]
native "GET_SHOP_PED_QUERY_COMPONENT"
hash "0x249E310B2D920699"
jhash (0xC0718904)
arguments {
int "componentId" [=[ {} ]=],
intPtr "outComponent" [=[ {} ]=],
}
ns "FILES"
returns "void"
doc [[!
]]
native "GET_SHOP_PED_QUERY_OUTFIT"
hash "0x6D793F03A631FE56"
jhash (0x2F8013A1)
arguments {
int "outfitIndex" [=[ {} ]=],
AnyPtr "outfit" [=[ {} ]=],
}
ns "FILES"
returns "void"
doc [[!
```
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;
};
```
]]
native "GET_SHOP_PED_QUERY_PROP"
hash "0xDE44A00999B2837D"
jhash (0x1D3C1466)
arguments {
int "componentId" [=[ {} ]=],
AnyPtr "outProp" [=[ {} ]=],
}
ns "FILES"
returns "void"
doc [[!
]]
native "GET_TATTOO_SHOP_DLC_ITEM_DATA"
hash "0xFF56381874F82086"
jhash (0x2E9D628C)
arguments {
int "characterType" [=[ {} ]=],
int "decorationIndex" [=[ {} ]=],
AnyPtr "outComponent" [=[ {} ]=],
}
alias "0xFF56381874F82086"
alias "_GET_TATTOO_COLLECTION_DATA"
ns "FILES"
returns "BOOL"
doc [[!
Returns data that adheres to the tattoo shop item data that is used in shop_tattoo.meta
Character types:
```cpp
enum eTattooFaction
{
TATTOO_SP_MICHAEL = 0,
TATTOO_SP_FRANKLIN = 1,
TATTOO_SP_TREVOR = 2,
TATTOO_MP_FM = 3,
TATTOO_MP_FM_F = 4
}
```
Returned struct properties:
```cpp
struct sTattooShopItemValues
{
// Lock hash, used with IS_CONTENT_ITEM_LOCKED
int LockHash;
// Unique ID of this slot. It can also be 0.
int Index;
// Collection hash of this tattoo
int CollectionHash;
// Preset hash of this tattoo
int PresetHash;
// Cost of this tattoo in shops.
int Cost;
// Secondary placement of this tattoo.
int eFacing;
// Location of this tattoo on the body (for example, for torso there would be chest upper, stomach, etc)
int UpdateGroup;
// This tattoo's name in the form of a text label.
const char* NameTextLabel;
};
```
Which character to get the tattoo data for (Refer to `eTattooFaction` above).
Tattoo index, value between 0 and [GET_NUM_TATTOO_SHOP_DLC_ITEMS](#\_0x278F76C3B0A8F109).
The referenced struct.
A bool indicating that the tattoo data exists in the files.
]]
native "GET_TATTOO_SHOP_DLC_ITEM_INDEX"
hash "0x10144267DD22866C"
arguments {
int "character" [=[ {"cs_type":"Hash"} ]=],
int "collection" [=[ {} ]=],
int "preset" [=[ {} ]=],
}
alias "0x10144267DD22866C"
ns "FILES"
returns "int"
doc [[!
```
NativeDB Introduced: v2189
```
AKA eFaction in shop_tattoo.meta. Which character this tattoo belongs to. See [GET_NUM_TATTOO_SHOP_DLC_ITEMS](#\_0x278F76C3B0A8F109).
Which collection this tattoo belongs to. If you specify `-1`, it will check all collections.
Which preset this tattoo belongs to.
Returns the actual index (Not ID from `shop_tattoo.meta`) from `0` to [GET_NUM_TATTOO_SHOP_DLC_ITEMS](#\_0x278F76C3B0A8F109), or `-1` (if it failed to find the tattoo) of a tattoo.
]]
native "GET_VARIANT_COMPONENT"
hash "0x6E11F282F11863B6"
jhash (0xE4FF7103)
arguments {
Hash "componentHash" [=[ {} ]=],
int "variantComponentIndex" [=[ {} ]=],
HashPtr "nameHash" [=[ {"cs_type":"AnyPtr"} ]=],
intPtr "enumValue" [=[ {"cs_type":"AnyPtr"} ]=],
intPtr "componentType" [=[ {"cs_type":"AnyPtr"} ]=],
}
ns "FILES"
returns "void"
doc [[!
]]
native "INIT_SHOP_PED_COMPONENT"
hash "0x1E8C308FD312C036"
jhash (0xB818C7FC)
arguments {
intPtr "outComponent" [=[ {} ]=],
}
ns "FILES"
returns "void"
doc [[!
]]
native "INIT_SHOP_PED_PROP"
hash "0xEB0A2B758F7B850F"
jhash (0xF5659E50)
arguments {
intPtr "outProp" [=[ {} ]=],
}
ns "FILES"
returns "void"
doc [[!
]]
native "IS_CONTENT_ITEM_LOCKED"
hash "0xD4D7B033C3AA243C"
jhash (0x06396058)
arguments {
Hash "itemHash" [=[ {"cs_type":"AnyPtr"} ]=],
}
alias "_IS_OUTFIT_EMPTY"
alias "_IS_DLC_DATA_EMPTY"
ns "FILES"
returns "BOOL"
doc [[!
]]
native "IS_DLC_VEHICLE_MOD"
hash "0x0564B9FF9631B82C"
jhash (0x35BCA844)
arguments {
Hash "hash" [=[ {"cs_type":"Any"} ]=],
}
alias "0x0564B9FF9631B82C"
ns "FILES"
returns "BOOL"
doc [[!
]]
native "SETUP_SHOP_PED_APPAREL_QUERY"
hash "0x50F457823CE6EB5F"
jhash (0xC937FF3D)
arguments {
int "p0" [=[ {} ]=],
int "p1" [=[ {} ]=],
int "p2" [=[ {} ]=],
int "p3" [=[ {} ]=],
}
alias "0x50F457823CE6EB5F"
ns "FILES"
returns "int"
doc [[!
]]
native "SETUP_SHOP_PED_APPAREL_QUERY_TU"
hash "0x9BDF59818B1E38C1"
jhash (0x594E862C)
arguments {
int "character" [=[ {} ]=],
int "p1" [=[ {} ]=],
int "p2" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
int "p4" [=[ {} ]=],
int "componentId" [=[ {} ]=],
}
alias "_GET_NUM_PROPS_FROM_OUTFIT"
ns "FILES"
returns "int"
doc [[!
```
character is 0 for Michael, 1 for Franklin, 2 for Trevor, 3 for freemode male, and 4 for freemode female.
componentId is between 0 and 11 and corresponds to the usual component slots.
p1 could be the outfit number; unsure.
p2 is usually -1; unknown function.
p3 appears to be for selecting between clothes and props; false is used with components/clothes, true is used with props.
p4 is usually -1; unknown function.
componentId is -1 when p3 is true in decompiled scripts.
```
]]
native "SETUP_SHOP_PED_OUTFIT_QUERY"
hash "0xF3FBE2D50A6A8C28"
jhash (0x1ECD23E7)
arguments {
int "character" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
alias "0xF3FBE2D50A6A8C28"
ns "FILES"
returns "int"
doc [[!
```
characters
0: Michael
1: Franklin
2: Trevor
3: MPMale
4: MPFemale
```
]]
native "_GET_DLC_WEAPON_COMPONENT_DATA_SP"
hash "0x31D5E073B6F93CDC"
arguments {
int "dlcWeaponIndex" [=[ {} ]=],
int "dlcWeapCompIndex" [=[ {} ]=],
intPtr "ComponentDataPtr" [=[ {} ]=],
}
ns "FILES"
returns "BOOL"
doc [[!
Same as GET_DLC_WEAPON_COMPONENT_DATA but only works for DLC components that are available in SP.
```
NativeDB Introduced: v2060
```
]]
native "_GET_DLC_WEAPON_DATA_SP"
hash "0x310836EE7129BA33"
arguments {
int "dlcWeaponIndex" [=[ {} ]=],
intPtr "outData" [=[ {} ]=],
}
ns "FILES"
returns "BOOL"
doc [[!
Same as GET_DLC_WEAPON_DATA but only works for DLC weapons that are available in SP.
```
NativeDB Introduced: v2060
```
]]
native "_GET_NUM_DLC_WEAPON_COMPONENTS_SP"
hash "0xAD2A7A6DFF55841B"
arguments {
int "dlcWeaponIndex" [=[ {} ]=],
}
ns "FILES"
returns "int"
doc [[!
Returns the total number of DLC weapon components that are available in SP.
```
NativeDB Introduced: v2060
```
]]
native "_GET_NUM_DLC_WEAPONS_SP"
hash "0x4160B65AE085B5A9"
ns "FILES"
returns "int"
doc [[!
Returns the total number of DLC weapons that are available in SP (availableInSP field in shop_weapon.meta).
```
NativeDB Introduced: v2060
```
]]
native "_GET_SHOP_PED_APPAREL_VARIANT_PROP_COUNT"
hash "0xD40AAC51E8E4C663"
arguments {
Hash "propHash" [=[ {} ]=],
}
alias "0xD40AAC51E8E4C663"
ns "FILES"
returns "int"
doc [[!
Ped helmet prop hash
This native returns 1 when the player helmet has a visor (there is another prop index for the same helmet with closed/opened visor variant) that can be toggled. 0 if there's no alternative version with a visor for this helmet prop.
]]
native "_GET_VARIANT_PROP"
hash "0xD81B7F27BC773E66"
arguments {
Hash "componentHash" [=[ {"cs_type":"Any"} ]=],
int "variantPropIndex" [=[ {} ]=],
HashPtr "nameHash" [=[ {"cs_type":"Any"} ]=],
intPtr "enumValue" [=[ {"cs_type":"Any"} ]=],
intPtr "anchorPoint" [=[ {"cs_type":"Any"} ]=],
}
alias "0xD81B7F27BC773E66"
ns "FILES"
returns "void"
doc [[!
]]
native "_LOAD_CONTENT_CHANGE_SET_GROUP"
hash "0x6BEDF5769AC2DC07"
arguments {
Hash "hash" [=[ {} ]=],
}
ns "FILES"
returns "void"
doc [[!
```
From fm_deathmatch_creator and fm_race_creator:
FILES::_UNLOAD_CONTENT_CHANGE_SET_GROUP(joaat("GROUP_MAP_SP"));
FILES::_LOAD_CONTENT_CHANGE_SET_GROUP(joaat("GROUP_MAP"));
NativeDB Introduced: v1604
```
]]
native "_UNLOAD_CONTENT_CHANGE_SET_GROUP"
hash "0x3C1978285B036B25"
arguments {
Hash "hash" [=[ {} ]=],
}
ns "FILES"
returns "void"
doc [[!
```
From fm_deathmatch_creator and fm_race_creator:
FILES::_UNLOAD_CONTENT_CHANGE_SET_GROUP(joaat("GROUP_MAP_SP"));
FILES::_LOAD_CONTENT_CHANGE_SET_GROUP(joaat("GROUP_MAP"));
NativeDB Introduced: v1604
```
]]
native "0x6CEBE002E58DEE97"
hash "0x6CEBE002E58DEE97"
arguments {
Hash "componentHash" [=[ {} ]=],
}
ns "FILES"
returns "int"
doc [[!
Returns some sort of index/offset for props.
Needs \_GET_NUM_PROPS_FROM_OUTFIT to be called with p3 = true and componentId = -1 first, returns -1 otherwise.
```
NativeDB Introduced: v2189
```
]]
native "0x96E2929292A4DB77"
hash "0x96E2929292A4DB77"
arguments {
Hash "componentHash" [=[ {} ]=],
}
ns "FILES"
returns "int"
doc [[!
Returns some sort of index/offset for components.
Needs \_GET_NUM_PROPS_FROM_OUTFIT to be called with p3 = false and componentId with the drawable's component slot first, returns -1 otherwise.
```
NativeDB Introduced: v2189
```
]]
native "ADD_EXPLOSION"
hash "0xE3AD2BDBAEE269AC"
jhash (0x10AF5258)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
int "explosionType" [=[ {} ]=],
float "damageScale" [=[ {} ]=],
BOOL "isAudible" [=[ {} ]=],
BOOL "isInvisible" [=[ {} ]=],
float "cameraShake" [=[ {} ]=],
}
ns "FIRE"
returns "void"
doc [[!
```
NativeDB Added Parameter 9: BOOL noDamage
```
```
BOOL isAudible = If explosion makes a sound.
BOOL isInvisible = If the explosion is invisible or not.
BOOL noDamage = false: damage || nodamage = true: no damage
```
```cpp
enum eExplosionTag
{
DONTCARE = -1,
GRENADE = 0,
GRENADELAUNCHER = 1,
STICKYBOMB = 2,
MOLOTOV = 3,
ROCKET = 4,
TANKSHELL = 5,
HI_OCTANE = 6,
CAR = 7,
PLANE = 8,
PETROL_PUMP = 9,
BIKE = 10,
DIR_STEAM = 11,
DIR_FLAME = 12,
DIR_WATER_HYDRANT = 13,
DIR_GAS_CANISTER = 14,
BOAT = 15,
SHIP_DESTROY = 16,
TRUCK = 17,
BULLET = 18,
SMOKE_GRENADE_LAUNCHER = 19,
SMOKE_GRENADE = 20,
BZGAS = 21,
FLARE = 22,
GAS_CANISTER = 23,
EXTINGUISHER = 24,
PROGRAMMABLEAR = 25,
TRAIN = 26,
BARREL = 27,
PROPANE = 28,
BLIMP = 29,
DIR_FLAME_EXPLODE = 30,
TANKER = 31,
PLANE_ROCKET = 32,
VEHICLE_BULLET = 33,
GAS_TANK = 34,
BIRD_CRAP = 35,
RAILGUN = 36,
BLIMP2 = 37,
FIREWORK = 38,
SNOWBALL = 39,
PROXMINE = 40,
VALKYRIE_CANNON = 41,
AIR_DEFENCE = 42,
PIPEBOMB = 43,
VEHICLEMINE = 44,
EXPLOSIVEAMMO = 45,
APCSHELL = 46,
BOMB_CLUSTER = 47,
BOMB_GAS = 48,
BOMB_INCENDIARY = 49,
BOMB_STANDARD = 50,
TORPEDO = 51,
TORPEDO_UNDERWATER = 52,
BOMBUSHKA_CANNON = 53,
BOMB_CLUSTER_SECONDARY = 54,
HUNTER_BARRAGE = 55,
HUNTER_CANNON = 56,
ROGUE_CANNON = 57,
MINE_UNDERWATER = 58,
ORBITAL_CANNON = 59,
BOMB_STANDARD_WIDE = 60,
EXPLOSIVEAMMO_SHOTGUN = 61,
OPPRESSOR2_CANNON = 62,
MORTAR_KINETIC = 63,
VEHICLEMINE_KINETIC = 64,
VEHICLEMINE_EMP = 65,
VEHICLEMINE_SPIKE = 66,
VEHICLEMINE_SLICK = 67,
VEHICLEMINE_TAR = 68,
SCRIPT_DRONE = 69,
RAYGUN = 70,
BURIEDMINE = 71,
SCRIPT_MISSILE = 72,
RCTANK_ROCKET = 73,
BOMB_WATER = 74,
BOMB_WATER_SECONDARY = 75,
MINE_CNCSPIKE = 76,
BZGAS_MK2 = 77,
FLASHGRENADE = 78,
STUNGRENADE = 79,
CNC_KINETICRAM = 80,
SCRIPT_MISSILE_LARGE = 81,
SUBMARINE_BIG = 82,
EMPLAUNCHER_EMP = 83
};
```
]]
native "ADD_EXPLOSION_WITH_USER_VFX"
hash "0x36DD3FE58B5E5212"
jhash (0xCF358946)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
int "explosionType" [=[ {} ]=],
Hash "explosionFx" [=[ {} ]=],
float "damageScale" [=[ {} ]=],
BOOL "isAudible" [=[ {} ]=],
BOOL "isInvisible" [=[ {} ]=],
float "cameraShake" [=[ {} ]=],
}
alias "_ADD_SPECFX_EXPLOSION"
ns "FIRE"
returns "void"
doc [[!
See [`ADD_EXPLOSION`](#\_0xE3AD2BDBAEE269AC).
If explosion makes a sound.
If the explosion is invisible or not.
]]
native "ADD_OWNED_EXPLOSION"
hash "0x172AA1B624FA1013"
jhash (0x27EE0D67)
arguments {
Ped "ped" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
int "explosionType" [=[ {} ]=],
float "damageScale" [=[ {} ]=],
BOOL "isAudible" [=[ {} ]=],
BOOL "isInvisible" [=[ {} ]=],
float "cameraShake" [=[ {} ]=],
}
ns "FIRE"
returns "void"
doc [[!
See [`ADD_EXPLOSION`](#\_0xE3AD2BDBAEE269AC).
If explosion makes a sound.
If the explosion is invisible or not.
]]
native "GET_CLOSEST_FIRE_POS"
hash "0x352A9F6BCF90081F"
jhash (0xC4977B47)
arguments {
Vector3Ptr "outPosition" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
ns "FIRE"
returns "BOOL"
doc [[!
```
Returns TRUE if it found something. FALSE if not.
```
]]
native "GET_NUMBER_OF_FIRES_IN_RANGE"
hash "0x50CAD495A460B305"
jhash (0x654D93B7)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "radius" [=[ {} ]=],
}
ns "FIRE"
returns "int"
doc [[!
]]
native "IS_ENTITY_ON_FIRE"
hash "0x28D3FED7190D3A0B"
jhash (0x8C73E64F)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "FIRE"
returns "BOOL"
doc [[!
]]
native "IS_EXPLOSION_ACTIVE_IN_AREA"
hash "0x6070104B699B2EF4"
jhash (0x37C388DB)
arguments {
int "explosionType" [=[ {} ]=],
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
}
alias "0x6070104B699B2EF4"
ns "FIRE"
returns "BOOL"
doc [[!
See [`ADD_EXPLOSION`](#\_0xE3AD2BDBAEE269AC).
]]
native "IS_EXPLOSION_IN_ANGLED_AREA"
hash "0xA079A6C51525DC4B"
jhash (0x0128FED9)
arguments {
int "explosionType" [=[ {} ]=],
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
float "width" [=[ {} ]=],
}
ns "FIRE"
returns "BOOL"
doc [[!
See [`IS_POINT_IN_ANGLED_AREA`](#\_0x2A70BAE8883E4C81) for the definition of an angled area.
explosion enum, -1 for any explosion type. See [ADD_EXPLOSION](#\_0xE3AD2BDBAEE269AC).
X dimension of the angled area 'origin'
Y dimension of the angled area 'origin'
Z dimension of the angled area 'origin'
X dimension of the angled area 'extent'
Y dimension of the angled area 'extent'
Z dimension of the angled area 'extent'
Width of the angled area
]]
native "IS_EXPLOSION_IN_AREA"
hash "0x2E2EBA0EE7CED0E0"
jhash (0xFB40075B)
arguments {
int "explosionType" [=[ {} ]=],
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
}
ns "FIRE"
returns "BOOL"
doc [[!
See [`ADD_EXPLOSION`](#\_0xE3AD2BDBAEE269AC).
]]
native "IS_EXPLOSION_IN_SPHERE"
hash "0xAB0F816885B0E483"
jhash (0xD455A7F3)
arguments {
int "explosionType" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "radius" [=[ {} ]=],
}
ns "FIRE"
returns "BOOL"
doc [[!
See [`ADD_EXPLOSION`](#\_0xE3AD2BDBAEE269AC).
]]
native "REMOVE_SCRIPT_FIRE"
hash "0x7FF548385680673F"
jhash (0x6B21FE26)
arguments {
FireId "fireHandle" [=[ {} ]=],
}
ns "FIRE"
returns "void"
doc [[!
]]
native "START_ENTITY_FIRE"
hash "0xF6A9D9708F6F23DF"
jhash (0x8928428E)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "FIRE"
returns "FireId"
doc [[!
]]
native "START_SCRIPT_FIRE"
hash "0x6B83617E04503888"
jhash (0xE7529357)
arguments {
float "X" [=[ {} ]=],
float "Y" [=[ {} ]=],
float "Z" [=[ {} ]=],
int "maxChildren" [=[ {} ]=],
BOOL "isGasFire" [=[ {} ]=],
}
ns "FIRE"
returns "FireId"
doc [[!
```
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.
```
]]
native "STOP_ENTITY_FIRE"
hash "0x7F0DD2EBBB651AFF"
jhash (0xCE8C9066)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "FIRE"
returns "void"
doc [[!
]]
native "STOP_FIRE_IN_RANGE"
hash "0x056A8A219B8E829F"
jhash (0x725C7205)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "radius" [=[ {} ]=],
}
ns "FIRE"
returns "void"
doc [[!
]]
native "_GET_ENTITY_INSIDE_EXPLOSION_AREA"
hash "0x14BA4BA137AF6CEC"
jhash (0xAEC0D176)
arguments {
int "explosionType" [=[ {} ]=],
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
float "radius" [=[ {} ]=],
}
alias "_GET_PED_INSIDE_EXPLOSION_AREA"
ns "FIRE"
returns "Entity"
doc [[!
```
Returns a handle to the first entity within the a circle spawned inside the 2 points from a radius.
```
See [`ADD_EXPLOSION`](#\_0xE3AD2BDBAEE269AC).
]]
native "_GET_ENTITY_INSIDE_EXPLOSION_SPHERE"
hash "0xB3CD51E3DB86F176"
arguments {
int "explosionType" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "radius" [=[ {} ]=],
}
ns "FIRE"
returns "Entity"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "_SET_FIRE_SPREAD_RATE"
hash "0x8F390AC4155099BA"
arguments {
float "p0" [=[ {} ]=],
}
ns "FIRE"
returns "void"
doc [[!
SET_FIRE_\*
```
NativeDB Introduced: v1734
```
]]
native "ACTIVATE_INTERIOR_ENTITY_SET"
hash "0x55E86AF2712B36A1"
jhash (0xC80A5DDF)
arguments {
int "interior" [=[ {} ]=],
charPtr "entitySetName" [=[ {} ]=],
}
alias "0x55E86AF2712B36A1"
alias "_ENABLE_INTERIOR_PROP"
ns "INTERIOR"
returns "void"
doc [[!
```
More info: http://gtaforums.com/topic/836367-adding-props-to-interiors/
```
]]
native "ADD_PICKUP_TO_INTERIOR_ROOM_BY_NAME"
hash "0x3F6167F351168730"
jhash (0xA2A73564)
arguments {
Pickup "pickup" [=[ {} ]=],
charPtr "roomName" [=[ {} ]=],
}
ns "INTERIOR"
returns "void"
doc [[!
]]
native "CAP_INTERIOR"
hash "0xD9175F941610DB54"
jhash (0x34E735A6)
arguments {
int "interiorID" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "INTERIOR"
returns "void"
doc [[!
```
Does something similar to INTERIOR::DISABLE_INTERIOR
```
]]
native "CLEAR_ROOM_FOR_ENTITY"
hash "0xB365FC0C4E27FFA7"
jhash (0x7DDADB92)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "INTERIOR"
returns "void"
doc [[!
]]
native "CLEAR_ROOM_FOR_GAME_VIEWPORT"
hash "0x23B59D8912F94246"
jhash (0x617DC75D)
alias "0x23B59D8912F94246"
ns "INTERIOR"
returns "void"
doc [[!
]]
native "DEACTIVATE_INTERIOR_ENTITY_SET"
hash "0x420BD37289EEE162"
jhash (0xDBA768A1)
arguments {
int "interior" [=[ {} ]=],
charPtr "entitySetName" [=[ {} ]=],
}
alias "0x420BD37289EEE162"
alias "_DISABLE_INTERIOR_PROP"
ns "INTERIOR"
returns "void"
doc [[!
]]
native "DISABLE_INTERIOR"
hash "0x6170941419D7D8EC"
jhash (0x093ADEA5)
arguments {
int "interiorID" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "INTERIOR"
returns "void"
doc [[!
```
Example:
This removes the interior from the strip club and when trying to walk inside the player just falls:
INTERIOR::DISABLE_INTERIOR(118018, true);
```
]]
native "ENABLE_EXTERIOR_CULL_MODEL_THIS_FRAME"
hash "0xA97F257D0151A6AB"
jhash (0x1F375B4C)
arguments {
Hash "mapObjectHash" [=[ {} ]=],
}
alias "0xA97F257D0151A6AB"
alias "_HIDE_MAP_OBJECT_THIS_FRAME"
ns "INTERIOR"
returns "void"
doc [[!
```
This is the native that is used to hide the exterior of GTA Online apartment buildings when you are inside an apartment.
```
]]
native "FORCE_ROOM_FOR_ENTITY"
hash "0x52923C4710DD9907"
jhash (0x10BD4435)
arguments {
Entity "entity" [=[ {} ]=],
int "interior" [=[ {} ]=],
Hash "roomHashKey" [=[ {} ]=],
}
ns "INTERIOR"
returns "void"
doc [[!
```
Forces the particular room in an interior to load incase not teleporting into the portal.
```
]]
native "FORCE_ROOM_FOR_GAME_VIEWPORT"
hash "0x920D853F3E17F1DA"
jhash (0xD79803B5)
arguments {
int "interiorID" [=[ {} ]=],
Hash "roomHashKey" [=[ {} ]=],
}
alias "0x920D853F3E17F1DA"
ns "INTERIOR"
returns "void"
doc [[!
]]
native "GET_INTERIOR_AT_COORDS"
hash "0xB0F7F8663821D9C3"
jhash (0xA17FBF37)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
ns "INTERIOR"
returns "int"
doc [[!
```
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)
```
]]
native "GET_INTERIOR_AT_COORDS_WITH_TYPE"
hash "0x05B7A89BD78797FC"
jhash (0x96525B06)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
charPtr "interiorType" [=[ {} ]=],
}
alias "0x05B7A89BD78797FC"
ns "INTERIOR"
returns "int"
doc [[!
```
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.
```
]]
native "GET_INTERIOR_AT_COORDS_WITH_TYPEHASH"
hash "0xF0F77ADB9F67E79D"
jhash (0x11718507)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
Hash "typeHash" [=[ {"cs_type":"int"} ]=],
}
alias "0xF0F77ADB9F67E79D"
alias "_UNK_GET_INTERIOR_AT_COORDS"
ns "INTERIOR"
returns "int"
doc [[!
```
Hashed version of GET_INTERIOR_AT_COORDS_WITH_TYPE
```
]]
native "GET_INTERIOR_FROM_COLLISION"
hash "0xEC4CF9FCB29A4424"
jhash (0x7ED33DC1)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
ns "INTERIOR"
returns "int"
doc [[!
]]
native "GET_INTERIOR_FROM_ENTITY"
hash "0x2107BA504071A6BB"
jhash (0x5C644614)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "INTERIOR"
returns "int"
doc [[!
```
Returns the handle of the interior that the entity is in. Returns 0 if outside.
```
]]
native "GET_INTERIOR_FROM_PRIMARY_VIEW"
hash "0xE7D267EC6CA966C3"
jhash (0xA83C3D15)
alias "0xE7D267EC6CA966C3"
alias "_GET_INTERIOR_FROM_GAMEPLAY_CAM"
ns "INTERIOR"
returns "int"
doc [[!
```
NativeDB Introduced: v1604
```
]]
native "GET_INTERIOR_GROUP_ID"
hash "0xE4A84ABF135EF91A"
jhash (0x09D6376F)
arguments {
int "interior" [=[ {} ]=],
}
ns "INTERIOR"
returns "int"
doc [[!
```
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.
```
]]
native "GET_INTERIOR_HEADING"
hash "0xF49B58631D9E22D9"
arguments {
int "interior" [=[ {} ]=],
}
alias "_GET_INTERIOR_HEADING"
ns "INTERIOR"
returns "float"
doc [[!
```
NativeDB Introduced: v1493
```
ID of the interior
Returns interior heading in radians. Multiply the returned value with 57.29578 (or 180.0 / math.pi) to convert it to degrees.
]]
native "GET_INTERIOR_LOCATION_AND_NAMEHASH"
hash "0x252BDC06B73FA6EA"
jhash (0x75885CB3)
arguments {
int "interior" [=[ {} ]=],
Vector3Ptr "position" [=[ {} ]=],
HashPtr "nameHash" [=[ {} ]=],
}
alias "0x252BDC06B73FA6EA"
alias "_GET_INTERIOR_INFO"
ns "INTERIOR"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "GET_KEY_FOR_ENTITY_IN_ROOM"
hash "0x399685DB942336BC"
jhash (0x91EA80EF)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "INTERIOR"
returns "Hash"
doc [[!
```
Seems to do the exact same as INTERIOR::GET_ROOM_KEY_FROM_ENTITY
```
]]
native "GET_OFFSET_FROM_INTERIOR_IN_WORLD_COORDS"
hash "0x9E3B3E6D66F6E22F"
jhash (0x7D8F26A1)
arguments {
int "interior" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
ns "INTERIOR"
returns "Vector3"
doc [[!
]]
native "GET_ROOM_KEY_FOR_GAME_VIEWPORT"
hash "0xA6575914D2A0B450"
jhash (0x4FF3D3F5)
alias "0xA6575914D2A0B450"
alias "_GET_ROOM_KEY_FROM_GAMEPLAY_CAM"
ns "INTERIOR"
returns "Hash"
doc [[!
]]
native "GET_ROOM_KEY_FROM_ENTITY"
hash "0x47C2A06D4F5F424B"
jhash (0xE4ACF8C3)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "INTERIOR"
returns "Hash"
doc [[!
```
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.
```
]]
native "IS_COLLISION_MARKED_OUTSIDE"
hash "0xEEA5AC2EDA7C33E8"
jhash (0x7762249C)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
alias "0xEEA5AC2EDA7C33E8"
alias "_ARE_COORDS_COLLIDING_WITH_EXTERIOR"
ns "INTERIOR"
returns "BOOL"
doc [[!
Returns true if the collision at the specified coords is marked as being outside (false if there's an interior)
]]
native "IS_INTERIOR_CAPPED"
hash "0x92BAC8ACF88CEC26"
jhash (0x18B17C80)
arguments {
int "interiorID" [=[ {} ]=],
}
ns "INTERIOR"
returns "BOOL"
doc [[!
]]
native "IS_INTERIOR_DISABLED"
hash "0xBC5115A5A939DD15"
jhash (0x81F34C71)
arguments {
int "interior" [=[ {} ]=],
}
ns "INTERIOR"
returns "BOOL"
doc [[!
]]
native "IS_INTERIOR_ENTITY_SET_ACTIVE"
hash "0x35F7DD45E8C0A16D"
jhash (0x39A3CC6F)
arguments {
int "interior" [=[ {} ]=],
charPtr "entitySetName" [=[ {} ]=],
}
alias "0x35F7DD45E8C0A16D"
alias "_IS_INTERIOR_PROP_ENABLED"
ns "INTERIOR"
returns "BOOL"
doc [[!
]]
native "IS_INTERIOR_READY"
hash "0x6726BDCCC1932F0E"
jhash (0xE1EF6450)
arguments {
int "interiorID" [=[ {} ]=],
}
ns "INTERIOR"
returns "BOOL"
doc [[!
]]
native "IS_INTERIOR_SCENE"
hash "0xBC72B5D7A1CBD54D"
jhash (0x55226C13)
ns "INTERIOR"
returns "BOOL"
doc [[!
]]
native "IS_VALID_INTERIOR"
hash "0x26B0E73D7EAAF4D3"
jhash (0x39C0B635)
arguments {
int "interior" [=[ {} ]=],
}
ns "INTERIOR"
returns "BOOL"
doc [[!
]]
native "PIN_INTERIOR_IN_MEMORY"
hash "0x2CA429C029CCF247"
jhash (0x3ADA414E)
arguments {
int "interior" [=[ {} ]=],
}
alias "0x2CA429C029CCF247"
alias "_LOAD_INTERIOR"
ns "INTERIOR"
returns "void"
doc [[!
]]
native "REFRESH_INTERIOR"
hash "0x41F37C3427C75AE0"
jhash (0x9A29ACE6)
arguments {
int "interiorID" [=[ {} ]=],
}
ns "INTERIOR"
returns "void"
doc [[!
]]
native "UNPIN_INTERIOR"
hash "0x261CCE7EED010641"
jhash (0xFCFF792A)
arguments {
int "interior" [=[ {} ]=],
}
ns "INTERIOR"
returns "void"
doc [[!
```
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.
```
]]
native "_CLEAR_INTERIOR_FOR_ENTITY"
hash "0x85D5422B2039A70D"
arguments {
Entity "entity" [=[ {} ]=],
}
ns "INTERIOR"
returns "void"
doc [[!
Immediately removes entity from an interior. Like sets entity to `limbo` room.
```
NativeDB Introduced: v2189
```
]]
native "_ENABLE_SCRIPT_CULL_MODEL_THIS_FRAME"
hash "0x50C375537449F369"
arguments {
Hash "mapObjectHash" [=[ {"cs_type":"Any"} ]=],
}
alias "0x50C375537449F369"
ns "INTERIOR"
returns "void"
doc [[!
]]
native "_SET_INTERIOR_ENTITY_SET_COLOR"
hash "0xC1F1920BAF281317"
arguments {
int "interior" [=[ {} ]=],
charPtr "entitySetName" [=[ {} ]=],
int "color" [=[ {} ]=],
}
alias "_SET_INTERIOR_PROP_COLOR"
ns "INTERIOR"
returns "void"
doc [[!
]]
native "0x38C1CB1CB119A016"
hash "0x38C1CB1CB119A016"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "INTERIOR"
returns "void"
doc [[!
```
NativeDB Introduced: v1493
```
]]
native "0x405DC2AEF6AF95B9"
hash "0x405DC2AEF6AF95B9"
jhash (0x0E9529CC)
arguments {
Hash "roomHashKey" [=[ {} ]=],
}
ns "INTERIOR"
returns "void"
doc [[!
```
Usage: INTERIOR::_0x405DC2AEF6AF95B9(INTERIOR::GET_KEY_FOR_ENTITY_IN_ROOM(PLAYER::PLAYER_PED_ID()));
```
]]
native "0x483ACA1176CA93F1"
hash "0x483ACA1176CA93F1"
ns "INTERIOR"
returns "void"
doc [[!
]]
native "0x4C2330E61D3DEB56"
hash "0x4C2330E61D3DEB56"
arguments {
int "interior" [=[ {} ]=],
}
ns "INTERIOR"
returns "Any"
doc [[!
```
Only used once in the entire game scripts.
Does not actually return anything.
```
]]
native "0x7241CCB7D020DB69"
hash "0x7241CCB7D020DB69"
arguments {
Entity "entity" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "INTERIOR"
returns "void"
doc [[!
```
Jenkins hash _might_ be 0xFC227584.
```
]]
native "0x7ECDF98587E92DEC"
hash "0x7ECDF98587E92DEC"
arguments {
Any "p0" [=[ {} ]=],
}
ns "INTERIOR"
returns "void"
doc [[!
```
NativeDB Introduced: v1604
```
]]
native "0x82EBB79E258FA2B7"
hash "0x82EBB79E258FA2B7"
jhash (0xE645E162)
arguments {
Entity "entity" [=[ {} ]=],
int "interiorID" [=[ {} ]=],
}
ns "INTERIOR"
returns "void"
doc [[!
]]
native "0x9E6542F0CE8E70A3"
hash "0x9E6542F0CE8E70A3"
jhash (0x5EF9C5C2)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "INTERIOR"
returns "void"
doc [[!
```
DISABLE_*
```
]]
native "0xAF348AFCB575A441"
hash "0xAF348AFCB575A441"
jhash (0x1F6B4B13)
arguments {
charPtr "roomName" [=[ {} ]=],
}
ns "INTERIOR"
returns "void"
doc [[!
```
Exemple of use(carmod_shop.c4)
INTERIOR::_AF348AFCB575A441("V_CarModRoom");
```
]]
native "ADD_TO_ITEMSET"
hash "0xE3945201F14637DD"
jhash (0x6B0FE61B)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "ITEMSET"
returns "BOOL"
doc [[!
]]
native "CLEAN_ITEMSET"
hash "0x41BC0D722FC04221"
jhash (0x919A4858)
arguments {
Any "p0" [=[ {} ]=],
}
ns "ITEMSET"
returns "void"
doc [[!
]]
native "CREATE_ITEMSET"
hash "0x35AD299F50D91B24"
jhash (0x0A113B2C)
arguments {
BOOL "distri" [=[ {"cs_type":"Vehicle"} ]=],
}
ns "ITEMSET"
returns "Vehicle"
doc [[!
]]
native "DESTROY_ITEMSET"
hash "0xDE18220B1C183EDA"
jhash (0x83CE1A4C)
arguments {
Any "p0" [=[ {} ]=],
}
ns "ITEMSET"
returns "void"
doc [[!
]]
native "GET_INDEXED_ITEM_IN_ITEMSET"
hash "0x7A197E2521EE2BAB"
jhash (0x3F712874)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "ITEMSET"
returns "Any"
doc [[!
]]
native "GET_ITEMSET_SIZE"
hash "0xD9127E83ABF7C631"
jhash (0x2B31F41A)
arguments {
ScrHandle "x" [=[ {} ]=],
}
ns "ITEMSET"
returns "Any"
doc [[!
]]
native "IS_IN_ITEMSET"
hash "0x2D0FC594D1E9C107"
jhash (0x0D4B9730)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "ITEMSET"
returns "BOOL"
doc [[!
]]
native "IS_ITEMSET_VALID"
hash "0xB1B1EA596344DFAB"
jhash (0xD201FC29)
arguments {
Any "p0" [=[ {} ]=],
}
ns "ITEMSET"
returns "BOOL"
doc [[!
]]
native "REMOVE_FROM_ITEMSET"
hash "0x25E68244B0177686"
jhash (0xA9565228)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "ITEMSET"
returns "void"
doc [[!
]]
native "_LOADINGSCREEN_GET_LOAD_FREEMODE"
hash "0xEF7D17BC6C85264C"
jhash (0xD87F3A9E)
alias "0xEF7D17BC6C85264C"
ns "LOADINGSCREEN"
returns "BOOL"
doc [[!
]]
native "_LOADINGSCREEN_GET_LOAD_FREEMODE_WITH_EVENT_NAME"
hash "0x8AA464D4E0F6ACCD"
jhash (0x94BCAC7C)
alias "0x8AA464D4E0F6ACCD"
ns "LOADINGSCREEN"
returns "BOOL"
doc [[!
]]
native "_LOADINGSCREEN_IS_LOADING_FREEMODE"
hash "0xC6DC823253FBB366"
jhash (0x734CFEDA)
alias "0xC6DC823253FBB366"
alias "_IS_UI_LOADING_MULTIPLAYER"
ns "LOADINGSCREEN"
returns "BOOL"
doc [[!
]]
native "_LOADINGSCREEN_SET_IS_LOADING_FREEMODE"
hash "0xC7E7181C09F33B69"
jhash (0x8C227332)
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0xC7E7181C09F33B69"
ns "LOADINGSCREEN"
returns "void"
doc [[!
]]
native "_LOADINGSCREEN_SET_LOAD_FREEMODE"
hash "0xB0C56BD3D808D863"
jhash (0xC0B971EA)
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "_GET_BROADCAST_FINSHED_LOS_SOUND"
alias "0xB0C56BD3D808D863"
ns "LOADINGSCREEN"
returns "void"
doc [[!
]]
native "_LOADINGSCREEN_SET_LOAD_FREEMODE_WITH_EVENT_NAME"
hash "0xFC309E94546FCDB5"
jhash (0x7D90EEE5)
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0xFC309E94546FCDB5"
alias "_IS_IN_LOADING_SCREEN"
ns "LOADINGSCREEN"
returns "void"
doc [[!
```
Only occurrence was false, in maintransition.
```
]]
native "0xF2CA003F167E21D2"
hash "0xF2CA003F167E21D2"
jhash (0x106C8317)
alias "_RETURN_ZERO"
ns "LOADINGSCREEN"
returns "int"
doc [[!
Hard-coded to always return 0.
]]
native "0xFA1E0E893D915215"
hash "0xFA1E0E893D915215"
jhash (0x5C350D78)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "LOADINGSCREEN"
returns "void"
doc [[!
]]
native "GET_CURRENT_LANGUAGE"
hash "0x2BDD44CC428A7EAE"
jhash (0x761BE00B)
alias "_GET_UI_LANGUAGE_ID"
alias "_GET_CURRENT_LANGUAGE_ID"
ns "LOCALIZATION"
returns "int"
doc [[!
```
0 = american (en-US)
1 = french (fr-FR)
2 = german (de-DE)
3 = italian (it-IT)
4 = spanish (es-ES)
5 = brazilian (pt-BR)
6 = polish (pl-PL)
7 = russian (ru-RU)
8 = korean (ko-KR)
9 = chinesetrad (zh-TW)
10 = japanese (ja-JP)
11 = mexican (es-MX)
12 = chinesesimp (zh-CN)
```
]]
native "_LOCALIZATION_GET_SYSTEM_DATE_FORMAT"
hash "0xA8AE43AEC1A61314"
alias "_GET_USER_LANGUAGE_ID"
ns "LOCALIZATION"
returns "int"
doc [[!
```
Possible return values: 0, 1, 2
```
]]
native "_LOCALIZATION_GET_SYSTEM_LANGUAGE"
hash "0x497420E022796B3F"
alias "0x497420E022796B3F"
ns "LOCALIZATION"
returns "int"
doc [[!
```
Same return values as GET_CURRENT_LANGUAGE
```
]]
native "ADD_DECAL"
hash "0xB302244A1839BDAD"
jhash (0xEAD0C412)
arguments {
int "decalType" [=[ {} ]=],
float "posX" [=[ {} ]=],
float "posY" [=[ {} ]=],
float "posZ" [=[ {} ]=],
float "dirX" [=[ {} ]=],
float "dirY" [=[ {} ]=],
float "dirZ" [=[ {} ]=],
float "sideX" [=[ {} ]=],
float "sideY" [=[ {} ]=],
float "sideZ" [=[ {} ]=],
float "width" [=[ {} ]=],
float "height" [=[ {} ]=],
float "rCoef" [=[ {} ]=],
float "gCoef" [=[ {} ]=],
float "bCoef" [=[ {} ]=],
float "opacity" [=[ {} ]=],
float "timeout" [=[ {} ]=],
BOOL "isLongRange" [=[ {} ]=],
BOOL "isDynamic" [=[ {} ]=],
BOOL "useComplexColn" [=[ {} ]=],
}
ns "GRAPHICS"
returns "int"
doc [[!
Places a decal into the world
```cs
public enum DecalTypes
{
splatters_blood = 1010,
splatters_blood_dir = 1015,
splatters_blood_mist = 1017,
splatters_mud = 1020,
splatters_paint = 1030,
splatters_water = 1040,
splatters_water_hydrant = 1050,
splatters_blood2 = 1110,
weapImpact_metal = 4010,
weapImpact_concrete = 4020,
weapImpact_mattress = 4030,
weapImpact_mud = 4032,
weapImpact_wood = 4050,
weapImpact_sand = 4053,
weapImpact_cardboard = 4040,
weapImpact_melee_glass = 4100,
weapImpact_glass_blood = 4102,
weapImpact_glass_blood2 = 4104,
weapImpact_shotgun_paper = 4200,
weapImpact_shotgun_mattress,
weapImpact_shotgun_metal,
weapImpact_shotgun_wood,
weapImpact_shotgun_dirt,
weapImpact_shotgun_tvscreen,
weapImpact_shotgun_tvscreen2,
weapImpact_shotgun_tvscreen3,
weapImpact_melee_concrete = 4310,
weapImpact_melee_wood = 4312,
weapImpact_melee_metal = 4314,
burn1 = 4421,
burn2,
burn3,
burn4,
burn5,
bang_concrete_bang = 5000,
bang_concrete_bang2,
bang_bullet_bang,
bang_bullet_bang2 = 5004,
bang_glass = 5031,
bang_glass2,
solidPool_water = 9000,
solidPool_blood,
solidPool_oil,
solidPool_petrol,
solidPool_mud,
porousPool_water,
porousPool_blood,
porousPool_oil,
porousPool_petrol,
porousPool_mud,
porousPool_water_ped_drip,
liquidTrail_water = 9050
}
```
which type of decal to place, based on the ID, see `DecalTypes` enum.
X position coordinate.
Y position coordinate.
Z position coordinate.
X Orientation.
Y Orientation.
Z Orientation.
Usually set to 0.
Usually set to 1.
Usually set to 0.
Width of the decal.
Height of the decal.
Red Color.
Green Color.
Blue Color.
Alpha Color.
The lifetime of the decal.
toggle further LOD draw distance.
toggle dynamics.
use complex coloring.
An integer value representing the added decal index, will return `0` if the decal cannot be added.
]]
native "ADD_ENTITY_ICON"
hash "0x9CD43EEE12BF4DD0"
jhash (0xF3027D21)
arguments {
Entity "entity" [=[ {} ]=],
charPtr "icon" [=[ {} ]=],
}
ns "GRAPHICS"
returns "Any"
doc [[!
```
Example:
GRAPHICS::ADD_ENTITY_ICON(a_0, "MP_Arrow");
I tried this and nothing happened...
```
]]
native "ADD_PETROL_DECAL"
hash "0x4F5212C7AD880DF8"
jhash (0x1259DF42)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "groundLvl" [=[ {} ]=],
float "width" [=[ {} ]=],
float "transparency" [=[ {} ]=],
}
ns "GRAPHICS"
returns "int"
doc [[!
]]
native "ADD_PETROL_TRAIL_DECAL_INFO"
hash "0x967278682CB6967A"
jhash (0xBAEC6ADD)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "p3" [=[ {} ]=],
}
alias "0x967278682CB6967A"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "ADD_TCMODIFIER_OVERRIDE"
hash "0x1A8E2C8B9CF4549C"
jhash (0xE8F538B5)
arguments {
charPtr "modifierName1" [=[ {} ]=],
charPtr "modifierName2" [=[ {} ]=],
}
alias "0x1A8E2C8B9CF4549C"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "ADD_VEHICLE_CREW_EMBLEM"
hash "0x428BDCB9DA58DA53"
jhash (0x12077738)
arguments {
Vehicle "vehicle" [=[ {} ]=],
Ped "ped" [=[ {} ]=],
int "boneIndex" [=[ {} ]=],
float "x1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "x3" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "y3" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "z2" [=[ {} ]=],
float "z3" [=[ {} ]=],
float "scale" [=[ {} ]=],
Any "p13" [=[ {} ]=],
int "alpha" [=[ {} ]=],
}
alias "_ADD_CLAN_DECAL_TO_VEHICLE"
ns "GRAPHICS"
returns "BOOL"
doc [[!
```
boneIndex is always chassis_dummy in the scripts. The x/y/z params are location relative to the chassis bone.
```
]]
native "ANIMPOSTFX_IS_RUNNING"
hash "0x36AD3E690DA5ACEB"
jhash (0x089D5921)
arguments {
charPtr "effectName" [=[ {} ]=],
}
alias "_GET_SCREEN_EFFECT_IS_ACTIVE"
ns "GRAPHICS"
returns "BOOL"
doc [[!
See [`ANIMPOSTFX_PLAY`](#\_0x2206BF9A37B7F724).
Whether the specified effect is active
]]
native "ANIMPOSTFX_PLAY"
hash "0x2206BF9A37B7F724"
jhash (0x1D980479)
arguments {
charPtr "effectName" [=[ {} ]=],
int "duration" [=[ {} ]=],
BOOL "looped" [=[ {} ]=],
}
alias "_START_SCREEN_EFFECT"
ns "GRAPHICS"
returns "void"
doc [[!
```
duration - is how long to play the effect for in milliseconds. If 0, it plays the default length
if loop is true, the effect won't stop until you call ANIMPOSTFX_STOP on it. (only loopable effects)
```
]]
native "ANIMPOSTFX_STOP"
hash "0x068E835A1D0DC0E3"
jhash (0x06BB5CDA)
arguments {
charPtr "effectName" [=[ {} ]=],
}
alias "_STOP_SCREEN_EFFECT"
ns "GRAPHICS"
returns "void"
doc [[!
See [`ANIMPOSTFX_PLAY`](#\_0x2206BF9A37B7F724).
]]
native "ANIMPOSTFX_STOP_ALL"
hash "0xB4EDDC19532BFB85"
jhash (0x4E6D875B)
alias "_STOP_ALL_SCREEN_EFFECTS"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "ATTACH_TV_AUDIO_TO_ENTITY"
hash "0x845BAD77CC770633"
jhash (0x784944DB)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
Might be more appropriate in AUDIO?
```
]]
native "BEGIN_SCALEFORM_MOVIE_METHOD"
hash "0xF6E48914C7A8694E"
jhash (0x215ABBE8)
arguments {
int "scaleform" [=[ {} ]=],
charPtr "methodName" [=[ {} ]=],
}
alias "_PUSH_SCALEFORM_MOVIE_FUNCTION"
ns "GRAPHICS"
returns "BOOL"
doc [[!
```
Push a function from the Scaleform onto the stack
```
]]
native "BEGIN_SCALEFORM_MOVIE_METHOD_ON_FRONTEND"
hash "0xAB58C27C2E6123C6"
jhash (0xF6015178)
arguments {
charPtr "functionName" [=[ {} ]=],
}
alias "0xAB58C27C2E6123C6"
alias "_PUSH_SCALEFORM_MOVIE_FUNCTION_N"
alias "_BEGIN_SCALEFORM_MOVIE_METHOD_N"
ns "GRAPHICS"
returns "BOOL"
doc [[!
Starts frontend (pause menu) scaleform movie methods.
This can be used when you want to make custom frontend menus, and customize things like images or text in the menus etc.
Use [`BEGIN_SCALEFORM_MOVIE_METHOD_ON_FRONTEND_HEADER`](#\_0xB9449845F73F5E9C) for header scaleform functions.
The function name of the scaleform to call.
]]
native "BEGIN_SCALEFORM_MOVIE_METHOD_ON_FRONTEND_HEADER"
hash "0xB9449845F73F5E9C"
jhash (0x5E219B67)
arguments {
charPtr "functionName" [=[ {} ]=],
}
alias "0xB9449845F73F5E9C"
alias "_BEGIN_SCALEFORM_MOVIE_METHOD_V"
ns "GRAPHICS"
returns "BOOL"
doc [[!
Starts frontend (pause menu) scaleform movie methods for header options.
Use [`BEGIN_SCALEFORM_MOVIE_METHOD_ON_FRONTEND`](#\_0xAB58C27C2E6123C6) to customize the content inside the frontend menus.
Scaleform function name.
]]
native "BEGIN_SCALEFORM_SCRIPT_HUD_MOVIE_METHOD"
hash "0x98C494FD5BDFBFD5"
jhash (0x5D66CE1E)
arguments {
int "hudComponent" [=[ {} ]=],
charPtr "methodName" [=[ {} ]=],
}
alias "_PUSH_SCALEFORM_MOVIE_FUNCTION_FROM_HUD_COMPONENT"
alias "_BEGIN_SCALEFORM_MOVIE_METHOD_HUD_COMPONENT"
ns "GRAPHICS"
returns "BOOL"
doc [[!
```
Pushes a function from the Hud component Scaleform onto the stack. Same behavior as GRAPHICS::BEGIN_SCALEFORM_MOVIE_METHOD, just a hud component id instead of a Scaleform.
Known components:
19 - MP_RANK_BAR
20 - HUD_DIRECTOR_MODE
This native requires more research - all information can be found inside of 'hud.gfx'. Using a decompiler, the different components are located under "scripts\__Packages\com\rockstargames\gtav\hud\hudComponents" and "scripts\__Packages\com\rockstargames\gtav\Multiplayer".
```
]]
native "BEGIN_TAKE_HIGH_QUALITY_PHOTO"
hash "0xA67C35C56EB1BD9D"
jhash (0x47B0C137)
alias "0xA67C35C56EB1BD9D"
ns "GRAPHICS"
returns "BOOL"
doc [[!
]]
native "BEGIN_TAKE_MISSION_CREATOR_PHOTO"
hash "0x1DD2139A9A20DCE8"
jhash (0xBA9AD458)
alias "0x1DD2139A9A20DCE8"
ns "GRAPHICS"
returns "BOOL"
doc [[!
]]
native "BEGIN_TEXT_COMMAND_SCALEFORM_STRING"
hash "0x80338406F3475E55"
jhash (0x3AC9CB55)
arguments {
charPtr "textLabel" [=[ {} ]=],
}
alias "_BEGIN_TEXT_COMPONENT"
ns "GRAPHICS"
returns "void"
doc [[!
```
Called prior to adding a text component to the UI. After doing so, GRAPHICS::END_TEXT_COMMAND_SCALEFORM_STRING is called.
Examples:
GRAPHICS::BEGIN_TEXT_COMMAND_SCALEFORM_STRING("NUMBER");
HUD::ADD_TEXT_COMPONENT_INTEGER(MISC::ABSI(a_1));
GRAPHICS::END_TEXT_COMMAND_SCALEFORM_STRING();
GRAPHICS::BEGIN_TEXT_COMMAND_SCALEFORM_STRING("STRING");
HUD::_ADD_TEXT_COMPONENT_STRING(a_2);
GRAPHICS::END_TEXT_COMMAND_SCALEFORM_STRING();
GRAPHICS::BEGIN_TEXT_COMMAND_SCALEFORM_STRING("STRTNM2");
HUD::_0x17299B63C7683A2B(v_3);
HUD::_0x17299B63C7683A2B(v_4);
GRAPHICS::END_TEXT_COMMAND_SCALEFORM_STRING();
GRAPHICS::BEGIN_TEXT_COMMAND_SCALEFORM_STRING("STRTNM1");
HUD::_0x17299B63C7683A2B(v_3);
GRAPHICS::END_TEXT_COMMAND_SCALEFORM_STRING();
```
a GXT text label
]]
native "CALL_SCALEFORM_MOVIE_METHOD"
hash "0xFBD96D87AC96D533"
jhash (0x7AB77B57)
arguments {
int "scaleform" [=[ {} ]=],
charPtr "method" [=[ {} ]=],
}
alias "_CALL_SCALEFORM_MOVIE_FUNCTION_VOID"
ns "GRAPHICS"
returns "void"
doc [[!
```
Calls the Scaleform function.
```
]]
native "CALL_SCALEFORM_MOVIE_METHOD_WITH_NUMBER"
hash "0xD0837058AE2E4BEE"
jhash (0x557EDA1D)
arguments {
int "scaleform" [=[ {} ]=],
charPtr "methodName" [=[ {} ]=],
float "param1" [=[ {} ]=],
float "param2" [=[ {} ]=],
float "param3" [=[ {} ]=],
float "param4" [=[ {} ]=],
float "param5" [=[ {} ]=],
}
alias "_CALL_SCALEFORM_MOVIE_FUNCTION_FLOAT_PARAMS"
ns "GRAPHICS"
returns "void"
doc [[!
```
Calls the Scaleform function and passes the parameters as floats.
The number of parameters passed to the function varies, so the end of the parameter list is represented by -1.0.
```
]]
native "CALL_SCALEFORM_MOVIE_METHOD_WITH_NUMBER_AND_STRING"
hash "0xEF662D8D57E290B1"
jhash (0x6EAF56DE)
arguments {
int "scaleform" [=[ {} ]=],
charPtr "methodName" [=[ {} ]=],
float "floatParam1" [=[ {} ]=],
float "floatParam2" [=[ {} ]=],
float "floatParam3" [=[ {} ]=],
float "floatParam4" [=[ {} ]=],
float "floatParam5" [=[ {} ]=],
charPtr "stringParam1" [=[ {} ]=],
charPtr "stringParam2" [=[ {} ]=],
charPtr "stringParam3" [=[ {} ]=],
charPtr "stringParam4" [=[ {} ]=],
charPtr "stringParam5" [=[ {} ]=],
}
alias "_CALL_SCALEFORM_MOVIE_FUNCTION_MIXED_PARAMS"
ns "GRAPHICS"
returns "void"
doc [[!
```
Calls the Scaleform function and passes both float and string parameters (in their respective order).
The number of parameters passed to the function varies, so the end of the float parameters is represented by -1.0, and the end of the string parameters is represented by 0 (NULL).
NOTE: The order of parameters in the function prototype is important! All float parameters must come first, followed by the string parameters.
Examples:
// function MY_FUNCTION(floatParam1, floatParam2, stringParam)
GRAPHICS::_CALL_SCALEFORM_MOVIE_FUNCTION_MIXED_PARAMS(scaleform, "MY_FUNCTION", 10.0, 20.0, -1.0, -1.0, -1.0, "String param", 0, 0, 0, 0);
// function MY_FUNCTION_2(floatParam, stringParam1, stringParam2)
GRAPHICS::_CALL_SCALEFORM_MOVIE_FUNCTION_MIXED_PARAMS(scaleform, "MY_FUNCTION_2", 10.0, -1.0, -1.0, -1.0, -1.0, "String param #1", "String param #2", 0, 0, 0);
```
]]
native "CALL_SCALEFORM_MOVIE_METHOD_WITH_STRING"
hash "0x51BC1ED3CC44E8F7"
jhash (0x91A7FCEB)
arguments {
int "scaleform" [=[ {} ]=],
charPtr "methodName" [=[ {} ]=],
charPtr "param1" [=[ {} ]=],
charPtr "param2" [=[ {} ]=],
charPtr "param3" [=[ {} ]=],
charPtr "param4" [=[ {} ]=],
charPtr "param5" [=[ {} ]=],
}
alias "_CALL_SCALEFORM_MOVIE_FUNCTION_STRING_PARAMS"
ns "GRAPHICS"
returns "void"
doc [[!
```
Calls the Scaleform function and passes the parameters as strings.
The number of parameters passed to the function varies, so the end of the parameter list is represented by 0 (NULL).
```
]]
native "CASCADE_SHADOWS_ENABLE_ENTITY_TRACKER"
hash "0x80ECBC0C856D3B0B"
jhash (0xFE903D0F)
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "_SET_FAR_SHADOWS_SUPPRESSED"
ns "GRAPHICS"
returns "void"
doc [[!
```
When this is set to ON, shadows only draw as you get nearer.
When OFF, they draw from a further distance.
```
]]
native "CASCADE_SHADOWS_INIT_SESSION"
hash "0x03FC694AE06C5A20"
jhash (0x48F16186)
alias "0x03FC694AE06C5A20"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "CASCADE_SHADOWS_SET_AIRCRAFT_MODE"
hash "0x6DDBF9DFFC4AC080"
jhash (0x9F470BE3)
arguments {
BOOL "p0" [=[ {} ]=],
}
alias "0x6DDBF9DFFC4AC080"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "CASCADE_SHADOWS_SET_CASCADE_BOUNDS"
hash "0xD2936CAB8B58FCBD"
jhash (0x84F05943)
arguments {
Any "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
float "p4" [=[ {} ]=],
float "p5" [=[ {} ]=],
BOOL "p6" [=[ {} ]=],
float "p7" [=[ {} ]=],
}
alias "0xD2936CAB8B58FCBD"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "CASCADE_SHADOWS_SET_CASCADE_BOUNDS_SCALE"
hash "0x5F0F3F56635809EF"
jhash (0x13D4ABC0)
arguments {
float "p0" [=[ {} ]=],
}
alias "0x5F0F3F56635809EF"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "CASCADE_SHADOWS_SET_DYNAMIC_DEPTH_MODE"
hash "0xD39D13C9FEBF0511"
jhash (0x4A124267)
arguments {
BOOL "p0" [=[ {} ]=],
}
alias "0xD39D13C9FEBF0511"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "CASCADE_SHADOWS_SET_DYNAMIC_DEPTH_VALUE"
hash "0x02AC28F3A01FA04A"
jhash (0xB19B2764)
arguments {
float "p0" [=[ {} ]=],
}
alias "0x02AC28F3A01FA04A"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "CASCADE_SHADOWS_SET_ENTITY_TRACKER_SCALE"
hash "0x5E9DAF5A20F15908"
jhash (0xD2157428)
arguments {
float "p0" [=[ {} ]=],
}
alias "0x5E9DAF5A20F15908"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "CASCADE_SHADOWS_SET_SHADOW_SAMPLE_TYPE"
hash "0xB11D94BC55F41932"
jhash (0xDE10BA1F)
arguments {
charPtr "type" [=[ {} ]=],
}
alias "0xB11D94BC55F41932"
alias "_CASCADESHADOWS_SET_TYPE"
ns "GRAPHICS"
returns "void"
doc [[!
```
Possible values:
"CSM_ST_POINT"
"CSM_ST_LINEAR"
"CSM_ST_TWOTAP"
"CSM_ST_BOX3x3"
"CSM_ST_BOX4x4"
"CSM_ST_DITHER2_LINEAR"
"CSM_ST_CUBIC"
"CSM_ST_DITHER4"
"CSM_ST_DITHER16"
"CSM_ST_SOFT16"
"CSM_ST_DITHER16_RPDB"
"CSM_ST_POISSON16_RPDB_GNORM"
"CSM_ST_HIGHRES_BOX4x4"
"CSM_ST_CLOUDS_SIMPLE"
"CSM_ST_CLOUDS_LINEAR"
"CSM_ST_CLOUDS_TWOTAP"
"CSM_ST_CLOUDS_BOX3x3"
"CSM_ST_CLOUDS_BOX4x4"
"CSM_ST_CLOUDS_DITHER2_LINEAR"
"CSM_ST_CLOUDS_SOFT16"
"CSM_ST_CLOUDS_DITHER16_RPDB"
"CSM_ST_CLOUDS_POISSON16_RPDB_GNORM"
```
]]
native "CLEAR_DRAW_ORIGIN"
hash "0xFF0B610F6BE0D7AF"
jhash (0xDD76B263)
ns "GRAPHICS"
returns "void"
doc [[!
Resets the screen's draw-origin which was changed by the function [`SET_DRAW_ORIGIN`](#\_0xAA0008F3BBB8F416) back to `x=0, y=0`. See [`SET_DRAW_ORIGIN`](#\_0xAA0008F3BBB8F416) for further information.
]]
native "CLEAR_TIMECYCLE_MODIFIER"
hash "0x0F07E7745A236711"
jhash (0x8D8DF8EE)
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "CLEAR_TV_CHANNEL_PLAYLIST"
hash "0xBEB3D46BB7F043C0"
jhash (0xCBE7068F)
arguments {
int "tvChannel" [=[ {} ]=],
}
alias "0xBEB3D46BB7F043C0"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "CREATE_CHECKPOINT"
hash "0x0134F0835AB6BFCB"
jhash (0xF541B690)
arguments {
int "type" [=[ {} ]=],
float "posX1" [=[ {} ]=],
float "posY1" [=[ {} ]=],
float "posZ1" [=[ {} ]=],
float "posX2" [=[ {} ]=],
float "posY2" [=[ {} ]=],
float "posZ2" [=[ {} ]=],
float "diameter" [=[ {} ]=],
int "red" [=[ {} ]=],
int "green" [=[ {} ]=],
int "blue" [=[ {} ]=],
int "alpha" [=[ {} ]=],
int "reserved" [=[ {} ]=],
}
ns "GRAPHICS"
returns "int"
doc [[!
```
Creates a checkpoint. Returns the handle of the checkpoint.
20/03/17 : Attention, checkpoints are already handled by the game itself, so you must not loop it like markers.
Parameters:
* type - The type of checkpoint to create. See below for a list of checkpoint types.
* pos1 - The position of the checkpoint.
* pos2 - The position of the next checkpoint to point to.
* diameter - The diameter of the checkpoint.
* color - The color of the checkpoint.
* reserved - Special parameter, see below for details. Usually set to 0 in the scripts.
Checkpoint types (prior to game build 2189):
0-4---------Cylinder: 1 arrow, 2 arrow, 3 arrows, CycleArrow, Checker
5-9---------Cylinder: 1 arrow, 2 arrow, 3 arrows, CycleArrow, Checker
10-14-------Ring: 1 arrow, 2 arrow, 3 arrows, CycleArrow, Checker
15-19-------1 arrow, 2 arrow, 3 arrows, CycleArrow, Checker
20-24-------Cylinder: 1 arrow, 2 arrow, 3 arrows, CycleArrow, Checker
25-29-------Cylinder: 1 arrow, 2 arrow, 3 arrows, CycleArrow, Checker
30-34-------Cylinder: 1 arrow, 2 arrow, 3 arrows, CycleArrow, Checker
35-38-------Ring: Airplane Up, Left, Right, UpsideDown
39----------?
40----------Ring: just a ring
41----------?
42-44-------Cylinder w/ number (uses 'reserved' parameter)
45-47-------Cylinder no arrow or number
If using type 42-44, reserved sets number / number and shape to display
0-99------------Just numbers (0-99)
100-109-----------------Arrow (0-9)
110-119------------Two arrows (0-9)
120-129----------Three arrows (0-9)
130-139----------------Circle (0-9)
140-149------------CycleArrow (0-9)
150-159----------------Circle (0-9)
160-169----Circle w/ pointer (0-9)
170-179-------Perforated ring (0-9)
180-189----------------Sphere (0-9)
```
[Checkpoint Types](https://docs.fivem.net/docs/game-references/checkpoints/) as of game build 2189
]]
native "CREATE_TRACKED_POINT"
hash "0xE2C9439ED45DEA60"
jhash (0x3129C31A)
ns "GRAPHICS"
returns "int"
doc [[!
Creates a tracked point: useful for checking the visibility of a 3D point on screen.
Tracked points must be manually managed and will not be destroyed on resource stop (they are not an instance of CScriptResource). See [`DESTROY_TRACKED_POINT`](#\_0xB25DC90BAD56CA42) and [onResourceStop](https://docs.fivem.net/docs/scripting-reference/events/list/onResourceStop/).
Only 64 points may be tracked at a given time.
]]
native "DELETE_CHECKPOINT"
hash "0xF5ED37F54CD4D52E"
jhash (0xB66CF3CA)
arguments {
int "checkpoint" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "DESTROY_TRACKED_POINT"
hash "0xB25DC90BAD56CA42"
jhash (0x14AC675F)
arguments {
int "point" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "DISABLE_MOON_CYCLE_OVERRIDE"
hash "0x2BF72AD5B41AA739"
alias "0x2BF72AD5B41AA739"
alias "_RESET_EXTRA_TIMECYCLE_MODIFIER_STRENGTH"
ns "GRAPHICS"
returns "void"
doc [[!
Removes any custom moon cycle overrides that have been configured with [ENABLE_MOON_CYCLE_OVERRIDE](#\_0x2C328AF17210F009)
]]
native "DISABLE_OCCLUSION_THIS_FRAME"
hash "0x3669F1B198DCAA4F"
jhash (0x0DCC0B8B)
alias "0x3669F1B198DCAA4F"
ns "GRAPHICS"
returns "void"
doc [[!
This disables all occluders that cause the 'flickering' rendering under the map and inside buildings with no interiors, note that this may impact performance on lower end systems.
]]
native "DISABLE_SCREENBLUR_FADE"
hash "0xDE81239437E8C5A8"
jhash (0xDB7AECDA)
alias "0xDE81239437E8C5A8"
alias "PAUSED_SCREENBLUR_LOADED"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "DISABLE_VEHICLE_DISTANTLIGHTS"
hash "0xC9F98AC1884E73A2"
jhash (0x7CFAE36F)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "DOES_LATEST_BRIEF_STRING_EXIST"
hash "0x5E657EF1099EDD65"
jhash (0x91A081A1)
arguments {
int "briefValue" [=[ {} ]=],
}
alias "0x5E657EF1099EDD65"
ns "GRAPHICS"
returns "BOOL"
doc [[!
Used in pi_menu.c. Checks if there is a brief entry for specified value.
Values:
0 - Dialogue brief
1 - Help text brief
2 - Mission Objective brief
A value indicating brief text.
]]
native "DOES_PARTICLE_FX_LOOPED_EXIST"
hash "0x74AFEF0D2E1E409B"
jhash (0xCBF91D2A)
arguments {
int "ptfxHandle" [=[ {} ]=],
}
ns "GRAPHICS"
returns "BOOL"
doc [[!
]]
native "DOES_VEHICLE_HAVE_CREW_EMBLEM"
hash "0x060D935D3981A275"
jhash (0x6D58F73B)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "p1" [=[ {} ]=],
}
alias "_HAS_VEHICLE_GOT_DECAL"
alias "_DOES_VEHICLE_HAVE_DECAL"
ns "GRAPHICS"
returns "BOOL"
doc [[!
]]
native "DONT_RENDER_IN_GAME_UI"
hash "0x22A249A53034450A"
jhash (0x932FDB81)
arguments {
BOOL "p0" [=[ {} ]=],
}
alias "0x22A249A53034450A"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "DRAW_BOX"
hash "0xD3A9971CADAC7252"
jhash (0xCD4D9DD5)
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
int "red" [=[ {} ]=],
int "green" [=[ {} ]=],
int "blue" [=[ {} ]=],
int "alpha" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
This native draws a box between two vectors in the game world. It is typically used for visualizing boundaries or areas of interest. The color of the box is specified by the red, green, and blue parameters, with alpha determining its opacity. This native should be called every frame for continuous rendering.
```
NativeDB Introduced: v323
```
The x-coordinate of the first corner of the box.
The y-coordinate of the first corner of the box.
The z-coordinate of the first corner of the box.
The x-coordinate of the opposite corner of the box.
The y-coordinate of the opposite corner of the box.
The z-coordinate of the opposite corner of the box.
The red color component of the box (0 - 255).
The green color component of the box (0 - 255).
The blue color component of the box (0 - 255).
The alpha value of the box (0 - 255).
]]
native "DRAW_DEBUG_BOX"
hash "0x083A2CA4F2E573BD"
jhash (0x8524A848)
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
int "r" [=[ {} ]=],
int "g" [=[ {} ]=],
int "b" [=[ {} ]=],
int "a" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
NOTE: Debugging functions are not present in the retail version of the game.
```
]]
native "DRAW_DEBUG_CROSS"
hash "0x73B1189623049839"
jhash (0xB6DF3709)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "size" [=[ {} ]=],
int "red" [=[ {} ]=],
int "green" [=[ {} ]=],
int "blue" [=[ {} ]=],
int "alpha" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
NOTE: Debugging functions are not present in the retail version of the game.
```
]]
native "DRAW_DEBUG_LINE"
hash "0x7FDFADE676AA3CB0"
jhash (0xABF783AB)
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
int "r" [=[ {} ]=],
int "g" [=[ {} ]=],
int "b" [=[ {} ]=],
int "a" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
NOTE: Debugging functions are not present in the retail version of the game.
```
]]
native "DRAW_DEBUG_LINE_WITH_TWO_COLOURS"
hash "0xD8B9A8AC5608FF94"
jhash (0xE8BFF632)
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
int "r1" [=[ {} ]=],
int "g1" [=[ {} ]=],
int "b1" [=[ {} ]=],
int "r2" [=[ {} ]=],
int "g2" [=[ {} ]=],
int "b2" [=[ {} ]=],
int "alpha1" [=[ {} ]=],
int "alpha2" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
NOTE: Debugging functions are not present in the retail version of the game.
```
]]
native "DRAW_DEBUG_SPHERE"
hash "0xAAD68E1AB39DA632"
jhash (0x304D0EEF)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "radius" [=[ {} ]=],
int "red" [=[ {} ]=],
int "green" [=[ {} ]=],
int "blue" [=[ {} ]=],
int "alpha" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
NOTE: Debugging functions are not present in the retail version of the game.
```
]]
native "DRAW_DEBUG_TEXT"
hash "0x3903E216620488E8"
jhash (0x269B006F)
arguments {
charPtr "text" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
int "red" [=[ {} ]=],
int "green" [=[ {} ]=],
int "blue" [=[ {} ]=],
int "alpha" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
NOTE: Debugging functions are not present in the retail version of the game.
```
]]
native "DRAW_DEBUG_TEXT_2D"
hash "0xA3BB2E9555C05A8F"
jhash (0x528B973B)
arguments {
charPtr "text" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
int "red" [=[ {} ]=],
int "green" [=[ {} ]=],
int "blue" [=[ {} ]=],
int "alpha" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
NOTE: Debugging functions are not present in the retail version of the game.
```
]]
native "DRAW_LIGHT_WITH_RANGE"
hash "0xF2A1B2771A01DBD4"
jhash (0x6A396E9A)
arguments {
float "posX" [=[ {} ]=],
float "posY" [=[ {} ]=],
float "posZ" [=[ {} ]=],
int "colorR" [=[ {} ]=],
int "colorG" [=[ {} ]=],
int "colorB" [=[ {} ]=],
float "range" [=[ {} ]=],
float "intensity" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "DRAW_LINE"
hash "0x6B7256074AE34680"
jhash (0xB3426BCC)
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
int "red" [=[ {} ]=],
int "green" [=[ {} ]=],
int "blue" [=[ {} ]=],
int "alpha" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
This native draws a line between two vectors in the game world. It is typically used for visualizing paths or connections between points. The color of the line is specified by the red, green, and blue parameters, with alpha determining its opacity. This native should be called every frame for continuous rendering.
```
NativeDB Introduced: v323
```
The x-coordinate of the starting point of the line.
The y-coordinate of the starting point of the line.
The z-coordinate of the starting point of the line.
The x-coordinate of the ending point of the line.
The y-coordinate of the ending point of the line.
The z-coordinate of the ending point of the line.
The red color component of the line (0 - 255).
The green color component of the line (0 - 255).
The blue color component of the line (0 - 255).
The alpha value of the line (0 - 255).
]]
native "DRAW_LOW_QUALITY_PHOTO_TO_PHONE"
hash "0x1072F115DAB0717E"
jhash (0xE9F2B68F)
arguments {
BOOL "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
alias "0x1072F115DAB0717E"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "DRAW_MARKER"
hash "0x28477EC23D892089"
jhash (0x48D84A02)
arguments {
int "type" [=[ {} ]=],
float "posX" [=[ {} ]=],
float "posY" [=[ {} ]=],
float "posZ" [=[ {} ]=],
float "dirX" [=[ {} ]=],
float "dirY" [=[ {} ]=],
float "dirZ" [=[ {} ]=],
float "rotX" [=[ {} ]=],
float "rotY" [=[ {} ]=],
float "rotZ" [=[ {} ]=],
float "scaleX" [=[ {} ]=],
float "scaleY" [=[ {} ]=],
float "scaleZ" [=[ {} ]=],
int "red" [=[ {} ]=],
int "green" [=[ {} ]=],
int "blue" [=[ {} ]=],
int "alpha" [=[ {} ]=],
BOOL "bobUpAndDown" [=[ {} ]=],
BOOL "faceCamera" [=[ {} ]=],
int "rotationOrder" [=[ {} ]=],
BOOL "rotate" [=[ {} ]=],
charPtr "textureDict" [=[ {} ]=],
charPtr "textureName" [=[ {} ]=],
BOOL "drawOnEnts" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
Draws a marker with the specified appearance at the target location. This has to be called every frame, e.g. in a `Wait(0)` loop.
There's a [list of markers](https://docs.fivem.net/game-references/markers/) on the FiveM documentation site.
The marker type to draw.
The X coordinate to draw the marker at.
The Y coordinate to draw the marker at.
The Z coordinate to draw the marker at.
The X component of the direction vector for the marker, or 0.0 to use rotX/Y/Z.
The Y component of the direction vector for the marker, or 0.0 to use rotX/Y/Z.
The Z component of the direction vector for the marker, or 0.0 to use rotX/Y/Z.
The X rotation for the marker. Only used if the direction vector is 0.0.
The Y rotation for the marker. Only used if the direction vector is 0.0.
The Z rotation for the marker. Only used if the direction vector is 0.0.
The scale for the marker on the X axis.
The scale for the marker on the Y axis.
The scale for the marker on the Z axis.
The red component of the marker color, on a scale from 0-255.
The green component of the marker color, on a scale from 0-255.
The blue component of the marker color, on a scale from 0-255.
The alpha component of the marker color, on a scale from 0-255.
Whether or not the marker should slowly animate up/down.
Whether the marker should be a 'billboard', as in, should constantly face the camera.
The order yaw, pitch and roll is applied. Usually `2`.
Rotations only apply to the heading.
A texture dictionary to draw the marker with, or NULL. Example: 'GolfPutting'
A texture name in `textureDict` to draw the marker with, or NULL. Example: 'PuttingMarker'
Whether or not the marker should draw on intersecting entities.
]]
native "DRAW_POLY"
hash "0xAC26716048436851"
jhash (0xABD19253)
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
float "x3" [=[ {} ]=],
float "y3" [=[ {} ]=],
float "z3" [=[ {} ]=],
int "red" [=[ {} ]=],
int "green" [=[ {} ]=],
int "blue" [=[ {} ]=],
int "alpha" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
x/y/z - Location of a vertex (in world coords), presumably.
----------------
x1, y1, z1 : Coordinates for the first point
x2, y2, z2 : Coordinates for the second point
x3, y3, z3 : Coordinates for the third point
r, g, b, alpha : Color with RGBA-Values
Keep in mind that only one side of the drawn triangle is visible: It's the side, in which the vector-product of the vectors heads to: (b-a)x(c-a) Or (b-a)x(c-b).
But be aware: The function seems to work somehow differently. I have trouble having them drawn in rotated orientation. Try it yourself and if you somehow succeed, please edit this and post your solution.
I recommend using a predefined function to call this.
[VB.NET]
Public Sub DrawPoly(a As Vector3, b As Vector3, c As Vector3, col As Color)
[Function].Call(Hash.DRAW_POLY, a.X, a.Y, a.Z, b.X, b.Y, b.Z, c.X, c.Y, c.Z, col.R, col.G, col.B, col.A)
End Sub
[C#]
public void DrawPoly(Vector3 a, Vector3 b, Vector3 c, Color col)
{
Function.Call(Hash.DRAW_POLY, a.X, a.Y, a.Z, b.X, b.Y, b.Z, c.X, c.Y, c.Z, col.R, col.G, col.B, col.A);
}
BTW: Intersecting triangles are not supported: They overlap in the order they were called.
```
]]
native "DRAW_RECT"
hash "0x3A618A217E5154F0"
jhash (0xDD2BFC77)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "width" [=[ {} ]=],
float "height" [=[ {} ]=],
int "r" [=[ {} ]=],
int "g" [=[ {} ]=],
int "b" [=[ {} ]=],
int "a" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
Draws a rectangle on the screen.
-x: The relative X point of the center of the rectangle. (0.0-1.0, 0.0 is the left edge of the screen, 1.0 is the right edge of the screen)
-y: The relative Y point of the center of the rectangle. (0.0-1.0, 0.0 is the top edge of the screen, 1.0 is the bottom edge of the screen)
-width: The relative width of the rectangle. (0.0-1.0, 1.0 means the whole screen width)
-height: The relative height of the rectangle. (0.0-1.0, 1.0 means the whole screen height)
-R: Red part of the color. (0-255)
-G: Green part of the color. (0-255)
-B: Blue part of the color. (0-255)
-A: Alpha part of the color. (0-255, 0 means totally transparent, 255 means totally opaque)
The total number of rectangles to be drawn in one frame is apparently limited to 399.
```
```
NativeDB Added Parameter 9: BOOL p8
```
]]
native "DRAW_SCALEFORM_MOVIE"
hash "0x54972ADAF0294A93"
jhash (0x48DA6A58)
arguments {
int "scaleformHandle" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "width" [=[ {} ]=],
float "height" [=[ {} ]=],
int "red" [=[ {} ]=],
int "green" [=[ {} ]=],
int "blue" [=[ {} ]=],
int "alpha" [=[ {} ]=],
int "unk" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "DRAW_SCALEFORM_MOVIE_3D"
hash "0x87D51D72255D4E78"
jhash (0xC4F63A89)
arguments {
int "scaleform" [=[ {} ]=],
float "posX" [=[ {} ]=],
float "posY" [=[ {} ]=],
float "posZ" [=[ {} ]=],
float "rotX" [=[ {} ]=],
float "rotY" [=[ {} ]=],
float "rotZ" [=[ {} ]=],
float "p7" [=[ {} ]=],
float "sharpness" [=[ {} ]=],
float "p9" [=[ {} ]=],
float "scaleX" [=[ {} ]=],
float "scaleY" [=[ {} ]=],
float "scaleZ" [=[ {} ]=],
Any "p13" [=[ {} ]=],
}
alias "0x87D51D72255D4E78"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "DRAW_SCALEFORM_MOVIE_3D_SOLID"
hash "0x1CE592FDC749D6F5"
jhash (0x899933C8)
arguments {
int "scaleform" [=[ {} ]=],
float "posX" [=[ {} ]=],
float "posY" [=[ {} ]=],
float "posZ" [=[ {} ]=],
float "rotX" [=[ {} ]=],
float "rotY" [=[ {} ]=],
float "rotZ" [=[ {} ]=],
float "p7" [=[ {} ]=],
float "p8" [=[ {} ]=],
float "p9" [=[ {} ]=],
float "scaleX" [=[ {} ]=],
float "scaleY" [=[ {} ]=],
float "scaleZ" [=[ {} ]=],
Any "p13" [=[ {} ]=],
}
alias "0x1CE592FDC749D6F5"
alias "_DRAW_SCALEFORM_MOVIE_3D_NON_ADDITIVE"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "DRAW_SCALEFORM_MOVIE_FULLSCREEN"
hash "0x0DF606929C105BE1"
jhash (0x7B48E696)
arguments {
int "scaleform" [=[ {} ]=],
int "red" [=[ {} ]=],
int "green" [=[ {} ]=],
int "blue" [=[ {} ]=],
int "alpha" [=[ {} ]=],
int "unk" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
unk is not used so no need
```
]]
native "DRAW_SCALEFORM_MOVIE_FULLSCREEN_MASKED"
hash "0xCF537FDE4FBD4CE5"
jhash (0x9C59FC06)
arguments {
int "scaleform1" [=[ {} ]=],
int "scaleform2" [=[ {} ]=],
int "red" [=[ {} ]=],
int "green" [=[ {} ]=],
int "blue" [=[ {} ]=],
int "alpha" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "DRAW_SPOT_LIGHT"
hash "0xD0F64B265C8C8B33"
jhash (0xBDBC410C)
arguments {
float "posX" [=[ {} ]=],
float "posY" [=[ {} ]=],
float "posZ" [=[ {} ]=],
float "dirX" [=[ {} ]=],
float "dirY" [=[ {} ]=],
float "dirZ" [=[ {} ]=],
int "colorR" [=[ {} ]=],
int "colorG" [=[ {} ]=],
int "colorB" [=[ {} ]=],
float "distance" [=[ {} ]=],
float "brightness" [=[ {} ]=],
float "hardness" [=[ {} ]=],
float "radius" [=[ {} ]=],
float "falloff" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
Parameters:
* pos - coordinate where the spotlight is located
* dir - the direction vector the spotlight should aim at from its current position
* r,g,b - color of the spotlight
* distance - the maximum distance the light can reach
* brightness - the brightness of the light
* roundness - "smoothness" of the circle edge
* radius - the radius size of the spotlight
* falloff - the falloff size of the light's edge (example: www.i.imgur.com/DemAWeO.jpg)
Example in C# (spotlight aims at the closest vehicle):
Vector3 myPos = Game.Player.Character.Position;
Vehicle nearest = World.GetClosestVehicle(myPos , 1000f);
Vector3 destinationCoords = nearest.Position;
Vector3 dirVector = destinationCoords - myPos;
dirVector.Normalize();
Function.Call(Hash.DRAW_SPOT_LIGHT, pos.X, pos.Y, pos.Z, dirVector.X, dirVector.Y, dirVector.Z, 255, 255, 255, 100.0f, 1f, 0.0f, 13.0f, 1f);
```
]]
native "DRAW_SPRITE"
hash "0xE7FFAE5EBF23D890"
jhash (0x1FEC16B0)
arguments {
charPtr "textureDict" [=[ {} ]=],
charPtr "textureName" [=[ {} ]=],
float "screenX" [=[ {} ]=],
float "screenY" [=[ {} ]=],
float "width" [=[ {} ]=],
float "height" [=[ {} ]=],
float "heading" [=[ {} ]=],
int "red" [=[ {} ]=],
int "green" [=[ {} ]=],
int "blue" [=[ {} ]=],
int "alpha" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
Draws a 2D sprite on the screen.
Parameters:
textureDict - Name of texture dictionary to load texture from (e.g. "CommonMenu", "MPWeaponsCommon", etc.)
textureName - Name of texture to load from texture dictionary (e.g. "last_team_standing_icon", "tennis_icon", etc.)
screenX/Y - Screen offset (0.5 = center)
scaleX/Y - Texture scaling. Negative values can be used to flip the texture on that axis. (0.5 = half)
heading - Texture rotation in degrees (default = 0.0) positive is clockwise, measured in degrees
red,green,blue - Sprite color (default = 255/255/255)
alpha - opacity level
```
```
NativeDB Added Parameter 12: BOOL p11
```
]]
native "DRAW_TEXTURED_POLY"
hash "0x29280002282F1928"
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
float "x3" [=[ {} ]=],
float "y3" [=[ {} ]=],
float "z3" [=[ {} ]=],
int "red" [=[ {} ]=],
int "green" [=[ {} ]=],
int "blue" [=[ {} ]=],
int "alpha" [=[ {} ]=],
charPtr "textureDict" [=[ {} ]=],
charPtr "textureName" [=[ {} ]=],
float "u1" [=[ {} ]=],
float "v1" [=[ {} ]=],
float "w1" [=[ {} ]=],
float "u2" [=[ {} ]=],
float "v2" [=[ {} ]=],
float "w2" [=[ {} ]=],
float "u3" [=[ {} ]=],
float "v3" [=[ {} ]=],
float "w3" [=[ {} ]=],
}
alias "0x29280002282F1928"
alias "_DRAW_SPRITE_POLY"
ns "GRAPHICS"
returns "void"
doc [[!
This native draws a textured polygon between three vectors in the game world. It's commonly utilized for rendering deadline trailing lights, with additional details available in the `deadline.ytd` file. UVW mapping details (u,v,w parameters) can be found on various internet resources. This native is specifically used for drawing textured polygons on the screen, where UV coordinates define the texture mapping and color/alpha parameters define the appearance of the polygon. This native should be called every frame for continuous rendering.
```
NativeDB Introduced: v877
```
The x-coordinate of the first vector.
The y-coordinate of the first vector.
The z-coordinate of the first vector.
The x-coordinate of the second vector.
The y-coordinate of the second vector.
The z-coordinate of the second vector.
The x-coordinate of the third vector.
The y-coordinate of the third vector.
The z-coordinate of the third vector.
The red color component of the polygon (0 - 255).
The green color component of the polygon (0 - 255).
The blue color component of the polygon (0 - 255).
The alpha value of the polygon (0 - 255).
The name of the texture dictionary.
The name of the texture.
The u-coordinate of the first UV mapping.
The v-coordinate of the first UV mapping.
The w-coordinate of the first UV mapping.
The u-coordinate of the second UV mapping.
The v-coordinate of the second UV mapping.
The w-coordinate of the second UV mapping.
The u-coordinate of the third UV mapping.
The v-coordinate of the third UV mapping.
The w-coordinate of the third UV mapping.
]]
native "DRAW_TV_CHANNEL"
hash "0xFDDC2B4ED3C69DF0"
jhash (0x8129EF89)
arguments {
float "xPos" [=[ {} ]=],
float "yPos" [=[ {} ]=],
float "xScale" [=[ {} ]=],
float "yScale" [=[ {} ]=],
float "rotation" [=[ {} ]=],
int "red" [=[ {} ]=],
int "green" [=[ {} ]=],
int "blue" [=[ {} ]=],
int "alpha" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
All calls to this native are preceded by calls to GRAPHICS::_0x61BB1D9B3A95D802 and GRAPHICS::_0xC6372ECD45D73BCD, respectively.
"act_cinema.ysc", line 1483:
HUD::SET_HUD_COMPONENT_POSITION(15, 0.0, -0.0375);
HUD::SET_TEXT_RENDER_ID(l_AE);
GRAPHICS::_0x61BB1D9B3A95D802(4);
GRAPHICS::_0xC6372ECD45D73BCD(1);
if (GRAPHICS::_0x0AD973CA1E077B60(${movie_arthouse})) {
GRAPHICS::DRAW_TV_CHANNEL(0.5, 0.5, 0.7375, 1.0, 0.0, 255, 255, 255, 255);
} else {
GRAPHICS::DRAW_TV_CHANNEL(0.5, 0.5, 1.0, 1.0, 0.0, 255, 255, 255, 255);
}
"am_mp_property_int.ysc", line 102545:
if (ENTITY::DOES_ENTITY_EXIST(a_2._f3)) {
if (HUD::IS_NAMED_RENDERTARGET_LINKED(ENTITY::GET_ENTITY_MODEL(a_2._f3))) {
HUD::SET_TEXT_RENDER_ID(a_2._f1);
GRAPHICS::_0x61BB1D9B3A95D802(4);
GRAPHICS::_0xC6372ECD45D73BCD(1);
GRAPHICS::DRAW_TV_CHANNEL(0.5, 0.5, 1.0, 1.0, 0.0, 255, 255, 255, 255);
if (GRAPHICS::GET_TV_CHANNEL() == -1) {
sub_a8fa5(a_2, 1);
} else {
sub_a8fa5(a_2, 1);
GRAPHICS::ATTACH_TV_AUDIO_TO_ENTITY(a_2._f3);
}
HUD::SET_TEXT_RENDER_ID(HUD::GET_DEFAULT_SCRIPT_RENDERTARGET_RENDER_ID());
}
}
```
]]
native "ENABLE_ALIEN_BLOOD_VFX"
hash "0x9DCE1F0F78260875"
jhash (0xCE8B8748)
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0x9DCE1F0F78260875"
ns "GRAPHICS"
returns "void"
doc [[!
Creates a motion-blur sort of effect, this native does not seem to work, however by using the [`ANIMPOSTFX_PLAY`](#\_0x2206BF9A37B7F724) native with `"DrugsMichaelAliensFight"` as the effect parameter, you should be able to get the effect.
This native does not seem to work, however by using the [ANIMPOSTFX_PLAY](#\_0x2206BF9A37B7F724) native with "DrugsMichaelAliensFight" as the effect parameter, you should be able to get the effect.
]]
native "ENABLE_CLOWN_BLOOD_VFX"
hash "0xD821490579791273"
jhash (0xC61C75E9)
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "SET_CAMERA_ENDTIME"
ns "GRAPHICS"
returns "void"
doc [[!
If true, this native will create purple explosions upon projectile impact, add comic-like PTFX when firing a weapon, create a sound on bullet impact and have its own "blood effect".
If the PTFX asset "scr_rcbarry2" is not requested using ([`RequestNamedPtfxAsset`](#\_0xD821490579791273)) then this native **will not work as intended**.
Excerpt from fm_content_drug_lab_work.c:
```
STREAMING::REQUEST_NAMED_PTFX_ASSET("scr_rcbarry2");
if (STREAMING::HAS_NAMED_PTFX_ASSET_LOADED("scr_rcbarry2"))
{
GRAPHICS::ENABLE_CLOWN_BLOOD_VFX(true);
AUDIO::START_AUDIO_SCENE("DLC_CM2022_DRUG_TRIP_SPRINKLERS_SCENE");
func_720(26);
}
```
Whether to toggle the clown VFX on or off.
]]
native "ENABLE_MOON_CYCLE_OVERRIDE"
hash "0x2C328AF17210F009"
arguments {
float "phase" [=[ {} ]=],
}
alias "0x2C328AF17210F009"
alias "_SET_EXTRA_TIMECYCLE_MODIFIER_STRENGTH"
ns "GRAPHICS"
returns "void"
doc [[!
Enable a custom moon cycle, allowing control of which lunar phase the moon is in.
Valid values are from `0.0` to `1.0`, with `0.5` representing a full moon.
| Value | Lunar Phase |
| :---: | :-------------: |
| `0.1` | Waxing Crescent |
| `0.2` | First Quarter |
| `0.3` | Waxing Gibbous |
| `0.5` | Full Moon |
| `0.7` | Waning Gibbous |
| `0.8` | Third Quarter |
| `0.9` | Waning Crescent |
The moon phase can be disabled with [DISABLE_MOON_CYCLE_OVERRIDE](#\_0x2BF72AD5B41AA739)
A value indicating the moon cycle.
]]
native "ENABLE_MOVIE_KEYFRAME_WAIT"
hash "0x74C180030FDE4B69"
jhash (0x796DE696)
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0x74C180030FDE4B69"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "ENABLE_MOVIE_SUBTITLES"
hash "0x873FA65C778AD970"
jhash (0xC2DEBA3D)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "END_PETROL_TRAIL_DECALS"
hash "0x0A123435A26C36CD"
jhash (0xCCCA6855)
alias "0x0A123435A26C36CD"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "END_SCALEFORM_MOVIE_METHOD"
hash "0xC6796A8FFA375E53"
jhash (0x02DBF2D7)
alias "_POP_SCALEFORM_MOVIE_FUNCTION_VOID"
ns "GRAPHICS"
returns "void"
doc [[!
```
Pops and calls the Scaleform function on the stack
```
]]
native "END_SCALEFORM_MOVIE_METHOD_RETURN_VALUE"
hash "0xC50AA39A577AF886"
jhash (0x2F38B526)
alias "_POP_SCALEFORM_MOVIE_FUNCTION"
alias "_END_SCALEFORM_MOVIE_METHOD_RETURN"
ns "GRAPHICS"
returns "int"
doc [[!
]]
native "END_TEXT_COMMAND_SCALEFORM_STRING"
hash "0x362E2D3FE93A9959"
jhash (0x386CE0B8)
alias "_END_TEXT_COMPONENT"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "END_TEXT_COMMAND_UNPARSED_SCALEFORM_STRING"
hash "0xAE4E8157D9ECF087"
jhash (0x2E80DB52)
alias "0xAE4E8157D9ECF087"
alias "_END_TEXT_COMMAND_SCALEFORM_STRING_2"
ns "GRAPHICS"
returns "void"
doc [[!
Same as END_TEXT_COMMAND_SCALEFORM_STRING but does not perform HTML conversion for text tokens.
Also useful for when you are trying to add blips and inputs in your scaleform (If the scaleform supports it).
]]
native "FADE_DECALS_IN_RANGE"
hash "0xD77EDADB0420E6E0"
jhash (0xF81E884A)
arguments {
float "x" [=[ {"cs_type":"Any"} ]=],
float "y" [=[ {"cs_type":"Any"} ]=],
float "z" [=[ {"cs_type":"Any"} ]=],
float "radius" [=[ {"cs_type":"Any"} ]=],
float "duration" [=[ {"cs_type":"Any"} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
A duration in seconds.
]]
native "FADE_UP_PED_LIGHT"
hash "0xC9B18B4619F48F7B"
jhash (0x93628786)
arguments {
float "p0" [=[ {} ]=],
}
alias "0xC9B18B4619F48F7B"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "FORCE_RENDER_IN_GAME_UI"
hash "0xDC459CFA0CCE245B"
jhash (0x7E946E87)
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0xDC459CFA0CCE245B"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "FREE_MEMORY_FOR_HIGH_QUALITY_PHOTO"
hash "0xD801CC02177FA3F1"
jhash (0x9CBA682A)
alias "0xD801CC02177FA3F1"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "FREE_MEMORY_FOR_LOW_QUALITY_PHOTO"
hash "0x6A12D88881435DCA"
jhash (0x108F36CC)
alias "0x6A12D88881435DCA"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "FREE_MEMORY_FOR_MISSION_CREATOR_PHOTO"
hash "0x0A46AF8A78DC5E0A"
jhash (0x9E553002)
alias "0x0A46AF8A78DC5E0A"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "GET_ACTUAL_SCREEN_RESOLUTION"
hash "0x873C9F3104101DD3"
arguments {
intPtr "x" [=[ {} ]=],
intPtr "y" [=[ {} ]=],
}
alias "_GET_SCREEN_ACTIVE_RESOLUTION"
alias "_GET_ACTIVE_SCREEN_RESOLUTION"
ns "GRAPHICS"
returns "void"
doc [[!
Returns current screen resolution.
```
NativeDB Introduced: v323
```
]]
native "GET_ASPECT_RATIO"
hash "0xF1307EF624A80D87"
arguments {
BOOL "physicalAspect" [=[ {} ]=],
}
alias "_GET_SCREEN_ASPECT_RATIO"
alias "_GET_ASPECT_RATIO"
ns "GRAPHICS"
returns "float"
doc [[!
This native retrieves the aspect ratio of the game window. If `physicalAspect` is `true`, it returns the physical aspect ratio of the game window, which is useful for 3x1 modes. Otherwise, it returns the aspect ratio of the main game window, considering any custom overrides from the settings menu.
```
NativeDB Introduced: v323
```
A boolean value. Passing in `true` returns the physical aspect ratio of the game window. Passing in `false` returns the aspect ratio of the main game window.
The aspect ratio of the game window as a floating-point number.
]]
native "GET_CURRENT_NUMBER_OF_CLOUD_PHOTOS"
hash "0x473151EBC762C6DA"
jhash (0x21DBF0C9)
alias "0x473151EBC762C6DA"
alias "_GET_NUMBER_OF_PHOTOS"
alias "_GET_CURRENT_NUMBER_OF_PHOTOS"
ns "GRAPHICS"
returns "int"
doc [[!
]]
native "GET_DECAL_WASH_LEVEL"
hash "0x323F647679A09103"
jhash (0x054448EF)
arguments {
int "decal" [=[ {} ]=],
}
ns "GRAPHICS"
returns "float"
doc [[!
]]
native "GET_IS_HIDEF"
hash "0x84ED31191CC5D2C9"
jhash (0x1C340359)
ns "GRAPHICS"
returns "BOOL"
doc [[!
This native indicates whether the game is running in high-definition (HD) resolution. It returns `false` if the resolution is less than `1280x720` and `true` if it's equal to or greater than `1280x720`.
```
NativeDB Introduced: v323
```
A boolean value indicating whether the game is running in high-definition (`true`) or not (`false`).
]]
native "GET_IS_PETROL_DECAL_IN_RANGE"
hash "0x2F09F7976C512404"
jhash (0x242C6A04)
arguments {
float "xCoord" [=[ {} ]=],
float "yCoord" [=[ {} ]=],
float "zCoord" [=[ {} ]=],
float "radius" [=[ {} ]=],
}
alias "0x2F09F7976C512404"
ns "GRAPHICS"
returns "BOOL"
doc [[!
]]
native "GET_IS_WIDESCREEN"
hash "0x30CF4BDA4FCB1905"
jhash (0xEC717AEF)
ns "GRAPHICS"
returns "BOOL"
doc [[!
This native retrieves whether the game is running in widescreen mode or not.
```
NativeDB Introduced: v323
```
A boolean value indicating whether the game is running in widescreen mode (`true`) or not (`false`).Returns `false` for narrow format aspect ratios (3:2, 4:3, 5:4, etc.) and `true` for wide format aspect ratios (5:3, 16:9, 16:10, etc.). If the aspect ratio is set to "Auto" in the game settings, it returns `false` or `true` based on the actual set resolution ratio.
]]
native "GET_MAXIMUM_NUMBER_OF_CLOUD_PHOTOS"
hash "0xDC54A7AF8B3A14EF"
jhash (0x239272BD)
alias "0xDC54A7AF8B3A14EF"
alias "_GET_MAXIMUM_NUMBER_OF_PHOTOS_2"
ns "GRAPHICS"
returns "int"
doc [[!
```
This function is hard-coded to always return 96.
```
]]
native "GET_MAXIMUM_NUMBER_OF_PHOTOS"
hash "0x34D23450F028B0BF"
jhash (0x727AA63F)
ns "GRAPHICS"
returns "int"
doc [[!
```
This function is hard-coded to always return 0.
```
]]
native "GET_REQUESTINGNIGHTVISION"
hash "0x35FB78DC42B7BD21"
jhash (0xF3A6309E)
alias "0x35FB78DC42B7BD21"
ns "GRAPHICS"
returns "BOOL"
doc [[!
]]
native "GET_SAFE_ZONE_SIZE"
hash "0xBAF107B6BB2C97F0"
jhash (0x3F0D1A6F)
ns "GRAPHICS"
returns "float"
doc [[!
```
Gets the scale of safe zone. if the safe zone size scale is max, it will return 1.0.
```
]]
native "GET_SCALEFORM_MOVIE_METHOD_RETURN_VALUE_BOOL"
hash "0xD80A80346A45D761"
arguments {
int "methodReturn" [=[ {} ]=],
}
alias "0xD80A80346A45D761"
alias "_GET_SCALEFORM_MOVIE_METHOD_RETURN_VALUE_BOOL"
ns "GRAPHICS"
returns "BOOL"
doc [[!
Operation handle returned by [`END_SCALEFORM_MOVIE_METHOD_RETURN_VALUE`](#\_0xC50AA39A577AF886)
The return value passed from actionscript to game code.
]]
native "GET_SCALEFORM_MOVIE_METHOD_RETURN_VALUE_INT"
hash "0x2DE7EFA66B906036"
jhash (0x2CFB0E6D)
arguments {
int "method_return" [=[ {} ]=],
}
alias "0x2DE7EFA66B906036"
alias "_GET_SCALEFORM_MOVIE_FUNCTION_RETURN_INT"
ns "GRAPHICS"
returns "int"
doc [[!
Used to get a return value from a scaleform function. Returns an int in the same way GET_SCALEFORM_MOVIE_METHOD_RETURN_VALUE_STRING returns a string.
The return value of this native: `EndScaleformMovieMethodReturn`
Returns an int in the same way `GET_SCALEFORM_MOVIE_METHOD_RETURN_VALUE_STRING` returns a string.
]]
native "GET_SCALEFORM_MOVIE_METHOD_RETURN_VALUE_STRING"
hash "0xE1E258829A885245"
jhash (0x516862EB)
arguments {
int "method_return" [=[ {} ]=],
}
alias "SITTING_TV"
alias "_GET_SCALEFORM_MOVIE_FUNCTION_RETURN_STRING"
ns "GRAPHICS"
returns "charPtr"
doc [[!
Used to get a return value from a scaleform function. Returns a string in the same way GET_SCALEFORM_MOVIE_METHOD_RETURN_VALUE_INT returns an int.
The return value of this native: `EndScaleformMovieMethodReturn`
Returns a string in the same way `GET_SCALEFORM_MOVIE_METHOD_RETURN_VALUE_INT` returns an int.
]]
native "GET_SCREEN_COORD_FROM_WORLD_COORD"
hash "0x34E82F05DF2974F5"
jhash (0x1F950E4B)
arguments {
float "worldX" [=[ {} ]=],
float "worldY" [=[ {} ]=],
float "worldZ" [=[ {} ]=],
floatPtr "screenX" [=[ {} ]=],
floatPtr "screenY" [=[ {} ]=],
}
alias "_WORLD3D_TO_SCREEN2D"
ns "GRAPHICS"
returns "BOOL"
doc [[!
```
Convert a world coordinate into its relative screen coordinate. (WorldToScreen)
Returns a boolean; whether or not the operation was successful. It will return false if the coordinates given are not visible to the rendering camera.
For .NET users...
VB:
Public Shared Function World3DToScreen2d(pos as vector3) As Vector2
Dim x2dp, y2dp As New Native.OutputArgument
Native.Function.Call(Of Boolean)(Native.Hash.GET_SCREEN_COORD_FROM_WORLD_COORD , pos.x, pos.y, pos.z, x2dp, y2dp)
Return New Vector2(x2dp.GetResult(Of Single), y2dp.GetResult(Of Single))
End Function
C#:
Vector2 World3DToScreen2d(Vector3 pos)
{
var x2dp = new OutputArgument();
var y2dp = new OutputArgument();
Function.Call(Hash.GET_SCREEN_COORD_FROM_WORLD_COORD , pos.X, pos.Y, pos.Z, x2dp, y2dp);
return new Vector2(x2dp.GetResult(), y2dp.GetResult());
}
//USE VERY SMALL VALUES FOR THE SCALE OF RECTS/TEXT because it is dramatically larger on screen than in 3D, e.g '0.05' small.
Used to be called _WORLD3D_TO_SCREEN2D
I thought we lost you from the scene forever. It does seem however that calling SET_DRAW_ORIGIN then your natives, then ending it. Seems to work better for certain things such as keeping boxes around people for a predator missile e.g.
```
]]
native "GET_SCREEN_RESOLUTION"
hash "0x888D57E407E63624"
jhash (0x29F3572F)
arguments {
intPtr "x" [=[ {} ]=],
intPtr "y" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
Hardcoded to always return 1280x720. Use [`_GET_ACTIVE_SCREEN_RESOLUTION`](#\_0x873C9F3104101DD3) to retrieve the correct screen resolution.
]]
native "GET_SCREENBLUR_FADE_CURRENT_TIME"
hash "0x5CCABFFCA31DDE33"
jhash (0xEA432A94)
alias "IS_PARTICLE_FX_DELAYED_BLINK"
ns "GRAPHICS"
returns "float"
doc [[!
]]
native "GET_STATUS_OF_LOAD_MISSION_CREATOR_PHOTO"
hash "0x1670F8D05056F257"
jhash (0x226B08EA)
arguments {
charPtr "p0" [=[ {} ]=],
}
alias "0x1670F8D05056F257"
ns "GRAPHICS"
returns "int"
doc [[!
]]
native "GET_STATUS_OF_SAVE_HIGH_QUALITY_PHOTO"
hash "0x0C0C4E81E1AC60A0"
jhash (0xEC5D0317)
alias "0x0C0C4E81E1AC60A0"
ns "GRAPHICS"
returns "int"
doc [[!
]]
native "GET_STATUS_OF_SORTED_LIST_OPERATION"
hash "0xF5BED327CEA362B1"
jhash (0x596B900D)
arguments {
BOOL "scanForSaving" [=[ {} ]=],
}
alias "0xF5BED327CEA362B1"
ns "GRAPHICS"
returns "int"
doc [[!
Returns status of gallery photo fetch, which was requested by [`QUEUE_OPERATION_TO_CREATE_SORTED_LIST_OF_PHOTOS`](#\_0x2A893980E96B659A).
0 - Succeeded, 1 - In progress, 2 - Failed
]]
native "GET_STATUS_OF_TAKE_HIGH_QUALITY_PHOTO"
hash "0x0D6CA79EEEBD8CA3"
jhash (0x65376C9B)
alias "0x0D6CA79EEEBD8CA3"
ns "GRAPHICS"
returns "int"
doc [[!
]]
native "GET_STATUS_OF_TAKE_MISSION_CREATOR_PHOTO"
hash "0x90A78ECAA4E78453"
jhash (0xADBBA287)
alias "0x90A78ECAA4E78453"
ns "GRAPHICS"
returns "int"
doc [[!
]]
native "GET_TEXTURE_RESOLUTION"
hash "0x35736EE65BD00C11"
jhash (0x096DAA4D)
arguments {
charPtr "textureDict" [=[ {} ]=],
charPtr "textureName" [=[ {} ]=],
}
ns "GRAPHICS"
returns "Vector3"
doc [[!
```
Returns the texture resolution of the passed texture dict+name.
Note: Most texture resolutions are doubled compared to the console version of the game.
```
]]
native "GET_TIMECYCLE_MODIFIER_INDEX"
hash "0xFDF3D97C674AFB66"
jhash (0x594FEEC4)
ns "GRAPHICS"
returns "int"
doc [[!
```
Only use for this in the PC scripts is:
if (GRAPHICS::GET_TIMECYCLE_MODIFIER_INDEX() != -1)
For a full list, see here: pastebin.com/cnk7FTF2
```
]]
native "GET_TIMECYCLE_TRANSITION_MODIFIER_INDEX"
hash "0x459FD2C8D0AB78BC"
jhash (0x03C44E4B)
alias "0x459FD2C8D0AB78BC"
ns "GRAPHICS"
returns "int"
doc [[!
]]
native "GET_TOGGLE_PAUSED_RENDERPHASES_STATUS"
hash "0xEB3DAC2C86001E5E"
jhash (0xD4F5D07D)
alias "0xEB3DAC2C86001E5E"
ns "GRAPHICS"
returns "BOOL"
doc [[!
]]
native "GET_TV_CHANNEL"
hash "0xFC1E275A90D39995"
jhash (0x6B96145A)
ns "GRAPHICS"
returns "int"
doc [[!
]]
native "GET_TV_VOLUME"
hash "0x2170813D3DD8661B"
jhash (0x39555CF0)
ns "GRAPHICS"
returns "float"
doc [[!
]]
native "GET_USINGNIGHTVISION"
hash "0x2202A3F42C8E5F79"
jhash (0x62619061)
alias "_IS_NIGHTVISION_INACTIVE"
alias "_IS_NIGHTVISION_ACTIVE"
ns "GRAPHICS"
returns "BOOL"
doc [[!
]]
native "GET_USINGSEETHROUGH"
hash "0x44B80ABAB9D80BD3"
jhash (0x1FE547F2)
alias "_IS_SEETHROUGH_ACTIVE"
ns "GRAPHICS"
returns "BOOL"
doc [[!
]]
native "GET_VEHICLE_CREW_EMBLEM_REQUEST_STATE"
hash "0xFE26117A5841B2FF"
jhash (0x4F4D76E8)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "p1" [=[ {} ]=],
}
alias "0xFE26117A5841B2FF"
ns "GRAPHICS"
returns "int"
doc [[!
]]
native "GOLF_TRAIL_GET_MAX_HEIGHT"
hash "0xA4819F5E23E2FFAD"
jhash (0xA08B46AD)
alias "0xA4819F5E23E2FFAD"
ns "GRAPHICS"
returns "float"
doc [[!
]]
native "GOLF_TRAIL_GET_VISUAL_CONTROL_POINT"
hash "0xA4664972A9B8F8BA"
jhash (0xECD470F0)
arguments {
int "p0" [=[ {} ]=],
}
alias "0xA4664972A9B8F8BA"
ns "GRAPHICS"
returns "Vector3"
doc [[!
]]
native "GOLF_TRAIL_SET_COLOUR"
hash "0x12995F2E53FFA601"
jhash (0x804F444C)
arguments {
int "p0" [=[ {} ]=],
int "p1" [=[ {} ]=],
int "p2" [=[ {} ]=],
int "p3" [=[ {} ]=],
int "p4" [=[ {} ]=],
int "p5" [=[ {} ]=],
int "p6" [=[ {} ]=],
int "p7" [=[ {} ]=],
int "p8" [=[ {} ]=],
int "p9" [=[ {} ]=],
int "p10" [=[ {} ]=],
int "p11" [=[ {} ]=],
}
alias "0x12995F2E53FFA601"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "GOLF_TRAIL_SET_ENABLED"
hash "0xA51C4B86B71652AE"
jhash (0x5D3BFFC9)
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0xA51C4B86B71652AE"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "GOLF_TRAIL_SET_FACING"
hash "0x06F761EA47C1D3ED"
jhash (0x0D830DC7)
arguments {
BOOL "p0" [=[ {} ]=],
}
alias "0x06F761EA47C1D3ED"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "GOLF_TRAIL_SET_FIXED_CONTROL_POINT"
hash "0xB1BB03742917A5D6"
jhash (0x3BB12B75)
arguments {
int "type" [=[ {} ]=],
float "xPos" [=[ {} ]=],
float "yPos" [=[ {} ]=],
float "zPos" [=[ {} ]=],
float "p4" [=[ {} ]=],
int "red" [=[ {} ]=],
int "green" [=[ {} ]=],
int "blue" [=[ {} ]=],
int "alpha" [=[ {} ]=],
}
alias "0xB1BB03742917A5D6"
ns "GRAPHICS"
returns "void"
doc [[!
```
12 matches across 4 scripts. All 4 scripts were job creators.
type ranged from 0 - 2.
p4 was always 0.2f. Likely scale.
assuming p5 - p8 is RGBA, the graphic is always yellow (255, 255, 0, 255).
Tested but noticed nothing.
```
]]
native "GOLF_TRAIL_SET_PATH"
hash "0x312342E1A4874F3F"
jhash (0xD9653728)
arguments {
float "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
float "p4" [=[ {} ]=],
float "p5" [=[ {} ]=],
float "p6" [=[ {} ]=],
float "p7" [=[ {} ]=],
BOOL "p8" [=[ {} ]=],
}
alias "0x312342E1A4874F3F"
ns "GRAPHICS"
returns "void"
doc [[!
```
p8 seems to always be false.
```
]]
native "GOLF_TRAIL_SET_RADIUS"
hash "0x2485D34E50A22E84"
jhash (0x72BA8A14)
arguments {
float "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
}
alias "0x2485D34E50A22E84"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "GOLF_TRAIL_SET_SHADER_PARAMS"
hash "0x9CFDD90B2B844BF7"
jhash (0x4EA70FB4)
arguments {
float "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
float "p4" [=[ {} ]=],
}
alias "0x9CFDD90B2B844BF7"
ns "GRAPHICS"
returns "void"
doc [[!
```
Only appeared in Golf & Golf_mp. Parameters were all ptrs
```
]]
native "GOLF_TRAIL_SET_TESSELLATION"
hash "0xDBAA5EC848BA2D46"
jhash (0xBB1A1294)
arguments {
int "p0" [=[ {} ]=],
int "p1" [=[ {} ]=],
}
alias "0xDBAA5EC848BA2D46"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "HAS_SCALEFORM_CONTAINER_MOVIE_LOADED_INTO_PARENT"
hash "0x8217150E1217EBFD"
jhash (0x1DFE8D8A)
arguments {
int "scaleformHandle" [=[ {} ]=],
}
ns "GRAPHICS"
returns "BOOL"
doc [[!
]]
native "HAS_SCALEFORM_MOVIE_FILENAME_LOADED"
hash "0x0C1C5D756FB5F337"
jhash (0x494A9E50)
arguments {
charPtr "scaleformName" [=[ {} ]=],
}
alias "0x0C1C5D756FB5F337"
alias "_HAS_NAMED_SCALEFORM_MOVIE_LOADED"
ns "GRAPHICS"
returns "BOOL"
doc [[!
```
Only values used in the scripts are:
"heist_mp"
"heistmap_mp"
"instructional_buttons"
"heist_pre"
```
]]
native "HAS_SCALEFORM_MOVIE_LOADED"
hash "0x85F01B8D5B90570E"
jhash (0xDDFB6448)
arguments {
int "scaleformHandle" [=[ {} ]=],
}
ns "GRAPHICS"
returns "BOOL"
doc [[!
]]
native "HAS_SCALEFORM_SCRIPT_HUD_MOVIE_LOADED"
hash "0xDF6E5987D2B4D140"
jhash (0x79B43255)
arguments {
int "hudComponent" [=[ {} ]=],
}
alias "_HAS_HUD_SCALEFORM_LOADED"
ns "GRAPHICS"
returns "BOOL"
doc [[!
]]
native "HAS_STREAMED_TEXTURE_DICT_LOADED"
hash "0x0145F696AAAAD2E4"
jhash (0x3F436EEF)
arguments {
charPtr "textureDict" [=[ {} ]=],
}
ns "GRAPHICS"
returns "BOOL"
doc [[!
]]
native "IS_DECAL_ALIVE"
hash "0xC694D74949CAFD0C"
jhash (0xCDD4A61A)
arguments {
int "decal" [=[ {} ]=],
}
ns "GRAPHICS"
returns "BOOL"
doc [[!
]]
native "IS_SCALEFORM_MOVIE_DELETING"
hash "0x86255B1FC929E33E"
arguments {
int "scaleformIndex" [=[ {} ]=],
}
alias "0x86255B1FC929E33E"
ns "GRAPHICS"
annotations [=[ {"cs_type":"Any"} ]=]
returns "BOOL"
doc [[!
```
NativeDB Introduced: v1290
```
Scaleform index returned by [`REQUEST_SCALEFORM_MOVIE`](#\_0x11FE353CF9733E6F) (or similar natives).
Returns true if a scaleform movie is being deleted from streaming memory (After it has been marked as no longer needed with [`SET_SCALEFORM_MOVIE_AS_NO_LONGER_NEEDED`](#\_0x1D132D614DD86811).
]]
native "IS_SCALEFORM_MOVIE_METHOD_RETURN_VALUE_READY"
hash "0x768FF8961BA904D6"
jhash (0x5CD7C3C0)
arguments {
int "method_return" [=[ {} ]=],
}
alias "0x768FF8961BA904D6"
alias "_GET_SCALEFORM_MOVIE_FUNCTION_RETURN_BOOL"
ns "GRAPHICS"
returns "BOOL"
doc [[!
methodReturn: The return value of this native: END_SCALEFORM_MOVIE_METHOD_RETURN_VALUE
Returns true if the return value of a scaleform function is ready to be collected (using GET_SCALEFORM_MOVIE_METHOD_RETURN_VALUE_STRING or GET_SCALEFORM_MOVIE_METHOD_RETURN_VALUE_INT).
The return value of this native: `EndScaleformMovieMethodReturn`
Returns true if the return value of a scaleform function is ready to be collected
]]
native "IS_SCREENBLUR_FADE_RUNNING"
hash "0x7B226C785A52A0A9"
jhash (0x926B8734)
alias "0x7B226C785A52A0A9"
ns "GRAPHICS"
returns "BOOL"
doc [[!
```
Returns whether screen transition to blur/from blur is running.
```
]]
native "IS_TRACKED_POINT_VISIBLE"
hash "0xC45CCDAAC9221CA8"
jhash (0x0BFC4F64)
arguments {
int "point" [=[ {} ]=],
}
ns "GRAPHICS"
returns "BOOL"
doc [[!
]]
native "LOAD_MISSION_CREATOR_PHOTO"
hash "0x4862437A486F91B0"
jhash (0x56C1E488)
arguments {
charPtr "p0" [=[ {} ]=],
AnyPtr "p1" [=[ {} ]=],
AnyPtr "p2" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
}
alias "0x4862437A486F91B0"
ns "GRAPHICS"
returns "BOOL"
doc [[!
]]
native "LOAD_MOVIE_MESH_SET"
hash "0xB66064452270E8F1"
jhash (0x9627905C)
arguments {
charPtr "movieMeshSetName" [=[ {} ]=],
}
ns "GRAPHICS"
returns "int"
doc [[!
]]
native "MOVE_VEHICLE_DECALS"
hash "0x84C8D7C2D30D3280"
jhash (0xCE9E6CF2)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "OVERRIDE_INTERIOR_SMOKE_END"
hash "0xEFB55E7C25D3B3BE"
jhash (0xE29EE145)
alias "0xEFB55E7C25D3B3BE"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "OVERRIDE_INTERIOR_SMOKE_LEVEL"
hash "0x1600FD8CF72EBC12"
jhash (0xD87CC710)
arguments {
float "level" [=[ {} ]=],
}
alias "0x1600FD8CF72EBC12"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "OVERRIDE_INTERIOR_SMOKE_NAME"
hash "0x2A2A52824DB96700"
jhash (0x0F486429)
arguments {
charPtr "name" [=[ {} ]=],
}
alias "0x2A2A52824DB96700"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "PASS_KEYBOARD_INPUT_TO_SCALEFORM"
hash "0xD1C7CB175E012964"
jhash (0xE9183D3A)
arguments {
int "scaleformHandle" [=[ {} ]=],
}
alias "0xD1C7CB175E012964"
ns "GRAPHICS"
returns "BOOL"
doc [[!
Passes keyboard input to scaleform. You must call this native every frame. Once an input occurs, this native will return true and call `SET_PC_KEY` scaleform movie method with the key that has been inputted.
The key parameter which is passed to the scaleform can also be: "BACKSPACE", "ENTER" or "\x1b" (Which is ESC).
This native is only used in `web_browser.c` as of game build 2944.
Scaleform movie handle returned by [REQUEST_SCALEFORM_MOVIE](#\_0x11FE353CF9733E6F)
Bool indicating if an input occurred this frame and was passed to the scaleform.
]]
native "PATCH_DECAL_DIFFUSE_MAP"
hash "0x8A35C742130C6080"
jhash (0x335695CF)
arguments {
int "decalType" [=[ {} ]=],
charPtr "textureDict" [=[ {} ]=],
charPtr "textureName" [=[ {} ]=],
}
alias "0x8A35C742130C6080"
alias "_ADD_DECAL_TO_MARKER"
alias "_OVERRIDE_DECAL_TEXTURE"
ns "GRAPHICS"
returns "void"
doc [[!
```
REQUEST_STREAMED_TEXTURE_DICT("MPOnMissMarkers", false);
*uParam0.f_809 = add_decal(9120, vParam1, vVar4, vVar7, 2f, 2f, to_float(iVar0) / 255f, to_float(iVar1) / 255f, to_float(iVar2) / 255f, 1f, -1f, 1, 0, 0);
PATCH_DECAL_DIFFUSE_MAP(9120, "MPOnMissMarkers", "Capture_The_Flag_Base_Icon");
```
]]
native "POP_TIMECYCLE_MODIFIER"
hash "0x3C8938D7D872211E"
jhash (0x79D7D235)
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "PRESET_INTERIOR_AMBIENT_CACHE"
hash "0xD7021272EB0A451E"
jhash (0x137E3E24)
arguments {
charPtr "timecycleModifierName" [=[ {} ]=],
}
alias "0xD7021272EB0A451E"
alias "_PRESET_INTERIOR_AMBIENT_CACHE"
ns "GRAPHICS"
returns "void"
doc [[!
```
Only one match in the scripts:
GRAPHICS::PRESET_INTERIOR_AMBIENT_CACHE("int_carrier_hanger");
```
]]
native "PUSH_TIMECYCLE_MODIFIER"
hash "0x58F735290861E6B4"
jhash (0x7E082045)
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "QUERY_MOVIE_MESH_SET_STATE"
hash "0x9B6E70C5CEEF4EEB"
jhash (0x9D5D9B38)
arguments {
Any "p0" [=[ {} ]=],
}
alias "0x9B6E70C5CEEF4EEB"
ns "GRAPHICS"
returns "Any"
doc [[!
]]
native "QUEUE_OPERATION_TO_CREATE_SORTED_LIST_OF_PHOTOS"
hash "0x2A893980E96B659A"
jhash (0x199FABF0)
arguments {
BOOL "scanForSaving" [=[ {} ]=],
}
alias "0x2A893980E96B659A"
ns "GRAPHICS"
returns "BOOL"
doc [[!
Queues a scan of all gallery photos.
Also see [`GET_STATUS_OF_SORTED_LIST_OPERATION`](#\_0xF5BED327CEA362B1)
Returns true if the operation began.
]]
native "RELEASE_MOVIE_MESH_SET"
hash "0xEB119AA014E89183"
jhash (0x4FA5501D)
arguments {
int "movieMeshSet" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "REMOVE_DECAL"
hash "0xED3F346429CCD659"
jhash (0xA4363188)
arguments {
int "decal" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "REMOVE_DECALS_FROM_OBJECT"
hash "0xCCF71CBDDF5B6CB9"
jhash (0x8B67DCA7)
arguments {
Object "obj" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "REMOVE_DECALS_FROM_OBJECT_FACING"
hash "0xA6F6F70FDC6D144C"
jhash (0xF4999A55)
arguments {
Object "obj" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "REMOVE_DECALS_FROM_VEHICLE"
hash "0xE91F1B65F2B48D57"
jhash (0x831D06CA)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "REMOVE_DECALS_IN_RANGE"
hash "0x5D6B2D4830A67C62"
jhash (0x06A619A0)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "range" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
Removes all decals in range from a position, it includes the bullet holes, blood pools, petrol...
```
]]
native "REMOVE_PARTICLE_FX"
hash "0xC401503DFE8D53CF"
jhash (0x6BA48C7E)
arguments {
int "ptfxHandle" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "REMOVE_PARTICLE_FX_FROM_ENTITY"
hash "0xB8FEAEEBCC127425"
jhash (0xCEDE52E9)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "REMOVE_PARTICLE_FX_IN_RANGE"
hash "0xDD19FA1C6D657305"
jhash (0x7EB8F275)
arguments {
float "X" [=[ {} ]=],
float "Y" [=[ {} ]=],
float "Z" [=[ {} ]=],
float "radius" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "REMOVE_SCALEFORM_SCRIPT_HUD_MOVIE"
hash "0xF44A5456AC3F4F97"
jhash (0x03D87600)
arguments {
int "hudComponent" [=[ {} ]=],
}
alias "0xF44A5456AC3F4F97"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "REMOVE_TCMODIFIER_OVERRIDE"
hash "0x15E33297C3E8DC60"
jhash (0x805BAB08)
arguments {
charPtr "p0" [=[ {} ]=],
}
alias "0x15E33297C3E8DC60"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "REMOVE_VEHICLE_CREW_EMBLEM"
hash "0xD2300034310557E4"
jhash (0x667046A8)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "p1" [=[ {} ]=],
}
alias "0xD2300034310557E4"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "REQUEST_SCALEFORM_MOVIE"
hash "0x11FE353CF9733E6F"
jhash (0xC67E3DCB)
arguments {
charPtr "scaleformName" [=[ {} ]=],
}
ns "GRAPHICS"
returns "int"
doc [[!
]]
native "REQUEST_SCALEFORM_MOVIE_INSTANCE"
hash "0xC514489CFB8AF806"
jhash (0x7CC8057D)
arguments {
charPtr "scaleformName" [=[ {} ]=],
}
ns "GRAPHICS"
returns "int"
doc [[!
Same as [REQUEST_SCALEFORM_MOVIE](#\_0x11FE353CF9733E6F), except it seems to fix stretched scaleforms on ultrawide.
]]
native "REQUEST_SCALEFORM_MOVIE_SKIP_RENDER_WHILE_PAUSED"
hash "0xBD06C611BB9048C2"
arguments {
charPtr "scaleformName" [=[ {} ]=],
}
alias "_REQUEST_SCALEFORM_MOVIE3"
alias "_REQUEST_SCALEFORM_MOVIE_INTERACTIVE"
ns "GRAPHICS"
returns "int"
doc [[!
Requests a scaleform movie that doesn't render when the game is paused (With [`SET_GAME_PAUSED`](#\_0x577D1284D6873711)).
]]
native "REQUEST_SCALEFORM_MOVIE_WITH_IGNORE_SUPER_WIDESCREEN"
hash "0x65E7E78842E74CDB"
arguments {
charPtr "scaleformName" [=[ {} ]=],
}
alias "0x65E7E78842E74CDB"
alias "_REQUEST_SCALEFORM_MOVIE_2"
ns "GRAPHICS"
returns "int"
doc [[!
Requests a scaleform movie, which has no widescreen adjustments while rendering (Useful for when your scaleform doesn't fully draw on the screen and borders are visible).
]]
native "REQUEST_SCALEFORM_SCRIPT_HUD_MOVIE"
hash "0x9304881D6F6537EA"
jhash (0x7AF85862)
arguments {
int "hudComponent" [=[ {} ]=],
}
alias "0x9304881D6F6537EA"
alias "_REQUEST_HUD_SCALEFORM"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "REQUEST_STREAMED_TEXTURE_DICT"
hash "0xDFA2EF8E04127DD5"
jhash (0x4C9B035F)
arguments {
charPtr "textureDict" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
This function can requests texture dictonaries from following RPFs:
scaleform_generic.rpf
scaleform_minigames.rpf
scaleform_minimap.rpf
scaleform_web.rpf
last param isnt a toggle
```
]]
native "RESET_ADAPTATION"
hash "0xE3E2C1B4C59DBC77"
jhash (0xD8CC7221)
arguments {
int "numFrames" [=[ {} ]=],
}
alias "0xE3E2C1B4C59DBC77"
ns "GRAPHICS"
returns "void"
doc [[!
Resets AnimPostFX adaptation.
Number of frames.
]]
native "RESET_PARTICLE_FX_OVERRIDE"
hash "0x89C8553DD3274AAE"
jhash (0x9E8D8B72)
arguments {
charPtr "name" [=[ {} ]=],
}
alias "0x89C8553DD3274AAE"
alias "_RESET_PARTICLE_FX_ASSET_OLD_TO_NEW"
ns "GRAPHICS"
returns "void"
doc [[!
```
Resets the effect of SET_PARTICLE_FX_OVERRIDE
```
]]
native "RESET_PAUSED_RENDERPHASES"
hash "0xE1C8709406F2C41C"
jhash (0x0113EAE4)
alias "0xE1C8709406F2C41C"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "RESET_SCRIPT_GFX_ALIGN"
hash "0xE3A3DB414A373DAB"
jhash (0x3FE33BD6)
alias "0xE3A3DB414A373DAB"
alias "_SCREEN_DRAW_POSITION_END"
ns "GRAPHICS"
returns "void"
doc [[!
This function resets the alignment set using `SET_SCRIPT_GFX_ALIGN` and `SET_SCRIPT_GFX_ALIGN_PARAMS` to the default
values ('I', 'I'; 0, 0, 0, 0). This should be used after having used the aforementioned functions in order to not affect
any other scripts attempting to draw.
]]
native "SAVE_HIGH_QUALITY_PHOTO"
hash "0x3DEC726C25A11BAC"
jhash (0x3B15D33C)
arguments {
int "unused" [=[ {} ]=],
}
alias "0x3DEC726C25A11BAC"
ns "GRAPHICS"
returns "BOOL"
doc [[!
]]
native "SCALEFORM_MOVIE_METHOD_ADD_PARAM_BOOL"
hash "0xC58424BA936EB458"
jhash (0x0D4AE8CB)
arguments {
BOOL "value" [=[ {} ]=],
}
alias "_PUSH_SCALEFORM_MOVIE_FUNCTION_PARAMETER_BOOL"
alias "_PUSH_SCALEFORM_MOVIE_METHOD_PARAMETER_BOOL"
ns "GRAPHICS"
returns "void"
doc [[!
```
Pushes a boolean for the Scaleform function onto the stack.
```
]]
native "SCALEFORM_MOVIE_METHOD_ADD_PARAM_FLOAT"
hash "0xD69736AAE04DB51A"
jhash (0x9A01FFDA)
arguments {
float "value" [=[ {} ]=],
}
alias "_PUSH_SCALEFORM_MOVIE_FUNCTION_PARAMETER_FLOAT"
alias "_PUSH_SCALEFORM_MOVIE_METHOD_PARAMETER_FLOAT"
ns "GRAPHICS"
returns "void"
doc [[!
```
Pushes a float for the Scaleform function onto the stack.
```
]]
native "SCALEFORM_MOVIE_METHOD_ADD_PARAM_INT"
hash "0xC3D0841A0CC546A6"
jhash (0x716777CB)
arguments {
int "value" [=[ {} ]=],
}
alias "_PUSH_SCALEFORM_MOVIE_FUNCTION_PARAMETER_INT"
alias "_PUSH_SCALEFORM_MOVIE_METHOD_PARAMETER_INT"
ns "GRAPHICS"
returns "void"
doc [[!
```
Pushes an integer for the Scaleform function onto the stack.
```
]]
native "SCALEFORM_MOVIE_METHOD_ADD_PARAM_LATEST_BRIEF_STRING"
hash "0xEC52C631A1831C03"
jhash (0x83A9811D)
arguments {
int "value" [=[ {} ]=],
}
alias "0xEC52C631A1831C03"
alias "_SCALEFORM_MOVIE_METHOD_ADD_PARAM_INT_STRING"
ns "GRAPHICS"
returns "void"
doc [[!
Values:
0 - Dialogue Brief
1 - Help Text Brief
2 - Mission Objective Brief
]]
native "SCALEFORM_MOVIE_METHOD_ADD_PARAM_LITERAL_STRING"
hash "0x77FE3402004CD1B0"
arguments {
charPtr "string" [=[ {} ]=],
}
alias "0x77FE3402004CD1B0"
alias "_PUSH_SCALEFORM_MOVIE_METHOD_PARAMETER_STRING_2"
alias "_SCALEFORM_MOVIE_METHOD_ADD_PARAM_TEXTURE_NAME_STRING_2"
ns "GRAPHICS"
returns "void"
doc [[!
Adds a literal string to a scaleform movie method.
There doesn't seem to be any difference between this and other `SCALEFORM_MOVIE_METHOD_ADD_PARAM_*_STRING` natives in game code.
]]
native "SCALEFORM_MOVIE_METHOD_ADD_PARAM_PLAYER_NAME_STRING"
hash "0xE83A3E3557A56640"
jhash (0xCCBF0334)
arguments {
charPtr "string" [=[ {} ]=],
}
alias "0xE83A3E3557A56640"
alias "_PUSH_SCALEFORM_MOVIE_METHOD_PARAMETER_BUTTON_NAME"
ns "GRAPHICS"
returns "void"
doc [[!
```
This method is the equivalent to PUSH_SCALEFORM_MOVIE_FUNCTION_PARAMETER_STRING when using it to add a new button (like "INSTRUCTIONAL_BUTTONS").
When switching with a controller, the icons update and become the controller's icons.
```
]]
native "SCALEFORM_MOVIE_METHOD_ADD_PARAM_TEXTURE_NAME_STRING"
hash "0xBA7148484BD90365"
jhash (0x4DAAD55B)
arguments {
charPtr "string" [=[ {} ]=],
}
alias "_PUSH_SCALEFORM_MOVIE_FUNCTION_PARAMETER_STRING"
alias "_PUSH_SCALEFORM_MOVIE_METHOD_PARAMETER_STRING"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "SEETHROUGH_RESET"
hash "0x70A64C0234EF522C"
jhash (0x310E9B67)
ns "GRAPHICS"
returns "void"
doc [[!
```
NativeDB Introduced: v323
```
]]
native "SEETHROUGH_SET_COLOR_NEAR"
hash "0x1086127B3A63505E"
jhash (0x5B2A67A8)
arguments {
int "red" [=[ {} ]=],
int "green" [=[ {} ]=],
int "blue" [=[ {} ]=],
}
alias "0x1086127B3A63505E"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "SEETHROUGH_SET_HEATSCALE"
hash "0xD7D0B00177485411"
jhash (0x654F0287)
arguments {
int "index" [=[ {} ]=],
float "heatScale" [=[ {} ]=],
}
alias "0xD7D0B00177485411"
ns "GRAPHICS"
returns "void"
doc [[!
min: 0.0 max: 0.75
]]
native "SET_ARTIFICIAL_LIGHTS_STATE"
hash "0x1268615ACE24D504"
jhash (0xAA2A0EAF)
arguments {
BOOL "state" [=[ {} ]=],
}
alias "_SET_BLACKOUT"
ns "GRAPHICS"
returns "void"
doc [[!
Does not affect weapons, particles, fire/explosions, flashlights or the sun.
When set to true, all emissive textures (including ped components that have light effects), street lights, building lights, vehicle lights, etc will all be turned off.
Used in Humane Labs Heist for EMP.
True turns off all artificial light sources in the map: buildings, street lights, car lights, etc. False turns them back on.
]]
native "SET_BACKFACECULLING"
hash "0x23BA6B0C2AD7B0D3"
jhash (0xC44C2F44)
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0x23BA6B0C2AD7B0D3"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "SET_CHECKPOINT_CYLINDER_HEIGHT"
hash "0x2707AAE9D9297D89"
jhash (0xFF0F9B22)
arguments {
int "checkpoint" [=[ {} ]=],
float "nearHeight" [=[ {} ]=],
float "farHeight" [=[ {} ]=],
float "radius" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
Sets the cylinder height of the checkpoint.
Parameters:
* nearHeight - The height of the checkpoint when inside of the radius.
* farHeight - The height of the checkpoint when outside of the radius.
* radius - The radius of the checkpoint.
```
]]
native "SET_CHECKPOINT_RGBA"
hash "0x7167371E8AD747F7"
jhash (0xEF9C8CB3)
arguments {
int "checkpoint" [=[ {} ]=],
int "red" [=[ {} ]=],
int "green" [=[ {} ]=],
int "blue" [=[ {} ]=],
int "alpha" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
Sets the checkpoint color.
```
]]
native "SET_CHECKPOINT_RGBA2"
hash "0xB9EA40907C680580"
jhash (0xA5456DBB)
arguments {
int "checkpoint" [=[ {} ]=],
int "red" [=[ {} ]=],
int "green" [=[ {} ]=],
int "blue" [=[ {} ]=],
int "alpha" [=[ {} ]=],
}
alias "_SET_CHECKPOINT_ICON_RGBA"
ns "GRAPHICS"
returns "void"
doc [[!
```
Sets the checkpoint icon color.
```
]]
native "SET_CURRENT_PLAYER_TCMODIFIER"
hash "0xBBF327DED94E4DEB"
jhash (0x85BA15A4)
arguments {
charPtr "modifierName" [=[ {} ]=],
}
alias "0xBBF327DED94E4DEB"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "SET_DEBUG_LINES_AND_SPHERES_DRAWING_ACTIVE"
hash "0x175B6BFC15CDD0C5"
jhash (0x1418CA37)
arguments {
BOOL "enabled" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
NOTE: Debugging functions are not present in the retail version of the game.
```
]]
native "SET_DISABLE_DECAL_RENDERING_THIS_FRAME"
hash "0x4B5CFC83122DF602"
jhash (0xA706E84D)
alias "0x4B5CFC83122DF602"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "SET_DISABLE_PETROL_DECALS_IGNITING_THIS_FRAME"
hash "0xD9454B5752C857DC"
jhash (0xEAB6417C)
alias "0xD9454B5752C857DC"
ns "GRAPHICS"
returns "void"
doc [[!
Prevents gas / petrol decals (aka gas / petrol trails and puddles) to be ignited on fire during the frame in which the native is called.
**Note**: This native needs to be called every frame to prevent ignition.
]]
native "SET_DRAW_ORIGIN"
hash "0xAA0008F3BBB8F416"
jhash (0xE10198D5)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
Sets the on-screen drawing origin for draw-functions in world coordinates.
The effect can be reset by calling [`CLEAR_DRAW_ORIGIN`](#\_0xFF0B610F6BE0D7AF) and is limited to 32 different origins each frame.
]]
native "SET_ENTITY_ICON_COLOR"
hash "0x1D5F595CCAE2E238"
jhash (0x6EE1E946)
arguments {
Entity "entity" [=[ {} ]=],
int "red" [=[ {} ]=],
int "green" [=[ {} ]=],
int "blue" [=[ {} ]=],
int "alpha" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "SET_ENTITY_ICON_VISIBILITY"
hash "0xE0E8BEECCA96BA31"
jhash (0xD1D2FD52)
arguments {
Entity "entity" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "SET_FLASH"
hash "0x0AB84296FED9CFC6"
jhash (0x7E55A1EE)
arguments {
float "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "fadeIn" [=[ {} ]=],
float "duration" [=[ {} ]=],
float "fadeOut" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
Purpose of p0 and p1 unknown.
```
]]
native "SET_HIDOF_OVERRIDE"
hash "0xBA3D65906822BED5"
jhash (0x513D444B)
arguments {
BOOL "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
float "nearplaneOut" [=[ {} ]=],
float "nearplaneIn" [=[ {} ]=],
float "farplaneOut" [=[ {} ]=],
float "farplaneIn" [=[ {} ]=],
}
alias "0xBA3D65906822BED5"
alias "_SET_HIDOF_ENV_BLUR_PARAMS"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "SET_NEXT_PLAYER_TCMODIFIER"
hash "0xBF59707B3E5ED531"
jhash (0x554BA16E)
arguments {
charPtr "modifierName" [=[ {} ]=],
}
alias "0xBF59707B3E5ED531"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "SET_NIGHTVISION"
hash "0x18F621F7A5B1F85D"
jhash (0xD1E5565F)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
Enables Night Vision.
Example:
C#: Function.Call(Hash.SET_NIGHTVISION, true);
C++: GRAPHICS::SET_NIGHTVISION(true);
BOOL toggle:
true = turns night vision on for your player.
false = turns night vision off for your player.
```
]]
native "SET_NOISEOVERIDE"
hash "0xE787BF1C5CF823C9"
jhash (0xD576F5DD)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "SET_NOISINESSOVERIDE"
hash "0xCB6A7C3BB17A0C67"
jhash (0x046B62D9)
arguments {
float "value" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "SET_PARTICLE_FX_BULLET_IMPACT_SCALE"
hash "0x27E32866E9A5C416"
jhash (0xC1AD5DDF)
arguments {
float "scale" [=[ {} ]=],
}
alias "0x27E32866E9A5C416"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "SET_PARTICLE_FX_CAM_INSIDE_NONPLAYER_VEHICLE"
hash "0xACEE6F360FC1F6B6"
jhash (0x6B125A02)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "SET_PARTICLE_FX_CAM_INSIDE_VEHICLE"
hash "0xEEC4047028426510"
jhash (0x19EC0001)
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "SET_PARTICLE_FX_LOOPED_ALPHA"
hash "0x726845132380142E"
jhash (0x5ED49BE1)
arguments {
int "ptfxHandle" [=[ {} ]=],
float "alpha" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "SET_PARTICLE_FX_LOOPED_COLOUR"
hash "0x7F8F65877F88783B"
jhash (0x5219D530)
arguments {
int "ptfxHandle" [=[ {} ]=],
float "r" [=[ {} ]=],
float "g" [=[ {} ]=],
float "b" [=[ {} ]=],
BOOL "bLocalOnly" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
Sets the colour tint of a previously started looped particle effect
You can use the [inverse lerp](https://www.gamedev.net/articles/programming/general-and-gameplay-programming/inverse-lerp-a-super-useful-yet-often-overlooked-function-r5230/) method to normalize in a range from 0.0 to 1.0 an rgb
range from 0.0 to 1.0
range from 0.0 to 1.0
range from 0.0 to 1.0
False by default. Defines whether the effect should be sent and modified over the network or not. Set this to `true` if you don't want to send the effect over the network.
]]
native "SET_PARTICLE_FX_LOOPED_EVOLUTION"
hash "0x5F0C4B5B1C393BE2"
jhash (0x1CBC1373)
arguments {
int "ptfxHandle" [=[ {} ]=],
charPtr "propertyName" [=[ {} ]=],
float "amount" [=[ {} ]=],
BOOL "noNetwork" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "SET_PARTICLE_FX_LOOPED_FAR_CLIP_DIST"
hash "0xDCB194B85EF7B541"
jhash (0x233DE879)
arguments {
int "ptfxHandle" [=[ {} ]=],
float "range" [=[ {} ]=],
}
alias "_SET_PARTICLE_FX_LOOPED_RANGE"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "SET_PARTICLE_FX_LOOPED_OFFSETS"
hash "0xF7DDEBEC43483C43"
jhash (0x641F7790)
arguments {
int "ptfxHandle" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "rotX" [=[ {} ]=],
float "rotY" [=[ {} ]=],
float "rotZ" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "SET_PARTICLE_FX_LOOPED_SCALE"
hash "0xB44250AAA456492D"
jhash (0x099B8B49)
arguments {
int "ptfxHandle" [=[ {} ]=],
float "scale" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "SET_PARTICLE_FX_NON_LOOPED_ALPHA"
hash "0x77168D722C58B2FC"
jhash (0x497EAFF2)
arguments {
float "alpha" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
Usage example for C#:
Function.Call(Hash.SET_PARTICLE_FX_NON_LOOPED_ALPHA, new InputArgument[] { 0.1f });
Note: the argument alpha ranges from 0.0f-1.0f !
```
]]
native "SET_PARTICLE_FX_NON_LOOPED_COLOUR"
hash "0x26143A59EF48B262"
jhash (0x7B689E20)
arguments {
float "r" [=[ {} ]=],
float "g" [=[ {} ]=],
float "b" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
Only works on some fx's, while on others it might SEEM to work "properly", but the colors can be "strange" or even completly different from what you've expected. Reason for this is that those fx's might already have colors "baked into them" which then start to act as a "mixing palette", resulting in a different color than expected. A hypothetical example of this would be if the fx itself is already full (bright) red (RGB: 1.0, 0.0, 0.0) and you then set the color to (bright) green (RGB: 0.0, 1.0, 0.0), that it MIGHT result in Yellow (RGB: 1.0, 1.0, 0.0).
This doc previously stated that the set color is **NOT** networked, however it does actually turns out to be networked. Tested with all fireworks effects and several other FX effects resulted in colored fx effects on all clients when used in combination with [START_NETWORKED_PARTICLE_FX_NON_LOOPED_AT_COORD](#\_0xF56B8137DF10135D).
This might however not be the case for all types of particle fx's, so it's recommended to test this thoroughly with multiple clients before releasing your script for example.
Red (0.0 - 1.0)
Green (0.0 - 1.0)
Blue (0.0 - 1.0)
]]
native "SET_PARTICLE_FX_OVERRIDE"
hash "0xEA1E2D93F6F75ED9"
jhash (0xC92719A7)
arguments {
charPtr "oldAsset" [=[ {} ]=],
charPtr "newAsset" [=[ {} ]=],
}
alias "_SET_PTFX_ASSET_OLD_2_NEW"
alias "_SET_PARTICLE_FX_ASSET_OLD_TO_NEW"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "SET_PARTICLE_FX_SHOOTOUT_BOAT"
hash "0x96EF97DAEB89BEF5"
jhash (0xD938DEE0)
arguments {
Any "p0" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "SET_PLAYER_TCMODIFIER_TRANSITION"
hash "0xBDEB86F4D5809204"
jhash (0x9559BB38)
arguments {
float "value" [=[ {} ]=],
}
alias "0xBDEB86F4D5809204"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "SET_SCALEFORM_MOVIE_AS_NO_LONGER_NEEDED"
hash "0x1D132D614DD86811"
jhash (0x5FED3BA1)
arguments {
intPtr "scaleformHandle" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "SET_SCALEFORM_MOVIE_TO_USE_LARGE_RT"
hash "0x32F34FF7F617643B"
arguments {
int "scaleformMovieId" [=[ {} ]=],
BOOL "useLargeRT" [=[ {"cs_type":"Any"} ]=],
}
alias "0x32F34FF7F617643B"
ns "GRAPHICS"
returns "void"
doc [[!
```
NativeDB Introduced: v573
```
Configures a Scaleform movie to render to a large render target (1280x720), which is useful for ensuring higher quality and clarity in certain display scenarios. Such as displaying the name of an organization (CEO Office) in a visually impactful way for example.
The handle of the Scaleform to be used.
A boolean switch to enable/disable the use of the large rendertarget.
]]
native "SET_SCALEFORM_MOVIE_TO_USE_SUPER_LARGE_RT"
hash "0xE6A9F00D4240B519"
arguments {
int "scaleformHandle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0xE6A9F00D4240B519"
alias "_SET_SCALEFORM_FIT_RENDERTARGET"
ns "GRAPHICS"
returns "void"
doc [[!
Adjusts a scaleform movie's dimensions to fit a large rendertarget. Mostly used in casino scripts.
]]
native "SET_SCALEFORM_MOVIE_TO_USE_SYSTEM_TIME"
hash "0x6D8EB211944DCE08"
jhash (0x18C9DE8D)
arguments {
int "scaleform" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "SET_SCRIPT_GFX_ALIGN"
hash "0xB8A850F20A067EB6"
jhash (0x228A2598)
arguments {
int "horizontalAlign" [=[ {} ]=],
int "verticalAlign" [=[ {} ]=],
}
alias "_SET_SCREEN_DRAW_POSITION"
alias "_SCREEN_DRAW_POSITION_BEGIN"
ns "GRAPHICS"
returns "void"
doc [[!
This function anchors script draws to a side of the safe zone. This needs to be called to make the interface
independent of the player's safe zone configuration.
These values are equivalent to `alignX` and `alignY` in `common:/data/ui/frontend.xml`, which can be used as a baseline
for default alignment.
Valid values for `horizontalAlign`, from original documentation:
* **C (67)** - Center: DRAW_TEXT starts in the middle of the screen, while DRAW_RECT starts on the right; both move with
the right side of the screen.
* **L (76)** - Left: Anchors to the left side, DRAW_RECT starts on the left side of the screen, same as DRAW_TEXT when
centered.
* **R (82)** - Right: DRAW_TEXT starts on the left side (normal 0,0), while DRAW_RECT starts some short distance away
from the right side of the screen, both move with the right side of the screen.
Valid values for `verticalAlign`, from original documentation:
* **B (66)** - Bottom: DRAW_RECT starts about as far as the middle of the map from the bottom, while DRAW_TEXT is about
rather centered.
* **C (67)** - Center: It starts at a certain distance from the bottom, but the distance is fixed, the distance is
different from 66.
* **T (84)** - Top: Anchors to the top, DRAW_RECT starts on the top of the screen, DRAW_TEXT just below it.
Using any other value (including 0) will result in the safe zone not being taken into account for this draw. The
canonical value for this is 'I' (73).
For example, you can use `SET_SCRIPT_GFX_ALIGN(0, 84)` to only scale on the Y axis (to the top), but not change the X
axis.
To reset the value, use `RESET_SCRIPT_GFX_ALIGN`.
The horizontal alignment. This can be 67 ('C'), 76 ('L'), or 82 ('R').
The vertical alignment. This can be 67 ('C'), 66 ('B'), or 84 ('T').
]]
native "SET_SCRIPT_GFX_ALIGN_PARAMS"
hash "0xF5A2C681787E579D"
jhash (0x76C641E4)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "w" [=[ {} ]=],
float "h" [=[ {} ]=],
}
alias "0xF5A2C681787E579D"
alias "_SCREEN_DRAW_POSITION_RATIO"
ns "GRAPHICS"
returns "void"
doc [[!
Sets the draw offset/calculated size for `SET_SCRIPT_GFX_ALIGN`. If using any alignment other than left/top, the game
expects the width/height to be configured using this native in order to get a proper starting position for the draw
command.
The X offset for the item to be drawn.
The Y offset for the item to be drawn.
The width of the item to be drawn.
The height of the item to be drawn.
]]
native "SET_SCRIPT_GFX_DRAW_BEHIND_PAUSEMENU"
hash "0xC6372ECD45D73BCD"
jhash (0xF8FBCC25)
arguments {
BOOL "flag" [=[ {} ]=],
}
alias "0xC6372ECD45D73BCD"
ns "GRAPHICS"
returns "void"
doc [[!
Sets a flag defining whether or not script draw commands should continue being drawn behind the pause menu. This is usually used for TV channels and other draw commands that are used with a world render target.
A boolean value.
]]
native "SET_SCRIPT_GFX_DRAW_ORDER"
hash "0x61BB1D9B3A95D802"
jhash (0xADF81D24)
arguments {
int "order" [=[ {} ]=],
}
alias "0x61BB1D9B3A95D802"
alias "_SET_2D_LAYER"
alias "_SET_UI_LAYER"
ns "GRAPHICS"
returns "void"
doc [[!
Sets the draw order for script draw commands.
Examples from decompiled scripts:
GRAPHICS::SET_SCRIPT_GFX_DRAW_ORDER(7);
GRAPHICS::DRAW_RECT(0.5, 0.5, 3.0, 3.0, v\_4, v\_5, v\_6, a\_0.\_f172, 0);
GRAPHICS::SET_SCRIPT_GFX_DRAW_ORDER(1);
GRAPHICS::DRAW_RECT(0.5, 0.5, 1.5, 1.5, 0, 0, 0, 255, 0);
```cpp
enum eGfxDrawOrder
{
GFX_ORDER_BEFORE_HUD_PRIORITY_LOW = 0,
GFX_ORDER_BEFORE_HUD = 1,
GFX_ORDER_BEFORE_HUD_PRIORITY_HIGH = 2,
GFX_ORDER_AFTER_HUD_PRIORITY_LOW = 3,
GFX_ORDER_AFTER_HUD = 4,
GFX_ORDER_AFTER_HUD_PRIORITY_HIGH = 5,
GFX_ORDER_AFTER_FADE_PRIORITY_LOW = 6,
GFX_ORDER_AFTER_FADE = 7,
GFX_ORDER_AFTER_FADE_PRIORITY_HIGH = 8,
}
```
The intended draw order/layer.
]]
native "SET_SEETHROUGH"
hash "0x7E08924259E08CE0"
jhash (0x74D4995C)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
Toggles Heatvision on/off.
```
]]
native "SET_STREAMED_TEXTURE_DICT_AS_NO_LONGER_NEEDED"
hash "0xBE2CACCF5A8AA805"
jhash (0xF07DDA38)
arguments {
charPtr "textureDict" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "SET_TIMECYCLE_MODIFIER"
hash "0x2C933ABF17A1DF41"
jhash (0xA81F3638)
arguments {
charPtr "modifierName" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
Loads the specified timecycle modifier. Modifiers are defined separately in another file (e.g. "timecycle_mods_1.xml")
Parameters:
modifierName - The modifier to load (e.g. "V_FIB_IT3", "scanline_cam", etc.)
```
]]
native "SET_TIMECYCLE_MODIFIER_STRENGTH"
hash "0x82E7FFCD5B2326B3"
jhash (0x458F4F45)
arguments {
float "strength" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "SET_TRACKED_POINT_INFO"
hash "0x164ECBB3CF750CB0"
jhash (0x28689AA4)
arguments {
int "point" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "radius" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "SET_TRANSITION_TIMECYCLE_MODIFIER"
hash "0x3BCF567485E1971C"
jhash (0xBB2BA72A)
arguments {
charPtr "modifierName" [=[ {} ]=],
float "transition" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
This native doesn't work like [`SetWeatherTypeTransition`](#\_0x578C752848ECFA0C).
The name of a timecycle
The speed to transition to `modifierName`. Appears to be half-seconds (?)
]]
native "SET_TV_AUDIO_FRONTEND"
hash "0x113D2C5DC57E1774"
jhash (0x2E0DFA35)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
Probably changes tvs from being a 3d audio to being "global" audio
```
]]
native "SET_TV_CHANNEL"
hash "0xBAABBB23EB6E484E"
jhash (0x41A8A627)
arguments {
int "channel" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "SET_TV_CHANNEL_PLAYLIST"
hash "0xF7B38B8305F1FE8B"
jhash (0xB262DE67)
arguments {
int "tvChannel" [=[ {} ]=],
charPtr "playlistName" [=[ {} ]=],
BOOL "restart" [=[ {} ]=],
}
alias "0xF7B38B8305F1FE8B"
alias "_LOAD_TV_CHANNEL_SEQUENCE"
ns "GRAPHICS"
returns "void"
doc [[!
Loads specified video sequence into the TV Channel
TV_Channel ranges from 0-2
VideoSequence can be any of the following:
"PL_STD_CNT" CNT Standard Channel
"PL_STD_WZL" Weazel Standard Channel
"PL_LO_CNT"
"PL_LO_WZL"
"PL_SP_WORKOUT"
"PL_SP_INV" - Jay Norris Assassination Mission Fail
"PL_SP_INV_EXP" - Jay Norris Assassination Mission Success
"PL_LO_RS" - Righteous Slaughter Ad
"PL_LO_RS_CUTSCENE" - Righteous Slaughter Cut-scene
"PL_SP_PLSH1\_INTRO"
"PL_LES1\_FAME_OR_SHAME"
"PL_STD_WZL_FOS_EP2"
"PL_MP_WEAZEL" - Weazel Logo on loop
"PL_MP_CCTV" - Generic CCTV loop
Restart:
0=video sequence continues as normal
1=sequence restarts from beginning every time that channel is selected
The above playlists work as intended, and are commonly used, but there are many more playlists, as seen in `tvplaylists.xml`. A pastebin below outlines all playlists, they will be surronded by the name tag I.E. (PL_STD_CNT = PL_STD_CNT).
https://pastebin.com/zUzGB6h7
]]
native "SET_TV_CHANNEL_PLAYLIST_AT_HOUR"
hash "0x2201C576FACAEBE8"
jhash (0x78C4DCBE)
arguments {
int "tvChannel" [=[ {} ]=],
charPtr "playlistName" [=[ {} ]=],
int "hour" [=[ {} ]=],
}
alias "0x2201C576FACAEBE8"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "SET_TV_VOLUME"
hash "0x2982BF73F66E9DDC"
jhash (0xF3504F4D)
arguments {
float "volume" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "START_NETWORKED_PARTICLE_FX_LOOPED_ON_ENTITY"
hash "0x6F60E89A7B64EE1D"
jhash (0x110752B2)
arguments {
charPtr "effectName" [=[ {} ]=],
Entity "entity" [=[ {} ]=],
float "xOffset" [=[ {} ]=],
float "yOffset" [=[ {} ]=],
float "zOffset" [=[ {} ]=],
float "xRot" [=[ {} ]=],
float "yRot" [=[ {} ]=],
float "zRot" [=[ {} ]=],
float "scale" [=[ {} ]=],
BOOL "xAxis" [=[ {} ]=],
BOOL "yAxis" [=[ {} ]=],
BOOL "zAxis" [=[ {} ]=],
}
alias "0x6F60E89A7B64EE1D"
alias "_START_PARTICLE_FX_LOOPED_ON_ENTITY_2"
ns "GRAPHICS"
returns "int"
doc [[!
```
network fx
```
```
NativeDB Added Parameter 13: Any p12
NativeDB Added Parameter 14: Any p13
NativeDB Added Parameter 15: Any p14
NativeDB Added Parameter 16: Any p15
```
]]
native "START_NETWORKED_PARTICLE_FX_LOOPED_ON_ENTITY_BONE"
hash "0xDDE23F30CC5A0F03"
jhash (0xF478EFCF)
arguments {
charPtr "effectName" [=[ {} ]=],
Entity "entity" [=[ {} ]=],
float "xOffset" [=[ {} ]=],
float "yOffset" [=[ {} ]=],
float "zOffset" [=[ {} ]=],
float "xRot" [=[ {} ]=],
float "yRot" [=[ {} ]=],
float "zRot" [=[ {} ]=],
int "boneIndex" [=[ {} ]=],
float "scale" [=[ {} ]=],
BOOL "xAxis" [=[ {} ]=],
BOOL "yAxis" [=[ {} ]=],
BOOL "zAxis" [=[ {} ]=],
}
alias "0xDDE23F30CC5A0F03"
alias "_START_PARTICLE_FX_LOOPED_ON_ENTITY_BONE_2"
ns "GRAPHICS"
returns "int"
doc [[!
```
network fx
```
```
NativeDB Added Parameter 14: Any p13
NativeDB Added Parameter 15: Any p14
NativeDB Added Parameter 16: Any p15
NativeDB Added Parameter 17: Any p16
```
]]
native "START_NETWORKED_PARTICLE_FX_NON_LOOPED_AT_COORD"
hash "0xF56B8137DF10135D"
jhash (0x633F8C48)
arguments {
charPtr "effectName" [=[ {} ]=],
float "xPos" [=[ {} ]=],
float "yPos" [=[ {} ]=],
float "zPos" [=[ {} ]=],
float "xRot" [=[ {} ]=],
float "yRot" [=[ {} ]=],
float "zRot" [=[ {} ]=],
float "scale" [=[ {} ]=],
BOOL "xAxis" [=[ {} ]=],
BOOL "yAxis" [=[ {} ]=],
BOOL "zAxis" [=[ {} ]=],
}
alias "_START_PARTICLE_FX_NON_LOOPED_AT_COORD_2"
ns "GRAPHICS"
returns "BOOL"
doc [[!
NOTE: the [USE_PARTICLE_FX_ASSET](#\_0x6C38AF3693A69A91) needs to be called before EVERY StartNetworkedParticleFxNonLoopedAtCoord(....) call!
List with lots of particle effects: https://gist.githubusercontent.com/alexguirre/af70f0122957f005a5c12bef2618a786/raw/899e93c5611ba58138c56873bb6f56664a776af4/Particles%2520Effects%2520Dump.txt
Note: Not all particles on this list are for non looped and vice versa, neither are all of them suited/meant to have SetParticleFxNonLoopedColour(....) called on them.
```
NativeDB Added Parameter 12: BOOL p11
```
]]
native "START_NETWORKED_PARTICLE_FX_NON_LOOPED_ON_ENTITY"
hash "0xC95EB1DB6E92113D"
jhash (0x469A2B4A)
arguments {
charPtr "effectName" [=[ {} ]=],
Entity "entity" [=[ {} ]=],
float "offsetX" [=[ {} ]=],
float "offsetY" [=[ {} ]=],
float "offsetZ" [=[ {} ]=],
float "rotX" [=[ {} ]=],
float "rotY" [=[ {} ]=],
float "rotZ" [=[ {} ]=],
float "scale" [=[ {} ]=],
BOOL "axisX" [=[ {} ]=],
BOOL "axisY" [=[ {} ]=],
BOOL "axisZ" [=[ {} ]=],
}
alias "_START_PARTICLE_FX_NON_LOOPED_ON_ENTITY_2"
ns "GRAPHICS"
returns "BOOL"
doc [[!
]]
native "START_NETWORKED_PARTICLE_FX_NON_LOOPED_ON_PED_BONE"
hash "0xA41B6A43642AC2CF"
jhash (0x161780C1)
arguments {
charPtr "effectName" [=[ {} ]=],
Ped "ped" [=[ {} ]=],
float "offsetX" [=[ {} ]=],
float "offsetY" [=[ {} ]=],
float "offsetZ" [=[ {} ]=],
float "rotX" [=[ {} ]=],
float "rotY" [=[ {} ]=],
float "rotZ" [=[ {} ]=],
int "boneIndex" [=[ {} ]=],
float "scale" [=[ {} ]=],
BOOL "axisX" [=[ {} ]=],
BOOL "axisY" [=[ {} ]=],
BOOL "axisZ" [=[ {} ]=],
}
alias "_START_PARTICLE_FX_NON_LOOPED_ON_PED_BONE_2"
ns "GRAPHICS"
returns "BOOL"
doc [[!
]]
native "START_PARTICLE_FX_LOOPED_AT_COORD"
hash "0xE184F4F0DC5910E7"
jhash (0xD348E3E6)
arguments {
charPtr "effectName" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "xRot" [=[ {} ]=],
float "yRot" [=[ {} ]=],
float "zRot" [=[ {} ]=],
float "scale" [=[ {} ]=],
BOOL "xAxis" [=[ {} ]=],
BOOL "yAxis" [=[ {} ]=],
BOOL "zAxis" [=[ {} ]=],
BOOL "p11" [=[ {} ]=],
}
ns "GRAPHICS"
returns "int"
doc [[!
```
GRAPHICS::START_PARTICLE_FX_LOOPED_AT_COORD("scr_fbi_falling_debris", 93.7743f, -749.4572f, 70.86904f, 0f, 0f, 0f, 0x3F800000, 0, 0, 0, 0)
p11 seems to be always 0
```
]]
native "START_PARTICLE_FX_LOOPED_ON_ENTITY"
hash "0x1AE42C1660FD6517"
jhash (0x0D06FF62)
arguments {
charPtr "effectName" [=[ {} ]=],
Entity "entity" [=[ {} ]=],
float "xOffset" [=[ {} ]=],
float "yOffset" [=[ {} ]=],
float "zOffset" [=[ {} ]=],
float "xRot" [=[ {} ]=],
float "yRot" [=[ {} ]=],
float "zRot" [=[ {} ]=],
float "scale" [=[ {} ]=],
BOOL "xAxis" [=[ {} ]=],
BOOL "yAxis" [=[ {} ]=],
BOOL "zAxis" [=[ {} ]=],
}
ns "GRAPHICS"
returns "int"
doc [[!
]]
native "START_PARTICLE_FX_LOOPED_ON_ENTITY_BONE"
hash "0xC6EB449E33977F0B"
jhash (0x23BF0F9B)
arguments {
charPtr "effectName" [=[ {} ]=],
Entity "entity" [=[ {} ]=],
float "xOffset" [=[ {} ]=],
float "yOffset" [=[ {} ]=],
float "zOffset" [=[ {} ]=],
float "xRot" [=[ {} ]=],
float "yRot" [=[ {} ]=],
float "zRot" [=[ {} ]=],
int "boneIndex" [=[ {} ]=],
float "scale" [=[ {} ]=],
BOOL "xAxis" [=[ {} ]=],
BOOL "yAxis" [=[ {} ]=],
BOOL "zAxis" [=[ {} ]=],
}
ns "GRAPHICS"
returns "int"
doc [[!
]]
native "START_PARTICLE_FX_LOOPED_ON_PED_BONE"
hash "0xF28DA9F38CD1787C"
jhash (0xF8FC196F)
arguments {
charPtr "effectName" [=[ {} ]=],
Ped "ped" [=[ {} ]=],
float "xOffset" [=[ {} ]=],
float "yOffset" [=[ {} ]=],
float "zOffset" [=[ {} ]=],
float "xRot" [=[ {} ]=],
float "yRot" [=[ {} ]=],
float "zRot" [=[ {} ]=],
int "boneIndex" [=[ {} ]=],
float "scale" [=[ {} ]=],
BOOL "xAxis" [=[ {} ]=],
BOOL "yAxis" [=[ {} ]=],
BOOL "zAxis" [=[ {} ]=],
}
ns "GRAPHICS"
returns "int"
doc [[!
]]
native "START_PARTICLE_FX_NON_LOOPED_AT_COORD"
hash "0x25129531F77B9ED3"
jhash (0xDD79D679)
arguments {
charPtr "effectName" [=[ {} ]=],
float "xPos" [=[ {} ]=],
float "yPos" [=[ {} ]=],
float "zPos" [=[ {} ]=],
float "xRot" [=[ {} ]=],
float "yRot" [=[ {} ]=],
float "zRot" [=[ {} ]=],
float "scale" [=[ {} ]=],
BOOL "xAxis" [=[ {} ]=],
BOOL "yAxis" [=[ {} ]=],
BOOL "zAxis" [=[ {} ]=],
}
ns "GRAPHICS"
returns "int"
doc [[!
```
GRAPHICS::START_PARTICLE_FX_NON_LOOPED_AT_COORD("scr_paleto_roof_impact", -140.8576f, 6420.789f, 41.1391f, 0f, 0f, 267.3957f, 0x3F800000, 0, 0, 0);
Axis - Invert Axis Flags
list: pastebin.com/N9unUFWY
-------------------------------------------------------------------
C#
Function.Call(Hash.START_PARTICLE_FX_NON_LOOPED_AT_COORD, = you are calling this function.
char *effectname = This is an in-game effect name, for e.g. "scr_fbi4_trucks_crash" is used to give the effects when truck crashes etc
float x, y, z pos = this one is Simple, you just have to declare, where do you want this effect to take place at, so declare the ordinates
float xrot, yrot, zrot = Again simple? just mention the value in case if you want the effect to rotate.
float scale = is declare the scale of the effect, this may vary as per the effects for e.g 1.0f
bool xaxis, yaxis, zaxis = To bool the axis values.
example:
Function.Call(Hash.START_PARTICLE_FX_NON_LOOPED_AT_COORD, "scr_fbi4_trucks_crash", GTA.Game.Player.Character.Position.X, GTA.Game.Player.Character.Position.Y, GTA.Game.Player.Character.Position.Z + 4f, 0, 0, 0, 5.5f, 0, 0, 0);
```
]]
native "START_PARTICLE_FX_NON_LOOPED_ON_ENTITY"
hash "0x0D53A3B8DA0809D2"
jhash (0x9604DAD4)
arguments {
charPtr "effectName" [=[ {} ]=],
Entity "entity" [=[ {} ]=],
float "offsetX" [=[ {} ]=],
float "offsetY" [=[ {} ]=],
float "offsetZ" [=[ {} ]=],
float "rotX" [=[ {} ]=],
float "rotY" [=[ {} ]=],
float "rotZ" [=[ {} ]=],
float "scale" [=[ {} ]=],
BOOL "axisX" [=[ {} ]=],
BOOL "axisY" [=[ {} ]=],
BOOL "axisZ" [=[ {} ]=],
}
ns "GRAPHICS"
returns "BOOL"
doc [[!
```
Starts a particle effect on an entity for example your player.
List: pastebin.com/N9unUFWY
Example:
C#:
Function.Call(Hash.REQUEST_NAMED_PTFX_ASSET, "scr_rcbarry2"); Function.Call(Hash._SET_PTFX_ASSET_NEXT_CALL, "scr_rcbarry2"); Function.Call(Hash.START_PARTICLE_FX_NON_LOOPED_ON_ENTITY, "scr_clown_appears", Game.Player.Character, 0.0, 0.0, -0.5, 0.0, 0.0, 0.0, 1.0, false, false, false);
Internally this calls the same function as GRAPHICS::START_PARTICLE_FX_NON_LOOPED_ON_PED_BONE
however it uses -1 for the specified bone index, so it should be possible to start a non looped fx on an entity bone using that native
```
]]
native "START_PARTICLE_FX_NON_LOOPED_ON_PED_BONE"
hash "0x0E7E72961BA18619"
jhash (0x53DAEF4E)
arguments {
charPtr "effectName" [=[ {} ]=],
Ped "ped" [=[ {} ]=],
float "offsetX" [=[ {} ]=],
float "offsetY" [=[ {} ]=],
float "offsetZ" [=[ {} ]=],
float "rotX" [=[ {} ]=],
float "rotY" [=[ {} ]=],
float "rotZ" [=[ {} ]=],
int "boneIndex" [=[ {} ]=],
float "scale" [=[ {} ]=],
BOOL "axisX" [=[ {} ]=],
BOOL "axisY" [=[ {} ]=],
BOOL "axisZ" [=[ {} ]=],
}
ns "GRAPHICS"
returns "BOOL"
doc [[!
```
GRAPHICS::START_PARTICLE_FX_NON_LOOPED_ON_PED_BONE("scr_sh_bong_smoke", PLAYER::PLAYER_PED_ID(), -0.025f, 0.13f, 0f, 0f, 0f, 0f, 31086, 0x3F800000, 0, 0, 0);
Axis - Invert Axis Flags
list: pastebin.com/N9unUFWY
```
]]
native "START_PETROL_TRAIL_DECALS"
hash "0x99AC7F0D8B9C893D"
jhash (0xE3938B0B)
arguments {
float "p0" [=[ {} ]=],
}
alias "0x99AC7F0D8B9C893D"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "STOP_PARTICLE_FX_LOOPED"
hash "0x8F75998877616996"
jhash (0xD245455B)
arguments {
int "ptfxHandle" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
p1 is always 0 in the native scripts
```
]]
native "TERRAINGRID_ACTIVATE"
hash "0xA356990E161C9E65"
jhash (0xA1CB6C94)
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0xA356990E161C9E65"
ns "GRAPHICS"
returns "void"
doc [[!
This native enables/disables the gold putting grid display (https://i.imgur.com/TC6cku6.png).
This requires these two natives to be called as well to configure the grid: [`TERRAINGRID_SET_PARAMS`](#\_0x1C4FC5752BCD8E48) and [`TERRAINGRID_SET_COLOURS`](#\_0x5CE62918F8D703C7).
Enables or disables the golf putting grid display.
]]
native "TERRAINGRID_SET_COLOURS"
hash "0x5CE62918F8D703C7"
jhash (0xDF552973)
arguments {
int "lowR" [=[ {} ]=],
int "lowG" [=[ {} ]=],
int "lowB" [=[ {} ]=],
int "lowAlpha" [=[ {} ]=],
int "R" [=[ {} ]=],
int "G" [=[ {} ]=],
int "B" [=[ {} ]=],
int "Alpha" [=[ {} ]=],
int "highR" [=[ {} ]=],
int "highG" [=[ {} ]=],
int "highB" [=[ {} ]=],
int "highAlpha" [=[ {} ]=],
}
alias "0x5CE62918F8D703C7"
ns "GRAPHICS"
returns "void"
doc [[!
This native is used along with these two natives: [`TERRAINGRID_ACTIVATE`](#\_0xA356990E161C9E65) and [`TERRAINGRID_SET_PARAMS`](#\_0x1C4FC5752BCD8E48).
This native sets the colors for the golf putting grid. the 'min...' values are for the lower areas that the grid covers, the 'max...' values are for the higher areas that the grid covers, all remaining values are for the 'normal' ground height.
All those natives combined they will output something like this: https://i.imgur.com/TC6cku6.png
Old description:
Only called in golf and golf_mp\
parameters used are\
GRAPHICS::\_0x5CE62918F8D703C7(255, 0, 0, 64, 255, 255, 255, 5, 255, 255, 0, 64);
red value for the lower level
green value for the lower level
blue value for the lower level
alpha value for the lower level
red value for the normal level
green value for the normal level
blue value for the normal level
alpha value for the normal level
red value for the upper level
green value for the upper level
blue value for the upper level
alpha value for the upper level
]]
native "TERRAINGRID_SET_PARAMS"
hash "0x1C4FC5752BCD8E48"
jhash (0x3B637AA7)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "p3" [=[ {} ]=],
float "rotation" [=[ {} ]=],
float "p5" [=[ {} ]=],
float "width" [=[ {} ]=],
float "height" [=[ {} ]=],
float "p8" [=[ {} ]=],
float "scale" [=[ {} ]=],
float "glowIntensity" [=[ {} ]=],
float "normalHeight" [=[ {} ]=],
float "heightDiff" [=[ {} ]=],
}
alias "0x1C4FC5752BCD8E48"
ns "GRAPHICS"
returns "void"
doc [[!
This native is used along with these two natives: [`TERRAINGRID_ACTIVATE`](#\_0xA356990E161C9E65) and [`TERRAINGRID_SET_COLOURS`](#\_0x5CE62918F8D703C7).
This native configures the location, size, rotation, normal height, and the difference ratio between min, normal and max.
All those natives combined they will output something like this: https://i.imgur.com/TC6cku6.png
Grid center x coord.
Grid center y coord.
Grid center z coord.
Not sure, but seems to be the amount of lines top/bottom there are in the grid. -1.0 works best.
Grid rotation (keep between 0.0 and 1.0).
Offset top/bottom (? not sure about this one, seems weird).
Grid width (usually 15.0).
Grid height (usually 15.0).
Not sure, but seems to be the amount of lines left/right there are in the grid. -1.0 works best.
Zoom / scale (higher values = smaller (more) squares) (lower values = bigger (less) squares).
glow intensity / opacity (40.0 is fine for daylight, 15.0 is fine for night time).
The z coord for 'normal' height (white grid lines level).
This is the height difference/margin used for line color changes. 0.2 works fine (normalHeight + 0.2 = yellow, normalHeight - 0.2 = red).
]]
native "TOGGLE_PAUSED_RENDERPHASES"
hash "0xDFC252D8A3E15AB7"
jhash (0x30ADE541)
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "_ENABLE_GAMEPLAY_CAM"
alias "_SET_FROZEN_RENDERING_DISABLED"
ns "GRAPHICS"
returns "void"
doc [[!
Switches the rendering display to exclude everything except PostFX, resulting in a frozen screen before the UI pass.
Setting it to `false` will exclude render updates as mentioned in the description, until it's set back to `true`.
]]
native "TRIGGER_SCREENBLUR_FADE_IN"
hash "0xA328A24AAA6B7FDC"
jhash (0x5604B890)
arguments {
float "transitionTime" [=[ {} ]=],
}
alias "_TRANSITION_TO_BLURRED"
ns "GRAPHICS"
returns "BOOL"
doc [[!
Time in milliseconds to transition into a fully blurred screen
]]
native "TRIGGER_SCREENBLUR_FADE_OUT"
hash "0xEFACC8AEF94430D5"
jhash (0x46617502)
arguments {
float "transitionTime" [=[ {} ]=],
}
alias "_TRANSITION_FROM_BLURRED"
ns "GRAPHICS"
returns "BOOL"
doc [[!
]]
native "UI3DSCENE_IS_AVAILABLE"
hash "0xD3A10FC7FD8D98CD"
jhash (0xE40A0F1A)
alias "0xD3A10FC7FD8D98CD"
ns "GRAPHICS"
returns "BOOL"
doc [[!
]]
native "UI3DSCENE_PUSH_PRESET"
hash "0xF1CEA8A4198D8E9A"
jhash (0x2E7D9B98)
arguments {
charPtr "presetName" [=[ {} ]=],
}
alias "0xF1CEA8A4198D8E9A"
ns "GRAPHICS"
returns "BOOL"
doc [[!
```
All presets can be found in common\data\ui\uiscenes.meta
```
]]
native "UNPATCH_DECAL_DIFFUSE_MAP"
hash "0xB7ED70C49521A61D"
jhash (0x7B786555)
arguments {
int "decalType" [=[ {} ]=],
}
alias "0xB7ED70C49521A61D"
alias "_UNDO_DECAL_TEXTURE_OVERRIDE"
ns "GRAPHICS"
returns "void"
doc [[!
```
GRAPHICS::UNPATCH_DECAL_DIFFUSE_MAP(9123);
GRAPHICS::SET_STREAMED_TEXTURE_DICT_AS_NO_LONGER_NEEDED("MPMissMarkers256");
```
]]
native "UPDATE_LIGHTS_ON_ENTITY"
hash "0xDEADC0DEDEADC0DE"
jhash (0xC12AC47A)
arguments {
Entity "entity" [=[ {} ]=],
}
alias "0xDEADC0DEDEADC0DE"
alias "_ENTITY_DESCRIPTION_TEXT"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "USE_PARTICLE_FX_ASSET"
hash "0x6C38AF3693A69A91"
jhash (0x9C720B61)
arguments {
charPtr "name" [=[ {} ]=],
}
alias "_SET_PTFX_ASSET_NEXT_CALL"
alias "_USE_PARTICLE_FX_ASSET_NEXT_CALL"
ns "GRAPHICS"
returns "void"
doc [[!
```
From the b678d decompiled scripts:
GRAPHICS::_SET_PTFX_ASSET_NEXT_CALL("FM_Mission_Controler");
GRAPHICS::_SET_PTFX_ASSET_NEXT_CALL("scr_apartment_mp");
GRAPHICS::_SET_PTFX_ASSET_NEXT_CALL("scr_indep_fireworks");
GRAPHICS::_SET_PTFX_ASSET_NEXT_CALL("scr_mp_cig_plane");
GRAPHICS::_SET_PTFX_ASSET_NEXT_CALL("scr_mp_creator");
GRAPHICS::_SET_PTFX_ASSET_NEXT_CALL("scr_ornate_heist");
GRAPHICS::_SET_PTFX_ASSET_NEXT_CALL("scr_prison_break_heist_station");
```
]]
native "WASH_DECALS_FROM_VEHICLE"
hash "0x5B712761429DBC14"
jhash (0x2929F11A)
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "p1" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "WASH_DECALS_IN_RANGE"
hash "0x9C30613D50A6ADEF"
jhash (0xDEECBC57)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "_ADD_OIL_DECAL"
hash "0x126D7F89FE859A5E"
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "groundLvl" [=[ {} ]=],
float "width" [=[ {} ]=],
float "transparency" [=[ {} ]=],
}
ns "GRAPHICS"
returns "int"
doc [[!
```
NativeDB Introduced: v2699
```
]]
native "_ANIMPOSTFX_GET_UNK"
hash "0xE35B38A27E8E7179"
arguments {
charPtr "effectName" [=[ {} ]=],
}
alias "0xE35B38A27E8E7179"
ns "GRAPHICS"
returns "float"
doc [[!
See [`ANIMPOSTFX_PLAY`](#\_0x2206BF9A37B7F724)
]]
native "_ANIMPOSTFX_STOP_AND_DO_UNK"
hash "0xD2209BE128B5418C"
arguments {
charPtr "effectName" [=[ {} ]=],
}
alias "0xD2209BE128B5418C"
ns "GRAPHICS"
returns "void"
doc [[!
Stops the effect and sets a value (bool) in its data (+0x199) to false; See [`ANIMPOSTFX_PLAY`](#\_0x2206BF9A37B7F724).
]]
native "_CASCADE_SHADOWS_CLEAR_SHADOW_SAMPLE_TYPE"
hash "0x27CB772218215325"
alias "0x27CB772218215325"
alias "_CASCADESHADOWS_RESET_TYPE"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "_CLEAR_EXTRA_TIMECYCLE_MODIFIER"
hash "0x92CCC17A7A2285DA"
jhash (0x6776720A)
alias "0x92CCC17A7A2285DA"
ns "GRAPHICS"
returns "void"
doc [[!
Clears the secondary timecycle modifier usually set with [`SetExtraTimecycleModifier`](#\_0x5096FD9CCB49056D)
]]
native "_DISABLE_SCRIPT_AMBIENT_EFFECTS"
hash "0xEFD97FF47B745B8D"
arguments {
Any "p0" [=[ {} ]=],
}
alias "0xEFD97FF47B745B8D"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "_DRAW_BINK_MOVIE"
hash "0x7118E83EEB9F7238"
arguments {
int "binkMovie" [=[ {} ]=],
float "posX" [=[ {} ]=],
float "posY" [=[ {} ]=],
float "scaleX" [=[ {} ]=],
float "scaleY" [=[ {} ]=],
float "rotation" [=[ {} ]=],
int "r" [=[ {} ]=],
int "g" [=[ {} ]=],
int "b" [=[ {} ]=],
int "a" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
Must be called each frame, will play at specified position on screen when called with [`_PLAY_BINK_MOVIE`](#\_0x70D2CC8A542A973C)
The movie to be drawn (from [`_SET_BINK_MOVIE`](#\_0x338D9F609FD632DB)).
The centered x position of the movie (0.0 - 1.0).
The centered y position of the movie (0.0 - 1.0).
The x scale of the movie (0.0 - 1.0).
The y scale of the movie (0.0 - 1.0).
The rotation of the movie (0.0 - 360.0).
The red value of the movie (0 - 255).
The green value of the movie (0 - 255).
The blue value of the movie (0 - 255).
The alpha value of the movie (0 - 255).
]]
native "_DRAW_INTERACTIVE_SPRITE"
hash "0x2BC54A8188768488"
arguments {
charPtr "textureDict" [=[ {} ]=],
charPtr "textureName" [=[ {} ]=],
float "screenX" [=[ {} ]=],
float "screenY" [=[ {} ]=],
float "width" [=[ {} ]=],
float "height" [=[ {} ]=],
float "heading" [=[ {} ]=],
int "red" [=[ {} ]=],
int "green" [=[ {} ]=],
int "blue" [=[ {} ]=],
int "alpha" [=[ {} ]=],
}
alias "0x2BC54A8188768488"
ns "GRAPHICS"
returns "void"
doc [[!
Similar to [\_DRAW_SPRITE](#\_0xE7FFAE5EBF23D890), but seems to be some kind of "interactive" sprite, at least used by render targets.
These seem to be the only dicts ever requested by this native:
```
prop_screen_biker_laptop
Prop_Screen_GR_Disruption
Prop_Screen_TaleOfUs
prop_screen_nightclub
Prop_Screen_IE_Adhawk
prop_screen_sm_free_trade_shipping
prop_screen_hacker_truck
MPDesktop
Prop_Screen_Nightclub
And a few others
```
Name of texture dictionary to load texture from
Name of texture to load from texture dictionary
Screen X
Screen Y
Scale X
Scale Y
Texture rotation in degrees (default = 0.0) positive is clockwise, measured in degrees
Color
Color
Color
Opacity level
]]
native "_DRAW_LIGHT_WITH_RANGE_AND_SHADOW"
hash "0xF49E9A9716A04595"
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
int "r" [=[ {} ]=],
int "g" [=[ {} ]=],
int "b" [=[ {} ]=],
float "range" [=[ {} ]=],
float "intensity" [=[ {} ]=],
float "shadow" [=[ {} ]=],
}
alias "_DRAW_LIGHT_WITH_RANGE_WITH_SHADOW"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "_DRAW_MARKER_2"
hash "0xE82728F0DE75D13A"
arguments {
int "type" [=[ {} ]=],
float "posX" [=[ {} ]=],
float "posY" [=[ {} ]=],
float "posZ" [=[ {} ]=],
float "dirX" [=[ {} ]=],
float "dirY" [=[ {} ]=],
float "dirZ" [=[ {} ]=],
float "rotX" [=[ {} ]=],
float "rotY" [=[ {} ]=],
float "rotZ" [=[ {} ]=],
float "scaleX" [=[ {} ]=],
float "scaleY" [=[ {} ]=],
float "scaleZ" [=[ {} ]=],
int "red" [=[ {} ]=],
int "green" [=[ {} ]=],
int "blue" [=[ {} ]=],
int "alpha" [=[ {} ]=],
BOOL "bobUpAndDown" [=[ {} ]=],
BOOL "faceCamera" [=[ {} ]=],
int "rotationOrder" [=[ {} ]=],
BOOL "rotate" [=[ {} ]=],
charPtr "textureDict" [=[ {} ]=],
charPtr "textureName" [=[ {} ]=],
BOOL "drawOnEnts" [=[ {} ]=],
BOOL "p24" [=[ {} ]=],
}
alias "0xE82728F0DE75D13A"
ns "GRAPHICS"
returns "void"
doc [[!
```
NativeDB Added Parameter 26: BOOL p25
```
]]
native "_DRAW_SHOWROOM"
hash "0x98C4FE6EC34154CA"
jhash (0x9A0E3BFE)
arguments {
charPtr "p0" [=[ {} ]=],
Ped "ped" [=[ {} ]=],
int "p2" [=[ {} ]=],
float "posX" [=[ {} ]=],
float "posY" [=[ {} ]=],
float "posZ" [=[ {} ]=],
}
alias "0x98C4FE6EC34154CA"
ns "GRAPHICS"
returns "BOOL"
doc [[!
```
It's called after 0xD3A10FC7FD8D98CD and 0xF1CEA8A4198D8E9A
p0 was always "CELEBRATION_WINNER"
```
]]
native "_DRAW_SPHERE"
hash "0x799017F9E3B10112"
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "radius" [=[ {} ]=],
int "r" [=[ {} ]=],
int "g" [=[ {} ]=],
int "b" [=[ {} ]=],
float "opacity" [=[ {} ]=],
}
alias "0x799017F9E3B10112"
ns "GRAPHICS"
returns "void"
doc [[!
Draws a 3D sphere, typically seen in the GTA:O freemode event "Penned In".
Example [image](https://imgur.com/nCbtS4H):
```lua
DrawSphere(35.45, 172.66, 126.22, 1.0, 0, 0, 255, 0.2)
```
X coordinate of the sphere
Y coordinate of the sphere
Z coordinate of the sphere
Size of the sphere, `1.0` = 1 meter
Color red `0`-`255`
Color green `0`-`255`
Color blue `0`-`255`
Opacity from `0.0`-`1.0`
]]
native "_DRAW_SPOT_LIGHT_WITH_SHADOW"
hash "0x5BCA583A583194DB"
jhash (0x32BF9598)
arguments {
float "posX" [=[ {} ]=],
float "posY" [=[ {} ]=],
float "posZ" [=[ {} ]=],
float "dirX" [=[ {} ]=],
float "dirY" [=[ {} ]=],
float "dirZ" [=[ {} ]=],
int "colorR" [=[ {} ]=],
int "colorG" [=[ {} ]=],
int "colorB" [=[ {} ]=],
float "distance" [=[ {} ]=],
float "brightness" [=[ {} ]=],
float "roundness" [=[ {} ]=],
float "radius" [=[ {} ]=],
float "falloff" [=[ {} ]=],
int "shadowId" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "_DRAW_SPRITE_POLY_2"
hash "0x736D7AA1B750856B"
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
float "x3" [=[ {} ]=],
float "y3" [=[ {} ]=],
float "z3" [=[ {} ]=],
float "red1" [=[ {} ]=],
float "green1" [=[ {} ]=],
float "blue1" [=[ {} ]=],
int "alpha1" [=[ {} ]=],
float "red2" [=[ {} ]=],
float "green2" [=[ {} ]=],
float "blue2" [=[ {} ]=],
int "alpha2" [=[ {} ]=],
float "red3" [=[ {} ]=],
float "green3" [=[ {} ]=],
float "blue3" [=[ {} ]=],
int "alpha3" [=[ {} ]=],
charPtr "textureDict" [=[ {} ]=],
charPtr "textureName" [=[ {} ]=],
float "u1" [=[ {} ]=],
float "v1" [=[ {} ]=],
float "w1" [=[ {} ]=],
float "u2" [=[ {} ]=],
float "v2" [=[ {} ]=],
float "w2" [=[ {} ]=],
float "u3" [=[ {} ]=],
float "v3" [=[ {} ]=],
float "w3" [=[ {} ]=],
}
alias "0x736D7AA1B750856B"
ns "GRAPHICS"
returns "void"
doc [[!
Used for drawling Deadline trailing lights, see deadline.ytd
Each vertex has its own colour that is blended/illuminated on the texture. Additionally, the R, G, and B components are floats that are int-casted internally.
For UVW mapping (u,v,w parameters), reference your favourite internet resource for more details.
]]
native "_DRAW_SPRITE_UV"
hash "0x95812F9B26074726"
arguments {
charPtr "textureDict" [=[ {} ]=],
charPtr "textureName" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "width" [=[ {} ]=],
float "height" [=[ {} ]=],
float "u1" [=[ {} ]=],
float "v1" [=[ {} ]=],
float "u2" [=[ {} ]=],
float "v2" [=[ {} ]=],
float "heading" [=[ {} ]=],
int "red" [=[ {} ]=],
int "green" [=[ {} ]=],
int "blue" [=[ {} ]=],
int "alpha" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
Similar to DRAW_SPRITE, but allows to specify the texture coordinates used to draw the sprite.
u1, v1 - texture coordinates for the top-left corner
u2, v2 - texture coordinates for the bottom-right corner
```
NativeDB Introduced: v1868
```
]]
native "_GET_BINK_MOVIE_TIME"
hash "0x8E17DDD6B9D5BF29"
arguments {
int "binkMovie" [=[ {} ]=],
}
ns "GRAPHICS"
returns "float"
doc [[!
In percentage: 0.0 - 100.0
```
NativeDB Introduced: v1734
```
]]
native "_GET_EXTRA_TIMECYCLE_MODIFIER_INDEX"
hash "0xBB0527EC6341496D"
alias "0xBB0527EC6341496D"
ns "GRAPHICS"
returns "int"
doc [[!
See [`GET_TIMECYCLE_MODIFIER_INDEX`](#\_0xFDF3D97C674AFB66) for use, works the same just for the secondary timecycle modifier.
An integer representing the Timecycle modifier
]]
native "_GET_SCRIPT_GFX_POSITION"
hash "0x6DD8F5AA635EB4B2"
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
floatPtr "calculatedX" [=[ {} ]=],
floatPtr "calculatedY" [=[ {} ]=],
}
alias "0x6DD8F5AA635EB4B2"
ns "GRAPHICS"
returns "void"
doc [[!
Calculates the effective X/Y fractions when applying the values set by `SET_SCRIPT_GFX_ALIGN` and
`SET_SCRIPT_GFX_ALIGN_PARAMS`.
The input X coordinate.
The input Y coordinate.
A pointer to the calculated X value.
A pointer to the calculated Y value.
]]
native "_GRASS_LOD_RESET_SCRIPT_AREAS"
hash "0x302C91AB2D477F7E"
alias "0x302C91AB2D477F7E"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "_GRASS_LOD_SHRINK_SCRIPT_AREAS"
hash "0x6D955F6A9E0295B1"
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "radius" [=[ {} ]=],
float "p4" [=[ {} ]=],
float "p5" [=[ {} ]=],
float "p6" [=[ {} ]=],
}
alias "0x6D955F6A9E0295B1"
ns "GRAPHICS"
returns "void"
doc [[!
```
Wraps 0xAAE9BE70EC7C69AB with FLT_MAX as p7, Jenkins: 0x73E96210?
```
]]
native "_HAS_SCALEFORM_MOVIE_NAMED_LOADED"
hash "0x9743BCCF7CD6E1F6"
arguments {
intPtr "scaleformHandle" [=[ {} ]=],
charPtr "scaleformName" [=[ {} ]=],
}
ns "GRAPHICS"
returns "BOOL"
doc [[!
Check if a Scaleform movie with the given name has been loaded.
```
NativeDB Introduced: v3407
```
Scaleform movie handle
Name of the Scaleform movie to check
Returns `true` if the named Scaleform movie is loaded, `false` otherwise.
]]
native "_IS_PLAYLIST_UNK"
hash "0x1F710BFF7DAE6261"
arguments {
int "tvChannel" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "GRAPHICS"
returns "BOOL"
doc [[!
```
NativeDB Introduced: v1604
```
]]
native "_IS_TV_PLAYLIST_ITEM_PLAYING"
hash "0x0AD973CA1E077B60"
jhash (0x4D1EB0FB)
arguments {
Hash "videoCliphash" [=[ {} ]=],
}
alias "0x0AD973CA1E077B60"
alias "_LOAD_TV_CHANNEL"
ns "GRAPHICS"
returns "BOOL"
doc [[!
```
IS_*
```
]]
native "_OVERRIDE_PED_BADGE_TEXTURE"
hash "0x95EB5E34F821BABE"
arguments {
Ped "ped" [=[ {} ]=],
charPtr "txd" [=[ {} ]=],
charPtr "txn" [=[ {} ]=],
}
alias "0x95EB5E34F821BABE"
ns "GRAPHICS"
returns "BOOL"
doc [[!
```
Overriding ped badge texture to a passed texture. It's synced between players (even custom textures!), don't forget to request used dict on *all* clients to make it sync properly. Can be removed by passing empty strings.
```
]]
native "_PLAY_BINK_MOVIE"
hash "0x70D2CC8A542A973C"
arguments {
int "binkMovie" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "_REGISTER_NOIR_SCREEN_EFFECT_THIS_FRAME"
hash "0xA44FF770DFBC5DAE"
alias "0xA44FF770DFBC5DAE"
ns "GRAPHICS"
returns "void"
doc [[!
Used with 'NG_filmnoir_BW{01,02}' timecycles and the "NOIR_FILTER_SOUNDS" audioref.
]]
native "_RELEASE_BINK_MOVIE"
hash "0x04D950EEFA4EED8C"
arguments {
int "binkMovie" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "_RETURN_TWO"
hash "0x40AFB081F8ADD4EE"
jhash (0x762E5C5F)
arguments {
int "p0" [=[ {} ]=],
}
alias "0x40AFB081F8ADD4EE"
ns "GRAPHICS"
returns "int"
doc [[!
]]
native "_SEETHROUGH_GET_MAX_THICKNESS"
hash "0x43DBAE39626CE83F"
ns "GRAPHICS"
returns "float"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "_SEETHROUGH_SET_FADE_END_DISTANCE"
hash "0x9D75795B9DC6EBBF"
arguments {
float "distance" [=[ {} ]=],
}
alias "0x9D75795B9DC6EBBF"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "_SEETHROUGH_SET_FADE_START_DISTANCE"
hash "0xA78DE25577300BA1"
arguments {
float "distance" [=[ {} ]=],
}
alias "0xA78DE25577300BA1"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "_SEETHROUGH_SET_HI_LIGHT_INTENSITY"
hash "0x19E50EB6E33E1D28"
arguments {
float "intensity" [=[ {} ]=],
}
alias "0x19E50EB6E33E1D28"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "_SEETHROUGH_SET_HI_LIGHT_NOISE"
hash "0x1636D7FC127B10D2"
arguments {
float "noise" [=[ {} ]=],
}
alias "0x1636D7FC127B10D2"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "_SEETHROUGH_SET_MAX_THICKNESS"
hash "0x0C8FAC83902A62DF"
arguments {
float "thickness" [=[ {} ]=],
}
alias "0x0C8FAC83902A62DF"
ns "GRAPHICS"
returns "void"
doc [[!
min: 1.0 max: 10000.0
]]
native "_SEETHROUGH_SET_NOISE_AMOUNT_MAX"
hash "0xFEBFBFDFB66039DE"
arguments {
float "amount" [=[ {} ]=],
}
alias "0xFEBFBFDFB66039DE"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "_SEETHROUGH_SET_NOISE_AMOUNT_MIN"
hash "0xFF5992E1C9E65D05"
arguments {
float "amount" [=[ {} ]=],
}
alias "0xFF5992E1C9E65D05"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "_SET_ARTIFICIAL_LIGHTS_STATE_AFFECTS_VEHICLES"
hash "0xE2B187C0939B3D32"
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
If "blackout" is enabled, this native allows you to ignore "blackout" for vehicles.
```
NativeDB Introduced: v2060
```
]]
native "_SET_BINK_MOVIE"
hash "0x338D9F609FD632DB"
arguments {
charPtr "name" [=[ {} ]=],
}
alias "_SET_BINK_MOVIE_REQUESTED"
ns "GRAPHICS"
returns "int"
doc [[!
Creates an integer (usually 1) for a BINK movie to be called with other natives.
[List of all BINK movies (alphabetically ordered) as of b2802](https://gist.github.com/ItsJunction/8046f28c29ea8ff2821e9e4f933f595f)
The BINK movie to play (with or without file extension).
]]
native "_SET_BINK_MOVIE_TIME"
hash "0x0CB6B3446855B57A"
arguments {
int "binkMovie" [=[ {} ]=],
float "progress" [=[ {} ]=],
}
alias "_SET_BINK_MOVIE_PROGRESS"
ns "GRAPHICS"
returns "void"
doc [[!
Seeks a BINK movie to a specified position.
The movie that is being played.
As a percentage (0.0 - 100.0).
]]
native "_SET_BINK_MOVIE_UNK_2"
hash "0xF816F2933752322D"
arguments {
int "binkMovie" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
NativeDB Introduced: v1868
```
]]
native "_SET_BINK_MOVIE_VOLUME"
hash "0xAFF33B1178172223"
arguments {
int "binkMovie" [=[ {} ]=],
float "value" [=[ {} ]=],
}
alias "_SET_BINK_MOVIE_UNK"
ns "GRAPHICS"
returns "void"
doc [[!
```
binkMovie: Is return value from _SET_BINK_MOVIE. Has something to do with bink volume? (audRequestedSettings::SetVolumeCurveScale)
```
```
NativeDB Introduced: v1290
```
]]
native "_SET_BINK_SHOULD_SKIP"
hash "0x6805D58CAA427B72"
arguments {
int "binkMovie" [=[ {} ]=],
BOOL "shouldSkip" [=[ {} ]=],
}
alias "_0x6805D58CAA427B72"
ns "GRAPHICS"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "_SET_CHECKPOINT_ICON_HEIGHT"
hash "0x4B5B4DA5D79F1943"
jhash (0x80151CCF)
arguments {
int "checkpoint" [=[ {} ]=],
float "height_multiplier" [=[ {} ]=],
}
alias "0x4B5B4DA5D79F1943"
alias "_SET_CHECKPOINT_SCALE"
ns "GRAPHICS"
returns "void"
doc [[!
This multiplies the height of the icon inside a checkpoint with the default height of about 2 units above the checkpoint's coordinates.
The checkpoint the multiplier should be applied to.
The multiplier for the icon height above the checkpoint's coordinates. Default is 1.0
]]
native "_SET_CHECKPOINT_ICON_SCALE"
hash "0x44621483FF966526"
arguments {
int "checkpoint" [=[ {} ]=],
float "scale" [=[ {} ]=],
}
alias "0x44621483FF966526"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "_SET_EXTRA_TIMECYCLE_MODIFIER"
hash "0x5096FD9CCB49056D"
jhash (0x908A335E)
arguments {
charPtr "modifierName" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "_SET_FORCE_PED_FOOTSTEPS_TRACKS"
hash "0xAEEDAD1420C65CC0"
jhash (0xC53576CA)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
Forces footstep tracks on all surfaces.
USE_/USING_*
```
]]
native "_SET_FORCE_VEHICLE_TRAILS"
hash "0x4CC7F0FEA5283FE0"
jhash (0x7158B1EA)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
Forces vehicle trails on all surfaces.
USE_/USING_*
```
]]
native "_SET_PARTICLE_FX_NON_LOOPED_EMITTER_SCALE"
hash "0x1E2E01C00837D26E"
arguments {
float "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "scale" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
NativeDB Introduced: v2699
```
]]
native "_START_NETWORKED_PARTICLE_FX_NON_LOOPED_ON_ENTITY_BONE"
hash "0x02B1F2A72E0F5325"
arguments {
charPtr "effectName" [=[ {} ]=],
Entity "entity" [=[ {} ]=],
float "offsetX" [=[ {} ]=],
float "offsetY" [=[ {} ]=],
float "offsetZ" [=[ {} ]=],
float "rotX" [=[ {} ]=],
float "rotY" [=[ {} ]=],
float "rotZ" [=[ {} ]=],
int "boneIndex" [=[ {} ]=],
float "scale" [=[ {} ]=],
BOOL "axisX" [=[ {} ]=],
BOOL "axisY" [=[ {} ]=],
BOOL "axisZ" [=[ {} ]=],
}
ns "GRAPHICS"
returns "BOOL"
doc [[!
```
NativeDB Introduced: v2189
```
]]
native "_STOP_BINK_MOVIE"
hash "0x63606A61DE68898A"
arguments {
int "binkMovie" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "0x0218BA067D249DEA"
hash "0x0218BA067D249DEA"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "0x02369D5C8A51FDCF"
hash "0x02369D5C8A51FDCF"
jhash (0xFDF6D8DA)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
DISABLE_S*
```
]]
native "0x03300B57FCAC6DDB"
hash "0x03300B57FCAC6DDB"
jhash (0x60F72371)
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "0x0AE73D8DF3A762B2"
hash "0x0AE73D8DF3A762B2"
jhash (0x342FA2B4)
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "0x0E4299C549F0D1F1"
hash "0x0E4299C549F0D1F1"
jhash (0x9BABCBA4)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "0x108BE26959A9D9BB"
hash "0x108BE26959A9D9BB"
jhash (0x24A7A7F6)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
UI3DSCENE_*
```
]]
native "0x14FC5833464340A8"
hash "0x14FC5833464340A8"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "0x1612C45F9E3E0D44"
hash "0x1612C45F9E3E0D44"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "0x1BBC135A4D25EDDE"
hash "0x1BBC135A4D25EDDE"
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "0x1CBA05AE7BD7EE05"
hash "0x1CBA05AE7BD7EE05"
jhash (0x56345F6B)
arguments {
float "p0" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
SET_TRA*
```
]]
native "0x259BA6D4E6F808F1"
hash "0x259BA6D4E6F808F1"
arguments {
Any "p0" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "0x25FC3E33A31AD0C9"
hash "0x25FC3E33A31AD0C9"
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "0x27CFB1B1E078CB2D"
hash "0x27CFB1B1E078CB2D"
jhash (0xC2703B88)
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "0x27FEB5254759CDE3"
hash "0x27FEB5254759CDE3"
jhash (0xD63FCB3E)
arguments {
charPtr "textureDict" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "GRAPHICS"
returns "BOOL"
doc [[!
]]
native "0x2A251AA48B2B46DB"
hash "0x2A251AA48B2B46DB"
ns "GRAPHICS"
returns "void"
doc [[!
```
NativeDB Introduced: v323
```
]]
native "0x2B40A97646381508"
hash "0x2B40A97646381508"
arguments {
Any "p0" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "0x2C42340F916C5930"
hash "0x2C42340F916C5930"
arguments {
Any "p0" [=[ {} ]=],
}
ns "GRAPHICS"
returns "Any"
doc [[!
]]
native "0x2D3B147AFAD49DE0"
hash "0x2D3B147AFAD49DE0"
arguments {
charPtr "textureDict" [=[ {} ]=],
charPtr "textureName" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "width" [=[ {} ]=],
float "height" [=[ {} ]=],
float "p6" [=[ {} ]=],
int "red" [=[ {} ]=],
int "green" [=[ {} ]=],
int "blue" [=[ {} ]=],
int "alpha" [=[ {} ]=],
int "p11" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
Used in arcade games and Beam hack minigame in Doomsday Heist. For example, [Penetrator Arcade Game](https://streamable.com/8igrzw)
NativeDB Introduced: v1290
```
inside script_txds.rpf, browse it with OpenIV
textureName
x position must be between 0.0 and 1.0 (1.0 being the most right side of the screen)
y position must be between 0.0 and 1.0 (1.0 being the most bottom side of the screen)
width 0.0 - 1.0 is the reasonable amount generally
height 0.0 - 1.0 is the reasonable amount generally
almost always 0.0
red color
green color
blue color
alpha
]]
native "0x2FCB133CA50A49EB"
hash "0x2FCB133CA50A49EB"
arguments {
Any "p0" [=[ {} ]=],
}
ns "GRAPHICS"
returns "Any"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "0x30432A0118736E00"
hash "0x30432A0118736E00"
ns "GRAPHICS"
returns "Hash"
doc [[!
```
GET_CURRENT_*
NativeDB Introduced: v1493
```
]]
native "0x346EF3ECAAAB149E"
hash "0x346EF3ECAAAB149E"
jhash (0x88EAF398)
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "0x36F6626459D91457"
hash "0x36F6626459D91457"
jhash (0xC07C64C9)
arguments {
float "p0" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "0x393BD2275CEB7793"
hash "0x393BD2275CEB7793"
ns "GRAPHICS"
returns "Any"
doc [[!
]]
native "0x3C788E7F6438754D"
hash "0x3C788E7F6438754D"
arguments {
int "checkpointHandle" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
NativeDB Introduced: v1180
```
Sets the given checkpoint target to the new coords
the handle of a created checkpoint
]]
native "0x43FA7CBE20DAB219"
hash "0x43FA7CBE20DAB219"
arguments {
Any "p0" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "0x46D1A61A21F566FC"
hash "0x46D1A61A21F566FC"
jhash (0x2056A015)
arguments {
float "p0" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "0x4AF92ACD3141D96C"
hash "0x4AF92ACD3141D96C"
jhash (0xC9EF81ED)
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "0x54E22EA2C1956A8D"
hash "0x54E22EA2C1956A8D"
jhash (0x8BE3D47F)
arguments {
float "p0" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "0x5B0316762AFD4A64"
hash "0x5B0316762AFD4A64"
jhash (0xA9DC8558)
ns "GRAPHICS"
returns "int"
doc [[!
]]
native "0x5DBF05DB5926D089"
hash "0x5DBF05DB5926D089"
arguments {
Any "p0" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "0x5DEBD9C4DC995692"
hash "0x5DEBD9C4DC995692"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "0x5F6DF3D92271E8A1"
hash "0x5F6DF3D92271E8A1"
jhash (0x18136DE0)
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "SET_PARTICLE_FX_BLOOD_SCALE"
ns "GRAPHICS"
returns "void"
doc [[!
```
DISABLE_*
```
]]
native "0x615D3925E87A3B26"
hash "0x615D3925E87A3B26"
jhash (0x1E3A3126)
arguments {
int "checkpoint" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
Unknown. Called after creating a checkpoint (type: 51) in the creators.
```
]]
native "0x61F95E5BB3E0A8C6"
hash "0x61F95E5BB3E0A8C6"
arguments {
Any "p0" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
**This native does absolutely nothing, just a nullsub**
]]
native "0x649C97D52332341A"
hash "0x649C97D52332341A"
arguments {
Any "p0" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "0x6A51F78772175A51"
hash "0x6A51F78772175A51"
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
SET_F*
```
]]
native "0x759650634F07B6B4"
hash "0x759650634F07B6B4"
jhash (0x25D569EB)
arguments {
int "p0" [=[ {} ]=],
}
ns "GRAPHICS"
returns "BOOL"
doc [[!
]]
native "0x7A42B2E236E71415"
hash "0x7A42B2E236E71415"
jhash (0x431AA036)
ns "GRAPHICS"
returns "void"
doc [[!
```
UI3DSCENE_*
```
]]
native "0x7AC24EAB6D74118D"
hash "0x7AC24EAB6D74118D"
jhash (0xB2410EAB)
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "GRAPHICS"
returns "BOOL"
doc [[!
]]
native "0x7FA5D82B8F58EC06"
hash "0x7FA5D82B8F58EC06"
jhash (0x1F3CADB0)
ns "GRAPHICS"
returns "BOOL"
doc [[!
]]
native "0x814AF7DCAACC597B"
hash "0x814AF7DCAACC597B"
arguments {
Any "p0" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "0x82ACC484FFA3B05F"
hash "0x82ACC484FFA3B05F"
arguments {
Any "p0" [=[ {} ]=],
}
ns "GRAPHICS"
returns "Any"
doc [[!
]]
native "0x851CD923176EBA7C"
hash "0x851CD923176EBA7C"
jhash (0xDCBA251B)
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "0x8CDE909A0370BB3A"
hash "0x8CDE909A0370BB3A"
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
Used only once in the scripts (taxi_clowncar)
SET_PARTICLE_FX_*
```
]]
native "0x908311265D42A820"
hash "0x908311265D42A820"
arguments {
Any "p0" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
NativeDB Introduced: v323
```
]]
native "0x949F397A288B28B3"
hash "0x949F397A288B28B3"
jhash (0xE3880F5A)
arguments {
float "p0" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "0x9641588DAB93B4B5"
hash "0x9641588DAB93B4B5"
arguments {
Any "p0" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "0x98D18905BF723B99"
hash "0x98D18905BF723B99"
ns "GRAPHICS"
returns "Any"
doc [[!
```
NativeDB Introduced: v1493
```
]]
native "0x98EDF76A7271E4F2"
hash "0x98EDF76A7271E4F2"
ns "GRAPHICS"
returns "void"
doc [[!
```
REQUEST_*
```
]]
native "0x9B079E5221D984D3"
hash "0x9B079E5221D984D3"
jhash (0x447A9EB9)
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
FORCE_*
```
]]
native "0xA46B73FAA3460AE1"
hash "0xA46B73FAA3460AE1"
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "0xAAE9BE70EC7C69AB"
hash "0xAAE9BE70EC7C69AB"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
Any "p6" [=[ {} ]=],
Any "p7" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "0xADD6627C4D325458"
hash "0xADD6627C4D325458"
arguments {
Any "p0" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
NativeDB Introduced: v2189
```
]]
native "0xAE51BC858F32BA66"
hash "0xAE51BC858F32BA66"
arguments {
Any "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
float "p4" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "0xB2EBE8CBC58B90E9"
hash "0xB2EBE8CBC58B90E9"
ns "GRAPHICS"
returns "Any"
doc [[!
]]
native "0xB3C641F3630BF6DA"
hash "0xB3C641F3630BF6DA"
jhash (0xF6B837F0)
arguments {
float "p0" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
Setter for 0xE59343E9E96529E7
SET_M*
```
]]
native "0xB569F41F3E7E83A4"
hash "0xB569F41F3E7E83A4"
arguments {
Any "p0" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "0xBA0127DA25FD54C9"
hash "0xBA0127DA25FD54C9"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "0xBA3D194057C79A7B"
hash "0xBA3D194057C79A7B"
arguments {
charPtr "p0" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
SET_PARTICLE_FX_*
```
]]
native "0xBB90E12CAC1DAB25"
hash "0xBB90E12CAC1DAB25"
jhash (0x3968E915)
arguments {
float "p0" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "0xBCEDB009461DA156"
hash "0xBCEDB009461DA156"
jhash (0x5AB94128)
ns "GRAPHICS"
returns "Any"
doc [[!
]]
native "0xBE197EAA669238F4"
hash "0xBE197EAA669238F4"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "GRAPHICS"
returns "Any"
doc [[!
```
This function is hard-coded to always return 0.
```
]]
native "0xC0416B061F2B7E5E"
hash "0xC0416B061F2B7E5E"
jhash (0x1A1A72EF)
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
GOLF_TRAIL_SET_*
```
]]
native "0xC35A6D07C93802B2"
hash "0xC35A6D07C93802B2"
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "0xC5C8F970D4EDFF71"
hash "0xC5C8F970D4EDFF71"
arguments {
Any "p0" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "0xCA465D9CC0D231BA"
hash "0xCA465D9CC0D231BA"
arguments {
Any "p0" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "0xCA4AE345A153D573"
hash "0xCA4AE345A153D573"
jhash (0x64BA4648)
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "0xCB82A0BF0E3E3265"
hash "0xCB82A0BF0E3E3265"
jhash (0xCFCDC518)
arguments {
int "p0" [=[ {} ]=],
}
ns "GRAPHICS"
returns "int"
doc [[!
]]
native "0xCFD16F0DB5A3535C"
hash "0xCFD16F0DB5A3535C"
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
NativeDB Introduced: v2060
```
]]
native "0xD1C55B110E4DF534"
hash "0xD1C55B110E4DF534"
jhash (0xD99EC000)
arguments {
Any "p0" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
SET_TV_???
```
]]
native "0xDB1EA9411C8911EC"
hash "0xDB1EA9411C8911EC"
arguments {
int "checkpointHandle" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
NativeDB Introduced: v1180
```
This native is used for the "larger" circular checkpoints, and sets the circle/ring around the checkpoint to point in the same direction as the inner arrow
the handle of a created checkpoint
]]
native "0xE2892E7E55D7073A"
hash "0xE2892E7E55D7073A"
jhash (0x455F1084)
arguments {
float "p0" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "0xE59343E9E96529E7"
hash "0xE59343E9E96529E7"
jhash (0xD906A3A9)
ns "GRAPHICS"
returns "float"
doc [[!
```
Getter for 0xB3C641F3630BF6DA
GET_M*
```
]]
native "0xE63D7C6EECECB66B"
hash "0xE63D7C6EECECB66B"
jhash (0xD34A6CBA)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
TOGGLE_*
```
]]
native "0xE791DF1F73ED2C8B"
hash "0xE791DF1F73ED2C8B"
jhash (0x9D84554C)
arguments {
Any "p0" [=[ {} ]=],
}
ns "GRAPHICS"
returns "Any"
doc [[!
```
This function is hard-coded to always return 0.
```
]]
native "0xEC72C258667BE5EA"
hash "0xEC72C258667BE5EA"
jhash (0x9C106AD9)
arguments {
Any "p0" [=[ {} ]=],
}
ns "GRAPHICS"
returns "Any"
doc [[!
```
This function is hard-coded to always return 0.
```
]]
native "0xEF398BEEE4EF45F9"
hash "0xEF398BEEE4EF45F9"
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "0xEFABC7722293DA7C"
hash "0xEFABC7722293DA7C"
ns "GRAPHICS"
returns "void"
doc [[!
```
AD*
```
]]
native "0xF3F776ADA161E47D"
hash "0xF3F776ADA161E47D"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
```
NativeDB Introduced: v1604
```
]]
native "0xF51D36185993515D"
hash "0xF51D36185993515D"
jhash (0x20EABD0F)
arguments {
int "checkpoint" [=[ {} ]=],
float "posX" [=[ {} ]=],
float "posY" [=[ {} ]=],
float "posZ" [=[ {} ]=],
float "unkX" [=[ {} ]=],
float "unkY" [=[ {} ]=],
float "unkZ" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "0xF78B803082D4386F"
hash "0xF78B803082D4386F"
arguments {
float "p0" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
]]
native "0xFCF6788FC4860CD4"
hash "0xFCF6788FC4860CD4"
arguments {
int "checkpoint" [=[ {} ]=],
}
ns "GRAPHICS"
returns "void"
doc [[!
SET_CHECKPOINT_\*
```
NativeDB Introduced: v1734
```
]]
native "CAN_PHONE_BE_SEEN_ON_SCREEN"
hash "0xC4E2813898C97A4B"
jhash (0x5F978584)
ns "MOBILE"
returns "BOOL"
doc [[!
```
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.
```
]]
native "CELL_CAM_ACTIVATE"
hash "0xFDE8F069C542D126"
jhash (0x234C1AE9)
arguments {
BOOL "active" [=[ {} ]=],
BOOL "bGoFirstPerson" [=[ {} ]=],
}
ns "MOBILE"
returns "void"
doc [[!
Activates the cellphone camera. Make sure you have a mobile phone created with [`CREATE_MOBILE_PHONE`](#\_0xA4E8E696C532FBC7) or else the camera will not work.
Toggle whether the camera should be active.
Unused parameter.
]]
native "CELL_CAM_ACTIVATE_SELFIE_MODE"
hash "0x015C49A93E3E086E"
jhash (0x4479B304)
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0x015C49A93E3E086E"
alias "_DISABLE_PHONE_THIS_FRAME"
alias "_CELL_CAM_DISABLE_THIS_FRAME"
ns "MOBILE"
returns "void"
doc [[!
Toggles the selfie mode on the cellphone camera. Only visible when the cell phone camera is active.
True to activate and false to deactivate the selfie mode.
]]
native "CELL_CAM_IS_CHAR_VISIBLE_NO_FACE_CHECK"
hash "0x439E9BC95B7E7FBE"
jhash (0xBEA88097)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "MOBILE"
returns "BOOL"
doc [[!
]]
native "CREATE_MOBILE_PHONE"
hash "0xA4E8E696C532FBC7"
jhash (0x5BBC5E23)
arguments {
int "phoneType" [=[ {} ]=],
}
ns "MOBILE"
returns "void"
doc [[!
```
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.
```
]]
native "DESTROY_MOBILE_PHONE"
hash "0x3BC861DF703E5097"
jhash (0x1A65037B)
ns "MOBILE"
returns "void"
doc [[!
```
Destroys the currently active mobile phone.
```
]]
native "GET_MOBILE_PHONE_POSITION"
hash "0x584FDFDA48805B86"
jhash (0xB2E1E1A0)
arguments {
Vector3Ptr "position" [=[ {} ]=],
}
ns "MOBILE"
returns "void"
doc [[!
]]
native "GET_MOBILE_PHONE_RENDER_ID"
hash "0xB4A53E05F68B6FA1"
jhash (0x88E4FECE)
arguments {
intPtr "renderId" [=[ {} ]=],
}
ns "MOBILE"
returns "void"
doc [[!
]]
native "GET_MOBILE_PHONE_ROTATION"
hash "0x1CEFB61F193070AE"
jhash (0x17A29F23)
arguments {
Vector3Ptr "rotation" [=[ {} ]=],
Vehicle "p1" [=[ {} ]=],
}
ns "MOBILE"
returns "void"
doc [[!
]]
native "SCRIPT_IS_MOVING_MOBILE_PHONE_OFFSCREEN"
hash "0xF511F759238A5122"
jhash (0x29828690)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "MOBILE"
returns "void"
doc [[!
```
If bool Toggle = true so the mobile is hide to screen.
If bool Toggle = false so the mobile is show to screen.
```
]]
native "SET_MOBILE_PHONE_DOF_STATE"
hash "0x375A706A5C2FD084"
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0x375A706A5C2FD084"
alias "_SET_MOBILE_PHONE_UNK"
ns "MOBILE"
returns "void"
doc [[!
Toggles depth of field on the cellphone camera.
true/false to toggle DOF.
]]
native "SET_MOBILE_PHONE_POSITION"
hash "0x693A5C6D6734085B"
jhash (0x841800B3)
arguments {
float "posX" [=[ {} ]=],
float "posY" [=[ {} ]=],
float "posZ" [=[ {} ]=],
}
ns "MOBILE"
returns "void"
doc [[!
]]
native "SET_MOBILE_PHONE_ROTATION"
hash "0xBB779C0CA917E865"
jhash (0x209C28CF)
arguments {
float "rotX" [=[ {} ]=],
float "rotY" [=[ {} ]=],
float "rotZ" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "MOBILE"
returns "void"
doc [[!
```
Last parameter is unknown and always zero.
```
]]
native "SET_MOBILE_PHONE_SCALE"
hash "0xCBDD322A73D6D932"
jhash (0x09BCF1BE)
arguments {
float "scale" [=[ {} ]=],
}
ns "MOBILE"
returns "void"
doc [[!
```
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.
```
]]
native "_CELL_CAM_MOVE_FINGER"
hash "0x95C9E72F3D7DEC9B"
arguments {
int "direction" [=[ {} ]=],
}
alias "_MOVE_FINGER"
ns "MOBILE"
returns "void"
doc [[!
Moves the character's finger in a swiping motion when holding a cellphone in their hand through the use of the [CREATE_MOBILE_PHONE](#\_0xA4E8E696C532FBC7) native.
```cpp
enum eCellInput {
CELL_INPUT_NONE = 0,
CELL_INPUT_UP = 1,
CELL_INPUT_DOWN = 2,
CELL_INPUT_LEFT = 3,
CELL_INPUT_RIGHT = 4,
CELL_INPUT_SELECT = 5
}
```
The direction to swipe to, refer to `eCellInput` enum.
]]
native "_CELL_CAM_SET_DISTANCE"
hash "0x53F4892D18EC90A4"
arguments {
float "p0" [=[ {} ]=],
}
alias "0x53F4892D18EC90A4"
ns "MOBILE"
returns "void"
doc [[!
Value from -1.0 to 1.0
]]
native "_CELL_CAM_SET_HEAD_HEIGHT"
hash "0x466DA42C89865553"
jhash (0x66DCD9D2)
arguments {
float "p0" [=[ {} ]=],
}
alias "0x466DA42C89865553"
ns "MOBILE"
returns "void"
doc [[!
Value from -1.0 to 0.0
]]
native "_CELL_CAM_SET_HEAD_PITCH"
hash "0xD6ADE981781FCA09"
arguments {
float "p0" [=[ {} ]=],
}
alias "0xD6ADE981781FCA09"
ns "MOBILE"
returns "void"
doc [[!
Value from -1.0 to 1.0
]]
native "_CELL_CAM_SET_HEAD_ROLL"
hash "0xF1E22DC13F5EEBAD"
arguments {
float "p0" [=[ {} ]=],
}
alias "0xF1E22DC13F5EEBAD"
ns "MOBILE"
returns "void"
doc [[!
Value from -1.0 to 1.0
]]
native "_CELL_CAM_SET_HORIZONTAL_OFFSET"
hash "0x1B0B4AEED5B9B41C"
arguments {
float "p0" [=[ {} ]=],
}
alias "0x1B0B4AEED5B9B41C"
ns "MOBILE"
returns "void"
doc [[!
Value from -1.0 to 1.0
]]
native "_CELL_CAM_SET_LEAN"
hash "0x44E44169EF70138E"
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "_SET_PHONE_LEAN"
ns "MOBILE"
returns "void"
doc [[!
```
if the bool "Toggle" is "true" so the phone is lean.
if the bool "Toggle" is "false" so the phone is not lean.
```
]]
native "_CELL_CAM_SET_ROLL"
hash "0x15E69E2802C24B8D"
arguments {
float "p0" [=[ {} ]=],
}
alias "0x15E69E2802C24B8D"
ns "MOBILE"
returns "void"
doc [[!
Value from -1.0 to 1.0
]]
native "_CELL_CAM_SET_VERTICAL_OFFSET"
hash "0x3117D84EFA60F77B"
arguments {
float "p0" [=[ {} ]=],
}
alias "0x3117D84EFA60F77B"
ns "MOBILE"
returns "void"
doc [[!
Value from 0.0 to 2.0
]]
native "0xA2CCBE62CD4C91A4"
hash "0xA2CCBE62CD4C91A4"
jhash (0xC273BB4D)
arguments {
intPtr "toggle" [=[ {} ]=],
}
ns "MOBILE"
returns "void"
doc [[!
```
Needs more research. If the "phone_cam12" filter is applied, this function is called with "TRUE"; otherwise, "FALSE".
Example (XBOX 360):
// check current filter selection
if (MISC::ARE_STRINGS_EQUAL(getElem(g_2471024, &l_17, 4), "phone_cam12") != 0)
{
MOBILE::_0xC273BB4D(0); // FALSE
}
else
{
MOBILE::_0xC273BB4D(1); // TRUE
}
```
]]
native "0xAC2890471901861C"
hash "0xAC2890471901861C"
arguments {
float "p0" [=[ {} ]=],
}
ns "MOBILE"
returns "void"
doc [[!
]]
native "ACTIVATE_FRONTEND_MENU"
hash "0xEF01D36B9C9D0C7B"
jhash (0x01D83872)
arguments {
Hash "menuhash" [=[ {} ]=],
BOOL "togglePause" [=[ {} ]=],
int "component" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
Does stuff like this:\
gyazo.com/7fcb78ea3520e3dbc5b2c0c0f3712617\
Example:\
int GetHash = GET_HASH_KEY("fe_menu_version_corona_lobby");\
ACTIVATE_FRONTEND_MENU(GetHash, 0, -1);\
BOOL p1 is a toggle to define the game in pause.\
int p2 is unknown but -1 always works, not sure why though.\
\[30/03/2017] ins1de :\
the int p2 is actually a component variable. When the pause menu is visible, it opens the tab related to it.\
Example : Function.Call(Hash.ACTIVATE_FRONTEND_MENU,-1171018317, 0, 42);\
Result : Opens the "Online" tab without pausing the menu, with -1 it opens the map.
Below is a list of all known Frontend Menu Hashes.
* FE_MENU_VERSION_SP_PAUSE
* FE_MENU_VERSION_MP_PAUSE
* FE_MENU_VERSION_CREATOR_PAUSE
* FE_MENU_VERSION_CUTSCENE_PAUSE
* FE_MENU_VERSION_SAVEGAME
* FE_MENU_VERSION_PRE_LOBBY
* FE_MENU_VERSION_LOBBY
* FE_MENU_VERSION_MP_CHARACTER_SELECT
* FE_MENU_VERSION_MP_CHARACTER_CREATION
* FE_MENU_VERSION_EMPTY
* FE_MENU_VERSION_EMPTY_NO_BACKGROUND
* FE_MENU_VERSION_TEXT_SELECTION
* FE_MENU_VERSION_CORONA
* FE_MENU_VERSION_CORONA_LOBBY
* FE_MENU_VERSION_CORONA_JOINED_PLAYERS
* FE_MENU_VERSION_CORONA_INVITE_PLAYERS
* FE_MENU_VERSION_CORONA_INVITE_FRIENDS
* FE_MENU_VERSION_CORONA_INVITE_CREWS
* FE_MENU_VERSION_CORONA_INVITE_MATCHED_PLAYERS
* FE_MENU_VERSION_CORONA_INVITE_LAST_JOB_PLAYERS
* FE_MENU_VERSION_CORONA_RACE
* FE_MENU_VERSION_CORONA_BETTING
* FE_MENU_VERSION_JOINING_SCREEN
* FE_MENU_VERSION_LANDING_MENU
* FE_MENU_VERSION_LANDING_KEYMAPPING_MENU
]]
native "ADD_BLIP_FOR_COORD"
hash "0x5A039BB0BCA604B6"
jhash (0xC6F43D0E)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
ns "HUD"
returns "Blip"
doc [[!
Creates a blip for the specified coordinates. You can use `SET_BLIP_` natives to change the blip.
The X coordinate to create the blip on.
The Y coordinate.
The Z coordinate.
A blip handle.
]]
native "ADD_BLIP_FOR_ENTITY"
hash "0x5CDE92C702A8FCE7"
jhash (0x30822554)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "HUD"
returns "Blip"
doc [[!
Create a blip that by default is red (enemy), you can use [SET_BLIP_AS_FRIENDLY](#\_0xC6F43D0E) to make it blue (friend).\
Can be used for objects, vehicles and peds.
Example of enemy:

Example of friend:

The entity handle to create the blip.
A blip handle.
]]
native "ADD_BLIP_FOR_PICKUP"
hash "0xBE339365C863BD36"
jhash (0x16693C3A)
arguments {
Pickup "pickup" [=[ {} ]=],
}
ns "HUD"
returns "Blip"
doc [[!
]]
native "ADD_BLIP_FOR_RADIUS"
hash "0x46818D79B1F7499A"
jhash (0x4626756C)
arguments {
float "posX" [=[ {} ]=],
float "posY" [=[ {} ]=],
float "posZ" [=[ {} ]=],
float "radius" [=[ {} ]=],
}
ns "HUD"
returns "Blip"
doc [[!
Create a blip with a radius for the specified coordinates (it doesnt create the blip sprite, so you need to use [AddBlipCoords](#\_0xC6F43D0E))
Example image:

The x position of the blip (you can also send a vector3 instead of the bulk coordinates)
The y position of the blip (you can also send a vector3 instead of the bulk coordinates)
The z position of the blip (you can also send a vector3 instead of the bulk coordinates)
The number that defines the radius of the blip circle
The blip handle that can be manipulated with every `SetBlip` natives
]]
native "ADD_NEXT_MESSAGE_TO_PREVIOUS_BRIEFS"
hash "0x60296AF4BA14ABC5"
jhash (0xB58B25BD)
arguments {
BOOL "addToBrief" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
Toggles if the next help message will be shown in Pause Menu > Info > Help.
]]
native "ADD_POINT_TO_GPS_CUSTOM_ROUTE"
hash "0x311438A071DD9B1A"
jhash (0xEEBDFE55)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
alias "0x311438A071DD9B1A"
ns "HUD"
returns "void"
doc [[!
]]
native "ADD_POINT_TO_GPS_MULTI_ROUTE"
hash "0xA905192A6781C41B"
jhash (0xFE485135)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
alias "0xA905192A6781C41B"
ns "HUD"
returns "void"
doc [[!
]]
native "ADD_TEXT_COMPONENT_FLOAT"
hash "0xE7DCB5B874BCD96E"
jhash (0x24D78013)
arguments {
float "value" [=[ {} ]=],
int "decimalPlaces" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
Adds a float to a text component placeholder, replacing `~1~` in the current text command's text label.

The number to substitute in the label.
How many decimal places to add
]]
native "ADD_TEXT_COMPONENT_FORMATTED_INTEGER"
hash "0x0E4C749FF9DE9CC4"
jhash (0x12929BDF)
arguments {
int "value" [=[ {} ]=],
BOOL "commaSeparated" [=[ {} ]=],
}
alias "0x0E4C749FF9DE9CC4"
ns "HUD"
returns "void"
doc [[!
The integer to add to the string
Whether or not to add comma seperators. So if true 1000 would become 1,000.
]]
native "ADD_TEXT_COMPONENT_INTEGER"
hash "0x03B504CF259931BC"
jhash (0xFE272A57)
arguments {
int "value" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
]]
native "ADD_TEXT_COMPONENT_SUBSTRING_BLIP_NAME"
hash "0x80EAD8E2E1D5D52E"
jhash (0x5DE98F0A)
arguments {
Blip "blip" [=[ {} ]=],
}
alias "0x80EAD8E2E1D5D52E"
ns "HUD"
returns "void"
doc [[!
]]
native "ADD_TEXT_COMPONENT_SUBSTRING_KEYBOARD_DISPLAY"
hash "0x5F68520888E69014"
jhash (0x0829A799)
arguments {
charPtr "string" [=[ {} ]=],
}
alias "_ADD_TEXT_COMPONENT_STRING3"
alias "_ADD_TEXT_COMPONENT_SCALEFORM"
ns "HUD"
returns "void"
doc [[!
Certain characters like `<` will have to be escaped using html entities (e.g. `<`), otherwise the text wont display properly.
]]
native "ADD_TEXT_COMPONENT_SUBSTRING_PHONE_NUMBER"
hash "0x761B77454205A61D"
jhash (0x65E1D404)
arguments {
charPtr "p0" [=[ {} ]=],
int "p1" [=[ {} ]=],
}
alias "0x761B77454205A61D"
alias "_ADD_TEXT_COMPONENT_APP_TITLE"
ns "HUD"
returns "void"
doc [[!
```
p1 was always -1
```
]]
native "ADD_TEXT_COMPONENT_SUBSTRING_PLAYER_NAME"
hash "0x6C188BE134E074AA"
jhash (0x27A244D8)
arguments {
charPtr "text" [=[ {} ]=],
}
alias "_ADD_TEXT_COMPONENT_STRING"
ns "HUD"
returns "void"
doc [[!
Adds an arbitrary string as a text component placeholder, replacing `~a~` in the current text command's text label.
See the documentation on text formatting for more information.
A string to add of up to 99 characters. This can contain additional `~` formatting directives.
]]
native "ADD_TEXT_COMPONENT_SUBSTRING_TEXT_LABEL"
hash "0xC63CD5D2920ACBE7"
jhash (0xDCE05406)
arguments {
charPtr "labelName" [=[ {} ]=],
}
alias "_ADD_TEXT_COMPONENT_ITEM_STRING"
ns "HUD"
returns "void"
doc [[!
]]
native "ADD_TEXT_COMPONENT_SUBSTRING_TEXT_LABEL_HASH_KEY"
hash "0x17299B63C7683A2B"
jhash (0x150E03B6)
arguments {
Hash "gxtEntryHash" [=[ {} ]=],
}
alias "0x17299B63C7683A2B"
ns "HUD"
returns "void"
doc [[!
```
It adds the localized text of the specified GXT entry name. Eg. if the argument is GET_HASH_KEY("ES_HELP"), adds "Continue". Just uses a text labels hash key
```
]]
native "ADD_TEXT_COMPONENT_SUBSTRING_TIME"
hash "0x1115F16B8AB9E8BF"
jhash (0x135B3CD0)
arguments {
int "timestamp" [=[ {} ]=],
int "format" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
Takes a time in milliseconds and converts it to a string. Use `~a~` to mark the position in your line of text where you want this substring inserted.
```cpp
enum eTimeFormat {
TEXT_FORMAT_MILLISECONDS = 1,
TEXT_FORMAT_SECONDS = 2,
TEXT_FORMAT_MINUTES = 4,
TEXT_FORMAT_HOURS = 8,
TEXT_FORMAT_DAYS = 16,
// e.g. show 12:20 not 00:12:20
TEXT_FORMAT_HIDE_LEADING_UNITS_EQUAL_TO_ZERO = 32,
// e.g. show 1:14 not 01:14
TEXT_FORMAT_HIDE_LEADING_ZEROS_ON_LEADING_UNITS = 64,
// e.g. show 3m24s not 3:24
TEXT_FORMAT_SHOW_UNIT_DIVIDERS_AS_LETTERS = 128,
// e.g. show 3m24 not 3m24s
TEXT_FORMAT_HIDE_UNIT_LETTER_FOR_SMALLEST_UNITS = 256,
// e.g. show 05:51 not 05:519
TEXT_FORMAT_HIDE_MILLISECONDS_UNITS_DIGIT = 512,
// e.g. show 05:5 not 05:519
TEXT_FORMAT_HIDE_MILLISECONDS_TENS_DIGIT = 1024,
// e.g. show 12.345 not 12:345
TEXT_FORMAT_USE_DOT_FOR_MILLISECOND_DIVIDER = 2048
}
```
The timestamp in milliseconds
The format of the timestamp, as bitwise flags
]]
native "ADD_TEXT_COMPONENT_SUBSTRING_WEBSITE"
hash "0x94CF4AC034C9C986"
jhash (0xC736999E)
arguments {
charPtr "website" [=[ {} ]=],
}
alias "_ADD_TEXT_COMPONENT_STRING2"
ns "HUD"
returns "void"
doc [[!
```
This native (along with 0x5F68520888E69014 and 0x6C188BE134E074AA) do not actually filter anything. They simply add the provided text (as of 944)
```
]]
native "ALLOW_SONAR_BLIPS"
hash "0x60734CC207C9833C"
jhash (0xE7E1E32B)
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0x60734CC207C9833C"
ns "HUD"
returns "void"
doc [[!
]]
native "BEGIN_TEXT_COMMAND_BUSYSPINNER_ON"
hash "0xABA17D7CE615ADBF"
jhash (0xCB7C8994)
arguments {
charPtr "string" [=[ {} ]=],
}
alias "0xABA17D7CE615ADBF"
alias "_SET_LOADING_PROMPT_TEXT_ENTRY"
alias "_BEGIN_TEXT_COMMAND_BUSY_STRING"
ns "HUD"
returns "void"
doc [[!
```
Initializes the text entry for the the text next to a loading prompt. All natives for for building UI texts can be used here
BEGIN_TEXT_COMMAND_PRINT
e.g
void StartLoadingMessage(char *text, int spinnerType = 3)
{
_SET_LOADING_PROMPT_TEXT_ENTRY("STRING");
ADD_TEXT_COMPONENT_SUBSTRING_PLAYER_NAME(text);
_SHOW_LOADING_PROMPT(spinnerType);
}
/*OR*/
void ShowLoadingMessage(char *text, int spinnerType = 3, int timeMs = 10000)
{
_SET_LOADING_PROMPT_TEXT_ENTRY("STRING");
ADD_TEXT_COMPONENT_SUBSTRING_PLAYER_NAME(text);
_SHOW_LOADING_PROMPT(spinnerType);
WAIT(timeMs);
_REMOVE_LOADING_PROMPT();
}
These are some localized strings used in the loading spinner.
"PM_WAIT" = Please Wait
"CELEB_WPLYRS" = Waiting For Players.
"CELL_SPINNER2" = Scanning storage.
"ERROR_CHECKYACHTNAME" = Registering your yacht's name. Please wait.
"ERROR_CHECKPROFANITY" = Checking your text for profanity. Please wait.
"FM_COR_AUTOD" = Just spinner no text
"FM_IHELP_WAT2" = Waiting for other players
"FM_JIP_WAITO" = Game options are being set
"FMMC_DOWNLOAD" = Downloading
"FMMC_PLYLOAD" = Loading
"FMMC_STARTTRAN" = Launching session
"HUD_QUITTING" = Quiting session
"KILL_STRIP_IDM" = Waiting for to accept
"MP_SPINLOADING" = Loading
```
]]
native "BEGIN_TEXT_COMMAND_CLEAR_PRINT"
hash "0xE124FA80A759019C"
jhash (0x550665AE)
arguments {
charPtr "text" [=[ {} ]=],
}
alias "0xE124FA80A759019C"
ns "HUD"
returns "void"
doc [[!
```
clears a print text command with this text
```
]]
native "BEGIN_TEXT_COMMAND_DISPLAY_HELP"
hash "0x8509B634FBE7DA11"
jhash (0xB245FC10)
arguments {
charPtr "inputType" [=[ {} ]=],
}
alias "_SET_TEXT_COMPONENT_FORMAT"
ns "HUD"
returns "void"
doc [[!
```
Used to be known as _SET_TEXT_COMPONENT_FORMAT
```
]]
native "BEGIN_TEXT_COMMAND_DISPLAY_TEXT"
hash "0x25FBB336DF1804CB"
jhash (0x3E35563E)
arguments {
charPtr "text" [=[ {} ]=],
}
alias "_SET_TEXT_ENTRY"
ns "HUD"
returns "void"
doc [[!
```
The following were found in the decompiled script files:
STRING, TWOSTRINGS, NUMBER, PERCENTAGE, FO_TWO_NUM, ESMINDOLLA, ESDOLLA, MTPHPER_XPNO, AHD_DIST, CMOD_STAT_0, CMOD_STAT_1, CMOD_STAT_2, CMOD_STAT_3, DFLT_MNU_OPT, F3A_TRAFDEST, ES_HELP_SOC3
ESDOLLA
ESMINDOLLA - cash (negative)
Used to be known as _SET_TEXT_ENTRY
```
]]
native "BEGIN_TEXT_COMMAND_IS_MESSAGE_DISPLAYED"
hash "0x853648FD1063A213"
jhash (0xDD524A11)
arguments {
charPtr "text" [=[ {} ]=],
}
alias "0x853648FD1063A213"
ns "HUD"
returns "void"
doc [[!
```
nothin doin.
BOOL Message(char* text)
{
BEGIN_TEXT_COMMAND_IS_MESSAGE_DISPLAYED("STRING");
ADD_TEXT_COMPONENT_SUBSTRING_PLAYER_NAME(text);
return END_TEXT_COMMAND_IS_MESSAGE_DISPLAYED();
}
```
]]
native "BEGIN_TEXT_COMMAND_IS_THIS_HELP_MESSAGE_BEING_DISPLAYED"
hash "0x0A24DA3A41B718F5"
jhash (0x00E20F2D)
arguments {
charPtr "labelName" [=[ {} ]=],
}
alias "0x0A24DA3A41B718F5"
ns "HUD"
returns "void"
doc [[!
Text entry name. This can be created using [`AddTextEntry`](#\_0x32CA01C3).
]]
native "BEGIN_TEXT_COMMAND_OVERRIDE_BUTTON_TEXT"
hash "0x8F9EE5687F8EECCD"
jhash (0xBF855650)
arguments {
charPtr "gxtEntry" [=[ {} ]=],
}
alias "0x8F9EE5687F8EECCD"
alias "_BEGIN_TEXT_COMMAND_TIMER"
ns "HUD"
returns "void"
doc [[!
]]
native "BEGIN_TEXT_COMMAND_PRINT"
hash "0xB87A37EEB7FAA67D"
jhash (0xF42C43C7)
arguments {
charPtr "GxtEntry" [=[ {} ]=],
}
alias "_SET_TEXT_ENTRY_2"
ns "HUD"
returns "void"
doc [[!
```
Used to be known as _SET_TEXT_ENTRY_2
void ShowSubtitle(char *text)
{
BEGIN_TEXT_COMMAND_PRINT("STRING");
ADD_TEXT_COMPONENT_SUBSTRING_PLAYER_NAME(text);
END_TEXT_COMMAND_PRINT(2000, 1);
}
```
]]
native "BEGIN_TEXT_COMMAND_SET_BLIP_NAME"
hash "0xF9113A30DE5C6670"
jhash (0xF4C211F6)
arguments {
charPtr "textLabel" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
Starts a text command to change the name of a blip displayed in the pause menu.
This should be paired with [`END_TEXT_COMMAND_SET_BLIP_NAME`](#\_0xBC38B49BCB83BC9B), once adding all required text components.
The text label to set.
]]
native "BEGIN_TEXT_COMMAND_THEFEED_POST"
hash "0x202709F4C58A0424"
jhash (0x574EE85C)
arguments {
charPtr "text" [=[ {} ]=],
}
alias "_SET_NOTIFICATION_TEXT_ENTRY"
ns "HUD"
returns "void"
doc [[!
Declares the entry type of a notification, for example "STRING".
int ShowNotification(char \*text)
{
BEGIN_TEXT_COMMAND_THEFEED_POST("STRING");
ADD_TEXT_COMPONENT_SUBSTRING_PLAYER_NAME(text);
return \_DRAW_NOTIFICATION(1, 1);
}
The text label to use.
]]
native "BUSYSPINNER_IS_DISPLAYING"
hash "0xB2A592B04648A9CB"
jhash (0x3AF34DEF)
alias "0xB2A592B04648A9CB"
ns "HUD"
annotations [=[ {"cs_type":"Pickup"} ]=]
returns "BOOL"
doc [[!
]]
native "BUSYSPINNER_IS_ON"
hash "0xD422FCC5F239A915"
jhash (0xB8B3A5D0)
alias "0xD422FCC5F239A915"
alias "_IS_LOADING_PROMPT_BEING_DISPLAYED"
ns "HUD"
returns "BOOL"
doc [[!
]]
native "BUSYSPINNER_OFF"
hash "0x10D373323E5B9C0D"
jhash (0x94119534)
alias "0x10D373323E5B9C0D"
alias "_REMOVE_LOADING_PROMPT"
ns "HUD"
returns "void"
doc [[!
```
Removes the loading prompt at the bottom right of the screen.
```
]]
native "CHANGE_FAKE_MP_CASH"
hash "0x0772DF77852C2E30"
jhash (0xE319F90B)
arguments {
int "cash" [=[ {} ]=],
int "bank" [=[ {} ]=],
}
alias "_SET_SINGLEPLAYER_HUD_CASH"
alias "_SET_PLAYER_CASH_CHANGE"
ns "HUD"
returns "void"
doc [[!
```
Displays cash change notifications on HUD.
```
]]
native "CLEAR_ADDITIONAL_TEXT"
hash "0x2A179DF17CCF04CD"
jhash (0x518141E0)
arguments {
int "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
]]
native "CLEAR_ALL_HELP_MESSAGES"
hash "0x6178F68A87A4D3A0"
jhash (0x9E5D9198)
ns "HUD"
returns "void"
doc [[!
]]
native "CLEAR_BRIEF"
hash "0x9D292F73ADBD9313"
jhash (0x9F75A929)
ns "HUD"
returns "void"
doc [[!
]]
native "CLEAR_DYNAMIC_PAUSE_MENU_ERROR_MESSAGE"
hash "0x7792424AA0EAC32E"
jhash (0x2F9A309C)
alias "0x7792424AA0EAC32E"
ns "HUD"
returns "void"
doc [[!
]]
native "CLEAR_FLOATING_HELP"
hash "0x50085246ABD3FEFA"
jhash (0xB181F88F)
arguments {
int "hudIndex" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
]]
native "CLEAR_GPS_CUSTOM_ROUTE"
hash "0xE6DE0561D9232A64"
jhash (0xCF2E3E24)
alias "0xE6DE0561D9232A64"
ns "HUD"
returns "void"
doc [[!
]]
native "CLEAR_GPS_FLAGS"
hash "0x21986729D6A3A830"
jhash (0x056AFCE6)
ns "HUD"
returns "void"
doc [[!
```
Clears the GPS flags. Only the script that originally called SET_GPS_FLAGS can clear them.
Doesn't seem like the flags are actually read by the game at all.
```
]]
native "CLEAR_GPS_MULTI_ROUTE"
hash "0x67EEDEA1B9BAFD94"
jhash (0x0D9969E4)
alias "0x67EEDEA1B9BAFD94"
ns "HUD"
returns "void"
doc [[!
Does the same as [`SET_GPS_MULTI_ROUTE_RENDER(false)`](#\_0x3DDA37128DD1ACA8)
]]
native "CLEAR_GPS_PLAYER_WAYPOINT"
hash "0xFF4FB7C8CDFA3DA7"
jhash (0x0B9C7FC2)
ns "HUD"
returns "void"
doc [[!
]]
native "CLEAR_GPS_RACE_TRACK"
hash "0x7AA5B4CE533C858B"
jhash (0x40C59829)
ns "HUD"
returns "void"
doc [[!
```
Does the same as SET_RACE_TRACK_RENDER(false);
```
]]
native "CLEAR_HELP"
hash "0x8DFCED7A656F8802"
jhash (0xE6D85741)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
]]
native "CLEAR_PED_IN_PAUSE_MENU"
hash "0x5E62BE5DC58E9E06"
jhash (0x28058ACF)
ns "HUD"
returns "void"
doc [[!
]]
native "CLEAR_PRINTS"
hash "0xCC33FA791322B9D9"
jhash (0x216CB1C5)
ns "HUD"
returns "void"
doc [[!
]]
native "CLEAR_REMINDER_MESSAGE"
hash "0xB57D8DD645CFA2CF"
jhash (0x5BBCC934)
alias "0xB57D8DD645CFA2CF"
ns "HUD"
returns "void"
doc [[!
**This native does absolutely nothing, just a nullsub**
]]
native "CLEAR_SMALL_PRINTS"
hash "0x2CEA2839313C09AC"
jhash (0xA869A238)
ns "HUD"
returns "void"
doc [[!
]]
native "CLEAR_THIS_PRINT"
hash "0xCF708001E1E536DD"
jhash (0x06878327)
arguments {
charPtr "p0" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
```
p0: found arguments in the b617d scripts: pastebin.com/X5akCN7z
```
]]
native "CLOSE_SOCIAL_CLUB_MENU"
hash "0xD2B32BE3FC1626C6"
jhash (0x5F86AA39)
alias "0xD2B32BE3FC1626C6"
ns "HUD"
returns "void"
doc [[!
]]
native "CREATE_FAKE_MP_GAMER_TAG"
hash "0xBFEFE3321A3F5015"
jhash (0xF5CD2AA4)
arguments {
Ped "ped" [=[ {} ]=],
charPtr "username" [=[ {} ]=],
BOOL "crewIsPrivate" [=[ {} ]=],
BOOL "crewIsRockstar" [=[ {} ]=],
charPtr "crewName" [=[ {} ]=],
int "crewRank" [=[ {} ]=],
}
alias "0xBFEFE3321A3F5015"
alias "_CREATE_MP_GAMER_TAG"
ns "HUD"
returns "int"
doc [[!
As per the name, this native creates a "fake" gamer tag that is attached to a specific ped.
Unlike "real" gamer tags, you cannot set the crew colour of these gamer tags.
To create gamer tags for actual players and for more gamer tag information, see [CREATE_MP_GAMER_TAG_WITH_CREW_COLOR](#\_0x6DD05E9D83EFA4C9).
The ped that the fake gamer tag will be attached to.
The name displayed on the gamer tag.
If the crew is private. Public crews have a pointed end cap, private crews do not.
If the crew is a Rockstar crew. Rockstar crews include a Rockstar logo before the name.
The name of the crew.
The rank from 1-5 that the player is within the crew. Use 0 if the player is the founder of the crew. Only relevant for private crews.
The ID of the new gamer tag.
]]
native "CREATE_MP_GAMER_TAG_WITH_CREW_COLOR"
hash "0x6DD05E9D83EFA4C9"
jhash (0xC969F2D0)
arguments {
Player "player" [=[ {} ]=],
charPtr "username" [=[ {} ]=],
BOOL "crewIsPrivate" [=[ {} ]=],
BOOL "crewIsRockstar" [=[ {} ]=],
charPtr "crewName" [=[ {} ]=],
int "crewRank" [=[ {} ]=],
int "crewR" [=[ {} ]=],
int "crewG" [=[ {} ]=],
int "crewB" [=[ {} ]=],
}
alias "0x6DD05E9D83EFA4C9"
alias "_CREATE_MP_GAMER_TAG_COLOR"
alias "_SET_MP_GAMER_TAG_COLOR"
alias "_CREATE_MP_GAMER_TAG_FOR_NET_PLAYER"
ns "HUD"
returns "void"
doc [[!
Creates a gamer tag for the specified local player ID, automatically attached to the player's current ped.
The created gamer tag will have the same ID as the player. You can use [IS_MP_GAMER_TAG_ACTIVE](#\_0x4E929E7A5796FD26) to check if a gamer tag already exists for a player.
After the gamer tag is created, all components will be set as invisible. Use [SET_MP_GAMER_TAG_VISIBILITY](#\_0x63BB75ABEDC1F6A0) to change the visibility of individual components or [\_SET_MP_GAMER_TAG_VISIBILITY_ALL](#\_0xEE76FF7E6A0166B0) to set all of them at once.
To create a gamer tag for a ped that is not a player, see [CREATE_FAKE_MP_GAMER_TAG](#\_0xBFEFE3321A3F5015).
The local player ID to assign the gamer tag to.
The name displayed on the gamer tag.
If the crew is private. Public crews have a pointed end cap, private crews do not.
If the crew is a Rockstar crew. Rockstar crews include a Rockstar logo before the name.
The name of the crew.
The rank from 1-5 that the player is within the crew. Use 0 if the player is the founder of the crew. Only relevant for private crews.
Red component of the crew colour.
Green component of the crew colour.
Blue component of the crew colour.
]]
native "DELETE_WAYPOINTS_FROM_THIS_PLAYER"
hash "0xD8E694757BCEA8E9"
jhash (0x62BABF2C)
alias "0xD8E694757BCEA8E9"
alias "_DELETE_WAYPOINT"
ns "HUD"
returns "void"
doc [[!
Same as [`SET_WAYPOINT_OFF`](#\_0xA7E4E2D361C2627F), except it checks if the local player is the owner of the waypoint.
]]
native "DISABLE_FRONTEND_THIS_FRAME"
hash "0x6D3465A73092F0E6"
jhash (0xD86A029E)
ns "HUD"
returns "void"
doc [[!
]]
native "DISPLAY_AMMO_THIS_FRAME"
hash "0xA5E78BA2B1331C55"
jhash (0x60693CEE)
arguments {
BOOL "display" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
]]
native "DISPLAY_AREA_NAME"
hash "0x276B6CE369C33678"
jhash (0x489FDD41)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
]]
native "DISPLAY_CASH"
hash "0x96DEC8D5430208B7"
jhash (0x0049DF83)
arguments {
BOOL "display" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
```
"DISPLAY_CASH(true);" makes the cash amount render on the screen when appropriate
"DISPLAY_CASH(false);" disables cash amount rendering
```
]]
native "DISPLAY_HELP_TEXT_THIS_FRAME"
hash "0x960C9FF8F616E41C"
jhash (0x18E3360A)
arguments {
charPtr "pTextLabel" [=[ {} ]=],
BOOL "bCurvedWindow" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
Shows a help message for one frame.
Do note that this message doesn't get added to the Pause Menu info section.
Text label for this message.
Unused parameter.
]]
native "DISPLAY_HUD"
hash "0xA6294919E56FF02A"
jhash (0xD10E4E31)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
```
If Hud should be displayed
```
]]
native "DISPLAY_HUD_WHEN_PAUSED_THIS_FRAME"
hash "0x402F9ED62087E898"
jhash (0xC47AB1B0)
alias "0x402F9ED62087E898"
ns "HUD"
returns "void"
doc [[!
]]
native "DISPLAY_PLAYER_NAME_TAGS_ON_BLIPS"
hash "0x82CEDC33687E1F50"
jhash (0x2F28F0A6)
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0x82CEDC33687E1F50"
ns "HUD"
returns "void"
doc [[!
Toggles whether or not name labels are shown on the expanded minimap next to player blips, like in GTA:O.
Doesn't need to be called every frame.
Preview: https://i.imgur.com/DfqKWfJ.png
Make sure to call SET_BLIP_CATEGORY with index 7 for this to work on the desired blip.
the toggle boolean
]]
native "DISPLAY_RADAR"
hash "0xA0EBB943C300E693"
jhash (0x52816BD4)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "HUD"
annotations [=[ {"cs_type":"Any"} ]=]
returns "void"
doc [[!
```
If Minimap / Radar should be displayed.
```
]]
native "DISPLAY_SNIPER_SCOPE_THIS_FRAME"
hash "0x73115226F4814E62"
jhash (0xBC6C73CB)
ns "HUD"
returns "void"
doc [[!
```
Displays the crosshair for this frame.
```
]]
native "DOES_BLIP_EXIST"
hash "0xA6DB27D19ECBB7DA"
jhash (0xAE92DD96)
arguments {
Blip "blip" [=[ {} ]=],
}
ns "HUD"
returns "BOOL"
doc [[!
]]
native "DOES_BLIP_HAVE_GPS_ROUTE"
hash "0xDD2238F57B977751"
jhash (0x3E47F357)
arguments {
Blip "blip" [=[ {} ]=],
}
alias "0xDD2238F57B977751"
ns "HUD"
returns "BOOL"
doc [[!
]]
native "DOES_PED_HAVE_AI_BLIP"
hash "0x15B8ECF844EE67ED"
jhash (0x3BE1257F)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "HUD"
returns "BOOL"
doc [[!
```
Returns whether the ped's blip is controlled by the game.
It's the default blip you can see on enemies during freeroam in singleplayer (the one that fades out quickly).
```
]]
native "DOES_TEXT_BLOCK_EXIST"
hash "0x1C7302E725259789"
jhash (0x96F74838)
arguments {
charPtr "gxt" [=[ {} ]=],
}
ns "HUD"
returns "BOOL"
doc [[!
]]
native "DOES_TEXT_LABEL_EXIST"
hash "0xAC09CA973C564252"
jhash (0x6ECAE560)
arguments {
charPtr "gxt" [=[ {} ]=],
}
ns "HUD"
returns "BOOL"
doc [[!
```
Checks if the passed gxt name exists in the game files.
```
]]
native "DONT_TILT_MINIMAP_THIS_FRAME"
hash "0x6D14BFDC33B34F55"
jhash (0x334EFD46)
alias "_CENTER_PLAYER_ON_RADAR_THIS_FRAME"
ns "HUD"
returns "void"
doc [[!
```
When calling this, the current frame will have the players "arrow icon" be focused on the dead center of the radar.
```
]]
native "DRAW_HUD_OVER_FADE_THIS_FRAME"
hash "0xBF4F34A85CA2970C"
jhash (0x317775DF)
alias "0xBF4F34A85CA2970C"
ns "HUD"
returns "void"
doc [[!
Allows HUD to be drawn over screen fade every frame this function is called.
]]
native "END_TEXT_COMMAND_BUSYSPINNER_ON"
hash "0xBD12F8228410D9B4"
jhash (0x903F5EE4)
arguments {
int "busySpinnerType" [=[ {} ]=],
}
alias "0xBD12F8228410D9B4"
alias "_SHOW_LOADING_PROMPT"
alias "_END_TEXT_COMMAND_BUSY_STRING"
ns "HUD"
returns "void"
doc [[!
```cpp
enum eBusySpinnerType
{
BUSY_SPINNER_LEFT = 0,
BUSY_SPINNER_LEFT_2 = 1,
BUSY_SPINNER_LEFT_3 = 2,
BUSY_SPINNER_SAVE = 3,
BUSY_SPINNER_RIGHT = 4,
};
```
]]
native "END_TEXT_COMMAND_CLEAR_PRINT"
hash "0xFCC75460ABA29378"
jhash (0x67785AF2)
alias "0xFCC75460ABA29378"
ns "HUD"
returns "void"
doc [[!
]]
native "END_TEXT_COMMAND_DISPLAY_HELP"
hash "0x238FFE5C7B0498A6"
jhash (0xB59B530D)
arguments {
int "shape" [=[ {} ]=],
BOOL "loop" [=[ {} ]=],
BOOL "beep" [=[ {} ]=],
int "duration" [=[ {} ]=],
}
alias "_DISPLAY_HELP_TEXT_FROM_STRING_LABEL"
ns "HUD"
returns "void"
doc [[!
0 for a normal rectangle shape, 1 and 2 has rounded edges, and can be used for floating help text hud component `FLOATING_HELP_TEXT_1` and `FLOATING_HELP_TEXT_2`. Use 1 for `FLOATING_HELP_TEXT_1` and 2 for `FLOATING_HELP_TEXT_2`, otherwise the help text will be reset to a normal help text on the top left corner on your screen.
If this is true, the message will stay forever unless you call [`CLEAR_ALL_HELP_MESSAGES`](#\_0x6178F68A87A4D3A0).
If this is true, the beeping sound will play. Beeping sound name is `INFO` in sound set `HUD_FRONTEND_DEFAULT_SOUNDSET`.
Duration in ms of how long this help message should display for. -1 for default.
]]
native "END_TEXT_COMMAND_DISPLAY_TEXT"
hash "0xCD015E5BB0D96A57"
jhash (0x6F8350CE)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
}
alias "_DRAW_TEXT"
ns "HUD"
returns "void"
doc [[!
```
After applying the properties to the text (See UI::SET_TEXT_), this will draw the text in the applied position. Also 0.0f < x, y < 1.0f, percentage of the axis.
```
```
NativeDB Added Parameter 3: int p2
```
]]
native "END_TEXT_COMMAND_IS_MESSAGE_DISPLAYED"
hash "0x8A9BA1AB3E237613"
jhash (0x672EFB45)
alias "0x8A9BA1AB3E237613"
ns "HUD"
returns "BOOL"
doc [[!
]]
native "END_TEXT_COMMAND_IS_THIS_HELP_MESSAGE_BEING_DISPLAYED"
hash "0x10BDDBFC529428DD"
jhash (0xF63A13EC)
arguments {
int "hudIndex" [=[ {} ]=],
}
alias "0x10BDDBFC529428DD"
ns "HUD"
returns "BOOL"
doc [[!
Returns whether a specific help message is being displayed or not.
```cpp
enum HudIndexes {
HELP_TEXT = 0,
FLOATING_HELP_TEXT_1 = 1,
FLOATING_HELP_TEXT_2 = 2,
}
```
The hud index for help message.
`true`: Indicates if the specific help message has been displayed.\
`false`: Indicates that the specific help message is still being displayed.
]]
native "END_TEXT_COMMAND_OVERRIDE_BUTTON_TEXT"
hash "0xA86911979638106F"
jhash (0x6E7FDA1C)
arguments {
int "buttonIndex" [=[ {"cs_type":"BOOL"} ]=],
}
alias "0xA86911979638106F"
alias "_END_TEXT_COMMAND_TIMER"
ns "HUD"
returns "void"
doc [[!
Index of the instructional button
]]
native "END_TEXT_COMMAND_PRINT"
hash "0x9D77056A530643F6"
jhash (0x38F82261)
arguments {
int "duration" [=[ {} ]=],
BOOL "drawImmediately" [=[ {} ]=],
}
alias "_DRAW_SUBTITLE_TIMED"
ns "HUD"
returns "void"
doc [[!
```
Draws the subtitle at middle center of the screen.
int duration = time in milliseconds to show text on screen before disappearing
drawImmediately = If true, the text will be drawn immediately, if false, the text will be drawn after the previous subtitle has finished
Used to be known as _DRAW_SUBTITLE_TIMED
```
]]
native "END_TEXT_COMMAND_SET_BLIP_NAME"
hash "0xBC38B49BCB83BC9B"
jhash (0xE8E59820)
arguments {
Blip "blip" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
Finalizes a text command started with [`BEGIN_TEXT_COMMAND_SET_BLIP_NAME`](#\_0xF9113A30DE5C6670), setting the name
of the specified blip.
The blip to change the name for.
]]
native "END_TEXT_COMMAND_THEFEED_POST_AWARD"
hash "0xAA295B6F28BD587D"
jhash (0x02DED2B8)
arguments {
charPtr "textureDict" [=[ {} ]=],
charPtr "textureName" [=[ {} ]=],
int "rpBonus" [=[ {} ]=],
int "colorOverlay" [=[ {} ]=],
charPtr "titleLabel" [=[ {} ]=],
}
alias "0xAA295B6F28BD587D"
alias "_DRAW_NOTIFICATION_ICON"
alias "_DRAW_NOTIFICATION_AWARD"
ns "HUD"
returns "int"
doc [[!
Shows an "award" notification above the minimap, lua example result:

Old description:
```
Example:
UI::_SET_NOTIFICATION_TEXT_ENTRY("HUNT");
UI::_0xAA295B6F28BD587D("Hunting", "Hunting_Gold_128", 0, 109, "HUD_MED_UNLKED");
```
The texture dictionary name for the icon on the left.
The texture name for the icon on the left.
The gained "RP" amount that will be displayed on the right side of the notification.
Hudcolor overlay that gets applied on top of the notification, conflicts with text/image visibility in most cases if set to something other than 0.
The label that will be displayed at the top of the notification (title).
The notification handle.
]]
native "END_TEXT_COMMAND_THEFEED_POST_CREW_RANKUP"
hash "0x8EFCCF6EC66D85E4"
jhash (0x76FB0F21)
arguments {
charPtr "chTitle" [=[ {} ]=],
charPtr "clanTxd" [=[ {} ]=],
charPtr "clanTxn" [=[ {} ]=],
BOOL "isImportant" [=[ {} ]=],
BOOL "showSubtitle" [=[ {} ]=],
}
alias "0x8EFCCF6EC66D85E4"
ns "HUD"
returns "int"
doc [[!
]]
native "END_TEXT_COMMAND_THEFEED_POST_CREWTAG"
hash "0x97C9E4E7024A8F2C"
jhash (0xA9CCEF66)
arguments {
BOOL "crewTypeIsPrivate" [=[ {} ]=],
BOOL "crewTagContainsRockstar" [=[ {} ]=],
intPtr "crewTag" [=[ {} ]=],
int "rank" [=[ {} ]=],
BOOL "hasFounderStatus" [=[ {} ]=],
BOOL "isImportant" [=[ {} ]=],
int "clanHandle" [=[ {} ]=],
int "r" [=[ {} ]=],
int "g" [=[ {} ]=],
int "b" [=[ {} ]=],
}
alias "0x97C9E4E7024A8F2C"
alias "_NOTIFICATION_SEND_APARTMENT_INVITE"
alias "_DRAW_NOTIFICATION_APARTMENT_INVITE"
ns "HUD"
returns "int"
doc [[!
```
This function and the one below it are for after you receive an invite, not sending it.
p0 = 1 or 0
nothin doin.
int invite(Player player)
{
int iVar2, iVar3;
networkHandleMgr handle;
NETWORK_HANDLE_FROM_PLAYER(player, &handle.netHandle, 13);
networkClanMgr clan;
char *playerName = GET_PLAYER_NAME(player);
_SET_NOTIFICATION_TEXT_ENTRY("STRING");
_SET_NOTIFACTION_COLOR_NEXT(0);
ADD_TEXT_COMPONENT_SUBSTRING_PLAYER_NAME(playerName);
if (NETWORK_CLAN_PLAYER_GET_DESC(&clan, 35, &handle.netHandle))
{
iVar2 = 0;
if (ARE_STRINGS_EQUAL(clan.unk22, "Leader") && clan.unk30 == 0)
{
iVar2 = 1;
}
if (clan.unk21 > 0)
{
iVar3 = 0;
}
else
{
iVar3 = 1;
}
BOOL unused = _0x54E79E9C(&clan.clanHandle, 35);
return _DRAW_NOTIFICATION_APARTMENT_INVITE(iVar3, 0 /*unused*/, &clan.unk17, clan.unk30, iVar2, 0, clan.clanHandle, 0, 0, 0);
}
}
```
]]
native "END_TEXT_COMMAND_THEFEED_POST_CREWTAG_WITH_GAME_NAME"
hash "0x137BC35589E34E1E"
jhash (0x88B9B909)
arguments {
BOOL "crewTypeIsPrivate" [=[ {} ]=],
BOOL "crewTagContainsRockstar" [=[ {} ]=],
intPtr "crewTag" [=[ {} ]=],
int "rank" [=[ {} ]=],
BOOL "isLeader" [=[ {} ]=],
BOOL "isImportant" [=[ {} ]=],
int "clanHandle" [=[ {} ]=],
charPtr "gamerStr" [=[ {} ]=],
int "r" [=[ {} ]=],
int "g" [=[ {} ]=],
int "b" [=[ {} ]=],
}
alias "0x137BC35589E34E1E"
alias "_NOTIFICATION_SEND_CLAN_INVITE"
alias "_DRAW_NOTIFICATION_CLAN_INVITE"
ns "HUD"
returns "int"
doc [[!
```
p0 = 1 or 0
crashes my game...
this is for sending invites to network players - jobs/apartment/ect...
return notification handle
int invite(Player player)
{
networkHandleMgr netHandle;
networkClanMgr clan;
char *playerName = GET_PLAYER_NAME(player);
_SET_NOTIFICATION_TEXT_ENTRY("STRING");
_SET_NOTIFACTION_COLOR_NEXT(1);
ADD_TEXT_COMPONENT_SUBSTRING_PLAYER_NAME(playerName);
NETWORK_HANDLE_FROM_PLAYER(player, &netHandle.netHandle, 13);
if (NETWORK_CLAN_PLAYER_IS_ACTIVE(&netHandle.netHandle))
{
NETWORK_CLAN_PLAYER_GET_DESC(&clan.clanHandle, 35, &netHandle.netHandle);
_DRAW_NOTIFICATION_CLAN_INVITE(0, _0x54E79E9C(&clan.clanHandle, 35), &clan.unk17, clan.isLeader, 0, 0, clan.clanHandle, playerName, 0, 0, 0);
}
}
```
]]
native "END_TEXT_COMMAND_THEFEED_POST_MESSAGETEXT"
hash "0x1CCD9A37359072CF"
jhash (0xE7E3C98B)
arguments {
charPtr "textureDict" [=[ {} ]=],
charPtr "textureName" [=[ {} ]=],
BOOL "flash" [=[ {} ]=],
int "iconType" [=[ {} ]=],
charPtr "sender" [=[ {} ]=],
charPtr "subject" [=[ {} ]=],
}
alias "_SET_NOTIFICATION_MESSAGE"
ns "HUD"
returns "int"
doc [[!
Sets some extra options for a notification. It adds an image (or icon type) and sets a notification title (sender) and subtitle (subject).
Texture dictionary and texture name parameters are usually the same exact value.
Example result:

Old description with list of possible icons and texture names:
```
List of picNames: pastebin.com/XdpJVbHz
flash is a bool for fading in.
iconTypes:
1 : Chat Box
2 : Email
3 : Add Friend Request
4 : Nothing
5 : Nothing
6 : Nothing
7 : Right Jumping Arrow
8 : RP Icon
9 : $ Icon
"sender" is the very top header. This can be any old string.
"subject" is the header under the sender.
```
The texture dictionary for the icon.
The texture name for the icon.
Flash, doesn't seem to work no matter what.
The icon type, see the list in the description below.
The notification title.
The notification subtitle.
The notification handle.
]]
native "END_TEXT_COMMAND_THEFEED_POST_MESSAGETEXT_TU"
hash "0x1E6611149DB3DB6B"
jhash (0x0EB382B7)
arguments {
charPtr "picTxd" [=[ {} ]=],
charPtr "picTxn" [=[ {} ]=],
BOOL "flash" [=[ {} ]=],
int "iconType" [=[ {} ]=],
charPtr "nameStr" [=[ {} ]=],
charPtr "subtitleStr" [=[ {} ]=],
float "durationMultiplier" [=[ {} ]=],
}
alias "0x1E6611149DB3DB6B"
alias "_SET_NOTIFICATION_MESSAGE_4"
ns "HUD"
returns "int"
doc [[!
Example, only occurrence in the scripts:
```
v_8 = UI::END_TEXT_COMMAND_THEFEED_POST_MESSAGETEXT_TU("CHAR_SOCIAL_CLUB", "CHAR_SOCIAL_CLUB", 0, 0, &v_9, "", a_5);
```
Example result:

The icon type, you can find those here: [`END_TEXT_COMMAND_THEFEED_POST_MESSAGETEXT`](#\_0x1CCD9A37359072CF)
1.0 is normal, 2.0 is twice as long, and 0.5 is half its normal display time.
]]
native "END_TEXT_COMMAND_THEFEED_POST_MESSAGETEXT_WITH_CREW_TAG"
hash "0x5CBF7BADE20DB93E"
jhash (0x3E807FE3)
arguments {
charPtr "picTxd" [=[ {} ]=],
charPtr "picTxn" [=[ {} ]=],
BOOL "flash" [=[ {} ]=],
int "iconType" [=[ {} ]=],
charPtr "nameStr" [=[ {} ]=],
charPtr "subtitleStr" [=[ {} ]=],
float "duration" [=[ {} ]=],
charPtr "crewPackedStr" [=[ {} ]=],
}
alias "_SET_NOTIFICATION_MESSAGE_CLAN_TAG"
ns "HUD"
returns "int"
doc [[!
```
List of picNames pastebin.com/XdpJVbHz
flash is a bool for fading in.
iconTypes:
1 : Chat Box
2 : Email
3 : Add Friend Request
4 : Nothing
5 : Nothing
6 : Nothing
7 : Right Jumping Arrow
8 : RP Icon
9 : $ Icon
"sender" is the very top header. This can be any old string.
"subject" is the header under the sender.
"duration" is a multiplier, so 1.0 is normal, 2.0 is twice as long (very slow), and 0.5 is half as long.
"clanTag" shows a crew tag in the "sender" header, after the text. You need to use 3 underscores as padding. Maximum length of this field seems to be 7. (e.g. "MK" becomes "___MK", "ACE" becomes "___ACE", etc.)
```
]]
native "END_TEXT_COMMAND_THEFEED_POST_MESSAGETEXT_WITH_CREW_TAG_AND_ADDITIONAL_ICON"
hash "0x531B84E7DA981FB6"
jhash (0xDEB491C8)
arguments {
charPtr "picTxd" [=[ {} ]=],
charPtr "picTxn" [=[ {} ]=],
BOOL "flash" [=[ {} ]=],
int "iconType1" [=[ {} ]=],
charPtr "nameStr" [=[ {} ]=],
charPtr "subtitleStr" [=[ {} ]=],
float "duration" [=[ {} ]=],
charPtr "crewPackedStr" [=[ {} ]=],
int "iconType2" [=[ {} ]=],
int "textColor" [=[ {} ]=],
}
alias "_SET_NOTIFICATION_MESSAGE_CLAN_TAG_2"
ns "HUD"
returns "int"
doc [[!
```
List of picNames: pastebin.com/XdpJVbHz
flash is a bool for fading in.
iconTypes:
1 : Chat Box
2 : Email
3 : Add Friend Request
4 : Nothing
5 : Nothing
6 : Nothing
7 : Right Jumping Arrow
8 : RP Icon
9 : $ Icon
"sender" is the very top header. This can be any old string.
"subject" is the header under the sender.
"duration" is a multiplier, so 1.0 is normal, 2.0 is twice as long (very slow), and 0.5 is half as long.
"clanTag" shows a crew tag in the "sender" header, after the text. You need to use 3 underscores as padding. Maximum length of this field seems to be 7. (e.g. "MK" becomes "___MK", "ACE" becomes "___ACE", etc.)
iconType2 is a mirror of iconType. It shows in the "subject" line, right under the original iconType.
int IconNotification(char *text, char *text2, char *Subject)
{
_SET_NOTIFICATION_TEXT_ENTRY("STRING");
ADD_TEXT_COMPONENT_SUBSTRING_PLAYER_NAME(text);
_SET_NOTIFICATION_MESSAGE_CLAN_TAG_2("CHAR_SOCIAL_CLUB", "CHAR_SOCIAL_CLUB", 1, 7, text2, Subject, 1.0f, "__EXAMPLE", 7);
return _DRAW_NOTIFICATION(1, 1);
}
```
]]
native "END_TEXT_COMMAND_THEFEED_POST_MPTICKER"
hash "0xF020C96915705B3A"
jhash (0x8E319AB8)
arguments {
BOOL "isImportant" [=[ {} ]=],
BOOL "showInBrief" [=[ {} ]=],
}
alias "_DRAW_NOTIFICATION_4"
ns "HUD"
returns "int"
doc [[!
Exactly the same as [`END_TEXT_COMMAND_THEFEED_POST_TICKER`](#\_0x2ED7843F8F801023).
If true, the notification will flash.
If true, the message will be shown in Pause Menu > Info > Notifications.
The notification handle.
]]
native "END_TEXT_COMMAND_THEFEED_POST_STATS"
hash "0x2B7E9A4EAAA93C89"
jhash (0xED130FA1)
arguments {
charPtr "statTitle" [=[ {} ]=],
int "iconEnum" [=[ {} ]=],
BOOL "stepVal" [=[ {} ]=],
int "barValue" [=[ {} ]=],
BOOL "isImportant" [=[ {} ]=],
charPtr "picTxd" [=[ {} ]=],
charPtr "picTxn" [=[ {} ]=],
}
alias "0x2B7E9A4EAAA93C89"
alias "_SET_NOTIFICATION_MESSAGE_2"
ns "HUD"
returns "int"
doc [[!
[List of picture names](https://pastebin.com/XdpJVbHz)
Example result:

The notification handle.
]]
native "END_TEXT_COMMAND_THEFEED_POST_TICKER"
hash "0x2ED7843F8F801023"
jhash (0x08F7AF78)
arguments {
BOOL "isImportant" [=[ {} ]=],
BOOL "showInBrief" [=[ {} ]=],
}
alias "_DRAW_NOTIFICATION"
ns "HUD"
returns "int"
doc [[!
Posts a generic feed notification:

````
## Parameters
* **isImportant**: Makes the notification flash on the screen.
* **showInBrief**: Makes the notification appear in the "Pause Menu > Info/Brief > Notifications" section.
## Return value
The notification handle.
## Examples
```lua
AddTextEntry("MyFeedMessage", "Hello " .. GetPlayerName(PlayerId()) .. ".")
BeginTextCommandThefeedPost("MyFeedMessage")
EndTextCommandThefeedPostTicker(true, true)
````
]]
native "END_TEXT_COMMAND_THEFEED_POST_TICKER_FORCED"
hash "0x44FA03975424A0EE"
jhash (0x57B8D0D4)
arguments {
BOOL "isImportant" [=[ {} ]=],
BOOL "showInBrief" [=[ {} ]=],
}
alias "_DRAW_NOTIFICATION_2"
ns "HUD"
returns "int"
doc [[!
Posts an above minimap feed notification that is forced (Previous messages will be cleared).
If true, the notification will flash.
If true, shows in Pause Menu > Info > Notifications.
The notification handle.
]]
native "END_TEXT_COMMAND_THEFEED_POST_TICKER_WITH_TOKENS"
hash "0x378E809BF61EC840"
jhash (0x02BCAF9B)
arguments {
BOOL "isImportant" [=[ {} ]=],
BOOL "showInBrief" [=[ {} ]=],
}
alias "_DRAW_NOTIFICATION_3"
ns "HUD"
returns "int"
doc [[!
Posts an above minimap feed message with tokens support (blips, input keys, etc...)
Makes the notification flash.
Shows in Pause Menu > Info > Notifications.
Notification handle.
]]
native "END_TEXT_COMMAND_THEFEED_POST_UNLOCK"
hash "0x33EE12743CCD6343"
jhash (0xE05E7052)
arguments {
charPtr "chTitle" [=[ {} ]=],
int "iconType" [=[ {} ]=],
charPtr "chSubtitle" [=[ {} ]=],
}
alias "0x33EE12743CCD6343"
ns "HUD"
returns "Any"
doc [[!
]]
native "END_TEXT_COMMAND_THEFEED_POST_UNLOCK_TU"
hash "0xC8F3AAF93D0600BF"
jhash (0x4FA43BA4)
arguments {
charPtr "chTitle" [=[ {} ]=],
int "iconType" [=[ {} ]=],
charPtr "chSubtitle" [=[ {} ]=],
BOOL "isImportant" [=[ {} ]=],
}
alias "0xC8F3AAF93D0600BF"
ns "HUD"
returns "Any"
doc [[!
]]
native "END_TEXT_COMMAND_THEFEED_POST_UNLOCK_TU_WITH_COLOR"
hash "0x7AE0589093A2E088"
jhash (0x8C90D22F)
arguments {
charPtr "chTitle" [=[ {} ]=],
int "iconType" [=[ {} ]=],
charPtr "chSubtitle" [=[ {} ]=],
BOOL "isImportant" [=[ {} ]=],
int "titleColor" [=[ {} ]=],
BOOL "p5" [=[ {} ]=],
}
alias "0x7AE0589093A2E088"
ns "HUD"
returns "Any"
doc [[!
]]
native "END_TEXT_COMMAND_THEFEED_POST_VERSUS_TU"
hash "0xB6871B0555B02996"
jhash (0x5E93FBFA)
arguments {
charPtr "ch1TXD" [=[ {} ]=],
charPtr "ch1TXN" [=[ {} ]=],
int "val1" [=[ {} ]=],
charPtr "ch2TXD" [=[ {} ]=],
charPtr "ch2TXN" [=[ {} ]=],
int "val2" [=[ {} ]=],
}
alias "0xB6871B0555B02996"
ns "HUD"
returns "int"
doc [[!
```
NativeDB Added Parameter 7: int hudColorIndex1
NativeDB Added Parameter 8: int hudColorIndex2
```
]]
native "FLAG_PLAYER_CONTEXT_IN_TOURNAMENT"
hash "0xCEF214315D276FD1"
jhash (0xFF06772A)
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0xCEF214315D276FD1"
alias "_SET_IS_IN_TOURNAMENT"
ns "HUD"
returns "void"
doc [[!
]]
native "FLASH_ABILITY_BAR"
hash "0x02CFBA0C9E9275CE"
jhash (0x3648960D)
arguments {
int "millisecondsToFlash" [=[ {"cs_type":"BOOL"} ]=],
}
ns "HUD"
returns "void"
doc [[!
]]
native "FLASH_MINIMAP_DISPLAY"
hash "0xF2DD778C22B15BDA"
jhash (0xB8359952)
ns "HUD"
returns "void"
doc [[!
```
adds a short flash to the Radar/Minimap
Usage: UI.FLASH_MINIMAP_DISPLAY
```
]]
native "FLASH_MINIMAP_DISPLAY_WITH_COLOR"
hash "0x6B1DE27EE78E6A19"
jhash (0x79A6CAF6)
arguments {
int "hudColorIndex" [=[ {} ]=],
}
alias "0x6B1DE27EE78E6A19"
ns "HUD"
returns "void"
doc [[!
]]
native "FLASH_WANTED_DISPLAY"
hash "0xA18AFB39081B6A1F"
jhash (0x629F866B)
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "HUD"
annotations [=[ {"cs_type":"Any"} ]=]
returns "void"
doc [[!
]]
native "FORCE_CLOSE_REPORTUGC_MENU"
hash "0xEE4C0E6DBC6F2C6F"
jhash (0x67649EE0)
alias "0xEE4C0E6DBC6F2C6F"
ns "HUD"
returns "void"
doc [[!
]]
native "FORCE_CLOSE_TEXT_INPUT_BOX"
hash "0x8817605C2BA76200"
alias "0x8817605C2BA76200"
alias "_FORCE_CLOSE_TEXT_INPUT_BOX"
ns "HUD"
returns "void"
doc [[!
]]
native "FORCE_SONAR_BLIPS_THIS_FRAME"
hash "0x1121BFA1A1A522A8"
jhash (0x3F4AFB13)
alias "0x1121BFA1A1A522A8"
ns "HUD"
returns "Any"
doc [[!
```
Doesn't actually return anything.
```
]]
native "GET_BLIP_ALPHA"
hash "0x970F608F0EE6C885"
jhash (0x297AF6C8)
arguments {
Blip "blip" [=[ {} ]=],
}
ns "HUD"
returns "int"
doc [[!
]]
native "GET_BLIP_COLOUR"
hash "0xDF729E8D20CF7327"
jhash (0xDD6A1E54)
arguments {
Blip "blip" [=[ {} ]=],
}
ns "HUD"
returns "int"
doc [[!
]]
native "GET_BLIP_COORDS"
hash "0x586AFE3FF72D996E"
jhash (0xEF6FF47B)
arguments {
Blip "blip" [=[ {} ]=],
}
ns "HUD"
returns "Vector3"
doc [[!
]]
native "GET_BLIP_FROM_ENTITY"
hash "0xBC8DBDCA2436F7E8"
jhash (0x005A2A47)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "HUD"
returns "Blip"
doc [[!
```
Returns the Blip handle of given Entity.
```
]]
native "GET_BLIP_HUD_COLOUR"
hash "0x729B5F1EFBC0AAEE"
jhash (0xE88B4BC2)
arguments {
Blip "blip" [=[ {} ]=],
}
ns "HUD"
returns "int"
doc [[!
]]
native "GET_BLIP_INFO_ID_COORD"
hash "0xFA7C7F0AADF25D09"
jhash (0xB7374A66)
arguments {
Blip "blip" [=[ {} ]=],
}
ns "HUD"
returns "Vector3"
doc [[!
]]
native "GET_BLIP_INFO_ID_DISPLAY"
hash "0x1E314167F701DC3B"
jhash (0xD0FC19F4)
arguments {
Blip "blip" [=[ {} ]=],
}
ns "HUD"
returns "int"
doc [[!
]]
native "GET_BLIP_INFO_ID_ENTITY_INDEX"
hash "0x4BA4E2553AFEDC2C"
jhash (0xA068C40B)
arguments {
Blip "blip" [=[ {} ]=],
}
ns "HUD"
returns "Entity"
doc [[!
]]
native "GET_BLIP_INFO_ID_PICKUP_INDEX"
hash "0x9B6786E4C03DD382"
jhash (0x86913D37)
arguments {
Blip "blip" [=[ {} ]=],
}
ns "HUD"
returns "Pickup"
doc [[!
```
This function is hard-coded to always return 0.
```
]]
native "GET_BLIP_INFO_ID_TYPE"
hash "0xBE9B0959FFD0779B"
jhash (0x501D7B4E)
arguments {
Blip "blip" [=[ {} ]=],
}
ns "HUD"
returns "int"
doc [[!
```
Returns a value based on what the blip is attached to
1 - Vehicle
2 - Ped
3 - Object
4 - Coord
5 - unk
6 - Pickup
7 - Radius
```
]]
native "GET_BLIP_SPRITE"
hash "0x1FC877464A04FC4F"
jhash (0x72FF2E73)
arguments {
Blip "blip" [=[ {} ]=],
}
ns "HUD"
returns "int"
doc [[!
Gets the sprite id of the specified blip. Blip sprite ids and images can be found [here](https://docs.fivem.net/docs/game-references/blips/).
The blip handle.
]]
native "GET_CURRENT_FRONTEND_MENU_VERSION"
hash "0x2309595AD6145265"
jhash (0x33D6868F)
alias "0x2309595AD6145265"
alias "_GET_CURRENT_FRONTEND_MENU"
ns "HUD"
returns "Hash"
doc [[!
```
if (HUD::GET_CURRENT_FRONTEND_MENU_VERSION() == joaat("fe_menu_version_empty_no_background"))
```
]]
native "GET_CURRENT_WEBPAGE_ID"
hash "0x01A358D9128B7A86"
jhash (0xAB5B7C18)
alias "0x01A358D9128B7A86"
alias "_GET_ACTIVE_WEBSITE_ID"
ns "HUD"
returns "int"
doc [[!
]]
native "GET_CURRENT_WEBSITE_ID"
hash "0x97D47996FC48CBAD"
jhash (0x42A55B14)
ns "HUD"
returns "int"
doc [[!
]]
native "GET_DEFAULT_SCRIPT_RENDERTARGET_RENDER_ID"
hash "0x52F0982D7FD156B6"
jhash (0x8188935F)
ns "HUD"
returns "int"
doc [[!
```
This function is hard-coded to always return 1.
```
]]
native "GET_FILENAME_FOR_AUDIO_CONVERSATION"
hash "0x7B5280EBA9840C72"
jhash (0x95C4B5AD)
arguments {
charPtr "labelName" [=[ {} ]=],
}
alias "0x7B5280EBA9840C72"
alias "_GET_LABEL_TEXT"
ns "HUD"
returns "charPtr"
doc [[!
Gets a localized string literal from a label name. This is used to get the filename of the audio conversation associated with the provided label name.
The label name for which the audio conversation filename is requested.
Returns the filename associated with the provided labelName.
]]
native "GET_FIRST_BLIP_INFO_ID"
hash "0x1BEDE233E6CD2A1F"
jhash (0x64C0273D)
arguments {
int "blipSprite" [=[ {} ]=],
}
ns "HUD"
returns "Blip"
doc [[!
Also see [`GET_NEXT_BLIP_INFO_ID`](#\_0x14F96AA50D6FBEA7) for an example.
Sprite ID, see the [Blips Game Reference](https://docs.fivem.net/docs/game-references/blips/) for the full list.
Returns the first blip ID in an interator that has the specified blip sprite.
]]
native "GET_GLOBAL_ACTIONSCRIPT_FLAG"
hash "0xE3B05614DCE1D014"
jhash (0xD217EE7E)
arguments {
int "flagIndex" [=[ {} ]=],
}
alias "0xE3B05614DCE1D014"
ns "HUD"
returns "int"
doc [[!
```
Returns the ActionScript flagValue.
ActionScript flags are global flags that scaleforms use
Flags found during testing
0: Returns 1 if the web_browser keyboard is open, otherwise 0
1: Returns 1 if the player has clicked back twice on the opening page, otherwise 0 (web_browser)
2: Returns how many links the player has clicked in the web_browser scaleform, returns 0 when the browser gets closed
9: Returns the current selection on the mobile phone scaleform
There are 20 flags in total.
```
]]
native "GET_HUD_COLOUR"
hash "0x7C9C91AB74A0360F"
jhash (0x63F66A0B)
arguments {
int "hudColorIndex" [=[ {} ]=],
intPtr "r" [=[ {} ]=],
intPtr "g" [=[ {} ]=],
intPtr "b" [=[ {} ]=],
intPtr "a" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
Gets hud color RGBA parameter values by passing a hud color index (hudColorIndex).
HUD colors can be found [here](https://docs.fivem.net/docs/game-references/hud-colors/)
]]
native "GET_HUD_COMPONENT_POSITION"
hash "0x223CA69A8C4417FD"
jhash (0x080DCED6)
arguments {
int "id" [=[ {} ]=],
}
ns "HUD"
returns "Vector3"
doc [[!
]]
native "GET_HUD_SCREEN_POSITION_FROM_WORLD_POSITION"
hash "0xF9904D11F1ACBEC3"
jhash (0xFE9A39F8)
arguments {
float "worldX" [=[ {} ]=],
float "worldY" [=[ {} ]=],
float "worldZ" [=[ {} ]=],
floatPtr "screenX" [=[ {} ]=],
floatPtr "screenY" [=[ {} ]=],
}
alias "0xF9904D11F1ACBEC3"
alias "_GET_2D_COORD_FROM_3D_COORD"
ns "HUD"
returns "BOOL"
doc [[!
```
World to relative screen coords
this world to screen will keep the text on screen. it will keep it in the screen pos
```
]]
native "GET_LENGTH_OF_LITERAL_STRING"
hash "0xF030907CCBB8A9FD"
jhash (0x99379D55)
arguments {
charPtr "string" [=[ {} ]=],
}
ns "HUD"
returns "int"
doc [[!
```
Returns the length of the string passed (much like strlen).
```
]]
native "GET_LENGTH_OF_LITERAL_STRING_IN_BYTES"
hash "0x43E4111189E54F0E"
jhash (0x7DBC0764)
arguments {
charPtr "string" [=[ {} ]=],
}
alias "0x43E4111189E54F0E"
alias "_GET_LENGTH_OF_STRING"
ns "HUD"
returns "int"
doc [[!
]]
native "GET_LENGTH_OF_STRING_WITH_THIS_TEXT_LABEL"
hash "0x801BD273D3A23F74"
jhash (0xA4CA7BE5)
arguments {
charPtr "gxt" [=[ {} ]=],
}
ns "HUD"
returns "int"
doc [[!
```
Returns the string length of the string from the gxt string .
```
]]
native "GET_MAIN_PLAYER_BLIP_ID"
hash "0xDCD4EC3F419D02FA"
jhash (0xAB93F020)
ns "HUD"
returns "Blip"
doc [[!
]]
native "GET_MENU_PED_BOOL_STAT"
hash "0x052991E59076E4E4"
jhash (0xD43BB56D)
arguments {
Hash "p0" [=[ {} ]=],
AnyPtr "p1" [=[ {} ]=],
}
alias "0x052991E59076E4E4"
ns "HUD"
returns "BOOL"
doc [[!
```
p0 was always 0xAE2602A3.
```
]]
native "GET_MENU_PED_FLOAT_STAT"
hash "0x5FBD7095FE7AE57F"
jhash (0x51972B04)
arguments {
Any "p0" [=[ {} ]=],
floatPtr "p1" [=[ {} ]=],
}
alias "0x5FBD7095FE7AE57F"
ns "HUD"
returns "BOOL"
doc [[!
]]
native "GET_MENU_PED_INT_STAT"
hash "0xEF4CED81CEBEDC6D"
jhash (0x4370999E)
arguments {
Any "p0" [=[ {} ]=],
AnyPtr "p1" [=[ {} ]=],
}
alias "SET_USERIDS_UIHIDDEN"
alias "0xEF4CED81CEBEDC6D"
ns "HUD"
returns "BOOL"
doc [[!
]]
native "GET_MENU_PED_MASKED_INT_STAT"
hash "0x90A6526CF0381030"
jhash (0xD6CC4766)
arguments {
Any "p0" [=[ {} ]=],
AnyPtr "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
alias "0x90A6526CF0381030"
ns "HUD"
returns "BOOL"
doc [[!
]]
native "GET_MINIMAP_FOW_COORDINATE_IS_REVEALED"
hash "0x6E31B91145873922"
jhash (0x65B705F6)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
alias "0x6E31B91145873922"
alias "_IS_MINIMAP_AREA_REVEALED"
ns "HUD"
returns "BOOL"
doc [[!
]]
native "GET_MINIMAP_FOW_DISCOVERY_RATIO"
hash "0xE0130B41D3CF4574"
jhash (0xA4098ACC)
alias "0xE0130B41D3CF4574"
alias "_GET_MINIMAP_REVEAL_PERCENTAGE"
ns "HUD"
returns "float"
doc [[!
]]
native "GET_MOUSE_EVENT"
hash "0x632B2940C67F4EA9"
arguments {
int "scaleformHandle" [=[ {} ]=],
boolPtr "received" [=[ {"cs_type":"Any*"} ]=],
intPtr "selectionType" [=[ {"cs_type":"Any*"} ]=],
intPtr "context" [=[ {"cs_type":"Any*"} ]=],
intPtr "slotIndex" [=[ {} ]=],
}
alias "0x632B2940C67F4EA9"
alias "_GET_SCALEFORM_MOVIE_CURSOR_SELECTION"
ns "HUD"
returns "BOOL"
doc [[!
Gets mouse event data from scaleforms with mouse support. Must be checked every frame.
Returns item index if using the COLOUR_SWITCHER\_02 scaleform.
Selection types, found in MOUSE_EVENTS.as:
MOUSE_DRAG_OUT = 0;
MOUSE_DRAG_OVER = 1;
MOUSE_DOWN = 2;
MOUSE_MOVE = 3;
MOUSE_UP = 4;
MOUSE_PRESS = 5;
MOUSE_RELEASE = 6;
MOUSE_RELEASE_OUTSIDE = 7;
MOUSE_ROLL_OUT = 8;
MOUSE_ROLL_OVER = 9;
MOUSE_WHEEL_UP = 10;
MOUSE_WHEEL_DOWN = 11;
Scaleforms that this works with:
* COLOUR_SWITCHER\_02
* MP_RESULTS_PANEL
* MP_NEXT_JOB_SELECTION
* SC_LEADERBOARD
Probably works with other scaleforms, needs more research.
In order to use this Native you MUST have controls 239, 240, 237, 238 enabled!
This native, due to its erroneous redundancy of the returned boolean value, works differently in C#: shifting the parameters (where `received` becomes `selectionType` and so on making the fourth parameter unused and always 0).
Handle of the scaleform
Returns a boolean indicating if the data was received successfully (in Lua).
The type of MouseEvent specified above.
Context of the slot the mouse is hovering on.
Index of the slot the mouse is hovering on.
* **retVal** Returns true if MOUSE_EVENT callback from Scaleforms has been called.
]]
native "GET_NAMED_RENDERTARGET_RENDER_ID"
hash "0x1A6478B61C6BDC3B"
jhash (0xF9D7A401)
arguments {
charPtr "name" [=[ {} ]=],
}
ns "HUD"
returns "int"
doc [[!
]]
native "GET_NEW_SELECTED_MISSION_CREATOR_BLIP"
hash "0x5C90988E7C8E1AF4"
jhash (0xFFD7476C)
alias "DISABLE_BLIP_NAME_FOR_VAR"
alias "0x5C90988E7C8E1AF4"
ns "HUD"
returns "Blip"
doc [[!
]]
native "GET_NEXT_BLIP_INFO_ID"
hash "0x14F96AA50D6FBEA7"
jhash (0x9356E92F)
arguments {
int "blipSprite" [=[ {} ]=],
}
ns "HUD"
returns "Blip"
doc [[!
Sprite ID, see the [Game Reference](https://docs.fivem.net/docs/game-references/blips/) for the full list.
Returns the next blip ID in an interator that has the specified blip sprite.
]]
native "GET_NUMBER_OF_ACTIVE_BLIPS"
hash "0x9A3FF3DE163034E8"
jhash (0x144020FA)
ns "HUD"
returns "int"
doc [[!
]]
native "GET_PAUSE_MENU_STATE"
hash "0x272ACD84970869C5"
jhash (0x92F50134)
ns "HUD"
returns "int"
doc [[!
```cpp
enum ePauseMenuState
{
PM_INACTIVE = 0,
PM_STARTING_UP = 5,
PM_RESTARTING = 10,
PM_READY = 15,
PM_IN_STORE = 20,
PM_IN_SC_MENU = 25,
PM_SHUTTING_DOWN = 30,
PM_IN_VIDEOEDITOR = 35,
}
```
]]
native "GET_RENDERED_CHARACTER_HEIGHT"
hash "0xDB88A37483346780"
jhash (0x3330175B)
arguments {
float "size" [=[ {} ]=],
int "font" [=[ {} ]=],
}
alias "0xDB88A37483346780"
alias "_GET_TEXT_SCALE_HEIGHT"
ns "HUD"
returns "float"
doc [[!
```
This gets the height of the FONT and not the total text. You need to get the number of lines your text uses, and get the height of a newline (I'm using a smaller value) to get the total text height.
Old name: _GET_TEXT_SCALE_HEIGHT
```
]]
native "GET_STANDARD_BLIP_ENUM_ID"
hash "0x4A9923385BDB9DAD"
jhash (0x87871CE0)
alias "0x4A9923385BDB9DAD"
alias "_GET_LEVEL_BLIP_SPRITE"
ns "HUD"
annotations [=[ {"cs_type":"BOOL"} ]=]
returns "int"
doc [[!
]]
native "GET_STREET_NAME_FROM_HASH_KEY"
hash "0xD0EF8A959B8A4CB9"
jhash (0x1E8E310C)
arguments {
Hash "hash" [=[ {} ]=],
}
ns "HUD"
returns "charPtr"
doc [[!
Converts the hash of a street name into a readable string. To retrieve a hash for a given (street) coordinate, see [`GET_STREET_NAME_AT_COORD`](#\_0x2EB41072B4C1E4C0).
]]
native "GET_WAYPOINT_BLIP_ENUM_ID"
hash "0x186E5D252FA50E7D"
jhash (0xB9827942)
alias "_GET_BLIP_INFO_ID_ITERATOR"
ns "HUD"
returns "int"
doc [[!
]]
native "GIVE_PED_TO_PAUSE_MENU"
hash "0xAC0BFBDC3BE00E14"
jhash (0x2AD2C9CE)
arguments {
Ped "ped" [=[ {} ]=],
int "p1" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
```
p1 is either 1 or 2 in the PC scripts.
```
This native is used to "give"/duplicate a player ped to a frontend menu as configured via the `ACTIVATE_FRONTEND_MENU` native, you first must utilize the [CLONE_PED](#\_0xEF29A16337FACADB) to clone said ped.
]]
native "HAS_ADDITIONAL_TEXT_LOADED"
hash "0x02245FE4BED318B8"
jhash (0xB0E56045)
arguments {
int "slot" [=[ {} ]=],
}
ns "HUD"
returns "BOOL"
doc [[!
]]
native "HAS_THIS_ADDITIONAL_TEXT_LOADED"
hash "0xADBF060E2B30C5BC"
jhash (0x80A52040)
arguments {
charPtr "gxt" [=[ {} ]=],
int "slot" [=[ {} ]=],
}
ns "HUD"
returns "BOOL"
doc [[!
```
Checks if the specified gxt has loaded into the passed slot.
```
]]
native "HIDE_HELP_TEXT_THIS_FRAME"
hash "0xD46923FC481CA285"
jhash (0xF3807BED)
ns "HUD"
returns "void"
doc [[!
]]
native "HIDE_HUD_AND_RADAR_THIS_FRAME"
hash "0x719FF505F097FD20"
jhash (0xB75D4AD2)
ns "HUD"
returns "void"
doc [[!
```
I think this works, but seems to prohibit switching to other weapons (or accessing the weapon wheel)
```
]]
native "HIDE_HUD_COMPONENT_THIS_FRAME"
hash "0x6806C51AD12B83B8"
jhash (0xDB2D0762)
arguments {
int "id" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
This function hides various HUD (Heads-up Display) components.
Listed below are the integers and the corresponding HUD component.
* 1 : WANTED_STARS
* 2 : WEAPON_ICON
* 3 : CASH
* 4 : MP_CASH
* 5 : MP_MESSAGE
* 6 : VEHICLE_NAME
* 7 : AREA_NAME
* 8 : VEHICLE_CLASS
* 9 : STREET_NAME
* 10 : HELP_TEXT
* 11 : FLOATING_HELP_TEXT\_1
* 12 : FLOATING_HELP_TEXT\_2
* 13 : CASH_CHANGE
* 14 : RETICLE
* 15 : SUBTITLE_TEXT
* 16 : RADIO_STATIONS
* 17 : SAVING_GAME
* 18 : GAME_STREAM
* 19 : WEAPON_WHEEL
* 20 : WEAPON_WHEEL_STATS
* 21 : HUD_COMPONENTS
* 22 : HUD_WEAPONS
These integers also work for the [`SHOW_HUD_COMPONENT_THIS_FRAME`](#\_0x0B4DF1FA60C0E664) native, but instead shows the HUD Component.
]]
native "HIDE_LOADING_ON_FADE_THIS_FRAME"
hash "0x4B0311D3CDC4648F"
jhash (0x35087963)
ns "HUD"
returns "void"
doc [[!
]]
native "HIDE_MINIMAP_EXTERIOR_MAP_THIS_FRAME"
hash "0x5FBAE526203990C9"
jhash (0x1A4318F7)
alias "_DISABLE_RADAR_THIS_FRAME"
ns "HUD"
returns "void"
doc [[!
]]
native "HIDE_MINIMAP_INTERIOR_MAP_THIS_FRAME"
hash "0x20FE7FDFEEAD38C0"
jhash (0xCE36E3FE)
alias "0x20FE7FDFEEAD38C0"
ns "HUD"
returns "void"
doc [[!
]]
native "HIDE_NUMBER_ON_BLIP"
hash "0x532CFF637EF80148"
jhash (0x0B6D610D)
arguments {
Blip "blip" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
]]
native "HIDE_SCRIPTED_HUD_COMPONENT_THIS_FRAME"
hash "0xE374C498D8BADC14"
jhash (0x31ABA127)
arguments {
int "id" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
]]
native "HUD_FORCE_WEAPON_WHEEL"
hash "0xEB354E5376BC81A7"
jhash (0x1EFFB02A)
arguments {
BOOL "show" [=[ {} ]=],
}
alias "0xEB354E5376BC81A7"
alias "_SHOW_WEAPON_WHEEL"
ns "HUD"
returns "void"
doc [[!
```
Forces the weapon wheel to show/hide.
```
]]
native "HUD_SET_WEAPON_WHEEL_TOP_SLOT"
hash "0x72C1056D678BB7D8"
jhash (0x83B608A0)
arguments {
Hash "weaponHash" [=[ {} ]=],
}
alias "0x72C1056D678BB7D8"
alias "_HUD_WEAPON_WHEEL_SET_SLOT_HASH"
ns "HUD"
returns "void"
doc [[!
```
Set the active slotIndex in the wheel weapon to the slot associated with the provided Weapon hash
```
]]
native "IS_BLIP_FLASHING"
hash "0xA5E41FD83AD6CEF0"
jhash (0x52E111D7)
arguments {
Blip "blip" [=[ {} ]=],
}
ns "HUD"
returns "BOOL"
doc [[!
]]
native "IS_BLIP_ON_MINIMAP"
hash "0xE41CA53051197A27"
jhash (0x258CBA3A)
arguments {
Blip "blip" [=[ {} ]=],
}
ns "HUD"
returns "BOOL"
doc [[!
]]
native "IS_BLIP_SHORT_RANGE"
hash "0xDA5F8727EB75B926"
jhash (0x1226765A)
arguments {
Blip "blip" [=[ {} ]=],
}
ns "HUD"
returns "BOOL"
doc [[!
]]
native "IS_FLOATING_HELP_TEXT_ON_SCREEN"
hash "0x2432784ACA090DA4"
jhash (0x45472FD5)
arguments {
int "hudIndex" [=[ {} ]=],
}
alias "0x2432784ACA090DA4"
ns "HUD"
returns "BOOL"
doc [[!
]]
native "IS_FRONTEND_READY_FOR_CONTROL"
hash "0x3BAB9A4E4F2FF5C7"
jhash (0xD3BF3ABD)
alias "0x3BAB9A4E4F2FF5C7"
ns "HUD"
returns "BOOL"
doc [[!
]]
native "IS_HELP_MESSAGE_BEING_DISPLAYED"
hash "0x4D79439A6B55AC67"
jhash (0xA65F262A)
ns "HUD"
returns "BOOL"
doc [[!
]]
native "IS_HELP_MESSAGE_FADING_OUT"
hash "0x327EDEEEAC55C369"
jhash (0x3E50AE92)
ns "HUD"
returns "BOOL"
doc [[!
]]
native "IS_HELP_MESSAGE_ON_SCREEN"
hash "0xDAD37F45428801AE"
jhash (0x4B3C9CA9)
ns "HUD"
returns "BOOL"
doc [[!
]]
native "IS_HOVERING_OVER_MISSION_CREATOR_BLIP"
hash "0x4167EFE0527D706E"
jhash (0xC5EB849A)
alias "0x4167EFE0527D706E"
ns "HUD"
returns "BOOL"
doc [[!
]]
native "IS_HUD_COMPONENT_ACTIVE"
hash "0xBC4C9EA5391ECC0D"
jhash (0x6214631F)
arguments {
int "id" [=[ {} ]=],
}
ns "HUD"
returns "BOOL"
doc [[!
```
Full list of components below
HUD = 0;
HUD_WANTED_STARS = 1;
HUD_WEAPON_ICON = 2;
HUD_CASH = 3;
HUD_MP_CASH = 4;
HUD_MP_MESSAGE = 5;
HUD_VEHICLE_NAME = 6;
HUD_AREA_NAME = 7;
HUD_VEHICLE_CLASS = 8;
HUD_STREET_NAME = 9;
HUD_HELP_TEXT = 10;
HUD_FLOATING_HELP_TEXT_1 = 11;
HUD_FLOATING_HELP_TEXT_2 = 12;
HUD_CASH_CHANGE = 13;
HUD_RETICLE = 14;
HUD_SUBTITLE_TEXT = 15;
HUD_RADIO_STATIONS = 16;
HUD_SAVING_GAME = 17;
HUD_GAME_STREAM = 18;
HUD_WEAPON_WHEEL = 19;
HUD_WEAPON_WHEEL_STATS = 20;
MAX_HUD_COMPONENTS = 21;
MAX_HUD_WEAPONS = 22;
MAX_SCRIPTED_HUD_COMPONENTS = 141;
```
]]
native "IS_HUD_HIDDEN"
hash "0xA86478C6958735C5"
jhash (0x40BADA1D)
ns "HUD"
returns "BOOL"
doc [[!
]]
native "IS_HUD_PREFERENCE_SWITCHED_ON"
hash "0x1930DFA731813EC4"
jhash (0xC3BC1B4F)
ns "HUD"
returns "BOOL"
doc [[!
]]
native "IS_MESSAGE_BEING_DISPLAYED"
hash "0x7984C03AA5CC2F41"
jhash (0x6A77FE8D)
ns "HUD"
returns "BOOL"
doc [[!
]]
native "IS_MINIMAP_RENDERING"
hash "0xAF754F20EB5CD51A"
jhash (0x9CD18314)
alias "0xAF754F20EB5CD51A"
alias "_IS_RADAR_ENABLED"
ns "HUD"
returns "BOOL"
doc [[!
]]
native "IS_MISSION_CREATOR_BLIP"
hash "0x26F49BF3381D933D"
jhash (0x24ACC4E9)
arguments {
Blip "blip" [=[ {} ]=],
}
ns "HUD"
returns "BOOL"
doc [[!
]]
native "IS_MOUSE_ROLLED_OVER_INSTRUCTIONAL_BUTTONS"
hash "0x3D9ACB1EB139E702"
alias "0x3D9ACB1EB139E702"
alias "_IS_MOUSE_CURSOR_ABOVE_INSTRUCTIONAL_BUTTONS"
ns "HUD"
annotations [=[ {"cs_type":"Any"} ]=]
returns "BOOL"
doc [[!
**Note:** The buttons need to support mouse (with the `TOGGLE_MOUSE_SUPPORT` scaleform movie method) for it to return `true`.
Returns `true` if the cursor is hovering above instructional buttons.
]]
native "IS_MP_GAMER_TAG_ACTIVE"
hash "0x4E929E7A5796FD26"
jhash (0x60118951)
arguments {
int "gamerTagId" [=[ {} ]=],
}
alias "0x4E929E7A5796FD26"
ns "HUD"
returns "BOOL"
doc [[!
]]
native "IS_MP_GAMER_TAG_FREE"
hash "0x595B5178E412E199"
jhash (0x63959059)
arguments {
int "gamerTagId" [=[ {} ]=],
}
alias "ADD_TREVOR_RANDOM_MODIFIER"
ns "HUD"
returns "BOOL"
doc [[!
]]
native "IS_MP_GAMER_TAG_MOVIE_ACTIVE"
hash "0x6E0EB3EB47C8D7AA"
jhash (0xEFD2564A)
alias "0x6E0EB3EB47C8D7AA"
alias "_HAS_MP_GAMER_TAG"
ns "HUD"
returns "BOOL"
doc [[!
]]
native "IS_NAMED_RENDERTARGET_LINKED"
hash "0x113750538FA31298"
jhash (0x8B52601F)
arguments {
Hash "modelHash" [=[ {} ]=],
}
ns "HUD"
returns "BOOL"
doc [[!
]]
native "IS_NAMED_RENDERTARGET_REGISTERED"
hash "0x78DCDC15C9F116B4"
jhash (0x284057F5)
arguments {
charPtr "name" [=[ {} ]=],
}
ns "HUD"
returns "BOOL"
doc [[!
]]
native "IS_NAVIGATING_MENU_CONTENT"
hash "0x4E3CD0EF8A489541"
jhash (0xDA7951A2)
alias "0x4E3CD0EF8A489541"
ns "HUD"
returns "Any"
doc [[!
]]
native "IS_ONLINE_POLICIES_MENU_ACTIVE"
hash "0x6F72CD94F7B5B68C"
jhash (0x9D4934F4)
alias "0x6F72CD94F7B5B68C"
ns "HUD"
returns "BOOL"
doc [[!
Returns the same as `IS_SOCIAL_CLUB_ACTIVE`.
]]
native "IS_PAUSE_MENU_ACTIVE"
hash "0xB0034A223497FFCB"
jhash (0xD3600591)
ns "HUD"
returns "BOOL"
doc [[!
]]
native "IS_PAUSE_MENU_RESTARTING"
hash "0x1C491717107431C7"
jhash (0x3C4CF4D9)
ns "HUD"
returns "BOOL"
doc [[!
]]
native "IS_PAUSEMAP_IN_INTERIOR_MODE"
hash "0x9049FE339D5F6F6F"
jhash (0x199DED14)
alias "0x9049FE339D5F6F6F"
alias "_IS_MINIMAP_IN_INTERIOR"
ns "HUD"
returns "BOOL"
doc [[!
]]
native "IS_RADAR_HIDDEN"
hash "0x157F93B036700462"
jhash (0x1AB3B954)
ns "HUD"
returns "BOOL"
doc [[!
]]
native "IS_RADAR_PREFERENCE_SWITCHED_ON"
hash "0x9EB6522EA68F22FE"
jhash (0x14AEAA28)
ns "HUD"
returns "BOOL"
doc [[!
]]
native "IS_REPORTUGC_MENU_OPEN"
hash "0x9135584D09A3437E"
jhash (0x9D2C94FA)
alias "0x9135584D09A3437E"
ns "HUD"
returns "BOOL"
doc [[!
]]
native "IS_SCRIPTED_HUD_COMPONENT_ACTIVE"
hash "0xDD100EB17A94FF65"
jhash (0x2B86F382)
arguments {
int "id" [=[ {} ]=],
}
ns "HUD"
returns "BOOL"
doc [[!
]]
native "IS_SCRIPTED_HUD_COMPONENT_HIDDEN_THIS_FRAME"
hash "0x09C0403ED9A751C2"
jhash (0xE8C8E535)
arguments {
int "id" [=[ {} ]=],
}
alias "0x09C0403ED9A751C2"
ns "HUD"
returns "BOOL"
doc [[!
]]
native "IS_SOCIAL_CLUB_ACTIVE"
hash "0xC406BE343FC4B9AF"
jhash (0xD4DA14EF)
alias "0xC406BE343FC4B9AF"
ns "HUD"
returns "BOOL"
doc [[!
]]
native "IS_STREAMING_ADDITIONAL_TEXT"
hash "0x8B6817B71B85EBF0"
jhash (0xF079E4EB)
arguments {
int "p0" [=[ {} ]=],
}
ns "HUD"
returns "BOOL"
doc [[!
]]
native "IS_SUBTITLE_PREFERENCE_SWITCHED_ON"
hash "0xAD6DACA4BA53E0A4"
jhash (0x63BA19F5)
ns "HUD"
returns "BOOL"
doc [[!
]]
native "IS_UPDATING_MP_GAMER_TAG_NAME_AND_CREW_DETAILS"
hash "0xEB709A36958ABE0D"
jhash (0xF11414C4)
arguments {
int "playerId" [=[ {} ]=],
}
alias "0xEB709A36958ABE0D"
alias "_HAS_MP_GAMER_TAG_2"
alias "_HAS_MP_GAMER_TAG_CREW_FLAGS_SET"
alias "_IS_VALID_MP_GAMER_TAG_MOVIE"
ns "HUD"
returns "BOOL"
doc [[!
When this native returns true, do not call [`SET_MP_GAMER_TAG_NAME`](#\_0xDEA2B8283BAA3944).
Local ID of the player.
Returns if game code is currently updating gamer tag and crew details for a player's name tag.
]]
native "IS_WARNING_MESSAGE_ACTIVE"
hash "0xE18B138FABC53103"
jhash (0x94C834AD)
alias "IS_MEDICAL_DISABLED"
ns "HUD"
returns "BOOL"
doc [[!
Returns true if a Warning Message or ReportUGC menu is active.
]]
native "IS_WAYPOINT_ACTIVE"
hash "0x1DD1F58F493F1DA5"
jhash (0x5E4DF47B)
ns "HUD"
returns "BOOL"
doc [[!
]]
native "LINK_NAMED_RENDERTARGET"
hash "0xF6C09E276AEB3F2D"
jhash (0x6844C4B9)
arguments {
Hash "modelHash" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
]]
native "LOCK_MINIMAP_ANGLE"
hash "0x299FAEBB108AE05B"
jhash (0xDEC733E4)
arguments {
int "angle" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
```
Locks the minimap to the specified angle in integer degrees.
angle: The angle in whole degrees. If less than 0 or greater than 360, unlocks the angle.
```
]]
native "LOCK_MINIMAP_POSITION"
hash "0x1279E861A329E73F"
jhash (0xB9632A91)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
```
Locks the minimap to the specified world position.
```
]]
native "OPEN_ONLINE_POLICIES_MENU"
hash "0x805D7CBB36FD6C4C"
jhash (0x19FCBBB2)
alias "_SHOW_SOCIAL_CLUB_LEGAL_SCREEN"
ns "HUD"
returns "void"
doc [[!
]]
native "OPEN_REPORTUGC_MENU"
hash "0x523A590C1A3CC0D3"
jhash (0x10DE5150)
alias "0x523A590C1A3CC0D3"
alias "_DISPLAY_JOB_REPORT"
ns "HUD"
returns "void"
doc [[!
```
Shows a menu for reporting UGC content.
```
]]
native "OPEN_SOCIAL_CLUB_MENU"
hash "0x75D3691713C3B05A"
jhash (0x57218529)
alias "0x75D3691713C3B05A"
ns "HUD"
returns "void"
doc [[!
Uses the `SOCIAL_CLUB2` scaleform.
]]
native "PAUSE_MENU_ACTIVATE_CONTEXT"
hash "0xDD564BDD0472C936"
jhash (0x9FE8FD5E)
arguments {
Hash "hash" [=[ {} ]=],
}
alias "0xDD564BDD0472C936"
alias "_ADD_FRONTEND_MENU_CONTEXT"
ns "HUD"
returns "void"
doc [[!
Activates the specified frontend menu context.
pausemenu.xml defines some specific menu options using 'context'. Context is basically a 'condition'.
The `*ALL*` part of the context means that whatever is being defined, will be active when any or all of those conditions after `*ALL*` are met.
The `*NONE*` part of the context section means that whatever is being defined, will NOT be active if any or all of the conditions after `*NONE*` are met.
This basically allows you to hide certain menu sections, or things like instructional buttons.
See the old description below for more info.
***
> Seems to add/set the current menu context (to show/hide buttons?)
> Pausemenu.xml:
> `*ALL*, DISPLAY_CORONA_BUTTONS, *NONE*, BET_LOCKED, BET_AVAILABLE, SCROLL_OPTION`
> Code:
>
> ```
> if (...) {
> sub_bbd34(a_0, 0, "FM_BET_HELP");
> UI::PAUSE_MENU_ACTIVATE_CONTEXT(${bet_available}); // This native
> UI::OBJECT_DECAL_TOGGLE(${bet_locked});
> } else {
> sub_bbd34(a_0, 0, "");
> UI::OBJECT_DECAL_TOGGLE(${bet_available});
> UI::PAUSE_MENU_ACTIVATE_CONTEXT(${bet_locked}); // This native
> }
> ```
>
> OBJECT_DECAL_TOGGLE seems to remove a context, It also has a hash collision
> // Old
> Scripts do not make this native's purpose clear. However, this native most likely has something to do with decals since in nearly every instance, "OBJECT_DECAL_TOGGLE" is called prior.
Context name hash.
]]
native "PAUSE_MENU_DEACTIVATE_CONTEXT"
hash "0x444D8CF241EC25C5"
jhash (0x0029046E)
arguments {
Hash "contextHash" [=[ {} ]=],
}
alias "OBJECT_DECAL_TOGGLE"
ns "HUD"
returns "void"
doc [[!
]]
native "PAUSE_MENU_IS_CONTEXT_ACTIVE"
hash "0x84698AB38D0C6636"
jhash (0xC51BC42F)
arguments {
Hash "contextHash" [=[ {} ]=],
}
alias "0x84698AB38D0C6636"
ns "HUD"
returns "BOOL"
doc [[!
]]
native "PAUSE_MENU_IS_CONTEXT_MENU_ACTIVE"
hash "0x2A25ADC48F87841F"
jhash (0x016D7AF9)
alias "0x2A25ADC48F87841F"
ns "HUD"
returns "Any"
doc [[!
]]
native "PAUSE_MENU_REDRAW_INSTRUCTIONAL_BUTTONS"
hash "0x4895BDEA16E7C080"
jhash (0x15B24768)
arguments {
int "p0" [=[ {"cs_type":"BOOL"} ]=],
}
alias "_ENABLE_DEATHBLOOD_SEETHROUGH"
alias "0x4895BDEA16E7C080"
ns "HUD"
returns "void"
doc [[!
Updates instructional buttons in Pause Menu after menu contexts have been toggled. p0 purpose is currently unknown, only 0 is used in scripts.
]]
native "PAUSE_MENU_SET_BUSY_SPINNER"
hash "0xC78E239AC5B2DDB9"
jhash (0x6C67131A)
arguments {
BOOL "bVisible" [=[ {} ]=],
int "iColumnID" [=[ {} ]=],
int "iSpinnerIndex" [=[ {} ]=],
}
alias "0xC78E239AC5B2DDB9"
ns "HUD"
returns "void"
doc [[!
Sets a loading icon in the pause menu.
Sets or removes this spinner.
Location of this spinner (0 - 17). Indexes can be found in `common:\data\ui\frontend.xml`, `PauseMenu\PersistentData\Spinner\Offsets`. If `bVisible` is `false`, this will be ignored.
Index of this spinner. Can have a maximum of three spinners at a time.
]]
native "PAUSE_MENU_SET_WARN_ON_TAB_CHANGE"
hash "0xF06EBB91A81E09E3"
jhash (0x11D09737)
arguments {
BOOL "setWarn" [=[ {} ]=],
}
alias "0xF06EBB91A81E09E3"
ns "HUD"
returns "void"
doc [[!
Shows this warning message when trying to switch pause menu header tabs: https://i.imgur.com/8qmfztu.png
Wether to show the message or not.
]]
native "PAUSE_MENUCEPTION_GO_DEEPER"
hash "0x77F16B447824DA6C"
jhash (0x0A89336C)
arguments {
int "pageId" [=[ {"cs_type":"Any"} ]=],
}
alias "0x77F16B447824DA6C"
ns "HUD"
returns "void"
doc [[!
Sets current pause menu page/component to the specified value.
Available page IDs: https://pastebin.com/qxuhwjPT
]]
native "PAUSE_MENUCEPTION_THE_KICK"
hash "0xCDCA26E80FAECB8F"
jhash (0xC84BE309)
alias "0xCDCA26E80FAECB8F"
ns "HUD"
returns "void"
doc [[!
Forces the Pause Menu to back out of unique pages such as Awards, Unlocks, Key Bindings etc
]]
native "PAUSE_TOGGLE_FULLSCREEN_MAP"
hash "0x2DE6C5E2E996F178"
arguments {
BOOL "enabled" [=[ {"cs_type":"Any"} ]=],
}
alias "0x2DE6C5E2E996F178"
ns "HUD"
returns "void"
doc [[!
Toggles pause menu map rendering.
]]
native "PRELOAD_BUSYSPINNER"
hash "0xC65AB383CD91DF98"
jhash (0x71077FBD)
alias "0xC65AB383CD91DF98"
ns "HUD"
returns "void"
doc [[!
]]
native "PULSE_BLIP"
hash "0x742D6FD43115AF73"
jhash (0x44253855)
arguments {
Blip "blip" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
]]
native "REFRESH_WAYPOINT"
hash "0x81FA173F170560D1"
jhash (0xB395D753)
ns "HUD"
returns "void"
doc [[!
]]
native "REGISTER_NAMED_RENDERTARGET"
hash "0x57D9C12635E25CE3"
jhash (0xFAE5D6F0)
arguments {
charPtr "name" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "HUD"
returns "BOOL"
doc [[!
]]
native "RELEASE_CONTROL_OF_FRONTEND"
hash "0x14621BB1DF14E2B2"
jhash (0xB9392CE7)
alias "0x14621BB1DF14E2B2"
ns "HUD"
returns "void"
doc [[!
Enables frontend (works in custom frontends, not sure about regular pause menu) navigation keys on keyboard if they were disabled using the native below.
To disable the keys, use [`0xEC9264727EEC0F28`](#\_0xEC9264727EEC0F28).
]]
native "RELEASE_NAMED_RENDERTARGET"
hash "0xE9F6FFE837354DD4"
jhash (0xD3F6C892)
arguments {
charPtr "name" [=[ {} ]=],
}
ns "HUD"
returns "BOOL"
doc [[!
]]
native "RELOAD_MAP_MENU"
hash "0x2916A928514C9827"
alias "0x2916A928514C9827"
ns "HUD"
returns "void"
doc [[!
Forces the map menu to reload.
]]
native "REMOVE_BLIP"
hash "0x86A652570E5F25DD"
jhash (0xD8C3C1CD)
arguments {
BlipPtr "blip" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
Removes the blip from your map.
**Note:** This function only works on the script that created the blip, if you wish to remove blips created by other scripts, see [`SET_THIS_SCRIPT_CAN_REMOVE_BLIPS_CREATED_BY_ANY_SCRIPT`](#\_0xB98236CAAECEF897).
Blip handle to remove.
]]
native "REMOVE_MP_GAMER_TAG"
hash "0x31698AA80E0223F8"
jhash (0x3D081FE4)
arguments {
int "gamerTagId" [=[ {} ]=],
}
alias "0x31698AA80E0223F8"
ns "HUD"
returns "void"
doc [[!
Removes the gamer tag associated with the provided ID. This does not happen instantly. Use [IS_MP_GAMER_TAG_FREE](#\_0x595B5178E412E199) to determine when the ID is free for reuse.
A player ID with a gamer tag or a fake gamer tag ID.
]]
native "REMOVE_MULTIPLAYER_BANK_CASH"
hash "0xC7C6789AA1CFEDD0"
jhash (0x728B4EF4)
ns "HUD"
returns "void"
doc [[!
]]
native "REMOVE_MULTIPLAYER_HUD_CASH"
hash "0x968F270E39141ECA"
jhash (0x07BF4A7D)
ns "HUD"
returns "void"
doc [[!
```
Removes multiplayer cash hud each frame
```
]]
native "REMOVE_MULTIPLAYER_WALLET_CASH"
hash "0x95CF81BD06EE1887"
jhash (0x7BFFE82F)
alias "0x95CF81BD06EE1887"
ns "HUD"
returns "void"
doc [[!
]]
native "REPLACE_HUD_COLOUR"
hash "0x1CCC708F0F850613"
jhash (0x3B216749)
arguments {
int "hudColorIndex" [=[ {} ]=],
int "hudColorIndex2" [=[ {} ]=],
}
alias "0x1CCC708F0F850613"
alias "_SET_HUD_COLOURS_SWITCH"
ns "HUD"
returns "void"
doc [[!
Changes the hud color at a given index (hudColorIndex) by another one (hudColorIndex2).
HUD colors can be found [here](https://docs.fivem.net/docs/game-references/hud-colors/)
]]
native "REPLACE_HUD_COLOUR_WITH_RGBA"
hash "0xF314CF4F0211894E"
jhash (0xF6E7E92B)
arguments {
int "hudColorIndex" [=[ {} ]=],
int "r" [=[ {} ]=],
int "g" [=[ {} ]=],
int "b" [=[ {} ]=],
int "a" [=[ {} ]=],
}
alias "0xF314CF4F0211894E"
alias "_SET_HUD_COLOUR"
ns "HUD"
returns "void"
doc [[!
Hud colors can be found [here](https://docs.fivem.net/docs/game-references/hud-colors/)
]]
native "REQUEST_ADDITIONAL_TEXT"
hash "0x71A78003C8E71424"
jhash (0x9FA9175B)
arguments {
charPtr "gxt" [=[ {} ]=],
int "slot" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
```
Request a gxt into the passed slot.
```
]]
native "REQUEST_ADDITIONAL_TEXT_FOR_DLC"
hash "0x6009F9F1AE90D8A6"
jhash (0xF4D27EBE)
arguments {
charPtr "gxt" [=[ {} ]=],
int "slot" [=[ {} ]=],
}
alias "_REQUEST_ADDITIONAL_TEXT_2"
ns "HUD"
returns "void"
doc [[!
]]
native "RESET_GLOBAL_ACTIONSCRIPT_FLAG"
hash "0xB99C4E4D9499DF29"
jhash (0x4C4C10CF)
arguments {
int "flagIndex" [=[ {} ]=],
}
alias "0xB99C4E4D9499DF29"
ns "HUD"
returns "void"
doc [[!
]]
native "RESET_HUD_COMPONENT_VALUES"
hash "0x450930E616475D0D"
jhash (0xD15B46DA)
arguments {
int "id" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
]]
native "RESET_RETICULE_VALUES"
hash "0x12782CE0A636E9F0"
jhash (0xBE27AA3F)
ns "HUD"
returns "void"
doc [[!
]]
native "RESTART_FRONTEND_MENU"
hash "0x10706DC6AD2D49C0"
jhash (0xB07DAF98)
arguments {
Hash "menuHash" [=[ {} ]=],
int "highlightedTab" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
Changes the current frontend menu to the desired frontend menu version.
Hash of the frontend menu. See [`ACTIVATE_FRONTEND_MENU`](#\_0xEF01D36B9C9D0C7B) for the list of available menus.
Menu ID (from PauseMenuLUT (in pause_menu_sp_content.gfx files), but the value - 1000) of which tab to have highlighted on the header, or -1.
]]
native "SET_ABILITY_BAR_VALUE"
hash "0x9969599CCFF5D85E"
jhash (0x24E53FD8)
arguments {
float "value" [=[ {} ]=],
float "maxValue" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
]]
native "SET_ALLOW_COMMA_ON_TEXT_INPUT"
hash "0x577599CCED639CA2"
arguments {
BOOL "allow" [=[ {"cs_type":"Any"} ]=],
}
alias "0x577599CCED639CA2"
ns "HUD"
returns "void"
doc [[!
**NOTE:** This must be called before you open the text input box.
Toggles if the comma can be used in conjuction with the `filename` text input box type.
]]
native "SET_BIGMAP_ACTIVE"
hash "0x231C8F89D0539D8F"
jhash (0x08EB83D2)
arguments {
BOOL "toggleBigMap" [=[ {} ]=],
BOOL "showFullMap" [=[ {} ]=],
}
alias "_SET_RADAR_BIGMAP_ENABLED"
ns "HUD"
returns "void"
doc [[!
Toggles the big minimap state like in GTA:Online.
To get the current state of the minimap, use [`IS_BIGMAP_ACTIVE`](#\_0xFFF65C63).
Enable or disable the expanded minimap.
Enable or disable the full map from being shown on the minimap, requires p0 to be true.
]]
native "SET_BLIP_ALPHA"
hash "0x45FF974EEE1C8734"
jhash (0xA791FCCD)
arguments {
Blip "blip" [=[ {} ]=],
int "alpha" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
```
Sets alpha-channel for blip color.
Example:
Blip blip = HUD::ADD_BLIP_FOR_ENTITY(entity);
HUD::SET_BLIP_COLOUR(blip , 3);
HUD::SET_BLIP_ALPHA(blip , 64);
```
]]
native "SET_BLIP_AS_FRIENDLY"
hash "0x6F6F290102C02AB4"
jhash (0xF290CFD8)
arguments {
Blip "blip" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
Allows the user to set a blip as friendly or enemy based on the toggle.
The blip handle
True for friendly, false for enemy
]]
native "SET_BLIP_AS_MISSION_CREATOR_BLIP"
hash "0x24AC0137444F9FD5"
jhash (0x802FB686)
arguments {
Blip "blip" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
]]
native "SET_BLIP_AS_SHORT_RANGE"
hash "0xBE8BE4FE60E27B72"
jhash (0x5C67725E)
arguments {
Blip "blip" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
Sets whether or not the specified blip should only be displayed when nearby, or on the minimap.
The blip handle.
True to only display the blip as 'short range', false to display the blip from a longer distance.
]]
native "SET_BLIP_BRIGHT"
hash "0xB203913733F27884"
jhash (0x72BEE6DF)
arguments {
Blip "blip" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
]]
native "SET_BLIP_CATEGORY"
hash "0x234CDD44D996FD9A"
jhash (0xEF72F533)
arguments {
Blip "blip" [=[ {} ]=],
int "index" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
Examples result:

**index:**
```
1 = No distance shown in legend
2 = Distance shown in legend
7 = "Other Players" category, also shows distance in legend
10 = "Property" category
11 = "Owned Property" category
12 - 133 = Custom named categories
134 - 254 = Custom unnamed categories
```
`index` wraps around after 255.
Blips with categories `7`, `10`, `11` or `12 - 254` (custom categories) will all show under the specific categories listing in the map legend, regardless of sprite or name.
**Legend entries**
| index | Legend entry | Label |
| --- | --- | --- |
| 7 | Other Players | `BLIP_OTHPLYR` |
| 10 | Property | `BLIP_PROPCAT` |
| 11 | Owned Property | `BLIP_APARTCAT` |
| 12 - 133 | Custom categories (Named) | `BLIP_CAT_` + `index` |
| 134 - 254 | Custom categories (Unnamed) | `-` |
The blip to change the category index of
The category index to change to
]]
native "SET_BLIP_COLOUR"
hash "0x03D7FB09E75D6B7E"
jhash (0xBB3C5A41)
arguments {
Blip "blip" [=[ {} ]=],
int "color" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
The blip handle to set the color of
This can be a hex color code, or a [blip color](https://docs.fivem.net/docs/game-references/blips/#blip-colors).
]]
native "SET_BLIP_COORDS"
hash "0xAE2AF67E9D9AF65D"
jhash (0x680A34D4)
arguments {
Blip "blip" [=[ {} ]=],
float "posX" [=[ {} ]=],
float "posY" [=[ {} ]=],
float "posZ" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
]]
native "SET_BLIP_DISPLAY"
hash "0x9029B2F3DA924928"
jhash (0x2B521F91)
arguments {
Blip "blip" [=[ {} ]=],
int "displayId" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
**displayId Behaviour**
| display ID | Behaviour |
|------------ |------------------------------------------------------------- |
| 0 | Doesn't show up, ever, anywhere. |
| 1 | Doesn't show up, ever, anywhere. |
| 2 | Shows on both main map and minimap. (Selectable on map) |
| 3 | Shows on main map only. (Selectable on map) |
| 4 | Shows on main map only. (Selectable on map) |
| 5 | Shows on minimap only. |
| 6 | Shows on both main map and minimap. (Selectable on map) |
| 7 | Doesn't show up, ever, anywhere. |
| 8 | Shows on both main map and minimap. (Not selectable on map) |
| 9 | Shows on minimap only. |
| 10 | Shows on both main map and minimap. (Not selectable on map) |
Anything higher than 10 seems to be exactly the same as 10.
Rockstar seem to only use 0, 2, 3, 4, 5 and 8 in the decompiled scripts.
]]
native "SET_BLIP_FADE"
hash "0x2AEE8F8390D2298C"
jhash (0xA5999031)
arguments {
Blip "blip" [=[ {} ]=],
int "opacity" [=[ {} ]=],
int "duration" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
]]
native "SET_BLIP_FLASH_INTERVAL"
hash "0xAA51DB313C010A7E"
jhash (0xEAF67377)
arguments {
Blip "blip" [=[ {} ]=],
int "interval" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
Sets the interval in milliseconds before flashing the blip.
The blip to change flashing interval
Interval in milliseconds before flashing the blip
]]
native "SET_BLIP_FLASH_TIMER"
hash "0xD3CD6FD297AE87CC"
jhash (0x8D5DF611)
arguments {
Blip "blip" [=[ {} ]=],
int "duration" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
Flashes blip for time in milliseconds before stopping.
The blip to start flashing
Time in milliseconds to flash the blip before stopping
]]
native "SET_BLIP_FLASHES"
hash "0xB14552383D39CE3E"
jhash (0xC0047F15)
arguments {
Blip "blip" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
]]
native "SET_BLIP_FLASHES_ALTERNATE"
hash "0x2E8D9498C56DD0D1"
jhash (0x1A81202B)
arguments {
Blip "blip" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
]]
native "SET_BLIP_HIDDEN_ON_LEGEND"
hash "0x54318C915D27E4CE"
jhash (0x43996428)
arguments {
Blip "blip" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x54318C915D27E4CE"
ns "HUD"
returns "void"
doc [[!
]]
native "SET_BLIP_HIGH_DETAIL"
hash "0xE2590BC29220CEBB"
jhash (0xD5842BFF)
arguments {
Blip "blip" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
]]
native "SET_BLIP_NAME_FROM_TEXT_FILE"
hash "0xEAA0FFE120D92784"
jhash (0xAC8A5461)
arguments {
Blip "blip" [=[ {} ]=],
charPtr "gxtEntry" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
```
Doesn't work if the label text of gxtEntry is >= 80.
```
]]
native "SET_BLIP_NAME_TO_PLAYER_NAME"
hash "0x127DE7B20C60A6A3"
jhash (0x03A0B8F9)
arguments {
Blip "blip" [=[ {} ]=],
Player "player" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
]]
native "SET_BLIP_PRIORITY"
hash "0xAE9FC9EF6A9FAC79"
jhash (0xCE87DA6F)
arguments {
Blip "blip" [=[ {} ]=],
int "priority" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
```
See this topic for more details : gtaforums.com/topic/717612-v-scriptnative-documentation-and-research/page-35?p=1069477935
```
]]
native "SET_BLIP_ROTATION"
hash "0xF87683CDF73C3F6E"
jhash (0x6B8F44FE)
arguments {
Blip "blip" [=[ {} ]=],
int "rotation" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
```
After some testing, looks like you need to use CEIL() on the rotation (vehicle/ped heading) before using it there.
```
]]
native "SET_BLIP_ROUTE"
hash "0x4F7D8A9BFB0B43E9"
jhash (0x3E160C90)
arguments {
Blip "blip" [=[ {} ]=],
BOOL "enabled" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
```
Enable / disable showing route for the Blip-object.
```
]]
native "SET_BLIP_ROUTE_COLOUR"
hash "0x837155CD2F63DA09"
jhash (0xDDE7C65C)
arguments {
Blip "blip" [=[ {} ]=],
int "colour" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
]]
native "SET_BLIP_SCALE"
hash "0xD38744167B2FA257"
jhash (0x1E6EC434)
arguments {
Blip "blip" [=[ {} ]=],
float "scale" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
]]
native "SET_BLIP_SECONDARY_COLOUR"
hash "0x14892474891E09EB"
jhash (0xC6384D32)
arguments {
Blip "blip" [=[ {} ]=],
int "r" [=[ {"cs_type":"float"} ]=],
int "g" [=[ {"cs_type":"float"} ]=],
int "b" [=[ {"cs_type":"float"} ]=],
}
ns "HUD"
returns "void"
doc [[!
]]
native "SET_BLIP_SHOW_CONE"
hash "0x13127EC3665E8EE1"
jhash (0xFF545AD8)
arguments {
Blip "blip" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
```
NativeDB Added Parameter 3: Any p2
```
]]
native "SET_BLIP_SPRITE"
hash "0xDF735600A4696DAF"
jhash (0x8DBBB0B9)
arguments {
Blip "blip" [=[ {} ]=],
int "spriteId" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
Sets the displayed sprite for a specific blip.
There's a [list of sprites](https://docs.fivem.net/game-references/blips/) on the FiveM documentation site.
The blip to change.
The sprite ID to set.
]]
native "SET_COLOUR_OF_NEXT_TEXT_COMPONENT"
hash "0x39BBF623FC803EAC"
jhash (0x6F1A1901)
arguments {
int "hudColor" [=[ {} ]=],
}
alias "0x39BBF623FC803EAC"
alias "_SET_NOTIFICATION_COLOR_NEXT"
ns "HUD"
returns "void"
doc [[!
]]
native "SET_CUSTOM_MP_HUD_COLOR"
hash "0x2ACCB195F3CCD9DE"
arguments {
int "hudColorId" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
Set a custom color for the MP HUD, providing a way to customize the HUD's appearance similar to character color changes in MP.
```cpp
enum eHudColours {
HUD_COLOUR_PURE_WHITE = 0,
HUD_COLOUR_WHITE = 1,
HUD_COLOUR_BLACK = 2,
HUD_COLOUR_GREY = 3,
HUD_COLOUR_GREYLIGHT = 4,
HUD_COLOUR_GREYDARK = 5,
HUD_COLOUR_RED = 6,
HUD_COLOUR_REDLIGHT = 7,
HUD_COLOUR_REDDARK = 8,
HUD_COLOUR_BLUE = 9,
HUD_COLOUR_BLUELIGHT = 10,
HUD_COLOUR_BLUEDARK = 11,
HUD_COLOUR_YELLOW = 12,
HUD_COLOUR_YELLOWLIGHT = 13,
HUD_COLOUR_YELLOWDARK = 14,
HUD_COLOUR_ORANGE = 15,
HUD_COLOUR_ORANGELIGHT = 16,
HUD_COLOUR_ORANGEDARK = 17,
HUD_COLOUR_GREEN = 18,
HUD_COLOUR_GREENLIGHT = 19,
HUD_COLOUR_GREENDARK = 20,
HUD_COLOUR_PURPLE = 21,
HUD_COLOUR_PURPLELIGHT = 22,
HUD_COLOUR_PURPLEDARK = 23,
HUD_COLOUR_PINK = 24,
HUD_COLOUR_STAR = 25,
HUD_COLOUR_STARLIGHT = 26,
HUD_COLOUR_STARDARK = 27,
HUD_COLOUR_NET_PLAYER1 = 28,
HUD_COLOUR_NET_PLAYER2 = 29,
HUD_COLOUR_NET_PLAYER3 = 30,
HUD_COLOUR_NET_PLAYER4 = 31,
HUD_COLOUR_NET_PLAYER5 = 32,
HUD_COLOUR_NET_PLAYER6 = 33,
HUD_COLOUR_NET_PLAYER7 = 34,
HUD_COLOUR_NET_PLAYER8 = 35,
HUD_COLOUR_NET_PLAYER9 = 36,
HUD_COLOUR_NET_PLAYER10 = 37,
HUD_COLOUR_NET_PLAYER11 = 38,
HUD_COLOUR_NET_PLAYER12 = 39,
HUD_COLOUR_NET_PLAYER13 = 40,
HUD_COLOUR_NET_PLAYER14 = 41,
HUD_COLOUR_NET_PLAYER15 = 42,
HUD_COLOUR_NET_PLAYER16 = 43,
HUD_COLOUR_NET_PLAYER17 = 44,
HUD_COLOUR_NET_PLAYER18 = 45,
HUD_COLOUR_NET_PLAYER19 = 46,
HUD_COLOUR_NET_PLAYER20 = 47,
HUD_COLOUR_NET_PLAYER21 = 48,
HUD_COLOUR_NET_PLAYER22 = 49,
HUD_COLOUR_NET_PLAYER23 = 50,
HUD_COLOUR_NET_PLAYER24 = 51,
HUD_COLOUR_NET_PLAYER25 = 52,
HUD_COLOUR_NET_PLAYER26 = 53,
HUD_COLOUR_NET_PLAYER27 = 54,
HUD_COLOUR_NET_PLAYER28 = 55,
HUD_COLOUR_NET_PLAYER29 = 56,
HUD_COLOUR_NET_PLAYER30 = 57,
HUD_COLOUR_NET_PLAYER31 = 58,
HUD_COLOUR_NET_PLAYER32 = 59,
HUD_COLOUR_SIMPLEBLIP_DEFAULT = 60,
HUD_COLOUR_MENU_BLUE = 61,
HUD_COLOUR_MENU_GREY_LIGHT = 62,
HUD_COLOUR_MENU_BLUE_EXTRA_DARK = 63,
HUD_COLOUR_MENU_YELLOW = 64,
HUD_COLOUR_MENU_YELLOW_DARK = 65,
HUD_COLOUR_MENU_GREEN = 66,
HUD_COLOUR_MENU_GREY = 67,
HUD_COLOUR_MENU_GREY_DARK = 68,
HUD_COLOUR_MENU_HIGHLIGHT = 69,
HUD_COLOUR_MENU_STANDARD = 70,
HUD_COLOUR_MENU_DIMMED = 71,
HUD_COLOUR_MENU_EXTRA_DIMMED = 72,
HUD_COLOUR_BRIEF_TITLE = 73,
HUD_COLOUR_MID_GREY_MP = 74,
HUD_COLOUR_NET_PLAYER1_DARK = 75,
HUD_COLOUR_NET_PLAYER2_DARK = 76,
HUD_COLOUR_NET_PLAYER3_DARK = 77,
HUD_COLOUR_NET_PLAYER4_DARK = 78,
HUD_COLOUR_NET_PLAYER5_DARK = 79,
HUD_COLOUR_NET_PLAYER6_DARK = 80,
HUD_COLOUR_NET_PLAYER7_DARK = 81,
HUD_COLOUR_NET_PLAYER8_DARK = 82,
HUD_COLOUR_NET_PLAYER9_DARK = 83,
HUD_COLOUR_NET_PLAYER10_DARK = 84,
HUD_COLOUR_NET_PLAYER11_DARK = 85,
HUD_COLOUR_NET_PLAYER12_DARK = 86,
HUD_COLOUR_NET_PLAYER13_DARK = 87,
HUD_COLOUR_NET_PLAYER14_DARK = 88,
HUD_COLOUR_NET_PLAYER15_DARK = 89,
HUD_COLOUR_NET_PLAYER16_DARK = 90,
HUD_COLOUR_NET_PLAYER17_DARK = 91,
HUD_COLOUR_NET_PLAYER18_DARK = 92,
HUD_COLOUR_NET_PLAYER19_DARK = 93,
HUD_COLOUR_NET_PLAYER20_DARK = 94,
HUD_COLOUR_NET_PLAYER21_DARK = 95,
HUD_COLOUR_NET_PLAYER22_DARK = 96,
HUD_COLOUR_NET_PLAYER23_DARK = 97,
HUD_COLOUR_NET_PLAYER24_DARK = 98,
HUD_COLOUR_NET_PLAYER25_DARK = 99,
HUD_COLOUR_NET_PLAYER26_DARK = 100,
HUD_COLOUR_NET_PLAYER27_DARK = 101,
HUD_COLOUR_NET_PLAYER28_DARK = 102,
HUD_COLOUR_NET_PLAYER29_DARK = 103,
HUD_COLOUR_NET_PLAYER30_DARK = 104,
HUD_COLOUR_NET_PLAYER31_DARK = 105,
HUD_COLOUR_NET_PLAYER32_DARK = 106,
HUD_COLOUR_BRONZE = 107,
HUD_COLOUR_SILVER = 108,
HUD_COLOUR_GOLD = 109,
HUD_COLOUR_PLATINUM = 110,
HUD_COLOUR_GANG1 = 111,
HUD_COLOUR_GANG2 = 112,
HUD_COLOUR_GANG3 = 113,
HUD_COLOUR_GANG4 = 114,
HUD_COLOUR_SAME_CREW = 115,
HUD_COLOUR_FREEMODE = 116,
HUD_COLOUR_PAUSE_BG = 117,
HUD_COLOUR_FRIENDLY = 118,
HUD_COLOUR_ENEMY = 119,
HUD_COLOUR_LOCATION = 120,
HUD_COLOUR_PICKUP = 121,
HUD_COLOUR_PAUSE_SINGLEPLAYER = 122,
HUD_COLOUR_FREEMODE_DARK = 123,
HUD_COLOUR_INACTIVE_MISSION = 124,
HUD_COLOUR_DAMAGE = 125,
HUD_COLOUR_PINKLIGHT = 126,
HUD_COLOUR_PM_MITEM_HIGHLIGHT = 127,
HUD_COLOUR_SCRIPT_VARIABLE = 128,
HUD_COLOUR_YOGA = 129,
HUD_COLOUR_TENNIS = 130,
HUD_COLOUR_GOLF = 131,
HUD_COLOUR_SHOOTING_RANGE = 132,
HUD_COLOUR_FLIGHT_SCHOOL = 133,
HUD_COLOUR_NORTH_BLUE = 134,
HUD_COLOUR_SOCIAL_CLUB = 135,
HUD_COLOUR_PLATFORM_BLUE = 136,
HUD_COLOUR_PLATFORM_GREEN = 137,
HUD_COLOUR_PLATFORM_GREY = 138,
HUD_COLOUR_FACEBOOK_BLUE = 139,
HUD_COLOUR_INGAME_BG = 140,
HUD_COLOUR_DARTS = 141,
HUD_COLOUR_WAYPOINT = 142,
HUD_COLOUR_MICHAEL = 143,
HUD_COLOUR_FRANKLIN = 144,
HUD_COLOUR_TREVOR = 145,
HUD_COLOUR_GOLF_P1 = 146,
HUD_COLOUR_GOLF_P2 = 147,
HUD_COLOUR_GOLF_P3 = 148,
HUD_COLOUR_GOLF_P4 = 149,
HUD_COLOUR_WAYPOINTLIGHT = 150,
HUD_COLOUR_WAYPOINTDARK = 151,
HUD_COLOUR_PANEL_LIGHT = 152,
HUD_COLOUR_MICHAEL_DARK = 153,
HUD_COLOUR_FRANKLIN_DARK = 154,
HUD_COLOUR_TREVOR_DARK = 155,
HUD_COLOUR_OBJECTIVE_ROUTE = 156,
HUD_COLOUR_PAUSEMAP_TINT = 157,
HUD_COLOUR_PAUSE_DESELECT = 158,
HUD_COLOUR_PM_WEAPONS_PURCHASABLE = 159,
HUD_COLOUR_PM_WEAPONS_LOCKED = 160,
HUD_COLOUR_END_SCREEN_BG = 161,
HUD_COLOUR_CHOP = 162,
HUD_COLOUR_PAUSEMAP_TINT_HALF = 163,
HUD_COLOUR_NORTH_BLUE_OFFICIAL = 164,
HUD_COLOUR_SCRIPT_VARIABLE_2 = 165,
HUD_COLOUR_H = 166,
HUD_COLOUR_HDARK = 167,
HUD_COLOUR_T = 168,
HUD_COLOUR_TDARK = 169,
HUD_COLOUR_HSHARD = 170,
HUD_COLOUR_CONTROLLER_MICHAEL = 171
HUD_COLOUR_CONTROLLER_FRANKLIN = 172
HUD_COLOUR_CONTROLLER_TREVOR = 173
HUD_COLOUR_CONTROLLER_CHOP = 174,
HUD_COLOUR_VIDEO_EDITOR_VIDEO = 175,
HUD_COLOUR_VIDEO_EDITOR_AUDIO = 176,
HUD_COLOUR_VIDEO_EDITOR_TEXT = 177,
HUD_COLOUR_HB_BLUE = 178,
HUD_COLOUR_HB_YELLOW = 179,
HUD_COLOUR_VIDEO_EDITOR_SCORE = 180,
HUD_COLOUR_VIDEO_EDITOR_AUDIO_FADEOUT = 181,
HUD_COLOUR_VIDEO_EDITOR_TEXT_FADEOUT = 182,
HUD_COLOUR_VIDEO_EDITOR_SCORE_FADEOUT = 183,
HUD_COLOUR_HEIST_BACKGROUND = 184,
HUD_COLOUR_VIDEO_EDITOR_AMBIENT = 185,
HUD_COLOUR_VIDEO_EDITOR_AMBIENT_FADEOUT = 186,
HUD_COLOUR_GANG_BOSS = 187,
HUD_COLOUR_GOON = 188,
HUD_COLOUR_BOSS = 189,
HUD_COLOUR_LOW_FLOW = 190,
HUD_COLOUR_LOW_FLOW_DARK = 191,
HUD_COLOUR_G1 = 192,
HUD_COLOUR_G2 = 193,
HUD_COLOUR_G3 = 194,
HUD_COLOUR_G4 = 195,
HUD_COLOUR_G5 = 196,
HUD_COLOUR_G6 = 197,
HUD_COLOUR_G7 = 198,
HUD_COLOUR_G8 = 199,
HUD_COLOUR_G9 = 200,
HUD_COLOUR_G10 = 201,
HUD_COLOUR_G11 = 202,
HUD_COLOUR_G12 = 203,
HUD_COLOUR_G13 = 204,
HUD_COLOUR_G14 = 205,
HUD_COLOUR_G15 = 206,
HUD_COLOUR_ADVERSARY = 207,
HUD_COLOUR_DEGEN_RED = 208,
HUD_COLOUR_DEGEN_YELLOW = 209,
HUD_COLOUR_DEGEN_GREEN = 210,
HUD_COLOUR_DEGEN_CYAN = 211,
HUD_COLOUR_DEGEN_BLUE = 212,
HUD_COLOUR_DEGEN_MAGENTA = 213,
HUD_COLOUR_STUNT_1 = 214,
HUD_COLOUR_STUNT_2 = 215,
HUD_COLOUR_SPECIAL_RACE_SERIES = 216
HUD_COLOUR_SPECIAL_RACE_SERIES_DARK = 217,
HUD_COLOUR_CS = 218
HUD_COLOUR_CS_DARK = 219,
HUD_COLOUR_TECH_GREEN = 220,
HUD_COLOUR_TECH_GREEN_DARK = 221,
HUD_COLOUR_TECH_RED = 222,
HUD_COLOUR_TECH_GREEN_VERY_DARK = 223,
HUD_COLOUR_PLACEHOLDER_01 = 224,
HUD_COLOUR_PLACEHOLDER_02 = 225,
HUD_COLOUR_PLACEHOLDER_03 = 226,
HUD_COLOUR_PLACEHOLDER_04 = 227,
HUD_COLOUR_PLACEHOLDER_05 = 228,
HUD_COLOUR_PLACEHOLDER_06 = 229,
HUD_COLOUR_PLACEHOLDER_07 = 230,
HUD_COLOUR_PLACEHOLDER_08 = 231,
HUD_COLOUR_PLACEHOLDER_09 = 232,
HUD_COLOUR_PLACEHOLDER_10 = 233,
HUD_COLOUR_JUNK_ENERGY = 234
};
```
```
NativeDB Introduced: 2545
```
The ID of the custom HUD color. Use -1 (`HUD_COLOUR_INVALID`) to clear the custom color. Refer to the `eHudColours` enum for valid color IDs.
]]
native "SET_FAKE_PAUSEMAP_PLAYER_POSITION_THIS_FRAME"
hash "0x77E2DD177910E1CF"
jhash (0x54E75C7D)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
}
alias "0x77E2DD177910E1CF"
alias "_SET_PLAYER_BLIP_POSITION_THIS_FRAME"
ns "HUD"
returns "void"
doc [[!
Overrides the position of the main player blip for the current frame.
X coord of the position.
Y coord of the position.
]]
native "SET_FLOATING_HELP_TEXT_SCREEN_POSITION"
hash "0x7679CC1BCEBE3D4C"
jhash (0x198F32D7)
arguments {
int "hudIndex" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
}
alias "0x7679CC1BCEBE3D4C"
ns "HUD"
returns "void"
doc [[!
]]
native "SET_FLOATING_HELP_TEXT_STYLE"
hash "0x788E7FD431BD67F1"
jhash (0x97852A82)
arguments {
int "hudIndex" [=[ {} ]=],
int "style" [=[ {} ]=],
int "hudColor" [=[ {} ]=],
int "alpha" [=[ {} ]=],
int "arrowPosition" [=[ {} ]=],
int "boxOffset" [=[ {} ]=],
}
alias "0x788E7FD431BD67F1"
ns "HUD"
returns "void"
doc [[!
### Arrow Positions
* 0 = Off / No arrow
* 1 = Top
* 2 = Left
* 3 = Bottom
* 4 = Right
### Note
Any numeric value greater than 4 will result in a right arrow (Index 4)
### Important
Needs to be called every frame

The hud index for the floating help message
Value 0 won't show an arrow at all. Values 1, 2 and -2 will display an arrow.
https://docs.fivem.net/docs/game-references/hud-colors/
Value for the help box opacity, from 0-255. Anything greater will simply ignore the alpha value. Always 191 in R\* scripts.
Used to set the arrow positon. No value will hide the arrow
Offset for the floating help box. Note: Arrow stays fixed
]]
native "SET_FLOATING_HELP_TEXT_TO_ENTITY"
hash "0xB094BC1DB4018240"
jhash (0x18B012B7)
arguments {
int "hudIndex" [=[ {} ]=],
Entity "entity" [=[ {} ]=],
float "offsetX" [=[ {} ]=],
float "offsetY" [=[ {} ]=],
}
alias "0xB094BC1DB4018240"
ns "HUD"
returns "void"
doc [[!
]]
native "SET_FLOATING_HELP_TEXT_WORLD_POSITION"
hash "0x784BA7E0ECEB4178"
jhash (0x93045157)
arguments {
int "hudIndex" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
alias "0x784BA7E0ECEB4178"
ns "HUD"
returns "void"
doc [[!
]]
native "SET_FRONTEND_ACTIVE"
hash "0x745711A75AB09277"
jhash (0x81E1AD32)
arguments {
BOOL "active" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
]]
native "SET_GPS_CUSTOM_ROUTE_RENDER"
hash "0x900086F371220B6F"
jhash (0xDA0AF00E)
arguments {
BOOL "toggle" [=[ {} ]=],
int "radarThickness" [=[ {} ]=],
int "mapThickness" [=[ {} ]=],
}
alias "0x900086F371220B6F"
ns "HUD"
returns "void"
doc [[!
The width of the GPS route on the radar
The width of the GPS route on the map
]]
native "SET_GPS_FLAGS"
hash "0x5B440763A4C8D15B"
jhash (0x60539BAB)
arguments {
int "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
```
Only the script that originally called SET_GPS_FLAGS can set them again. Another script cannot set the flags, until the first script that called it has called CLEAR_GPS_FLAGS.
Doesn't seem like the flags are actually read by the game at all.
```
]]
native "SET_GPS_FLASHES"
hash "0x320D0E0D936A0E9B"
jhash (0xE991F733)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
]]
native "SET_GPS_MULTI_ROUTE_RENDER"
hash "0x3DDA37128DD1ACA8"
jhash (0xE87CBE4C)
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0x3DDA37128DD1ACA8"
ns "HUD"
returns "void"
doc [[!
]]
native "SET_HEALTH_HUD_DISPLAY_VALUES"
hash "0x3F5CC444DCAAA8F2"
jhash (0x7FB6FB2A)
arguments {
int "health" [=[ {} ]=],
int "capacity" [=[ {} ]=],
BOOL "wasAdded" [=[ {} ]=],
}
alias "0x3F5CC444DCAAA8F2"
ns "HUD"
returns "void"
doc [[!
]]
native "SET_HUD_COMPONENT_POSITION"
hash "0xAABB1F56E2A17CED"
jhash (0x2F3A0D15)
arguments {
int "id" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
]]
native "SET_MAX_ARMOUR_HUD_DISPLAY"
hash "0x06A320535F5F0248"
jhash (0x827F14DE)
arguments {
int "maximumValue" [=[ {} ]=],
}
alias "0x06A320535F5F0248"
ns "HUD"
returns "void"
doc [[!
]]
native "SET_MAX_HEALTH_HUD_DISPLAY"
hash "0x975D66A0BC17064C"
jhash (0xF07D8CEF)
arguments {
int "maximumValue" [=[ {} ]=],
}
alias "0x975D66A0BC17064C"
ns "HUD"
returns "void"
doc [[!
]]
native "SET_MINIMAP_BLOCK_WAYPOINT"
hash "0x58FADDED207897DC"
jhash (0xA41C3B62)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
]]
native "SET_MINIMAP_COMPONENT"
hash "0x75A9A10948D1DEA6"
jhash (0x419DCDC4)
arguments {
int "componentID" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
int "hudColor" [=[ {} ]=],
}
ns "HUD"
returns "int"
doc [[!
This native is used to colorize/toggle certain map components like the army base.
Component IDs 6 through 14 are used by the freemode event King of the Castle in GTA Online.
### An incomplete list of component IDs:
* **0**: Los Santos International Airport yellow runway markers
* **1**: Sandy Shores Airfield yellow runway markers
* **2**: McKenzie Field yellow runway markers
* **6**: Vespucci Beach lifeguard building
* **7**: Top level zone of Alien Camp (Hippy Camp)
* **8**: Paleto Bay fire station drill tower
* **9** Land Act Dam tower
* **10** Pala Springs Aerial Tramway
* **11** Galileo Observatory power unit
* **12** Small zone (empty "interior") near Central Los Santos Medical Center
* **13** Richman Mansion grotto
* **14** 2 Alien Camp (Hippy Camp) circles
* **15** Fort Zancudo
The component ID to change.
True to enable/colorize, false to disable.
The hudcolor index, the list of hud colors can be found [here](https://docs.fivem.net/docs/game-references/hud-colors/).
Hardcoded to always return 1 (int)
]]
native "SET_MINIMAP_FOW_REVEAL_COORDINATE"
hash "0x0923DBF87DFF735E"
jhash (0xE010F081)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
alias "0x0923DBF87DFF735E"
ns "HUD"
returns "void"
doc [[!
]]
native "SET_MINIMAP_GOLF_COURSE"
hash "0x71BDB63DBAF8DA59"
jhash (0x5133A750)
arguments {
int "hole" [=[ {} ]=],
}
alias "0x71BDB63DBAF8DA59"
ns "HUD"
returns "void"
doc [[!
Not much is known so far on what it does *exactly*.
All I know for sure is that it draws the specified hole ID on the pause menu map as well as on the mini-map/radar. This native also seems to change some other things related to the pause menu map's behaviour, for example: you can no longer set waypoints, the pause menu map starts up in a 'zoomed in' state. This native does not need to be executed every tick.
You need to center the minimap manually as well as change/lock it's zoom and angle in order for it to appear correctly on the minimap.
You'll also need to use the `GOLF` scaleform in order to get the correct minmap border to show up.
Use [`SET_MINIMAP_GOLF_COURSE_OFF()`](#\_0x35EDD5B2E3FF01C0) to reset the map when you no longer want to display any golf holes (you still need to unlock zoom, position and angle of the radar manually after calling this).
The ID of the hole to draw on the map. ID starts with 1 for hole 1, 2 for hole 2, etc. 0 disables the golf map behaviour.
]]
native "SET_MINIMAP_GOLF_COURSE_OFF"
hash "0x35EDD5B2E3FF01C0"
jhash (0x20FD3E87)
alias "0x35EDD5B2E3FF01C0"
ns "HUD"
returns "void"
doc [[!
]]
native "SET_MINIMAP_HIDE_FOW"
hash "0xF8DEE0A5600CBB93"
jhash (0xD8D77733)
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0xF8DEE0A5600CBB93"
alias "_SET_MINIMAP_REVEALED"
ns "HUD"
returns "void"
doc [[!
```
If true, the entire map will be revealed.
```
]]
native "SET_MINIMAP_IN_PROLOGUE"
hash "0x9133955F1A2DA957"
jhash (0x02F5F1D1)
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "_SET_DRAW_MAP_VISIBLE"
alias "_SET_NORTH_YANKTON_MAP"
ns "HUD"
returns "void"
doc [[!
```
Toggles the North Yankton map
```
]]
native "SET_MINIMAP_IN_SPECTATOR_MODE"
hash "0x1A5CD7752DD28CD3"
jhash (0xD5BFCADB)
arguments {
BOOL "toggle" [=[ {} ]=],
Ped "ped" [=[ {} ]=],
}
alias "KEY_HUD_COLOUR"
ns "HUD"
returns "void"
doc [[!
]]
native "SET_MINIMAP_SONAR_SWEEP"
hash "0x6B50FC8749632EC1"
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "_SET_MINIMAP_SONAR_ENABLED"
ns "HUD"
returns "void"
doc [[!
Enables or disables the sonar sweep animation on the minimap.
```
NativeDB Introduced: v2189
```
A boolean value where `true` activates the sonar sweep animation on the minimap, and `false` turns it off.
This native does not return any value.
]]
native "SET_MISSION_NAME"
hash "0x5F28ECF5FC84772F"
jhash (0x68DCAE10)
arguments {
BOOL "p0" [=[ {} ]=],
charPtr "name" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
]]
native "SET_MOUSE_CURSOR_STYLE"
hash "0x8DB8CFFD58B62552"
arguments {
int "style" [=[ {} ]=],
}
alias "0x8DB8CFFD58B62552"
alias "_SET_CURSOR_SPRITE"
alias "_SET_MOUSE_CURSOR_SPRITE"
ns "HUD"
returns "void"
doc [[!
Changes the mouse style.
```cpp
enum eMousePointerStyle {
ARROW = 1,
ARROW_DIMMED = 2,
HAND_OPEN = 3,
HAND_GRAB = 4,
HAND_MIDDLE_FINGER = 5,
ARROW_LEFT = 6,
ARROW_RIGHT = 7,
ARROW_UP = 8,
ARROW_DOWN = 9,
ARROW_TRIMMING = 10,
ARROW_PLUS = 11,
ARROW_MINUS = 12
};
```
Which sprite to change to, see declared enum `eMousePointerStyle`.
]]
native "SET_MOUSE_CURSOR_THIS_FRAME"
hash "0xAAE7CE1D63167423"
alias "_SHOW_CURSOR_THIS_FRAME"
alias "_SET_MOUSE_CURSOR_ACTIVE_THIS_FRAME"
ns "HUD"
returns "void"
doc [[!
Sets the mouse pointer to be active on current frame.
]]
native "SET_MOUSE_CURSOR_VISIBLE"
hash "0x98215325A695E78A"
arguments {
BOOL "isVisible" [=[ {} ]=],
}
alias "0x98215325A695E78A"
alias "_SET_MOUSE_CURSOR_VISIBLE_IN_MENUS"
ns "HUD"
returns "void"
doc [[!
Toggles the visibility of the cursor. Do note that if the game loses focus and then regains it, the cursor will become visible again.
If the mouse cursor is visible
]]
native "SET_MP_GAMER_TAG_ALPHA"
hash "0xD48FE545CD46F857"
jhash (0xF4418611)
arguments {
int "gamerTagId" [=[ {} ]=],
int "component" [=[ {} ]=],
int "alpha" [=[ {} ]=],
}
alias "0xD48FE545CD46F857"
ns "HUD"
returns "void"
doc [[!
```
Sets flag's sprite transparency. 0-255.
```
]]
native "SET_MP_GAMER_TAG_BIG_TEXT"
hash "0x7B7723747CCB55B6"
jhash (0x939218AB)
arguments {
int "gamerTagId" [=[ {} ]=],
charPtr "string" [=[ {} ]=],
}
alias "0x7B7723747CCB55B6"
alias "_SET_MP_GAMER_TAG_CHATTING"
ns "HUD"
returns "void"
doc [[!
]]
native "SET_MP_GAMER_TAG_COLOUR"
hash "0x613ED644950626AE"
jhash (0x7E3AA40A)
arguments {
int "gamerTagId" [=[ {} ]=],
int "component" [=[ {} ]=],
int "hudColorIndex" [=[ {} ]=],
}
alias "0x613ED644950626AE"
ns "HUD"
returns "void"
doc [[!
Sets a gamer tag's component colour
a gamerTagId obtained using for example: [`CREATE_FAKE_MP_GAMER_TAG`](#\_0xBFEFE3321A3F5015).
a component id, see the full list here: [link](https://docs.fivem.net/docs/game-references/gamer-tags/#components-list)
a hud color index, see the full list here: [link](https://docs.fivem.net/docs/game-references/hud-colors/)
]]
native "SET_MP_GAMER_TAG_HEALTH_BAR_COLOUR"
hash "0x3158C77A7E888AB4"
jhash (0x5777EC77)
arguments {
int "gamerTagId" [=[ {} ]=],
int "hudColorIndex" [=[ {} ]=],
}
alias "0x3158C77A7E888AB4"
alias "_SET_MP_GAMER_TAG_HEALTH_BAR_COLOR"
ns "HUD"
returns "void"
doc [[!
Should be enabled as component (2). Has 0 alpha by default.
a gamerTagId obtained using for example: [CREATE_FAKE_MP_GAMER_TAG](#\_0xBFEFE3321A3F5015)
a hud color index, see the full list here: [link](https://docs.fivem.net/docs/game-references/hud-colors/)
]]
native "SET_MP_GAMER_TAG_NAME"
hash "0xDEA2B8283BAA3944"
jhash (0x627A559B)
arguments {
int "gamerTagId" [=[ {} ]=],
charPtr "string" [=[ {} ]=],
}
alias "0xDEA2B8283BAA3944"
ns "HUD"
returns "void"
doc [[!
]]
native "SET_MP_GAMER_TAG_VISIBILITY"
hash "0x63BB75ABEDC1F6A0"
jhash (0xD41DF479)
arguments {
int "gamerTagId" [=[ {} ]=],
int "component" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x63BB75ABEDC1F6A0"
ns "HUD"
returns "void"
doc [[!
```cpp
enum eMpGamerTagComponent
{
MP_TAG_GAMER_NAME = 0,
MP_TAG_CREW_TAG = 1,
MP_TAG_HEALTH_ARMOUR = 2,
MP_TAG_BIG_TEXT = 3,
MP_TAG_AUDIO_ICON = 4,
MP_TAG_USING_MENU = 5,
MP_TAG_PASSIVE_MODE = 6,
MP_TAG_WANTED_STARS = 7,
MP_TAG_DRIVER = 8,
MP_TAG_CO_DRIVER = 9,
MP_TAG_TAGGED = 10,
MP_TAG_GAMER_NAME_NEARBY = 11,
MP_TAG_ARROW = 12,
MP_TAG_PACKAGES = 13,
MP_TAG_INV_IF_PED_FOLLOWING = 14,
MP_TAG_RANK_TEXT = 15,
MP_TAG_TYPING = 16,
MP_TAG_BAG_LARGE = 17,
MP_TAG_ARROW = 18,
MP_TAG_GANG_CEO = 19,
MP_TAG_GANG_BIKER = 20,
MP_TAG_BIKER_ARROW = 21,
MP_TAG_MC_ROLE_PRESIDENT = 22,
MP_TAG_MC_ROLE_VICE_PRESIDENT = 23,
MP_TAG_MC_ROLE_ROAD_CAPTAIN = 24,
MP_TAG_MC_ROLE_SARGEANT = 25,
MP_TAG_MC_ROLE_ENFORCER = 26,
MP_TAG_MC_ROLE_PROSPECT = 27,
MP_TAG_TRANSMITTER = 28,
MP_TAG_BOMB = 29
};
```
```
NativeDB Added Parameter 4: Any p3
```
]]
native "SET_MP_GAMER_TAG_WANTED_LEVEL"
hash "0xCF228E2AA03099C3"
jhash (0x0EBB003F)
arguments {
int "gamerTagId" [=[ {} ]=],
int "wantedlvl" [=[ {} ]=],
}
alias "0xCF228E2AA03099C3"
ns "HUD"
returns "void"
doc [[!
```
displays wanted star above head
```
]]
native "SET_MULTIPLAYER_BANK_CASH"
hash "0xDD21B55DF695CD0A"
jhash (0x2C842D03)
ns "HUD"
returns "void"
doc [[!
Preview image:

To change the bank balance use [`STAT_SET_INT`](#\_0xB3271D7AB655B441) with "BANK_BALANCE" to whatever value you need to.
]]
native "SET_MULTIPLAYER_HUD_CASH"
hash "0xFD1D220394BCB824"
jhash (0xA8DB435E)
arguments {
int "p0" [=[ {} ]=],
int "p1" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
**This native does absolutely nothing, just a nullsub**
]]
native "SET_MULTIPLAYER_WALLET_CASH"
hash "0xC2D15BEF167E27BC"
jhash (0xF4F3C796)
alias "0xC2D15BEF167E27BC"
ns "HUD"
returns "void"
doc [[!
Preview image:

To change money value use [`STAT_SET_INT`](#\_0xB3271D7AB655B441) with "MP0\_WALLET_BALANCE" to whatever value you need to.
]]
native "SET_NEW_WAYPOINT"
hash "0xFE43368D2AA4F2FC"
jhash (0x8444E1F0)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
]]
native "SET_PAUSE_MENU_ACTIVE"
hash "0xDF47FC56C71569CF"
jhash (0x1DCD878E)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
This native is deprecated.
If you're looking to:
* Toggle the pause menu on, use [`ACTIVATE_FRONTEND_MENU`](#\_0xEF01D36B9C9D0C7B)
* Toggle the pause menu off, use [`SET_FRONTEND_ACTIVE`](#\_0x745711A75AB09277)
* Disable toggling the pause menu, use [`DISABLE_FRONTEND_THIS_FRAME`](#\_0x6D3465A73092F0E6)
]]
native "SET_PAUSE_MENU_PED_LIGHTING"
hash "0x3CA6050692BC61B0"
jhash (0x127310EB)
arguments {
BOOL "state" [=[ {} ]=],
}
alias "0x3CA6050692BC61B0"
ns "HUD"
returns "void"
doc [[!
Toggles the light state for the pause menu ped in frontend menus.
This is used by R\* in combination with [`SET_PAUSE_MENU_PED_SLEEP_STATE`](#\_0xECF128344E9FF9F1) to toggle the "offline" or "online" state in the "friends" tab of the pause menu in GTA Online.
Example:
On: 
Off: 
True enables the light, false disables the light.
]]
native "SET_PAUSE_MENU_PED_SLEEP_STATE"
hash "0xECF128344E9FF9F1"
jhash (0x8F45D327)
arguments {
BOOL "state" [=[ {} ]=],
}
alias "0xECF128344E9FF9F1"
ns "HUD"
returns "void"
doc [[!
Toggles the pause menu ped sleep state for frontend menus.
[Example GIF](https://vespura.com/hi/i/2019-04-01\_15-51\_8ed38\_1014.gif)
0 will make the ped slowly fall asleep, 1 will slowly wake the ped up.
]]
native "SET_PED_AI_BLIP_FORCED_ON"
hash "0x0C4BBF625CA98C4E"
jhash (0xFFDF46F0)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x0C4BBF625CA98C4E"
alias "_IS_AI_BLIP_ALWAYS_SHOWN"
ns "HUD"
returns "void"
doc [[!
```
if "flag" is true, the AI blip will always be displayed for the specified ped, if it has an AI blip
If "flag" is false, the AI blip will only be displayed when the player is in combat with the specified ped, if it has an AI blip
```
]]
native "SET_PED_AI_BLIP_GANG_ID"
hash "0xE52B8E7F85D39A08"
jhash (0xD8E31B1A)
arguments {
Ped "ped" [=[ {} ]=],
int "gangId" [=[ {} ]=],
}
alias "0xE52B8E7F85D39A08"
alias "_SET_AI_BLIP_TYPE"
ns "HUD"
returns "void"
doc [[!
]]
native "SET_PED_AI_BLIP_HAS_CONE"
hash "0x3EED80DFF7325CAA"
jhash (0x872C2CFB)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "HIDE_SPECIAL_ABILITY_LOCKON_OPERATION"
ns "HUD"
returns "void"
doc [[!
]]
native "SET_PED_AI_BLIP_NOTICE_RANGE"
hash "0x97C65887D4B37FA9"
jhash (0xF9DC2AF7)
arguments {
Ped "ped" [=[ {} ]=],
float "range" [=[ {} ]=],
}
alias "0x97C65887D4B37FA9"
alias "_SET_AI_BLIP_MAX_DISTANCE"
ns "HUD"
returns "void"
doc [[!
]]
native "SET_PED_HAS_AI_BLIP"
hash "0xD30C50DF888D58B5"
jhash (0x96C4C4DD)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "hasCone" [=[ {} ]=],
}
alias "0xD30C50DF888D58B5"
alias "_SET_PED_ENEMY_AI_BLIP"
alias "_SET_PED_AI_BLIP"
ns "HUD"
returns "void"
doc [[!
```
This native turns on the AI blip on the specified ped. It also disappears automatically when the ped is too far or if the ped is dead. You don't need to control it with other natives.
See gtaforums.com/topic/884370-native-research-ai-blips for further information.
```
]]
native "SET_RACE_TRACK_RENDER"
hash "0x1EAC5F91BCBC5073"
jhash (0xFB9BABF5)
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0x1EAC5F91BCBC5073"
ns "HUD"
returns "void"
doc [[!
]]
native "SET_RADAR_AS_EXTERIOR_THIS_FRAME"
hash "0xE81B7D2A3DAB2D81"
jhash (0x39ABB10E)
ns "HUD"
returns "void"
doc [[!
]]
native "SET_RADAR_AS_INTERIOR_THIS_FRAME"
hash "0x59E727A1C9D3E31A"
jhash (0x6F2626E1)
arguments {
Hash "interior" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
int "heading" [=[ {} ]=],
int "zoom" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
```
List of interior hashes: pastebin.com/1FUyXNqY
Not for every interior zoom > 0 available.
```
]]
native "SET_RADAR_ZOOM"
hash "0x096EF57A0C999BBA"
jhash (0x2A50D1A6)
arguments {
int "zoomLevel" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
```
zoomLevel ranges from 0 to 200
```
]]
native "SET_RADAR_ZOOM_PRECISE"
hash "0xBD12C5EEE184C337"
jhash (0xDCA3F423)
arguments {
float "zoom" [=[ {} ]=],
}
alias "RESPONDING_AS_TEMP"
ns "HUD"
returns "void"
doc [[!
]]
native "SET_RADAR_ZOOM_TO_BLIP"
hash "0xF98E4B3E56AFC7B1"
jhash (0x25EC28C0)
arguments {
Blip "blip" [=[ {} ]=],
float "zoom" [=[ {} ]=],
}
alias "0xF98E4B3E56AFC7B1"
ns "HUD"
returns "void"
doc [[!
]]
native "SET_RADAR_ZOOM_TO_DISTANCE"
hash "0xCB7CC0D58405AD41"
jhash (0x09CF1CE5)
arguments {
float "zoom" [=[ {} ]=],
}
alias "_SET_RADAR_ZOOM_LEVEL_THIS_FRAME"
ns "HUD"
returns "void"
doc [[!
]]
native "SET_RADIUS_BLIP_EDGE"
hash "0x25615540D894B814"
jhash (0x40E25DB8)
arguments {
Blip "blip" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x25615540D894B814"
ns "HUD"
returns "void"
doc [[!
Enabling this on a radius blip will make it outline only.\
Please note that this only works on a **radius** blip (i.e. one generated using [`ADD_BLIP_FOR_RADIUS`](#\_0x46818D79B1F7499A)), not a normal blip.
**Example result:**\

The blip handle
Whether to turn off or on the effect
]]
native "SET_SCRIPT_VARIABLE_HUD_COLOUR"
hash "0xD68A5FF8A3A89874"
jhash (0x0E41E45C)
arguments {
int "r" [=[ {} ]=],
int "g" [=[ {} ]=],
int "b" [=[ {} ]=],
int "a" [=[ {} ]=],
}
alias "0xD68A5FF8A3A89874"
ns "HUD"
returns "void"
doc [[!
```
Sets the color of HUD_COLOUR_SCRIPT_VARIABLE
```
]]
native "SET_SOCIAL_CLUB_TOUR"
hash "0x9E778248D6685FE0"
jhash (0x7AD67C95)
arguments {
charPtr "name" [=[ {} ]=],
}
alias "0x9E778248D6685FE0"
ns "HUD"
returns "void"
doc [[!
```
HUD::SET_SOCIAL_CLUB_TOUR("Gallery");
HUD::SET_SOCIAL_CLUB_TOUR("Missions");
HUD::SET_SOCIAL_CLUB_TOUR("General");
HUD::SET_SOCIAL_CLUB_TOUR("Playlists");
```
]]
native "SET_TEXT_CENTRE"
hash "0xC02F4DBFB51D988B"
jhash (0xE26D39A1)
arguments {
BOOL "align" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
]]
native "SET_TEXT_COLOUR"
hash "0xBE6B23FFA53FB442"
jhash (0xE54DD2C8)
arguments {
int "red" [=[ {} ]=],
int "green" [=[ {} ]=],
int "blue" [=[ {} ]=],
int "alpha" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
```
colors you input not same as you think?
A: for some reason its R B G A
```
]]
native "SET_TEXT_DROP_SHADOW"
hash "0x1CA3E9EAC9D93E5E"
jhash (0xE2A11511)
ns "HUD"
returns "void"
doc [[!
]]
native "SET_TEXT_DROPSHADOW"
hash "0x465C84BC39F1C351"
jhash (0xE6587517)
arguments {
int "distance" [=[ {} ]=],
int "r" [=[ {} ]=],
int "g" [=[ {} ]=],
int "b" [=[ {} ]=],
int "a" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
distance - shadow distance in pixels, both horizontal and vertical
r, g, b, a - color
Shadow distance in pixels, both horizontal and vertical.
Red color.
Green color.
Blue color.
Alpha.
]]
native "SET_TEXT_EDGE"
hash "0x441603240D202FA6"
jhash (0x3F1A5DAB)
arguments {
int "p0" [=[ {} ]=],
int "r" [=[ {} ]=],
int "g" [=[ {} ]=],
int "b" [=[ {} ]=],
int "a" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
**This native does absolutely nothing, just a nullsub**
]]
native "SET_TEXT_FONT"
hash "0x66E0276CC5F6B9DA"
jhash (0x80BC530D)
arguments {
int "fontType" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
```cpp
enum eTextFonts
{
FONT_STANDARD = 0,
FONT_CURSIVE = 1,
FONT_ROCKSTAR_TAG = 2,
FONT_LEADERBOAR0D = 3,
FONT_CONDENSED = 4,
FONT_STYLE_FIXED_WIDTH_NUMBERS = 5,
FONT_CONDENSED_NOT_GAMERNAME = 6,
FONT_STYLE_PRICEDOWN = 7,
FONT_STYLE_TAXI = 8,
}
```
]]
native "SET_TEXT_INPUT_BOX_ENABLED"
hash "0x1185A8087587322C"
arguments {
BOOL "state" [=[ {} ]=],
}
alias "0x1185A8087587322C"
ns "HUD"
returns "void"
doc [[!
Toggles if the text input box can be opened with [`DISPLAY_ONSCREEN_KEYBOARD`](#\_0x00DC833F2568DBF6).
]]
native "SET_TEXT_JUSTIFICATION"
hash "0x4E096588B13FFECA"
jhash (0x68CDFA60)
arguments {
int "justifyType" [=[ {} ]=],
}
alias "0x4E096588B13FFECA"
ns "HUD"
returns "void"
doc [[!
```
Types -
0: Center-Justify
1: Left-Justify
2: Right-Justify
Right-Justify requires SET_TEXT_WRAP, otherwise it will draw to the far right of the screen
```
]]
native "SET_TEXT_LEADING"
hash "0xA50ABC31E3CDFAFF"
jhash (0x98CE21D4)
arguments {
int "p0" [=[ {"cs_type":"BOOL"} ]=],
}
ns "HUD"
returns "void"
doc [[!
]]
native "SET_TEXT_OUTLINE"
hash "0x2513DFB0FB8400FE"
jhash (0xC753412F)
ns "HUD"
returns "void"
doc [[!
]]
native "SET_TEXT_PROPORTIONAL"
hash "0x038C1F517D7FDCF8"
jhash (0xF49D8A08)
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
**This native does absolutely nothing, just a nullsub**
]]
native "SET_TEXT_RENDER_ID"
hash "0x5F15302936E07111"
jhash (0xC5C3B7F3)
arguments {
int "renderId" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
]]
native "SET_TEXT_RIGHT_JUSTIFY"
hash "0x6B3C4650BC8BEE47"
jhash (0x45B60520)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
]]
native "SET_TEXT_SCALE"
hash "0x07C837F9A01C34C9"
jhash (0xB6E15B23)
arguments {
float "scale" [=[ {} ]=],
float "size" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
```
Size range : 0F to 1.0F
p0 is unknown and doesn't seem to have an effect, yet in the game scripts it changes to 1.0F sometimes.
```
]]
native "SET_TEXT_WRAP"
hash "0x63145D9C883A1A70"
jhash (0x6F60AB54)
arguments {
float "start" [=[ {} ]=],
float "end" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
```
It sets the text in a specified box and wraps the text if it exceeds the boundries. Both values are for X axis. Useful when positioning text set to center or aligned to the right.
start - left boundry on screen position (0.0 - 1.0)
end - right boundry on screen position (0.0 - 1.0)
```
]]
native "SET_USE_ISLAND_MAP"
hash "0x5E1460624D194A38"
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "_SET_TOGGLE_MINIMAP_HEIST_ISLAND"
ns "HUD"
returns "void"
doc [[!
Switches the display of the in-game minimap to the Cayo Perico map. This native needs to be called every frame to maintain the toggled state effectively.
```
NativeDB Introduced: v2189
```
A boolean value where `true` switches the minimap to the Cayo Perico map, and `false` reverts it to the standard map.
This native does not return any value.
]]
native "SET_WARNING_MESSAGE"
hash "0x7B1776B3B53F8D74"
jhash (0xBE699BDE)
arguments {
charPtr "entryLine1" [=[ {} ]=],
int "instructionalKey" [=[ {} ]=],
charPtr "entryLine2" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
int "p4" [=[ {} ]=],
charPtr "background" [=[ {"cs_type":"AnyPtr"} ]=],
charPtr "p6" [=[ {"cs_type":"AnyPtr"} ]=],
BOOL "showBg" [=[ {} ]=],
int "errorCode" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
```cpp
enum eInstructionalButtonTypes
{
NONE = 0,
SELECT = 1,
OK = 2,
YES = 4,
BACK = 8,
BACK_SELECT = 9,
BACK_OK = 10,
BACK_YES = 12,
CANCEL = 16,
CANCEL_SELECT = 17,
CANCEL_OK = 18,
CANCEL_YES = 20,
NO = 32,
NO_SELECT = 33,
NO_OK = 34,
YES_NO = 36,
RETRY = 64,
RETRY_SELECT = 65,
RETRY_OK = 66,
RETRY_YES = 68,
RETRY_BACK = 72,
RETRY_BACK_SELECT = 73,
RETRY_BACK_OK = 74,
RETRY_BACK_YES = 76,
RETRY_CANCEL = 80,
RETRY_CANCEL_SELECT = 81,
RETRY_CANCEL_OK = 82,
RETRY_CANCEL_YES = 84,
SKIP = 256,
SKIP_SELECT = 257,
SKIP_OK = 258,
SKIP_YES = 260,
SKIP_BACK = 264,
SKIP_BACK_SELECT = 265,
SKIP_BACK_OK = 266,
SKIP_BACK_YES = 268,
SKIP_CANCEL = 272,
SKIP_CANCEL_SELECT = 273,
SKIP_CANCEL_OK = 274,
SKIP_CANCEL_YES = 276,
CONTINUE = 16384,
BACK_CONTINUE = 16392,
CANCEL_CONTINUE = 16400,
LOADING_SPINNER = 134217728,
SELECT_LOADING_SPINNER = 134217729,
OK_LOADING_SPINNER = 134217730,
YES_LOADING_SPINNER = 134217732,
BACK_LOADING_SPINNER = 134217736,
BACK_SELECT_LOADING_SPINNER = 134217737,
BACK_OK_LOADING_SPINNER = 134217738,
BACK_YES_LOADING_SPINNER = 134217740,
CANCEL_LOADING_SPINNER = 134217744,
CANCEL_SELECT_LOADING_SPINNER = 134217745,
CANCEL_OK_LOADING_SPINNER = 134217746,
CANCEL_YES_LOADING_SPINNER = 134217748
}
```
Note: this list is definitely NOT complete, but these are the ones I've been able to find before giving up because it's such a boring thing to look for 'good' combinations.
**Result of the example code:**
The text label to display as the first line of the warning message.
This is an enum, check the description for a list.
The text label to display as the second line of the warning message.
Purpose unknown.
Purpose unknown.
Set to anything other than 0 or false (even any string) and it will draw a background. Setting it to 0 or false will draw no background.
Purpose unknown.
Purpose unknown.
When not 0, adds a field displaying the value as 'error code' to the warning message.
]]
native "SET_WARNING_MESSAGE_OPTION_ITEMS"
hash "0x0C5A80A9E096D529"
arguments {
int "index" [=[ {} ]=],
charPtr "name" [=[ {} ]=],
int "cash" [=[ {} ]=],
int "rp" [=[ {} ]=],
int "lvl" [=[ {} ]=],
int "colour" [=[ {} ]=],
}
alias "0x0C5A80A9E096D529"
alias "_SET_WARNING_MESSAGE_LIST_ROW"
ns "HUD"
returns "BOOL"
doc [[!
]]
native "SET_WARNING_MESSAGE_WITH_HEADER"
hash "0xDC38CC1E35B6A5D7"
jhash (0x2DB9EAB5)
arguments {
charPtr "titleMsg" [=[ {} ]=],
charPtr "entryLine1" [=[ {} ]=],
int "flags" [=[ {} ]=],
charPtr "promptMsg" [=[ {} ]=],
BOOL "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
BOOL "background" [=[ {} ]=],
AnyPtr "p7" [=[ {} ]=],
BOOL "showBg" [=[ {} ]=],
}
alias "_SET_WARNING_MESSAGE_2"
ns "HUD"
returns "void"
doc [[!
```
You can only use text entries. No custom text.
C# Example :
Function.Call(Hash._SET_WARNING_MESSAGE_2, "HUD_QUIT", "HUD_CGIGNORE", 2, "HUD_CGINVITE", 0, -1, 0, 0, 1);
you can recreate this easily with scaleforms
---------------
Fixed native name, from before nativedb restoration.
```
```
NativeDB Added Parameter 10: Any p9
```
]]
native "SET_WARNING_MESSAGE_WITH_HEADER_AND_SUBSTRING_FLAGS"
hash "0x701919482C74B5AB"
jhash (0x749929D3)
arguments {
charPtr "entryHeader" [=[ {} ]=],
charPtr "entryLine1" [=[ {} ]=],
Any "instructionalKey" [=[ {} ]=],
charPtr "entryLine2" [=[ {} ]=],
BOOL "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
Any "p6" [=[ {} ]=],
AnyPtr "p7" [=[ {} ]=],
AnyPtr "p8" [=[ {} ]=],
BOOL "p9" [=[ {} ]=],
}
alias "_SET_WARNING_MESSAGE_3"
ns "HUD"
returns "void"
doc [[!
```
You can only use text entries. No custom text.
```
```
NativeDB Added Parameter 11: Any p10
```
]]
native "SET_WARNING_MESSAGE_WITH_HEADER_EXTENDED"
hash "0x38B55259C2E078ED"
arguments {
charPtr "headerTextLabel" [=[ {} ]=],
charPtr "line1TextLabel" [=[ {} ]=],
int "buttonsBitField" [=[ {} ]=],
int "buttonsBitFieldUpper" [=[ {"cs_type":"char*"} ]=],
charPtr "line2TextLabel" [=[ {"cs_type":"BOOL"} ]=],
BOOL "addNumber" [=[ {"cs_type":"Any"} ]=],
int "numberToAdd" [=[ {"cs_type":"Any*"} ]=],
charPtr "firstSubstring" [=[ {"cs_type":"Any*"} ]=],
charPtr "secondSubstring" [=[ {"cs_type":"BOOL"} ]=],
BOOL "showBackground" [=[ {"cs_type":"Any"} ]=],
int "errorCode" [=[ {} ]=],
}
alias "0x38B55259C2E078ED"
alias "_SET_WARNING_MESSAGE_WITH_HEADER_UNK"
ns "HUD"
returns "void"
doc [[!
Sets a warning message for one frame with header and upper buttons bit field that don't fit the standard 32 bit set.
Text label to set on the header/title.
Text label to set on the first line of the body..
Bit field of the button flags. See [`SET_WARNING_MESSAGE`](#\_0x7B1776B3B53F8D74).
Bit field of the upper button flags. See [`SET_WARNING_MESSAGE_WITH_HEADER_AND_SUBSTRING_FLAGS_EXTENDED`](#\_0x15803FEC3B9A872B).
Text label to set on the second line of the body.
If number should be inserted into `~1~` in the body.
What number to insert into `~1~` in the body.
First substring text label to insert into `~a~` in the body.
Second substring text label to insert into `~a~` in the body.
Bool indicating if the message should have a black background.
Error number to show at the bottom of the message. `0` is the default.
]]
native "SET_WAYPOINT_OFF"
hash "0xA7E4E2D361C2627F"
jhash (0xB3496E1B)
ns "HUD"
returns "void"
doc [[!
```
This native removes the current waypoint from the map.
Example:
C#:
Function.Call(Hash.SET_WAYPOINT_OFF);
C++:
HUD::SET_WAYPOINT_OFF();
```
]]
native "SET_WIDESCREEN_FORMAT"
hash "0xC3B07BA00A83B0F1"
jhash (0xF016E08F)
arguments {
Any "p0" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
]]
native "SHOW_CONTACT_INSTRUCTIONAL_BUTTON"
hash "0xC772A904CDE1186F"
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
Controls the visibility of the "Contact" instructional buttons on the map screen.
```
NativeDB Introduced: 2545
```
Set to `true` to show the instructional buttons, or `false` to hide them.
]]
native "SHOW_CREW_INDICATOR_ON_BLIP"
hash "0xDCFB5D4DB8BF367E"
jhash (0xABBE1E45)
arguments {
Blip "blip" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0xDCFB5D4DB8BF367E"
alias "SET_BLIP_CREW"
ns "HUD"
returns "void"
doc [[!
Enables or disables the blue half circle  around the specified blip on the left side of the blip. This is used to indicate that the player is in your crew in GTA:O. Color is changeable by using [`SET_BLIP_SECONDARY_COLOUR`](#\_0x14892474891E09EB).
To toggle the right side of the circle use: [`SHOW_FRIEND_INDICATOR_ON_BLIP`](#\_0x23C3EB807312F01A).
Example code result:

The blip to toggle the half blue circle around the blip on.
Enables or disables the half blue circle around the blip (on the left side).
]]
native "SHOW_FRIEND_INDICATOR_ON_BLIP"
hash "0x23C3EB807312F01A"
jhash (0x4C8F02B4)
arguments {
Blip "blip" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x23C3EB807312F01A"
alias "SET_BLIP_FRIEND"
ns "HUD"
returns "void"
doc [[!
Highlights a blip by a half cyan circle on the right side of the blip.  Indicating that that player is a friend (in GTA:O). This color can not be changed.
To toggle the left side (crew member indicator) of the half circle around the blip, use: [`SHOW_CREW_INDICATOR_ON_BLIP`](#\_0xDCFB5D4DB8BF367E).
The blip to toggle the half circle on.
Enables or disables the half circle around the blip (on the right side of the blip).
]]
native "SHOW_HEADING_INDICATOR_ON_BLIP"
hash "0x5FBCA48327B914DF"
jhash (0xD1C3D71B)
arguments {
Blip "blip" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x5FBCA48327B914DF"
ns "HUD"
returns "void"
doc [[!
```
Adds the GTA: Online player heading indicator to a blip.
```
]]
native "SHOW_HEIGHT_ON_BLIP"
hash "0x75A16C3DA34F1245"
jhash (0x1D99F676)
arguments {
Blip "blip" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x75A16C3DA34F1245"
ns "HUD"
returns "void"
doc [[!
]]
native "SHOW_HUD_COMPONENT_THIS_FRAME"
hash "0x0B4DF1FA60C0E664"
jhash (0x95E1546E)
arguments {
int "id" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
This function shows various HUD (Heads-up Display) components.
Listed below are the integers and the corresponding HUD component.
* 1 : WANTED_STARS
* 2 : WEAPON_ICON
* 3 : CASH
* 4 : MP_CASH
* 5 : MP_MESSAGE
* 6 : VEHICLE_NAME
* 7 : AREA_NAME
* 8 : VEHICLE_CLASS
* 9 : STREET_NAME
* 10 : HELP_TEXT
* 11 : FLOATING_HELP_TEXT\_1
* 12 : FLOATING_HELP_TEXT\_2
* 13 : CASH_CHANGE
* 14 : RETICLE
* 15 : SUBTITLE_TEXT
* 16 : RADIO_STATIONS
* 17 : SAVING_GAME
* 18 : GAME_STREAM
* 19 : WEAPON_WHEEL
* 20 : WEAPON_WHEEL_STATS
* 21 : HUD_COMPONENTS
* 22 : HUD_WEAPONS
These integers also work for the [`HIDE_HUD_COMPONENT_THIS_FRAME`](#\_0x6806C51AD12B83B8) native, but instead hides the HUD component.
]]
native "SHOW_NUMBER_ON_BLIP"
hash "0xA3C0B359DCB848B6"
jhash (0x7BFC66C6)
arguments {
Blip "blip" [=[ {} ]=],
int "number" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
]]
native "SHOW_OUTLINE_INDICATOR_ON_BLIP"
hash "0xB81656BC81FE24D1"
jhash (0x8DE82C15)
arguments {
Blip "blip" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0xB81656BC81FE24D1"
alias "SET_BLIP_FRIENDLY"
ns "HUD"
returns "void"
doc [[!
Toggles a cyan outline around the blip.
Color can be changed with [`SET_BLIP_SECONDARY_COLOUR`](#\_0x14892474891E09EB). Enabling this circle will override the "crew" and "friend" half-circles (see [`SHOW_CREW_INDICATOR_ON_BLIP`](#\_0xDCFB5D4DB8BF367E) and [`SHOW_FRIEND_INDICATOR_ON_BLIP`](#\_0x23C3EB807312F01A)).
The blip to toggle the outline on.
Enables or disables the outline.
]]
native "SHOW_START_MISSION_INSTRUCTIONAL_BUTTON"
hash "0xF1A6C18B35BCADE6"
jhash (0xA2CAAB4F)
arguments {
BOOL "p0" [=[ {} ]=],
}
alias "0xF1A6C18B35BCADE6"
ns "HUD"
returns "void"
doc [[!
]]
native "SHOW_TICK_ON_BLIP"
hash "0x74513EA3E505181E"
jhash (0x3DCF0092)
arguments {
Blip "blip" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x74513EA3E505181E"
alias "_SET_BLIP_CHECKED"
ns "HUD"
returns "void"
doc [[!
```
Adds a green checkmark on top of a blip.
```
]]
native "START_GPS_CUSTOM_ROUTE"
hash "0xDB34E8D56FC13B08"
jhash (0x7F93799B)
arguments {
int "hudColor" [=[ {} ]=],
BOOL "displayOnFoot" [=[ {} ]=],
BOOL "followPlayer" [=[ {} ]=],
}
alias "0xDB34E8D56FC13B08"
ns "HUD"
returns "void"
doc [[!
Starts a new GPS custom-route, allowing you to plot lines on the map.
Lines are drawn directly between points.
The GPS custom route works like the GPS multi route, except it does not follow roads.
**Example result:**

The HUD color of the GPS path.
Draws the path regardless if the player is in a vehicle or not.
Draw the path partially between the previous and next point based on the players position between them. When false, the GPS appears to not disappear after the last leg is completed.
]]
native "START_GPS_MULTI_ROUTE"
hash "0x3D3D15AF7BCAAF83"
jhash (0xC3DCBEDB)
arguments {
int "hudColor" [=[ {} ]=],
BOOL "routeFromPlayer" [=[ {} ]=],
BOOL "displayOnFoot" [=[ {} ]=],
}
alias "0x3D3D15AF7BCAAF83"
ns "HUD"
returns "void"
doc [[!
Starts a new GPS multi-route, allowing you to create custom GPS paths.
GPS functions like the waypoint, except it can contain multiple points it's forced to go through.
Once the player has passed a point, the GPS will no longer force its path through it.
Works independently from the player-placed waypoint and blip routes.
**Example result:**

The HUD color of the GPS path.
Makes the GPS draw a path from the player to the next point, rather than the original path from the previous point.
Draws the GPS path regardless if the player is in a vehicle or not.
]]
native "SUPPRESS_FRONTEND_RENDERING_THIS_FRAME"
hash "0xBA751764F0821256"
jhash (0x7F349900)
alias "0xBA751764F0821256"
ns "HUD"
returns "void"
doc [[!
]]
native "TAKE_CONTROL_OF_FRONTEND"
hash "0xEC9264727EEC0F28"
jhash (0xC06B763D)
alias "0xEC9264727EEC0F28"
ns "HUD"
returns "void"
doc [[!
Disables frontend (works in custom frontends, not sure about regular pause menu) navigation keys on keyboard. Not sure about controller. Does not disable mouse controls. No need to call this every tick.
To enable the keys again, use [`0x14621BB1DF14E2B2`](#\_0x14621BB1DF14E2B2).
]]
native "THEFEED_AUTO_POST_GAMETIPS_OFF"
hash "0xADED7F5748ACAFE6"
jhash (0x1D6859CA)
alias "0xADED7F5748ACAFE6"
alias "_THEFEED_SHOW_GTAO_TOOLTIPS"
alias "_THEFEED_COMMENT_TELEPORT_POOL_OFF"
ns "HUD"
returns "void"
doc [[!
Disables tip notifications enabled by [`THEFEED_AUTO_POST_GAMETIPS_ON`](#\_0x56C8B608CFD49854)
]]
native "THEFEED_AUTO_POST_GAMETIPS_ON"
hash "0x56C8B608CFD49854"
jhash (0xF881AB87)
alias "0x56C8B608CFD49854"
alias "_THEFEED_COMMENT_TELEPORT_POOL_ON"
ns "HUD"
returns "void"
doc [[!
Enables loading screen tips to be be shown, blocks other kinds of notifications from being displayed.
Call [`THEFEED_AUTO_POST_GAMETIPS_OFF`](#\_0xADED7F5748ACAFE6) to undo this.
]]
native "THEFEED_CLEAR_FROZEN_POST"
hash "0x80FE4F3AB4E1B62A"
jhash (0x3CD4307C)
alias "0x80FE4F3AB4E1B62A"
alias "_THEFEED_FLUSH_PERSISTENT"
ns "HUD"
returns "void"
doc [[!
]]
native "THEFEED_FLUSH_QUEUE"
hash "0xA8FDB297A8D25FBA"
jhash (0x5205C6F5)
alias "0xA8FDB297A8D25FBA"
ns "HUD"
returns "void"
doc [[!
]]
native "THEFEED_FORCE_RENDER_OFF"
hash "0x583049884A2EEE3C"
jhash (0xC8BAB2F2)
alias "0x583049884A2EEE3C"
alias "_THEFEED_HIDE_GTAO_TOOLTIPS"
ns "HUD"
returns "void"
doc [[!
Enables loading screen tips to be be shown (`_0x15CFA549788D35EF` and `_0x488043841BBE156F`), blocks other kinds of notifications from being displayed (at least from current script). Call `0xADED7F5748ACAFE6` to display those again.
]]
native "THEFEED_FORCE_RENDER_ON"
hash "0xA13C11E1B5C06BFC"
jhash (0x520FCB6D)
alias "0xA13C11E1B5C06BFC"
ns "HUD"
returns "void"
doc [[!
]]
native "THEFEED_FREEZE_NEXT_POST"
hash "0xFDEC055AB549E328"
jhash (0xAFA1148B)
alias "0xFDEC055AB549E328"
alias "_THEFEED_SET_NEXT_POST_PERSISTENT"
ns "HUD"
returns "void"
doc [[!
```
Requires manual management of game stream handles (i.e., 0xBE4390CB40B3E627).
```
]]
native "THEFEED_GET_FIRST_VISIBLE_DELETE_REMAINING"
hash "0x82352748437638CA"
jhash (0x294405D4)
alias "0x82352748437638CA"
alias "_GET_CURRENT_NOTIFICATION"
alias "_THEFEED_GET_CURRENT_NOTIFICATION"
ns "HUD"
returns "int"
doc [[!
```
Returns the handle for the notification currently displayed on the screen. Name may be a hash collision, but describes the function accurately.
```
]]
native "THEFEED_HIDE_THIS_FRAME"
hash "0x25F87B30C382FCA7"
jhash (0x1E63088A)
alias "0x25F87B30C382FCA7"
alias "_HIDE_HUD_NOTIFICATIONS_THIS_FRAME"
ns "HUD"
returns "void"
doc [[!
Once called each frame hides all above radar notifications.
]]
native "THEFEED_IS_PAUSED"
hash "0xA9CBFD40B3FA3010"
jhash (0xC5223796)
alias "0xA9CBFD40B3FA3010"
ns "HUD"
returns "BOOL"
doc [[!
]]
native "THEFEED_ONLY_SHOW_TOOLTIPS"
hash "0x6F1554B0CC2089FA"
jhash (0xA7C8594B)
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0x6F1554B0CC2089FA"
ns "HUD"
returns "void"
doc [[!
]]
native "THEFEED_PAUSE"
hash "0xFDB423997FA30340"
jhash (0x4D0449C6)
alias "0xFDB423997FA30340"
ns "HUD"
returns "void"
doc [[!
]]
native "THEFEED_REMOVE_ITEM"
hash "0xBE4390CB40B3E627"
jhash (0xECA8ACB9)
arguments {
int "notificationId" [=[ {} ]=],
}
alias "_REMOVE_NOTIFICATION"
ns "HUD"
returns "void"
doc [[!
```
Removes a notification instantly instead of waiting for it to disappear
```
]]
native "THEFEED_RESET_ALL_PARAMETERS"
hash "0xFDD85225B2DEA55E"
jhash (0xA4524B23)
alias "0xFDD85225B2DEA55E"
alias "_THEFEED_CLEAR_ANIMPOSTFX"
ns "HUD"
returns "void"
doc [[!
]]
native "THEFEED_RESUME"
hash "0xE1CD1E48E025E661"
jhash (0xD3F40140)
alias "0xE1CD1E48E025E661"
ns "HUD"
returns "void"
doc [[!
]]
native "THEFEED_SET_SCRIPTED_MENU_HEIGHT"
hash "0x55598D21339CB998"
jhash (0x1DA7E41A)
arguments {
float "pos" [=[ {} ]=],
}
alias "0x55598D21339CB998"
alias "_CLEAR_NOTIFICATIONS_POS"
ns "HUD"
returns "void"
doc [[!
]]
native "THEFEED_SPS_EXTEND_WIDESCREEN_OFF"
hash "0xB695E2CD0A2DA9EE"
jhash (0x4A4A40A4)
alias "0xB695E2CD0A2DA9EE"
alias "_THEFEED_DISABLE_BASELINE_OFFSET"
ns "HUD"
returns "void"
doc [[!
]]
native "THEFEED_SPS_EXTEND_WIDESCREEN_ON"
hash "0xD4438C0564490E63"
jhash (0x709B4BCB)
alias "0xD4438C0564490E63"
alias "_THEFEED_ENABLE_BASELINE_OFFSET"
ns "HUD"
returns "void"
doc [[!
]]
native "THEFEED_UPDATE_ITEM_TEXTURE"
hash "0x317EBA71D7543F52"
jhash (0x6A3F747D)
arguments {
charPtr "txdString1" [=[ {} ]=],
charPtr "txnString1" [=[ {} ]=],
charPtr "txdString2" [=[ {} ]=],
charPtr "txnString2" [=[ {} ]=],
}
alias "0x317EBA71D7543F52"
alias "_THEFEED_ADD_TXD_REF"
ns "HUD"
returns "void"
doc [[!
```
Used in the native scripts to reference "GET_PEDHEADSHOT_TXD_STRING" and "CHAR_DEFAULT".
NativeDB Introduced: v323
```
]]
native "TOGGLE_STEALTH_RADAR"
hash "0x6AFDFB93754950C7"
jhash (0xC68D47C4)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
]]
native "TRIGGER_SONAR_BLIP"
hash "0x72DD432F3CDFC0EE"
jhash (0xBF25E7B2)
arguments {
float "posX" [=[ {} ]=],
float "posY" [=[ {} ]=],
float "posZ" [=[ {} ]=],
float "radius" [=[ {} ]=],
int "p4" [=[ {} ]=],
}
alias "0x72DD432F3CDFC0EE"
ns "HUD"
returns "void"
doc [[!
]]
native "UNLOCK_MINIMAP_ANGLE"
hash "0x8183455E16C42E3A"
jhash (0x742043F9)
ns "HUD"
returns "void"
doc [[!
]]
native "UNLOCK_MINIMAP_POSITION"
hash "0x3E93E06DB8EF1F30"
jhash (0x5E8E6F54)
ns "HUD"
returns "void"
doc [[!
]]
native "USE_FAKE_MP_CASH"
hash "0x170F541E1CADD1DE"
jhash (0x6253B9D7)
arguments {
BOOL "p0" [=[ {} ]=],
}
alias "0x170F541E1CADD1DE"
ns "HUD"
returns "void"
doc [[!
```
Related to displaying cash on the HUD
Always called before HUD::CHANGE_FAKE_MP_CASH in decompiled scripts
```
]]
native "_ADD_BLIP_FOR_AREA"
hash "0xCE5D0E5E315DB238"
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "width" [=[ {} ]=],
float "height" [=[ {} ]=],
}
alias "0xCE5D0E5E315DB238"
ns "HUD"
returns "Blip"
doc [[!
Adds a rectangular blip for the specified coordinates/area.
It is recommended to use [SET_BLIP_ROTATION](#\_0xF87683CDF73C3F6E) and [SET_BLIP_COLOUR](#\_0x03D7FB09E75D6B7E) to make the blip not rotate along with the camera.
By default, the blip will show as a *regular* blip with the specified color/sprite if it is outside of the minimap view.
Example image:


(Native name is *likely* to actually be ADD_BLIP_FOR_AREA, but due to the usual reasons this can't be confirmed)
The X coordinate of the center of the blip.
The Y coordinate of the center of the blip.
The Z coordinate of the center of the blip.
The width of the blip.
The height of the blip.
A handle to the blip.
]]
native "_ALLOW_PAUSE_MENU_WHEN_DEAD_THIS_FRAME"
hash "0xCC3FDDED67BCFC63"
jhash (0x630CD8EE)
alias "0xCC3FDDED67BCFC63"
ns "HUD"
returns "void"
doc [[!
Allows opening the pause menu this frame, when the player is dead.
]]
native "_BEGIN_TEXT_COMMAND_GET_WIDTH"
hash "0x54CE8AC98E120CAB"
jhash (0x51E7A037)
arguments {
charPtr "text" [=[ {} ]=],
}
alias "_SET_TEXT_ENTRY_FOR_WIDTH"
alias "_BEGIN_TEXT_COMMAND_WIDTH"
ns "HUD"
returns "void"
doc [[!
```
BEGIN_TEXT_COMMAND_*
Example:
_BEGIN_TEXT_COMMAND_GET_WIDTH("NUMBER");
ADD_TEXT_COMPONENT_FLOAT(69.420f, 2);
float width = _END_TEXT_COMMAND_GET_WIDTH(1);
```
]]
native "_BEGIN_TEXT_COMMAND_LINE_COUNT"
hash "0x521FB041D93DD0E4"
jhash (0x94B82066)
arguments {
charPtr "entry" [=[ {} ]=],
}
alias "_SET_TEXT_GXT_ENTRY"
ns "HUD"
returns "void"
doc [[!
```
get's line count
int GetLineCount(char *text, float x, float y)
{
_BEGIN_TEXT_COMMAND_LINE_COUNT("STRING");
ADD_TEXT_COMPONENT_SUBSTRING_PLAYER_NAME(text);
return _END_TEXT_COMMAND_GET_LINE_COUNT(x, y);
}
```
]]
native "_BEGIN_TEXT_COMMAND_OBJECTIVE"
hash "0x23D69E0465570028"
jhash (0x0E103475)
arguments {
charPtr "p0" [=[ {} ]=],
}
alias "0x23D69E0465570028"
ns "HUD"
returns "void"
doc [[!
]]
native "_CLEAR_ALL_BLIP_ROUTES"
hash "0xD12882D3FF82BF11"
alias "0xD12882D3FF82BF11"
ns "HUD"
returns "void"
doc [[!
Clears all active blip routes that have been set with [`SetBlipRoute`](#\_0x4F7D8A9BFB0B43E9).
]]
native "_CLEAR_RACE_GALLERY_BLIPS"
hash "0x2708FC083123F9FF"
jhash (0xCBEC9369)
alias "0x2708FC083123F9FF"
ns "HUD"
returns "void"
doc [[!
]]
native "_CLOSE_MULTIPLAYER_CHAT"
hash "0x1AC8F4AD40E22127"
alias "_ABORT_TEXT_CHAT"
ns "HUD"
returns "void"
doc [[!
]]
native "_DISABLE_MULTIPLAYER_CHAT"
hash "0x1DB21A44B09E8BA3"
arguments {
BOOL "disable" [=[ {} ]=],
}
alias "_SET_TEXT_CHAT_UNK"
ns "HUD"
returns "void"
doc [[!
If true is passed, the player won't be able to open the multiplayer chat
]]
native "_DISPLAY_HUD_WHEN_DEAD_THIS_FRAME"
hash "0x7669F9E39DC17063"
jhash (0xC380AC85)
alias "0x7669F9E39DC17063"
ns "HUD"
returns "void"
doc [[!
Enables drawing some hud components, such as help labels, this frame, when the player is dead.
]]
native "_END_TEXT_COMMAND_GET_WIDTH"
hash "0x85F061DA64ED2F67"
jhash (0xD12A643A)
arguments {
BOOL "p0" [=[ {} ]=],
}
alias "_GET_TEXT_SCREEN_WIDTH"
ns "HUD"
returns "float"
doc [[!
```
END_TEXT_COMMAND_*
In scripts font most of the time is passed as 1.
Use _BEGIN_TEXT_GET_COMMAND_GET_WIDTH
param is not font from what i've tested
```
]]
native "_END_TEXT_COMMAND_LINE_COUNT"
hash "0x9040DFB09BE75706"
jhash (0xAA318785)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
}
alias "0x9040DFB09BE75706"
alias "_GET_TEXT_SCREEN_LINE_COUNT"
alias "_END_TEXT_COMMAND_GET_LINE_COUNT"
ns "HUD"
returns "int"
doc [[!
```
END_TEXT_COMMAND_*
Determines how many lines the text string will use when drawn on screen.
Must use 0x521FB041D93DD0E4 for setting up
```
]]
native "_END_TEXT_COMMAND_OBJECTIVE"
hash "0xCFDBDF5AE59BA0F4"
jhash (0x2944A6C5)
arguments {
BOOL "p0" [=[ {} ]=],
}
alias "0xCFDBDF5AE59BA0F4"
ns "HUD"
returns "void"
doc [[!
]]
native "_END_TEXT_COMMAND_THEFEED_POST_MESSAGETEXT_GXT_ENTRY"
hash "0xC6F580E4C94926AC"
arguments {
charPtr "txdName" [=[ {} ]=],
charPtr "textureName" [=[ {} ]=],
BOOL "flash" [=[ {} ]=],
int "iconType" [=[ {} ]=],
charPtr "sender" [=[ {} ]=],
charPtr "subject" [=[ {} ]=],
}
alias "0xC6F580E4C94926AC"
alias "_SET_NOTIFICATION_MESSAGE_3"
alias "_END_TEXT_COMMAND_THEFEED_POST_MESSAGETEXT_ENTRY"
ns "HUD"
returns "int"
doc [[!
This function can show pictures of every texture that can be requested by REQUEST_STREAMED_TEXTURE_DICT.
Needs more research.
Only one type of usage in the scripts:
HUD::\_C6F580E4C94926AC("CHAR_ACTING_UP", "CHAR_ACTING_UP", 0, 0, "DI_FEED_CHAR", a\_0);
]]
native "_END_TEXT_COMMAND_THEFEED_POST_REPLAY_ICON"
hash "0xD202B92CBF1D816F"
arguments {
int "eType" [=[ {} ]=],
int "iIcon" [=[ {} ]=],
charPtr "sTitle" [=[ {} ]=],
}
alias "0xD202B92CBF1D816F"
alias "_DRAW_NOTIFICATION_WITH_ICON"
ns "HUD"
returns "int"
doc [[!
```
returns a notification handle, prints out a notification like below:
type range: 0
if you set type to 1, image goes from 0 - 39 - Xbox you can add text to
example:
UI::_0xD202B92CBF1D816F(1, 20, "Who you trynna get crazy with, ese? Don't you know I'm LOCO?!");
```
]]
native "_END_TEXT_COMMAND_THEFEED_POST_REPLAY_INPUT"
hash "0xDD6CB2CCE7C2735C"
arguments {
int "type" [=[ {} ]=],
charPtr "button" [=[ {} ]=],
charPtr "text" [=[ {} ]=],
}
alias "0xDD6CB2CCE7C2735C"
alias "_DRAW_NOTIFICATION_WITH_BUTTON"
ns "HUD"
returns "int"
doc [[!
```
returns a notification handle, prints out a notification like below:
type range: 0 - 2
if you set type to 1, button accepts "~INPUT_SOMETHING~"
example:
HUD::_0xDD6CB2CCE7C2735C(1, "~INPUT_TALK~", "Who you trynna get crazy with, ese? Don't you know I'm LOCO?!");
- imgur.com/UPy0Ial
Examples from the scripts:
l_D1[1/*1*/]=HUD::_DD6CB2CCE7C2735C(1,"~INPUT_REPLAY_START_STOP_RECORDING~","");
l_D1[2/*1*/]=HUD::_DD6CB2CCE7C2735C(1,"~INPUT_SAVE_REPLAY_CLIP~","");
l_D1[1/*1*/]=HUD::_DD6CB2CCE7C2735C(1,"~INPUT_REPLAY_START_STOP_RECORDING~","");
l_D1[2/*1*/]=HUD::_DD6CB2CCE7C2735C(1,"~INPUT_REPLAY_START_STOP_RECORDING_SECONDARY~","");
```
]]
native "_GET_AI_BLIP"
hash "0x56176892826A4FE8"
jhash (0xCA52CF43)
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0x56176892826A4FE8"
ns "HUD"
returns "Blip"
doc [[!
```
Returns the current AI BLIP for the specified ped
```
]]
native "_GET_AI_BLIP_2"
hash "0x7CD934010E115C2C"
jhash (0x06349065)
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0x7CD934010E115C2C"
ns "HUD"
annotations [=[ {"cs_type":"void"} ]=]
returns "Blip"
doc [[!
]]
native "_GET_BLIP_ROTATION"
hash "0x003E92BA477F9D7F"
arguments {
Blip "blip" [=[ {} ]=],
}
alias "0x003E92BA477F9D7F"
ns "HUD"
returns "int"
doc [[!
```
NativeDB Introduced: v2060
```
]]
native "_GET_CLOSEST_BLIP_OF_TYPE"
hash "0xD484BF71050CA1EE"
arguments {
int "blipSprite" [=[ {} ]=],
}
alias "0xD484BF71050CA1EE"
ns "HUD"
returns "Blip"
doc [[!
```
NativeDB Introduced: v1180
```
]]
native "_GET_NORTH_RADAR_BLIP"
hash "0x3F0CF9CB7E589B88"
alias "0x3F0CF9CB7E589B88"
ns "HUD"
returns "Blip"
doc [[!
]]
native "_GET_PAUSE_MENU_CURSOR_POSITION"
hash "0x5BFF36D6ED83E0AE"
alias "0x5BFF36D6ED83E0AE"
ns "HUD"
returns "Vector3"
doc [[!
Name between `GET_ONSCREEN_KEYBOARD_RESULT` and `GET_PAUSE_MENU_STATE`. Likely, `GET_PAUSE_MENU_*`.
If the pause menu is open, it will return a Vector3, Z is always 0.
If the pause menu is closed, it will return Vector3.Zero
]]
native "_GET_PAUSE_MENU_SELECTION"
hash "0x36C1451A88A09630"
jhash (0x8543AAC8)
arguments {
intPtr "lastItemMenuId" [=[ {"cs_type":"AnyPtr"} ]=],
intPtr "selectedItemUniqueId" [=[ {"cs_type":"AnyPtr"} ]=],
}
alias "0x36C1451A88A09630"
ns "HUD"
returns "void"
doc [[!
]]
native "_GET_PAUSE_MENU_SELECTION_DATA"
hash "0x7E17BE53E1AAABAF"
jhash (0x6025AA2F)
arguments {
intPtr "lastItemMenuId" [=[ {} ]=],
intPtr "selectedItemMenuId" [=[ {} ]=],
intPtr "selectedItemUniqueId" [=[ {} ]=],
}
alias "0x7E17BE53E1AAABAF"
ns "HUD"
returns "void"
doc [[!
```
lastItemMenuId: this is the menuID of the last selected item minus 1000 (lastItem.menuID - 1000)
selectedItemMenuId: same as lastItemMenuId except for the currently selected menu item
selectedItemUniqueId: this is uniqueID of the currently selected menu item
when the pausemenu is closed:
lastItemMenuId = -1
selectedItemMenuId = -1
selectedItemUniqueId = 0
when the header gains focus:
lastItemMenuId updates as normal or 0 if the pausemenu was just opened
selectedItemMenuId becomes a unique id for the pausemenu page that focus was taken from (?) or 0 if the pausemenu was just opened
selectedItemUniqueId = -1
when focus is moved from the header to a pausemenu page:
lastItemMenuId becomes a unique id for the pausemenu page that focus was moved to (?)
selectedItemMenuId = -1
selectedItemUniqueId updates as normal
```
]]
native "_GET_TEXT_SUBSTRING"
hash "0x169BD9382084C8C0"
jhash (0x34A396EE)
arguments {
charPtr "text" [=[ {} ]=],
int "position" [=[ {} ]=],
int "length" [=[ {} ]=],
}
ns "HUD"
returns "charPtr"
doc [[!
```
Returns a substring of a specified length starting at a specified position.
Example:
// Get "STRING" text from "MY_STRING"
subStr = HUD::_GET_TEXT_SUBSTRING("MY_STRING", 3, 6);
```
]]
native "_GET_TEXT_SUBSTRING_SAFE"
hash "0xB2798643312205C5"
jhash (0x0183A66C)
arguments {
charPtr "text" [=[ {} ]=],
int "position" [=[ {} ]=],
int "length" [=[ {} ]=],
int "maxLength" [=[ {} ]=],
}
ns "HUD"
returns "charPtr"
doc [[!
```
Returns a substring of a specified length starting at a specified position. The result is guaranteed not to exceed the specified max length.
NOTE: The 'maxLength' parameter might actually be the size of the buffer that is returned. More research is needed. -CL69
Example:
// Condensed example of how Rockstar uses this function
strLen = HUD::GET_LENGTH_OF_LITERAL_STRING(MISC::GET_ONSCREEN_KEYBOARD_RESULT());
subStr = HUD::_GET_TEXT_SUBSTRING_SAFE(MISC::GET_ONSCREEN_KEYBOARD_RESULT(), 0, strLen, 63);
--
"fm_race_creator.ysc", line 85115:
// parameters modified for clarity
BOOL sub_8e5aa(char *text, int length) {
for (i = 0; i <= (length - 2); i += 1) {
if (!MISC::ARE_STRINGS_EQUAL(HUD::_GET_TEXT_SUBSTRING_SAFE(text, i, i + 1, 1), " ")) {
return FALSE;
}
}
return TRUE;
}
```
]]
native "_GET_TEXT_SUBSTRING_SLICE"
hash "0xCE94AEBA5D82908A"
jhash (0xFA6373BB)
arguments {
charPtr "text" [=[ {} ]=],
int "startPosition" [=[ {} ]=],
int "endPosition" [=[ {} ]=],
}
ns "HUD"
returns "charPtr"
doc [[!
```
Returns a substring that is between two specified positions. The length of the string will be calculated using (endPosition - startPosition).
Example:
// Get "STRING" text from "MY_STRING"
subStr = HUD::_GET_TEXT_SUBSTRING_SLICE("MY_STRING", 3, 9);
// Overflows are possibly replaced with underscores (needs verification)
subStr = HUD::_GET_TEXT_SUBSTRING_SLICE("MY_STRING", 3, 10); // "STRING_"?
```
]]
native "_GET_WARNING_MESSAGE_TITLE_HASH"
hash "0x81DF9ABA6C83DFF9"
ns "HUD"
returns "Hash"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "_HAS_DIRECTOR_MODE_BEEN_TRIGGERED"
hash "0xA277800A9EAE340E"
alias "0xA277800A9EAE340E"
ns "HUD"
returns "BOOL"
doc [[!
```
HAS_*
```
]]
native "_HIDE_AREA_AND_VEHICLE_NAME_THIS_FRAME"
hash "0xA4DEDE28B1814289"
jhash (0x52746FE1)
alias "0xA4DEDE28B1814289"
ns "HUD"
returns "void"
doc [[!
```
HIDE_*_THIS_FRAME
Hides area and vehicle name HUD components for one frame.
```
]]
native "_HUD_DISPLAY_LOADING_SCREEN_TIPS"
hash "0x488043841BBE156F"
alias "0x488043841BBE156F"
ns "HUD"
returns "void"
doc [[!
Displays loading screen tips, requires `_0x56C8B608CFD49854` to be called beforehand.
]]
native "_HUD_WEAPON_WHEEL_GET_SELECTED_HASH"
hash "0xA48931185F0536FE"
jhash (0x22E9F555)
alias "0xA48931185F0536FE"
ns "HUD"
returns "Hash"
doc [[!
```
Returns the weapon hash to the selected/highlighted weapon in the wheel
```
]]
native "_HUD_WEAPON_WHEEL_GET_SLOT_HASH"
hash "0xA13E93403F26C812"
arguments {
int "weaponTypeIndex" [=[ {} ]=],
}
alias "0xA13E93403F26C812"
ns "HUD"
annotations [=[ {"cs_type":"Any"} ]=]
returns "Hash"
doc [[!
```
Returns the weapon hash active in a specific weapon wheel slotList
```
]]
native "_HUD_WEAPON_WHEEL_IGNORE_CONTROL_INPUT"
hash "0x14C9FDCC41F81F63"
jhash (0xE70D1F43)
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0x14C9FDCC41F81F63"
ns "HUD"
returns "void"
doc [[!
```
Sets a global that disables many weapon input tasks (shooting, aiming, etc.). Does not work with vehicle weapons, only used in selector.ysc
```
]]
native "_HUD_WEAPON_WHEEL_IGNORE_SELECTION"
hash "0x0AFC4AF510774B47"
jhash (0xB26FED2B)
alias "_BLOCK_WEAPON_WHEEL_THIS_FRAME"
alias "0x0AFC4AF510774B47"
ns "HUD"
returns "void"
doc [[!
```
Calling this each frame, stops the player from receiving a weapon via the weapon wheel.
```
]]
native "_IS_MULTIPLAYER_CHAT_ACTIVE"
hash "0xB118AF58B5F332A1"
alias "_IS_TEXT_CHAT_ACTIVE"
ns "HUD"
returns "BOOL"
doc [[!
```
Returns whether or not the text chat (MULTIPLAYER_CHAT Scaleform component) is active.
```
]]
native "_IS_WARNING_MESSAGE_ACTIVE_2"
hash "0xAF42195A42C63BBA"
alias "0xAF42195A42C63BBA"
ns "HUD"
returns "BOOL"
doc [[!
```
IS_WARNING_MESSAGE_*
```
]]
native "_LOG_DEBUG_INFO"
hash "0x2162C446DFDF38FD"
jhash (0x2DFD35C7)
arguments {
charPtr "p0" [=[ {} ]=],
}
alias "0x2162C446DFDF38FD"
ns "HUD"
returns "void"
doc [[!
```
Not present in retail version of the game, actual definiton seems to be
_LOG_DEBUG_INFO(const char* category, const char* debugText);
```
]]
native "_OVERRIDE_MULTIPLAYER_CHAT_COLOUR"
hash "0xF47E567B3630DD12"
arguments {
int "p0" [=[ {} ]=],
int "hudColor" [=[ {} ]=],
}
alias "0xF47E567B3630DD12"
ns "HUD"
returns "void"
doc [[!
]]
native "_OVERRIDE_MULTIPLAYER_CHAT_PREFIX"
hash "0x6A1738B4323FE2D9"
arguments {
Hash "gxtEntryHash" [=[ {"cs_type":"Any"} ]=],
}
alias "0x6A1738B4323FE2D9"
ns "HUD"
returns "void"
doc [[!
]]
native "_PAUSE_MENU_DISABLE_BUSYSPINNER"
hash "0x9245E81072704B8A"
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0x9245e81072704b8a"
ns "HUD"
returns "void"
doc [[!
Disables the loading spinner in Pause Menu when switching from one header tab to another.
true to disable and false to re-enable the loading icon.
]]
native "_PAUSE_MENU_GET_INDEX_OF_MOUSE_HOVERED_SLOT"
hash "0x359AF31A4B52F5ED"
alias "0x359AF31A4B52F5ED"
ns "HUD"
returns "int"
doc [[!
If mouse is hovering on a slot, it returns the slot's index, else it returns -1.
]]
native "_PAUSE_MENU_GET_UNIQUE_ID_OF_MOUSE_HOVERED_SLOT"
hash "0x13C4B962653A5280"
alias "0x13C4B962653A5280"
ns "HUD"
returns "int"
doc [[!
If mouse is hovering on a slot, it returns uniqueid of that slot, else it returns -1.
]]
native "_RACE_GALLERY_ADD_BLIP"
hash "0x551DF99658DB6EE8"
jhash (0x786CA0A2)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
alias "0x551DF99658DB6EE8"
ns "HUD"
returns "Any"
doc [[!
```
Add a BLIP_GALLERY at the specific coordinate. Used in fm_maintain_transition_players to display race track points.
```
]]
native "_RACE_GALLERY_FULLSCREEN"
hash "0x5354C5BA2EA868A4"
jhash (0xE4FD20D8)
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0x5354C5BA2EA868A4"
alias "_SET_MAP_FULL_SCREEN"
ns "HUD"
returns "void"
doc [[!
```
If toggle is true, the map is shown in full screen
If toggle is false, the map is shown in normal mode
```
]]
native "_RACE_GALLERY_NEXT_BLIP_SPRITE"
hash "0x1EAE6DD17B7A5EFA"
jhash (0x13E7A5A9)
arguments {
int "spriteId" [=[ {} ]=],
}
alias "0x1EAE6DD17B7A5EFA"
ns "HUD"
returns "void"
doc [[!
```
Sets the sprite of the next BLIP_GALLERY blip, values used in the native scripts: 143 (ObjectiveBlue), 144 (ObjectiveGreen), 145 (ObjectiveRed), 146 (ObjectiveYellow).
```
]]
native "_REMOVE_WARNING_MESSAGE_LIST_ITEMS"
hash "0x6EF54AB721DC6242"
alias "0x6EF54AB721DC6242"
ns "HUD"
returns "void"
doc [[!
]]
native "_SET_ABILITY_BAR_VISIBILITY_IN_MULTIPLAYER"
hash "0x1DFEDD15019315A9"
arguments {
BOOL "visible" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
```
NativeDB Introduced: v1493
```
]]
native "_SET_ALLOW_ABILITY_BAR_IN_MULTIPLAYER"
hash "0x889329C80FE5963C"
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
```
NativeDB Introduced: v1868
```
]]
native "_SET_BLIP_DISPLAY_INDICATOR_ON_BLIP"
hash "0xC4278F70131BAA6D"
jhash (0x6AA6A1CC)
arguments {
Blip "blip" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0xC4278F70131BAA6D"
ns "HUD"
returns "void"
doc [[!
```
Must be toggled before being queued for animation
```
]]
native "_SET_BLIP_SCALE_TRANSFORMATION"
hash "0xCD6524439909C979"
arguments {
Blip "blip" [=[ {} ]=],
float "xScale" [=[ {} ]=],
float "yScale" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
See https://imgur.com/a/lLkEsMN
```
NativeDB Introduced: v1734
```
]]
native "_SET_BLIP_SHRINK"
hash "0x2B6D467DAB714E8D"
jhash (0xC575F0BC)
arguments {
Blip "blip" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x2B6D467DAB714E8D"
ns "HUD"
returns "void"
doc [[!
```
Makes a blip go small when off the minimap.
SET_BLIP_AS_*
```
]]
native "_SET_BLIP_SQUARED_ROTATION"
hash "0xA8B6AFDAC320AC87"
arguments {
Blip "blip" [=[ {} ]=],
float "heading" [=[ {} ]=],
}
alias "0xA8B6AFDAC320AC87"
ns "HUD"
returns "void"
doc [[!
```
Does not require whole number/integer rotations.
```
]]
native "_SET_DIRECTOR_MODE_CLEAR_TRIGGERED_FLAG"
hash "0x2632482FD6B9AB87"
alias "0x2632482FD6B9AB87"
ns "HUD"
returns "void"
doc [[!
```
SET_*
```
]]
native "_SET_HELP_MESSAGE_TEXT_STYLE"
hash "0xB9C362BABECDDC7A"
arguments {
int "style" [=[ {} ]=],
int "hudColor" [=[ {} ]=],
int "alpha" [=[ {} ]=],
int "p3" [=[ {} ]=],
int "p4" [=[ {} ]=],
}
alias "0xB9C362BABECDDC7A"
ns "HUD"
returns "void"
doc [[!
]]
native "_SET_INTERIOR_ZOOM_LEVEL_DECREASED"
hash "0x7EC8ABA5E74B3D7A"
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0x7EC8ABA5E74B3D7A"
ns "HUD"
returns "void"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "_SET_INTERIOR_ZOOM_LEVEL_INCREASED"
hash "0x504DFE62A1692296"
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0x504DFE62A1692296"
ns "HUD"
returns "void"
doc [[!
```
NativeDB Introduced: v1493
```
]]
native "_SET_MAIN_PLAYER_BLIP_COLOUR"
hash "0x7B21E0BB01E8224A"
arguments {
int "color" [=[ {} ]=],
}
alias "0x7B21E0BB01E8224A"
ns "HUD"
returns "void"
doc [[!
]]
native "_SET_MINIMAP_ALTITUDE_INDICATOR_LEVEL"
hash "0xD201F3FF917A506D"
jhash (0x0308EDF6)
arguments {
float "altitude" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
alias "_SET_MINIMAP_ATTITUDE_INDICATOR_LEVEL"
ns "HUD"
returns "void"
doc [[!
```
Argument must be 0.0f or above 38.0f, or it will be ignored.
```
```
NativeDB Added Parameter 3: Any p2
```
]]
native "_SET_MISSION_NAME_2"
hash "0xE45087D85F468BC2"
jhash (0x8D9A1734)
arguments {
BOOL "p0" [=[ {} ]=],
charPtr "name" [=[ {} ]=],
}
alias "0xE45087D85F468BC2"
ns "HUD"
returns "void"
doc [[!
]]
native "_SET_MP_GAMER_TAG_DISABLE_PLAYER_HEALTH_SYNC"
hash "0xD29EC58C2F6B5014"
arguments {
int "gamerTagId" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0xD29EC58C2F6B5014"
alias "_SET_MP_GAMER_HEALTH_BAR_DISPLAY"
ns "HUD"
returns "void"
doc [[!
By default, the player health value shown by a gamer tag's health bar is synchronised with the health of the ped it is attached to.
This native disables that behaviour, allowing [`_SET_MP_GAMER_TAG_OVERRIDE_PLAYER_HEALTH`](#\_0x1563FE35E9928E67) to have an effect.
If player health synchronisation should be disabled.
]]
native "_SET_MP_GAMER_TAG_MP_BAG_LARGE_COUNT"
hash "0x9C16459B2324B2CF"
arguments {
int "gamerTagId" [=[ {} ]=],
int "count" [=[ {} ]=],
}
alias "0x9B9AA95688F78DD3"
alias "_SET_MP_GAMER_TAG_UNK"
ns "HUD"
returns "void"
doc [[!
```
displays wanted star above head
```
]]
native "_SET_MP_GAMER_TAG_OVERRIDE_PLAYER_HEALTH"
hash "0x1563FE35E9928E67"
arguments {
int "gamerTagId" [=[ {} ]=],
int "health" [=[ {} ]=],
int "maximumHealth" [=[ {} ]=],
}
alias "0x1563FE35E9928E67"
alias "_SET_MP_GAMER_HEALTH_BAR_MAX"
ns "HUD"
returns "void"
doc [[!
Manually sets the player health value for a gamer tag, using the maximum health to calculate what percentage of the bar should be filled.
Has no effect unless [\_SET_MP_GAMER_TAG_DISABLE_PLAYER_HEALTH_SYNC](#\_0xD29EC58C2F6B5014) has been called prior to disable synchronisation with the attached ped.
The amount the health the player has.
The maximum amount of health the player could have.
]]
native "_SET_MP_GAMER_TAG_USE_VEHICLE_HEALTH"
hash "0xA67F9C46D612B6F1"
jhash (0xB01A5434)
arguments {
int "gamerTagId" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0xA67F9C46D612B6F1"
alias "_SET_MP_GAMER_TAG_ICONS"
ns "HUD"
returns "void"
doc [[!
Sets the health bar of a gamer tag to show the health of the last (or current) vehicle of the ped the gamer tag is attached to.
The vehicle health value is stored separate from the player health and using it won't clear any player health overrides.
If vehicle health should be displayed instead of player health.
]]
native "_SET_MP_GAMER_TAG_VISIBILITY_ALL"
hash "0xEE76FF7E6A0166B0"
jhash (0x767DED29)
arguments {
int "gamerTagId" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0xEE76FF7E6A0166B0"
alias "_SET_MP_GAMER_TAG_"
alias "_SET_MP_GAMER_TAG"
alias "_SET_MP_GAMER_TAG_ENABLED"
ns "HUD"
returns "void"
doc [[!
Sets the visibility of all components of the gamer tag to the specified value.
The new visibility state of all gamer tag components.
]]
native "_SET_PED_AI_BLIP_SPRITE"
hash "0xFCFACD0DB9D7A57D"
arguments {
Ped "ped" [=[ {} ]=],
int "spriteId" [=[ {} ]=],
}
alias "0xFCFACD0DB9D7A57D"
ns "HUD"
returns "void"
doc [[!
]]
native "_SET_PED_HAS_AI_BLIP_WITH_COLOR"
hash "0xB13DCB4C6FAAD238"
arguments {
Ped "ped" [=[ {} ]=],
BOOL "hasCone" [=[ {} ]=],
int "color" [=[ {} ]=],
}
alias "0xB13DCB4C6FAAD238"
ns "HUD"
returns "void"
doc [[!
See [`SET_BLIP_COLOUR`](#\_0x03D7FB09E75D6B7E).
]]
native "_SET_PLAYER_IS_IN_DIRECTOR_MODE"
hash "0x808519373FD336A3"
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0x808519373FD336A3"
alias "_SET_DIRECTOR_MODE"
ns "HUD"
returns "void"
doc [[!
```
If toggle is true, hides special ability bar / character name in the pause menu
If toggle is false, shows special ability bar / character name in the pause menu
SET_PLAYER_*
```
]]
native "_SET_SCRIPT_VARIABLE_2_HUD_COLOUR"
hash "0x16A304E6CB2BFAB9"
jhash (0x6BE3ACA8)
arguments {
int "r" [=[ {} ]=],
int "g" [=[ {} ]=],
int "b" [=[ {} ]=],
int "a" [=[ {} ]=],
}
alias "0x16A304E6CB2BFAB9"
ns "HUD"
returns "void"
doc [[!
```
Sets the color of HUD_COLOUR_SCRIPT_VARIABLE_2
```
]]
native "_SET_USE_WAYPOINT_AS_DESTINATION"
hash "0x6CDD58146A436083"
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0x6CDD58146A436083"
ns "HUD"
returns "void"
doc [[!
Sets a global mode which makes the pause menu map show 'Destination' instead of 'Waypoint' in the key legend on the
bottom of the screen.
`true` to show 'Destination', `false` to show 'Waypoint' (the default)
]]
native "_SET_WARNING_MESSAGE_WITH_ALERT"
hash "0x15803FEC3B9A872B"
arguments {
charPtr "labelTitle" [=[ {} ]=],
charPtr "labelMsg" [=[ {} ]=],
int "p2" [=[ {} ]=],
int "p3" [=[ {} ]=],
charPtr "labelMsg2" [=[ {} ]=],
BOOL "p5" [=[ {"cs_type":"int"} ]=],
int "p6" [=[ {} ]=],
int "p7" [=[ {} ]=],
charPtr "p8" [=[ {} ]=],
charPtr "p9" [=[ {} ]=],
BOOL "background" [=[ {} ]=],
int "errorCode" [=[ {} ]=],
}
alias "0x15803FEC3B9A872B"
alias "_DRAW_FRONTEND_ALERT"
ns "HUD"
annotations [=[ {"cs_type":"Any"} ]=]
returns "void"
doc [[!
instructionalKey enum list:
```
Buttons = {
Empty = 0,
Select = 1, -- (RETURN)
Ok = 2, -- (RETURN)
Yes = 4, -- (RETURN)
Back = 8, -- (ESC)
Cancel = 16, -- (ESC)
No = 32, -- (ESC)
RetrySpace = 64, -- (SPACE)
Restart = 128, -- (SPACE)
Skip = 256, -- (SPACE)
Quit = 512, -- (ESC)
Adjust = 1024, -- (ARROWS)
SpaceKey = 2048, -- (SPACE)
Share = 4096, -- (SPACE)
SignIn = 8192, -- (SPACE)
Continue = 16384, -- (RETURN)
AdjustLeftRight = 32768, -- (SCROLL L/R)
AdjustUpDown = 65536, -- (SCROLL U/D)
Overwrite = 131072, -- (SPACE)
SocialClubSignup = 262144, -- (RETURN)
Confirm = 524288, -- (RETURN)
Queue = 1048576, -- (RETURN)
RetryReturn = 2097152, -- (RETURN)
BackEsc = 4194304, -- (ESC)
SocialClub = 8388608, -- (RETURN)
Spectate = 16777216, -- (SPACE)
OkEsc = 33554432, -- (ESC)
CancelTransfer = 67108864, -- (ESC)
LoadingSpinner = 134217728,
NoReturnToGTA = 268435456, -- (ESC)
CancelEsc = 536870912, -- (ESC)
}
Alt = {
Empty = 0,
No = 1, -- (SPACE)
Host = 2, -- (ESC)
SearchForJob = 4, -- (RETURN)
ReturnKey = 8, -- (TURN)
Freemode = 16, -- (ESC)
}
```
**Result of the example code:**
Label of the alert's title.
Label of the alert's message.
This is an enum, check the description for a list.
This is an enum, check the description for a list.
Label of another message line
usually 0
usually -1
usually 0
unknown label
unknown label
Set to anything other than 0 or false (even any string) and it will draw a background. Setting it to 0 or false will draw no background.
Error code, shown at the bottom left if set to value other than 0.
]]
native "_SHOW_HAS_COMPLETED_INDICATOR_ON_BLIP"
hash "0xCAC2031EBF79B1A8"
arguments {
Blip "blip" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
```
Adds a orange checkmark on top of a given blip handle: https://imgur.com/a/aw5OTMF
_SHOW_FRIEND_INDICATOR_ON_BLIP* - _SHOW_HEADING_INDICATOR_ON_BLIP*
```
```
NativeDB Introduced: v2699
```
]]
native "_SHOW_PURCHASE_INSTRUCTIONAL_BUTTON"
hash "0xF6865E26067B708C"
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
```
NativeDB Introduced: v3407
```
]]
native "_SHOW_SCRIPTED_HUD_COMPONENT_THIS_FRAME"
hash "0x4F38DCA127DAAEA2"
arguments {
int "id" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
SHOW_\*
```
NativeDB Introduced: v1734
```
]]
native "_SHOW_SIGNIN_UI"
hash "0x60E892BA4F5BDCA4"
alias "0x60E892BA4F5BDCA4"
ns "HUD"
returns "void"
doc [[!
]]
native "_THEFEED_DISABLE_LOADING_SCREEN_TIPS"
hash "0x32888337579A5970"
alias "0x32888337579A5970"
alias "_THEFEED_DISABLE"
ns "HUD"
returns "void"
doc [[!
Stops loading screen tips shown by invoking either `0x488043841BBE156F` or `0x15CFA549788D35EF`
]]
native "_THEFEED_DISPLAY_LOADING_SCREEN_TIPS"
hash "0x15CFA549788D35EF"
alias "0x15CFA549788D35EF"
alias "_THEFEED_ENABLE"
ns "HUD"
returns "void"
doc [[!
Displays loading screen tips, requires `0x56C8B608CFD49854` to be called beforehand.
]]
native "_THEFEED_SET_ANIMPOSTFX_COLOR"
hash "0x17430B918701C342"
jhash (0xCF14D7F2)
arguments {
int "red" [=[ {} ]=],
int "green" [=[ {} ]=],
int "blue" [=[ {} ]=],
int "alpha" [=[ {} ]=],
}
alias "0x17430B918701C342"
alias "_SET_NOTIFICATION_FLASH_COLOR"
ns "HUD"
returns "void"
doc [[!
]]
native "_THEFEED_SET_ANIMPOSTFX_COUNT"
hash "0x17AD8C9706BDD88A"
jhash (0x24A97AF8)
arguments {
int "count" [=[ {} ]=],
}
alias "0x17AD8C9706BDD88A"
ns "HUD"
returns "void"
doc [[!
Related to notification color flashing, setting p0 to 0 invalidates a `_SET_NOTIFICATION_FLASH_COLOR` call for the target notification.
]]
native "_THEFEED_SET_ANIMPOSTFX_SOUND"
hash "0x4A0C7C9BB10ABB36"
jhash (0x44018EDB)
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0x4A0C7C9BB10ABB36"
ns "HUD"
returns "void"
doc [[!
```
Requires GAME_STREAM_ENUMS.MSGTEXT. Default sounds: "DPAD_WEAPON_SCROLL" and "HUD_FRONTEND_DEFAULT_SOUNDSET"
```
]]
native "_THEFEED_SET_FLUSH_ANIMPOSTFX"
hash "0xBAE4F9B97CD43B30"
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0xBAE4F9B97CD43B30"
ns "HUD"
returns "void"
doc [[!
```
If true, remove all feed components instantly. Otherwise tween/animate close each component
```
]]
native "_THEFEED_SET_NEXT_POST_BACKGROUND_COLOR"
hash "0x92F0DA1E27DB96DC"
jhash (0x07CE2EA4)
arguments {
int "hudColorIndex" [=[ {} ]=],
}
alias "0x92F0DA1E27DB96DC"
alias "_SET_NOTIFICATION_BACKGROUND_COLOR"
alias "_THEFEED_NEXT_POST_BACKGROUND_COLOR"
ns "HUD"
returns "void"
doc [[!
```
From the decompiled scripts:
HUD::_92F0DA1E27DB96DC(6);
HUD::_92F0DA1E27DB96DC(184);
HUD::_92F0DA1E27DB96DC(190);
sets background color for the next notification
6 = red
184 = green
190 = yellow
Here is a list of some colors that can be used: gyazo.com/68bd384455fceb0a85a8729e48216e15
```
]]
native "0x04655F9D075D0AE5"
hash "0x04655F9D075D0AE5"
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
```
SET_*
```
]]
native "0x0C698D8F099174C7"
hash "0x0C698D8F099174C7"
arguments {
Any "p0" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
```
NativeDB Introduced: v1180
```
]]
native "0x0CF54F20DE43879C"
hash "0x0CF54F20DE43879C"
arguments {
Any "p0" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
]]
native "0x211C4EF450086857"
hash "0x211C4EF450086857"
jhash (0x801D0D86)
ns "HUD"
returns "void"
doc [[!
**This native does absolutely nothing, just a nullsub**
]]
native "0x214CD562A939246A"
hash "0x214CD562A939246A"
jhash (0x812CBE0E)
ns "HUD"
returns "BOOL"
doc [[!
```
HAS_S*
```
]]
native "0x243296A510B562B6"
hash "0x243296A510B562B6"
ns "HUD"
returns "void"
doc [[!
```
NativeDB Introduced: v2060
```
]]
native "0x24A49BEAF468DC90"
hash "0x24A49BEAF468DC90"
arguments {
Any "p0" [=[ {} ]=],
AnyPtr "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
}
ns "HUD"
returns "BOOL"
doc [[!
]]
native "0x2790F4B17D098E26"
hash "0x2790F4B17D098E26"
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
```
SET_F*
```
]]
native "0x2C173AE2BDB9385E"
hash "0x2C173AE2BDB9385E"
arguments {
Blip "blip" [=[ {} ]=],
}
ns "HUD"
returns "int"
doc [[!
GET_BLIP_\*
Seems to always return 0 from what I can tell. I've tried a lot of different blip related natives and it always seems to return 0. Decompiled scripts always pass a blip handle as p0.
The blip to check.
Seems to always return 0 from what I can tell. I've tried a lot of different blip related natives and it always seems to return 0.
]]
native "0x2C9F302398E13141"
hash "0x2C9F302398E13141"
jhash (0xCA95C487)
arguments {
Blip "blip" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
Correct native name lies between SET_BLIP_SPRITE and SET_RADIUS_BLIP_EDGE alphabetically.
]]
native "0x2E22FEFA0100275E"
hash "0x2E22FEFA0100275E"
jhash (0x96863460)
ns "HUD"
returns "BOOL"
doc [[!
]]
native "0x2F057596F2BD0061"
hash "0x2F057596F2BD0061"
jhash (0xC85C4487)
ns "HUD"
returns "BOOL"
doc [[!
```
Appears to return whether the player is using the pause menu store. Can't be sure though.
```
]]
native "0x35A3CD97B2C0A6D2"
hash "0x35A3CD97B2C0A6D2"
arguments {
Blip "blip" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "0x41350B4FC28E3941"
hash "0x41350B4FC28E3941"
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
]]
native "0x4B5B620C9B59ED34"
hash "0x4B5B620C9B59ED34"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
]]
native "0x55F5A5F07134DE60"
hash "0x55F5A5F07134DE60"
jhash (0x7A569F78)
ns "HUD"
returns "void"
doc [[!
```
NativeDB Introduced: v1180
```
]]
native "0x57D760D55F54E071"
hash "0x57D760D55F54E071"
jhash (0x9854485F)
arguments {
int "p0" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
```
FORCE_*
```
]]
native "0x593FEAE1F73392D4"
hash "0x593FEAE1F73392D4"
jhash (0x22CA9F2A)
ns "HUD"
returns "Any"
doc [[!
]]
native "0x62E849B7EB28E770"
hash "0x62E849B7EB28E770"
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
]]
native "0x66E7CB63C97B7D20"
hash "0x66E7CB63C97B7D20"
jhash (0x92DAFA78)
ns "HUD"
returns "Any"
doc [[!
]]
native "0x7C226D5346D4D10A"
hash "0x7C226D5346D4D10A"
arguments {
Any "p0" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
]]
native "0x801879A9B4F4B2FB"
hash "0x801879A9B4F4B2FB"
ns "HUD"
returns "BOOL"
doc [[!
```
IS_*
```
]]
native "0x817B86108EB94E51"
hash "0x817B86108EB94E51"
jhash (0xD2161E77)
arguments {
BOOL "p0" [=[ {} ]=],
AnyPtr "p1" [=[ {} ]=],
AnyPtr "p2" [=[ {} ]=],
AnyPtr "p3" [=[ {} ]=],
AnyPtr "p4" [=[ {} ]=],
AnyPtr "p5" [=[ {} ]=],
AnyPtr "p6" [=[ {} ]=],
AnyPtr "p7" [=[ {} ]=],
AnyPtr "p8" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
```
UI::_817B86108EB94E51(1, &g_189F36._f10CD1[0/*16*/], &g_189F36._f10CD1[1/*16*/], &g_189F36._f10CD1[2/*16*/], &g_189F36._f10CD1[3/*16*/], &g_189F36._f10CD1[4/*16*/], &g_189F36._f10CD1[5/*16*/], &g_189F36._f10CD1[6/*16*/], &g_189F36._f10CD1[7/*16*/]);
```
]]
native "0x8410C5E0CD847B9D"
hash "0x8410C5E0CD847B9D"
ns "HUD"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "0x8F08017F9D7C47BD"
hash "0x8F08017F9D7C47BD"
arguments {
Any "p0" [=[ {} ]=],
AnyPtr "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
ns "HUD"
returns "BOOL"
doc [[!
]]
native "0x98C3CF913D895111"
hash "0x98C3CF913D895111"
arguments {
charPtr "string" [=[ {} ]=],
int "length" [=[ {} ]=],
}
ns "HUD"
returns "charPtr"
doc [[!
```
GET_F*
```
]]
native "0x9FCB3CBFB3EAD69A"
hash "0x9FCB3CBFB3EAD69A"
arguments {
int "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
SET_C\*
```
NativeDB Introduced: v1734
```
]]
native "0xA17784FCA9548D15"
hash "0xA17784FCA9548D15"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
]]
native "0xA238192F33110615"
hash "0xA238192F33110615"
jhash (0x46794EB2)
arguments {
intPtr "p0" [=[ {} ]=],
intPtr "p1" [=[ {} ]=],
intPtr "p2" [=[ {} ]=],
}
ns "HUD"
returns "BOOL"
doc [[!
]]
native "0xB552929B85FC27EC"
hash "0xB552929B85FC27EC"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
]]
native "0xB7B873520C84C118"
hash "0xB7B873520C84C118"
ns "HUD"
returns "void"
doc [[!
SET_C\*
```
NativeDB Introduced: v1734
```
]]
native "0xBA8D65C1C65702E5"
hash "0xBA8D65C1C65702E5"
jhash (0x58612465)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
```
FORCE_*
```
]]
native "0xC2D2AD9EAAE265B8"
hash "0xC2D2AD9EAAE265B8"
ns "HUD"
returns "BOOL"
doc [[!
```
Getter for 0xCD74233600C4EA6B
GET_*
```
]]
native "0xC594B315EDF2D4AF"
hash "0xC594B315EDF2D4AF"
jhash (0x41B0D022)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
]]
native "0xC8E1071177A23BE5"
hash "0xC8E1071177A23BE5"
arguments {
AnyPtr "p0" [=[ {} ]=],
AnyPtr "p1" [=[ {} ]=],
AnyPtr "p2" [=[ {} ]=],
}
ns "HUD"
returns "BOOL"
doc [[!
]]
native "0xCA6B2F7CE32AB653"
hash "0xCA6B2F7CE32AB653"
arguments {
Any "p0" [=[ {} ]=],
AnyPtr "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
ns "HUD"
returns "BOOL"
doc [[!
]]
native "0xCD74233600C4EA6B"
hash "0xCD74233600C4EA6B"
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
```
Setter for 0xC2D2AD9EAAE265B8
SET_*
```
]]
native "0xD1942374085C8469"
hash "0xD1942374085C8469"
arguments {
Any "p0" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
]]
native "0xD2049635DEB9C375"
hash "0xD2049635DEB9C375"
jhash (0xE8D3A910)
ns "HUD"
returns "void"
doc [[!
**This native does absolutely nothing, just a nullsub**
]]
native "0xDAF87174BE7454FF"
hash "0xDAF87174BE7454FF"
arguments {
Any "p0" [=[ {} ]=],
}
ns "HUD"
returns "BOOL"
doc [[!
]]
native "0xDE03620F8703A9DF"
hash "0xDE03620F8703A9DF"
ns "HUD"
returns "Any"
doc [[!
]]
native "0xE4C3B169876D33D7"
hash "0xE4C3B169876D33D7"
arguments {
Any "p0" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "0xE67C6DFD386EA5E7"
hash "0xE67C6DFD386EA5E7"
jhash (0x5476B9FD)
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
]]
native "0xEB81A3DADD503187"
hash "0xEB81A3DADD503187"
ns "HUD"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "0xF13FE2A80C05C561"
hash "0xF13FE2A80C05C561"
jhash (0x850690FF)
ns "HUD"
returns "BOOL"
doc [[!
]]
native "0xF284AC67940C6812"
hash "0xF284AC67940C6812"
jhash (0x7D95AFFF)
ns "HUD"
returns "Any"
doc [[!
]]
native "0xF83D0FEBE75E62C9"
hash "0xF83D0FEBE75E62C9"
arguments {
Blip "blip" [=[ {"cs_type":"Any"} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
float "width" [=[ {"cs_type":"Any"} ]=],
Any "p4" [=[ {} ]=],
float "length" [=[ {"cs_type":"Any"} ]=],
float "heading" [=[ {"cs_type":"Any"} ]=],
Any "p7" [=[ {} ]=],
}
ns "HUD"
returns "void"
doc [[!
```
NativeDB Added Parameter 9: int hudColour
NativeDB Introduced: v1290
```
Sets the 'data' for a cone for a blip
See [here](https://docs.fivem.net/docs/game-references/hud-colors/) for the hud colours for the cone
Name in scripts: `SETUP_FAKE_CONE_DATA()`
For people who don't know how to convert degrees to radians and the other way around:
```
degrees = radians * 180 / pi
radians = degrees * pi / 180
```
A blip from an entity. The entity can not be a ped. The width and length will not change if it is a ped.
\-1.0 in decompiled scripts (unk)
1.0 in decompiled scripts (unk)
Width of the cone (0.0 to ~3.0)
1.0 in decompiled scripts (unk)
Length of the cone. (8.2 is 'normal' sized)
This heading is in radians, this can be calculated with (heading + 180.00) \* (pi/180)
1 in decompiled scripts (unk)
]]
native "_NET_GAMESERVER_BASKET_ADD_ITEM"
hash "0xF30980718C8ED876"
arguments {
AnyPtr "itemData" [=[ {} ]=],
int "quantity" [=[ {} ]=],
}
alias "0xF30980718C8ED876"
alias "_NETWORK_SHOP_BASKET_ADD_ITEM"
ns "NETSHOPPING"
returns "BOOL"
doc [[!
]]
native "_NET_GAMESERVER_BASKET_APPLY_SERVER_DATA"
hash "0xE1A0450ED46A7812"
arguments {
Any "p0" [=[ {} ]=],
AnyPtr "p1" [=[ {} ]=],
}
alias "0xE1A0450ED46A7812"
alias "_NETWORK_SHOP_BASKET_APPLY_SERVER_DATA"
ns "NETSHOPPING"
returns "BOOL"
doc [[!
]]
native "_NET_GAMESERVER_BASKET_DELETE"
hash "0xFA336E7F40C0A0D0"
ns "NETSHOPPING"
returns "BOOL"
doc [[!
```
NativeDB Introduced: v372
```
]]
native "_NET_GAMESERVER_BASKET_END"
hash "0xA65568121DF2EA26"
alias "0xA65568121DF2EA26"
alias "0xE547E9114277098F"
alias "_NETWORK_SHOP_BASKET_END"
ns "NETSHOPPING"
returns "BOOL"
doc [[!
]]
native "_NET_GAMESERVER_BASKET_IS_FULL"
hash "0x27F76CC6C55AD30E"
alias "0x27F76CC6C55AD30E"
alias "_NETWORK_SHOP_BASKET_IS_FULL"
ns "NETSHOPPING"
annotations [=[ {"cs_type":"Any"} ]=]
returns "BOOL"
doc [[!
]]
native "_NET_GAMESERVER_BASKET_START"
hash "0x279F08B1A4B29B7E"
arguments {
intPtr "transactionId" [=[ {"cs_type":"AnyPtr"} ]=],
Hash "categoryHash" [=[ {"cs_type":"int"} ]=],
Hash "actionHash" [=[ {"cs_type":"int"} ]=],
int "flags" [=[ {} ]=],
}
alias "_NETWORK_SHOP_BASKET_START"
ns "NETSHOPPING"
returns "BOOL"
doc [[!
]]
native "_NET_GAMESERVER_BEGIN_SERVICE"
hash "0x3C5FD37B5499582E"
arguments {
intPtr "transactionId" [=[ {} ]=],
Hash "categoryHash" [=[ {} ]=],
Hash "itemHash" [=[ {} ]=],
Hash "actionTypeHash" [=[ {"cs_type":"int"} ]=],
int "value" [=[ {} ]=],
int "flags" [=[ {} ]=],
}
alias "0x3C5FD37B5499582E"
alias "_NETWORK_SHOP_BEGIN_SERVICE"
ns "NETSHOPPING"
returns "BOOL"
doc [[!
]]
native "_NET_GAMESERVER_CATALOG_IS_READY"
hash "0x3C4487461E9B0DCB"
alias "0x3C4487461E9B0DCB"
ns "NETSHOPPING"
returns "BOOL"
doc [[!
]]
native "_NET_GAMESERVER_CATALOG_ITEM_EXISTS"
hash "0xBD4D7EAF8A30F637"
arguments {
charPtr "name" [=[ {} ]=],
}
alias "0xBD4D7EAF8A30F637"
alias "_NETWORK_SHOP_IS_ITEM_UNLOCKED"
alias "_NETWORK_SHOP_DOES_ITEM_EXIST"
ns "NETSHOPPING"
returns "BOOL"
doc [[!
]]
native "_NET_GAMESERVER_CATALOG_ITEM_EXISTS_HASH"
hash "0x247F0F73A182EA0B"
arguments {
Hash "hash" [=[ {} ]=],
}
alias "0x247F0F73A182EA0B"
alias "_NETWORK_SHOP_IS_ITEM_UNLOCKED_HASH"
alias "_NETWORK_SHOP_DOES_ITEM_EXIST_HASH"
ns "NETSHOPPING"
returns "BOOL"
doc [[!
]]
native "_NET_GAMESERVER_CHECKOUT_START"
hash "0x39BE7CEA8D9CC8E6"
arguments {
int "transactionId" [=[ {} ]=],
}
alias "0x39BE7CEA8D9CC8E6"
alias "_NETWORK_SHOP_CHECKOUT_START"
ns "NETSHOPPING"
returns "BOOL"
doc [[!
]]
native "_NET_GAMESERVER_DELETE_CHARACTER_SLOT"
hash "0x51F1A8E48C3D2F6D"
arguments {
int "slot" [=[ {} ]=],
BOOL "transfer" [=[ {} ]=],
Hash "reason" [=[ {"cs_type":"Any"} ]=],
}
alias "0x51F1A8E48C3D2F6D"
ns "NETSHOPPING"
returns "BOOL"
doc [[!
]]
native "_NET_GAMESERVER_DELETE_CHARACTER_SLOT_GET_STATUS"
hash "0x0A6D923DFFC9BD89"
alias "0x0A6D923DFFC9BD89"
ns "NETSHOPPING"
returns "int"
doc [[!
]]
native "_NET_GAMESERVER_DELETE_SET_TELEMETRY_NONCE_SEED"
hash "0x112CEF1615A1139F"
alias "0x112CEF1615A1139F"
alias "_NETWORK_SHOP_DELETE_SET_TELEMETRY_NONCE_SEED"
ns "NETSHOPPING"
annotations [=[ {"cs_type":"Any"} ]=]
returns "BOOL"
doc [[!
]]
native "_NET_GAMESERVER_END_SERVICE"
hash "0xE2A99A9B524BEFFF"
arguments {
int "transactionId" [=[ {} ]=],
}
alias "0xE2A99A9B524BEFFF"
alias "_NETWORK_SHOP_END_SERVICE"
alias "_NETWORK_SHOP_TERMINATE_SERVICE"
ns "NETSHOPPING"
returns "BOOL"
doc [[!
]]
native "_NET_GAMESERVER_GET_BALANCE"
hash "0x35A1B3E1D1315CFA"
arguments {
BOOL "inventory" [=[ {} ]=],
BOOL "playerbalance" [=[ {} ]=],
}
alias "0x35A1B3E1D1315CFA"
ns "NETSHOPPING"
returns "BOOL"
doc [[!
```
Note: only one of the arguments can be set to true at a time
```
]]
native "_NET_GAMESERVER_GET_CATALOG_STATE"
hash "0xCF38DAFBB49EDE5E"
arguments {
intPtr "state" [=[ {"cs_type":"AnyPtr"} ]=],
}
alias "0xCF38DAFBB49EDE5E"
ns "NETSHOPPING"
returns "BOOL"
doc [[!
]]
native "_NET_GAMESERVER_GET_PRICE"
hash "0xC27009422FCCA88D"
arguments {
Hash "itemHash" [=[ {} ]=],
Hash "categoryHash" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
alias "_NETWORK_SHOP_GET_PRICE"
ns "NETSHOPPING"
returns "int"
doc [[!
```
bool is always true in game scripts
```
]]
native "_NET_GAMESERVER_GET_TRANSACTION_MANAGER_DATA"
hash "0x897433D292B44130"
arguments {
intPtr "p0" [=[ {"cs_type":"AnyPtr"} ]=],
BOOLPtr "p1" [=[ {} ]=],
}
alias "0x897433D292B44130"
ns "NETSHOPPING"
returns "BOOL"
doc [[!
]]
native "_NET_GAMESERVER_IS_CATALOG_VALID"
hash "0x2B949A1E6AEC8F6A"
alias "0x2B949A1E6AEC8F6A"
ns "NETSHOPPING"
returns "BOOL"
doc [[!
]]
native "_NET_GAMESERVER_IS_SESSION_REFRESH_PENDING"
hash "0x810E8431C0614BF9"
alias "0x810E8431C0614BF9"
alias "_NETWORK_SHOP_GET_TRANSACTIONS_DISABLED"
ns "NETSHOPPING"
returns "BOOL"
doc [[!
]]
native "_NET_GAMESERVER_IS_SESSION_VALID"
hash "0xB24F0944DA203D9E"
arguments {
int "charSlot" [=[ {} ]=],
}
alias "0xB24F0944DA203D9E"
alias "_NETWORK_SHOP_GET_TRANSACTIONS_ENABLED_FOR_CHARACTER"
ns "NETSHOPPING"
returns "BOOL"
doc [[!
]]
native "_NET_GAMESERVER_SESSION_APPLY_RECEIVED_DATA"
hash "0x2F41D51BA3BCD1F1"
arguments {
int "charSlot" [=[ {} ]=],
}
alias "0x2F41D51BA3BCD1F1"
alias "_NETWORK_SHOP_SESSION_APPLY_RECEIVED_DATA"
ns "NETSHOPPING"
returns "BOOL"
doc [[!
]]
native "_NET_GAMESERVER_SET_TELEMETRY_NONCE_SEED"
hash "0x9507D4271988E1AE"
arguments {
int "p0" [=[ {} ]=],
}
alias "0x9507D4271988E1AE"
alias "_NETWORK_SHOP_SET_TELEMETRY_NONCE_SEED"
ns "NETSHOPPING"
returns "BOOL"
doc [[!
]]
native "_NET_GAMESERVER_START_SESSION"
hash "0xA135AC892A58FC07"
arguments {
int "charSlot" [=[ {} ]=],
}
alias "0xA135AC892A58FC07"
alias "_NETWORK_SHOP_START_SESSION"
ns "NETSHOPPING"
returns "BOOL"
doc [[!
]]
native "_NET_GAMESERVER_TRANSFER_BANK_TO_WALLET"
hash "0xD47A2C1BA117471D"
arguments {
int "charSlot" [=[ {} ]=],
int "amount" [=[ {} ]=],
}
alias "0xD47A2C1BA117471D"
alias "_NETWORK_TRANSFER_BANK_TO_WALLET"
ns "NETSHOPPING"
returns "BOOL"
doc [[!
]]
native "_NET_GAMESERVER_TRANSFER_CASH_GET_STATUS"
hash "0x23789E777D14CE44"
alias "0x23789E777D14CE44"
ns "NETSHOPPING"
returns "int"
doc [[!
```
Same as 0x350AA5EBC03D3BD2
```
]]
native "_NET_GAMESERVER_TRANSFER_CASH_GET_STATUS_2"
hash "0x350AA5EBC03D3BD2"
alias "0x350AA5EBC03D3BD2"
ns "NETSHOPPING"
returns "int"
doc [[!
```
Same as 0x23789E777D14CE44
```
]]
native "_NET_GAMESERVER_TRANSFER_CASH_SET_TELEMETRY_NONCE_SEED"
hash "0x498C1E05CE5F7877"
alias "0x498C1E05CE5F7877"
alias "_NETWORK_SHOP_CASH_TRANSFER_SET_TELEMETRY_NONCE_SEED"
ns "NETSHOPPING"
returns "BOOL"
doc [[!
```
Used to be NETWORK_SHOP_CASH_TRANSFER_SET_TELEMETRY_NONCE_SEED
```
]]
native "_NET_GAMESERVER_TRANSFER_WALLET_TO_BANK"
hash "0xC2F7FE5309181C7D"
arguments {
int "charSlot" [=[ {} ]=],
int "amount" [=[ {} ]=],
}
alias "0xC2F7FE5309181C7D"
alias "_NETWORK_TRANSFER_WALLET_TO_BANK"
ns "NETSHOPPING"
returns "BOOL"
doc [[!
]]
native "_NET_GAMESERVER_USE_SERVER_TRANSACTIONS"
hash "0x7D2708796355B20B"
ns "NETSHOPPING"
returns "BOOL"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "0x0395CB47B022E62C"
hash "0x0395CB47B022E62C"
arguments {
AnyPtr "p0" [=[ {} ]=],
}
ns "NETSHOPPING"
returns "BOOL"
doc [[!
]]
native "0x170910093218C8B9"
hash "0x170910093218C8B9"
arguments {
AnyPtr "p0" [=[ {} ]=],
}
ns "NETSHOPPING"
returns "BOOL"
doc [[!
]]
native "0x357B152EF96C30B6"
hash "0x357B152EF96C30B6"
ns "NETSHOPPING"
returns "Any"
doc [[!
]]
native "0x613F125BA3BD2EB9"
hash "0x613F125BA3BD2EB9"
ns "NETSHOPPING"
returns "BOOL"
doc [[!
]]
native "0x72EB7BA9B69BF6AB"
hash "0x72EB7BA9B69BF6AB"
ns "NETSHOPPING"
returns "BOOL"
doc [[!
]]
native "0x74A0FD0688F1EE45"
hash "0x74A0FD0688F1EE45"
arguments {
int "p0" [=[ {} ]=],
}
ns "NETSHOPPING"
returns "int"
doc [[!
```
NET_GAMESERVER_*
```
]]
native "0x79EDAC677CA62F81"
hash "0x79EDAC677CA62F81"
arguments {
int "transactionId" [=[ {} ]=],
}
ns "NETSHOPPING"
returns "BOOL"
doc [[!
```
NET_GAMESERVER_*
Checks if the transaction status is equal to 3.
NativeDB Introduced: v1365
```
]]
native "0x85F6C9ABA1DE2BCF"
hash "0x85F6C9ABA1DE2BCF"
ns "NETSHOPPING"
returns "Any"
doc [[!
]]
native "0xC13C38E47EA5DF31"
hash "0xC13C38E47EA5DF31"
arguments {
AnyPtr "p0" [=[ {} ]=],
}
ns "NETSHOPPING"
returns "BOOL"
doc [[!
]]
native "0xC830417D630A50F9"
hash "0xC830417D630A50F9"
arguments {
int "transactionId" [=[ {} ]=],
}
ns "NETSHOPPING"
returns "BOOL"
doc [[!
```
NET_GAMESERVER_*
Checks if the transaction status is equal to 1.
NativeDB Introduced: v1365
```
]]
native "0xE3E5A7C64CA2C6ED"
hash "0xE3E5A7C64CA2C6ED"
ns "NETSHOPPING"
returns "Any"
doc [[!
]]
native "ABSF"
hash "0x73D57CFFDD12C355"
jhash (0xAF6F6E0B)
arguments {
float "value" [=[ {} ]=],
}
ns "MISC"
returns "float"
doc [[!
]]
native "ABSI"
hash "0xF0D31AD191A74F87"
jhash (0xB44677C5)
arguments {
int "value" [=[ {} ]=],
}
ns "MISC"
returns "int"
doc [[!
]]
native "ACOS"
hash "0x1D08B970013C34B6"
jhash (0xF4038776)
arguments {
float "p0" [=[ {} ]=],
}
ns "MISC"
returns "float"
doc [[!
]]
native "ACTIVITY_FEED_CREATE"
hash "0x4DCDF92BF64236CD"
arguments {
charPtr "captionString" [=[ {} ]=],
charPtr "condensedCaptionString" [=[ {} ]=],
}
alias "0x4DCDF92BF64236CD"
ns "MISC"
returns "void"
doc [[!
Creates and opens a new activity feed post to start filling in.
**Note**: This is a PS4 related native, resulting in a nullsub on the PC platform. This native won't do anything when invoked.
The main text or caption for the activity feed post. This is the primary message displayed in the feed entry.
A shorter or condensed version of the caption, used in cases where space is limited or a brief summary is required.
]]
native "ADD_HOSPITAL_RESTART"
hash "0x1F464EF988465A81"
jhash (0x4F3E3104)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
}
ns "MISC"
returns "int"
doc [[!
```
Returns the index of the newly created hospital spawn point.
p3 might be radius?
```
]]
native "ADD_POLICE_RESTART"
hash "0x452736765B31FC4B"
jhash (0xE96C29FE)
arguments {
float "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
}
ns "MISC"
returns "Any"
doc [[!
]]
native "ADD_POP_MULTIPLIER_AREA"
hash "0x67F6413D3220E18D"
jhash (0x42BF09B3)
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
float "p6" [=[ {} ]=],
float "p7" [=[ {} ]=],
BOOL "p8" [=[ {} ]=],
}
alias "0x67F6413D3220E18D"
ns "MISC"
returns "int"
doc [[!
```
NativeDB Added Parameter 10: BOOL p9
```
]]
native "ADD_POP_MULTIPLIER_SPHERE"
hash "0x32C7A7E8C43A1F80"
jhash (0xCE4A3D20)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "radius" [=[ {} ]=],
float "pedMultiplier" [=[ {} ]=],
float "vehicleMultiplier" [=[ {} ]=],
BOOL "p6" [=[ {} ]=],
BOOL "p7" [=[ {} ]=],
}
alias "0x32C7A7E8C43A1F80"
ns "MISC"
returns "int"
doc [[!
```
This native is adding a zone, where you can change density settings. For example, you can add a zone on 0.0, 0.0, 0.0 with radius 900.0 and vehicleMultiplier 0.0, and you will not see any new population vehicle spawned in a radius of 900.0 from 0.0, 0.0, 0.0. Returns the id. You can have only 15 zones at the same time. You can remove zone using REMOVE_POP_MULTIPLIER_SPHERE
```
]]
native "ADD_REPLAY_STAT_VALUE"
hash "0x69FE6DC87BD2A5E9"
jhash (0x81216EE0)
arguments {
Any "value" [=[ {} ]=],
}
alias "0x69FE6DC87BD2A5E9"
ns "MISC"
returns "void"
doc [[!
]]
native "ADD_STUNT_JUMP"
hash "0x1A992DA297A4630C"
jhash (0xB630E5FF)
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
float "x3" [=[ {} ]=],
float "y3" [=[ {} ]=],
float "z3" [=[ {} ]=],
float "x4" [=[ {} ]=],
float "y4" [=[ {} ]=],
float "z4" [=[ {} ]=],
float "camX" [=[ {} ]=],
float "camY" [=[ {} ]=],
float "camZ" [=[ {} ]=],
int "unk1" [=[ {} ]=],
int "unk2" [=[ {} ]=],
int "unk3" [=[ {} ]=],
}
ns "MISC"
returns "int"
doc [[!
See description of [`ADD_STUNT_JUMP_ANGLED`](#\_0xBBE5D803A5360CBF) for detailed info. The only difference really is this one does not have the radius (or angle, not sure) floats parameters for entry and landing zones.
Jump entry left far bottom corner coordinate X.
Jump entry left far bottom corner coordinate Y.
Jump entry left far bottom corner coordinate Z.
Jump entry right near top corner coordinate X.
Jump entry right near top corner coordinate Y.
Jump entry right near top corner coordinate Z.
Landing zone end coordinate X.
Landing zone end coordinate Y.
Landing zone end coordinate Z.
Landing zone start coordinate X.
Landing zone start coordinate Y.
Landing zone start coordinate Z.
Stuntcam (cinematic) coordinate x.
Stuntcam (cinematic) coordinate y.
Stuntcam (cinematic) coordinate z.
Unknown, always 150.
Unknown, always 0.
Unknown, always 0.
The ID of the stunt jump that was added.
]]
native "ADD_STUNT_JUMP_ANGLED"
hash "0xBBE5D803A5360CBF"
jhash (0xB9B7E777)
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
float "radius1" [=[ {} ]=],
float "x3" [=[ {} ]=],
float "y3" [=[ {} ]=],
float "z3" [=[ {} ]=],
float "x4" [=[ {} ]=],
float "y4" [=[ {} ]=],
float "z4" [=[ {} ]=],
float "radius2" [=[ {} ]=],
float "camX" [=[ {} ]=],
float "camY" [=[ {} ]=],
float "camZ" [=[ {} ]=],
int "unk1" [=[ {} ]=],
int "unk2" [=[ {} ]=],
int "unk3" [=[ {} ]=],
}
ns "MISC"
returns "int"
doc [[!
Creates a new stunt jump.
The radius1 and radius2 might actually not be a radius at all, but that's what it seems to me testing them in-game. But they may be 'angle' floats instead, considering this native is named ADD_STUNT_JUMP\_**ANGLED**.
Info about the specific 'parameter sections':
**x1, y1, z1, x2, y2, z2 and radius1:**
First coordinates are for the jump entry area, and the radius that will be checked around that area. So if you're not exactly within the coordinates, but you are within the outter radius limit then it will still register as entering the stunt jump. Note as mentioned above, the radius is just a guess, I'm not really sure about it's exact purpose.
**x3, y3, z3, x4, y4, z4 and radius2:**
Next part is the landing area, again starting with the left bottom (nearest to the stunt jump entry zone) coordinate, and the second one being the top right furthest away part of the landing area. Followed by another (most likely) radius float, this is usually slightly larger than the entry zone 'radius' float value, just because you have quite a lot of places where you can land (I'm guessing).
**camX, camY and camZ:**
The final coordinate in this native is the Camera position. Rotation and zoom/FOV is managed by the game itself, you just need to provide the camera location.
**unk1, unk2 and unk3:**
Not sure what these are for, but they're always `150, 0, 0` in decompiled scripts.
Visualized example in-game:

Here is a list of almost all of the stunt jumps from GTA V (taken from decompiled scripts): https://pastebin.com/EW1jBPkY
Entry zone bottom left corner x.
Entry zone bottom left corner y.
Entry zone bottom left corner z.
Entry zone top right corner x.
Entry zone top right corner y.
Entry zone top right corner z.
Probably a "feather" radius for entry zone, you need to enter the jump within the min/max coordinates, or within this radius of those two coordinates.
Landing zone start corner coordinate x.
Landing zone start corner coordinate y.
Landing zone start corner coordinate z.
Landing zone end corner coordinate x.
Landing zone end corner coordinate y.
Landing zone end corner coordinate z.
Probably a "feather" radius for landing zone, you need to land within the min/max coordinates, or within this radius of those two coordinates.
Stunt (cinematic) camera x position.
Stunt (cinematic) camera y position.
Stunt (cinematic) camera z position.
always 150
always 0
always 0
The ID of the stuntjump that was created.
]]
native "ALLOW_MISSION_CREATOR_WARP"
hash "0xDEA36202FC3382DF"
jhash (0x082BA6F2)
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0xDEA36202FC3382DF"
ns "MISC"
returns "void"
doc [[!
]]
native "ARE_PROFILE_SETTINGS_VALID"
hash "0x5AA3BEFA29F03AD4"
jhash (0x46B5A15C)
alias "0x5AA3BEFA29F03AD4"
ns "MISC"
returns "BOOL"
doc [[!
]]
native "ARE_STRINGS_EQUAL"
hash "0x0C515FAB3FF9EA92"
jhash (0x877C0BC5)
arguments {
charPtr "string1" [=[ {} ]=],
charPtr "string2" [=[ {} ]=],
}
ns "MISC"
returns "BOOL"
doc [[!
]]
native "ASIN"
hash "0xC843060B5765DCE7"
jhash (0x998E5CAD)
arguments {
float "value" [=[ {} ]=],
}
ns "MISC"
returns "float"
doc [[!
Returns the inverse sine in radians of the specified value
]]
native "ATAN"
hash "0xA9D1795CD5043663"
jhash (0x7A03CC8E)
arguments {
float "p0" [=[ {} ]=],
}
ns "MISC"
returns "float"
doc [[!
]]
native "ATAN2"
hash "0x8927CBF9D22261A4"
jhash (0x2508AC81)
arguments {
float "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
}
ns "MISC"
returns "float"
doc [[!
]]
native "BEGIN_REPLAY_STATS"
hash "0xE0E500246FF73D66"
jhash (0x17F4F44D)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
]]
native "BLOCK_DISPATCH_SERVICE_RESOURCE_CREATION"
hash "0x9B2BD3773123EA2F"
jhash (0xE0F0684F)
arguments {
int "dispatchService" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x9B2BD3773123EA2F"
ns "MISC"
returns "void"
doc [[!
]]
native "CANCEL_ONSCREEN_KEYBOARD"
hash "0x58A39BE597CE99CD"
jhash (0x196444BB)
alias "0x58A39BE597CE99CD"
alias "_CANCEL_ONSCREEN_KEYBOARD"
ns "MISC"
returns "void"
doc [[!
Closes the onscreen keyboard on console versions of the game.
**NOTE:** Do not use this native in FiveM/PC, because [`UPDATE_ONSCREEN_KEYBOARD`](#\_0x0CF2B696BBF945AE) value doesn't get cleaned up and stays as `0`.
You should use [`FORCE_CLOSE_TEXT_INPUT_BOX`](#\_0x8817605C2BA76200) instead.
]]
native "CANCEL_STUNT_JUMP"
hash "0xE6B7B0ACD4E4B75E"
jhash (0xF43D9821)
ns "MISC"
returns "void"
doc [[!
]]
native "CLEAR_ANGLED_AREA_OF_VEHICLES"
hash "0x11DB3500F042A8AA"
jhash (0xF11A3018)
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
float "width" [=[ {} ]=],
BOOL "p7" [=[ {} ]=],
BOOL "p8" [=[ {} ]=],
BOOL "p9" [=[ {} ]=],
BOOL "p10" [=[ {} ]=],
BOOL "p11" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
```
NativeDB Added Parameter 13: Any p12
```
X dimension of the angled area 'origin'
Y dimension of the angled area 'origin'
Z dimension of the angled area 'origin'
X dimension of the angled area 'extent'
Y dimension of the angled area 'extent'
Z dimension of the angled area 'extent'
Width of the angled area
]]
native "CLEAR_AREA"
hash "0xA56F01F3765B93A0"
jhash (0x854E9AB8)
arguments {
float "X" [=[ {} ]=],
float "Y" [=[ {} ]=],
float "Z" [=[ {} ]=],
float "radius" [=[ {} ]=],
BOOL "p4" [=[ {} ]=],
BOOL "ignoreCopCars" [=[ {} ]=],
BOOL "ignoreObjects" [=[ {} ]=],
BOOL "p7" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
```
Example: CLEAR_AREA(0, 0, 0, 30, true, false, false, false);
```
]]
native "CLEAR_AREA_LEAVE_VEHICLE_HEALTH"
hash "0x957838AAF91BD12D"
jhash (0x20E4FFD9)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "radius" [=[ {} ]=],
BOOL "p4" [=[ {} ]=],
BOOL "p5" [=[ {} ]=],
BOOL "p6" [=[ {} ]=],
BOOL "p7" [=[ {} ]=],
}
alias "0x957838AAF91BD12D"
alias "_CLEAR_AREA_OF_EVERYTHING"
ns "MISC"
returns "void"
doc [[!
```
MISC::_0x957838AAF91BD12D(x, y, z, radius, false, false, false, false); seem to make all objects go away, peds, vehicles etc. All booleans set to true doesn't seem to change anything.
```
]]
native "CLEAR_AREA_OF_COPS"
hash "0x04F8FC8FCF58F88D"
jhash (0x95C53824)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "radius" [=[ {} ]=],
BOOL "createNetEvent" [=[ {"cs_type":"int"} ]=],
}
ns "MISC"
returns "void"
doc [[!
Clears an area of cops at the given coordinates and radius.
The x coordinate of where to clear cops.
The y coordinate of where to clear cops.
The z coordinate of where to clear cops.
The area radius to clear cops.
specifies whether a `CClearAreaEvent` event of should be created for online use.
]]
native "CLEAR_AREA_OF_OBJECTS"
hash "0xDD9B9B385AAC7F5B"
jhash (0xBB720FE7)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "radius" [=[ {} ]=],
int "flags" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
```
I looked through the PC scripts that this site provides you with a link to find. It shows the last param mainly uses, (0, 2, 6, 16, and 17) so I am going to assume it is a type of flag.
```
]]
native "CLEAR_AREA_OF_PEDS"
hash "0xBE31FD6CE464AC59"
jhash (0x25BE7FA8)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "radius" [=[ {} ]=],
BOOL "createNetEvent" [=[ {"cs_type":"int"} ]=],
}
ns "MISC"
returns "void"
doc [[!
Clears an area of peds at the given coordinates and radius.
The x coordinate of where to clear peds.
The y coordinate of where to clear peds.
The z coordinate of where to clear peds.
The area radius to clear peds.
specifies whether a `CClearAreaEvent` event of should be created for online use.
]]
native "CLEAR_AREA_OF_PROJECTILES"
hash "0x0A1CB9094635D1A6"
jhash (0x18DB5434)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "radius" [=[ {} ]=],
BOOL "createNetEvent" [=[ {"cs_type":"int"} ]=],
}
ns "MISC"
returns "void"
doc [[!
Clears an area of projectiles at the given coordinates and radius.
The x coordinate of where to clear projectiles.
The y coordinate of where to clear projectiles.
The z coordinate of where to clear projectiles.
The area radius to clear projectiles.
specifies whether a `CClearAreaEvent` event of should be created for online use.
]]
native "CLEAR_AREA_OF_VEHICLES"
hash "0x01C7B9B38428AEB6"
jhash (0x63320F3C)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "radius" [=[ {} ]=],
BOOL "p4" [=[ {} ]=],
BOOL "p5" [=[ {} ]=],
BOOL "p6" [=[ {} ]=],
BOOL "p7" [=[ {} ]=],
BOOL "p8" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
```
Example: CLEAR_AREA_OF_VEHICLES(0, 0, 0, 10000, false, false, false, false, false);
```
```
NativeDB Added Parameter 10: BOOL p9
```
]]
native "CLEAR_BIT"
hash "0xE80492A9AC099A93"
jhash (0x8BC9E618)
arguments {
intPtr "address" [=[ {} ]=],
int "offset" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
```
This sets bit [offset] of [address] to off.
Example:
MISC::CLEAR_BIT(&bitAddress, 1);
To check if this bit has been enabled:
MISC::IS_BIT_SET(bitAddress, 1); // will return 0 afterwards
```
]]
native "CLEAR_OVERRIDE_WEATHER"
hash "0x338D2E3477711050"
jhash (0x7740EA4E)
ns "MISC"
returns "void"
doc [[!
]]
native "CLEAR_REPLAY_STATS"
hash "0x1B1AB132A16FDA55"
jhash (0xC47DFF02)
ns "MISC"
returns "void"
doc [[!
]]
native "CLEAR_WEATHER_TYPE_NOW_PERSIST_NETWORK"
hash "0x0CF97F497FE7D048"
arguments {
int "transitionTimeInMs" [=[ {"cs_type":"float"} ]=],
}
alias "0x0CF97F497FE7D048"
ns "MISC"
returns "void"
doc [[!
Clears the active weather type after a specific amount of time determined by `transitionTimeInMs`.
Transition time in milliseconds.
]]
native "CLEAR_WEATHER_TYPE_PERSIST"
hash "0xCCC39339BEF76CF5"
jhash (0x6AB757D8)
ns "MISC"
returns "void"
doc [[!
]]
native "COMPARE_STRINGS"
hash "0x1E34710ECD4AB0EB"
jhash (0xFE25A58F)
arguments {
charPtr "str1" [=[ {} ]=],
charPtr "str2" [=[ {} ]=],
BOOL "matchCase" [=[ {} ]=],
int "maxLength" [=[ {} ]=],
}
ns "MISC"
returns "int"
doc [[!
```
Compares two strings up to a specified number of characters.
Parameters:
str1 - String to be compared.
str2 - String to be compared.
matchCase - Comparison will be case-sensitive.
maxLength - Maximum number of characters to compare. A value of -1 indicates an infinite length.
Returns:
A value indicating the relationship between the strings:
<0 - The first non-matching character in 'str1' is less than the one in 'str2'. (e.g. 'A' < 'B', so result = -1)
0 - The contents of both strings are equal.
>0 - The first non-matching character in 'str1' is less than the one in 'str2'. (e.g. 'B' > 'A', so result = 1)
Examples:
MISC::COMPARE_STRINGS("STRING", "string", false, -1); // 0; equal
MISC::COMPARE_STRINGS("TESTING", "test", false, 4); // 0; equal
MISC::COMPARE_STRINGS("R2D2", "R2xx", false, 2); // 0; equal
MISC::COMPARE_STRINGS("foo", "bar", false, -1); // 4; 'f' > 'b'
MISC::COMPARE_STRINGS("A", "A", true, 1); // 0; equal
When comparing case-sensitive strings, lower-case characters are greater than upper-case characters:
MISC::COMPARE_STRINGS("A", "a", true, 1); // -1; 'A' < 'a'
MISC::COMPARE_STRINGS("a", "A", true, 1); // 1; 'a' > 'A'
```
]]
native "CREATE_INCIDENT"
hash "0x3F892CAF67444AE7"
jhash (0xFC5FF7B3)
arguments {
int "dispatchService" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
int "numUnits" [=[ {} ]=],
float "radius" [=[ {} ]=],
intPtr "outIncidentID" [=[ {} ]=],
}
ns "MISC"
returns "BOOL"
doc [[!
```
NativeDB Added Parameter 8: Any p7
NativeDB Added Parameter 9: Any p8
```
Refer to [ENABLE_DISPATCH_SERVICE](#\_0xDC0F817884CDD856) for dispatch types
]]
native "CREATE_INCIDENT_WITH_ENTITY"
hash "0x05983472F0494E60"
jhash (0xBBC35B03)
arguments {
int "dispatchService" [=[ {} ]=],
Ped "ped" [=[ {} ]=],
int "numUnits" [=[ {} ]=],
float "radius" [=[ {} ]=],
intPtr "outIncidentID" [=[ {} ]=],
}
ns "MISC"
returns "BOOL"
doc [[!
```
NativeDB Added Parameter 6: Any p5
NativeDB Added Parameter 7: Any p6
```
Refer to [ENABLE_DISPATCH_SERVICE](#\_0xDC0F817884CDD856) for dispatch types
Returns true if the incident was succesfully made
]]
native "DELETE_INCIDENT"
hash "0x556C1AA270D5A207"
jhash (0x212BD0DC)
arguments {
int "incidentId" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
```
Delete an incident with a given id.
=======================================================
Correction, I have change this to int, instead of int*
as it doesn't use a pointer to the createdIncident.
If you try it you will crash (or) freeze.
=======================================================
```
]]
native "DELETE_STUNT_JUMP"
hash "0xDC518000E39DAE1F"
jhash (0x840CB5DA)
arguments {
int "p0" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
]]
native "DISABLE_HOSPITAL_RESTART"
hash "0xC8535819C450EBA8"
jhash (0x09F49C72)
arguments {
int "hospitalIndex" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
```
The game by default has 5 hospital respawn points. Disabling them all will cause the player to respawn at the last position they were.
```
]]
native "DISABLE_POLICE_RESTART"
hash "0x23285DED6EBD7EA3"
jhash (0x0A280324)
arguments {
int "policeIndex" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
```
Disables the spawn point at the police house on the specified index.
policeIndex: The police house index.
toggle: true to enable the spawn point, false to disable.
- Nacorpio
```
]]
native "DISABLE_STUNT_JUMP_SET"
hash "0xA5272EBEDD4747F6"
jhash (0x644C9FA4)
arguments {
int "p0" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
]]
native "DISPLAY_ONSCREEN_KEYBOARD"
hash "0x00DC833F2568DBF6"
jhash (0xAD99F2CE)
arguments {
int "keyboardType" [=[ {} ]=],
charPtr "windowTitle" [=[ {} ]=],
charPtr "description" [=[ {} ]=],
charPtr "defaultText" [=[ {} ]=],
charPtr "defaultConcat1" [=[ {} ]=],
charPtr "defaultConcat2" [=[ {} ]=],
charPtr "defaultConcat3" [=[ {} ]=],
int "maxInputLength" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
Displays a text input box.
```cpp
enum eKeyboardType
{
ONSCREEN_KEYBOARD_ENGLISH = 0,
ONSCREEN_KEYBOARD_LOCALISED = 1,
ONSCREEN_KEYBOARD_PASSWORD = 2,
ONSCREEN_KEYBOARD_GAMERTAG = 3,
ONSCREEN_KEYBOARD_EMAIL = 4,
ONSCREEN_KEYBOARD_BASIC_ENGLISH = 5,
ONSCREEN_KEYBOARD_FILENAME = 6
};
```
See the list above. Default is `0`.
Text label for the title of the box.
Has no use on PC.
Default text that is written in the input field.
Max number of characters that can be typed (2 - 256).
]]
native "DISPLAY_ONSCREEN_KEYBOARD_WITH_LONGER_INITIAL_STRING"
hash "0xCA78CFA0366592FE"
jhash (0xD2688412)
arguments {
int "keyboardType" [=[ {} ]=],
charPtr "windowTitle" [=[ {} ]=],
charPtr "description" [=[ {"cs_type":"AnyPtr"} ]=],
charPtr "defaultText" [=[ {} ]=],
charPtr "defaultConcat1" [=[ {} ]=],
charPtr "defaultConcat2" [=[ {} ]=],
charPtr "defaultConcat3" [=[ {} ]=],
charPtr "defaultConcat4" [=[ {} ]=],
charPtr "defaultConcat5" [=[ {} ]=],
charPtr "defaultConcat6" [=[ {} ]=],
charPtr "defaultConcat7" [=[ {} ]=],
int "maxInputLength" [=[ {} ]=],
}
alias "0xCA78CFA0366592FE"
alias "_DISPLAY_ONSCREEN_KEYBOARD_2"
ns "MISC"
returns "void"
doc [[!
Displays the text input box with support for input with 500 characters.
See [`DISPLAY_ONSCREEN_KEYBOARD`](#\_0x00DC833F2568DBF6)
Text label of the window title.
Unused on PC.
Default text that is written in the input field.
Value between 2 - 500.
]]
native "DO_AUTO_SAVE"
hash "0x50EEAAD86232EE55"
jhash (0x54C44B1A)
ns "MISC"
returns "void"
doc [[!
]]
native "DOES_POP_MULTIPLIER_AREA_EXIST"
hash "0x1327E2FE9746BAEE"
jhash (0xE933B34A)
arguments {
int "id" [=[ {} ]=],
}
alias "0x1327E2FE9746BAEE"
ns "MISC"
returns "BOOL"
doc [[!
]]
native "DOES_POP_MULTIPLIER_SPHERE_EXIST"
hash "0x171BAFB3C60389F4"
jhash (0xD2B7A5A0)
arguments {
int "id" [=[ {} ]=],
}
alias "0x171BAFB3C60389F4"
ns "MISC"
returns "BOOL"
doc [[!
]]
native "ENABLE_DISPATCH_SERVICE"
hash "0xDC0F817884CDD856"
jhash (0x0B710A51)
arguments {
int "dispatchService" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0xDC0F817884CDD856"
ns "MISC"
returns "void"
doc [[!
Enables or disables the specified 'dispatch service' type. 'Dispatch services' are used for spawning AI response peds/vehicles for events such as a fire in the street (type 3 - DT_FireDepartment), or gunfire in a gang area (type 11 - DT_Gangs).
List of dispatch services:
```cpp
enum eDispatchType
{
DT_Invalid = 0,
DT_PoliceAutomobile = 1,
DT_PoliceHelicopter = 2,
DT_FireDepartment = 3,
DT_SwatAutomobile = 4,
DT_AmbulanceDepartment = 5,
DT_PoliceRiders = 6,
DT_PoliceVehicleRequest = 7,
DT_PoliceRoadBlock = 8,
DT_PoliceAutomobileWaitPulledOver = 9,
DT_PoliceAutomobileWaitCruising = 10,
DT_Gangs = 11,
DT_SwatHelicopter = 13,
DT_PoliceBoat = 14,
DT_ArmyVehicle = 15,
DT_BikerBackup = 15
};
```
Note that 'dispatch service' has nothing to do with the police scanner (audio), to toggle that, use [SET_AUDIO_FLAG](#\_0xB9EFD5C25018725A) with `'PoliceScannerDisabled'`.
The ID of the dispatch service to toggle.
True to enable the dispatch service, false to disable the dispatch service.
]]
native "ENABLE_STUNT_JUMP_SET"
hash "0xE369A5783B866016"
jhash (0x9D1E7785)
arguments {
int "p0" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
]]
native "ENABLE_TENNIS_MODE"
hash "0x28A04B411933F8A6"
jhash (0x0BD3F9EC)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
```
Makes the ped jump around like they're in a tennis match
```
]]
native "END_REPLAY_STATS"
hash "0xA23E821FBDF8A5F2"
jhash (0xCB570185)
ns "MISC"
returns "void"
doc [[!
]]
native "FIND_SPAWN_POINT_IN_DIRECTION"
hash "0x6874E2190B0C1972"
jhash (0x71AEFD77)
arguments {
float "posX" [=[ {} ]=],
float "posY" [=[ {} ]=],
float "posZ" [=[ {} ]=],
float "dirX" [=[ {} ]=],
float "dirY" [=[ {} ]=],
float "dirZ" [=[ {} ]=],
float "distance" [=[ {} ]=],
Vector3Ptr "spawnPoint" [=[ {} ]=],
}
ns "MISC"
returns "BOOL"
doc [[!
```
Finds a position ahead of the player by predicting the players next actions.
The positions match path finding node positions.
When roads diverge, the position may rapidly change between two or more positions. This is due to the engine not being certain of which path the player will take.
```
]]
native "FORCE_GAME_STATE_PLAYING"
hash "0xC0AA53F866B3134D"
jhash (0x5D209F25)
alias "_RESET_LOCALPLAYER_STATE"
ns "MISC"
returns "void"
doc [[!
```
Sets the localplayer playerinfo state back to playing (State 0)
States are:
-1: "Invalid"
0: "Playing"
1: "Died"
2: "Arrested"
3: "Failed Mission"
4: "Left Game"
5: "Respawn"
6: "In MP Cutscene"
```
]]
native "FORCE_LIGHTNING_FLASH"
hash "0xF6062E089251C898"
jhash (0xDF38165E)
alias "_CREATE_LIGHTNING_THUNDER"
ns "MISC"
returns "void"
doc [[!
```
creates single lightning+thunder at random position
```
]]
native "GET_ALLOCATED_STACK_SIZE"
hash "0x8B3CA62B1EF19B62"
jhash (0x4E9CA30A)
ns "MISC"
returns "int"
doc [[!
]]
native "GET_ANGLE_BETWEEN_2D_VECTORS"
hash "0x186FC4BE848E1C92"
jhash (0xDBF75E58)
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
}
ns "MISC"
returns "float"
doc [[!
]]
native "GET_BITS_IN_RANGE"
hash "0x53158863FCC0893A"
jhash (0xCA03A1E5)
arguments {
int "var" [=[ {} ]=],
int "rangeStart" [=[ {} ]=],
int "rangeEnd" [=[ {} ]=],
}
ns "MISC"
returns "int"
doc [[!
]]
native "GET_COORDS_OF_PROJECTILE_TYPE_IN_AREA"
hash "0x8D7A43EC6A5FEA45"
jhash (0x1A40454B)
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
Hash "projectileHash" [=[ {} ]=],
Vector3Ptr "projectilePos" [=[ {} ]=],
BOOL "ownedByPlayer" [=[ {} ]=],
}
alias "0x8D7A43EC6A5FEA45"
alias "_GET_IS_PROJECTILE_TYPE_IN_AREA"
ns "MISC"
returns "BOOL"
doc [[!
]]
native "GET_COORDS_OF_PROJECTILE_TYPE_WITHIN_DISTANCE"
hash "0xDFB4138EEFED7B81"
jhash (0x6BDE5CE4)
arguments {
Ped "ped" [=[ {} ]=],
Hash "weaponHash" [=[ {} ]=],
float "distance" [=[ {} ]=],
Vector3Ptr "outCoords" [=[ {} ]=],
BOOL "ownedByPlayer" [=[ {} ]=],
}
alias "0xDFB4138EEFED7B81"
alias "_GET_PROJECTILE_NEAR_PED_COORDS"
ns "MISC"
returns "BOOL"
doc [[!
]]
native "GET_DISTANCE_BETWEEN_COORDS"
hash "0xF1B760881820C952"
jhash (0xF698765E)
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
BOOL "useZ" [=[ {} ]=],
}
ns "MISC"
returns "float"
doc [[!
Returns the distance between two three-dimensional points, optionally ignoring the Z values.
If useZ is false, only the 2D plane (X-Y) will be considered for calculating the distance.
Consider using this faster native instead: SYSTEM::VDIST - DVIST always takes in consideration the 3D coordinates.
The X coordinate of the first point.
The Y coordinate of the first point.
The Z coordinate of the first point.
The X coordinate of the second point.
The Y coordinate of the second point.
The Z coordinate of the second point.
Whether or not to use the Z coordinate.
The distance between the passed points in units.
]]
native "GET_FAKE_WANTED_LEVEL"
hash "0x4C9296CBCD1B971E"
jhash (0x0022A430)
alias "0x4C9296CBCD1B971E"
ns "MISC"
returns "int"
doc [[!
]]
native "GET_FRAME_COUNT"
hash "0xFC8202EFC642E6F2"
jhash (0xB477A015)
ns "MISC"
returns "int"
doc [[!
Gets the number of the current frame being displayed.
The number of the current frame being displayed.
]]
native "GET_FRAME_TIME"
hash "0x15C40837039FFAF7"
jhash (0x96374262)
ns "MISC"
returns "float"
doc [[!
Gets the high precision frame time of the last frame in seconds.
*note: the example above is way less precise.*
The frame time (in seconds) of the last frame.
]]
native "GET_GAME_TIMER"
hash "0x9CD27B0045628463"
jhash (0xA4EA0691)
ns "MISC"
returns "int"
doc [[!
]]
native "GET_GROUND_Z_AND_NORMAL_FOR_3D_COORD"
hash "0x8BDC7BFC57A81E76"
jhash (0x64D91CED)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
floatPtr "groundZ" [=[ {} ]=],
Vector3Ptr "normal" [=[ {} ]=],
}
alias "0x8BDC7BFC57A81E76"
alias "_GET_GROUND_Z_COORD_WITH_OFFSETS"
ns "MISC"
returns "BOOL"
doc [[!
Attempts to identify the highest ground Z-coordinate and determine the corresponding surface normal directly beneath a specified 3D coordinate.
```
NativeDB Introduced: v323
```
X-coordinate of the point to check.
Y-coordinate of the point to check.
Z-coordinate of the point to check.
A pointer to a float where the ground Z-coordinate will be stored if found.
A pointer to a Vector3 structure where the surface normal at the ground point will be stored.
Returns `true` if ground is found below the given coordinates and the surface normal could be determined, otherwise `false`.
]]
native "GET_GROUND_Z_EXCLUDING_OBJECTS_FOR_3D_COORD"
hash "0x9E82F0F362881B29"
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
floatPtr "groundZ" [=[ {} ]=],
BOOL "waterAsGround" [=[ {} ]=],
}
alias "0x9E82F0F362881B29"
alias "_GET_GROUND_Z_FOR_3D_COORD_2"
ns "MISC"
returns "BOOL"
doc [[!
Determines the highest ground Z-coordinate directly below a specified 3D coordinate, excluding any objects at that point. Optionally, water can be considered as ground when determining the highest point.
```
NativeDB Added Parameter 6: BOOL ignoreDistToWaterLevelCheck - If set to true, the distance to the water level will be ignored when checking for water as ground.
```
```
NativeDB Introduced: v505
```
X-coordinate of the point to check.
Y-coordinate of the point to check.
Z-coordinate of the point to check.
A pointer to a float where the ground Z-coordinate will be stored if found.
If set to `true`, water will be included in the check, and its height will be returned if it is higher than the ground level.
Returns `true` if ground (or water, if specified) is found below the given coordinates, otherwise `false`.
]]
native "GET_GROUND_Z_FOR_3D_COORD"
hash "0xC906A7DAB05C8D2B"
jhash (0xA1BFD5E0)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
floatPtr "groundZ" [=[ {} ]=],
BOOL "includeWater" [=[ {} ]=],
}
ns "MISC"
returns "BOOL"
doc [[!
This native gets the ground level (ground elevation) and returns the Z coordinate that represents it.
Note: This native can only calculate the elevation when the coordinates are within the render distance of the client.
```
NativeDB Added Parameter 6: BOOL p5
```
Position on the X-axis to get ground elevation.
Position on the Y-axis to get ground elevation.
Position on the Z-axis to get ground elevation.
Determines if the top water level at the specified position should be considered the ground elevation. (It would only matter if the specified position is located above or under the water)
This native\`s first return value (retval) will return true if the ground elevation has been found, and the second (groundZ) will return the z-coord which represents the ground elevation at the specified position.
]]
native "GET_HASH_KEY"
hash "0xD24D37CC275948CC"
jhash (0x98EFF6F1)
arguments {
charPtr "string" [=[ {} ]=],
}
ns "MISC"
returns "Hash"
doc [[!
This native converts its past string to hash. It is hashed using jenkins one at a time method.
The string to hash.
The hash of `string`.
]]
native "GET_HEADING_FROM_VECTOR_2D"
hash "0x2FFB6B224F4B2926"
jhash (0xD209D52B)
arguments {
float "dx" [=[ {} ]=],
float "dy" [=[ {} ]=],
}
ns "MISC"
returns "float"
doc [[!
```
dx = x1 - x2
dy = y1 - y2
```
]]
native "GET_INDEX_OF_CURRENT_LEVEL"
hash "0xCBAD6729F7B1F4FC"
jhash (0x6F203C6E)
ns "MISC"
returns "int"
doc [[!
]]
native "GET_IS_AUTO_SAVE_OFF"
hash "0x6E04F06094C87047"
jhash (0xA8546914)
alias "0x6E04F06094C87047"
ns "MISC"
returns "BOOL"
doc [[!
```
Returns true if profile setting 208 is equal to 0.
```
]]
native "GET_LINE_PLANE_INTERSECTION"
hash "0xF56DFB7B61BE7276"
jhash (0xC6CC812C)
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
float "planeX" [=[ {} ]=],
float "planeY" [=[ {} ]=],
float "planeZ" [=[ {} ]=],
float "planeNormalX" [=[ {} ]=],
float "planeNormalY" [=[ {} ]=],
float "planeNormalZ" [=[ {} ]=],
floatPtr "intersectionParameter" [=[ {} ]=],
}
alias "0xF56DFB7B61BE7276"
ns "MISC"
returns "BOOL"
doc [[!
Determines whether a line segment intersects a plane and, if so, returns the parameter value at which this intersection occurs.
```
NativeDB Introduced: v323
```
The X-coordinate of the first point of the line segment.
The Y-coordinate of the first point of the line segment.
The Z-coordinate of the first point of the line segment. Together, `x1`, `y1`, and `z1` define the starting point of the line segment.
The X-coordinate of the second point of the line segment.
The Y-coordinate of the second point of the line segment.
The Z-coordinate of the second point of the line segment. Together, `x2`, `y2`, and `z2` define the ending point of the line segment.
The X-coordinate of a point on the plane. This, along with `planeY` and `planeZ`, specifies a point that lies on the plane's surface.
The Y-coordinate of a point on the plane.
The Z-coordinate of a point on the plane.
The X-component of the plane's normal vector. The normal vector is perpendicular to the plane's surface and defines its orientation.
The Y-component of the plane's normal vector.
The Z-component of the plane's normal vector. Together, `planeNormalX`, `planeNormalY`, and `planeNormalZ` fully describe the plane's orientation in 3D space.
A pointer to a float. This parameter is used to return the value of `t` at which the line segment intersects the plane. The value of `t` is a scalar multiplier that can be used to calculate the exact intersection point on the line segment. If the line does not intersect the plane, the value of `t` is not meaningful.
Returns `true` if the line segment intersects the plane, in which case the `intersectionParameter` will contain the intersection point's parameter value. Returns `false` if there is no intersection, making the `intersectionParameter` value irrelevant.
]]
native "GET_MISSION_FLAG"
hash "0xA33CDCCDA663159E"
jhash (0x95115F97)
ns "MISC"
returns "BOOL"
doc [[!
]]
native "GET_MODEL_DIMENSIONS"
hash "0x03E8D3D5F549087A"
jhash (0x91ABB8E0)
arguments {
Hash "modelHash" [=[ {} ]=],
Vector3Ptr "minimum" [=[ {} ]=],
Vector3Ptr "maximum" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
```
Gets the dimensions of a model.
Calculate (maximum - minimum) to get the size, in which case, Y will be how long the model is.
Example from the scripts: MISC::GET_MODEL_DIMENSIONS(ENTITY::GET_ENTITY_MODEL(PLAYER::PLAYER_PED_ID()), &v_1A, &v_17);
```
]]
native "GET_NEXT_WEATHER_TYPE_HASH_NAME"
hash "0x711327CD09C8F162"
jhash (0x353E8056)
alias "_GET_NEXT_WEATHER_TYPE"
ns "MISC"
returns "Hash"
doc [[!
Refer to [`SET_WEATHER_TYPE_NOW`](#\_0x29B487C359E19889) for weather types.
]]
native "GET_NUM_SUCCESSFUL_STUNT_JUMPS"
hash "0x996DD1E1E02F1008"
jhash (0x006F9BA2)
alias "0x996DD1E1E02F1008"
ns "MISC"
returns "int"
doc [[!
]]
native "GET_NUMBER_OF_FREE_STACKS_OF_THIS_SIZE"
hash "0xFEAD16FC8F9DFC0F"
jhash (0x11A178B8)
arguments {
int "stackSize" [=[ {} ]=],
}
alias "_GET_FREE_STACK_SLOTS_COUNT"
ns "MISC"
returns "int"
doc [[!
]]
native "GET_ONSCREEN_KEYBOARD_RESULT"
hash "0x8362B09B91893647"
jhash (0x44828FB3)
ns "MISC"
returns "charPtr"
doc [[!
```
Returns NULL unless UPDATE_ONSCREEN_KEYBOARD() returns 1 in the same tick.
```
]]
native "GET_PREV_WEATHER_TYPE_HASH_NAME"
hash "0x564B884A05EC45A3"
jhash (0xA8171E9E)
alias "_GET_PREV_WEATHER_TYPE"
ns "MISC"
returns "Hash"
doc [[!
Refer to [`SET_WEATHER_TYPE_NOW`](#\_0x29B487C359E19889) for weather types.
]]
native "GET_PROFILE_SETTING"
hash "0xC488FF2356EA7791"
jhash (0xD374BEBC)
arguments {
int "profileSetting" [=[ {} ]=],
}
ns "MISC"
returns "int"
doc [[!
]]
native "GET_RAIN_LEVEL"
hash "0x96695E368AD855F3"
jhash (0xC9F67F28)
ns "MISC"
returns "float"
doc [[!
]]
native "GET_RANDOM_EVENT_FLAG"
hash "0xD2D57F1D764117B1"
jhash (0x794CC92C)
ns "MISC"
annotations [=[ {"cs_type":"Any"} ]=]
returns "BOOL"
doc [[!
]]
native "GET_RANDOM_FLOAT_IN_RANGE"
hash "0x313CE5879CEB6FCD"
jhash (0x0562C4D0)
arguments {
float "startRange" [=[ {} ]=],
float "endRange" [=[ {} ]=],
}
ns "MISC"
returns "float"
doc [[!
]]
native "GET_RANDOM_INT_IN_RANGE"
hash "0xD53343AA4FB7DD28"
jhash (0x4051115B)
arguments {
int "startRange" [=[ {} ]=],
int "endRange" [=[ {} ]=],
}
ns "MISC"
returns "int"
doc [[!
]]
native "GET_REPLAY_STAT_AT_INDEX"
hash "0x8098C8D6597AAE18"
jhash (0x22BE2423)
arguments {
int "index" [=[ {} ]=],
}
alias "0x8098C8D6597AAE18"
ns "MISC"
returns "int"
doc [[!
]]
native "GET_REPLAY_STAT_COUNT"
hash "0xDC9274A7EF6B2867"
jhash (0xC7BD1AF0)
alias "0xDC9274A7EF6B2867"
ns "MISC"
returns "int"
doc [[!
]]
native "GET_REPLAY_STAT_MISSION_TYPE"
hash "0x2B626A0150E4D449"
jhash (0x710E5D1E)
alias "0x2B626A0150E4D449"
ns "MISC"
returns "int"
doc [[!
]]
native "GET_SIZE_OF_SAVE_DATA"
hash "0xA09F896CE912481F"
jhash (0x9EF0BC64)
arguments {
BOOL "p0" [=[ {} ]=],
}
alias "0xA09F896CE912481F"
ns "MISC"
returns "int"
doc [[!
]]
native "GET_SNOW_LEVEL"
hash "0xC5868A966E5BE3AE"
jhash (0x1B09184F)
ns "MISC"
annotations [=[ {"cs_type":"Any"} ]=]
returns "float"
doc [[!
]]
native "GET_STATUS_OF_MISSION_REPEAT_SAVE"
hash "0x2B5E102E4A42F2BF"
jhash (0x144AAF22)
alias "0x2B5E102E4A42F2BF"
ns "MISC"
returns "int"
doc [[!
]]
native "GET_TENNIS_SWING_ANIM_COMPLETE"
hash "0x17DF68D720AA77F8"
jhash (0x8501E727)
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0x17DF68D720AA77F8"
ns "MISC"
returns "BOOL"
doc [[!
]]
native "GET_TOTAL_SUCCESSFUL_STUNT_JUMPS"
hash "0x6856EC3D35C81EA4"
jhash (0x495BE324)
alias "0x6856EC3D35C81EA4"
ns "MISC"
returns "int"
doc [[!
]]
native "GET_WIND_DIRECTION"
hash "0x1F400FEF721170DA"
jhash (0x89499A0D)
ns "MISC"
returns "Vector3"
doc [[!
Used for hunting in singleplayer and for golfing in both sp and online. The [`GET_HEADING_FROM_VECTOR_2D`](#\_0x2FFB6B224F4B2926) native can be used to get the wind heading from the direction.
The wind direction
]]
native "GET_WIND_SPEED"
hash "0xA8CF1CC0AFCD3F12"
jhash (0x098F0F3C)
ns "MISC"
returns "float"
doc [[!
The wind speed in meters per second
]]
native "HAS_BULLET_IMPACTED_IN_AREA"
hash "0x9870ACFB89A90995"
jhash (0x902BC7D9)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "p3" [=[ {} ]=],
BOOL "p4" [=[ {} ]=],
BOOL "p5" [=[ {} ]=],
}
ns "MISC"
returns "BOOL"
doc [[!
```
p3 - possibly radius?
```
]]
native "HAS_BULLET_IMPACTED_IN_BOX"
hash "0xDC8C5D7CFEAB8394"
jhash (0x2C2618CC)
arguments {
float "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
float "p4" [=[ {} ]=],
float "p5" [=[ {} ]=],
BOOL "p6" [=[ {} ]=],
BOOL "p7" [=[ {} ]=],
}
ns "MISC"
returns "BOOL"
doc [[!
]]
native "HAVE_CREDITS_REACHED_END"
hash "0x075F1D57402C93BA"
jhash (0x2569C9A7)
alias "0x075F1D57402C93BA"
ns "MISC"
returns "BOOL"
doc [[!
]]
native "IGNORE_NEXT_RESTART"
hash "0x21FFB63D8C615361"
jhash (0xDA13A4B6)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
]]
native "IS_AREA_OCCUPIED"
hash "0xA61B4DF533DCB56E"
jhash (0xC013972F)
arguments {
float "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
float "p4" [=[ {} ]=],
float "p5" [=[ {} ]=],
BOOL "p6" [=[ {} ]=],
BOOL "p7" [=[ {} ]=],
BOOL "p8" [=[ {} ]=],
BOOL "p9" [=[ {} ]=],
BOOL "p10" [=[ {} ]=],
Any "p11" [=[ {} ]=],
BOOL "p12" [=[ {} ]=],
}
ns "MISC"
returns "BOOL"
doc [[!
]]
native "IS_AUSSIE_VERSION"
hash "0x9F1935CA1F724008"
jhash (0x944BA1DC)
ns "MISC"
returns "BOOL"
doc [[!
```
if (MISC::IS_AUSSIE_VERSION()) {
sub_127a9(&l_31, 1024); // l_31 |= 1024
l_129 = 3;
sub_129d2("AUSSIE VERSION IS TRUE!?!?!"); // DEBUG
}
Used to block some of the prostitute stuff due to laws in Australia.
```
]]
native "IS_AUTO_SAVE_IN_PROGRESS"
hash "0x69240733738C19A0"
jhash (0x36F75399)
ns "MISC"
returns "BOOL"
doc [[!
]]
native "IS_BIT_SET"
hash "0xA921AA820C25702F"
jhash (0x902E26AC)
arguments {
int "address" [=[ {} ]=],
int "offset" [=[ {} ]=],
}
ns "MISC"
returns "BOOL"
doc [[!
```
Returns bit's boolean state from [offset] of [address].
Example:
MISC::IS_BIT_SET(bitAddress, 1);
To enable and disable bits, see:
MISC::SET_BIT(&bitAddress, 1); // enable
MISC::CLEAR_BIT(&bitAddress, 1); // disable
```
]]
native "IS_BULLET_IN_ANGLED_AREA"
hash "0x1A8B5F3C01E2B477"
jhash (0xE2DB58F7)
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
float "width" [=[ {} ]=],
BOOL "ownedByPlayer" [=[ {} ]=],
}
ns "MISC"
returns "BOOL"
doc [[!
See [`IS_POINT_IN_ANGLED_AREA`](#\_0x2A70BAE8883E4C81) for the definition of an angled area.
For projectiles, see: [`IS_PROJECTILE_TYPE_IN_ANGLED_AREA`](#\_0xF0BC12401061DEA0)
X dimension of the angled area 'origin'
Y dimension of the angled area 'origin'
Z dimension of the angled area 'origin'
X dimension of the angled area 'extent'
Y dimension of the angled area 'extent'
Z dimension of the angled area 'extent'
Width of the angled area
True if a bullet, as maintained by a pool within CWeaponManager, has been fired into the defined angled area.
]]
native "IS_BULLET_IN_AREA"
hash "0x3F2023999AD51C1F"
jhash (0xB54F46CA)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "radius" [=[ {} ]=],
BOOL "ownedByPlayer" [=[ {} ]=],
}
ns "MISC"
returns "BOOL"
doc [[!
]]
native "IS_BULLET_IN_BOX"
hash "0xDE0F6D7450D37351"
jhash (0xAB73ED26)
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
BOOL "ownedByPlayer" [=[ {} ]=],
}
ns "MISC"
returns "BOOL"
doc [[!
]]
native "IS_DURANGO_VERSION"
hash "0x4D982ADB1978442D"
jhash (0x46FB06A5)
ns "MISC"
returns "BOOL"
doc [[!
Hard-coded to always return 0.
]]
native "IS_FRONTEND_FADING"
hash "0x7EA2B6AF97ECA6ED"
jhash (0x8FF6232C)
ns "MISC"
returns "BOOL"
doc [[!
```
This function is hard-coded to always return 0.
```
]]
native "IS_INCIDENT_VALID"
hash "0xC8BC6461E629BEAA"
jhash (0x31FD0BA4)
arguments {
int "incidentId" [=[ {} ]=],
}
ns "MISC"
returns "BOOL"
doc [[!
```
=======================================================
Correction, I have change this to int, instead of int*
as it doesn't use a pointer to the createdIncident.
If you try it you will crash (or) freeze.
=======================================================
```
]]
native "IS_JAPANESE_VERSION"
hash "0xB8C0BB75D8A77DB3"
ns "MISC"
returns "BOOL"
doc [[!
```
NativeDB Introduced: 2545
```
Returns `true` when GTA:V is running with the Japanese executable.
]]
native "IS_MEMORY_CARD_IN_USE"
hash "0x8A75CE2956274ADD"
jhash (0x40CE4DFD)
ns "MISC"
returns "BOOL"
doc [[!
]]
native "IS_MINIGAME_IN_PROGRESS"
hash "0x2B4A15E44DE0F478"
jhash (0x53A95E13)
ns "MISC"
returns "BOOL"
doc [[!
]]
native "IS_NEXT_WEATHER_TYPE"
hash "0x2FAA3A30BEC0F25D"
jhash (0x99CB167F)
arguments {
charPtr "weatherType" [=[ {} ]=],
}
ns "MISC"
returns "BOOL"
doc [[!
Refer to [`SET_WEATHER_TYPE_NOW`](#\_0x29B487C359E19889) for weather types.
]]
native "IS_ORBIS_VERSION"
hash "0xA72BC0B675B1519E"
jhash (0x40282018)
ns "MISC"
returns "BOOL"
doc [[!
Hard-coded to always return 0.
]]
native "IS_PC_VERSION"
hash "0x48AF36444B965238"
jhash (0x4D5D9EE3)
ns "MISC"
returns "BOOL"
doc [[!
Hard-coded to always return 1.
]]
native "IS_POINT_OBSCURED_BY_A_MISSION_ENTITY"
hash "0xE54E209C35FFA18D"
jhash (0xC161558D)
arguments {
float "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
float "p4" [=[ {} ]=],
float "p5" [=[ {} ]=],
Any "p6" [=[ {} ]=],
}
ns "MISC"
returns "BOOL"
doc [[!
]]
native "IS_POSITION_OCCUPIED"
hash "0xADCDE75E1C60F32D"
jhash (0x452E8D9E)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "range" [=[ {} ]=],
BOOL "p4" [=[ {} ]=],
BOOL "checkVehicles" [=[ {} ]=],
BOOL "checkPeds" [=[ {} ]=],
BOOL "p7" [=[ {} ]=],
BOOL "p8" [=[ {} ]=],
Entity "ignoreEntity" [=[ {} ]=],
BOOL "p10" [=[ {} ]=],
}
ns "MISC"
returns "BOOL"
doc [[!
The BOOL parameters that are documented have not been confirmed. They are just documented from what I've found during testing. They may not work as expected in all cases.
X coordinate of the position to check.
Y coordinate of the position to check.
Z coordinate of the position to check.
The range, seems to not be very accurate during testing.
Unknown, when set to true it seems to always return true no matter what I try.
Check for any vehicles in that area.
Check for any peds in that area.
Unknown.
Unknown.
This entity will be ignored if it's in the area. Set to 0 if you don't want to exclude any entities.
Unknown.
Returns true if there is anything in that location matching the provided parameters.
]]
native "IS_PREV_WEATHER_TYPE"
hash "0x44F28F86433B10A9"
jhash (0x250ADA61)
arguments {
charPtr "weatherType" [=[ {} ]=],
}
ns "MISC"
returns "BOOL"
doc [[!
Refer to [`SET_WEATHER_TYPE_NOW`](#\_0x29B487C359E19889) for weather types.
]]
native "IS_PROJECTILE_IN_AREA"
hash "0x5270A8FBC098C3F8"
jhash (0x78E1A557)
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
BOOL "ownedByPlayer" [=[ {} ]=],
}
ns "MISC"
returns "BOOL"
doc [[!
```
Determines whether there is a projectile within the specified coordinates. The coordinates form a rectangle.
ownedByPlayer = only projectiles fired by the player will be detected.
```
]]
native "IS_PROJECTILE_TYPE_IN_ANGLED_AREA"
hash "0xF0BC12401061DEA0"
jhash (0xD1AE2681)
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
float "width" [=[ {} ]=],
float "p7" [=[ {} ]=],
Hash "weaponHash" [=[ {"cs_type":"Any"} ]=],
BOOL "ownedByPlayer" [=[ {} ]=],
}
ns "MISC"
returns "BOOL"
doc [[!
See [`IS_POINT_IN_ANGLED_AREA`](#\_0x2A70BAE8883E4C81) for the definition of an angled area.
```
NativeDB Removed Parameter 7: float p7
```
X dimension of the angled area 'origin'
Y dimension of the angled area 'origin'
Z dimension of the angled area 'origin'
X dimension of the angled area 'extent'
Y dimension of the angled area 'extent'
Z dimension of the angled area 'extent'
Width of the angled area
]]
native "IS_PROJECTILE_TYPE_IN_AREA"
hash "0x2E0DC353342C4A6D"
jhash (0x2B73BCF6)
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
int "type" [=[ {} ]=],
BOOL "ownedByPlayer" [=[ {} ]=],
}
ns "MISC"
returns "BOOL"
doc [[!
```
Determines whether there is a projectile of a specific type within the specified coordinates. The coordinates form a axis-aligned bounding box.
```
]]
native "IS_PROJECTILE_TYPE_WITHIN_DISTANCE"
hash "0x34318593248C8FB2"
jhash (0xBE81F1E2)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
Hash "projHash" [=[ {} ]=],
float "radius" [=[ {} ]=],
BOOL "ownedByPlayer" [=[ {} ]=],
}
alias "0x34318593248C8FB2"
alias "_IS_PROJECTILE_TYPE_IN_RADIUS"
ns "MISC"
returns "BOOL"
doc [[!
]]
native "IS_PS3_VERSION"
hash "0xCCA1072C29D096C2"
jhash (0x4C0D5303)
ns "MISC"
returns "BOOL"
doc [[!
Hard-coded to always return 0.
]]
native "IS_SNIPER_BULLET_IN_AREA"
hash "0xFEFCF11B01287125"
jhash (0x0483715C)
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
}
ns "MISC"
returns "BOOL"
doc [[!
```
Determines whether there is a sniper bullet within the specified coordinates. The coordinates form an axis-aligned bounding box.
```
]]
native "IS_SNIPER_INVERTED"
hash "0x61A23B7EDA9BDA24"
jhash (0x5C3BF51B)
ns "MISC"
returns "BOOL"
doc [[!
```
This function is hard-coded to always return 0.
```
]]
native "IS_STEAM_VERSION"
hash "0x0A27B2B6282F7169"
ns "MISC"
returns "BOOL"
doc [[!
```
NativeDB Introduced: 2545
```
Returns `true` when GTA:V is running with the Steam executable.
]]
native "IS_STRING_NULL"
hash "0xF22B6C47C6EAB066"
jhash (0x8E71E00F)
arguments {
charPtr "string" [=[ {} ]=],
}
ns "MISC"
returns "BOOL"
doc [[!
]]
native "IS_STRING_NULL_OR_EMPTY"
hash "0xCA042B6957743895"
jhash (0x42E9F2CA)
arguments {
charPtr "string" [=[ {} ]=],
}
ns "MISC"
returns "BOOL"
doc [[!
]]
native "IS_STUNT_JUMP_IN_PROGRESS"
hash "0x7A3F19700A4D0525"
jhash (0xF477D0B1)
ns "MISC"
returns "BOOL"
doc [[!
]]
native "IS_STUNT_JUMP_MESSAGE_SHOWING"
hash "0x2272B0A1343129F4"
jhash (0x021636EE)
alias "0x2272B0A1343129F4"
ns "MISC"
returns "BOOL"
doc [[!
]]
native "IS_TENNIS_MODE"
hash "0x5D5479D115290C3F"
jhash (0x04A947BA)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "MISC"
returns "BOOL"
doc [[!
]]
native "IS_THIS_A_MINIGAME_SCRIPT"
hash "0x7B30F65D7B710098"
jhash (0x7605EF6F)
ns "MISC"
returns "BOOL"
doc [[!
]]
native "IS_XBOX360_VERSION"
hash "0xF6201B4DAF662A9D"
jhash (0x24005CC8)
ns "MISC"
returns "BOOL"
doc [[!
Hard-coded to always return 0.
]]
native "LOAD_CLOUD_HAT"
hash "0xFC4842A34657BFCB"
jhash (0xED88FC61)
arguments {
charPtr "name" [=[ {} ]=],
float "transitionTime" [=[ {} ]=],
}
alias "_SET_CLOUD_HAT_TRANSITION"
ns "MISC"
returns "void"
doc [[!
```
The following cloudhats are useable:
altostratus
Cirrus
cirrocumulus
Clear 01
Cloudy 01
Contrails
Horizon
horizonband1
horizonband2
horizonband3
horsey
Nimbus
Puffs
RAIN
Snowy 01
Stormy 01
stratoscumulus
Stripey
shower
Wispy
```
]]
native "NETWORK_SET_SCRIPT_IS_SAFE_FOR_NETWORK_GAME"
hash "0x9243BAC96D64C050"
jhash (0x878486CE)
ns "MISC"
returns "void"
doc [[!
]]
native "NEXT_ONSCREEN_KEYBOARD_RESULT_WILL_DISPLAY_USING_THESE_FONTS"
hash "0x3ED1438C1F5C6612"
jhash (0x3301EA47)
arguments {
int "fontBitField" [=[ {} ]=],
}
alias "0x3ED1438C1F5C6612"
ns "MISC"
returns "void"
doc [[!
```cpp
enum eFontBitField
{
FONT_BIT_STANDARD = 1,
FONT_BIT_CURSIVE = 2,
FONT_BIT_ROCKSTAR_TAG = 4
FONT_BIT_LEADERBOARD = 8
FONT_BIT_CONDENSED = 16
FONT_BIT_FIXED_WIDTH_NUMBERS = 32
FONT_BIT_CONDENSED_NOT_GAMERNAME = 64
FONT_BIT_PRICEDOWN = 128
};
```
See the list above.
]]
native "OVERRIDE_SAVE_HOUSE"
hash "0x1162EA8AE9D24EEA"
jhash (0x47436C12)
arguments {
BOOL "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
float "p4" [=[ {} ]=],
BOOL "p5" [=[ {} ]=],
Vector3Ptr "p6" [=[ {} ]=],
floatPtr "p7" [=[ {} ]=],
}
ns "MISC"
returns "BOOL"
doc [[!
]]
native "PAUSE_DEATH_ARREST_RESTART"
hash "0x2C2B3493FBF51C71"
jhash (0x296574AE)
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "_DISABLE_AUTOMATIC_RESPAWN"
ns "MISC"
returns "void"
doc [[!
]]
native "PLAY_TENNIS_DIVE_ANIM"
hash "0x8FA9C42FC5D7C64B"
jhash (0x0C8865DF)
arguments {
Ped "ped" [=[ {} ]=],
int "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
float "p4" [=[ {} ]=],
BOOL "p5" [=[ {} ]=],
}
alias "0x8FA9C42FC5D7C64B"
ns "MISC"
returns "void"
doc [[!
]]
native "PLAY_TENNIS_SWING_ANIM"
hash "0xE266ED23311F24D4"
jhash (0xC20A7D2B)
arguments {
Ped "ped" [=[ {} ]=],
charPtr "animDict" [=[ {} ]=],
charPtr "animName" [=[ {} ]=],
float "p3" [=[ {} ]=],
float "p4" [=[ {} ]=],
BOOL "p5" [=[ {} ]=],
}
alias "0xE266ED23311F24D4"
ns "MISC"
returns "void"
doc [[!
]]
native "POPULATE_NOW"
hash "0x7472BB270D7B4F3E"
jhash (0x72C20700)
ns "MISC"
returns "void"
doc [[!
```
spawns a few distant/out-of-sight peds, vehicles, animals etc each time it is called
```
]]
native "PRELOAD_CLOUD_HAT"
hash "0x11B56FBBF7224868"
jhash (0x8727A4C5)
arguments {
charPtr "name" [=[ {} ]=],
}
alias "0x11B56FBBF7224868"
ns "MISC"
returns "void"
doc [[!
```
Found in the scripts:
MISC::_11B56FBBF7224868("CONTRAILS");
```
]]
native "QUEUE_MISSION_REPEAT_LOAD"
hash "0x72DE52178C291CB5"
jhash (0xF62B3C48)
alias "0x72DE52178C291CB5"
ns "MISC"
annotations [=[ {"cs_type":"Any"} ]=]
returns "BOOL"
doc [[!
]]
native "QUEUE_MISSION_REPEAT_SAVE"
hash "0x44A0BDC559B35F6E"
jhash (0x3589452B)
alias "0x44A0BDC559B35F6E"
ns "MISC"
returns "BOOL"
doc [[!
Shows the screen which is visible before you redo a mission? The game will make a restoration point where you will cameback when the mission is over.
Returns 1 if the message isn't currently on screen.
]]
native "QUIT_GAME"
hash "0xEB6891F03362FB12"
alias "0xEB6891F03362FB12"
alias "_FORCE_SOCIAL_CLUB_UPDATE"
ns "MISC"
returns "void"
doc [[!
Quits the game.
]]
native "REGISTER_BOOL_TO_SAVE"
hash "0xC8F4131414C835A1"
jhash (0x5417E0E0)
arguments {
AnyPtr "p0" [=[ {} ]=],
charPtr "name" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
]]
native "REGISTER_ENUM_TO_SAVE"
hash "0x10C2FA78D0E128A1"
jhash (0x9B38374A)
arguments {
AnyPtr "p0" [=[ {} ]=],
charPtr "name" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
]]
native "REGISTER_FLOAT_TO_SAVE"
hash "0x7CAEC29ECB5DFEBB"
jhash (0xDB06F7AD)
arguments {
AnyPtr "p0" [=[ {} ]=],
charPtr "name" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
]]
native "REGISTER_INT_TO_SAVE"
hash "0x34C9EE5986258415"
jhash (0xB930956F)
arguments {
AnyPtr "p0" [=[ {} ]=],
charPtr "name" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
]]
native "REGISTER_SAVE_HOUSE"
hash "0xC0714D0A7EEECA54"
jhash (0x39C1849A)
arguments {
float "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
AnyPtr "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
Any "p6" [=[ {} ]=],
}
ns "MISC"
returns "Any"
doc [[!
]]
native "REGISTER_TEXT_LABEL_TO_SAVE"
hash "0xEDB1232C5BEAE62F"
jhash (0x284352C4)
arguments {
AnyPtr "p0" [=[ {} ]=],
charPtr "name" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
]]
native "REMOVE_DISPATCH_SPAWN_BLOCKING_AREA"
hash "0x264AC28B01B353A5"
jhash (0xA8D2FB92)
arguments {
Any "p0" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
]]
native "REMOVE_POP_MULTIPLIER_AREA"
hash "0xB129E447A2EDA4BF"
jhash (0xFBDBE374)
arguments {
int "id" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
alias "0xB129E447A2EDA4BF"
ns "MISC"
returns "void"
doc [[!
]]
native "REMOVE_POP_MULTIPLIER_SPHERE"
hash "0xE6869BECDD8F2403"
jhash (0x92E7E4EB)
arguments {
int "id" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
alias "0xE6869BECDD8F2403"
ns "MISC"
returns "void"
doc [[!
]]
native "RESET_DISPATCH_IDEAL_SPAWN_DISTANCE"
hash "0x77A84429DD9F0A15"
jhash (0xDA65ECAA)
ns "MISC"
returns "void"
doc [[!
]]
native "RESET_DISPATCH_SPAWN_BLOCKING_AREAS"
hash "0xAC7BFD5C1D83EA75"
jhash (0x9A17F835)
ns "MISC"
returns "void"
doc [[!
]]
native "RESET_DISPATCH_TIME_BETWEEN_SPAWN_ATTEMPTS"
hash "0xEB2DB0CAD13154B3"
jhash (0x1479E85A)
arguments {
Any "p0" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
```
NativeDB Introduced: v323
```
]]
native "RESTART_GAME"
hash "0xE574A662ACAEFBB1"
alias "0xE574A662ACAEFBB1"
alias "_RESTART_GAME"
ns "MISC"
returns "void"
doc [[!
In singleplayer it does exactly what the name implies. In FiveM / GTA:Online it shows the `Disconnecting from GTA Online` warning screen message and quits the game.
After quitting, the game process is started again (as the name implies).
]]
native "SCRIPT_RACE_GET_PLAYER_SPLIT_TIME"
hash "0x8EF5573A1F801A5C"
jhash (0x07FF553F)
arguments {
Player "player" [=[ {} ]=],
intPtr "p1" [=[ {} ]=],
intPtr "p2" [=[ {} ]=],
}
alias "0x8EF5573A1F801A5C"
ns "MISC"
returns "BOOL"
doc [[!
]]
native "SCRIPT_RACE_INIT"
hash "0x0A60017F841A54F2"
jhash (0x2D33F15A)
arguments {
int "numCheckpoints" [=[ {} ]=],
int "numLaps" [=[ {} ]=],
int "numPlayers" [=[ {} ]=],
Player "localPlayer" [=[ {} ]=],
}
alias "0x0A60017F841A54F2"
ns "MISC"
returns "void"
doc [[!
Initializes a script race in GTA:Online and sets up the helper split time system.
```
NativeDB Introduced: v323
```
The total number of checkpoints in the race
The total number of laps in the race.
The total number of players participating in the race.
Local player in the race.
]]
native "SCRIPT_RACE_PLAYER_HIT_CHECKPOINT"
hash "0x1BB299305C3E8C13"
jhash (0xA27F4472)
arguments {
Ped "ped" [=[ {} ]=],
int "checkpoint" [=[ {} ]=],
int "lap" [=[ {} ]=],
int "time" [=[ {} ]=],
}
alias "0x1BB299305C3E8C13"
ns "MISC"
returns "void"
doc [[!
Records that a player has successfully passed a checkpoint during a scripted race in GTA:Online. This native should be used after initializing the race with [`SCRIPT_RACE_INIT`](#\_0x0A60017F841A54F2).
```
NativeDB Introduced: v323
```
The index of the Ped who hit the checkpoint.
The checkpoint number that the player has passed.
The current lap that the player is on.
The time it took for the player to reach this checkpoint from the start of the race or the last checkpoint.
]]
native "SCRIPT_RACE_SHUTDOWN"
hash "0x1FF6BF9A63E5757F"
jhash (0xDF99925C)
alias "0x1FF6BF9A63E5757F"
ns "MISC"
returns "void"
doc [[!
]]
native "SET_BIT"
hash "0x933D6A9EEC1BACD0"
jhash (0x4EFE7E6B)
arguments {
intPtr "address" [=[ {} ]=],
int "offset" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
```
This sets bit [offset] of [address] to on.
The offsets used are different bits to be toggled on and off, typically there is only one address used in a script.
Example:
MISC::SET_BIT(&bitAddress, 1);
To check if this bit has been enabled:
MISC::IS_BIT_SET(bitAddress, 1); // will return 1 afterwards
Please note, this method may assign a value to [address] when used.
```
]]
native "SET_BITS_IN_RANGE"
hash "0x8EF07E15701D61ED"
jhash (0x32094719)
arguments {
intPtr "var" [=[ {} ]=],
int "rangeStart" [=[ {} ]=],
int "rangeEnd" [=[ {} ]=],
int "p3" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
]]
native "SET_CLOUD_SETTINGS_OVERRIDE"
hash "0x02DEAAC8F8EA7FE7"
arguments {
charPtr "overrideSettingsName" [=[ {} ]=],
}
alias "0x02DEAAC8F8EA7FE7"
ns "MISC"
returns "void"
doc [[!
Overrides the cloud settings, which are normally controlled by the weather, with the specified named version. This native allows for custom cloud formations and behaviors that deviate from the default settings associated with the game's current weather conditions.
```
NativeDB Introduced: v323
```
The name of the cloud settings to use. Use a empty string to clear the override and return to the default settings.
]]
native "SET_CLOUDS_ALPHA"
hash "0xF36199225D6D8C86"
arguments {
float "opacity" [=[ {} ]=],
}
alias "0xF36199225D6D8C86"
alias "_SET_CLOUD_HAT_OPACITY"
ns "MISC"
returns "void"
doc [[!
Allows modification of the cloud opacity. It can also be used in other contexts, such as when the player is in a switch state [`IS_PLAYER_SWITCH_IN_PROGRESS`](#\_0xD9D2CFFF49FAB35F).
The opacity value to set for clouds.
]]
native "SET_CREDITS_ACTIVE"
hash "0xB938B7E6D3C0620C"
jhash (0xEC2A0ECF)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
]]
native "SET_DISPATCH_IDEAL_SPAWN_DISTANCE"
hash "0x6FE601A64180D423"
jhash (0x6283BE32)
arguments {
float "p0" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
]]
native "SET_DISPATCH_SPAWN_LOCATION"
hash "0xD10F442036302D50"
jhash (0x6F009E33)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
alias "0xD10F442036302D50"
ns "MISC"
returns "void"
doc [[!
]]
native "SET_DISPATCH_TIME_BETWEEN_SPAWN_ATTEMPTS"
hash "0x44F7CBC1BEB3327D"
jhash (0xABADB709)
arguments {
Any "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
]]
native "SET_DISPATCH_TIME_BETWEEN_SPAWN_ATTEMPTS_MULTIPLIER"
hash "0x48838ED9937A15D1"
jhash (0x1C996BCD)
arguments {
Any "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
]]
native "SET_EXPLOSIVE_AMMO_THIS_FRAME"
hash "0xA66C71C98D5F2CFB"
jhash (0x2EAFA1D1)
arguments {
Player "player" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
]]
native "SET_EXPLOSIVE_MELEE_THIS_FRAME"
hash "0xFF1BED81BFDC0FE0"
jhash (0x96663D56)
arguments {
Player "player" [=[ {} ]=],
}
ns "MISC"
annotations [=[ {"cs_type":"Any"} ]=]
returns "void"
doc [[!
]]
native "SET_FADE_IN_AFTER_DEATH_ARREST"
hash "0xDA66D2796BA33F12"
jhash (0xACDE6985)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
```
Sets whether the game should fade in after the player dies or is arrested.
```
]]
native "SET_FADE_IN_AFTER_LOAD"
hash "0xF3D78F59DFE18D79"
jhash (0x6E00EB0B)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
]]
native "SET_FADE_OUT_AFTER_ARREST"
hash "0x1E0B4DC0D990A4E7"
jhash (0xCB074B9D)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
```
Sets whether the game should fade out after the player is arrested.
```
]]
native "SET_FADE_OUT_AFTER_DEATH"
hash "0x4A18E01DF2C87B86"
jhash (0xC9F6F0BC)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
```
Sets whether the game should fade out after the player dies.
```
]]
native "SET_FAKE_WANTED_LEVEL"
hash "0x1454F2448DE30163"
jhash (0x85B1C9FA)
arguments {
int "fakeWantedLevel" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
```
Sets a visually fake wanted level on the user interface. Used by Rockstar's scripts to "override" regular wanted levels and make custom ones while the real wanted level and multipliers are still in effect.
Max is 6, anything above this makes it just 6. Also the mini-map gets the red & blue flashing effect.
```
]]
native "SET_FIRE_AMMO_THIS_FRAME"
hash "0x11879CDD803D30F4"
jhash (0x7C18FC8A)
arguments {
Player "player" [=[ {} ]=],
}
ns "MISC"
annotations [=[ {"cs_type":"Any"} ]=]
returns "void"
doc [[!
]]
native "SET_GAME_PAUSED"
hash "0x577D1284D6873711"
jhash (0x8230FF6C)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
```
Make sure to call this from the correct thread if you're using multiple threads because all other threads except the one which is calling SET_GAME_PAUSED will be paused which means you will lose control and the game remains in paused mode until you exit GTA5.exe
```
]]
native "SET_GRAVITY_LEVEL"
hash "0x740E14FAD5842351"
jhash (0x2D833F4A)
arguments {
int "level" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
```cpp
enum eGravityLevel
{
GRAV_EARTH = 0, // earth gravity 9.8m/s2
GRAV_MOON = 1, // moon gravity 2.4m/s2
GRAV_LOW = 2, // very low gravity
GRAV_ZERO = 3 // zero gravity
}
```
]]
native "SET_INCIDENT_REQUESTED_UNITS"
hash "0xB08B85D860E7BA3C"
jhash (0x0242D88E)
arguments {
int "incidentId" [=[ {} ]=],
int "dispatchService" [=[ {} ]=],
int "numUnits" [=[ {} ]=],
}
alias "0xB08B85D860E7BA3C"
ns "MISC"
returns "void"
doc [[!
]]
native "SET_INSTANCE_PRIORITY_HINT"
hash "0xC5F0A8EBD3F361CE"
jhash (0xE202879D)
arguments {
int "flag" [=[ {} ]=],
}
alias "_SET_UNK_MAP_FLAG"
ns "MISC"
returns "void"
doc [[!
```
Sets an unknown flag used by CScene in determining which entities from CMapData scene nodes to draw, similar to SET_INSTANCE_PRIORITY_MODE.
```
]]
native "SET_INSTANCE_PRIORITY_MODE"
hash "0x9BAE5AD2508DF078"
jhash (0x721B2492)
arguments {
int "toggle" [=[ {"cs_type":"BOOL"} ]=],
}
alias "_ENABLE_MP_DLC_MAPS"
alias "_USE_FREEMODE_MAP_BEHAVIOR"
alias "_LOWER_MAP_PROP_DENSITY"
ns "MISC"
returns "void"
doc [[!
Sets the maximum prop density and changes a loading screen flag from 'loading story mode' to 'loading GTA Online'. It causes a loading screen to show as it reloads map data.
toggles the instance priority mode
]]
native "SET_MINIGAME_IN_PROGRESS"
hash "0x19E00D7322C6F85B"
jhash (0x348B9046)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
]]
native "SET_MISSION_FLAG"
hash "0xC4301E5121A0ED73"
jhash (0x57592D52)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
```
If true, the player can't save the game.
If the parameter is true, sets the mission flag to true, if the parameter is false, the function does nothing at all.
^ also, if the mission flag is already set, the function does nothing at all
```
]]
native "SET_OVERRIDE_WEATHER"
hash "0xA43D5C6FE51ADBEF"
jhash (0xD9082BB5)
arguments {
charPtr "weatherType" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
Refer to [`SET_WEATHER_TYPE_NOW`](#\_0x29B487C359E19889) for weather types.
]]
native "SET_RANDOM_EVENT_FLAG"
hash "0x971927086CFD2158"
jhash (0xA77F31E8)
arguments {
BOOL "toggle" [=[ {"cs_type":"Any"} ]=],
}
ns "MISC"
returns "void"
doc [[!
```
If the parameter is true, sets the random event flag to true, if the parameter is false, the function does nothing at all.
Does nothing if the mission flag is set.
```
]]
native "SET_RANDOM_SEED"
hash "0x444D98F98C11F3EC"
jhash (0xDB3FEB5C)
arguments {
int "seed" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
]]
native "SET_RANDOM_WEATHER_TYPE"
hash "0x8B05F884CF7E8020"
jhash (0xE7AA1BC9)
ns "MISC"
returns "void"
doc [[!
]]
native "SET_RIOT_MODE_ENABLED"
hash "0x2587A48BC88DFADF"
jhash (0xD9660339)
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0x2587A48BC88DFADF"
ns "MISC"
returns "void"
doc [[!
Activates riot mode. All NPCs are being hostile to each other (including player). Also the game will give weapons (pistols, smgs) to random NPCs.
Turn on or off riot mode. Set to `true` to enable riot mode.
]]
native "SET_SAVE_HOUSE"
hash "0x4F548CABEAE553BC"
jhash (0xC3240BB4)
arguments {
Any "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
]]
native "SET_SAVE_MENU_ACTIVE"
hash "0xC9BF75D28165FF77"
jhash (0xF5CCF164)
arguments {
BOOL "ignoreVehicle" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
```
ignoreVehicle - bypasses vehicle check of the local player (it will not open if you are in a vehicle and this is set to false)
```
]]
native "SET_STUNT_JUMPS_CAN_TRIGGER"
hash "0xD79185689F8FD5DF"
jhash (0x3C806A2D)
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0xD79185689F8FD5DF"
ns "MISC"
returns "void"
doc [[!
]]
native "SET_SUPER_JUMP_THIS_FRAME"
hash "0x57FFF03E423A4C0B"
jhash (0x86745EF3)
arguments {
Player "player" [=[ {} ]=],
}
ns "MISC"
annotations [=[ {"cs_type":"int"} ]=]
returns "void"
doc [[!
Allows the player to perform super jumps. This function must be called every frame for it to work.
It basically OR's a flag for a single frame, allowing the ped to perform a super jump only when the flag is set.
The player we are setting this for.
]]
native "SET_THIS_SCRIPT_CAN_BE_PAUSED"
hash "0xAA391C728106F7AF"
jhash (0xA0C3CE29)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
]]
native "SET_THIS_SCRIPT_CAN_REMOVE_BLIPS_CREATED_BY_ANY_SCRIPT"
hash "0xB98236CAAECEF897"
jhash (0xD06F1720)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
Normally, blips can only be removed by the script or resource that created them. However, this native function allows a script to bypass this logic and remove blips from any script.
Bool indicating if the script that called this native can remove blips created by other scripts.
]]
native "SET_TIME_SCALE"
hash "0x1D408577D440E81E"
jhash (0xA7F84694)
arguments {
float "timeScale" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
```
Maximum value is 1.
At a value of 0 the game will still run at a minimum time scale.
Slow Motion 1: 0.6
Slow Motion 2: 0.4
Slow Motion 3: 0.2
```
]]
native "SET_WEATHER_TYPE_NOW"
hash "0x29B487C359E19889"
jhash (0x361E9EAC)
arguments {
charPtr "weatherType" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
Immediately changes the game's weather to the specified type, which will then persist for one cycle before the game resumes its natural weather progression.
**Note:** This native is not supported in networked sessions. Please refer to [`SET_OVERRIDE_WEATHER`](#\_0xA43D5C6FE51ADBEF) or [`SET_WEATHER_TYPE_NOW_PERSIST`](#\_0xED712CA327900C8A) if you want to override weather in networked sessions.
```
NativeDB Introduced: v323
```
**Weather Types:**
* CLEAR
* EXTRASUNNY
* CLOUDS
* OVERCAST
* RAIN
* CLEARING
* THUNDER
* SMOG
* FOGGY
* XMAS
* SNOW
* SNOWLIGHT
* BLIZZARD
* HALLOWEEN
* NEUTRAL
* RAIN_HALLOWEEN
* SNOW_HALLOWEEN
The weather type to set. This should be one of the predefined weather type strings.
]]
native "SET_WEATHER_TYPE_NOW_PERSIST"
hash "0xED712CA327900C8A"
jhash (0xC869FE97)
arguments {
charPtr "weatherType" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
Refer to [`SET_WEATHER_TYPE_NOW`](#\_0x29B487C359E19889) for weather types.
]]
native "SET_WEATHER_TYPE_OVERTIME_PERSIST"
hash "0xFB5045B7C42B75BF"
jhash (0x386F0D25)
arguments {
charPtr "weatherType" [=[ {} ]=],
float "time" [=[ {} ]=],
}
alias "_SET_WEATHER_TYPE_OVER_TIME"
ns "MISC"
returns "void"
doc [[!
Refer to [`SET_WEATHER_TYPE_NOW`](#\_0x29B487C359E19889) for weather types.
The weather type to override to.
A float on how long to take to transition (in seconds).
]]
native "SET_WEATHER_TYPE_PERSIST"
hash "0x704983DF373B198F"
jhash (0xC6C04C75)
arguments {
charPtr "weatherType" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
Sets the current weather type to persist indefinitely until changed.
**Note:** This native is not supported in networked sessions. Please refer to [`SET_OVERRIDE_WEATHER`](#\_0xA43D5C6FE51ADBEF) or [`SET_WEATHER_TYPE_NOW_PERSIST`](#\_0xED712CA327900C8A) if you want to override weather in networked sessions.
```
NativeDB Introduced: v323
```
The weather type to be set as persistent. Refer to [`SET_WEATHER_TYPE_NOW`](#\_0x29B487C359E19889) for a list of weather type strings.
]]
native "SET_WIND"
hash "0xAC3A74E8384A9919"
jhash (0xC6294698)
arguments {
float "speed" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
Sets the the raw wind speed value. The wind speed will stay persistent until it is reset (see examples).
The wind speed (clamped to between 0.0 and 1.0)
]]
native "SET_WIND_DIRECTION"
hash "0xEB0F4468467B4528"
jhash (0x381AEEE9)
arguments {
float "direction" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
Sets the wind direction. The wind direction will stay persistent until it is reset (see examples).
the [wind direction](https://en.wikipedia.org/wiki/Wind_direction) in radians
]]
native "SET_WIND_SPEED"
hash "0xEE09ECEDBABE47FC"
jhash (0x45705F94)
arguments {
float "speed" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
Using this native will clamp the wind speed value to a range of 0.0 - 12.0. The wind speed will stay persistent until it is reset (see examples).
wind speed in meters per second
]]
native "SHOOT_SINGLE_BULLET_BETWEEN_COORDS"
hash "0x867654CBC7606F2C"
jhash (0xCB7415AC)
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
int "damage" [=[ {} ]=],
BOOL "pureAccuracy" [=[ {} ]=],
Hash "weaponHash" [=[ {} ]=],
Ped "ownerPed" [=[ {} ]=],
BOOL "isAudible" [=[ {} ]=],
BOOL "isInvisible" [=[ {} ]=],
float "speed" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
Shoots a bullet from the first vector to the second vector. The weapon used as weaponHash should already be loaded via REQUEST_WEAPON_ASSET, otherwise the bullet may fail to materialise.
The X coordinate to start the shot at.
The Y coordinate to start the shot at.
The Z coordinate to start the shot at.
The X coordinate the shot should end up at.
The Y coordinate the shot should end up at.
The Z coordinate the shot should end up at.
The amount of damage the bullet carries.
Whether the bullet should have pinpoint accuracy.
Hash of the weapon the bullet is used as ammunition for.
Owner of the bullet, e.g. if the bullet kills someone the kill feed shows 'X was shot by ownerPed.'
Whether the bullet should be audible. Optional, defaults to true
Whether the bullet should be invisible. Optional, defaults to false
Speed the bullet should fly at. Optional
]]
native "SHOOT_SINGLE_BULLET_BETWEEN_COORDS_IGNORE_ENTITY"
hash "0xE3A7742E0B7A2F8B"
jhash (0x52ACCB7B)
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
int "damage" [=[ {} ]=],
BOOL "p7" [=[ {} ]=],
Hash "weaponHash" [=[ {} ]=],
Ped "ownerPed" [=[ {} ]=],
BOOL "isAudible" [=[ {} ]=],
BOOL "isInvisible" [=[ {} ]=],
float "speed" [=[ {} ]=],
Entity "entity" [=[ {} ]=],
}
alias "0xE3A7742E0B7A2F8B"
alias "_SHOOT_SINGLE_BULLET_BETWEEN_COORDS_PRESET_PARAMS"
ns "MISC"
returns "void"
doc [[!
```
entity - entity to ignore
```
```
NativeDB Added Parameter 15: Any p14
```
]]
native "SHOOT_SINGLE_BULLET_BETWEEN_COORDS_IGNORE_ENTITY_NEW"
hash "0xBFE5756E7407064A"
jhash (0xCCDC33CC)
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
int "damage" [=[ {} ]=],
BOOL "p7" [=[ {} ]=],
Hash "weaponHash" [=[ {} ]=],
Ped "ownerPed" [=[ {} ]=],
BOOL "isAudible" [=[ {} ]=],
BOOL "isInvisible" [=[ {} ]=],
float "speed" [=[ {} ]=],
Entity "entity" [=[ {} ]=],
BOOL "p14" [=[ {} ]=],
BOOL "p15" [=[ {} ]=],
BOOL "p16" [=[ {} ]=],
BOOL "p17" [=[ {} ]=],
}
alias "0xBFE5756E7407064A"
alias "_SHOOT_SINGLE_BULLET_BETWEEN_COORDS_WITH_EXTRA_PARAMS"
ns "MISC"
returns "void"
doc [[!
```
NativeDB Added Parameter 19: Any p18
NativeDB Added Parameter 20: Any p19
NativeDB Added Parameter 21: Any p20
```
]]
native "SHOULD_USE_METRIC_MEASUREMENTS"
hash "0xD3D15555431AB793"
jhash (0xBAF17315)
alias "0xD3D15555431AB793"
alias "_IS_GAME_USING_METRIC_MEASUREMENT_SYSTEM"
ns "MISC"
returns "BOOL"
doc [[!
Returns true if the game is using the metric measurement system (profile setting 227), false if imperial is used.
Returns true if the game is using the metric measurement system, false if imperial is used.
]]
native "SLERP_NEAR_QUATERNION"
hash "0xF2F6A2FA49278625"
jhash (0x87B92190)
arguments {
float "t" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "w" [=[ {} ]=],
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "w1" [=[ {} ]=],
floatPtr "outX" [=[ {} ]=],
floatPtr "outY" [=[ {} ]=],
floatPtr "outZ" [=[ {} ]=],
floatPtr "outW" [=[ {} ]=],
}
alias "0xF2F6A2FA49278625"
ns "MISC"
returns "void"
doc [[!
This native always come right before SET_ENTITY_QUATERNION where its final 4 parameters are SLERP_NEAR_QUATERNION p9 to p12
acceleration differenzial (am_rollercoaster.c func\_134)
rotation parameter (maybe X axys)
rotation parameter (maybe X axys)
rotation parameter (maybe X axys)
rotation parameter (maybe X axys)
rotation parameter (maybe Y axys)
rotation parameter (maybe Y axys)
rotation parameter (maybe Y axys)
rotation parameter (maybe Y axys)
output value calculated (X)
output value calculated (Y)
output value calculated (Z)
output value calculated (W)
]]
native "START_SAVE_ARRAY_WITH_SIZE"
hash "0x60FE567DF1B1AF9D"
jhash (0x893A342C)
arguments {
AnyPtr "p0" [=[ {} ]=],
int "size" [=[ {} ]=],
charPtr "arrayName" [=[ {} ]=],
}
alias "_START_SAVE_ARRAY"
ns "MISC"
returns "void"
doc [[!
]]
native "START_SAVE_DATA"
hash "0xA9575F812C6A7997"
jhash (0x881A694D)
arguments {
AnyPtr "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
]]
native "START_SAVE_STRUCT_WITH_SIZE"
hash "0xBF737600CDDBEADD"
jhash (0xFB45728E)
arguments {
AnyPtr "p0" [=[ {} ]=],
int "size" [=[ {} ]=],
charPtr "structName" [=[ {} ]=],
}
alias "_START_SAVE_STRUCT"
ns "MISC"
returns "void"
doc [[!
]]
native "STOP_SAVE_ARRAY"
hash "0x04456F95153C6BE4"
jhash (0x0CAD8217)
ns "MISC"
returns "void"
doc [[!
]]
native "STOP_SAVE_DATA"
hash "0x74E20C9145FB66FD"
jhash (0x3B1C07C8)
ns "MISC"
returns "void"
doc [[!
]]
native "STOP_SAVE_STRUCT"
hash "0xEB1774DF12BB9F12"
jhash (0xC2624A28)
ns "MISC"
returns "void"
doc [[!
]]
native "STRING_TO_INT"
hash "0x5A5F40FE637EB584"
jhash (0x590A8160)
arguments {
charPtr "string" [=[ {} ]=],
intPtr "outInteger" [=[ {} ]=],
}
ns "MISC"
returns "BOOL"
doc [[!
```
Returns false if it's a null or empty string or if the string is too long. outInteger will be set to -999 in that case.
If all checks have passed successfully, the return value will be set to whatever strtol(string, 0i64, 10); returns.
```
]]
native "SUPRESS_RANDOM_EVENT_THIS_FRAME"
hash "0x1EAE0A6E978894A2"
jhash (0x8F60366E)
arguments {
int "eventType" [=[ {} ]=],
BOOL "enable" [=[ {} ]=],
}
alias "0x1EAE0A6E978894A2"
ns "MISC"
returns "void"
doc [[!
Suppresses or enables a specific type of random event for the current frame.
```cpp
enum eEventType {
RC_PED_STEAL_VEHICLE = 0,
RC_PED_JAY_WALK_LIGHT = 1,
RC_COP_PURSUE = 2,
RC_COP_PURSUE_VEHICLE_FLEE_SPAWNED = 3,
RC_COP_VEHICLE_DRIVING_FAST = 4,
RC_COP_VEHICLE_DRIVING_SLOW = 5,
RC_DRIVER_RECKLESS = 6,
RC_DRIVER_PRO = 7,
RC_PED_PURSUE_WHEN_HIT_BY_CAR = 8
}
```
The type of the event to be suppressed or enabled. Use the `eEventType` enum for specific event types.
Set to `false` to suppress the event for this frame; set to `true` to enable it.
]]
native "TAN"
hash "0x632106CC96E82E91"
jhash (0xD320CE5E)
arguments {
float "p0" [=[ {} ]=],
}
ns "MISC"
returns "float"
doc [[!
]]
native "TERMINATE_ALL_SCRIPTS_WITH_THIS_NAME"
hash "0x9DC711BC69C548DF"
jhash (0x9F861FD4)
arguments {
charPtr "scriptName" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
For a full list, see [here](https://gist.github.com/4mmonium/f76f3ecef649ed275b260b433ea84494).
]]
native "TOGGLE_SHOW_OPTIONAL_STUNT_JUMP_CAMERA"
hash "0xFB80AB299D2EE1BD"
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0xFB80AB299D2EE1BD"
ns "MISC"
returns "void"
doc [[!
Enable/disable optional stunt camera.
```
NativeDB Introduced: v757
```
Set to `true` to enable the optional stunt jump camera angles, or `false` to disable them and use the default camera view.
]]
native "UI_STARTED_END_USER_BENCHMARK"
hash "0xEA2F2061875EED90"
alias "0xEA2F2061875EED90"
alias "_UI_IS_SINGLEPLAYER_PAUSE_MENU_ACTIVE"
ns "MISC"
returns "BOOL"
doc [[!
Returns whether the In-Game Pause Menu Launched the Benchmark Tests.
Returns true if the current frontend menu is `FE_MENU_VERSION_SP_PAUSE`, `false` otherwise.
]]
native "UNLOAD_CLOUD_HAT"
hash "0xA74802FB8D0B7814"
jhash (0xC9FA6E07)
arguments {
charPtr "name" [=[ {} ]=],
float "p1" [=[ {} ]=],
}
alias "0xA74802FB8D0B7814"
ns "MISC"
returns "void"
doc [[!
```
Called 4 times in the b617d scripts:
MISC::_A74802FB8D0B7814("CONTRAILS", 0);
```
]]
native "UPDATE_ONSCREEN_KEYBOARD"
hash "0x0CF2B696BBF945AE"
jhash (0x23D0A1CE)
ns "MISC"
returns "int"
doc [[!
Returns the current state of the text input box.
```cpp
enum eOSKStatus
{
OSK_INVALID = -1,
OSK_PENDING = 0,
OSK_SUCCESS = 1,
OSK_CANCELLED = 2,
OSK_FAILED = 3
};
```
Returns a value from the list above.
]]
native "USING_MISSION_CREATOR"
hash "0xF14878FC50BEC6EE"
jhash (0x20AB0B6B)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
]]
native "WATER_OVERRIDE_FADE_IN"
hash "0xA8434F1DFF41D6E7"
jhash (0x5F3DDEC0)
arguments {
float "p0" [=[ {} ]=],
}
alias "0xA8434F1DFF41D6E7"
ns "MISC"
returns "void"
doc [[!
]]
native "WATER_OVERRIDE_FADE_OUT"
hash "0xC3C221ADDDE31A11"
jhash (0x63A89684)
arguments {
float "p0" [=[ {} ]=],
}
alias "0xC3C221ADDDE31A11"
ns "MISC"
returns "void"
doc [[!
]]
native "WATER_OVERRIDE_SET_OCEANNOISEMINAMPLITUDE"
hash "0x31727907B2C43C55"
jhash (0xD447439D)
arguments {
float "minAmplitude" [=[ {} ]=],
}
alias "0x31727907B2C43C55"
ns "MISC"
returns "void"
doc [[!
]]
native "WATER_OVERRIDE_SET_OCEANWAVEAMPLITUDE"
hash "0x405591EC8FD9096D"
jhash (0x584E9C59)
arguments {
float "amplitude" [=[ {} ]=],
}
alias "0x405591EC8FD9096D"
ns "MISC"
returns "void"
doc [[!
]]
native "WATER_OVERRIDE_SET_OCEANWAVEMAXAMPLITUDE"
hash "0xB3E6360DDE733E82"
jhash (0x0DE40C28)
arguments {
float "maxAmplitude" [=[ {} ]=],
}
alias "0xB3E6360DDE733E82"
ns "MISC"
returns "void"
doc [[!
]]
native "WATER_OVERRIDE_SET_OCEANWAVEMINAMPLITUDE"
hash "0xF751B16FB32ABC1D"
jhash (0x5656D578)
arguments {
float "minAmplitude" [=[ {} ]=],
}
alias "0xF751B16FB32ABC1D"
ns "MISC"
returns "void"
doc [[!
]]
native "WATER_OVERRIDE_SET_RIPPLEBUMPINESS"
hash "0x7C9C0B1EEB1F9072"
jhash (0x98C9138B)
arguments {
float "bumpiness" [=[ {} ]=],
}
alias "0x7C9C0B1EEB1F9072"
ns "MISC"
returns "void"
doc [[!
]]
native "WATER_OVERRIDE_SET_RIPPLEDISTURB"
hash "0xB9854DFDE0D833D6"
jhash (0x4671AC2E)
arguments {
float "disturb" [=[ {} ]=],
}
alias "0xB9854DFDE0D833D6"
ns "MISC"
returns "void"
doc [[!
]]
native "WATER_OVERRIDE_SET_RIPPLEMAXBUMPINESS"
hash "0x9F5E6BB6B34540DA"
jhash (0x1C0CAE89)
arguments {
float "maxBumpiness" [=[ {} ]=],
}
alias "0x9F5E6BB6B34540DA"
ns "MISC"
returns "void"
doc [[!
]]
native "WATER_OVERRIDE_SET_RIPPLEMINBUMPINESS"
hash "0x6216B116083A7CB4"
jhash (0xFB1A9CDE)
arguments {
float "minBumpiness" [=[ {} ]=],
}
alias "0x6216B116083A7CB4"
ns "MISC"
returns "void"
doc [[!
]]
native "WATER_OVERRIDE_SET_SHOREWAVEAMPLITUDE"
hash "0xB8F87EAD7533B176"
jhash (0x625181DC)
arguments {
float "amplitude" [=[ {} ]=],
}
alias "0xB8F87EAD7533B176"
ns "MISC"
returns "void"
doc [[!
]]
native "WATER_OVERRIDE_SET_SHOREWAVEMAXAMPLITUDE"
hash "0xA7A1127490312C36"
jhash (0x6926AB03)
arguments {
float "maxAmplitude" [=[ {} ]=],
}
alias "0xA7A1127490312C36"
ns "MISC"
returns "void"
doc [[!
]]
native "WATER_OVERRIDE_SET_SHOREWAVEMINAMPLITUDE"
hash "0xC3EAD29AB273ECE8"
jhash (0xBEBBFDC8)
arguments {
float "minAmplitude" [=[ {} ]=],
}
alias "0xC3EAD29AB273ECE8"
ns "MISC"
returns "void"
doc [[!
]]
native "WATER_OVERRIDE_SET_STRENGTH"
hash "0xC54A08C85AE4D410"
jhash (0xDA02F415)
arguments {
float "strength" [=[ {} ]=],
}
alias "0xC54A08C85AE4D410"
ns "MISC"
returns "void"
doc [[!
```
This seems to edit the water wave, intensity around your current location.
0.0f = Normal
1.0f = So Calm and Smooth, a boat will stay still.
3.0f = Really Intense.
```
]]
native "_ADD_DISPATCH_SPAWN_BLOCKING_ANGLED_AREA"
hash "0x918C7B2D2FF3928B"
jhash (0xF557BAF9)
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
float "width" [=[ {} ]=],
}
alias "0x918C7B2D2FF3928B"
ns "MISC"
returns "Any"
doc [[!
To remove, see: [`REMOVE_DISPATCH_SPAWN_BLOCKING_AREA`](#\_0x264AC28B01B353A5).
See [`IS_POINT_IN_ANGLED_AREA`](#\_0x2A70BAE8883E4C81) for the definition of an angled area.
X dimension of the angled area 'origin'
Y dimension of the angled area 'origin'
Z dimension of the angled area 'origin'
X dimension of the angled area 'extent'
Y dimension of the angled area 'extent'
Z dimension of the angled area 'extent'
Width of the angled area
]]
native "_ADD_DISPATCH_SPAWN_BLOCKING_AREA"
hash "0x2D4259F1FEB81DA9"
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
}
alias "0x2D4259F1FEB81DA9"
ns "MISC"
returns "Any"
doc [[!
]]
native "_ADD_TACTICAL_ANALYSIS_POINT"
hash "0xB8721407EE9C3FF6"
jhash (0x24A4E0B2)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
alias "0xB8721407EE9C3FF6"
ns "MISC"
returns "void"
doc [[!
```
Adds a point related to CTacticalAnalysis
```
]]
native "_CLEANUP_ASYNC_INSTALL"
hash "0xC79AE21974B01FB2"
alias "0xC79AE21974B01FB2"
ns "MISC"
returns "void"
doc [[!
]]
native "_CLEAR_CLOUD_HAT"
hash "0x957E790EA1727B64"
jhash (0x2D7787BC)
ns "MISC"
returns "void"
doc [[!
]]
native "_CLEAR_RESTART_CUSTOM_POSITION"
hash "0xA2716D40842EAF79"
alias "0xA2716D40842EAF79"
alias "_SET_NEXT_RESPAWN_TO_CUSTOM"
ns "MISC"
returns "void"
doc [[!
]]
native "_CLEAR_TACTICAL_ANALYSIS_POINTS"
hash "0xB3CD58CCA6CDA852"
jhash (0x66C3C59C)
alias "0xB3CD58CCA6CDA852"
ns "MISC"
returns "void"
doc [[!
]]
native "_COPY_MEMORY"
hash "0x213AEB2B90CBA7AC"
arguments {
AnyPtr "dst" [=[ {} ]=],
Any "src" [=[ {} ]=],
int "size" [=[ {} ]=],
}
alias "0x213AEB2B90CBA7AC"
ns "MISC"
returns "void"
doc [[!
]]
native "_GET_BASE_ELEMENT_METADATA"
hash "0xB335F761606DB47C"
jhash (0xE23416C1)
arguments {
AnyPtr "p1" [=[ {} ]=],
AnyPtr "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
BOOL "p4" [=[ {} ]=],
}
alias "0xB335F761606DB47C"
ns "MISC"
returns "BOOL"
doc [[!
]]
native "_GET_BENCHMARK_ITERATIONS_FROM_COMMAND_LINE"
hash "0x4750FC27570311EC"
alias "0x4750FC27570311EC"
ns "MISC"
returns "int"
doc [[!
```
Returns value of the '-benchmarkIterations' command line option.
```
]]
native "_GET_BENCHMARK_PASS_FROM_COMMAND_LINE"
hash "0x1B2366C3F2A5C8DF"
alias "0x1B2366C3F2A5C8DF"
ns "MISC"
returns "int"
doc [[!
```
Returns value of the '-benchmarkPass' command line option.
```
]]
native "_GET_BENCHMARK_TIME"
hash "0xE599A503B3837E1B"
alias "0xE599A503B3837E1B"
ns "MISC"
returns "float"
doc [[!
]]
native "_GET_CLOUD_HAT_OPACITY"
hash "0x20AC25E781AE4A84"
alias "0x20AC25E781AE4A84"
ns "MISC"
returns "float"
doc [[!
]]
native "_GET_GLOBAL_CHAR_BUFFER"
hash "0x24DA7D7667FD7B09"
alias "0x24DA7D7667FD7B09"
ns "MISC"
returns "charPtr"
doc [[!
```
Returns pointer to an empty string.
GET_C*
```
]]
native "_GET_IS_PLAYER_IN_ANIMAL_FORM"
hash "0x9689123E3F213AA5"
alias "0x9689123E3F213AA5"
ns "MISC"
returns "BOOL"
doc [[!
```
Although we don't have a jenkins hash for this one, the name is 100% confirmed.
```
]]
native "_GET_NUM_DISPATCHED_UNITS_FOR_PLAYER"
hash "0xEB4A0C2D56441717"
jhash (0x3CE5BF6B)
arguments {
int "dispatchService" [=[ {} ]=],
}
alias "0xEB4A0C2D56441717"
alias "_GET_NUMBER_OF_DISPATCHED_UNITS_FOR_PLAYER"
ns "MISC"
returns "int"
doc [[!
]]
native "_GET_POWER_SAVING_MODE_DURATION"
hash "0xABB2FA71C83A1B72"
alias "0xABB2FA71C83A1B72"
ns "MISC"
returns "int"
doc [[!
```
Returns duration of how long the game has been in power-saving mode (aka "constrained") in milliseconds.
```
]]
native "_GET_PROJECTILE_NEAR_PED"
hash "0x82FDE6A57EE4EE44"
jhash (0x507BC6F7)
arguments {
Ped "ped" [=[ {} ]=],
Hash "weaponHash" [=[ {} ]=],
float "distance" [=[ {} ]=],
Vector3Ptr "outCoords" [=[ {} ]=],
ObjectPtr "outProjectile" [=[ {} ]=],
BOOL "ownedByPlayer" [=[ {} ]=],
}
alias "0x82FDE6A57EE4EE44"
ns "MISC"
returns "BOOL"
doc [[!
]]
native "_GET_RANDOM_INT_IN_RANGE_2"
hash "0xF2D49816A804D134"
arguments {
int "startRange" [=[ {} ]=],
int "endRange" [=[ {} ]=],
}
ns "MISC"
returns "int"
doc [[!
```
NativeDB Introduced: v1734
```
]]
native "_GET_WEATHER_TYPE_TRANSITION"
hash "0xF3BBE884A14BB413"
jhash (0x9A5C1D56)
arguments {
HashPtr "weatherType1" [=[ {} ]=],
HashPtr "weatherType2" [=[ {} ]=],
floatPtr "percentWeather2" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
Refer to [`SET_WEATHER_TYPE_NOW`](#\_0x29B487C359E19889) for weather types.
]]
native "_HAS_ASYNC_INSTALL_FINISHED"
hash "0x14832BF2ABA53FC5"
alias "0x14832BF2ABA53FC5"
ns "MISC"
returns "BOOL"
doc [[!
```
Hardcoded to always return true.
```
]]
native "_HAS_BUTTON_COMBINATION_JUST_BEEN_ENTERED"
hash "0x071E2A839DE82D90"
jhash (0xFF6191E1)
arguments {
Hash "hash" [=[ {} ]=],
int "amount" [=[ {} ]=],
}
alias "0x071E2A839DE82D90"
ns "MISC"
returns "BOOL"
doc [[!
```
This native appears on the cheat_controller script and tracks a combination of buttons, which may be used to toggle cheats in-game. Credits to ThreeSocks for the info. The hash contains the combination, while the "amount" represents the amount of buttons used in a combination.
INT_SCORES_SCORTED was a hash collision
```
]]
native "_HAS_CHEAT_STRING_JUST_BEEN_ENTERED"
hash "0x557E43C447E700A8"
arguments {
Hash "hash" [=[ {} ]=],
}
alias "0x557E43C447E700A8"
ns "MISC"
returns "BOOL"
doc [[!
```
Get inputted "Cheat code", for example:
while (TRUE)
{
if (MISC::_557E43C447E700A8(${fugitive}))
{
// Do something.
}
SYSTEM::WAIT(0);
}
Calling this will also set the last saved string hash to zero.
```
]]
native "_HAS_RESUMED_FROM_SUSPEND"
hash "0xE8B9C0EC9E183F35"
alias "0xE8B9C0EC9E183F35"
ns "MISC"
returns "BOOL"
doc [[!
```
Hardcoded to return false.
```
]]
native "_IS_COMMAND_LINE_BENCHMARK_VALUE_SET"
hash "0xA049A5BE0F04F2F8"
alias "0xA049A5BE0F04F2F8"
ns "MISC"
returns "BOOL"
doc [[!
```
Returns true if command line option '-benchmark' is set.
```
]]
native "_IS_IN_POWER_SAVING_MODE"
hash "0x684A41975F077262"
alias "0x684A41975F077262"
ns "MISC"
returns "BOOL"
doc [[!
```
aka "constrained"
```
]]
native "_IS_POP_MULTIPLIER_AREA_UNK"
hash "0x1312F4B242609CE3"
arguments {
int "id" [=[ {} ]=],
}
ns "MISC"
returns "BOOL"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "_LANDING_MENU_IS_ACTIVE"
hash "0x3BBBD13E5041A79E"
alias "0x3BBBD13E5041A79E"
ns "MISC"
returns "BOOL"
doc [[!
```
Returns true if the current frontend menu is FE_MENU_VERSION_LANDING_MENU
```
]]
native "_REGISTER_INT64_TO_SAVE"
hash "0xA735353C77334EA0"
arguments {
AnyPtr "p0" [=[ {} ]=],
charPtr "name" [=[ {} ]=],
}
alias "0xA735353C77334EA0"
ns "MISC"
returns "void"
doc [[!
]]
native "_REGISTER_TEXT_LABEL_TO_SAVE_2"
hash "0x6F7794F28C6B2535"
jhash (0xE2089749)
arguments {
AnyPtr "p0" [=[ {} ]=],
charPtr "name" [=[ {} ]=],
}
alias "0x6F7794F28C6B2535"
ns "MISC"
returns "void"
doc [[!
```
Seems to have the same functionality as REGISTER_TEXT_LABEL_TO_SAVE?
MISC::_6F7794F28C6B2535(&a_0._f1, "tlPlateText");
MISC::_6F7794F28C6B2535(&a_0._f1C, "tlPlateText_pending");
MISC::_6F7794F28C6B2535(&a_0._f10B, "tlCarAppPlateText");
"tl" prefix sounds like "Text Label"
```
]]
native "_REMOVE_STEALTH_KILL"
hash "0xA6A12939F16D85BE"
jhash (0x42B484ED)
arguments {
Hash "hash" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
alias "0xA6A12939F16D85BE"
ns "MISC"
returns "void"
doc [[!
```
Appears to remove stealth kill action from memory
```
]]
native "_RESET_BENCHMARK_RECORDING"
hash "0x437138B6A830166A"
alias "0x437138B6A830166A"
ns "MISC"
returns "void"
doc [[!
```
Begins with RESET_*. Next character in the name is either D or E.
```
]]
native "_RESET_DISPATCH_SPAWN_LOCATION"
hash "0x5896F2BD5683A4E1"
ns "MISC"
returns "void"
doc [[!
```
NativeDB Introduced: v1868
```
]]
native "_SAVE_BENCHMARK_RECORDING"
hash "0x37DEB0AA183FB6D8"
alias "0x37DEB0AA183FB6D8"
ns "MISC"
returns "void"
doc [[!
```
Saves the benchmark recording to %USERPROFILE%\Documents\Rockstar Games\GTA V\Benchmarks and submits some metrics.
```
]]
native "_SET_BEAST_MODE_ACTIVE"
hash "0x438822C279B73B93"
arguments {
Player "player" [=[ {} ]=],
}
alias "0x438822C279B73B93"
ns "MISC"
returns "void"
doc [[!
]]
native "_SET_FORCE_PLAYER_TO_JUMP"
hash "0xA1183BCFEE0F93D1"
arguments {
Player "player" [=[ {} ]=],
}
alias "0xA1183BCFEE0F93D1"
ns "MISC"
returns "void"
doc [[!
```
NativeDB Introduced: v1180
```
]]
native "_SET_INCIDENT_UNK"
hash "0xD261BA3E7E998072"
jhash (0x1F38102E)
arguments {
int "incidentId" [=[ {} ]=],
float "p1" [=[ {} ]=],
}
alias "0xD261BA3E7E998072"
ns "MISC"
returns "void"
doc [[!
```
SET_INCIDENT_*
```
]]
native "_SET_PLAYER_IS_IN_ANIMAL_FORM"
hash "0x4EBB7E87AA0DBED4"
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0x4EBB7E87AA0DBED4"
alias "_SHOW_PED_IN_PAUSE_MENU"
ns "MISC"
returns "void"
doc [[!
```
If toggle is true, the ped's head is shown in the pause menu
If toggle is false, the ped's head is not shown in the pause menu
```
]]
native "_SET_PLAYER_ROCKSTAR_EDITOR_DISABLED"
hash "0x9D8D44ADBBA61EF2"
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0x9D8D44ADBBA61EF2"
ns "MISC"
returns "void"
doc [[!
```
SET_PLAYER_*
```
]]
native "_SET_RAIN_LEVEL"
hash "0x643E26EA6E024D92"
arguments {
float "level" [=[ {} ]=],
}
alias "_SET_RAIN_FX_INTENSITY"
ns "MISC"
returns "void"
doc [[!
Controls rain, rain sounds and the creation of puddles.
With an `level` higher than `0.5f`, only the creation of puddles gets faster, rain and rain sound won't increase after that.
With an `level` of `0.0f` rain and rain sounds are disabled and there won't be any new puddles.
To use the rain level of the current weather, call this native with `-1f` as `level`.
Strength of rain effects
]]
native "_SET_RESTART_CUSTOM_POSITION"
hash "0x706B5EDCAA7FA663"
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "heading" [=[ {} ]=],
}
alias "0x706B5EDCAA7FA663"
alias "_SET_CUSTOM_RESPAWN_POSITION"
ns "MISC"
returns "void"
doc [[!
]]
native "_SET_SNOW_LEVEL"
hash "0x7F06937B0CDCBC1A"
arguments {
float "level" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
```
NativeDB Introduced: v1868
```
]]
native "_SET_WEATHER_TYPE_TRANSITION"
hash "0x578C752848ECFA0C"
jhash (0x5CA74040)
arguments {
Hash "weatherType1" [=[ {} ]=],
Hash "weatherType2" [=[ {} ]=],
float "percentWeather2" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
Refer to [`SET_WEATHER_TYPE_NOW`](#\_0x29B487C359E19889) for weather types.
```
Mixes two weather types. If percentWeather2 is set to 0.0f, then the weather will be entirely of weatherType1, if it is set to 1.0f it will be entirely of weatherType2. If it's set somewhere in between, there will be a mixture of weather behaviors. To test, try this in the RPH console, and change the float to different values between 0 and 1:
execute "NativeFunction.Natives.x578C752848ECFA0C(Game.GetHashKey(""RAIN""), Game.GetHashKey(""SMOG""), 0.50f);
```
]]
native "_START_BENCHMARK_RECORDING"
hash "0x92790862E36C2ADA"
alias "0x92790862E36C2ADA"
ns "MISC"
returns "void"
doc [[!
```
Begins with START_*. Next character in the name is either D or E.
```
]]
native "_STOP_BENCHMARK_RECORDING"
hash "0xC7DB36C24634F52B"
alias "0xC7DB36C24634F52B"
ns "MISC"
returns "void"
doc [[!
```
Begins with STOP_*. Next character in the name is either D or E.
```
]]
native "0x06462A961E94B67C"
hash "0x06462A961E94B67C"
jhash (0x5A45B11A)
ns "MISC"
returns "void"
doc [[!
```
CLEAR_*
```
]]
native "0x1178E104409FE58C"
hash "0x1178E104409FE58C"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
```
NativeDB Introduced: v2189
```
]]
native "0x19BFED045C647C49"
hash "0x19BFED045C647C49"
jhash (0x1A332D2D)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "MISC"
returns "BOOL"
doc [[!
```
GET_TENNIS_*; references 0xFBFEC0E9 = interruptswing
```
]]
native "0x2107A3773771186D"
hash "0x2107A3773771186D"
jhash (0x78350773)
ns "MISC"
returns "BOOL"
doc [[!
```
HAS_*
```
]]
native "0x21C235BC64831E5A"
hash "0x21C235BC64831E5A"
jhash (0xCAECF37E)
arguments {
float "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
float "p4" [=[ {} ]=],
float "p5" [=[ {} ]=],
float "p6" [=[ {} ]=],
float "p7" [=[ {} ]=],
float "p8" [=[ {} ]=],
BOOL "p9" [=[ {} ]=],
}
ns "MISC"
returns "Vector3"
doc [[!
```
GET_C*
```
]]
native "0x23227DF0B2115469"
hash "0x23227DF0B2115469"
ns "MISC"
returns "void"
doc [[!
**This native does absolutely nothing, just a nullsub**
]]
native "0x31125FD509D9043F"
hash "0x31125FD509D9043F"
arguments {
AnyPtr "p0" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
**This native does absolutely nothing, just a nullsub**
]]
native "0x39455BF4F4F55186"
hash "0x39455BF4F4F55186"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
Any "p6" [=[ {} ]=],
Any "p7" [=[ {} ]=],
Any "p8" [=[ {} ]=],
Any "p9" [=[ {} ]=],
Any "p10" [=[ {} ]=],
Any "p11" [=[ {} ]=],
Any "p12" [=[ {} ]=],
}
ns "MISC"
returns "Any"
doc [[!
```
NativeDB Introduced: v1868
```
]]
native "0x397BAA01068BAA96"
hash "0x397BAA01068BAA96"
jhash (0x39771F21)
ns "MISC"
returns "int"
doc [[!
]]
native "0x48F069265A0E4BEC"
hash "0x48F069265A0E4BEC"
jhash (0xF91B8C33)
arguments {
AnyPtr "p0" [=[ {} ]=],
charPtr "name" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
```
Only found 3 times in decompiled scripts. Not a whole lot to go off of.
MISC::_48F069265A0E4BEC(a_0, "Movie_Name_For_This_Player");
MISC::_48F069265A0E4BEC(&a_0._fB, "Ringtone_For_This_Player");
MISC::_48F069265A0E4BEC(&a_0._f1EC4._f12[v_A/*6*/], &v_13); // where v_13 is "MPATMLOGSCRS0" thru "MPATMLOGSCRS15"
```
]]
native "0x54F157E0336A3822"
hash "0x54F157E0336A3822"
jhash (0x49F977A9)
arguments {
Ped "ped" [=[ {} ]=],
charPtr "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
```
From the scripts:
MISC::_54F157E0336A3822(sub_aa49(a_0), "ForcedStopDirection", v_E);
Related to tennis mode.
SET_*
```
]]
native "0x5B1F2E327B6B6FE1"
hash "0x5B1F2E327B6B6FE1"
jhash (0x50C39926)
ns "MISC"
returns "Any"
doc [[!
]]
native "0x65D2EBB47E1CEC21"
hash "0x65D2EBB47E1CEC21"
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
```
Sets GtaThread+0x14A
SET_S*
```
]]
native "0x693478ACBD7F18E7"
hash "0x693478ACBD7F18E7"
ns "MISC"
returns "void"
doc [[!
]]
native "0x6F2135B6129620C1"
hash "0x6F2135B6129620C1"
jhash (0x8B2DE971)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
```
Sets bit 3 in GtaThread+0x150
SET_T*
```
]]
native "0x6FDDF453C0C756EC"
hash "0x6FDDF453C0C756EC"
jhash (0xC3C10FCC)
ns "MISC"
returns "BOOL"
doc [[!
```
HAS_*
Probably something like "has game been started for the first time".
```
]]
native "0x703CC7F60CBB2B57"
hash "0x703CC7F60CBB2B57"
arguments {
Any "p0" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
**This native does absolutely nothing, just a nullsub**
]]
native "0x7EC6F9A478A6A512"
hash "0x7EC6F9A478A6A512"
ns "MISC"
returns "void"
doc [[!
```
Possibly used to clear scenario points.
CLEAR_*
```
]]
native "0x7F8F6405F4777AF6"
hash "0x7F8F6405F4777AF6"
jhash (0x89459F0A)
arguments {
float "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
float "p4" [=[ {} ]=],
float "p5" [=[ {} ]=],
float "p6" [=[ {} ]=],
float "p7" [=[ {} ]=],
float "p8" [=[ {} ]=],
BOOL "p9" [=[ {} ]=],
}
ns "MISC"
returns "float"
doc [[!
]]
native "0x8269816F6CFD40F8"
hash "0x8269816F6CFD40F8"
jhash (0x74E8FAD9)
arguments {
AnyPtr "p0" [=[ {} ]=],
charPtr "name" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
```
Only found 2 times in decompiled scripts. Not a whole lot to go off of.
MISC::_8269816F6CFD40F8(&a_0._f1F5A._f6[0/*8*/], "TEMPSTAT_LABEL"); // gets saved in a struct called "g_SaveData_STRING_ScriptSaves"
MISC::_8269816F6CFD40F8(&a_0._f4B4[v_1A/*8*/], &v_5); // where v_5 is "Name0" thru "Name9", gets saved in a struct called "OUTFIT_Name"
```
]]
native "0x8951EB9C6906D3C8"
hash "0x8951EB9C6906D3C8"
ns "MISC"
returns "void"
doc [[!
**This native does absolutely nothing, just a nullsub**
]]
native "0x8D74E26F54B4E5C3"
hash "0x8D74E26F54B4E5C3"
jhash (0xE77199F7)
arguments {
charPtr "p0" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
```
I*
```
]]
native "0x916CA67D26FD1E37"
hash "0x916CA67D26FD1E37"
arguments {
charPtr "p0" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
Does nothing (it's a nullsub). Seems to be PS4 specific.
```
NativeDB Introduced: v2060
```
]]
native "0x97E7E2C04245115B"
hash "0x97E7E2C04245115B"
arguments {
Any "p0" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
**This native does absolutely nothing, just a nullsub**
]]
native "0xA0AD167E4B39D9A2"
hash "0xA0AD167E4B39D9A2"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
Any "p6" [=[ {} ]=],
Any "p7" [=[ {} ]=],
Any "p8" [=[ {} ]=],
Any "p9" [=[ {} ]=],
Any "p10" [=[ {} ]=],
Any "p11" [=[ {} ]=],
Any "p12" [=[ {} ]=],
Any "p13" [=[ {} ]=],
}
ns "MISC"
returns "Any"
doc [[!
```
NativeDB Introduced: v2189
```
]]
native "0xA4A0065E39C9F25C"
hash "0xA4A0065E39C9F25C"
jhash (0xC4D71AB4)
arguments {
Vector3Ptr "p0" [=[ {} ]=],
floatPtr "p1" [=[ {} ]=],
BOOLPtr "fadeInAfterLoad" [=[ {} ]=],
BOOLPtr "p3" [=[ {} ]=],
}
ns "MISC"
returns "BOOL"
doc [[!
```
GET_SAVE_*
GET_SAVE_UNLESS_CUSTOM_DOT ?
```
]]
native "0xB51B9AB9EF81868C"
hash "0xB51B9AB9EF81868C"
jhash (0x75B06B5A)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
]]
native "0xBA4B8D83BDC75551"
hash "0xBA4B8D83BDC75551"
arguments {
Any "p0" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
**This native does absolutely nothing, just a nullsub**
]]
native "0xD10282B6E3751BA0"
hash "0xD10282B6E3751BA0"
ns "MISC"
returns "Any"
doc [[!
]]
native "0xD642319C54AADEB6"
hash "0xD642319C54AADEB6"
jhash (0xC58250F1)
ns "MISC"
returns "Any"
doc [[!
]]
native "0xD9F692D349249528"
hash "0xD9F692D349249528"
jhash (0xE0C9307E)
ns "MISC"
returns "void"
doc [[!
```
RESET_*
```
]]
native "0xE3D969D2785FFB5E"
hash "0xE3D969D2785FFB5E"
ns "MISC"
returns "void"
doc [[!
```
sets something to 1
```
]]
native "0xE532EC1A63231B4F"
hash "0xE532EC1A63231B4F"
jhash (0xA0D8C749)
arguments {
int "p0" [=[ {} ]=],
int "p1" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
```
SET_*
```
]]
native "0xE95B0C7D5BA3B96B"
hash "0xE95B0C7D5BA3B96B"
arguments {
Ped "ped" [=[ {} ]=],
}
ns "MISC"
returns "BOOL"
doc [[!
Related to tennis mode. Checks for `0x0FCED5ADF = swung`
]]
native "0xEB078CA2B5E82ADD"
hash "0xEB078CA2B5E82ADD"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
**This native does absolutely nothing, just a nullsub**
]]
native "0xEB2104E905C6F2E9"
hash "0xEB2104E905C6F2E9"
ns "MISC"
returns "Any"
doc [[!
]]
native "0xEBD3205A207939ED"
hash "0xEBD3205A207939ED"
arguments {
AnyPtr "p0" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
**This native does absolutely nothing, just a nullsub**
]]
native "0xFA3FFB0EEBC288A3"
hash "0xFA3FFB0EEBC288A3"
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
```
NativeDB Introduced: v2060
```
]]
native "0xFAA457EF263E8763"
hash "0xFAA457EF263E8763"
jhash (0x6B4335DD)
arguments {
AnyPtr "p0" [=[ {} ]=],
charPtr "name" [=[ {} ]=],
}
ns "MISC"
returns "void"
doc [[!
```
Another unknown label type...
MISC::_FAA457EF263E8763(a_0, "Thumb_label");
MISC::_FAA457EF263E8763(&a_0._f10, "Photo_label");
MISC::_FAA457EF263E8763(a_0, "GXTlabel");
MISC::_FAA457EF263E8763(&a_0._f21, "StringComp");
MISC::_FAA457EF263E8763(&a_0._f43, "SecondStringComp");
MISC::_FAA457EF263E8763(&a_0._f53, "ThirdStringComp");
MISC::_FAA457EF263E8763(&a_0._f32, "SenderStringComp");
MISC::_FAA457EF263E8763(&a_0._f726[v_1A/*16*/], &v_20); // where v_20 is "LastJobTL_0_1" thru "LastJobTL_2_1", gets saved in a struct called "LAST_JobGamer_TL"
MISC::_FAA457EF263E8763(&a_0._f4B, "PAID_PLAYER");
MISC::_FAA457EF263E8763(&a_0._f5B, "RADIO_STATION");
```
]]
native "0xFB00CA71DA386228"
hash "0xFB00CA71DA386228"
jhash (0x054EC103)
ns "MISC"
returns "void"
doc [[!
]]
native "DEPOSIT_VC"
hash "0xE260E0BB9CD995AC"
jhash (0x8F266745)
arguments {
int "amount" [=[ {} ]=],
}
alias "0xE260E0BB9CD995AC"
ns "MONEY"
returns "BOOL"
doc [[!
```
Does nothing and always returns false.
```
]]
native "NETWORK_BUY_AIRSTRIKE"
hash "0x763B4BD305338F19"
jhash (0x40470683)
arguments {
int "cost" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
p1 = 0 (always)
p2 = 1 (always)
```
]]
native "NETWORK_BUY_BACKUP_GANG"
hash "0xA3EDDAA42411D3B9"
jhash (0x2AD2EC51)
arguments {
int "p0" [=[ {} ]=],
int "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v323
```
]]
native "NETWORK_BUY_BOUNTY"
hash "0x7B718E197453F2D9"
jhash (0xCB89CBE0)
arguments {
int "amount" [=[ {} ]=],
Player "victim" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
p1 is just an assumption. p2 was false and p3 was true.
```
]]
native "NETWORK_BUY_FAIRGROUND_RIDE"
hash "0x8A7B3952DD64D2B5"
jhash (0xD9622D64)
arguments {
int "amountSpent" [=[ {} ]=],
Any "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
}
alias "0x8A7B3952DD64D2B5"
ns "MONEY"
returns "void"
doc [[!
```
The first parameter is the amount spent which is store in a global when this native is called. The global returns 10. Which is the price for both rides.
The last 3 parameters are,
2,0,1 in the am_ferriswheel.c
1,0,1 in the am_rollercoaster.c
```
]]
native "NETWORK_BUY_HEALTHCARE"
hash "0xD9B067E55253E3DD"
jhash (0x832150E5)
arguments {
int "cost" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
]]
native "NETWORK_BUY_HELI_STRIKE"
hash "0x81AA4610E3FD3A69"
jhash (0x047547D4)
arguments {
int "cost" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
p1 = 0 (always)
p2 = 1 (always)
```
]]
native "NETWORK_BUY_ITEM"
hash "0xF0077C797F66A355"
jhash (0xA07B6368)
arguments {
int "amount" [=[ {} ]=],
Hash "item" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
BOOL "p4" [=[ {} ]=],
charPtr "item_name" [=[ {} ]=],
Any "p6" [=[ {} ]=],
Any "p7" [=[ {} ]=],
Any "p8" [=[ {} ]=],
BOOL "p9" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
]]
native "NETWORK_BUY_LOTTERY_TICKET"
hash "0xD987F2489969668C"
jhash (0xF64DF4CF)
arguments {
int "p0" [=[ {} ]=],
int "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v323
```
]]
native "NETWORK_BUY_PROPERTY"
hash "0x650A08A280870AF6"
jhash (0x7D479AAB)
arguments {
int "propertyCost" [=[ {"cs_type":"float"} ]=],
Hash "propertyName" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
]]
native "NETWORK_BUY_SMOKES"
hash "0x75AF80E61248EEBD"
jhash (0xC0AB03EB)
arguments {
int "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v323
```
]]
native "NETWORK_CAN_BET"
hash "0x3A54E33660DED67F"
jhash (0xE3802533)
arguments {
int "amount" [=[ {} ]=],
}
alias "0x3A54E33660DED67F"
ns "MONEY"
returns "BOOL"
doc [[!
]]
native "NETWORK_CAN_BUY_LOTTERY_TICKET"
hash "0xC62DD18375C99130"
jhash (0x334B9364)
arguments {
int "cost" [=[ {} ]=],
}
ns "MONEY"
returns "BOOL"
doc [[!
```
NativeDB Introduced: v323
```
]]
native "NETWORK_CAN_RECEIVE_PLAYER_CASH"
hash "0x5D17BE59D2123284"
jhash (0x41F5F10E)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "MONEY"
returns "BOOL"
doc [[!
]]
native "NETWORK_CAN_SHARE_JOB_CASH"
hash "0x1C2473301B1C66BA"
jhash (0xA27B9FE8)
alias "0x1C2473301B1C66BA"
ns "MONEY"
returns "BOOL"
doc [[!
]]
native "NETWORK_CAN_SPEND_MONEY"
hash "0xAB3CAA6B422164DA"
jhash (0x5AA379D9)
arguments {
Any "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
}
alias "0xAB3CAA6B422164DA"
ns "MONEY"
returns "BOOL"
doc [[!
```
NativeDB Added Parameter 6: Any p5
```
]]
native "NETWORK_CLEAR_CHARACTER_WALLET"
hash "0xA921DED15FDF28F5"
jhash (0x19F0C471)
arguments {
int "characterSlot" [=[ {} ]=],
}
alias "0xA921DED15FDF28F5"
ns "MONEY"
returns "void"
doc [[!
]]
native "NETWORK_DELETE_CHARACTER"
hash "0x05A50AF38947EB8D"
jhash (0xA9F7E9C3)
arguments {
int "characterSlot" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
Note the 2nd parameters are always 1, 0. I have a feeling it deals with your money, wallet, bank. So when you delete the character it of course wipes the wallet cash at that time. So if that was the case, it would be eg, NETWORK_DELETE_CHARACTER(characterIndex, deleteWalletCash, deleteBankCash);
```
]]
native "NETWORK_EARN_FROM_AI_TARGET_KILL"
hash "0x515B4A22E4D3C6D7"
jhash (0x866004A8)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
alias "0x515B4A22E4D3C6D7"
ns "MONEY"
returns "void"
doc [[!
```
DSPORT
```
]]
native "NETWORK_EARN_FROM_AMBIENT_JOB"
hash "0xFB6DB092FBAE29E6"
jhash (0xA14CC95D)
arguments {
int "p0" [=[ {} ]=],
charPtr "p1" [=[ {} ]=],
AnyPtr "p2" [=[ {} ]=],
}
alias "0xFB6DB092FBAE29E6"
alias "_NETWORK_EARN_FROM_AMBIENT_JOB"
ns "MONEY"
returns "void"
doc [[!
```
Example for p1: "AM_DISTRACT_COPS"
```
]]
native "NETWORK_EARN_FROM_BEND_JOB"
hash "0x61326EE6DF15B0CA"
jhash (0xBB293400)
arguments {
int "amount" [=[ {} ]=],
charPtr "heistHash" [=[ {} ]=],
}
alias "0x61326EE6DF15B0CA"
alias "NETWORK_EARN_FROM_MISSION_H"
ns "MONEY"
returns "void"
doc [[!
]]
native "NETWORK_EARN_FROM_BETTING"
hash "0x827A5BA1A44ACA6D"
jhash (0xA0F7F07C)
arguments {
int "amount" [=[ {} ]=],
charPtr "p1" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
]]
native "NETWORK_EARN_FROM_BOUNTY"
hash "0x131BB5DA15453ACF"
jhash (0x127F2DAE)
arguments {
int "amount" [=[ {} ]=],
intPtr "networkHandle" [=[ {} ]=],
AnyPtr "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
]]
native "NETWORK_EARN_FROM_CHALLENGE_WIN"
hash "0x2B171E6B2F64D8DF"
jhash (0x2BEFB6C4)
arguments {
Any "p0" [=[ {} ]=],
AnyPtr "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
alias "0x2B171E6B2F64D8DF"
ns "MONEY"
returns "void"
doc [[!
]]
native "NETWORK_EARN_FROM_CRATE_DROP"
hash "0xB1CC1B9EC3007A2A"
jhash (0xEAF04923)
arguments {
int "amount" [=[ {} ]=],
}
alias "0xB1CC1B9EC3007A2A"
ns "MONEY"
returns "void"
doc [[!
]]
native "NETWORK_EARN_FROM_DAILY_OBJECTIVES"
hash "0x6EA318C91C1A8786"
jhash (0xAB6BD72F)
arguments {
int "p0" [=[ {} ]=],
charPtr "p1" [=[ {} ]=],
int "p2" [=[ {} ]=],
}
alias "0x6EA318C91C1A8786"
alias "_NETWORK_EARN_FROM_DAILY_OBJECTIVE"
ns "MONEY"
returns "void"
doc [[!
]]
native "NETWORK_EARN_FROM_HOLDUPS"
hash "0x45B8154E077D9E4D"
jhash (0xE6B90E9C)
arguments {
int "amount" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
]]
native "NETWORK_EARN_FROM_IMPORT_EXPORT"
hash "0xF92A014A634442D6"
jhash (0xF11FC458)
arguments {
int "amount" [=[ {} ]=],
Hash "modelHash" [=[ {"cs_type":"Any"} ]=],
}
ns "MONEY"
returns "void"
doc [[!
]]
native "NETWORK_EARN_FROM_JOB"
hash "0xB2CC4836834E8A98"
jhash (0x0B6997FC)
arguments {
int "amount" [=[ {} ]=],
charPtr "p1" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
]]
native "NETWORK_EARN_FROM_JOB_BONUS"
hash "0x6816FB4416760775"
jhash (0xBEE23713)
arguments {
Any "p0" [=[ {} ]=],
AnyPtr "p1" [=[ {} ]=],
AnyPtr "p2" [=[ {} ]=],
}
alias "0x6816FB4416760775"
alias "_NETWORK_EARN_FROM_JOB_BONUS"
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v323
```
]]
native "NETWORK_EARN_FROM_NOT_BADSPORT"
hash "0x4337511FA8221D36"
jhash (0xCC068380)
arguments {
int "amount" [=[ {} ]=],
}
alias "0x4337511FA8221D36"
ns "MONEY"
returns "void"
doc [[!
]]
native "NETWORK_EARN_FROM_PERSONAL_VEHICLE"
hash "0x3F4D00167E41E0AD"
jhash (0x96B8BEE8)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
Any "p6" [=[ {} ]=],
Any "p7" [=[ {} ]=],
Any "p8" [=[ {} ]=],
}
alias "0x3F4D00167E41E0AD"
ns "MONEY"
returns "void"
doc [[!
]]
native "NETWORK_EARN_FROM_PICKUP"
hash "0xED1517D3AF17C698"
jhash (0x70A0ED62)
arguments {
int "amount" [=[ {} ]=],
}
ns "MONEY"
annotations [=[ {"cs_type":"Any"} ]=]
returns "void"
doc [[!
]]
native "NETWORK_EARN_FROM_PROPERTY"
hash "0x849648349D77F5C5"
jhash (0x9BE4F7E1)
arguments {
int "amount" [=[ {} ]=],
Hash "propertyName" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
]]
native "NETWORK_EARN_FROM_ROCKSTAR"
hash "0x02CE1D6AC0FC73EA"
jhash (0x5A3733CC)
arguments {
int "amount" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
]]
native "NETWORK_EARN_FROM_VEHICLE"
hash "0xB539BD8A4C1EECF8"
jhash (0xF803589D)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
Any "p6" [=[ {} ]=],
Any "p7" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
]]
native "NETWORK_GET_EVC_BALANCE"
hash "0x5D1E75F91C07DEE5"
jhash (0xF1EDB7F4)
ns "MONEY"
returns "int"
doc [[!
```
NativeDB Introduced: v323
```
]]
native "NETWORK_GET_PVC_BALANCE"
hash "0x4F54F3B6C202FB4E"
jhash (0x56485B56)
ns "MONEY"
returns "int"
doc [[!
```
NativeDB Introduced: v323
```
]]
native "NETWORK_GET_PVC_TRANSFER_BALANCE"
hash "0x13A8DE2FD77D04F3"
jhash (0xC670C814)
alias "_NETWORK_GET_REMAINING_VC_DAILY_TRANSFERS"
ns "MONEY"
returns "int"
doc [[!
```
Same as 0xEA560AC9EEB1E19B.
```
```
Same as 0xEA560AC9EEB1E19B.
NativeDB Introduced: v323
```
]]
native "NETWORK_GET_REMAINING_TRANSFER_BALANCE"
hash "0xEA560AC9EEB1E19B"
jhash (0xA9021211)
alias "_NETWORK_GET_REMAINING_VC_DAILY_TRANSFERS_2"
ns "MONEY"
returns "int"
doc [[!
```
Same as 0x13A8DE2FD77D04F3.
NativeDB Introduced: v323
```
]]
native "NETWORK_GET_STRING_BANK_BALANCE"
hash "0xA6FA3979BED01B81"
jhash (0xAA7EA3BD)
alias "0xA6FA3979BED01B81"
alias "_NETWORK_GET_BANK_BALANCE_STRING"
ns "MONEY"
returns "charPtr"
doc [[!
]]
native "NETWORK_GET_STRING_BANK_WALLET_BALANCE"
hash "0x700AF71AE615E6DD"
jhash (0x7D4FD28C)
ns "MONEY"
returns "charPtr"
doc [[!
```
NativeDB Introduced: v323
```
]]
native "NETWORK_GET_STRING_WALLET_BALANCE"
hash "0xF9B10B529DCFB33B"
jhash (0xC1A11435)
arguments {
int "characterSlot" [=[ {} ]=],
}
ns "MONEY"
returns "charPtr"
doc [[!
```
NativeDB Introduced: v323
```
]]
native "NETWORK_GET_VC_BALANCE"
hash "0x5CBAD97E059E1B94"
jhash (0xADF8F882)
alias "0x5CBAD97E059E1B94"
ns "MONEY"
returns "int"
doc [[!
]]
native "NETWORK_GET_VC_BANK_BALANCE"
hash "0x76EF28DA05EA395A"
jhash (0x16184FB5)
alias "0x76EF28DA05EA395A"
ns "MONEY"
returns "int"
doc [[!
]]
native "NETWORK_GET_VC_WALLET_BALANCE"
hash "0xA40F9C2623F6A8B5"
jhash (0x4F5B781C)
arguments {
int "characterSlot" [=[ {} ]=],
}
alias "0xA40F9C2623F6A8B5"
ns "MONEY"
returns "int"
doc [[!
]]
native "NETWORK_GIVE_PLAYER_JOBSHARE_CASH"
hash "0xFB18DF9CB95E0105"
jhash (0xC6047FDB)
arguments {
int "amount" [=[ {} ]=],
intPtr "networkHandle" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
]]
native "NETWORK_INITIALIZE_CASH"
hash "0x3DA5ECD1A56CBA6D"
jhash (0x66DA9935)
arguments {
int "wallet" [=[ {} ]=],
int "bank" [=[ {} ]=],
}
alias "0x3DA5ECD1A56CBA6D"
ns "MONEY"
returns "void"
doc [[!
]]
native "NETWORK_MONEY_CAN_BET"
hash "0x81404F3DC124FE5B"
jhash (0x8474E6F0)
arguments {
int "amount" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
alias "0x81404F3DC124FE5B"
ns "MONEY"
returns "BOOL"
doc [[!
]]
native "NETWORK_PAY_EMPLOYEE_WAGE"
hash "0x5FD5ED82CBBE9989"
jhash (0xBE70849B)
arguments {
Any "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
alias "0x5FD5ED82CBBE9989"
ns "MONEY"
returns "void"
doc [[!
]]
native "NETWORK_PAY_MATCH_ENTRY_FEE"
hash "0x9346E14F2AF74D46"
jhash (0x224A3488)
arguments {
int "amount" [=[ {} ]=],
charPtr "matchId" [=[ {"cs_type":"intPtr"} ]=],
BOOL "p2" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
}
alias "0x9346E14F2AF74D46"
ns "MONEY"
returns "void"
doc [[!
]]
native "NETWORK_PAY_UTILITY_BILL"
hash "0xAFE08B35EC0C9EAE"
jhash (0x451A2644)
arguments {
int "amount" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
alias "0xAFE08B35EC0C9EAE"
ns "MONEY"
returns "void"
doc [[!
]]
native "NETWORK_RECEIVE_PLAYER_JOBSHARE_CASH"
hash "0x56A3B51944C50598"
jhash (0x4ED71C1A)
arguments {
int "value" [=[ {} ]=],
intPtr "networkHandle" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
]]
native "NETWORK_REFUND_CASH"
hash "0xF9C812CD7C46E817"
jhash (0x07C92F21)
arguments {
int "index" [=[ {} ]=],
charPtr "context" [=[ {} ]=],
charPtr "reason" [=[ {} ]=],
BOOL "unk" [=[ {} ]=],
}
alias "0xF9C812CD7C46E817"
ns "MONEY"
returns "void"
doc [[!
```
index
-------
See function sub_1005 in am_boat_taxi.ysc
context
----------
"BACKUP_VAGOS"
"BACKUP_LOST"
"BACKUP_FAMILIES"
"HIRE_MUGGER"
"HIRE_MERCENARY"
"BUY_CARDROPOFF"
"HELI_PICKUP"
"BOAT_PICKUP"
"CLEAR_WANTED"
"HEAD_2_HEAD"
"CHALLENGE"
"SHARE_LAST_JOB"
"DEFAULT"
reason
---------
"NOTREACHTARGET"
"TARGET_ESCAPE"
"DELIVERY_FAIL"
"NOT_USED"
"TEAM_QUIT"
"SERVER_ERROR"
"RECEIVE_LJ_L"
"CHALLENGE_PLAYER_LEFT"
"DEFAULT"
unk
-----
Unknown bool value
```
]]
native "NETWORK_SPENT_AMMO_DROP"
hash "0xB162DC95C0A3317B"
jhash (0x4B643076)
arguments {
Any "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
]]
native "NETWORK_SPENT_ARREST_BAIL"
hash "0x812F5488B1B2A299"
jhash (0x5AEE2FC1)
arguments {
Any "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
]]
native "NETWORK_SPENT_BANK_INTEREST"
hash "0xCA230C9682556CF1"
jhash (0xF02E92D7)
arguments {
int "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v323
```
]]
native "NETWORK_SPENT_BETTING"
hash "0x1C436FD11FFA692F"
jhash (0xF8A07513)
arguments {
int "amount" [=[ {} ]=],
int "p1" [=[ {} ]=],
charPtr "matchId" [=[ {"cs_type":"AnyPtr"} ]=],
BOOL "p3" [=[ {} ]=],
BOOL "p4" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
]]
native "NETWORK_SPENT_BOAT_PICKUP"
hash "0x524EE43A37232C00"
jhash (0xB241CABD)
arguments {
Any "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
]]
native "NETWORK_SPENT_BOUNTY"
hash "0x29B260B84947DFCC"
jhash (0x3401FC96)
arguments {
Any "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
]]
native "NETWORK_SPENT_BULL_SHARK"
hash "0xA6DD8458CE24012C"
jhash (0xDE7D398C)
arguments {
Any "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
]]
native "NETWORK_SPENT_BUY_OFFTHERADAR"
hash "0xA628A745E2275C5D"
jhash (0x20DDCF2F)
arguments {
Any "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
]]
native "NETWORK_SPENT_BUY_PASSIVE_MODE"
hash "0x6D3A430D1A809179"
jhash (0x7E97C92C)
arguments {
Any "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
]]
native "NETWORK_SPENT_BUY_REVEAL_PLAYERS"
hash "0x6E176F1B18BC0637"
jhash (0x2F7836E2)
arguments {
Any "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
]]
native "NETWORK_SPENT_BUY_WANTEDLEVEL"
hash "0xE1B13771A843C4F6"
jhash (0xE7CB4F95)
arguments {
Any "p0" [=[ {} ]=],
AnyPtr "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
]]
native "NETWORK_SPENT_CALL_PLAYER"
hash "0xACDE7185B374177C"
jhash (0x1A89B5FC)
arguments {
Any "p0" [=[ {} ]=],
AnyPtr "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
]]
native "NETWORK_SPENT_CARWASH"
hash "0xEC03C719DB2F4306"
jhash (0x8283E028)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
BOOL "p4" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
]]
native "NETWORK_SPENT_CASH_DROP"
hash "0x289016EC778D60E0"
jhash (0x87BD1D11)
arguments {
int "amount" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
]]
native "NETWORK_SPENT_CINEMA"
hash "0x6B38ECB05A63A685"
jhash (0x1100CAF5)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
]]
native "NETWORK_SPENT_FROM_ROCKSTAR"
hash "0x6A445B64ED7ABEB5"
jhash (0x54198922)
arguments {
int "bank" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
alias "0x6A445B64ED7ABEB5"
ns "MONEY"
returns "void"
doc [[!
]]
native "NETWORK_SPENT_HELI_PICKUP"
hash "0x7BF1D73DB2ECA492"
jhash (0x27EEBCAB)
arguments {
Any "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
]]
native "NETWORK_SPENT_HIRE_MERCENARY"
hash "0xE7B80E2BF9D80BD6"
jhash (0x99CF02C4)
arguments {
Any "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
]]
native "NETWORK_SPENT_HIRE_MUGGER"
hash "0xE404BFB981665BF0"
jhash (0xE792C4A5)
arguments {
Any "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
Only used once in a script (am_contact_requests)
p1 = 0
p2 = 1
```
]]
native "NETWORK_SPENT_HOLDUPS"
hash "0xD9B86B9872039763"
jhash (0x1B3803B1)
arguments {
Any "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
]]
native "NETWORK_SPENT_IN_STRIPCLUB"
hash "0xEE99784E4467689C"
jhash (0x8957038E)
arguments {
Any "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
}
alias "0xEE99784E4467689C"
ns "MONEY"
returns "void"
doc [[!
]]
native "NETWORK_SPENT_NO_COPS"
hash "0xD5BB406F4E04019F"
jhash (0x2E51C61C)
arguments {
Any "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
alias "0xD5BB406F4E04019F"
ns "MONEY"
returns "void"
doc [[!
]]
native "NETWORK_SPENT_PAY_VEHICLE_INSURANCE_PREMIUM"
hash "0x9FF28D88C766E3E8"
jhash (0x4E665BB2)
arguments {
int "amount" [=[ {} ]=],
Hash "vehicleModel" [=[ {} ]=],
intPtr "networkHandle" [=[ {} ]=],
BOOL "notBankrupt" [=[ {} ]=],
BOOL "hasTheMoney" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
According to how I understood this in the freemode script alone,
The first parameter is determined by a function named, func_5749 within the freemode script which has a list of all the vehicles and a set price to return which some vehicles deals with globals as well. So the first parameter is basically the set in stone insurance cost it's gonna charge you for that specific vehicle model.
The second parameter whoever put it was right, they call GET_ENTITY_MODEL with the vehicle as the paremeter.
The third parameter is the network handle as they call their little struct<13> func or atleast how the script decompiled it to look which in lamens terms just returns the network handle of the previous owner based on DECOR_GET_INT(vehicle, "Previous_Owner").
The fourth parameter is a bool that returns true/false depending on if your bank balance is greater then 0.
The fifth and last parameter is a bool that returns true/false depending on if you have the money for the car based on the cost returned by func_5749. In the freemode script eg,
bool hasTheMoney = MONEY::_GET_BANK_BALANCE() < carCost.
```
]]
native "NETWORK_SPENT_PLAYER_HEALTHCARE"
hash "0x7C99101F7FCE2EE5"
jhash (0x3D96A21C)
arguments {
int "p0" [=[ {} ]=],
int "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
}
alias "0x7C99101F7FCE2EE5"
ns "MONEY"
returns "void"
doc [[!
]]
native "NETWORK_SPENT_PROSTITUTES"
hash "0xB21B89501CFAC79E"
jhash (0x78436D07)
arguments {
Any "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
]]
native "NETWORK_SPENT_REQUEST_HEIST"
hash "0x9D26502BB97BFE62"
jhash (0xF4287778)
arguments {
Any "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
alias "0x9D26502BB97BFE62"
alias "_NETWORK_SPENT_REQUEST_HEIST"
ns "MONEY"
returns "void"
doc [[!
]]
native "NETWORK_SPENT_REQUEST_JOB"
hash "0x8204DA7934DF3155"
jhash (0xD57A5125)
arguments {
Any "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
alias "0x8204DA7934DF3155"
ns "MONEY"
returns "void"
doc [[!
]]
native "NETWORK_SPENT_ROBBED_BY_MUGGER"
hash "0x995A65F15F581359"
jhash (0xE6AAA0D5)
arguments {
int "amount" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
alias "0x995A65F15F581359"
ns "MONEY"
returns "void"
doc [[!
]]
native "NETWORK_SPENT_TAXI"
hash "0x17C3A7D31EAE39F9"
jhash (0x1F3DB3E3)
arguments {
int "amount" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
]]
native "NETWORK_SPENT_TELESCOPE"
hash "0x7FE61782AD94CC09"
jhash (0xAE7FF044)
arguments {
Any "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
]]
native "PROCESS_CASH_GIFT"
hash "0x20194D48EAEC9A41"
jhash (0xC5D8B1E9)
arguments {
intPtr "p0" [=[ {} ]=],
intPtr "p1" [=[ {} ]=],
charPtr "p2" [=[ {} ]=],
}
alias "0x20194D48EAEC9A41"
ns "MONEY"
returns "charPtr"
doc [[!
]]
native "WITHDRAW_VC"
hash "0xF70EFA14FE091429"
jhash (0x8B755993)
arguments {
int "amount" [=[ {} ]=],
}
alias "0xF70EFA14FE091429"
ns "MONEY"
returns "int"
doc [[!
```
Does nothing and always returns 0.
```
]]
native "_CAN_PAY_GOON"
hash "0x9777734DAD16992F"
alias "0x9777734DAD16992F"
ns "MONEY"
returns "BOOL"
doc [[!
```
NativeDB Added Parameter 1: int p0
NativeDB Added Parameter 2: int p1
NativeDB Added Parameter 3: int amount
NativeDB Added Parameter 4: int* p3
```
]]
native "_NETWORK_BUY_CONTRABAND"
hash "0x30FD873ECE50E9F6"
arguments {
int "p0" [=[ {} ]=],
int "p1" [=[ {} ]=],
Hash "p2" [=[ {"cs_type":"Any"} ]=],
BOOL "p3" [=[ {} ]=],
BOOL "p4" [=[ {} ]=],
}
alias "0x30FD873ECE50E9F6"
ns "MONEY"
returns "void"
doc [[!
]]
native "_NETWORK_CAN_SPEND_MONEY_2"
hash "0x7303E27CC6532080"
arguments {
Any "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
AnyPtr "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
}
alias "0x7303E27CC6532080"
ns "MONEY"
returns "BOOL"
doc [[!
```
NETWORK_CAN_R??? or NETWORK_CAN_S???
```
```
NativeDB Added Parameter 7: Any p6
```
]]
native "_NETWORK_CASINO_CAN_GAMBLE"
hash "0xF62F6D9528358FE4"
arguments {
Any "p0" [=[ {} ]=],
}
ns "MONEY"
returns "BOOL"
doc [[!
NETWORK_C\*
```
NativeDB Introduced: v1734
```
]]
native "_NETWORK_CASINO_CAN_PURCHASE_CHIPS_WITH_PVC"
hash "0x394DCDB9E836B7A9"
ns "MONEY"
returns "BOOL"
doc [[!
Same as 0x8968D4D8C6C40C11.
NETWORK_C\*
```
NativeDB Introduced: v1734
```
]]
native "_NETWORK_CASINO_CAN_PURCHASE_CHIPS_WITH_PVC_2"
hash "0x8968D4D8C6C40C11"
ns "MONEY"
returns "BOOL"
doc [[!
Same as 0x394DCDB9E836B7A9.
NETWORK_C\*
```
NativeDB Introduced: v1734
```
]]
native "_NETWORK_CASINO_CAN_USE_GAMBLING_TYPE"
hash "0x158C16F5E4CF41F8"
arguments {
Hash "hash" [=[ {} ]=],
}
ns "MONEY"
returns "BOOL"
doc [[!
GTAO_CASINO_HOUSE
GTAO_CASINO_INSIDETRACK
GTAO_CASINO_LUCKYWHEEL
GTAO_CASINO_BLACKJACK
GTAO_CASINO_ROULETTE
GTAO_CASINO_SLOTS
GTAO_CASINO_PURCHASE_CHIPS
NETWORK_C\*
```
NativeDB Introduced: v1734
```
]]
native "_NETWORK_CASINO_PURCHASE_CHIPS"
hash "0x3BD101471C7F9EEC"
arguments {
int "p0" [=[ {} ]=],
int "p1" [=[ {} ]=],
}
ns "MONEY"
returns "BOOL"
doc [[!
NETWORK_C\*
```
NativeDB Introduced: v1734
```
]]
native "_NETWORK_CASINO_SELL_CHIPS"
hash "0xED44897CB336F480"
arguments {
int "p0" [=[ {} ]=],
int "p1" [=[ {} ]=],
}
ns "MONEY"
returns "BOOL"
doc [[!
NETWORK_C\*
```
NativeDB Introduced: v1734
```
]]
native "_NETWORK_DEDUCT_CASH"
hash "0x18B7AE224B087E26"
arguments {
int "amount" [=[ {} ]=],
charPtr "p1" [=[ {} ]=],
charPtr "p2" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
BOOL "p4" [=[ {} ]=],
BOOL "p5" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v323
```
]]
native "_NETWORK_EARN_BOSS"
hash "0x08B0CA7A6AB3AC32"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
alias "0x08B0CA7A6AB3AC32"
ns "MONEY"
returns "void"
doc [[!
]]
native "_NETWORK_EARN_BOSS_AGENCY"
hash "0x0CB1BE0633C024A8"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
alias "0x0CB1BE0633C024A8"
ns "MONEY"
returns "void"
doc [[!
]]
native "_NETWORK_EARN_BOUNTY_HUNTER_REWARD"
hash "0xF6B170F9A02E9E87"
arguments {
Any "p0" [=[ {} ]=],
}
alias "0xF6B170F9A02E9E87"
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1493
```
]]
native "_NETWORK_EARN_CASINO_HEIST"
hash "0x72E7C7B9615FA3C3"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
Any "p6" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1868
```
]]
native "_NETWORK_EARN_CASINO_HEIST_BONUS"
hash "0x3EC7471E6909798A"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1868
```
]]
native "_NETWORK_EARN_COLLECTABLE_COMPLETED_COLLECTION"
hash "0x5C9B198AF5A54FA6"
arguments {
int "amount" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v2060
```
]]
native "_NETWORK_EARN_FMBB_WAGE_BONUS"
hash "0xFFFBA1B1F7C0B6F4"
arguments {
Any "p0" [=[ {} ]=],
}
alias "0xFFFBA1B1F7C0B6F4"
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1493
```
]]
native "_NETWORK_EARN_FROM_ARENA_CAREER_PROGRESSION"
hash "0x0F99F70C61F14619"
arguments {
int "amount" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1604
```
]]
native "_NETWORK_EARN_FROM_ARENA_SKILL_LEVEL_PROGRESSION"
hash "0xE08256F972C7BB2C"
arguments {
int "amount" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1604
```
]]
native "_NETWORK_EARN_FROM_ARENA_WAR"
hash "0x631F1CB8FB4130AA"
arguments {
int "amount" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1604
```
]]
native "_NETWORK_EARN_FROM_ARMOUR_TRUCK"
hash "0xF514621E8EA463D0"
jhash (0x30B3EC0A)
arguments {
int "amount" [=[ {} ]=],
}
alias "0xF514621E8EA463D0"
ns "MONEY"
returns "void"
doc [[!
```
For the money bags that drop a max of $40,000. Often called 40k bags.
Most likely NETWORK_EARN_FROM_ROB***
```
]]
native "_NETWORK_EARN_FROM_ASSASSINATE_TARGET_KILLED"
hash "0xFA700D8A9905F78A"
arguments {
int "amount" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1604
```
]]
native "_NETWORK_EARN_FROM_ASSASSINATE_TARGET_KILLED_2"
hash "0x5E7AE8AABE8B7C0D"
arguments {
int "amount" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1604
```
]]
native "_NETWORK_EARN_FROM_AUTOSHOP_BUSINESS"
hash "0x36A7FD5A7194B03E"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
alias "0x36A7FD5A7194B03E"
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "_NETWORK_EARN_FROM_AUTOSHOP_INCOME"
hash "0xC66D1CF99ED7FE25"
arguments {
Any "p0" [=[ {} ]=],
}
alias "0xC66D1CF99ED7FE25"
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "_NETWORK_EARN_FROM_BB_EVENT_BONUS"
hash "0xFDD8D2440DAF1590"
arguments {
int "amount" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1604
```
]]
native "_NETWORK_EARN_FROM_BB_EVENT_CARGO"
hash "0xA82959062361B259"
arguments {
int "amount" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1604
```
]]
native "_NETWORK_EARN_FROM_BIKE_SHOP_BUSINESS"
hash "0x2C5809EB9DF57257"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v2699
```
]]
native "_NETWORK_EARN_FROM_BIKER_INCOME"
hash "0x71BEC32FA466E105"
arguments {
Any "p0" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v2699
```
]]
native "_NETWORK_EARN_FROM_BUSINESS_BATTLE"
hash "0x42FCE14F50F27291"
arguments {
Any "p0" [=[ {} ]=],
}
alias "0x42FCE14F50F27291"
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1493
```
]]
native "_NETWORK_EARN_FROM_BUSINESS_HUB_SELL"
hash "0x0B39CF0D53F1C883"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
alias "0x0B39CF0D53F1C883"
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1493
```
]]
native "_NETWORK_EARN_FROM_BUSINESS_HUB_SOURCE"
hash "0x59498BC8B1C8B15C"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v2699
```
]]
native "_NETWORK_EARN_FROM_BUSINESS_PRODUCT"
hash "0x8586789730B10CAF"
arguments {
int "amount" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
alias "0x8586789730B10CAF"
ns "MONEY"
returns "void"
doc [[!
]]
native "_NETWORK_EARN_FROM_CARCLUB_MEMBERSHIP"
hash "0xBC6227792A188E2E"
arguments {
Any "p0" [=[ {} ]=],
}
alias "0xBC6227792A188E2E"
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "_NETWORK_EARN_FROM_CASHING_OUT"
hash "0xEFE9C9A1651B81E6"
arguments {
int "amount" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "_NETWORK_EARN_FROM_CASINO_AWARD"
hash "0x973A9781A34F8DEB"
arguments {
int "amount" [=[ {} ]=],
Hash "hash" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1734
```
]]
native "_NETWORK_EARN_FROM_CASINO_MISSION_PARTICIPATION"
hash "0x09E8F18641BE2575"
arguments {
int "amount" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1734
```
]]
native "_NETWORK_EARN_FROM_CASINO_MISSION_REWARD"
hash "0x566FD402B25787DE"
arguments {
int "amount" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1734
```
]]
native "_NETWORK_EARN_FROM_CASINO_STORY_MISSION_REWARD"
hash "0xAC95ED552157E092"
arguments {
int "amount" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1734
```
]]
native "_NETWORK_EARN_FROM_CLUB_MANAGEMENT_PARTICIPATION"
hash "0xA75EAC69F59E96E7"
arguments {
Any "p0" [=[ {} ]=],
}
alias "0xA75EAC69F59E96E7"
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1493
```
]]
native "_NETWORK_EARN_FROM_COLLECTABLES_ACTION_FIGURES"
hash "0x5517F90043466049"
arguments {
int "amount" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1734
```
]]
native "_NETWORK_EARN_FROM_COLLECTION_ITEM"
hash "0x84FF63BD4966F33D"
arguments {
int "amount" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1734
```
]]
native "_NETWORK_EARN_FROM_COMPLETE_COLLECTION"
hash "0x83AD64F53F4E9483"
arguments {
int "amount" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1734
```
]]
native "_NETWORK_EARN_FROM_CONTRABAND"
hash "0xECA658CE2A4E5A72"
arguments {
int "amount" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
alias "0xECA658CE2A4E5A72"
ns "MONEY"
returns "void"
doc [[!
]]
native "_NETWORK_EARN_FROM_CRIMINAL_MASTERMIND_BONUS"
hash "0xFA009A62990671D4"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
alias "0xD20D79671A598594"
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "_NETWORK_EARN_FROM_DAILY_OBJECTIVE_EVENT"
hash "0x5128DF14A5BB86FC"
arguments {
int "amount" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1734
```
]]
native "_NETWORK_EARN_FROM_DAR_CHALLENGE"
hash "0xCAC672087B4A24AB"
arguments {
int "amount" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "_NETWORK_EARN_FROM_DESTROYING_CONTRABAND"
hash "0x84C0116D012E8FC2"
arguments {
Any "p0" [=[ {} ]=],
}
alias "0x84C0116D012E8FC2"
ns "MONEY"
returns "void"
doc [[!
]]
native "_NETWORK_EARN_FROM_DOOMSDAY_FINALE_BONUS"
hash "0x128A747F4A230952"
arguments {
int "amount" [=[ {} ]=],
Hash "vehicleHash" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "_NETWORK_EARN_FROM_FMBB_BOSS_WORK"
hash "0x1FDA0AA679C9919B"
arguments {
Any "p0" [=[ {} ]=],
}
alias "0x1FDA0AA679C9919B"
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1493
```
]]
native "_NETWORK_EARN_FROM_FMBB_PHONECALL_MISSION"
hash "0xC5156361F26E2212"
arguments {
Any "p0" [=[ {} ]=],
}
alias "0xC5156361F26E2212"
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1493
```
]]
native "_NETWORK_EARN_FROM_GANG_PICKUP"
hash "0xA03D4ACE0A3284CE"
jhash (0x33C20BC4)
arguments {
int "amount" [=[ {} ]=],
}
alias "0xA03D4ACE0A3284CE"
ns "MONEY"
returns "void"
doc [[!
]]
native "_NETWORK_EARN_FROM_GANGOPS_AWARDS"
hash "0xA9A31475F530DFDA"
arguments {
int "amount" [=[ {} ]=],
charPtr "unk" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "_NETWORK_EARN_FROM_GANGOPS_ELITE"
hash "0x2597A0D4A4FC2C77"
arguments {
int "amount" [=[ {} ]=],
charPtr "unk" [=[ {} ]=],
int "actIndex" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "_NETWORK_EARN_FROM_GANGOPS_JOBS_FINALE"
hash "0x1C121FC9545E0D52"
arguments {
int "amount" [=[ {} ]=],
charPtr "unk" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "_NETWORK_EARN_FROM_GANGOPS_JOBS_PREP_PARTICIPATION"
hash "0xED26584F6BDCBBFD"
arguments {
int "amount" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "_NETWORK_EARN_FROM_GANGOPS_JOBS_SETUP"
hash "0xA9160796D47A2CF8"
arguments {
int "amount" [=[ {} ]=],
charPtr "unk" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "_NETWORK_EARN_FROM_GANGOPS_WAGES"
hash "0x2DCB19ABAB0380A8"
arguments {
int "amount" [=[ {} ]=],
int "p1" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "_NETWORK_EARN_FROM_GANGOPS_WAGES_BONUS"
hash "0x15BB2A5C757EB91F"
arguments {
int "amount" [=[ {} ]=],
int "p1" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "_NETWORK_EARN_FROM_HACKER_TRUCK_MISSION"
hash "0xE8815FE993896AD3"
arguments {
Any "p0" [=[ {} ]=],
int "amount" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1493
```
]]
native "_NETWORK_EARN_FROM_JOB_X2"
hash "0xDEBBF584665411D0"
arguments {
int "amount" [=[ {} ]=],
charPtr "p1" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1734
```
]]
native "_NETWORK_EARN_FROM_PREMIUM_JOB"
hash "0xC8407624CEF2354B"
arguments {
int "amount" [=[ {} ]=],
charPtr "p1" [=[ {} ]=],
}
alias "0xC8407624CEF2354B"
ns "MONEY"
returns "void"
doc [[!
]]
native "_NETWORK_EARN_FROM_RC_TIME_TRIAL"
hash "0xDFF49EE984E7AAE8"
arguments {
int "amount" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1734
```
]]
native "_NETWORK_EARN_FROM_RDR_BONUS"
hash "0x7A5349B773584675"
arguments {
int "amount" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "_NETWORK_EARN_FROM_SELL_BASE"
hash "0x0E1E2FF3F4EC11AA"
arguments {
int "amount" [=[ {} ]=],
Hash "baseNameHash" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "_NETWORK_EARN_FROM_SELL_BUNKER"
hash "0x9251B6ABF2D0A5B4"
arguments {
int "amount" [=[ {} ]=],
Hash "bunkerHash" [=[ {"cs_type":"Any"} ]=],
}
alias "0x9251B6ABF2D0A5B4"
ns "MONEY"
returns "void"
doc [[!
]]
native "_NETWORK_EARN_FROM_SELLING_VEHICLE"
hash "0x8BCB27A057DF7B7F"
arguments {
int "amount" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Added Parameter 2: Any p1
NativeDB Added Parameter 3: Any p2
NativeDB Introduced: v1734
```
]]
native "_NETWORK_EARN_FROM_SIGHTSEEING"
hash "0x45087AE480B233AC"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v2699
```
]]
native "_NETWORK_EARN_FROM_SMUGGLING"
hash "0xDEE612F2D71B0308"
arguments {
int "amount" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1180
```
]]
native "_NETWORK_EARN_FROM_SPIN_THE_WHEEL_CASH"
hash "0x676C48776CACBB5A"
arguments {
int "amount" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1604
```
]]
native "_NETWORK_EARN_FROM_TARGET_REFUND"
hash "0x5B669CF2299A271F"
arguments {
int "amount" [=[ {} ]=],
int "p1" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "_NETWORK_EARN_FROM_TIME_TRIAL_WIN"
hash "0x0819DB99FD2FBBD8"
arguments {
int "amount" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1734
```
]]
native "_NETWORK_EARN_FROM_TUNER_AWARD"
hash "0xB846F547D3792DF6"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
alias "0xB846F547D3792DF6"
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "_NETWORK_EARN_FROM_TUNER_FINALE"
hash "0xBCB266247193AC61"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
}
alias "0xBCB266247193AC61"
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "_NETWORK_EARN_FROM_UPGRADE_AUTOSHOP_LOCATION"
hash "0xC10322A8D3E061EE"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
alias "0xC10322A8D3E061EE"
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "_NETWORK_EARN_FROM_VEHICLE_AUTOSHOP"
hash "0x533073E8A596008C"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
alias "0x533073E8A596008C"
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "_NETWORK_EARN_FROM_VEHICLE_AUTOSHOP_BONUS"
hash "0xFE65AFE7308E32B2"
arguments {
Any "p0" [=[ {} ]=],
}
alias "0xFE65AFE7308E32B2"
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "_NETWORK_EARN_FROM_VEHICLE_EXPORT"
hash "0xEDEAD9A91EC768B3"
arguments {
int "amount" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
alias "0xEDEAD9A91EC768B3"
ns "MONEY"
returns "void"
doc [[!
]]
native "_NETWORK_EARN_FROM_WAGE_PAYMENT"
hash "0x35F8DA0E8A31EF1B"
arguments {
int "amount" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1180
```
]]
native "_NETWORK_EARN_FROM_WAGE_PAYMENT_BONUS"
hash "0x005ACA7100BD101D"
arguments {
int "amount" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1180
```
]]
native "_NETWORK_EARN_FROM_WAREHOUSE"
hash "0x3E4ADAFF1830F146"
alias "0x3E4ADAFF1830F146"
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Added Parameter 1: int amount
NativeDB Added Parameter 2: int id
```
]]
native "_NETWORK_EARN_GOON"
hash "0xCDA1C62BE2777802"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
alias "0xCDA1C62BE2777802"
ns "MONEY"
returns "void"
doc [[!
]]
native "_NETWORK_EARN_ISLAND_HEIST"
hash "0xD21D111C46BA9F15"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v2189
```
]]
native "_NETWORK_EARN_JOB_BONUS_FIRST_TIME_BONUS"
hash "0x11B0A20C493F7E36"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
alias "0x11B0A20C493F7E36"
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "_NETWORK_EARN_JOB_BONUS_HEIST_AWARD"
hash "0x9D4FDBB035229669"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
alias "0x9D4FDBB035229669"
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "_NETWORK_GET_IS_HIGH_EARNER"
hash "0xFB2456B2040A6A67"
jhash (0x63F093A6)
ns "MONEY"
returns "BOOL"
doc [[!
```
NativeDB Introduced: v323
```
]]
native "_NETWORK_GET_VC_BANK_BALANCE_IS_NOT_LESS_THAN"
hash "0xA31FD6A0865B6D14"
jhash (0xABED6020)
arguments {
int "amount" [=[ {} ]=],
}
ns "MONEY"
returns "BOOL"
doc [[!
```
Returns true if bank balance >= amount.
NativeDB Introduced: v323
```
]]
native "_NETWORK_GET_VC_BANK_WALLET_BALANCE_IS_NOT_LESS_THAN"
hash "0xDC18531D7019A535"
jhash (0xCA23FD25)
arguments {
int "amount" [=[ {} ]=],
int "characterSlot" [=[ {} ]=],
}
alias "0xDC18531D7019A535"
ns "MONEY"
returns "BOOL"
doc [[!
```
Returns true if bank balance + wallet balance >= amount.
```
]]
native "_NETWORK_GET_VC_WALLET_BALANCE_IS_NOT_LESS_THAN"
hash "0xED5AB8860415BABA"
jhash (0x0EA2188C)
arguments {
int "amount" [=[ {} ]=],
int "characterSlot" [=[ {} ]=],
}
ns "MONEY"
returns "BOOL"
doc [[!
```
Returns true if wallet balance >= amount.
NativeDB Introduced: v323
```
]]
native "_NETWORK_MANUAL_DELETE_CHARACTER"
hash "0x821418C727FCACD7"
arguments {
int "characterSlot" [=[ {} ]=],
}
alias "0x821418C727FCACD7"
ns "MONEY"
returns "void"
doc [[!
]]
native "_NETWORK_RIVAL_DELIVERY_COMPLETED"
hash "0x1B882107C23A9022"
arguments {
int "earnedMoney" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "_NETWORK_SPENT_ARCADE_GAME"
hash "0xEAD3D81F2C3A1458"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1868
```
]]
native "_NETWORK_SPENT_ARCADE_GENERIC"
hash "0x43AA7FAC4E6D6687"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1868
```
]]
native "_NETWORK_SPENT_ARENA_JOIN_SPECTATOR"
hash "0x14EAEA58F93B55AF"
arguments {
int "amount" [=[ {} ]=],
Any "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1604
```
]]
native "_NETWORK_SPENT_ARENA_PREMIUM"
hash "0x619496D837EFD920"
arguments {
int "amount" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1604
```
]]
native "_NETWORK_SPENT_ARENA_SPECTATOR_BOX"
hash "0x7049BF858601DC0F"
arguments {
int "amount" [=[ {} ]=],
Any "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1604
```
]]
native "_NETWORK_SPENT_AUTOSHOP_MODIFICATIONS"
hash "0x9BEA350D7C48061B"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
}
alias "0x9BEA350D7C48061B"
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "_NETWORK_SPENT_AUTOSHOP_PROPERTY_UTILITY_FEE"
hash "0xB40F96D6D252839B"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
alias "0xB40F96D6D252839B"
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "_NETWORK_SPENT_BA_SERVICE"
hash "0xD7CCCBA28C4ECAF0"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
}
alias "0xD7CCCBA28C4ECAF0"
ns "MONEY"
returns "void"
doc [[!
]]
native "_NETWORK_SPENT_BALLISTIC_EQUIPMENT"
hash "0x5D97630A8A0EF123"
arguments {
int "amount" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
alias "0x5D97630A8A0EF123"
ns "MONEY"
returns "void"
doc [[!
]]
native "_NETWORK_SPENT_BEACH_PARTY_GENERIC"
hash "0x54ABA22FA6371249"
arguments {
Any "p0" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v2189
```
]]
native "_NETWORK_SPENT_BIKE_SHOP_MODIFY"
hash "0x923AEA8E78F8DF0B"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v2699
```
]]
native "_NETWORK_SPENT_BOSS"
hash "0xFFBE02CD385356BD"
alias "0xFFBE02CD385356BD"
ns "MONEY"
returns "BOOL"
doc [[!
```
NativeDB Added Parameter 1: int amount
NativeDB Added Parameter 2: BOOL p1
NativeDB Added Parameter 3: BOOL p2
```
]]
native "_NETWORK_SPENT_BOUNTY_HUNTER_MISSION"
hash "0x1BEA0CD93470BB1F"
arguments {
int "amount" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1493
```
]]
native "_NETWORK_SPENT_BUSINESS"
hash "0x0035BB914316F1E3"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
alias "0x0035BB914316F1E3"
ns "MONEY"
returns "void"
doc [[!
]]
native "_NETWORK_SPENT_BUY_ARENA"
hash "0x40D5DA9550B7CB46"
arguments {
int "amount" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
charPtr "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1604
```
]]
native "_NETWORK_SPENT_BUY_AUTOSHOP"
hash "0xEEB7E5D1FEB20869"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
alias "0xEEB7E5D1FEB20869"
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "_NETWORK_SPENT_BUY_BASE"
hash "0x4EA3F425C7744D21"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "_NETWORK_SPENT_BUY_BUNKER"
hash "0x12D148D26538D0F9"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
alias "0x12D148D26538D0F9"
ns "MONEY"
returns "void"
doc [[!
]]
native "_NETWORK_SPENT_BUY_CASINO"
hash "0x34A6FC4D06C4DA0F"
arguments {
int "amount" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
AnyPtr "data" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1734
```
]]
native "_NETWORK_SPENT_BUY_TILTROTOR"
hash "0x0CCE73BC7A11E885"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "_NETWORK_SPENT_BUY_TRUCK"
hash "0xAC272C0AE01B4BD8"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
alias "0xAC272C0AE01B4BD8"
ns "MONEY"
returns "void"
doc [[!
]]
native "_NETWORK_SPENT_CARCLUB"
hash "0x925227803A0EAA1B"
arguments {
Any "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
alias "0x925227803A0EAA1B"
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "_NETWORK_SPENT_CARCLUB_MEMBERSHIP"
hash "0x1464E17207CD36E2"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
}
alias "0x1464E17207CD36E2"
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "_NETWORK_SPENT_CARCLUB_TAKEOVER"
hash "0xD1E46824E6FB92B5"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
alias "0xD1E46824E6FB92B5"
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "_NETWORK_SPENT_CARGO_SOURCING"
hash "0x948705F6F9C50824"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v2699
```
]]
native "_NETWORK_SPENT_CASINO_CLUB_GENERIC"
hash "0xC991C255AA6D90B2"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
Any "p6" [=[ {} ]=],
Any "p7" [=[ {} ]=],
Any "p8" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v2189
```
]]
native "_NETWORK_SPENT_CASINO_GENERIC"
hash "0x88BF9B612B84D3C3"
arguments {
int "amount" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1734
```
]]
native "_NETWORK_SPENT_CASINO_HEIST"
hash "0xD30E8392F407C328"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
Any "p6" [=[ {} ]=],
Any "p7" [=[ {} ]=],
Any "p8" [=[ {} ]=],
Any "p9" [=[ {} ]=],
Any "p10" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1868
```
]]
native "_NETWORK_SPENT_CASINO_HEIST_SKIP_MISSION"
hash "0x487009DD91D93429"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1868
```
]]
native "_NETWORK_SPENT_CASINO_MEMBERSHIP"
hash "0xFBBE0570EDF39D46"
arguments {
int "amount" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
int "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1734
```
]]
native "_NETWORK_SPENT_EMPLOY_ASSASSINS"
hash "0x5BBBD92186E1F1C5"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "_NETWORK_SPENT_FROM_BANK"
hash "0xB9F7A469460E7A4A"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
}
alias "0xB9F7A469460E7A4A"
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "_NETWORK_SPENT_GANGOPS_CANNON"
hash "0x771ADB0E7635B7BF"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "_NETWORK_SPENT_GANGOPS_START_MISSION"
hash "0xDA947AE8880D5C18"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "_NETWORK_SPENT_GANGOPS_START_STRAND"
hash "0xA19EC0786E326E06"
arguments {
int "type" [=[ {} ]=],
int "amount" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "_NETWORK_SPENT_GANGOPS_TRIP_SKIP"
hash "0x5ECE6FD7B4EC8D6A"
arguments {
int "amount" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "_NETWORK_SPENT_GUNRUNNING_CONTACT_SERVICE"
hash "0x2CEB0E0BC2A77C05"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v2699
```
]]
native "_NETWORK_SPENT_HANGAR_STAFF_CHARGES"
hash "0xB1F1346FD57685D7"
arguments {
int "amount" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1180
```
]]
native "_NETWORK_SPENT_HANGAR_UTILITY_CHARGES"
hash "0xB18AC2ECBB15CB6A"
arguments {
int "amount" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1180
```
]]
native "_NETWORK_SPENT_IM_ABILITY"
hash "0x93AA4165CB67E925"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
alias "0x93AA4165CB67E925"
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "_NETWORK_SPENT_IMPORT_EXPORT_REPAIR"
hash "0xC1952F3773BA18FE"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
alias "0xC1952F3773BA18FE"
ns "MONEY"
returns "void"
doc [[!
]]
native "_NETWORK_SPENT_ISLAND_HEIST"
hash "0xE86689E5F82DE429"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v2189
```
]]
native "_NETWORK_SPENT_JOB_SKIP"
hash "0x28F174A67B8D0C2F"
arguments {
int "amount" [=[ {} ]=],
charPtr "matchId" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v323
```
]]
native "_NETWORK_SPENT_JUKEBOX"
hash "0x5BCDE0F640C773D2"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
alias "0x5BCDE0F640C773D2"
ns "MONEY"
returns "void"
doc [[!
]]
native "_NETWORK_SPENT_MAKE_IT_RAIN"
hash "0xE5F5A060439C2F5D"
arguments {
int "amount" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1604
```
]]
native "_NETWORK_SPENT_MOVE_YACHT"
hash "0xE7DF4E0545DFB56E"
arguments {
int "amount" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
alias "0xE7DF4E0545DFB56E"
ns "MONEY"
returns "void"
doc [[!
]]
native "_NETWORK_SPENT_NIGHTCLUB_BAR_DRINK"
hash "0xDD21B016E4289465"
arguments {
int "amount" [=[ {} ]=],
Any "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1493
```
]]
native "_NETWORK_SPENT_NIGHTCLUB_ENTRY_FEE"
hash "0x876056684281655D"
arguments {
Player "player" [=[ {} ]=],
int "amount" [=[ {} ]=],
Any "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1493
```
]]
native "_NETWORK_SPENT_ORDER_BODYGUARD_VEHICLE"
hash "0xE8B0B270B6E7C76E"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
alias "0xE8B0B270B6E7C76E"
ns "MONEY"
returns "void"
doc [[!
]]
native "_NETWORK_SPENT_ORDER_WAREHOUSE_VEHICLE"
hash "0x05F04155A226FBBF"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
alias "0x05F04155A226FBBF"
ns "MONEY"
returns "void"
doc [[!
]]
native "_NETWORK_SPENT_PA_SERVICE_DANCER"
hash "0xB49ECA122467D05F"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
alias "0xB49ECA122467D05F"
ns "MONEY"
returns "void"
doc [[!
]]
native "_NETWORK_SPENT_PA_SERVICE_HELI_PICKUP"
hash "0x0FE8E1FCD2B86B33"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
alias "0x0FE8E1FCD2B86B33"
ns "MONEY"
returns "void"
doc [[!
]]
native "_NETWORK_SPENT_PAY_BOSS"
hash "0xDBC966A01C02BCA7"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
alias "0xDBC966A01C02BCA7"
ns "MONEY"
returns "void"
doc [[!
]]
native "_NETWORK_SPENT_PAY_GOON"
hash "0x08A1B82B91900682"
arguments {
int "p0" [=[ {} ]=],
int "p1" [=[ {} ]=],
int "amount" [=[ {} ]=],
}
alias "0x08A1B82B91900682"
ns "MONEY"
returns "void"
doc [[!
]]
native "_NETWORK_SPENT_PURCHASE_HANGAR"
hash "0xCCB339CC970452DA"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1180
```
]]
native "_NETWORK_SPENT_PURCHASE_WAREHOUSE"
hash "0x33981D6804E62F49"
arguments {
int "amount" [=[ {} ]=],
Any "data" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
}
alias "0x33981D6804E62F49"
ns "MONEY"
returns "void"
doc [[!
]]
native "_NETWORK_SPENT_RDRHATCHET_BONUS"
hash "0xE284D46FFDB82E36"
arguments {
int "amount" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1493
```
]]
native "_NETWORK_SPENT_REHIRE_DJ"
hash "0xF6C8A544E4CF14FC"
arguments {
int "amount" [=[ {} ]=],
Any "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1493
```
]]
native "_NETWORK_SPENT_RENAME_ORGANIZATION"
hash "0xFC4EE00A7B3BFB76"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
alias "0xFC4EE00A7B3BFB76"
ns "MONEY"
returns "void"
doc [[!
]]
native "_NETWORK_SPENT_SALES_DISPLAY"
hash "0x7E2F4E8F44CAF4E0"
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v2699
```
]]
native "_NETWORK_SPENT_SPIN_THE_WHEEL_PAYMENT"
hash "0x9A5BD1D0000B339C"
arguments {
int "amount" [=[ {} ]=],
Any "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1604
NativeDB Removed Parameter 4: BOOL p3
```
]]
native "_NETWORK_SPENT_SUBMARINE"
hash "0x6C8BC1488527AAAB"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v2189
```
]]
native "_NETWORK_SPENT_UPGRADE_ARENA"
hash "0x037ABB06825D7AB1"
arguments {
int "amount" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
charPtr "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1604
```
]]
native "_NETWORK_SPENT_UPGRADE_AUTOSHOP"
hash "0xDD829AA198FDC46C"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
alias "0xDD829AA198FDC46C"
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "_NETWORK_SPENT_UPGRADE_BASE"
hash "0x3DD3F33A5D55EA6F"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "_NETWORK_SPENT_UPGRADE_BUNKER"
hash "0x0C82D21A77C22D49"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
alias "0x0C82D21A77C22D49"
ns "MONEY"
returns "void"
doc [[!
]]
native "_NETWORK_SPENT_UPGRADE_CASINO"
hash "0x4740D62BC1B4EBEA"
arguments {
int "amount" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
AnyPtr "data" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1734
```
]]
native "_NETWORK_SPENT_UPGRADE_HANGAR"
hash "0x615EB504B0788DAF"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1180
```
]]
native "_NETWORK_SPENT_UPGRADE_SUB"
hash "0x89049A84065CE68E"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
alias "0x89049A84065CE68E"
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v2189
```
]]
native "_NETWORK_SPENT_UPGRADE_TILTROTOR"
hash "0x165E135D6DFA2907"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "_NETWORK_SPENT_UPGRADE_TRUCK"
hash "0x365E877C61D6988B"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
alias "0x365E877C61D6988B"
ns "MONEY"
returns "void"
doc [[!
]]
native "_NETWORK_SPENT_VEHICLE_EXPORT_MODS"
hash "0xA75CCF58A60A5FD1"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
Any "p6" [=[ {} ]=],
Any "p7" [=[ {} ]=],
Any "p8" [=[ {} ]=],
Any "p9" [=[ {} ]=],
}
alias "0xA75CCF58A60A5FD1"
ns "MONEY"
returns "void"
doc [[!
]]
native "_NETWORK_SPENT_VEHICLE_REQUESTED"
hash "0x02D24A35A9CC3503"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v2699
```
]]
native "_NETWORK_SPENT_VIP_UTILITY_CHARGES"
hash "0x5182A339A3474510"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
alias "0x5182A339A3474510"
ns "MONEY"
returns "void"
doc [[!
]]
native "_NETWORK_SPENT_WAGER"
hash "0xD99DB210089617FE"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
int "amount" [=[ {} ]=],
}
alias "0xD99DB210089617FE"
ns "MONEY"
returns "void"
doc [[!
]]
native "0x08E8EEADFD0DC4A0"
hash "0x08E8EEADFD0DC4A0"
jhash (0x03461981)
arguments {
int "amount" [=[ {} ]=],
}
ns "MONEY"
returns "BOOL"
doc [[!
```
Returns false if amount > wallet balance or daily transfer limit has been hit.
NativeDB Introduced: v323
```
]]
native "0x0D30EB83668E63C5"
hash "0x0D30EB83668E63C5"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
]]
native "0x0DD362F14F18942A"
hash "0x0DD362F14F18942A"
arguments {
int "amount" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1868
```
]]
native "0x112209CE0290C03A"
hash "0x112209CE0290C03A"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
]]
native "0x1DC9B749E7AE282B"
hash "0x1DC9B749E7AE282B"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1493
```
]]
native "0x226C284C830D0CA8"
hash "0x226C284C830D0CA8"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1493
```
]]
native "0x2A7CEC72C3443BCC"
hash "0x2A7CEC72C3443BCC"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "0x2A93C46AAB1EACC9"
hash "0x2A93C46AAB1EACC9"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1493
```
]]
native "0x2AFC2D19B50797F2"
hash "0x2AFC2D19B50797F2"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
]]
native "0x2FAB6614CE22E196"
hash "0x2FAB6614CE22E196"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
]]
native "0x31BA138F6304FB9F"
hash "0x31BA138F6304FB9F"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1180
```
]]
native "0x4128464231E3CA0B"
hash "0x4128464231E3CA0B"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
]]
native "0x4C3B75694F7E0D9C"
hash "0x4C3B75694F7E0D9C"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1868
```
]]
native "0x5574637681911FDA"
hash "0x5574637681911FDA"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1868
```
]]
native "0x55A1E095DB052FA5"
hash "0x55A1E095DB052FA5"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
]]
native "0x5F456788B05FAEAC"
hash "0x5F456788B05FAEAC"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
]]
native "0x65482BFD0923C8A1"
hash "0x65482BFD0923C8A1"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1493
```
]]
native "0x675D19C6067CAE08"
hash "0x675D19C6067CAE08"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
]]
native "0x69EF772B192614C1"
hash "0x69EF772B192614C1"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
]]
native "0x6B7E4FB50D5F3D65"
hash "0x6B7E4FB50D5F3D65"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1180
```
]]
native "0x6FCF8DDEA146C45B"
hash "0x6FCF8DDEA146C45B"
jhash (0xB96C7ABE)
arguments {
Any "p0" [=[ {} ]=],
}
ns "MONEY"
returns "BOOL"
doc [[!
```
This function is hard-coded to always return 1.
```
]]
native "0x6FD97159FE3C971A"
hash "0x6FD97159FE3C971A"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
]]
native "0x7C4FCCD2E4DEB394"
hash "0x7C4FCCD2E4DEB394"
jhash (0x468CC978)
ns "MONEY"
returns "BOOL"
doc [[!
]]
native "0x870289A558348378"
hash "0x870289A558348378"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1868
```
]]
native "0x8E243837643D9583"
hash "0x8E243837643D9583"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
]]
native "0x90CD7C6871FBF1B4"
hash "0x90CD7C6871FBF1B4"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v2189
```
]]
native "0x998E18CEB44487FC"
hash "0x998E18CEB44487FC"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
]]
native "0x9B5016A6433A68C5"
hash "0x9B5016A6433A68C5"
jhash (0xBD64F1B7)
ns "MONEY"
returns "Any"
doc [[!
```
Hardcoded to return 0.
NativeDB Introduced: v323
```
]]
native "0xA51338E0DCCD4065"
hash "0xA51338E0DCCD4065"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v2189
```
]]
native "0xA51B086B0B2C0F7A"
hash "0xA51B086B0B2C0F7A"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
]]
native "0xA95CFB4E02390842"
hash "0xA95CFB4E02390842"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1868
```
]]
native "0xA95F667A755725DA"
hash "0xA95F667A755725DA"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
]]
native "0xB4C2EC463672474E"
hash "0xB4C2EC463672474E"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
]]
native "0xB4DEAE67F35E2ACD"
hash "0xB4DEAE67F35E2ACD"
arguments {
Any "p0" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1493
```
]]
native "0xB5B58E24868CB09E"
hash "0xB5B58E24868CB09E"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1868
```
]]
native "0xBD0EFB25CCA8F97A"
hash "0xBD0EFB25CCA8F97A"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
]]
native "0xC6E74CF8C884C880"
hash "0xC6E74CF8C884C880"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
Any "p6" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1493
```
]]
native "0xCD0F5B5D932AE473"
hash "0xCD0F5B5D932AE473"
jhash (0xC4CD928D)
ns "MONEY"
returns "void"
doc [[!
```
Does nothing (it's a nullsub).
NativeDB Introduced: v323
```
]]
native "0xCD4D66B43B1DD28D"
hash "0xCD4D66B43B1DD28D"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v2189
```
]]
native "0xD29334ED1A256DBF"
hash "0xD29334ED1A256DBF"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1868
```
]]
native "0xDE68E30D89F97132"
hash "0xDE68E30D89F97132"
arguments {
int "amount" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v2060
```
]]
native "0xE0F82D68C7039158"
hash "0xE0F82D68C7039158"
arguments {
Any "p0" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1493
```
]]
native "0xE154B48B68EF72BC"
hash "0xE154B48B68EF72BC"
jhash (0x531E4892)
arguments {
Any "p0" [=[ {} ]=],
}
ns "MONEY"
returns "BOOL"
doc [[!
```
This function is hard-coded to always return 1.
```
]]
native "0xE23ADC6FCB1F29AE"
hash "0xE23ADC6FCB1F29AE"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
]]
native "0xE2BB399D90942091"
hash "0xE2BB399D90942091"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v2189
```
]]
native "0xE2E244AB823B4483"
hash "0xE2E244AB823B4483"
arguments {
int "amount" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v2060
```
]]
native "0xED5FD7AF10F5E262"
hash "0xED5FD7AF10F5E262"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
]]
native "0xED76D195E6E3BF7F"
hash "0xED76D195E6E3BF7F"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
```
NativeDB Introduced: v1493
```
]]
native "0xFA07759E6FDDD7CF"
hash "0xFA07759E6FDDD7CF"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "MONEY"
returns "void"
doc [[!
]]
native "ADD_DOOR_TO_SYSTEM"
hash "0x6F8838D03D1DC226"
jhash (0x9D2D778D)
arguments {
Hash "doorHash" [=[ {} ]=],
Hash "modelHash" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
BOOL "p5" [=[ {} ]=],
BOOL "scriptDoor" [=[ {} ]=],
BOOL "isLocal" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
p5 only set to true in single player native scripts. Door hashes normally look like `PROP_[int]_DOOR_[int]` for interior doors and `PROP_BUILDING_[int]_DOOR_[int]` exterior doors but you can just make up your own hash if you want.
If scriptDoor is true, register the door on the script handler host (note: there's a hardcap on the number of script IDs that can be added to the system at a given time). If scriptDoor and isLocal are both false, the door is considered to be in a "Persists w/o netobj" state.
A simple "localized" door-system (with hundreds/thousands of doors) can be created by setting p5, p6, and p7 to false and using EventHandlers to synchronize the states to: [DOOR_SYSTEM_SET_DOOR_STATE](#\_0x6BAB9442830C7F53), [DOOR_SYSTEM_SET_OPEN_RATIO](#\_0xB6E6FBA95C7324AC), [DOOR_SYSTEM_SET_HOLD_OPEN](#\_0xD9B71952F78A2640), etc.
A (unique) door system identifier
Entity model hash
The X coordinate of the door object
The Y coordinate of the door object
The Z coordinate of the door object
false; relies upon getNetworkGameScriptHandler.
On true disables the creation `CRequestDoorEvent's` in [DOOR_SYSTEM_SET_DOOR_STATE](#\_0x6BAB9442830C7F53).
]]
native "ARE_ENTITIES_ENTIRELY_INSIDE_GARAGE"
hash "0x85B6C850546FDDE2"
jhash (0x4BD59750)
arguments {
Hash "garageHash" [=[ {"cs_type":"Any"} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
}
alias "0x85B6C850546FDDE2"
ns "OBJECT"
returns "BOOL"
doc [[!
]]
native "ATTACH_PORTABLE_PICKUP_TO_PED"
hash "0x8DC39368BDD57755"
jhash (0x184F6AB3)
arguments {
Object "pickupObject" [=[ {} ]=],
Ped "ped" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
]]
native "BREAK_OBJECT_FRAGMENT_CHILD"
hash "0xE7E4C198B0185900"
jhash (0x1E82C2AE)
arguments {
Object "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
alias "0xE7E4C198B0185900"
ns "OBJECT"
returns "void"
doc [[!
]]
native "CLEAR_OBJECTS_INSIDE_GARAGE"
hash "0x190428512B240692"
jhash (0xA565E27E)
arguments {
Hash "garageHash" [=[ {"cs_type":"Any"} ]=],
BOOL "vehicles" [=[ {} ]=],
BOOL "peds" [=[ {} ]=],
BOOL "objects" [=[ {} ]=],
BOOL "isNetwork" [=[ {} ]=],
}
alias "0x190428512B240692"
ns "OBJECT"
returns "void"
doc [[!
]]
native "CREATE_AMBIENT_PICKUP"
hash "0x673966A0C0FD7171"
jhash (0x17B99CE7)
arguments {
Hash "pickupHash" [=[ {} ]=],
float "posX" [=[ {} ]=],
float "posY" [=[ {} ]=],
float "posZ" [=[ {} ]=],
int "flags" [=[ {} ]=],
int "value" [=[ {} ]=],
Hash "modelHash" [=[ {} ]=],
BOOL "returnHandle" [=[ {} ]=],
BOOL "p8" [=[ {} ]=],
}
ns "OBJECT"
returns "Pickup"
doc [[!
Creates an ambient pickup given the hash. Pickup hashes can be found [here](https://gist.github.com/4mmonium/1eabfb6b3996e3aa6b9525a3eccf8a0b).
]]
native "CREATE_MONEY_PICKUPS"
hash "0x0589B5E791CE9B2B"
jhash (0x36C9A5EA)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
int "value" [=[ {} ]=],
int "amount" [=[ {} ]=],
Hash "model" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
```
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
```
]]
native "CREATE_NON_NETWORKED_PORTABLE_PICKUP"
hash "0x125494B98A21AAF7"
jhash (0x56A02502)
arguments {
Hash "pickupHash" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
BOOL "placeOnGround" [=[ {} ]=],
Hash "modelHash" [=[ {} ]=],
}
alias "0x125494B98A21AAF7"
alias "_CREATE_PORTABLE_PICKUP_2"
ns "OBJECT"
returns "Object"
doc [[!
]]
native "CREATE_OBJECT"
hash "0x509D5878EB39E842"
jhash (0x2F7AA05C)
arguments {
Hash "modelHash" [=[ {"cs_type":"int"} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
BOOL "isNetwork" [=[ {} ]=],
BOOL "netMissionEntity" [=[ {} ]=],
BOOL "doorFlag" [=[ {} ]=],
}
ns "OBJECT"
returns "Object"
doc [[!
Creates an object (prop) with the specified model at the specified position, offset on the Z axis by the radius of the object's model.
This object will initially be owned by the creating script as a mission entity, and the model should be loaded already (e.g. using REQUEST_MODEL).
The model to spawn.
Spawn coordinate X component.
Spawn coordinate Y component.
Spawn coordinate Z component, 'ground level'.
Whether to create a network object for the object. If false, the object exists only locally.
Whether to register the object as pinned to the script host in the R\* network model.
False to create a door archetype (archetype flag bit 26 set) as a door. Required to be set to true to create door models in network mode.
A script handle (fwScriptGuid index) for the object, or `0` if the object failed to be created.
]]
native "CREATE_OBJECT_NO_OFFSET"
hash "0x9A294B2138ABB884"
jhash (0x58040420)
arguments {
Hash "modelHash" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
BOOL "isNetwork" [=[ {} ]=],
BOOL "netMissionEntity" [=[ {} ]=],
BOOL "doorFlag" [=[ {} ]=],
}
ns "OBJECT"
returns "Object"
doc [[!
Creates an object (prop) with the specified model centered at the specified position.
This object will initially be owned by the creating script as a mission entity, and the model should be loaded already (e.g. using REQUEST_MODEL).
The model to spawn.
Spawn coordinate X component.
Spawn coordinate Y component.
Spawn coordinate Z component.
Whether to create a network object for the object. If false, the object exists only locally.
Whether to register the object as pinned to the script host in the R\* network model.
False to create a door archetype (archetype flag bit 26 set) as a door. Required to be set to true to create door models in network mode.
A script handle (fwScriptGuid index) for the object, or `0` if the object failed to be created.
]]
native "CREATE_PICKUP"
hash "0xFBA08C503DD5FA58"
jhash (0x5E14DF68)
arguments {
Hash "pickupHash" [=[ {} ]=],
float "posX" [=[ {} ]=],
float "posY" [=[ {} ]=],
float "posZ" [=[ {} ]=],
int "p4" [=[ {} ]=],
int "value" [=[ {} ]=],
BOOL "p6" [=[ {} ]=],
Hash "modelHash" [=[ {} ]=],
}
ns "OBJECT"
returns "Pickup"
doc [[!
Pickup hashes can be found [here](https://gist.github.com/4mmonium/1eabfb6b3996e3aa6b9525a3eccf8a0b).
]]
native "CREATE_PICKUP_ROTATE"
hash "0x891804727E0A98B7"
jhash (0xF015BFE2)
arguments {
Hash "pickupHash" [=[ {} ]=],
float "posX" [=[ {} ]=],
float "posY" [=[ {} ]=],
float "posZ" [=[ {} ]=],
float "rotX" [=[ {} ]=],
float "rotY" [=[ {} ]=],
float "rotZ" [=[ {} ]=],
int "flag" [=[ {} ]=],
int "amount" [=[ {} ]=],
Any "p9" [=[ {} ]=],
BOOL "p10" [=[ {} ]=],
Hash "modelHash" [=[ {} ]=],
}
ns "OBJECT"
returns "Pickup"
doc [[!
```
Pickup hashes: pastebin.com/8EuSv2r1
flags:
8 (1 << 3): place on ground
512 (1 << 9): spin around
```
]]
native "CREATE_PORTABLE_PICKUP"
hash "0x2EAF1FDB2FB55698"
jhash (0x8C886BE5)
arguments {
Hash "pickupHash" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
BOOL "placeOnGround" [=[ {} ]=],
Hash "modelHash" [=[ {} ]=],
}
ns "OBJECT"
returns "Object"
doc [[!
Pickup hashes can be found [here](https://gist.github.com/4mmonium/1eabfb6b3996e3aa6b9525a3eccf8a0b).
]]
native "DELETE_OBJECT"
hash "0x539E0AE3E6634B9F"
jhash (0xD6EF9DA7)
arguments {
ObjectPtr "object" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
Deletes the specified object.
**Note**: If for some reason the entity won't delete, you might want to check if the object is a mission entity.
```
NativeDB Introduced: v323
```
The object you want to delete.
]]
native "DETACH_PORTABLE_PICKUP_FROM_PED"
hash "0xCF463D1E9A0AECB1"
jhash (0x1D094562)
arguments {
Object "pickupObject" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
]]
native "DOES_OBJECT_OF_TYPE_EXIST_AT_COORDS"
hash "0xBFA48E2FF417213F"
jhash (0x23FF2BA4)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "radius" [=[ {} ]=],
Hash "hash" [=[ {} ]=],
BOOL "p5" [=[ {} ]=],
}
ns "OBJECT"
returns "BOOL"
doc [[!
```
p5 is usually 0.
```
]]
native "DOES_PICKUP_EXIST"
hash "0xAFC1CA75AD4074D1"
jhash (0x9C6DA0B3)
arguments {
Pickup "pickup" [=[ {} ]=],
}
ns "OBJECT"
returns "BOOL"
doc [[!
]]
native "DOES_PICKUP_OBJECT_EXIST"
hash "0xD9EFB6DBF7DAAEA3"
jhash (0xE0B32108)
arguments {
Object "pickupObject" [=[ {} ]=],
}
ns "OBJECT"
returns "BOOL"
doc [[!
]]
native "DOES_PICKUP_OF_TYPE_EXIST_IN_AREA"
hash "0xF9C36251F6E48E33"
jhash (0xF139681B)
arguments {
Hash "pickupHash" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "radius" [=[ {} ]=],
}
alias "_IS_PICKUP_WITHIN_RADIUS"
ns "OBJECT"
returns "BOOL"
doc [[!
Pickup hashes can be found [here](https://gist.github.com/4mmonium/1eabfb6b3996e3aa6b9525a3eccf8a0b).
]]
native "DOES_RAYFIRE_MAP_OBJECT_EXIST"
hash "0x52AF537A0C5B8AAD"
jhash (0xE08C834D)
arguments {
Object "object" [=[ {} ]=],
}
alias "0x52AF537A0C5B8AAD"
alias "_DOES_DES_OBJECT_EXIST"
ns "OBJECT"
returns "BOOL"
doc [[!
```
Returns true if a destructible object with this handle exists, false otherwise.
```
]]
native "DOOR_SYSTEM_FIND_EXISTING_DOOR"
hash "0x589F80B325CC82C5"
jhash (0xE9AE494F)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
Hash "modelHash" [=[ {"cs_type":"Any"} ]=],
HashPtr "doorOutPointer" [=[ {"cs_type":"AnyPtr"} ]=],
}
alias "0x589F80B325CC82C5"
ns "OBJECT"
returns "BOOL"
doc [[!
Search radius: 0.5
The X coordinate of the door object
The Y coordinate of the door object
The Z coordinate of the door object
Entity model hash
]]
native "DOOR_SYSTEM_GET_DOOR_PENDING_STATE"
hash "0x4BC2854478F3A749"
jhash (0xD649B7E1)
arguments {
Hash "doorHash" [=[ {} ]=],
}
alias "0x4BC2854478F3A749"
ns "OBJECT"
returns "int"
doc [[!
]]
native "DOOR_SYSTEM_GET_DOOR_STATE"
hash "0x160AA1B32F6139B8"
jhash (0xD42A41C2)
arguments {
Hash "doorHash" [=[ {} ]=],
}
alias "0x160AA1B32F6139B8"
ns "OBJECT"
returns "int"
doc [[!
]]
native "DOOR_SYSTEM_GET_IS_PHYSICS_LOADED"
hash "0xDF97CDD4FC08FD34"
jhash (0x17FF9393)
arguments {
Hash "doorHash" [=[ {"cs_type":"Any"} ]=],
}
alias "0xDF97CDD4FC08FD34"
ns "OBJECT"
returns "BOOL"
doc [[!
]]
native "DOOR_SYSTEM_GET_OPEN_RATIO"
hash "0x65499865FCA6E5EC"
jhash (0xB74C3BD7)
arguments {
Hash "doorHash" [=[ {} ]=],
}
alias "0x65499865FCA6E5EC"
ns "OBJECT"
returns "float"
doc [[!
]]
native "DOOR_SYSTEM_SET_AUTOMATIC_DISTANCE"
hash "0x9BA001CB45CBF627"
jhash (0x47531446)
arguments {
Hash "doorHash" [=[ {} ]=],
float "distance" [=[ {} ]=],
BOOL "requestDoor" [=[ {} ]=],
BOOL "forceUpdate" [=[ {} ]=],
}
alias "0x9BA001CB45CBF627"
ns "OBJECT"
returns "void"
doc [[!
Door system identifier
On true invokes [DOOR_SYSTEM_SET_DOOR_STATE](#\_0x6BAB9442830C7F53); otherwise requestDoor is unused.
]]
native "DOOR_SYSTEM_SET_AUTOMATIC_RATE"
hash "0x03C27E13B42A0E82"
jhash (0x4F44AF21)
arguments {
Hash "doorHash" [=[ {} ]=],
float "rate" [=[ {} ]=],
BOOL "requestDoor" [=[ {} ]=],
BOOL "forceUpdate" [=[ {} ]=],
}
alias "0x03C27E13B42A0E82"
ns "OBJECT"
returns "void"
doc [[!
Includes networking check: ownership vs. or the door itself **isn't** networked.
Door system identifier
On true invokes [DOOR_SYSTEM_SET_DOOR_STATE](#\_0x6BAB9442830C7F53); otherwise requestDoor is unused.
]]
native "DOOR_SYSTEM_SET_DOOR_STATE"
hash "0x6BAB9442830C7F53"
jhash (0xDF83DB47)
arguments {
Hash "doorHash" [=[ {} ]=],
int "state" [=[ {} ]=],
BOOL "requestDoor" [=[ {} ]=],
BOOL "forceUpdate" [=[ {} ]=],
}
alias "0x6BAB9442830C7F53"
alias "_SET_DOOR_ACCELERATION_LIMIT"
ns "OBJECT"
returns "void"
doc [[!
Lockstates not applied and CNetObjDoor's not created until [DOOR_SYSTEM_GET_IS_PHYSICS_LOADED](#\_0xDF97CDD4FC08FD34) returns true.
### Door lock states: (v323)
* **0**: UNLOCKED
* **1**: LOCKED
* **2**: DOORSTATE_FORCE_LOCKED_UNTIL_OUT_OF_AREA
* **3**: DOORSTATE_FORCE_UNLOCKED_THIS_FRAME
* **4**: DOORSTATE_FORCE_LOCKED_THIS_FRAME
* **5**: DOORSTATE_FORCE_OPEN_THIS_FRAME
* **6**: DOORSTATE_FORCE_CLOSED_THIS_FRAME
On true, and when door system is configured to, i.e., "persists w/o netobj", generate a CRequestDoorEvent.
On true, forces an update on the door system (same path as netObjDoor_applyDoorStuff)
]]
native "DOOR_SYSTEM_SET_HOLD_OPEN"
hash "0xD9B71952F78A2640"
jhash (0xECE58AE0)
arguments {
Hash "doorHash" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0xD9B71952F78A2640"
ns "OBJECT"
returns "void"
doc [[!
Includes networking check: ownership vs. or the door itself **isn't** networked.
Door system identifier
]]
native "DOOR_SYSTEM_SET_OPEN_RATIO"
hash "0xB6E6FBA95C7324AC"
jhash (0x34883DE3)
arguments {
Hash "doorHash" [=[ {} ]=],
float "ajar" [=[ {} ]=],
BOOL "requestDoor" [=[ {} ]=],
BOOL "forceUpdate" [=[ {} ]=],
}
alias "0xB6E6FBA95C7324AC"
alias "_SET_DOOR_AJAR_ANGLE"
ns "OBJECT"
returns "void"
doc [[!
```
Sets the ajar angle of a door.
Ranges from -1.0 to 1.0, and 0.0 is closed / default.
```
Door system identifier
On true invokes [DOOR_SYSTEM_SET_DOOR_STATE](#\_0x6BAB9442830C7F53); otherwise requestDoor is unused.
]]
native "DOOR_SYSTEM_SET_SPRING_REMOVED"
hash "0xC485E07E4F0B7958"
jhash (0xB4A9A558)
arguments {
Hash "doorHash" [=[ {} ]=],
BOOL "removed" [=[ {} ]=],
BOOL "requestDoor" [=[ {} ]=],
BOOL "forceUpdate" [=[ {} ]=],
}
alias "0xC485E07E4F0B7958"
ns "OBJECT"
returns "void"
doc [[!
Includes networking check: ownership vs. or the door itself **isn't** networked.
Door system identifier
On true invokes [DOOR_SYSTEM_SET_DOOR_STATE](#\_0x6BAB9442830C7F53); otherwise requestDoor is unused.
]]
native "ENABLE_SAVING_IN_GARAGE"
hash "0xF2E1A7133DD356A6"
jhash (0x43BB7E48)
arguments {
Hash "garageHash" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0xF2E1A7133DD356A6"
ns "OBJECT"
returns "void"
doc [[!
]]
native "FIX_OBJECT_FRAGMENT"
hash "0xF9C1681347C8BD15"
arguments {
Object "object" [=[ {} ]=],
}
alias "0xF9C1681347C8BD15"
ns "OBJECT"
returns "void"
doc [[!
Resets and brings back all the children of a fragment based object.
This should be used when attaching or detaching an object from another entity, especially when the object being detached consists of multiple fragments.
Attempting to teleport a fragment-based object using [`SET_ENTITY_COORDS`](#\_0x06843DA7060A026B) such as a flag object, will result in it remaining in place and failing to teleport, given the condition mentioned in the preceding statement.
The native should be executed after detaching the object from its parent entity and before calling [`SET_ENTITY_COORDS`](#\_0x06843DA7060A026B).
Example given down below.
The object to fix fragments for (a handle should be passed).
]]
native "GET_CLOSEST_OBJECT_OF_TYPE"
hash "0xE143FA2249364369"
jhash (0x45619B33)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "radius" [=[ {} ]=],
Hash "modelHash" [=[ {} ]=],
BOOL "isMission" [=[ {} ]=],
BOOL "p6" [=[ {} ]=],
BOOL "p7" [=[ {} ]=],
}
ns "OBJECT"
returns "Object"
doc [[!
```
Has 8 params in the latest patches.
isMission - if true doesn't return mission objects
```
]]
native "GET_COORDS_AND_ROTATION_OF_CLOSEST_OBJECT_OF_TYPE"
hash "0x163F8B586BC95F2A"
jhash (0x65213FC3)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "radius" [=[ {} ]=],
Hash "modelHash" [=[ {} ]=],
Vector3Ptr "outPosition" [=[ {} ]=],
Vector3Ptr "outRotation" [=[ {} ]=],
int "rotationOrder" [=[ {} ]=],
}
alias "0x163F8B586BC95F2A"
ns "OBJECT"
returns "Any"
doc [[!
]]
native "GET_OBJECT_FRAGMENT_DAMAGE_HEALTH"
hash "0xB6FBFD079B8D0596"
jhash (0xF0B330AD)
arguments {
Any "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "OBJECT"
returns "float"
doc [[!
]]
native "GET_OFFSET_FROM_COORD_AND_HEADING_IN_WORLD_COORDS"
hash "0x163E252DE035A133"
jhash (0x87A42A12)
arguments {
float "xPos" [=[ {} ]=],
float "yPos" [=[ {} ]=],
float "zPos" [=[ {} ]=],
float "heading" [=[ {} ]=],
float "xOffset" [=[ {} ]=],
float "yOffset" [=[ {} ]=],
float "zOffset" [=[ {} ]=],
}
alias "0x163E252DE035A133"
alias "_GET_OBJECT_OFFSET_FROM_COORDS"
ns "OBJECT"
returns "Vector3"
doc [[!
Calculates the world coordinates after applying the specified offsets to the given position, relative to a certain heading.
This native is similar to [`GET_OFFSET_FROM_ENTITY_IN_WORLD_COORDS`](#\_0x1899F328B0E12848), but uses a world position and heading as the reference point.
The X coordinate of the original position.
The Y coordinate of the original position.
The Z coordinate of the original position.
The heading (in degrees) relative to which the offsets are applied.
Left/right offset from the coord.
Forward/backward offset from the coord.
Upward/downward offset from the coord.
Returns a Vector3 representing the new world coordinates after applying the offsets to the original position relative to the specified heading.
]]
native "GET_PICKUP_COORDS"
hash "0x225B8B35C88029B3"
jhash (0xC2E1E2C5)
arguments {
Pickup "pickup" [=[ {} ]=],
}
ns "OBJECT"
returns "Vector3"
doc [[!
]]
native "GET_PICKUP_OBJECT"
hash "0x5099BC55630B25AE"
jhash (0x6052E62E)
arguments {
Pickup "pickup" [=[ {} ]=],
}
alias "0x5099BC55630B25AE"
ns "OBJECT"
returns "Object"
doc [[!
]]
native "GET_RAYFIRE_MAP_OBJECT"
hash "0xB48FCED898292E52"
jhash (0xA286DE96)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "radius" [=[ {} ]=],
charPtr "name" [=[ {} ]=],
}
alias "0xB48FCED898292E52"
alias "_GET_DES_OBJECT"
ns "OBJECT"
returns "Object"
doc [[!
```
Example:
OBJECT::GET_RAYFIRE_MAP_OBJECT(-809.9619750976562, 170.919, 75.7406997680664, 3.0, "des_tvsmash");
```
]]
native "GET_RAYFIRE_MAP_OBJECT_ANIM_PHASE"
hash "0x260EE4FDBDF4DB01"
jhash (0x020497DE)
arguments {
Object "object" [=[ {} ]=],
}
alias "0x260EE4FDBDF4DB01"
alias "_GET_DES_OBJECT_ANIM_PROGRESS"
ns "OBJECT"
returns "float"
doc [[!
```
`object`: The des-object handle to get the animation progress from.
Return value is a float between 0.0 and 1.0, 0.0 is the beginning of the animation, 1.0 is the end. Value resets to 0.0 instantly after reaching 1.0.
```
The des-object handle to get the animation progress from.
A float between 0.0 and 1.0, 0.0 is the beginning of the animation, 1.0 is the end. Value resets to 0.0 instantly after reaching 1.0.
]]
native "GET_SAFE_PICKUP_COORDS"
hash "0x6E16BC2503FF1FF0"
jhash (0x618B5F67)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "p3" [=[ {"cs_type":"Any"} ]=],
float "p4" [=[ {"cs_type":"Any"} ]=],
}
ns "OBJECT"
returns "Vector3"
doc [[!
]]
native "GET_STATE_OF_CLOSEST_DOOR_OF_TYPE"
hash "0xEDC1A5B84AEF33FF"
jhash (0x4B44A83D)
arguments {
Hash "type" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
BOOLPtr "locked" [=[ {} ]=],
floatPtr "heading" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
```
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)
```
]]
native "GET_STATE_OF_RAYFIRE_MAP_OBJECT"
hash "0x899BA936634A322E"
jhash (0xF1B8817A)
arguments {
Object "object" [=[ {} ]=],
}
alias "0x899BA936634A322E"
alias "_GET_DES_OBJECT_STATE"
ns "OBJECT"
returns "int"
doc [[!
See [`SET_STATE_OF_RAYFIRE_MAP_OBJECT`](#\_0x5C29F698D404C5E1) to see the different states
Get a destructible object's state. Substract 1 to get the real state. For example, if the object just spawned (state 2), the native will return 3.
]]
native "GET_WEAPON_TYPE_FROM_PICKUP_TYPE"
hash "0x08F96CA6C551AD51"
jhash (0xEDD01937)
arguments {
Hash "pickupHash" [=[ {"cs_type":"Pickup"} ]=],
}
alias "0x08F96CA6C551AD51"
alias "_GET_WEAPON_HASH_FROM_PICKUP"
ns "OBJECT"
returns "Hash"
doc [[!
]]
native "HAS_CLOSEST_OBJECT_OF_TYPE_BEEN_BROKEN"
hash "0x761B0E69AC4D007E"
jhash (0x6FC0353D)
arguments {
float "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
Hash "modelHash" [=[ {} ]=],
Any "p5" [=[ {} ]=],
}
ns "OBJECT"
returns "BOOL"
doc [[!
]]
native "HAS_CLOSEST_OBJECT_OF_TYPE_BEEN_COMPLETELY_DESTROYED"
hash "0x46494A2475701343"
jhash (0x7DB578DD)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "radius" [=[ {} ]=],
Hash "modelHash" [=[ {} ]=],
BOOL "p5" [=[ {} ]=],
}
alias "0x46494A2475701343"
ns "OBJECT"
returns "BOOL"
doc [[!
]]
native "HAS_OBJECT_BEEN_BROKEN"
hash "0x8ABFB70C49CC43E2"
jhash (0xFE21F891)
arguments {
Object "object" [=[ {} ]=],
}
ns "OBJECT"
returns "BOOL"
doc [[!
```
NativeDB Added Parameter 2: Any p1
```
]]
native "HAS_PICKUP_BEEN_COLLECTED"
hash "0x80EC48E6679313F9"
jhash (0x0BE5CCED)
arguments {
Pickup "pickup" [=[ {} ]=],
}
ns "OBJECT"
returns "BOOL"
doc [[!
]]
native "HIDE_PORTABLE_PICKUP_WHEN_DETACHED"
hash "0x867458251D47CCB2"
jhash (0x1F63B042)
arguments {
Pickup "pickup" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x867458251D47CCB2"
alias "_HIDE_PICKUP"
ns "OBJECT"
returns "void"
doc [[!
]]
native "IS_ANY_ENTITY_ENTIRELY_INSIDE_GARAGE"
hash "0x673ED815D6E323B7"
jhash (0x7B44D659)
arguments {
Hash "garageHash" [=[ {"cs_type":"Any"} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
}
alias "0x673ED815D6E323B7"
ns "OBJECT"
returns "BOOL"
doc [[!
]]
native "IS_ANY_OBJECT_NEAR_POINT"
hash "0x397DC58FF00298D1"
jhash (0xE9E46941)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "range" [=[ {} ]=],
BOOL "p4" [=[ {} ]=],
}
ns "OBJECT"
returns "BOOL"
doc [[!
]]
native "IS_DOOR_CLOSED"
hash "0xC531EE8A1145A149"
jhash (0x48659CD7)
arguments {
Hash "doorHash" [=[ {} ]=],
}
ns "OBJECT"
returns "BOOL"
doc [[!
]]
native "IS_DOOR_REGISTERED_WITH_SYSTEM"
hash "0xC153C43EA202C8C1"
jhash (0x5AFCD8A1)
arguments {
Hash "doorHash" [=[ {} ]=],
}
alias "0xC153C43EA202C8C1"
alias "_DOES_DOOR_EXIST"
ns "OBJECT"
returns "BOOL"
doc [[!
```
if (OBJECT::IS_DOOR_REGISTERED_WITH_SYSTEM(doorHash))
{
OBJECT::REMOVE_DOOR_FROM_SYSTEM(doorHash);
}
```
]]
native "IS_GARAGE_EMPTY"
hash "0x90E47239EA1980B8"
jhash (0xA8B37DEA)
arguments {
Hash "garageHash" [=[ {"cs_type":"Any"} ]=],
BOOL "p1" [=[ {} ]=],
int "p2" [=[ {} ]=],
}
ns "OBJECT"
returns "BOOL"
doc [[!
]]
native "IS_OBJECT_A_PICKUP"
hash "0xFC481C641EBBD27D"
jhash (0x93D23399)
arguments {
Object "object" [=[ {} ]=],
}
alias "0xFC481C641EBBD27D"
ns "OBJECT"
returns "BOOL"
doc [[!
]]
native "IS_OBJECT_A_PORTABLE_PICKUP"
hash "0x0378C08504160D0D"
jhash (0x0F0E94FF)
arguments {
Object "object" [=[ {} ]=],
}
alias "0x0378C08504160D0D"
ns "OBJECT"
returns "BOOL"
doc [[!
```
NativeDB Introduced: v1365
```
]]
native "IS_OBJECT_ENTIRELY_INSIDE_GARAGE"
hash "0x372EF6699146A1E4"
jhash (0x142C8F76)
arguments {
Hash "garageHash" [=[ {"cs_type":"Any"} ]=],
Entity "entity" [=[ {} ]=],
float "p2" [=[ {} ]=],
int "p3" [=[ {} ]=],
}
alias "0x372EF6699146A1E4"
ns "OBJECT"
returns "BOOL"
doc [[!
]]
native "IS_OBJECT_NEAR_POINT"
hash "0x8C90FE4B381BA60A"
jhash (0x50A62C43)
arguments {
Hash "objectHash" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "range" [=[ {} ]=],
}
ns "OBJECT"
returns "BOOL"
doc [[!
]]
native "IS_OBJECT_PARTIALLY_INSIDE_GARAGE"
hash "0xF0EED5A6BC7B237A"
jhash (0x95A9AB2B)
arguments {
Hash "garageHash" [=[ {"cs_type":"Any"} ]=],
Entity "entity" [=[ {} ]=],
int "p2" [=[ {} ]=],
}
alias "0xF0EED5A6BC7B237A"
ns "OBJECT"
returns "BOOL"
doc [[!
]]
native "IS_OBJECT_VISIBLE"
hash "0x8B32ACE6326A7546"
jhash (0xF4FD8AE4)
arguments {
Object "object" [=[ {} ]=],
}
ns "OBJECT"
returns "BOOL"
doc [[!
]]
native "IS_PICKUP_WEAPON_OBJECT_VALID"
hash "0x11D1E53A726891FE"
jhash (0x883DAB2D)
arguments {
Object "object" [=[ {} ]=],
}
alias "0x11D1E53A726891FE"
ns "OBJECT"
returns "BOOL"
doc [[!
]]
native "IS_PLAYER_ENTIRELY_INSIDE_GARAGE"
hash "0x024A60DEB0EA69F0"
jhash (0xC33ED360)
arguments {
Hash "garageHash" [=[ {"cs_type":"Any"} ]=],
Player "player" [=[ {} ]=],
float "p2" [=[ {} ]=],
int "p3" [=[ {} ]=],
}
alias "0x024A60DEB0EA69F0"
ns "OBJECT"
returns "BOOL"
doc [[!
]]
native "IS_PLAYER_PARTIALLY_INSIDE_GARAGE"
hash "0x1761DC5D8471CBAA"
jhash (0x41924877)
arguments {
Hash "garageHash" [=[ {"cs_type":"Any"} ]=],
Player "player" [=[ {} ]=],
int "p2" [=[ {} ]=],
}
alias "0x1761DC5D8471CBAA"
ns "OBJECT"
returns "BOOL"
doc [[!
]]
native "IS_POINT_IN_ANGLED_AREA"
hash "0x2A70BAE8883E4C81"
jhash (0x73BCFFDC)
arguments {
float "xPos" [=[ {} ]=],
float "yPos" [=[ {} ]=],
float "zPos" [=[ {} ]=],
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
float "width" [=[ {} ]=],
BOOL "p10" [=[ {} ]=],
BOOL "includez" [=[ {} ]=],
}
ns "OBJECT"
returns "BOOL"
doc [[!
An **angled area** is an X-Z oriented rectangle with three parameters:
1. **origin**: the mid-point along a base edge of the rectangle;
2. **extent**: the mid-point of opposite base edge on the other Z;
3. **width**: the length of the base edge; (named derived from logging strings `CNetworkRoadNodeWorldStateData`).
The oriented rectangle can then be derived from the direction of the two points (`norm(origin - extent)`), its orthonormal, and the width, e.g:
1. [golf_mp](https://i.imgur.com/JhsQAK9.png)
2. [am_taxi](https://i.imgur.com/TJWCZaT.jpg)
The x coordinate.
The y coordinate.
The z coordinate.
X dimension of the angled area 'origin'
Y dimension of the angled area 'origin'
Z dimension of the angled area 'origin'
X dimension of the angled area 'extent'
Y dimension of the angled area 'extent'
Z dimension of the angled area 'extent'
Width of the angled area
a debug flag invoking functions in the same path as `DRAW_MARKER`
If true, include the Z dimension when doing the height check; otherwise the query becomes two-dimensional
]]
native "PLACE_OBJECT_ON_GROUND_OR_OBJECT_PROPERLY"
hash "0xD76EEEF746057FD6"
arguments {
Object "object" [=[ {} ]=],
}
alias "0xD76EEEF746057FD6"
alias "_PLACE_OBJECT_ON_GROUND_PROPERLY_2"
ns "OBJECT"
returns "BOOL"
doc [[!
Casts a ray downward from the object's position and places the object on the surface it hits (including world surface and objects). Use [`PLACE_OBJECT_ON_GROUND_PROPERLY`](#\_0x58A850EAEE20FAA3) to not include objects when determining the surface.
The object handle.
]]
native "PLACE_OBJECT_ON_GROUND_PROPERLY"
hash "0x58A850EAEE20FAA3"
jhash (0x8F95A20B)
arguments {
Object "object" [=[ {} ]=],
}
ns "OBJECT"
returns "BOOL"
doc [[!
]]
native "PREVENT_COLLECTION_OF_PORTABLE_PICKUP"
hash "0x92AEFB5F6E294023"
jhash (0xCBB5F9B6)
arguments {
Object "object" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
alias "0x92AEFB5F6E294023"
ns "OBJECT"
returns "void"
doc [[!
]]
native "REMOVE_ALL_PICKUPS_OF_TYPE"
hash "0x27F9D613092159CF"
jhash (0x40062C53)
arguments {
Hash "pickupHash" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
Pickup hashes can be found [here](https://gist.github.com/4mmonium/1eabfb6b3996e3aa6b9525a3eccf8a0b).
]]
native "REMOVE_DOOR_FROM_SYSTEM"
hash "0x464D8E1427156FE4"
jhash (0x00253286)
arguments {
Hash "doorHash" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
CDoor and CDoorSystemData still internally allocated (and their associations between doorHash, modelHash, and coordinates).
Only its NetObj removed and flag `*(v2 + 192) |= 8u` (1604 retail) toggled.
]]
native "REMOVE_OBJECT_HIGH_DETAIL_MODEL"
hash "0x4A39DB43E47CF3AA"
jhash (0xE3261B35)
arguments {
Object "object" [=[ {} ]=],
}
alias "0x4A39DB43E47CF3AA"
ns "OBJECT"
returns "void"
doc [[!
]]
native "REMOVE_PICKUP"
hash "0x3288D8ACAECD2AB2"
jhash (0x64A7A0E0)
arguments {
Pickup "pickup" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
]]
native "RENDER_FAKE_PICKUP_GLOW"
hash "0x3430676B11CDF21D"
jhash (0x63B02FAD)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
int "colorIndex" [=[ {} ]=],
}
alias "0x3430676B11CDF21D"
alias "_HIGHLIGHT_PLACEMENT_COORDS"
ns "OBJECT"
returns "void"
doc [[!
```
draws circular marker at pos
-1 = none
0 = red
1 = green
2 = blue
3 = green larger
4 = nothing
5 = green small
```
]]
native "SET_ACTIVATE_OBJECT_PHYSICS_AS_SOON_AS_IT_IS_UNFROZEN"
hash "0x406137F8EF90EAF5"
jhash (0x3E263AE1)
arguments {
Object "object" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
]]
native "SET_FORCE_OBJECT_THIS_FRAME"
hash "0xF538081986E49E9D"
jhash (0x3DA41C1A)
arguments {
float "x" [=[ {"cs_type":"Any"} ]=],
float "y" [=[ {"cs_type":"Any"} ]=],
float "z" [=[ {"cs_type":"Any"} ]=],
float "p3" [=[ {"cs_type":"Any"} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
]]
native "SET_LOCAL_PLAYER_CAN_COLLECT_PORTABLE_PICKUPS"
hash "0x78857FC65CADB909"
jhash (0xA3CDF152)
arguments {
BOOL "p0" [=[ {} ]=],
}
alias "0x78857FC65CADB909"
ns "OBJECT"
returns "void"
doc [[!
]]
native "SET_MAX_NUM_PORTABLE_PICKUPS_CARRIED_BY_PLAYER"
hash "0x0BF3B3BD47D79C08"
jhash (0x7EFBA039)
arguments {
Hash "modelHash" [=[ {} ]=],
int "p1" [=[ {} ]=],
}
alias "0x0BF3B3BD47D79C08"
ns "OBJECT"
returns "void"
doc [[!
]]
native "SET_OBJECT_ALLOW_LOW_LOD_BUOYANCY"
hash "0x4D89D607CB3DD1D2"
jhash (0x19B17769)
arguments {
Object "object" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x4D89D607CB3DD1D2"
alias "_SET_OBJECT_CAN_CLIMB_ON"
ns "OBJECT"
returns "void"
doc [[!
```
Overrides the climbing/blocking flags of the object, used in the native scripts mostly for "prop_dock_bouy_*"
```
]]
native "SET_OBJECT_FORCE_VEHICLES_TO_AVOID"
hash "0x77F33F2CCF64B3AA"
jhash (0x483C5C88)
arguments {
Object "object" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x77F33F2CCF64B3AA"
alias "_SET_OBJECT_SOMETHING"
ns "OBJECT"
returns "void"
doc [[!
Overrides a flag on the object which determines if the object should be avoided by a vehicle in task: CTaskVehicleGoToPointWithAvoidanceAutomobile.
Tested on vehicles that were created by the vehicle generators.
]]
native "SET_OBJECT_PHYSICS_PARAMS"
hash "0xF6DF6E90DE7DF90F"
jhash (0xE8D11C58)
arguments {
Object "object" [=[ {} ]=],
float "mass" [=[ {} ]=],
float "gravityFactor" [=[ {} ]=],
float "linearC" [=[ {} ]=],
float "linearV" [=[ {} ]=],
float "linearV2" [=[ {} ]=],
float "angularC" [=[ {} ]=],
float "angularV" [=[ {} ]=],
float "angularV2" [=[ {} ]=],
float "p9" [=[ {} ]=],
float "maxAngSpeed" [=[ {} ]=],
float "buoyancyFactor" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
```
rage::phArchetypeDamp
p9: Some phBoundGeometry margin value, limited to (0.0, 0.1) exclusive.
```
]]
native "SET_OBJECT_TARGETTABLE"
hash "0x8A7391690F5AFD81"
jhash (0x3F88CD86)
arguments {
Object "object" [=[ {} ]=],
BOOL "targettable" [=[ {} ]=],
}
ns "OBJECT"
annotations [=[ {"cs_type":"Any"} ]=]
returns "void"
doc [[!
]]
native "SET_PICKUP_GENERATION_RANGE_MULTIPLIER"
hash "0x318516E02DE3ECE2"
jhash (0x9879AC51)
arguments {
float "multiplier" [=[ {} ]=],
}
alias "0x318516E02DE3ECE2"
ns "OBJECT"
returns "void"
doc [[!
]]
native "SET_PICKUP_REGENERATION_TIME"
hash "0x78015C9B4B3ECC9D"
jhash (0xAB11267D)
arguments {
Pickup "pickup" [=[ {} ]=],
int "duration" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
]]
native "SET_STATE_OF_CLOSEST_DOOR_OF_TYPE"
hash "0xF82D8F1926A02C3D"
jhash (0x38C951A4)
arguments {
Hash "type" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
BOOL "locked" [=[ {} ]=],
float "heading" [=[ {} ]=],
BOOL "p6" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
```
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
```
]]
native "SET_STATE_OF_RAYFIRE_MAP_OBJECT"
hash "0x5C29F698D404C5E1"
jhash (0x21F51560)
arguments {
Object "object" [=[ {} ]=],
int "state" [=[ {} ]=],
}
alias "0x5C29F698D404C5E1"
alias "_SET_DES_OBJECT_STATE"
ns "OBJECT"
returns "void"
doc [[!
```
Defines the state of a destructible object.
Use the GET_RAYFIRE_MAP_OBJECT native to find an object's handle with its name / coords.
State 2 == object just spawned
State 4 == Beginning of the animation
State 6 == Start animation
State 9 == End of the animation
```
]]
native "SET_TEAM_PICKUP_OBJECT"
hash "0x53E0DF1A2A3CF0CA"
jhash (0x77687DC5)
arguments {
Object "object" [=[ {} ]=],
Any "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
]]
native "SLIDE_OBJECT"
hash "0x2FDFF4107B8C1147"
jhash (0x63BFA7A0)
arguments {
Object "object" [=[ {} ]=],
float "toX" [=[ {} ]=],
float "toY" [=[ {} ]=],
float "toZ" [=[ {} ]=],
float "speedX" [=[ {} ]=],
float "speedY" [=[ {} ]=],
float "speedZ" [=[ {} ]=],
BOOL "collision" [=[ {} ]=],
}
ns "OBJECT"
returns "BOOL"
doc [[!
```
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: https://gtag.sannybuilder.com/opcode-database/opcode/034E/
Has to be looped until it returns true.
```
]]
native "TRACK_OBJECT_VISIBILITY"
hash "0xB252BC036B525623"
jhash (0x46D06B9A)
arguments {
Object "object" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
]]
native "_CLEAR_GARAGE_AREA"
hash "0xDA05194260CDCDF9"
arguments {
Hash "garageHash" [=[ {"cs_type":"Any"} ]=],
BOOL "isNetwork" [=[ {} ]=],
}
alias "0xDA05194260CDCDF9"
ns "OBJECT"
returns "void"
doc [[!
]]
native "_CREATE_NON_NETWORKED_AMBIENT_PICKUP"
hash "0x9C93764223E29C50"
arguments {
Any "pickupHash" [=[ {} ]=],
float "posX" [=[ {} ]=],
float "posY" [=[ {} ]=],
float "posZ" [=[ {} ]=],
int "flags" [=[ {} ]=],
int "value" [=[ {} ]=],
Any "modelHash" [=[ {} ]=],
BOOL "p7" [=[ {} ]=],
BOOL "p8" [=[ {} ]=],
}
alias "0x9C93764223E29C50"
ns "OBJECT"
returns "Any"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "_DOOR_CONTROL"
hash "0x9B12F9A24FABEDB0"
jhash (0x4E0A260B)
arguments {
Hash "modelHash" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
BOOL "locked" [=[ {} ]=],
float "xRotMult" [=[ {} ]=],
float "yRotMult" [=[ {} ]=],
float "zRotMult" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
Hardcoded not to work in multiplayer environments.
Native name between `SET_LOCAL_PLAYER_VISIBLE_LOCALLY` & `SET_MAX_WANTED_LEVEL`.
```
OBJECT::_9B12F9A24FABEDB0(${prop_gate_prison_01}, 1845.0, 2605.0, 45.0, 0, 0.0, 50.0, 0); //door unlocked
OBJECT::_9B12F9A24FABEDB0(${prop_gate_prison_01}, 1845.0, 2605.0, 45.0, 1, 0.0, 50.0, 0); //door locked
```
tells the game whether or not the door is locked
multiplier that specifies how fast the door/gate will rotate in degrees per second.
multiplier that specifies how fast the door/gate will rotate in degrees per second.
multiplier that specifies how fast the door/gate will rotate in degrees per second.
]]
native "_DOOR_SYSTEM_GET_AUTOMATIC_DISTANCE"
hash "0xE851471AEFC3374F"
arguments {
Hash "doorHash" [=[ {} ]=],
}
ns "OBJECT"
returns "float"
doc [[!
```
NativeDB Introduced: v1868
```
]]
native "_FORCE_PICKUP_REGENERATE"
hash "0x758A5C1B3B1E1990"
arguments {
Any "p0" [=[ {} ]=],
}
alias "0x758A5C1B3B1E1990"
ns "OBJECT"
returns "void"
doc [[!
]]
native "_GET_IS_ARENA_PROP_PHYSICS_DISABLED"
hash "0x43C677F1E1158005"
arguments {
Object "entity" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
alias "0x43C677F1E1158005"
ns "OBJECT"
annotations [=[ {"cs_type":"Any"} ]=]
returns "BOOL"
doc [[!
```
NativeDB Introduced: v1604
```
]]
native "_GET_OBJECT_TEXTURE_VARIATION"
hash "0xE84EB93729C5F36A"
arguments {
Object "object" [=[ {} ]=],
}
alias "0xE84EB93729C5F36A"
ns "OBJECT"
returns "int"
doc [[!
]]
native "_GET_PICKUP_GENERATION_RANGE_MULTIPLIER"
hash "0xB3ECA65C7317F174"
alias "0xB3ECA65C7317F174"
ns "OBJECT"
returns "float"
doc [[!
]]
native "_GET_PICKUP_HASH"
hash "0x5EAAD83F8CFB4575"
jhash (0x6AE36192)
arguments {
Hash "pickupHash" [=[ {"cs_type":"Pickup"} ]=],
}
alias "0x5EAAD83F8CFB4575"
ns "OBJECT"
returns "Hash"
doc [[!
```
returns pickup hash.
```
]]
native "_GET_PICKUP_HASH_FROM_WEAPON"
hash "0xD6429A016084F1A5"
arguments {
Hash "weapon" [=[ {} ]=],
}
alias "0xD6429A016084F1A5"
ns "OBJECT"
returns "Hash"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "_MARK_OBJECT_FOR_DELETION"
hash "0xADBE4809F19F927A"
jhash (0x2048A7DD)
arguments {
Object "object" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
```
is this like setting is as no longer needed?
```
]]
native "_SET_CREATE_WEAPON_OBJECT_LIGHT_SOURCE"
hash "0xBCE595371A5FBAAF"
jhash (0x3A68AA46)
arguments {
Object "object" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0xBCE595371A5FBAAF"
ns "OBJECT"
returns "void"
doc [[!
```
Requires a component_at_*_flsh to be attached to the weapon object
```
]]
native "_SET_ENABLE_ARENA_PROP_PHYSICS"
hash "0x911024442F4898F0"
arguments {
Object "entity" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
int "p2" [=[ {} ]=],
}
alias "0x911024442F4898F0"
ns "OBJECT"
returns "void"
doc [[!
```
Activate the physics to: "xs_prop_arena_{flipper,wall,bollard,turntable,pit}"
```
```
NativeDB Introduced: v1604
```
]]
native "_SET_ENABLE_ARENA_PROP_PHYSICS_ON_PED"
hash "0xB20834A7DD3D8896"
arguments {
Object "entity" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
int "p2" [=[ {} ]=],
Ped "ped" [=[ {} ]=],
}
alias "0xB20834A7DD3D8896"
ns "OBJECT"
returns "void"
doc [[!
```
NativeDB Introduced: v1604
```
]]
native "_SET_LOCAL_PLAYER_CAN_USE_PICKUPS_WITH_THIS_MODEL"
hash "0x88EAEC617CD26926"
jhash (0x3A8F1BF7)
arguments {
Hash "modelHash" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x88EAEC617CD26926"
ns "OBJECT"
returns "void"
doc [[!
```
Maximum amount of pickup models that can be disallowed is 30.
SET_LOCAL_PLAYER_*
```
]]
native "_SET_OBJECT_LIGHT_COLOR"
hash "0x5F048334B4A4E774"
arguments {
Object "object" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
int "r" [=[ {} ]=],
int "g" [=[ {} ]=],
int "b" [=[ {} ]=],
}
ns "OBJECT"
returns "Any"
doc [[!
Sets color of embedded light source.
Only appears in am_mp_nightclub.c for the nightclub dancefloor.
Not sure what p1 does, seems to only ever be '1' in scripts.
```
NativeDB Introduced: v1493
```
]]
native "_SET_OBJECT_STUNT_PROP_DURATION"
hash "0xDF6CA0330F2E737B"
arguments {
Object "object" [=[ {} ]=],
float "duration" [=[ {} ]=],
}
alias "0xDF6CA0330F2E737B"
ns "OBJECT"
returns "void"
doc [[!
]]
native "_SET_OBJECT_STUNT_PROP_SPEEDUP"
hash "0x96EE0EBA0163DF80"
arguments {
Object "object" [=[ {} ]=],
int "intensity" [=[ {} ]=],
}
alias "0x96EE0EBA0163DF80"
ns "OBJECT"
returns "void"
doc [[!
Sets the intensity of Speed Boost and Slow Down props.
The corresponding values for Speed Boosts in the Creator are:\
Weak: `15`\
Normal: `25`\
Strong: `35`\
Extra Strong: `45`\
Ultra Strong: `100`
For Slow Downs:\
Weak: `44`\
Normal: `30`\
Strong: `16`
A Speed Boost or Slow Down prop
Ranges from `1`-`254`, other values are ignored. Higher values will increase the effect of Speed Boosts and decrease the effect of Slow Downs.
]]
native "_SET_OBJECT_TARGETTABLE_BY_PLAYER"
hash "0xB39F03368DB0CAA2"
arguments {
Object "object" [=[ {} ]=],
BOOL "setFlag34" [=[ {} ]=],
BOOL "setFlag35" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
]]
native "_SET_OBJECT_TEXTURE_VARIATION"
hash "0x971DA0055324D033"
arguments {
Object "object" [=[ {} ]=],
int "textureVariation" [=[ {} ]=],
}
alias "0x971DA0055324D033"
alias "_SET_OBJECT_TEXTURE_VARIANT"
ns "OBJECT"
returns "void"
doc [[!
```cpp
enum eObjectPaintVariants
{
Pacific = 0,
Azure = 1,
Nautical = 2,
Continental = 3,
Battleship = 4,
Intrepid = 5,
Uniform = 6,
Classico = 7,
Mediterranean = 8,
Command = 9,
Mariner = 10,
Ruby = 11,
Vintage = 12,
Pristine = 13,
Merchant = 14,
Voyager = 15
};
```
]]
native "_SET_PICKUP_HIDDEN_WHEN_UNCOLLECTABLE"
hash "0x3ED2B83AB2E82799"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
alias "0x3ED2B83AB2E82799"
ns "OBJECT"
returns "void"
doc [[!
]]
native "_SET_PICKUP_UNCOLLECTABLE"
hash "0x1C1B69FAE509BA97"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
alias "0x1C1B69FAE509BA97"
ns "OBJECT"
returns "void"
doc [[!
]]
native "_SET_TEXTURE_VARIATION_OF_CLOSEST_OBJECT_OF_TYPE"
hash "0xF12E33034D887F66"
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "radius" [=[ {} ]=],
Hash "modelHash" [=[ {"cs_type":"Any"} ]=],
int "textureVariation" [=[ {} ]=],
}
alias "0xF12E33034D887F66"
ns "OBJECT"
returns "BOOL"
doc [[!
]]
native "_SET_UNK_GLOBAL_BOOL_RELATED_TO_DAMAGE"
hash "0xABDABF4E1EDECBFA"
arguments {
BOOL "value" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
```
NativeDB Introduced: v1365
```
]]
native "_TOGGLE_USE_PICKUPS_FOR_PLAYER"
hash "0x616093EC6B139DD9"
jhash (0x7FADB4B9)
arguments {
Player "player" [=[ {} ]=],
Hash "pickupHash" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x616093EC6B139DD9"
ns "OBJECT"
returns "void"
doc [[!
```
Disabling/enabling a player from getting pickups. From the scripts:
OBJECT::_616093EC6B139DD9(PLAYER::PLAYER_ID(), ${pickup_portable_package}, 0);
```
Player ID. Use [`PLAYER_ID`](#\_0x4F8644AF03D0E0D6) for your own player.
Hash of the pickup, obtainable with [`GET_HASH_KEY`](#\_0xD24D37CC275948CC)
boolean that enables/disables the pickup drop (false to disable, true to enable)
]]
native "0x006E4B040ED37EC3"
hash "0x006E4B040ED37EC3"
arguments {
Any "p0" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
```
NativeDB Introduced: v1868
```
]]
native "0x0596843B34B95CE5"
hash "0x0596843B34B95CE5"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
]]
native "0x1A6CBB06E2D0D79D"
hash "0x1A6CBB06E2D0D79D"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
```
NativeDB Introduced: v1604
```
]]
native "0x1C57C94A6446492A"
hash "0x1C57C94A6446492A"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
```
NativeDB Introduced: v1604
```
]]
native "0x1E3F1B1B891A2AAA"
hash "0x1E3F1B1B891A2AAA"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
]]
native "0x2542269291C6AC84"
hash "0x2542269291C6AC84"
arguments {
Any "p0" [=[ {} ]=],
}
ns "OBJECT"
returns "Any"
doc [[!
```
NativeDB Introduced: v1180
```
]]
native "0x27F248C3FEBFAAD3"
hash "0x27F248C3FEBFAAD3"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "0x31574B1B41268673"
hash "0x31574B1B41268673"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
```
NativeDB Introduced: v2189
```
]]
native "0x31F924B53EADDF65"
hash "0x31F924B53EADDF65"
jhash (0xDB18FA01)
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
]]
native "0x394CD08E31313C28"
hash "0x394CD08E31313C28"
ns "OBJECT"
returns "void"
doc [[!
]]
native "0x39A5FB7EAF150840"
hash "0x39A5FB7EAF150840"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
]]
native "0x3B2FD68DB5F8331C"
hash "0x3B2FD68DB5F8331C"
arguments {
Object "object" [=[ {} ]=],
BOOL "toggle" [=[ {"cs_type":"Any"} ]=],
int "R" [=[ {} ]=],
int "G" [=[ {} ]=],
int "B" [=[ {} ]=],
}
alias "_SET_OBJECT_COLOUR"
ns "OBJECT"
returns "void"
doc [[!
```
NativeDB Removed Parameter 3: int R
NativeDB Removed Parameter 4: int G
NativeDB Removed Parameter 5: int B
NativeDB Introduced: v757
```
]]
native "0x3BD770D281982DB5"
hash "0x3BD770D281982DB5"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "OBJECT"
returns "Any"
doc [[!
```
NativeDB Introduced: v1604
```
]]
native "0x46F3ADD1E2D5BAF2"
hash "0x46F3ADD1E2D5BAF2"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
]]
native "0x4C134B4DF76025D0"
hash "0x4C134B4DF76025D0"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
```
NativeDB Introduced: v1180
```
]]
native "0x62454A641B41F3C5"
hash "0x62454A641B41F3C5"
arguments {
Any "p0" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
]]
native "0x63ECF581BC70E363"
hash "0x63ECF581BC70E363"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
```
NativeDB Introduced: v1365
```
]]
native "0x641F272B52E2F0F8"
hash "0x641F272B52E2F0F8"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
]]
native "0x659F9D71F52843F8"
hash "0x659F9D71F52843F8"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "0x66A49D021870FE88"
hash "0x66A49D021870FE88"
jhash (0x6158959E)
ns "OBJECT"
returns "void"
doc [[!
]]
native "0x701FDA1E82076BA4"
hash "0x701FDA1E82076BA4"
jhash (0xF592AD10)
ns "OBJECT"
returns "void"
doc [[!
Clears the fields sets by [N\_0xc7f29ca00f46350e](#\_0xC7F29CA00F46350E) (1604 retail: 0x1424A7A10, 0x1424A7A11) and iterates over the global CDoor's bucket-list.
Related to its "Pre-networked state"?
]]
native "0x734E1714D077DA9A"
hash "0x734E1714D077DA9A"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
```
NativeDB Introduced: v1604
```
]]
native "0x762DB2D380B48D04"
hash "0x762DB2D380B48D04"
jhash (0xD1BAAFB7)
arguments {
Any "p0" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
]]
native "0x7813E8B8C4AE4799"
hash "0x7813E8B8C4AE4799"
arguments {
Pickup "pickup" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
SET_PICKUP_\*
```
NativeDB Introduced: v1734
```
]]
native "0x826D1EE4D1CAFC78"
hash "0x826D1EE4D1CAFC78"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
]]
native "0x834344A414C7C85D"
hash "0x834344A414C7C85D"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "0x858EC9FD25DE04AA"
hash "0x858EC9FD25DE04AA"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
]]
native "0x8881C98A31117998"
hash "0x8881C98A31117998"
arguments {
Any "p0" [=[ {} ]=],
}
alias "0xA90E7227A9303FA9"
ns "OBJECT"
returns "void"
doc [[!
```
NativeDB Added Parameter 2: Any p1
```
]]
native "0x8CAAB2BD3EA58BD4"
hash "0x8CAAB2BD3EA58BD4"
arguments {
Any "p0" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
]]
native "0x8CFF648FBD7330F1"
hash "0x8CFF648FBD7330F1"
arguments {
Any "p0" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
```
NativeDB Introduced: v757
```
]]
native "0x8DCA505A5C196F05"
hash "0x8DCA505A5C196F05"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
```
NativeDB Introduced: v1180
```
]]
native "0xA08FE5E49BDC39DD"
hash "0xA08FE5E49BDC39DD"
jhash (0x276A7807)
arguments {
Any "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
]]
native "0xA2C1F5E92AFE49ED"
hash "0xA2C1F5E92AFE49ED"
jhash (0xB241806C)
ns "OBJECT"
returns "void"
doc [[!
```
CLEAR_*
```
]]
native "0xA85A21582451E951"
hash "0xA85A21582451E951"
jhash (0xF736227C)
arguments {
Hash "doorHash" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
Some property related to gates. Native name between `DOOR_SYSTEM_SET_AUTOMATIC_RATE` and `DOOR_SYSTEM_SET_DOOR_STATE`.
]]
native "0xAA059C615DE9DD03"
hash "0xAA059C615DE9DD03"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
```
NativeDB Introduced: v1180
```
]]
native "0xADF084FB8F075D06"
hash "0xADF084FB8F075D06"
arguments {
Object "p0" [=[ {} ]=],
}
ns "OBJECT"
returns "BOOL"
doc [[!
```
NativeDB Introduced: v1604
```
]]
native "0xAFE24E4D29249E4A"
hash "0xAFE24E4D29249E4A"
arguments {
Object "object" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
}
ns "OBJECT"
returns "BOOL"
doc [[!
```
NativeDB Introduced: v1734
```
]]
native "0xB2D0BDE54F0E8E5A"
hash "0xB2D0BDE54F0E8E5A"
jhash (0x132B6D92)
arguments {
Object "object" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
]]
native "0xB5B7742424BD4445"
hash "0xB5B7742424BD4445"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
```
NativeDB Introduced: v1604
```
]]
native "0xB7C6D80FB371659A"
hash "0xB7C6D80FB371659A"
ns "OBJECT"
returns "void"
doc [[!
```
Clears all areas created by 0xD4A7A435B3710D05
CLEAR_*
NativeDB Introduced: v1290
```
]]
native "0xBFFE53AE7E67FCDC"
hash "0xBFFE53AE7E67FCDC"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "0xC6033D32241F6FB5"
hash "0xC6033D32241F6FB5"
jhash (0xF4A1A14A)
arguments {
Object "object" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
]]
native "0xC7F29CA00F46350E"
hash "0xC7F29CA00F46350E"
jhash (0x9BF33E41)
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
See [`N_0x701fda1e82076ba4`](#\_0x701FDA1E82076BA4).
]]
native "0xD05A3241B9A86F19"
hash "0xD05A3241B9A86F19"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
```
NativeDB Introduced: v1180
```
]]
native "0xD4A7A435B3710D05"
hash "0xD4A7A435B3710D05"
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "radius" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
```
Adds an area that seems to be related to pickup physics behavior.
Max amount of areas is 10. Only works in multiplayer.
ADD_*
NativeDB Introduced: v1290
```
]]
native "0xDB41D07A45A6D4B7"
hash "0xDB41D07A45A6D4B7"
jhash (0x000E92DC)
arguments {
Any "p0" [=[ {} ]=],
}
ns "OBJECT"
returns "Any"
doc [[!
]]
native "0xE05F6AEEFEB0BB02"
hash "0xE05F6AEEFEB0BB02"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
```
NativeDB Introduced: v1180
```
]]
native "0xEB6F1A9B5510A5D2"
hash "0xEB6F1A9B5510A5D2"
jhash (0xAF016CC1)
arguments {
Any "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
]]
native "0xF92099527DB8E2A7"
hash "0xF92099527DB8E2A7"
jhash (0xA7E936FD)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
]]
native "0xFDC07C58E8AAB715"
hash "0xFDC07C58E8AAB715"
arguments {
Hash "pickupHash" [=[ {} ]=],
}
ns "OBJECT"
returns "void"
doc [[!
A\*
```
NativeDB Introduced: v1734
```
]]
native "DISABLE_ALL_CONTROL_ACTIONS"
hash "0x5F4B6931816E599B"
jhash (0x16753CF4)
arguments {
int "padIndex" [=[ {} ]=],
}
ns "PAD"
returns "void"
doc [[!
The control system instance to use. See [`ENABLE_ALL_CONTROL_ACTIONS`](#\_0xA5FFE9B05F199DE7).
]]
native "DISABLE_CONTROL_ACTION"
hash "0xFE99B66D079CF6BC"
jhash (0x3800C0DC)
arguments {
int "padIndex" [=[ {} ]=],
int "control" [=[ {} ]=],
BOOL "disable" [=[ {} ]=],
}
ns "PAD"
returns "void"
doc [[!
[Control values and meaning](https://docs.fivem.net/docs/game-references/controls/#controls)
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.
]]
native "ENABLE_ALL_CONTROL_ACTIONS"
hash "0xA5FFE9B05F199DE7"
jhash (0xFC2F119F)
arguments {
int "padIndex" [=[ {} ]=],
}
ns "PAD"
returns "void"
doc [[!
```cpp
enum ePadType {
PLAYER_CONTROL = 0,
CAMERA_CONTROL = 1,
FRONTEND_CONTRO = 2
};
```
The control system instance to use.
]]
native "ENABLE_CONTROL_ACTION"
hash "0x351220255D64C155"
jhash (0xD2753551)
arguments {
int "padIndex" [=[ {} ]=],
int "control" [=[ {} ]=],
BOOL "enable" [=[ {} ]=],
}
ns "PAD"
returns "void"
doc [[!
```
control values and meaning: https://github.com/scripthookvdotnet/scripthookvdotnet/blob/47f8bb02a50e27d4bb982f43a78091feac59b21c/source/scripting_v3/GTA/Control.cs
and
https://docs.fivem.net/game-references/controls/
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
```
]]
native "GET_ALLOW_MOVEMENT_WHILE_ZOOMED"
hash "0xFC859E2374407556"
jhash (0xC0823820)
alias "0xFC859E2374407556"
ns "PAD"
returns "BOOL"
doc [[!
```
Returns profile setting 17.
```
]]
native "GET_CONTROL_GROUP_INSTRUCTIONAL_BUTTON"
hash "0x80C2FD58D720C801"
jhash (0x3EE71F6A)
arguments {
int "padIndex" [=[ {} ]=],
int "controlGroup" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
alias "0x80C2FD58D720C801"
ns "PAD"
returns "charPtr"
doc [[!
The control system instance to use. See [`ENABLE_ALL_CONTROL_ACTIONS`](#\_0xA5FFE9B05F199DE7).
]]
native "GET_CONTROL_INSTRUCTIONAL_BUTTON"
hash "0x0499D7B09FC9B407"
jhash (0x3551727A)
arguments {
int "padIndex" [=[ {} ]=],
int "control" [=[ {} ]=],
BOOL "p2" [=[ {"cs_type":"Player"} ]=],
}
alias "0x0499D7B09FC9B407"
ns "PAD"
returns "charPtr"
doc [[!
```
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.
```
]]
native "GET_CONTROL_NORMAL"
hash "0xEC3C9B8D5327B563"
jhash (0x5DE226A5)
arguments {
int "padIndex" [=[ {} ]=],
int "control" [=[ {} ]=],
}
ns "PAD"
returns "float"
doc [[!
The control system instance to use. See [`ENABLE_ALL_CONTROL_ACTIONS`](#\_0xA5FFE9B05F199DE7).
The [control ID](https://docs.fivem.net/docs/game-references/controls/#controls) to check.
Returns the value of [`GET_CONTROL_VALUE`](#\_0xD95E79E8686D2C27) normalized, i.e. a real number value between -1.0 and 1.0
]]
native "GET_CONTROL_UNBOUND_NORMAL"
hash "0x5B84D09CEC5209C5"
jhash (0xC49343BB)
arguments {
int "padIndex" [=[ {} ]=],
int "control" [=[ {} ]=],
}
alias "0x5B84D09CEC5209C5"
ns "PAD"
returns "float"
doc [[!
```
Seems to return values between -1 and 1 for controls like gas and steering.
```
The control system instance to use. See [`ENABLE_ALL_CONTROL_ACTIONS`](#\_0xA5FFE9B05F199DE7).
The [control ID](https://docs.fivem.net/docs/game-references/controls/#controls) to check.
]]
native "GET_CONTROL_VALUE"
hash "0xD95E79E8686D2C27"
jhash (0xC526F3C6)
arguments {
int "padIndex" [=[ {} ]=],
int "control" [=[ {} ]=],
}
ns "PAD"
returns "int"
doc [[!
The control system instance to use. See [`ENABLE_ALL_CONTROL_ACTIONS`](#\_0xA5FFE9B05F199DE7).
The [control ID](https://docs.fivem.net/docs/game-references/controls/#controls) to check.
]]
native "GET_DISABLED_CONTROL_NORMAL"
hash "0x11E65974A982637C"
jhash (0x66FF4FAA)
arguments {
int "padIndex" [=[ {} ]=],
int "control" [=[ {} ]=],
}
ns "PAD"
returns "float"
doc [[!
The control system instance to use. See [`ENABLE_ALL_CONTROL_ACTIONS`](#\_0xA5FFE9B05F199DE7).
The [control ID](https://docs.fivem.net/docs/game-references/controls/#controls) to check.
]]
native "GET_DISABLED_CONTROL_UNBOUND_NORMAL"
hash "0x4F8A26A890FD62FB"
jhash (0xF2A65A4C)
arguments {
int "padIndex" [=[ {} ]=],
int "control" [=[ {} ]=],
}
alias "0x4F8A26A890FD62FB"
ns "PAD"
returns "float"
doc [[!
The control system instance to use. See [`ENABLE_ALL_CONTROL_ACTIONS`](#\_0xA5FFE9B05F199DE7).
The [control ID](https://docs.fivem.net/docs/game-references/controls/#controls) to check.
]]
native "GET_IS_USING_ALTERNATE_DRIVEBY"
hash "0x0F70731BACCFBB96"
jhash (0xC1AFABD5)
alias "0x0F70731BACCFBB96"
ns "PAD"
returns "BOOL"
doc [[!
```
Returns profile setting 225.
```
]]
native "GET_LOCAL_PLAYER_AIM_STATE"
hash "0xBB41AFBBBC0A0287"
jhash (0x81802053)
ns "PAD"
returns "int"
doc [[!
Returns the local player's targeting mode. See [`SET_PLAYER_TARGETING_MODE`](#\_0xB1906895227793F3).
]]
native "GET_LOCAL_PLAYER_GAMEPAD_AIM_STATE"
hash "0x59B9A7AF4C95133C"
alias "0x59B9A7AF4C95133C"
alias "_GET_LOCAL_PLAYER_AIM_STATE_2"
ns "PAD"
returns "int"
doc [[!
Same behavior as [`GET_LOCAL_PLAYER_AIM_STATE`](#\_0xBB41AFBBBC0A0287) but will also return if player using a keyboard.
Returns the local player's targeting mode. See [`SET_PLAYER_TARGETING_MODE`](#\_0xB1906895227793F3).
]]
native "IS_CONTROL_ENABLED"
hash "0x1CEA6BFDF248E5D9"
jhash (0x9174AF84)
arguments {
int "padIndex" [=[ {} ]=],
int "control" [=[ {} ]=],
}
ns "PAD"
returns "BOOL"
doc [[!
The control system instance to use. See [`ENABLE_ALL_CONTROL_ACTIONS`](#\_0xA5FFE9B05F199DE7).
The [control ID](https://docs.fivem.net/docs/game-references/controls/#controls) to check.
]]
native "IS_CONTROL_JUST_PRESSED"
hash "0x580417101DDB492F"
jhash (0x4487F579)
arguments {
int "padIndex" [=[ {} ]=],
int "control" [=[ {} ]=],
}
ns "PAD"
returns "BOOL"
doc [[!
Returns whether a control was newly pressed since the last check.
The control system instance to use. See [`ENABLE_ALL_CONTROL_ACTIONS`](#\_0xA5FFE9B05F199DE7).
The [control ID](https://docs.fivem.net/docs/game-references/controls/#controls) to check.
True if the control was pressed.
]]
native "IS_CONTROL_JUST_RELEASED"
hash "0x50F940259D3841E6"
jhash (0x2314444B)
arguments {
int "padIndex" [=[ {} ]=],
int "control" [=[ {} ]=],
}
ns "PAD"
returns "BOOL"
doc [[!
Returns whether a control was newly released since the last check.
The control system instance to use. See [`ENABLE_ALL_CONTROL_ACTIONS`](#\_0xA5FFE9B05F199DE7).
The [control ID](https://docs.fivem.net/docs/game-references/controls/#controls) to check.
True if the control was recently released.
]]
native "IS_CONTROL_PRESSED"
hash "0xF3A21BCD95725A4A"
jhash (0x517A4384)
arguments {
int "padIndex" [=[ {} ]=],
int "control" [=[ {} ]=],
}
ns "PAD"
returns "BOOL"
doc [[!
Returns whether a control is currently pressed.
The control system instance to use. See [`ENABLE_ALL_CONTROL_ACTIONS`](#\_0xA5FFE9B05F199DE7).
The [control ID](https://docs.fivem.net/docs/game-references/controls/#controls) to check.
True if the control was pressed.
]]
native "IS_CONTROL_RELEASED"
hash "0x648EE3E7F38877DD"
jhash (0x1F91A06E)
arguments {
int "padIndex" [=[ {} ]=],
int "control" [=[ {} ]=],
}
ns "PAD"
returns "BOOL"
doc [[!
Returns whether a control is currently *not* pressed.
The control system instance to use. See [`ENABLE_ALL_CONTROL_ACTIONS`](#\_0xA5FFE9B05F199DE7).
The [control ID](https://docs.fivem.net/docs/game-references/controls/#controls) to check.
True if the control is not pressed.
]]
native "IS_DISABLED_CONTROL_JUST_PRESSED"
hash "0x91AEF906BCA88877"
jhash (0xEE6ABD32)
arguments {
int "padIndex" [=[ {} ]=],
int "control" [=[ {} ]=],
}
ns "PAD"
returns "BOOL"
doc [[!
The control system instance to use. See [`ENABLE_ALL_CONTROL_ACTIONS`](#\_0xA5FFE9B05F199DE7).
The [control ID](https://docs.fivem.net/docs/game-references/controls/#controls) to check.
]]
native "IS_DISABLED_CONTROL_JUST_RELEASED"
hash "0x305C8DCD79DA8B0F"
jhash (0xD6A679E1)
arguments {
int "padIndex" [=[ {} ]=],
int "control" [=[ {} ]=],
}
ns "PAD"
returns "BOOL"
doc [[!
The control system instance to use. See [`ENABLE_ALL_CONTROL_ACTIONS`](#\_0xA5FFE9B05F199DE7).
The [control ID](https://docs.fivem.net/docs/game-references/controls/#controls) to check.
]]
native "IS_DISABLED_CONTROL_PRESSED"
hash "0xE2587F8CBBD87B1D"
jhash (0x32A93544)
arguments {
int "padIndex" [=[ {} ]=],
int "control" [=[ {} ]=],
}
ns "PAD"
returns "BOOL"
doc [[!
The control system instance to use. See [`ENABLE_ALL_CONTROL_ACTIONS`](#\_0xA5FFE9B05F199DE7).
The [control ID](https://docs.fivem.net/docs/game-references/controls/#controls) to check.
]]
native "IS_LOOK_INVERTED"
hash "0x77B612531280010D"
jhash (0x313434B2)
ns "PAD"
returns "BOOL"
doc [[!
]]
native "SET_INPUT_EXCLUSIVE"
hash "0xEDE476E5EE29EDB1"
jhash (0x4E8E29E6)
arguments {
int "padIndex" [=[ {} ]=],
int "control" [=[ {} ]=],
}
ns "PAD"
returns "void"
doc [[!
The control system instance to use. See [`ENABLE_ALL_CONTROL_ACTIONS`](#\_0xA5FFE9B05F199DE7).
The [control ID](https://docs.fivem.net/docs/game-references/controls/#controls) to check.
]]
native "SET_PAD_SHAKE"
hash "0x48B3886C1358D0D5"
jhash (0x5D38BD2F)
arguments {
int "padIndex" [=[ {} ]=],
int "duration" [=[ {} ]=],
int "frequency" [=[ {} ]=],
}
ns "PAD"
returns "void"
doc [[!
```
p0 always seems to be 0
duration in milliseconds
frequency should range from about 10 (slow vibration) to 255 (very fast)
example:
SET_PAD_SHAKE(0, 100, 200);
```
]]
native "SET_PLAYERPAD_SHAKES_WHEN_CONTROLLER_DISABLED"
hash "0x798FDEB5B1575088"
jhash (0xA86BD91F)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "PAD"
returns "void"
doc [[!
]]
native "STOP_PAD_SHAKE"
hash "0x38C16A305E8CDC8D"
jhash (0x8F75657E)
arguments {
int "padIndex" [=[ {} ]=],
}
ns "PAD"
returns "void"
doc [[!
]]
native "_DISABLE_INPUT_GROUP"
hash "0x7F4724035FDCA1DD"
jhash (0x2CEDE6C5)
arguments {
int "padIndex" [=[ {} ]=],
}
alias "0x7F4724035FDCA1DD"
ns "PAD"
returns "void"
doc [[!
]]
native "_GET_TIME_SINCE_LAST_INPUT"
hash "0xD7D22F5592AED8BA"
jhash (0x0E8EF929)
arguments {
int "padIndex" [=[ {} ]=],
}
alias "0xD7D22F5592AED8BA"
ns "PAD"
returns "int"
doc [[!
```
The number of milliseconds since last padIndex registered pressed
```
]]
native "_IS_DISABLED_CONTROL_RELEASED"
hash "0xFB6C4072E9A32E92"
arguments {
int "padIndex" [=[ {} ]=],
int "control" [=[ {} ]=],
}
alias "0xFB6C4072E9A32E92"
ns "PAD"
returns "BOOL"
doc [[!
The control system instance to use. See [`ENABLE_ALL_CONTROL_ACTIONS`](#\_0xA5FFE9B05F199DE7).
The [control ID](https://docs.fivem.net/docs/game-references/controls/#controls) to check.
]]
native "_IS_USING_KEYBOARD"
hash "0xA571D46727E2B718"
arguments {
int "padIndex" [=[ {} ]=],
}
alias "_GET_LAST_INPUT_METHOD"
alias "_IS_INPUT_DISABLED"
ns "PAD"
returns "BOOL"
doc [[!
The control system instance to use. See [`ENABLE_ALL_CONTROL_ACTIONS`](#\_0xA5FFE9B05F199DE7).
]]
native "_IS_USING_KEYBOARD_2"
hash "0x13337B38DB572509"
arguments {
int "padIndex" [=[ {} ]=],
}
alias "0x13337B38DB572509"
alias "_IS_INPUT_JUST_DISABLED"
ns "PAD"
returns "BOOL"
doc [[!
The control system instance to use. See [`ENABLE_ALL_CONTROL_ACTIONS`](#\_0xA5FFE9B05F199DE7).
]]
native "_RESET_INPUT_MAPPING_SCHEME"
hash "0x643ED62D5EA3BEBD"
jhash (0x42140FF9)
alias "0x643ED62D5EA3BEBD"
ns "PAD"
returns "void"
doc [[!
```
S*
```
]]
native "_SET_CONTROL_LIGHT_EFFECT_COLOR"
hash "0x8290252FFF36ACB5"
arguments {
int "padIndex" [=[ {} ]=],
int "red" [=[ {} ]=],
int "green" [=[ {} ]=],
int "blue" [=[ {} ]=],
}
alias "0x8290252FFF36ACB5"
alias "_SET_CONTROL_GROUP_COLOR"
ns "PAD"
returns "void"
doc [[!
The control system instance to use. See [`ENABLE_ALL_CONTROL_ACTIONS`](#\_0xA5FFE9B05F199DE7).
]]
native "_SET_CONTROL_NORMAL"
hash "0xE8A25867FBA3B05E"
arguments {
int "padIndex" [=[ {} ]=],
int "control" [=[ {} ]=],
float "amount" [=[ {} ]=],
}
alias "0xE8A25867FBA3B05E"
ns "PAD"
returns "BOOL"
doc [[!
This is for simulating player input.
The control system instance to use. See [`ENABLE_ALL_CONTROL_ACTIONS`](#\_0xA5FFE9B05F199DE7).
The [control ID](https://docs.fivem.net/docs/game-references/controls/#controls) to check.
An unbounded normal value.
]]
native "_SET_CURSOR_LOCATION"
hash "0xFC695459D4D0E219"
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
}
alias "0xFC695459D4D0E219"
ns "PAD"
returns "BOOL"
doc [[!
Sets the position of the mouse cursor within the current UI context (e.g., NUI menu or pause menu).\
Coordinates must be in the range 0.0 to 1.0, where (0.5, 0.5) represents the center of the screen.
Horizontal position (0.0 = left, 1.0 = right)
Vertical position (0.0 = top, 1.0 = bottom)
Returns `true` if the cursor position was successfully set, otherwise `false`.
]]
native "_SWITCH_TO_INPUT_MAPPING_SCHEME"
hash "0x3D42B92563939375"
jhash (0xD2C80B2E)
arguments {
charPtr "name" [=[ {} ]=],
}
alias "0x3D42B92563939375"
ns "PAD"
returns "BOOL"
doc [[!
```
Used in carsteal3 script with p0 = "Carsteal4_spycar".
S*
```
]]
native "_SWITCH_TO_INPUT_MAPPING_SCHEME_2"
hash "0x4683149ED1DDE7A1"
jhash (0xBBFC9050)
arguments {
charPtr "name" [=[ {} ]=],
}
alias "0x4683149ED1DDE7A1"
ns "PAD"
returns "BOOL"
doc [[!
```
Same as 0x3D42B92563939375
S*
```
]]
native "0x14D29BB12D47F68C"
hash "0x14D29BB12D47F68C"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
}
ns "PAD"
returns "void"
doc [[!
**This native does absolutely nothing, just a nullsub**
]]
native "0x23F09EADC01449D6"
hash "0x23F09EADC01449D6"
arguments {
int "padIndex" [=[ {} ]=],
}
ns "PAD"
returns "BOOL"
doc [[!
Hardcoded to return false.
The control system instance to use. See [`ENABLE_ALL_CONTROL_ACTIONS`](#\_0xA5FFE9B05F199DE7).
]]
native "0x25AAA32BDC98F2A3"
hash "0x25AAA32BDC98F2A3"
ns "PAD"
returns "Any"
doc [[!
```
NativeDB Introduced: v1365
```
]]
native "0x5B73C77D9EB66E24"
hash "0x5B73C77D9EB66E24"
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "PAD"
returns "void"
doc [[!
]]
native "0x6CD79468A1E595C6"
hash "0x6CD79468A1E595C6"
arguments {
int "padIndex" [=[ {} ]=],
}
ns "PAD"
returns "BOOL"
doc [[!
The control system instance to use. See [`ENABLE_ALL_CONTROL_ACTIONS`](#\_0xA5FFE9B05F199DE7).
]]
native "0xA0CEFCEA390AAB9B"
hash "0xA0CEFCEA390AAB9B"
arguments {
Any "p0" [=[ {} ]=],
}
ns "PAD"
returns "void"
doc [[!
]]
native "0xCB0360EFEFB2580D"
hash "0xCB0360EFEFB2580D"
arguments {
int "padIndex" [=[ {} ]=],
}
ns "PAD"
returns "void"
doc [[!
]]
native "0xE1615EC03B3BB4FD"
hash "0xE1615EC03B3BB4FD"
ns "PAD"
returns "BOOL"
doc [[!
```
Used with IS_LOOK_INVERTED() and negates its affect.
--
Not sure how the person above got that description, but here's an actual example:
if (PAD::_GET_LAST_INPUT_METHOD(2)) {
if (a_5) {
if (PAD::IS_LOOK_INVERTED()) {
a_3 *= -1;
}
if (PAD::_E1615EC03B3BB4FD()) {
a_3 *= -1;
}
}
}
```
]]
native "0xF239400E16C23E08"
hash "0xF239400E16C23E08"
jhash (0x7D65EB6E)
arguments {
int "padIndex" [=[ {} ]=],
int "p1" [=[ {} ]=],
}
ns "PAD"
returns "void"
doc [[!
]]
native "ADD_NAVMESH_BLOCKING_OBJECT"
hash "0xFCD5C8E06E502F5A"
jhash (0x2952BA56)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "width" [=[ {} ]=],
float "length" [=[ {} ]=],
float "height" [=[ {} ]=],
float "heading" [=[ {} ]=],
BOOL "bPermanent" [=[ {} ]=],
int "flags" [=[ {} ]=],
}
ns "PATHFIND"
returns "Any"
doc [[!
Creates a navmesh blocking object, vehicles will avoid driving through this area.
Only 32 blocking objects may exist at a given time and must be manually managed. See [`REMOVE_NAVMESH_BLOCKING_OBJECT`](#\_0x46399A7895957C0E) and [`onResourceStop`](https://docs.fivem.net/docs/scripting-reference/events/list/onResourceStop/)
```cpp
enum eBlockingObjectFlags {
// Default Flag
BLOCKING_OBJECT_DEFAULT = 0,
// Blocking object will block wander paths
BLOCKING_OBJECT_WANDERPATH = 1,
// Blocking object will block (regular) shortest-paths
BLOCKING_OBJECT_SHORTESTPATH = 2,
// Blocking object will block flee paths
BLOCKING_OBJECT_FLEEPATH = 4,
// Blocking object will block all paths
BLOCKING_OBJECT_ALLPATHS = 7,
}
```
The x coordinate to create the block on.
The y coordinate.
The z coordinate.
The width of the block.
The length of the block.
The height of the block.
The heading of object in degrees.
A boolean indicating if the blocking object is permanent (`true`/`false`).
Flag for the blocking object, refer to `eBlockingObjectFlags`.
]]
native "ADD_NAVMESH_REQUIRED_REGION"
hash "0x387EAD7EE42F6685"
jhash (0x12B086EA)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "radius" [=[ {} ]=],
}
ns "PATHFIND"
returns "void"
doc [[!
]]
native "ARE_ALL_NAVMESH_REGIONS_LOADED"
hash "0x8415D95B194A3AEA"
jhash (0x34C4E789)
ns "PATHFIND"
returns "BOOL"
doc [[!
]]
native "ARE_NODES_LOADED_FOR_AREA"
hash "0xF7B79A50B905A30D"
jhash (0x86E80A17)
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
}
alias "0xF7B79A50B905A30D"
alias "_ARE_PATH_NODES_LOADED_IN_AREA"
ns "PATHFIND"
returns "BOOL"
doc [[!
]]
native "CALCULATE_TRAVEL_DISTANCE_BETWEEN_POINTS"
hash "0xADD95C7005C4A197"
jhash (0xB114489B)
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
}
ns "PATHFIND"
returns "float"
doc [[!
Calculates the travel distance between a set of points.
Doesn't seem to correlate with distance on gps sometimes.
This function returns the value 100000.0 over long distances, seems to be a failure mode result, potentially occurring when not all path nodes are loaded into pathfind.
]]
native "CLEAR_GPS_DISABLED_ZONE_AT_INDEX"
hash "0x2801D0012266DF07"
jhash (0x59090745)
arguments {
int "index" [=[ {} ]=],
}
alias "0x2801D0012266DF07"
alias "_CLEAR_GPS_DISABLED_ZONE_AT_INDEX"
ns "PATHFIND"
returns "void"
doc [[!
Clears a disabled GPS route area from a certain index previously set using [`SET_GPS_DISABLED_ZONE_AT_INDEX`](#\_0xD0BC1C6FB18EE154).
Index of disabled zone.
]]
native "DISABLE_NAVMESH_IN_AREA"
hash "0x4C8872D8CDBE1B8B"
jhash (0x6E37F132)
arguments {
float "posMinX" [=[ {"cs_type":"Any"} ]=],
float "posMinY" [=[ {"cs_type":"Any"} ]=],
float "posMinZ" [=[ {"cs_type":"Any"} ]=],
float "posMaxX" [=[ {"cs_type":"Any"} ]=],
float "posMaxY" [=[ {"cs_type":"Any"} ]=],
float "posMaxZ" [=[ {"cs_type":"Any"} ]=],
bool "bDisable" [=[ {"cs_type":"Any"} ]=],
}
ns "PATHFIND"
returns "void"
doc [[!
Use this if you want to completely disable a large area of navmesh.
For smaller areas, use [`ADD_NAVMESH_BLOCKING_OBJECT`](#\_0xFCD5C8E06E502F5A) instead.
X Min Coordinate.
Y Min Coordinate.
Z Min Coordinate.
X Max Coordinate.
Y Max Coordinate.
Z Max Coordinate.
Whether to disable the navmesh or not.
]]
native "DOES_NAVMESH_BLOCKING_OBJECT_EXIST"
hash "0x0EAEB0DB4B132399"
jhash (0x4B67D7EE)
arguments {
Any "p0" [=[ {} ]=],
}
alias "0x0EAEB0DB4B132399"
ns "PATHFIND"
returns "BOOL"
doc [[!
]]
native "GENERATE_DIRECTIONS_TO_COORD"
hash "0xF90125F1F79ECDF8"
jhash (0xED35C094)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
intPtr "direction" [=[ {} ]=],
floatPtr "vehicle" [=[ {} ]=],
floatPtr "distToNxJunction" [=[ {} ]=],
}
ns "PATHFIND"
returns "int"
doc [[!
```
p3 is 0 in the only game script occurrence (trevor3) but 1 doesn't seem to make a difference
distToNxJunction seems to be the distance in metres * 10.0f
direction:
0 = This happens randomly during the drive for seemingly no reason but if you consider that this native is only used in trevor3, it seems to mean "Next frame, stop whatever's being said and tell the player the direction."
1 = Route is being calculated or the player is going in the wrong direction
2 = Please Proceed the Highlighted Route
3 = In (distToNxJunction) Turn Left
4 = In (distToNxJunction) Turn Right
5 = In (distToNxJunction) Keep Straight
6 = In (distToNxJunction) Turn Sharply To The Left
7 = In (distToNxJunction) Turn Sharply To The Right
8 = Route is being recalculated or the navmesh is confusing. This happens randomly during the drive but consistently at {2044.0358, 2996.6116, 44.9717} if you face towards the bar and the route needs you to turn right. In that particular case, it could be a bug with how the turn appears to be 270 deg. CCW instead of "right." Either way, this seems to be the engine saying "I don't know the route right now."
return value set to 0 always
```
]]
native "GET_CLOSEST_MAJOR_VEHICLE_NODE"
hash "0x2EABE3B06F58C1BE"
jhash (0x04B5F15B)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
Vector3Ptr "outPosition" [=[ {} ]=],
float "zMeasureMult" [=[ {} ]=],
int "zTolerance" [=[ {} ]=],
}
ns "PATHFIND"
returns "BOOL"
doc [[!
Same as [`GET_CLOSEST_VEHICLE_NODE`](#\_0x240A18690AE96513), but with the node flag `GCNF_INCLUDE_SWITCHED_OFF_NODES` set.
X coordinate
Y coordinate
Z coordinate
Pointer to the found nodes coords
How strongly the difference in the Z direction should be weighted
How far apart the Z coords have to be before `zMeasureMult` kicks in
Returns the closest major vehicle node.
]]
native "GET_CLOSEST_ROAD"
hash "0x132F52BBA570FE92"
jhash (0x567B0E11)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "minimumEdgeLength" [=[ {} ]=],
int "minimumLaneCount" [=[ {} ]=],
Vector3Ptr "srcNode" [=[ {} ]=],
Vector3Ptr "targetNode" [=[ {} ]=],
intPtr "laneCountForward" [=[ {} ]=],
intPtr "laneCountBackward" [=[ {} ]=],
floatPtr "width" [=[ {} ]=],
BOOL "onlyMajorRoads" [=[ {} ]=],
}
ns "PATHFIND"
annotations [=[ {"cs_type":"Any"} ]=]
returns "bool"
doc [[!
Finds an edge (node connection to another node) that satisfies the specified criteria.
x position
y position
z position
Minimum distance the srcNode must be from the targetNode.
Minimum number of lanes the connection must have.
Position of the edge source
Position of the edge target
Lane count forward
Lane count backwards
Width of gap in middle of road between forward and backward lanes.
Return major roads only.
Returns `true` if a road was found, `false` otherwise.
]]
native "GET_CLOSEST_VEHICLE_NODE"
hash "0x240A18690AE96513"
jhash (0x6F5F1E6C)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
Vector3Ptr "outPosition" [=[ {} ]=],
int "nodeFlags" [=[ {} ]=],
float "zMeasureMult" [=[ {} ]=],
float "zTolerance" [=[ {} ]=],
}
ns "PATHFIND"
returns "BOOL"
doc [[!
```cpp
enum eGetClosestNodeFlags {
GCNF_INCLUDE_SWITCHED_OFF_NODES = 1,
GCNF_INCLUDE_BOAT_NODES = 2,
GCNF_IGNORE_SLIPLANES = 4,
GCNF_IGNORE_SWITCHED_OFF_DEADENDS = 8,
GCNF_GET_HEADING = 256,
GCNF_FAVOUR_FACING = 512
}
```
X coordinate
Y coordinate
Z coordinate
Pointer to the found nodes coords
Node flags
How strongly the difference in the Z direction should be weighted
How far apart the Z coords have to be before `zMeasureMult` kicks in
Returns the closest vehicle node matching the node flags.
]]
native "GET_CLOSEST_VEHICLE_NODE_WITH_HEADING"
hash "0xFF071FB798B803B0"
jhash (0x8BD5759B)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
Vector3Ptr "outPosition" [=[ {} ]=],
floatPtr "outHeading" [=[ {} ]=],
int "nodeFlags" [=[ {} ]=],
float "zMeasureMult" [=[ {} ]=],
int "zTolerance" [=[ {} ]=],
}
ns "PATHFIND"
returns "BOOL"
doc [[!
Same as [`GET_CLOSEST_VEHICLE_NODE`](#\_0x240A18690AE96513), but with the node flag `GCNF_GET_HEADING` set, causing the native to also return the heading.
X coordinate
Y coordinate
Z coordinate
Pointer to the found nodes coords
Pointer to the found nodes heading
Node flags, see [`GET_CLOSEST_VEHICLE_NODE`](#\_0x240A18690AE96513)
How strongly the difference in the Z direction should be weighted
How far apart the Z coords have to be before `zMeasureMult` kicks in
Returns the closest vehicle node with its heading.
]]
native "GET_GPS_BLIP_ROUTE_FOUND"
hash "0x869DAACBBE9FA006"
jhash (0x286F82CC)
alias "0x869DAACBBE9FA006"
ns "PATHFIND"
returns "BOOL"
doc [[!
]]
native "GET_GPS_BLIP_ROUTE_LENGTH"
hash "0xBBB45C3CF5C8AA85"
jhash (0x4B770634)
alias "0xBBB45C3CF5C8AA85"
ns "PATHFIND"
returns "int"
doc [[!
]]
native "GET_NEXT_GPS_DISABLED_ZONE_INDEX"
hash "0xD3A6A0EF48823A8C"
jhash (0xBE92551F)
arguments {
int "index" [=[ {} ]=],
}
alias "0xD3A6A0EF48823A8C"
ns "PATHFIND"
returns "int"
doc [[!
Gets the next zone that has been disabled using SET_GPS_DISABLED_ZONE_AT_INDEX.
```
NativeDB Removed Parameter 1: int index
```
The disabled zone index
]]
native "GET_NTH_CLOSEST_VEHICLE_NODE"
hash "0xE50E52416CCF948B"
jhash (0xF125BFCC)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
int "nthClosest" [=[ {} ]=],
Vector3Ptr "outPosition" [=[ {} ]=],
int "nodeFlags" [=[ {} ]=],
float "zMeasureMult" [=[ {"cs_type":"Any"} ]=],
float "zTolerance" [=[ {"cs_type":"Any"} ]=],
}
ns "PATHFIND"
returns "BOOL"
doc [[!
Same as [`GET_CLOSEST_VEHICLE_NODE`](#\_0x240A18690AE96513), but returns the nth closest node instead of the first.
X coordinate
Y coordinate
Z coordinate
The index of the node to return
Pointer to the found nodes coords
Node flags, see [`GET_CLOSEST_VEHICLE_NODE`](#\_0x240A18690AE96513)
How strongly the difference in the Z direction should be weighted
How far apart the Z coords have to be before `zMeasureMult` kicks in
Returns the nth closest vehicle node.
]]
native "GET_NTH_CLOSEST_VEHICLE_NODE_FAVOUR_DIRECTION"
hash "0x45905BE8654AE067"
jhash (0x928A4DEC)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "desiredX" [=[ {} ]=],
float "desiredY" [=[ {} ]=],
float "desiredZ" [=[ {} ]=],
int "nthClosest" [=[ {} ]=],
Vector3Ptr "outPosition" [=[ {} ]=],
floatPtr "outHeading" [=[ {} ]=],
int "nodeFlags" [=[ {} ]=],
float "zMeasureMult" [=[ {"cs_type":"Any"} ]=],
float "zTolerance" [=[ {"cs_type":"Any"} ]=],
}
ns "PATHFIND"
returns "BOOL"
doc [[!
Like [`GET_CLOSEST_VEHICLE_NODE_WITH_HEADING`](#\_0xFF071FB798B803B0), but returns the nth closest node instead of the first.
X coordinate
Y coordinate
Z coordinate
The X direction to favour
The Y direction to favour
The Z direction to favour
The index of the node to return
Pointer to the found nodes coords
Pointer to the found nodes heading
Node flags, see [`GET_CLOSEST_VEHICLE_NODE`](#\_0x240A18690AE96513)
How strongly the difference in the Z direction should be weighted
How far apart the Z coords have to be before `zMeasureMult` kicks in
Returns the nth closest vehicle node with its heading favouring the desired direction.
]]
native "GET_NTH_CLOSEST_VEHICLE_NODE_ID"
hash "0x22D7275A79FE8215"
jhash (0x3F358BEA)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
int "nthClosest" [=[ {} ]=],
int "nodeFlags" [=[ {} ]=],
float "zMeasureMult" [=[ {} ]=],
float "zTolerance" [=[ {} ]=],
}
ns "PATHFIND"
returns "int"
doc [[!
X coordinate
Y coordinate
Z coordinate
The index of the node to return
Node flags, see [`GET_CLOSEST_VEHICLE_NODE`](#\_0x240A18690AE96513)
How strongly the difference in the Z direction should be weighted
How far apart the Z coords have to be before `zMeasureMult` kicks in
Returns the nth closest vehicle nodes id.
]]
native "GET_NTH_CLOSEST_VEHICLE_NODE_ID_WITH_HEADING"
hash "0x6448050E9C2A7207"
jhash (0xC1AEB88D)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
int "nthClosest" [=[ {} ]=],
Vector3Ptr "outPosition" [=[ {} ]=],
floatPtr "outHeading" [=[ {"cs_type":"float"} ]=],
int "nodeFlags" [=[ {} ]=],
float "zMeasureMult" [=[ {} ]=],
float "zTolerance" [=[ {} ]=],
}
ns "PATHFIND"
returns "int"
doc [[!
X coordinate
Y coordinate
Z coordinate
The index of the node to return
Pointer to the found nodes coords
Pointer to the found nodes heading
Node flags, see [`GET_CLOSEST_VEHICLE_NODE`](#\_0x240A18690AE96513)
How strongly the difference in the Z direction should be weighted
How far apart the Z coords have to be before `zMeasureMult` kicks in
Returns the nth closest vehicle nodes id with its heading.
]]
native "GET_NTH_CLOSEST_VEHICLE_NODE_WITH_HEADING"
hash "0x80CA6A8B6C094CC4"
jhash (0x7349C856)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
int "nthClosest" [=[ {} ]=],
Vector3Ptr "outPosition" [=[ {} ]=],
floatPtr "outHeading" [=[ {} ]=],
intPtr "totalLanes" [=[ {} ]=],
int "nodeFlags" [=[ {} ]=],
float "zMeasureMult" [=[ {} ]=],
float "zTolerance" [=[ {} ]=],
}
ns "PATHFIND"
returns "BOOL"
doc [[!
Get the nth closest vehicle node with its heading and total lane count. If you need specific forward and backward lane counts use [`GET_CLOSEST_ROAD`](#\_0x132F52BBA570FE92).
X coordinate
Y coordinate
Z coordinate
The index of the node to return
Pointer to the found nodes coords
Pointer to the found nodes heading
Pointer to the total lanes (forward + backward) of the found node
Node flags, see [`GET_CLOSEST_VEHICLE_NODE`](#\_0x240A18690AE96513)
How strongly the difference in the Z direction should be weighted
How far apart the Z coords have to be before `zMeasureMult` kicks in
Returns `true` if the node was found, or `false` if the node was not found, or was not streamed in.
]]
native "GET_NUM_NAVMESHES_EXISTING_IN_AREA"
hash "0x01708E8DD3FF8C65"
jhash (0x76AFFBB5)
arguments {
float "posMinX" [=[ {} ]=],
float "posMinY" [=[ {} ]=],
float "posMinZ" [=[ {} ]=],
float "posMaxX" [=[ {} ]=],
float "posMaxY" [=[ {} ]=],
float "posMaxZ" [=[ {} ]=],
}
alias "0x01708E8DD3FF8C65"
ns "PATHFIND"
returns "int"
doc [[!
Min X Coordinate.
Min Y Coordinate.
Min Z Coordinate.
Max X Coordinate.
Max Y Coordinate.
Max Z Coordinate.
Returns the number of navmeshes which exist in the given area (irrespective of whether they are currently loaded or not)
]]
native "GET_POS_ALONG_GPS_TYPE_ROUTE"
hash "0xF3162836C28F9DA5"
jhash (0x40BB1149)
arguments {
Vector3Ptr "result" [=[ {} ]=],
BOOL "bStartAtPlayerPos" [=[ {} ]=],
float "fDistanceAlongRoute" [=[ {} ]=],
int "slotType" [=[ {} ]=],
}
alias "0xF3162836C28F9DA5"
alias "GET_GPS_WAYPOINT_ROUTE_END"
ns "PATHFIND"
returns "BOOL"
doc [[!
Native to get a position along current player GPS route using supplied slot.
This native was previously named `GET_GPS_WAYPOINT_ROUTE_END`, but its named changed.
```cpp
enum eGpsSlotType {
GPS_SLOT_WAYPOINT = 0,
GPS_SLOT_RADAR_BLIP = 1,
GPS_SLOT_DISCRETE = 2
}
```
Coordinates of waypoint marker
Should we project distance from the player position or from next node.
Distance we want to get the position along the route.
Type of gps route to check against. See `eGpsSlotType`.
will return `true` if a position is returned, `false` if not.
]]
native "GET_RANDOM_VEHICLE_NODE"
hash "0x93E0DB8440B73A7D"
jhash (0xAD1476EA)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "radius" [=[ {} ]=],
BOOL "p4" [=[ {} ]=],
BOOL "p5" [=[ {} ]=],
BOOL "p6" [=[ {} ]=],
Vector3Ptr "outPosition" [=[ {} ]=],
intPtr "nodeId" [=[ {} ]=],
}
ns "PATHFIND"
returns "BOOL"
doc [[!
]]
native "GET_ROAD_BOUNDARY_USING_HEADING"
hash "0xA0F8A7517A273C05"
jhash (0x5E440AC7)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "heading" [=[ {} ]=],
Vector3Ptr "outPosition" [=[ {} ]=],
}
alias "0xA0F8A7517A273C05"
alias "_GET_ROAD_SIDE_POINT_WITH_HEADING"
ns "PATHFIND"
returns "BOOL"
doc [[!
]]
native "GET_SAFE_COORD_FOR_PED"
hash "0xB61C8E878A4199CA"
jhash (0xB370270A)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
BOOL "onlyOnPavement" [=[ {} ]=],
Vector3Ptr "outPosition" [=[ {} ]=],
int "flags" [=[ {} ]=],
}
ns "PATHFIND"
returns "BOOL"
doc [[!
```cpp
enum eSafePositionFlags {
// Only navmesh polygons marked as pavement
GSC_FLAG_ONLY_PAVEMENT = 1,
// Only navmesh polygons not marked as "isolated"
GSC_FLAG_NOT_ISOLATED = 2,
// No navmesh polygons created from interiors
GSC_FLAG_NOT_INTERIOR = 4,
// No navmesh polygons marked as water
GSC_FLAG_NOT_WATER = 8,
// Only navmesh polygons marked as "network spawn candidate"
GSC_FLAG_ONLY_NETWORK_SPAWN = 16,
// Specify whether to use a flood-fill from the starting position, as opposed to scanning all polygons within the search volume
GSC_FLAG_USE_FLOOD_FILL = 32
}
```
The X coordinate of the point to check.
The Y coordinate of the point to check.
The Z coordinate of the point to check.
Sets the `GSC_FLAG_ONLY_PAVEMENT` flag.
The location of the safe coord.
The search flags.
Returns true if a safe coord was found and false otherwise.
]]
native "GET_STREET_NAME_AT_COORD"
hash "0x2EB41072B4C1E4C0"
jhash (0xDEBEEFCF)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
HashPtr "streetName" [=[ {} ]=],
HashPtr "crossingRoad" [=[ {} ]=],
}
ns "PATHFIND"
returns "void"
doc [[!
```
Determines the name of the street which is the closest to the given coordinates.
x,y,z - the coordinates of the street
streetName - returns a hash to the name of the street the coords are on
crossingRoad - if the coordinates are on an intersection, a hash to the name of the crossing road
Note: the names are returned as hashes, the strings can be returned using the function HUD::GET_STREET_NAME_FROM_HASH_KEY.
```
]]
native "GET_VEHICLE_NODE_IS_GPS_ALLOWED"
hash "0xA2AE5C478B96E3B6"
jhash (0xEE4B1219)
arguments {
int "nodeID" [=[ {} ]=],
}
alias "0xA2AE5C478B96E3B6"
alias "_GET_SUPPORTS_GPS_ROUTE_FLAG"
ns "PATHFIND"
returns "BOOL"
doc [[!
```
Returns false for nodes that aren't used for GPS routes.
Example:
Nodes in Fort Zancudo and LSIA are false
```
]]
native "GET_VEHICLE_NODE_IS_SWITCHED_OFF"
hash "0x4F5070AA58F69279"
jhash (0x56737A3C)
arguments {
int "nodeID" [=[ {} ]=],
}
alias "0x4F5070AA58F69279"
alias "_GET_IS_SLOW_ROAD_FLAG"
ns "PATHFIND"
returns "BOOL"
doc [[!
```
Returns true when the node is Offroad. Alleys, some dirt roads, and carparks return true.
Normal roads where plenty of Peds spawn will return false
```
]]
native "GET_VEHICLE_NODE_POSITION"
hash "0x703123E5E7D429C2"
jhash (0xE38E252D)
arguments {
int "nodeId" [=[ {} ]=],
Vector3Ptr "outPosition" [=[ {} ]=],
}
ns "PATHFIND"
returns "void"
doc [[!
```
Calling this with an invalid node id, will crash the game.
Note that IS_VEHICLE_NODE_ID_VALID simply checks if nodeId is not zero. It does not actually ensure that the id is valid.
Eg. IS_VEHICLE_NODE_ID_VALID(1) will return true, but will crash when calling GET_VEHICLE_NODE_POSITION().
```
]]
native "GET_VEHICLE_NODE_PROPERTIES"
hash "0x0568566ACBB5DEDC"
jhash (0xCC90110B)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
intPtr "density" [=[ {} ]=],
intPtr "flags" [=[ {} ]=],
}
ns "PATHFIND"
returns "BOOL"
doc [[!
Gets the density and flags of the closest node to the specified position.\
Density is a value between 0 and 15, indicating how busy the road is.
```cpp
enum eVehicleNodeProperties {
OFF_ROAD = 1 << 0,
ON_PLAYERS_ROAD = 1 << 1,
NO_BIG_VEHICLES = 1 << 2,
SWITCHED_OFF = 1 << 3,
TUNNEL_OR_INTERIOR = 1 << 4,
LEADS_TO_DEAD_END = 1 << 5,
HIGHWAY = 1 << 6,
JUNCTION = 1 << 7,
TRAFFIC_LIGHT = 1 << 8,
GIVE_WAY = 1 << 9,
WATER = 1 << 10,
}
```
x position of search
y position of search
z position of search
The traffic density the current node will spawn in a range of 0-15.
The vehicle node flags, see `eVehicleNodeProperties`.
Returns `true` if the node was found, or `false` if the node was not found, or was not streamed in.
]]
native "IS_NAVMESH_LOADED_IN_AREA"
hash "0xF813C7E63F9062A5"
jhash (0x4C2BA99E)
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
}
ns "PATHFIND"
returns "BOOL"
doc [[!
```
Returns whether navmesh for the region is loaded. The region is a rectangular prism defined by it's top left deepest corner to it's bottom right shallowest corner.
If you can re-word this so it makes more sense, please do. I'm horrible with words sometimes...
```
]]
native "IS_POINT_ON_ROAD"
hash "0x125BF4ABFC536B09"
jhash (0xCF198055)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
Vehicle "vehicle" [=[ {} ]=],
}
ns "PATHFIND"
returns "BOOL"
doc [[!
```
Gets a value indicating whether the specified position is on a road.
The vehicle parameter is not implemented (ignored).
```
]]
native "IS_VEHICLE_NODE_ID_VALID"
hash "0x1EAF30FCFBF5AF74"
jhash (0x57DFB1EF)
arguments {
int "vehicleNodeId" [=[ {} ]=],
}
ns "PATHFIND"
returns "BOOL"
doc [[!
```
Returns true if the id is non zero.
```
]]
native "LOAD_ALL_PATH_NODES"
hash "0x80E4A6EDDB0BE8D9"
jhash (0xC66E28C3)
arguments {
BOOL "keepInMemory" [=[ {} ]=],
}
ns "PATHFIND"
returns "BOOL"
doc [[!
```
This native has been removed in v1180.
```
if true, all path nodes will be loaded and be kept in memory; otherwise, all path nodes will be loaded, but unloaded as the game sees fit.
]]
native "REMOVE_NAVMESH_BLOCKING_OBJECT"
hash "0x46399A7895957C0E"
jhash (0x098602B0)
arguments {
Any "p0" [=[ {} ]=],
}
ns "PATHFIND"
returns "void"
doc [[!
]]
native "REMOVE_NAVMESH_REQUIRED_REGIONS"
hash "0x916F0A3CDEC3445E"
jhash (0x637BB680)
ns "PATHFIND"
returns "void"
doc [[!
]]
native "SET_AMBIENT_PED_RANGE_MULTIPLIER_THIS_FRAME"
hash "0x0B919E1FB47CC4E0"
jhash (0x3C5085E4)
arguments {
float "multiplier" [=[ {} ]=],
}
alias "0x0B919E1FB47CC4E0"
ns "PATHFIND"
returns "void"
doc [[!
]]
native "SET_GPS_DISABLED_ZONE"
hash "0xDC20483CD3DD5201"
jhash (0x720B8073)
arguments {
float "x1" [=[ {"cs_type":"Any"} ]=],
float "y1" [=[ {"cs_type":"Any"} ]=],
float "z1" [=[ {"cs_type":"Any"} ]=],
float "x2" [=[ {"cs_type":"Any"} ]=],
float "y2" [=[ {"cs_type":"Any"} ]=],
float "z2" [=[ {"cs_type":"Any"} ]=],
}
ns "PATHFIND"
returns "void"
doc [[!
]]
native "SET_GPS_DISABLED_ZONE_AT_INDEX"
hash "0xD0BC1C6FB18EE154"
jhash (0x98BDB311)
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
int "index" [=[ {} ]=],
}
alias "0xD0BC1C6FB18EE154"
ns "PATHFIND"
returns "void"
doc [[!
Disables the GPS route displayed on the minimap while within a certain zone (area). When in a disabled zone and creating a waypoint, the GPS route is not shown on the minimap until you are outside of the zone. When disabled, the direct distance is shown on minimap opposed to distance to travel. Seems to only work before setting a waypoint.
You can clear the disabled zone with CLEAR_GPS_DISABLED_ZONE_AT_INDEX.
**Setting a waypoint at the same coordinate:**
Disabled Zone:
Enabled Zone (normal):
X coordinate of first vector.
Y coordinate of first vector.
Z coordinate of first vector.
X coordinate of second vector.
Y coordinate of second vector.
Z coordinate of second vector.
Index of zone.
]]
native "SET_IGNORE_NO_GPS_FLAG"
hash "0x72751156E7678833"
jhash (0xB72CF194)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "PATHFIND"
returns "void"
doc [[!
]]
native "SET_PED_PATHS_BACK_TO_ORIGINAL"
hash "0xE04B48F2CC926253"
jhash (0x3F1ABDA4)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
}
ns "PATHFIND"
returns "void"
doc [[!
```
NativeDB Added Parameter 7: Any p6
```
]]
native "SET_PED_PATHS_IN_AREA"
hash "0x34F060F4BF92E018"
jhash (0x2148EA84)
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
BOOL "unknown" [=[ {} ]=],
}
ns "PATHFIND"
returns "void"
doc [[!
```
NativeDB Added Parameter 8: Any p7
```
]]
native "SET_ROADS_BACK_TO_ORIGINAL"
hash "0x1EE7063B80FFC77C"
jhash (0x86AC4A85)
arguments {
float "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
float "p4" [=[ {} ]=],
float "p5" [=[ {} ]=],
}
ns "PATHFIND"
returns "void"
doc [[!
```
missing a last parameter int p6
```
```
NativeDB Added Parameter 7: Any p6
```
]]
native "SET_ROADS_BACK_TO_ORIGINAL_IN_ANGLED_AREA"
hash "0x0027501B9F3B407E"
jhash (0x9DB5D209)
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
float "width" [=[ {} ]=],
}
ns "PATHFIND"
returns "void"
doc [[!
See [`IS_POINT_IN_ANGLED_AREA`](#\_0x2A70BAE8883E4C81) for the definition of an angled area.
```
NativeDB Added Parameter 8: Any p7
bool p7 - always 1
```
X dimension of the angled area 'origin'
Y dimension of the angled area 'origin'
Z dimension of the angled area 'origin'
X dimension of the angled area 'extent'
Y dimension of the angled area 'extent'
Z dimension of the angled area 'extent'
Width of the angled area
]]
native "SET_ROADS_IN_ANGLED_AREA"
hash "0x1A5AA1208AF5DB59"
jhash (0xBD088F4B)
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
float "width" [=[ {} ]=],
BOOL "unknown1" [=[ {} ]=],
BOOL "unknown2" [=[ {} ]=],
BOOL "unknown3" [=[ {} ]=],
}
ns "PATHFIND"
returns "void"
doc [[!
unknown3 is related to `SEND_SCRIPT_WORLD_STATE_EVENT > CNetworkRoadNodeWorldStateData` in networked environments.
See [`IS_POINT_IN_ANGLED_AREA`](#\_0x2A70BAE8883E4C81) for the definition of an angled area.
X dimension of the angled area 'origin'
Y dimension of the angled area 'origin'
Z dimension of the angled area 'origin'
X dimension of the angled area 'extent'
Y dimension of the angled area 'extent'
Z dimension of the angled area 'extent'
Width of the angled area
]]
native "SET_ROADS_IN_AREA"
hash "0xBF1A602B5BA52FEE"
jhash (0xEBC7B918)
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
BOOL "nodeEnabled" [=[ {} ]=],
BOOL "unknown2" [=[ {} ]=],
}
ns "PATHFIND"
returns "void"
doc [[!
When this is set to false, all nodes in the area get disabled.
`GET_VEHICLE_NODE_IS_SWITCHED_OFF` returns true afterwards.
If it's true,
`GET_VEHICLE_NODE_IS_SWITCHED_OFF` returns false.
]]
native "UPDATE_NAVMESH_BLOCKING_OBJECT"
hash "0x109E99373F290687"
jhash (0x4E9776D0)
arguments {
Object "object" [=[ {} ]=],
float "posX" [=[ {} ]=],
float "posY" [=[ {} ]=],
float "posZ" [=[ {} ]=],
float "scaleX" [=[ {} ]=],
float "scaleY" [=[ {} ]=],
float "scaleZ" [=[ {} ]=],
float "heading" [=[ {} ]=],
int "flags" [=[ {} ]=],
}
ns "PATHFIND"
returns "void"
doc [[!
Navmesh Blocking Object by ID. must be returned by [`ADD_NAVMESH_BLOCKING_OBJECT`](#\_0xFCD5C8E06E502F5A).
X position coordinate.
Y position coordinate.
Z position coordinate.
X Scale.
Y Scale.
Z Scale.
Heading of the blocking object.
Flags for the blocking object, see [`ADD_NAVMESH_BLOCKING_OBJECT`](#\_0xFCD5C8E06E502F5A) for list of blocking object flags.
]]
native "_GET_HEIGHTMAP_BOTTOM_Z_FOR_AREA"
hash "0x3599D741C9AC6310"
jhash (0x76751DD4)
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
}
alias "0x3599D741C9AC6310"
ns "PATHFIND"
returns "float"
doc [[!
```
Returns CGameWorldHeightMap's minimum Z among all grid nodes that intersect with the specified rectangle.
```
]]
native "_GET_HEIGHTMAP_BOTTOM_Z_FOR_POSITION"
hash "0x336511A34F2E5185"
jhash (0xA07C5B7D)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
}
alias "0x336511A34F2E5185"
ns "PATHFIND"
returns "float"
doc [[!
```
Returns CGameWorldHeightMap's minimum Z value at specified point (grid node).
```
]]
native "_GET_HEIGHTMAP_TOP_Z_FOR_AREA"
hash "0x8ABE8608576D9CE3"
jhash (0x3ED21C90)
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
}
alias "0x8ABE8608576D9CE3"
ns "PATHFIND"
returns "float"
doc [[!
```
Returns CGameWorldHeightMap's maximum Z among all grid nodes that intersect with the specified rectangle.
```
]]
native "_GET_HEIGHTMAP_TOP_Z_FOR_POSITION"
hash "0x29C24BFBED8AB8FB"
jhash (0x3FE8C5A0)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
}
alias "0x29C24BFBED8AB8FB"
ns "PATHFIND"
returns "float"
doc [[!
```
Returns CGameWorldHeightMap's maximum Z value at specified point (grid node).
```
]]
native "_GET_POINT_ON_ROAD_SIDE"
hash "0x16F46FB18C8009E4"
jhash (0xF6422F9A)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
int "p3" [=[ {} ]=],
Vector3Ptr "outPosition" [=[ {} ]=],
}
alias "0x16F46FB18C8009E4"
ns "PATHFIND"
returns "BOOL"
doc [[!
]]
native "_IS_NAVMESH_REQUIRED_REGION_OWNED_BY_ANY_THREAD"
hash "0x705A844002B39DC0"
alias "0x705A844002B39DC0"
ns "PATHFIND"
returns "BOOL"
doc [[!
```
IS_*
```
]]
native "_REQUEST_PATHS_PREFER_ACCURATE_BOUNDINGSTRUCT"
hash "0x07FB139B592FA687"
jhash (0x2CDA5012)
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
}
alias "0x07FB139B592FA687"
ns "PATHFIND"
returns "BOOL"
doc [[!
```
Used internally for long range tasks
```
]]
native "_SET_AI_GLOBAL_PATH_NODES_TYPE"
hash "0xF74B1FFA4A15FBEA"
arguments {
int "type" [=[ {} ]=],
}
ns "PATHFIND"
returns "void"
doc [[!
Activates Cayo Perico path nodes if passed `1`. GPS navigation will start working, maybe more stuff will change, not sure. It seems if you try to unload (pass `0`) when close to the island, your game might crash.
```
NativeDB Introduced: v2189
```
]]
native "_SET_ALL_PATHS_CACHE_BOUNDINGSTRUCT"
hash "0x228E5C6AD4D74BFD"
jhash (0xD6A3B458)
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0x228E5C6AD4D74BFD"
ns "PATHFIND"
returns "void"
doc [[!
```
Toggles a global boolean, name is probably a hash collision but describes its functionality.
```
]]
native "_SET_IGNORE_SECONDARY_ROUTE_NODES"
hash "0x1FC289A0C3FF470F"
jhash (0x90DF7A4C)
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0x1FC289A0C3FF470F"
ns "PATHFIND"
returns "void"
doc [[!
```
See: SET_BLIP_ROUTE
```
]]
native "0xAA76052DDA9BFC3E"
hash "0xAA76052DDA9BFC3E"
jhash (0xD0F51299)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
Any "p6" [=[ {} ]=],
}
ns "PATHFIND"
returns "void"
doc [[!
]]
native "ACTIVATE_PHYSICS"
hash "0x710311ADF0E20730"
jhash (0x031711B8)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "PHYSICS"
returns "void"
doc [[!
]]
native "ADD_ROPE"
hash "0xE832D760399EB220"
jhash (0xA592EC74)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "rotX" [=[ {} ]=],
float "rotY" [=[ {} ]=],
float "rotZ" [=[ {} ]=],
float "maxLength" [=[ {} ]=],
int "ropeType" [=[ {} ]=],
float "initLength" [=[ {} ]=],
float "minLength" [=[ {} ]=],
float "lengthChangeRate" [=[ {} ]=],
BOOL "onlyPPU" [=[ {} ]=],
BOOL "collisionOn" [=[ {} ]=],
BOOL "lockFromFront" [=[ {} ]=],
float "timeMultiplier" [=[ {} ]=],
BOOL "breakable" [=[ {} ]=],
AnyPtr "unkPtr" [=[ {} ]=],
}
ns "PHYSICS"
returns "int"
doc [[!
```
Creates a rope at the specific position, that extends in the specified direction when not attached to any entities.
__
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.
```
There are 8 different rope types in the base game. Full rope data can be found in `ropedata.xml`.
```cpp
enum ePhysicsRopeType {
RopeThin = 0, // Verticies: 1, Radius: 0.03, Textures: rope & rope_n
RopeWire6 = 1, // Verticies: 4, Radius: 0.015, Textures: steel_cable & steel_cable_n
RopeWire32 = 2, // Verticies: 32, Radius: 0.025, Textures: steel_cable & steel_cable_n
RopeMesh = 3, // Verticies: 6, Radius: 0.03, Textures: rope & rope_n
RopeThinWire32 = 4, // Verticies: 32, Radius: 0.01, Textures: rope & rope_n
RopeReins = 5, // Verticies: 32, Radius: 0.005, Textures: rope & rope_n
RopeThin4 = 6, // Verticies: 4, Radius: 0.03, Textures: rope & rope_n
RopeWire64 = 7 // Verticies: 64, Radius: 0.025, Textures: steel_cable & steel_cable_n
}
```
Spawn coordinate X component.
Spawn coordinate Y component.
Spawn coordinate Z component.
Rotation X component.
Rotation Y component.
Rotation Z component.
The maximum length the rope can droop.
The zero-based index of the entry in the `ropedata.xml` file. *NOTE: Using an index which does not exist will crash the game. As of game build 3258, valid values are from `0` to `7` inclusive.*
The initial length of the rope.
The minimum length the rope can be.
The speed in which the rope will wind if winding is started.
Whether the rope should have collision. In original scripts this is followed by a LoadRopeData call when set.
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).
The speed as which physics should run at. 1.0f is normal, 2.0f is twice as fast, -1.0f is time going backwards. This can affect gravity, etc.
Whether shooting the rope will break it.
Unknown pointer, always 0 in original scrips.
A script handle for the rope
]]
native "APPLY_IMPULSE_TO_CLOTH"
hash "0xE37F721824571784"
jhash (0xA2A5C9FE)
arguments {
float "posX" [=[ {} ]=],
float "posY" [=[ {} ]=],
float "posZ" [=[ {} ]=],
float "vecX" [=[ {} ]=],
float "vecY" [=[ {} ]=],
float "vecZ" [=[ {} ]=],
float "impulse" [=[ {} ]=],
}
ns "PHYSICS"
returns "void"
doc [[!
]]
native "ATTACH_ENTITIES_TO_ROPE"
hash "0x3D95EC8B6D940AC3"
jhash (0x7508668F)
arguments {
int "ropeId" [=[ {} ]=],
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" [=[ {} ]=],
charPtr "boneName1" [=[ {} ]=],
charPtr "boneName2" [=[ {} ]=],
}
ns "PHYSICS"
returns "void"
doc [[!
```
Attaches entity 1 to entity 2.
```
]]
native "ATTACH_ROPE_TO_ENTITY"
hash "0x4B490A6832559A65"
jhash (0xB25D9536)
arguments {
int "ropeId" [=[ {} ]=],
Entity "entity" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
BOOL "p5" [=[ {} ]=],
}
ns "PHYSICS"
returns "void"
doc [[!
```
The position supplied can be anywhere, and the entity should anchor relative to that point from it's origin.
```
]]
native "BREAK_ENTITY_GLASS"
hash "0x2E648D16F6E308F3"
jhash (0xD0E0402F)
arguments {
Entity "entity" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
float "p4" [=[ {} ]=],
float "p5" [=[ {} ]=],
float "p6" [=[ {} ]=],
float "p7" [=[ {} ]=],
float "p8" [=[ {} ]=],
Any "p9" [=[ {} ]=],
BOOL "p10" [=[ {} ]=],
}
ns "PHYSICS"
returns "void"
doc [[!
]]
native "DELETE_CHILD_ROPE"
hash "0xAA5D6B1888E4DB20"
jhash (0xB19B4706)
arguments {
int "ropeId" [=[ {} ]=],
}
ns "PHYSICS"
annotations [=[ {"cs_type":"Any"} ]=]
returns "void"
doc [[!
]]
native "DELETE_ROPE"
hash "0x52B4829281364649"
jhash (0x748D72AF)
arguments {
intPtr "ropeId" [=[ {} ]=],
}
ns "PHYSICS"
returns "void"
doc [[!
Deletes the rope with the specified handle.
You should check if the rope exists before trying to delete it, see [DOES_ROPE_EXIST](#\_0xFD5448BE3111ED96).
For an example on how to use this native please refer to [ADD_ROPE](#\_0xE832D760399EB220)
The handle of the rope to delete
]]
native "DETACH_ROPE_FROM_ENTITY"
hash "0xBCF3026912A8647D"
jhash (0x3E720BEE)
arguments {
int "ropeId" [=[ {} ]=],
Entity "entity" [=[ {} ]=],
}
ns "PHYSICS"
returns "void"
doc [[!
]]
native "DOES_ROPE_EXIST"
hash "0xFD5448BE3111ED96"
jhash (0x66E4A3AC)
arguments {
intPtr "ropeId" [=[ {} ]=],
}
ns "PHYSICS"
returns "BOOL"
doc [[!
For an example on how to use this native please refer to [ADD_ROPE](#\_0xE832D760399EB220)
The handle of the rope to check
Returns `true` if the rope exists, `false` otherwise.
]]
native "GET_CGOFFSET"
hash "0x8214A4B5A7A33612"
jhash (0x49A11F0D)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "PHYSICS"
returns "Vector3"
doc [[!
]]
native "GET_DAMPING"
hash "0x8C520A929415BCD2"
arguments {
Entity "entity" [=[ {} ]=],
int "type" [=[ {} ]=],
}
ns "PHYSICS"
returns "Vector3"
doc [[!
```
NativeDB Introduced: v3407
```
]]
native "GET_ROPE_LAST_VERTEX_COORD"
hash "0x21BB0FBD3E217C2D"
jhash (0x91F6848B)
arguments {
int "ropeId" [=[ {} ]=],
}
ns "PHYSICS"
annotations [=[ {"cs_type":"Any"} ]=]
returns "Vector3"
doc [[!
]]
native "GET_ROPE_VERTEX_COORD"
hash "0xEA61CA8E80F09E4D"
jhash (0x84374452)
arguments {
int "ropeId" [=[ {} ]=],
int "vertex" [=[ {} ]=],
}
ns "PHYSICS"
returns "Vector3"
doc [[!
]]
native "GET_ROPE_VERTEX_COUNT"
hash "0x3655F544CD30F0B5"
jhash (0x5131CD2C)
arguments {
int "ropeId" [=[ {} ]=],
}
ns "PHYSICS"
returns "int"
doc [[!
]]
native "LOAD_ROPE_DATA"
hash "0xCBB203C04D1ABD27"
jhash (0x9E8F1644)
arguments {
int "ropeId" [=[ {} ]=],
charPtr "rope_preset" [=[ {} ]=],
}
ns "PHYSICS"
annotations [=[ {"cs_type":"Any"} ]=]
returns "void"
doc [[!
```
Rope presets can be found in the gamefiles. One example is "ropeFamily3", it is NOT a hash but rather a string.
```
]]
native "PIN_ROPE_VERTEX"
hash "0x2B320CF14146B69A"
jhash (0xAE1D101B)
arguments {
int "ropeId" [=[ {} ]=],
int "vertex" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
ns "PHYSICS"
returns "void"
doc [[!
]]
native "ROPE_ARE_TEXTURES_LOADED"
hash "0xF2D0E6A75CC05597"
jhash (0x5FDC1047)
ns "PHYSICS"
returns "BOOL"
doc [[!
]]
native "ROPE_CONVERT_TO_SIMPLE"
hash "0x5389D48EFA2F079A"
jhash (0x43E92628)
arguments {
int "ropeId" [=[ {} ]=],
}
ns "PHYSICS"
returns "void"
doc [[!
]]
native "ROPE_DRAW_SHADOW_ENABLED"
hash "0xF159A63806BB5BA8"
jhash (0x51523B8C)
arguments {
intPtr "ropeId" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PHYSICS"
returns "void"
doc [[!
]]
native "ROPE_FORCE_LENGTH"
hash "0xD009F759A723DB1B"
jhash (0xABF3130F)
arguments {
int "ropeId" [=[ {} ]=],
float "length" [=[ {} ]=],
}
ns "PHYSICS"
annotations [=[ {"cs_type":"Any"} ]=]
returns "void"
doc [[!
```
Forces a rope to a certain length.
```
]]
native "ROPE_GET_DISTANCE_BETWEEN_ENDS"
hash "0x73040398DFF9A4A6"
jhash (0xFD309DC8)
arguments {
int "ropeId" [=[ {} ]=],
}
alias "_GET_ROPE_LENGTH"
ns "PHYSICS"
returns "float"
doc [[!
]]
native "ROPE_LOAD_TEXTURES"
hash "0x9B9039DBF2D258C1"
jhash (0xBA97CE91)
ns "PHYSICS"
annotations [=[ {"cs_type":"Any"} ]=]
returns "void"
doc [[!
```
Loads rope textures for all ropes in the current scene.
```
]]
native "ROPE_RESET_LENGTH"
hash "0xC16DE94D9BEA14A0"
jhash (0xC8A423A3)
arguments {
int "ropeId" [=[ {} ]=],
float "length" [=[ {} ]=],
}
ns "PHYSICS"
returns "void"
doc [[!
```
Reset a rope to a certain length.
```
]]
native "ROPE_SET_UPDATE_ORDER"
hash "0xDC57A637A20006ED"
jhash (0x80DB77A7)
arguments {
int "ropeId" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
alias "0xDC57A637A20006ED"
ns "PHYSICS"
returns "void"
doc [[!
]]
native "ROPE_SET_UPDATE_PINVERTS"
hash "0xC8D667EE52114ABA"
jhash (0xEAF291A0)
arguments {
int "ropeId" [=[ {} ]=],
}
ns "PHYSICS"
returns "void"
doc [[!
]]
native "ROPE_UNLOAD_TEXTURES"
hash "0x6CE36C35C1AC8163"
jhash (0x584463E0)
ns "PHYSICS"
annotations [=[ {"cs_type":"Any"} ]=]
returns "void"
doc [[!
```
Unloads rope textures for all ropes in the current scene.
```
]]
native "SET_CG_AT_BOUNDCENTER"
hash "0xBE520D9761FF811F"
jhash (0xA5B55421)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "PHYSICS"
returns "void"
doc [[!
]]
native "SET_CGOFFSET"
hash "0xD8FA3908D7B86904"
jhash (0x59910AB2)
arguments {
Entity "entity" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
ns "PHYSICS"
returns "void"
doc [[!
]]
native "SET_DAMPING"
hash "0xEEA3B200A6FEB65B"
jhash (0xCFB37773)
arguments {
Entity "entity" [=[ {} ]=],
int "vertex" [=[ {} ]=],
float "value" [=[ {} ]=],
}
ns "PHYSICS"
returns "void"
doc [[!
]]
native "SET_DISABLE_BREAKING"
hash "0x5CEC1A84620E7D5B"
jhash (0xEE77C326)
arguments {
Object "object" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PHYSICS"
annotations [=[ {"cs_type":"Any"} ]=]
returns "void"
doc [[!
]]
native "SET_DISABLE_FRAG_DAMAGE"
hash "0x01BA3AED21C16CFB"
jhash (0x97269DC8)
arguments {
Object "object" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PHYSICS"
returns "void"
doc [[!
]]
native "START_ROPE_UNWINDING_FRONT"
hash "0x538D1179EC1AA9A9"
jhash (0xFC0DB4C3)
arguments {
int "ropeId" [=[ {} ]=],
}
ns "PHYSICS"
returns "void"
doc [[!
]]
native "START_ROPE_WINDING"
hash "0x1461C72C889E343E"
jhash (0x5187BED3)
arguments {
int "ropeId" [=[ {} ]=],
}
ns "PHYSICS"
returns "void"
doc [[!
]]
native "STOP_ROPE_UNWINDING_FRONT"
hash "0xFFF3A50779EFBBB3"
jhash (0x2EEDB18F)
arguments {
int "ropeId" [=[ {} ]=],
}
ns "PHYSICS"
returns "void"
doc [[!
]]
native "STOP_ROPE_WINDING"
hash "0xCB2D4AB84A19AA7C"
jhash (0x46826B53)
arguments {
int "ropeId" [=[ {} ]=],
}
ns "PHYSICS"
returns "void"
doc [[!
]]
native "UNPIN_ROPE_VERTEX"
hash "0x4B5AE2EEE4A8F180"
jhash (0xB30B552F)
arguments {
int "ropeId" [=[ {} ]=],
int "vertex" [=[ {} ]=],
}
ns "PHYSICS"
annotations [=[ {"cs_type":"Any"} ]=]
returns "void"
doc [[!
]]
native "_DOES_ROPE_BELONG_TO_THIS_SCRIPT"
hash "0x271C9D3ACA5D6409"
arguments {
int "ropeId" [=[ {} ]=],
}
alias "0x271C9D3ACA5D6409"
ns "PHYSICS"
returns "BOOL"
doc [[!
Return if the rope was generated or not by the script where the native is called.
]]
native "_GET_HAS_OBJECT_FRAG_INST"
hash "0x0C112765300C7E1E"
arguments {
Object "object" [=[ {} ]=],
}
alias "0x0C112765300C7E1E"
alias "_DOES_ENTITY_HAVE_FRAG_INST"
ns "PHYSICS"
returns "BOOL"
doc [[!
```
GET_*
```
]]
native "_SET_ENTITY_PROOF_UNK"
hash "0x15F944730C832252"
arguments {
Entity "entity" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x15F944730C832252"
ns "PHYSICS"
returns "void"
doc [[!
]]
native "_SET_LAUNCH_CONTROL_ENABLED"
hash "0xAA6A6098851C396F"
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0xAA6A6098851C396F"
ns "PHYSICS"
returns "void"
doc [[!
Related to the lower-end of a vehicles fTractionCurve, e.g., from standing starts and acceleration from low/zero speeds.
```
NativeDB Introduced: v1604
```
]]
native "0x36CCB9BE67B970FD"
hash "0x36CCB9BE67B970FD"
jhash (0xC67D5CF6)
arguments {
int "ropeId" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "PHYSICS"
returns "void"
doc [[!
```
ROPE_*
```
]]
native "0x84DE3B5FB3E666F0"
hash "0x84DE3B5FB3E666F0"
jhash (0x7A18BB9C)
arguments {
intPtr "ropeId" [=[ {"cs_type":"AnyPtr"} ]=],
}
ns "PHYSICS"
returns "BOOL"
doc [[!
]]
native "0x9EBD751E5787BAF2"
hash "0x9EBD751E5787BAF2"
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "PHYSICS"
returns "void"
doc [[!
```
SET_*
```
]]
native "0xA1AE736541B0FCA3"
hash "0xA1AE736541B0FCA3"
arguments {
intPtr "ropeId" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "PHYSICS"
returns "void"
doc [[!
ROPE_\*
```
NativeDB Introduced: v1868
```
]]
native "0xB1B6216CA2E7B55E"
hash "0xB1B6216CA2E7B55E"
jhash (0x7C6F7668)
arguments {
Any "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "PHYSICS"
returns "void"
doc [[!
]]
native "0xB743F735C03D7810"
hash "0xB743F735C03D7810"
jhash (0x686672DD)
arguments {
int "ropeId" [=[ {} ]=],
int "p1" [=[ {} ]=],
}
ns "PHYSICS"
returns "void"
doc [[!
```
ROPE_*
```
]]
native "0xBC0CE682D4D05650"
hash "0xBC0CE682D4D05650"
jhash (0x106BA127)
arguments {
int "ropeId" [=[ {} ]=],
int "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
float "p4" [=[ {} ]=],
float "p5" [=[ {} ]=],
float "p6" [=[ {} ]=],
float "p7" [=[ {} ]=],
float "p8" [=[ {} ]=],
float "p9" [=[ {} ]=],
float "p10" [=[ {} ]=],
float "p11" [=[ {} ]=],
float "p12" [=[ {} ]=],
float "p13" [=[ {} ]=],
}
ns "PHYSICS"
returns "void"
doc [[!
```
Most likely ROPE_ATTACH_*
```
]]
native "0xCC6E963682533882"
hash "0xCC6E963682533882"
arguments {
Object "object" [=[ {} ]=],
}
ns "PHYSICS"
returns "void"
doc [[!
```
RESET_*
```
]]
native "ARE_PLAYER_FLASHING_STARS_ABOUT_TO_DROP"
hash "0xAFAF86043E5874E9"
jhash (0xE13A71C7)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "BOOL"
doc [[!
]]
native "ARE_PLAYER_STARS_GREYED_OUT"
hash "0x0A6EB355EE14A2DB"
jhash (0x5E72AB72)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "BOOL"
doc [[!
]]
native "ASSISTED_MOVEMENT_CLOSE_ROUTE"
hash "0xAEBF081FFC0A0E5E"
jhash (0xF23277F3)
ns "PLAYER"
returns "void"
doc [[!
]]
native "ASSISTED_MOVEMENT_FLUSH_ROUTE"
hash "0x8621390F0CDCFE1F"
jhash (0xD04568B9)
ns "PLAYER"
returns "void"
doc [[!
]]
native "CAN_PED_HEAR_PLAYER"
hash "0xF297383AA91DCA29"
jhash (0x1C70B2EB)
arguments {
Player "player" [=[ {} ]=],
Ped "ped" [=[ {} ]=],
}
ns "PLAYER"
returns "BOOL"
doc [[!
]]
native "CAN_PLAYER_START_MISSION"
hash "0xDE7465A27D403C06"
jhash (0x39E3CB3F)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "BOOL"
doc [[!
]]
native "CHANGE_PLAYER_PED"
hash "0x048189FAC643DEEE"
jhash (0xBE515485)
arguments {
Player "player" [=[ {} ]=],
Ped "ped" [=[ {} ]=],
BOOL "b2" [=[ {} ]=],
BOOL "resetDamage" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
]]
native "CLEAR_PLAYER_HAS_DAMAGED_AT_LEAST_ONE_NON_ANIMAL_PED"
hash "0x4AACB96203D11A31"
jhash (0x7E3BFBC5)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
]]
native "CLEAR_PLAYER_HAS_DAMAGED_AT_LEAST_ONE_PED"
hash "0xF0B67A4DE6AB5F98"
jhash (0x1D31CBBD)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
]]
native "CLEAR_PLAYER_PARACHUTE_MODEL_OVERRIDE"
hash "0x8753997EB5F6EE3F"
jhash (0x6FF034BB)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
]]
native "CLEAR_PLAYER_PARACHUTE_PACK_MODEL_OVERRIDE"
hash "0x10C54E4389C12B42"
jhash (0xBB62AAC5)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
]]
native "CLEAR_PLAYER_PARACHUTE_VARIATION_OVERRIDE"
hash "0x0F4CC924CF8C7B21"
jhash (0xFD60F5AB)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
]]
native "CLEAR_PLAYER_WANTED_LEVEL"
hash "0xB302540597885499"
jhash (0x54EA5BCC)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
This executes at the same as speed as PLAYER::SET_PLAYER_WANTED_LEVEL(player, 0, false);
PLAYER::GET_PLAYER_WANTED_LEVEL(player); executes in less than half the time. Which means that it's worth first checking if the wanted level needs to be cleared before clearing. However, this is mostly about good code practice and can important in other situations. The difference in time in this example is negligible.
```
]]
native "DISABLE_PLAYER_FIRING"
hash "0x5E6CC07646BBEAB8"
jhash (0x30CB28CB)
arguments {
Player "player" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
Inhibits the player from using any method of combat including melee and firearms.\
NOTE: Only disables the firing for one frame
The player for which to disable combat methods.
Unused, as this native will disable combat regardless of the value of this parameter.
]]
native "DISABLE_PLAYER_VEHICLE_REWARDS"
hash "0xC142BE3BB9CE125F"
jhash (0x8C6E611D)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
Disables vehicle rewards for the current frame.
The player to disable rewards
]]
native "DISPLAY_SYSTEM_SIGNIN_UI"
hash "0x94DD7888C10A979E"
jhash (0x4264CED2)
arguments {
BOOL "unk" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
Purpose of the BOOL currently unknown.
Both, true and false, work
```
]]
native "ENABLE_SPECIAL_ABILITY"
hash "0x181EC197DAEFE121"
jhash (0xC86C1B4E)
arguments {
Player "player" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
NativeDB Added Parameter 3: Any p2
```
]]
native "EXTEND_WORLD_BOUNDARY_FOR_PLAYER"
hash "0x5006D96C995A5827"
jhash (0x64DDB07D)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
alias "0x5006D96C995A5827"
alias "_EXPAND_WORLD_LIMITS"
ns "PLAYER"
returns "void"
doc [[!
```
Appears only 3 times in the scripts, more specifically in michael1.ysc
-
This can be used to prevent dying if you are "out of the world"
```
]]
native "FORCE_CLEANUP"
hash "0xBC8983F38F78ED51"
jhash (0xFDAAEA2B)
arguments {
int "cleanupFlags" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
used with 1,2,8,64,128 in the scripts
```
]]
native "FORCE_CLEANUP_FOR_ALL_THREADS_WITH_THIS_NAME"
hash "0x4C68DDDDF0097317"
jhash (0x04256C73)
arguments {
charPtr "name" [=[ {} ]=],
int "cleanupFlags" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
PLAYER::FORCE_CLEANUP_FOR_ALL_THREADS_WITH_THIS_NAME("pb_prostitute", 1); // Found in decompilation
```
]]
native "FORCE_CLEANUP_FOR_THREAD_WITH_THIS_ID"
hash "0xF745B37630DF176B"
jhash (0x882D3EB3)
arguments {
int "id" [=[ {} ]=],
int "cleanupFlags" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
]]
native "GET_ARE_CAMERA_CONTROLS_DISABLED"
hash "0x7C814D2FB49F40C0"
jhash (0x4C456AF2)
alias "_IS_PLAYER_CAM_CONTROL_DISABLED"
alias "0x7C814D2FB49F40C0"
ns "PLAYER"
returns "BOOL"
doc [[!
Returns `true` if the main player's camera controls are disabled. Also returns `true` if the there is no main player info.
]]
native "GET_CAUSE_OF_MOST_RECENT_FORCE_CLEANUP"
hash "0x9A41CF4674A12272"
jhash (0x39AA9FC8)
ns "PLAYER"
returns "int"
doc [[!
]]
native "GET_ENTITY_PLAYER_IS_FREE_AIMING_AT"
hash "0x2975C866E6713290"
jhash (0x8866D9D0)
arguments {
Player "player" [=[ {} ]=],
EntityPtr "entity" [=[ {} ]=],
}
ns "PLAYER"
returns "BOOL"
doc [[!
```
Returns TRUE if it found an entity in your crosshair within range of your weapon. Assigns the handle of the target to the *entity that you pass it.
Returns false if no entity found.
```
]]
native "GET_IS_PLAYER_DRIVING_ON_HIGHWAY"
hash "0x5FC472C501CCADB3"
jhash (0x46E7E31D)
arguments {
Player "playerId" [=[ {} ]=],
}
alias "0x5FC472C501CCADB3"
ns "PLAYER"
returns "BOOL"
doc [[!
The local index of the player to check (see [PLAYER_ID](#\_0x4F8644AF03D0E0D6))
Returns a boolean value representing if the player is driving on a highway.
]]
native "GET_MAX_WANTED_LEVEL"
hash "0x462E0DB9B137DC5F"
jhash (0x457F1E44)
ns "PLAYER"
returns "int"
doc [[!
```
Gets the maximum wanted level the player can get.
Ranges from 0 to 5.
```
]]
native "GET_NUMBER_OF_PLAYERS"
hash "0x407C7F91DDB46C16"
jhash (0x4C1B8867)
ns "PLAYER"
returns "int"
doc [[!
```
Gets the number of players in the current session.
If not multiplayer, always returns 1.
```
]]
native "GET_PLAYER_CURRENT_STEALTH_NOISE"
hash "0x2F395D61F3A1F877"
jhash (0xC3B02362)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "float"
doc [[!
]]
native "GET_PLAYER_FAKE_WANTED_LEVEL"
hash "0x56105E599CAB0EFA"
jhash (0x0098D244)
arguments {
Player "player" [=[ {} ]=],
}
alias "0x56105E599CAB0EFA"
ns "PLAYER"
returns "int"
doc [[!
]]
native "GET_PLAYER_GROUP"
hash "0x0D127585F77030AF"
jhash (0xA5EDCDE8)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "int"
doc [[!
```
Returns the group ID the player is member of.
```
]]
native "GET_PLAYER_HAS_RESERVE_PARACHUTE"
hash "0x5DDFE2FF727F3CA3"
jhash (0x30DA1DA1)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "BOOL"
doc [[!
]]
native "GET_PLAYER_INDEX"
hash "0xA5EDC40EF369B48D"
jhash (0x309BBDC1)
ns "PLAYER"
returns "Player"
doc [[!
```
Returns the same as PLAYER_ID and NETWORK_PLAYER_ID_TO_INT
```
]]
native "GET_PLAYER_INVINCIBLE"
hash "0xB721981B2B939E07"
jhash (0x680C90EE)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "BOOL"
doc [[!
This native will only return true if a player was made invincible with [`SET_PLAYER_INVINCIBLE`](#\_0x239528EACDC3E7DE).
You should use [`GET_PLAYER_INVINCIBLE_2`](#\_0xF2E3912B) to get both [`SET_PLAYER_INVINCIBLE`](#\_0x239528EACDC3E7DE) and [`SET_PLAYER_INVINCIBLE_KEEP_RAGDOLL_ENABLED`](#\_0x6BC97F4F4BB3C04B) invincibility state.
The player index
A boolean to tell if the player is invincible.
]]
native "GET_PLAYER_MAX_ARMOUR"
hash "0x92659B4CE1863CB3"
jhash (0x02A50657)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "int"
doc [[!
]]
native "GET_PLAYER_NAME"
hash "0x6D0DE6A7B5DA71F8"
jhash (0x406B4B20)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "charPtr"
doc [[!
Returns the players name from a specified player index
The player index, or -1 to get the local player ped.
The name of the queried player. "**Invalid**" if the player does not exist.
]]
native "GET_PLAYER_PARACHUTE_PACK_TINT_INDEX"
hash "0x6E9C742F340CE5A2"
jhash (0x4E418E13)
arguments {
Player "player" [=[ {} ]=],
intPtr "tintIndex" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
]]
native "GET_PLAYER_PARACHUTE_SMOKE_TRAIL_COLOR"
hash "0xEF56DBABD3CD4887"
jhash (0xF66E5CDD)
arguments {
Player "player" [=[ {} ]=],
intPtr "r" [=[ {} ]=],
intPtr "g" [=[ {} ]=],
intPtr "b" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
]]
native "GET_PLAYER_PARACHUTE_TINT_INDEX"
hash "0x75D3F7A1B0D9B145"
jhash (0x432B0509)
arguments {
Player "player" [=[ {} ]=],
intPtr "tintIndex" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
Tints:
None = -1,
Rainbow = 0,
Red = 1,
SeasideStripes = 2,
WidowMaker = 3,
Patriot = 4,
Blue = 5,
Black = 6,
Hornet = 7,
AirFocce = 8,
Desert = 9,
Shadow = 10,
HighAltitude = 11,
Airbone = 12,
Sunrise = 13,
```
]]
native "GET_PLAYER_PED"
hash "0x43A66C31C68491C0"
jhash (0x6E31E993)
arguments {
Player "playerId" [=[ {} ]=],
}
ns "PLAYER"
returns "Ped"
doc [[!
Gets the ped for a specified player index.
Note: For performance reasons, usage of [`PLAYER_PED_ID`](#\_0xD80958FC74E988A6) is recommended over the use of `GetPlayerPed(-1)` when wanting to acquire your local player ped. For more information, please refer to [this](https://forum.cfx.re/t/question-difference-between-getplayerped-1-and-playerpedid/539437/2) forum post.
The player index, or -1 to get the local player ped.
The specified player's ped, or 0 if invalid.
]]
native "GET_PLAYER_PED_SCRIPT_INDEX"
hash "0x50FAC3A3E030A6E1"
jhash (0x6AC64990)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "Ped"
doc [[!
```
Does the same like PLAYER::GET_PLAYER_PED
```
]]
native "GET_PLAYER_RESERVE_PARACHUTE_TINT_INDEX"
hash "0xD5A016BC3C09CF40"
jhash (0x77B8EF01)
arguments {
Player "player" [=[ {} ]=],
intPtr "index" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
Tints:
None = -1,
Rainbow = 0,
Red = 1,
SeasideStripes = 2,
WidowMaker = 3,
Patriot = 4,
Blue = 5,
Black = 6,
Hornet = 7,
AirFocce = 8,
Desert = 9,
Shadow = 10,
HighAltitude = 11,
Airbone = 12,
Sunrise = 13,
```
]]
native "GET_PLAYER_RGB_COLOUR"
hash "0xE902EF951DCE178F"
jhash (0x6EF43BBB)
arguments {
Player "player" [=[ {} ]=],
intPtr "r" [=[ {} ]=],
intPtr "g" [=[ {} ]=],
intPtr "b" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
]]
native "GET_PLAYER_SPRINT_STAMINA_REMAINING"
hash "0x3F9F16F8E65A7ED7"
jhash (0x47017C90)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "float"
doc [[!
]]
native "GET_PLAYER_SPRINT_TIME_REMAINING"
hash "0x1885BC9B108B4C99"
jhash (0x40E80543)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "float"
doc [[!
]]
native "GET_PLAYER_TARGET_ENTITY"
hash "0x13EDE1A5DBF797C9"
jhash (0xF6AAA2D7)
arguments {
Player "player" [=[ {} ]=],
EntityPtr "entity" [=[ {} ]=],
}
ns "PLAYER"
returns "BOOL"
doc [[!
```
Assigns the handle of locked-on melee target to *entity that you pass it.
Returns false if no entity found.
```
]]
native "GET_PLAYER_TEAM"
hash "0x37039302F4E0A008"
jhash (0x9873E404)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "int"
doc [[!
```
Gets the player's team.
Does nothing in singleplayer.
```
]]
native "GET_PLAYER_UNDERWATER_TIME_REMAINING"
hash "0xA1FCF8E6AF40B731"
jhash (0x1317125A)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "float"
doc [[!
]]
native "GET_PLAYER_WANTED_CENTRE_POSITION"
hash "0x0C92BA89F1AF26F8"
jhash (0x821F2D2C)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "Vector3"
doc [[!
]]
native "GET_PLAYER_WANTED_LEVEL"
hash "0xE28E54788CE8F12D"
jhash (0xBDCDD163)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "int"
doc [[!
]]
native "GET_PLAYERS_LAST_VEHICLE"
hash "0xB6997A7EB3F5C8C0"
jhash (0xE2757AC1)
ns "PLAYER"
returns "Vehicle"
doc [[!
### Warning
This native will return `0` if the last vehicle the player was in was destroyed.
### Alternative
You can use [GET_VEHICLE_PED_IS_IN](#\_0x9A9112A0FE9A4713), which will actually get the last vehicle, even if it was destroyed.
A vehicle handle containing the last player's vehicle.
]]
native "GET_TIME_SINCE_LAST_ARREST"
hash "0x5063F92F07C2A316"
jhash (0x62824EF4)
ns "PLAYER"
returns "int"
doc [[!
```
Returns the time since the character was arrested in (ms) milliseconds.
example
var time = Function.call(Hash.GET_TIME_SINCE_LAST_ARREST();
UI.DrawSubtitle(time.ToString());
if player has not been arrested, the int returned will be -1.
```
]]
native "GET_TIME_SINCE_LAST_DEATH"
hash "0xC7034807558DDFCA"
jhash (0x24BC5AC0)
ns "PLAYER"
returns "int"
doc [[!
```
Returns the time since the character died in (ms) milliseconds.
example
var time = Function.call(Hash.GET_TIME_SINCE_LAST_DEATH();
UI.DrawSubtitle(time.ToString());
if player has not died, the int returned will be -1.
```
]]
native "GET_TIME_SINCE_PLAYER_DROVE_AGAINST_TRAFFIC"
hash "0xDB89591E290D9182"
jhash (0x9F27D00E)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "int"
doc [[!
]]
native "GET_TIME_SINCE_PLAYER_DROVE_ON_PAVEMENT"
hash "0xD559D2BE9E37853B"
jhash (0x8836E732)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "int"
doc [[!
]]
native "GET_TIME_SINCE_PLAYER_HIT_PED"
hash "0xE36A25322DC35F42"
jhash (0xB6209195)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "int"
doc [[!
]]
native "GET_TIME_SINCE_PLAYER_HIT_VEHICLE"
hash "0x5D35ECF3A81A0EE0"
jhash (0x6E9B8B9E)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "int"
doc [[!
]]
native "GET_WANTED_LEVEL_RADIUS"
hash "0x085DEB493BE80812"
jhash (0x1CF7D7DA)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
annotations [=[ {"cs_type":"Any"} ]=]
returns "float"
doc [[!
```
Remnant from GTA IV. Does nothing in GTA V.
```
]]
native "GET_WANTED_LEVEL_THRESHOLD"
hash "0xFDD179EAF45B556C"
jhash (0xD9783F6B)
arguments {
int "wantedLevel" [=[ {} ]=],
}
ns "PLAYER"
returns "int"
doc [[!
```
Drft
```
]]
native "GIVE_ACHIEVEMENT_TO_PLAYER"
hash "0xBEC7076D64130195"
jhash (0x822BC992)
arguments {
int "achievement" [=[ {} ]=],
}
ns "PLAYER"
annotations [=[ {"cs_type":"Any"} ]=]
returns "BOOL"
doc [[!
```
Achievements from 0-57
more achievements came with update 1.29 (freemode events update), I'd say that they now go to 60, but I'll need to check.
```
]]
native "GIVE_PLAYER_RAGDOLL_CONTROL"
hash "0x3C49C870E66F0A28"
jhash (0xC7B4D7AC)
arguments {
Player "player" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
]]
native "HAS_ACHIEVEMENT_BEEN_PASSED"
hash "0x867365E111A3B6EB"
jhash (0x136A5BE9)
arguments {
int "achievement" [=[ {} ]=],
}
ns "PLAYER"
returns "BOOL"
doc [[!
]]
native "HAS_FORCE_CLEANUP_OCCURRED"
hash "0xC968670BFACE42D9"
jhash (0x4B37333C)
arguments {
int "cleanupFlags" [=[ {} ]=],
}
ns "PLAYER"
returns "BOOL"
doc [[!
]]
native "HAS_PLAYER_BEEN_SPOTTED_IN_STOLEN_VEHICLE"
hash "0xD705740BB0A1CF4C"
jhash (0x4A01B76A)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "BOOL"
doc [[!
]]
native "HAS_PLAYER_DAMAGED_AT_LEAST_ONE_NON_ANIMAL_PED"
hash "0xE4B90F367BD81752"
jhash (0xA3707DFC)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "BOOL"
doc [[!
]]
native "HAS_PLAYER_DAMAGED_AT_LEAST_ONE_PED"
hash "0x20CE80B0C2BF4ACC"
jhash (0x14F52453)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "BOOL"
doc [[!
]]
native "HAS_PLAYER_LEFT_THE_WORLD"
hash "0xD55DDFB47991A294"
jhash (0xFEA40B6C)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "BOOL"
doc [[!
]]
native "INT_TO_PARTICIPANTINDEX"
hash "0x9EC6603812C24710"
jhash (0x98F3B274)
arguments {
int "value" [=[ {} ]=],
}
ns "PLAYER"
returns "int"
doc [[!
```
Simply returns whatever is passed to it (Regardless of whether the handle is valid or not).
--------------------------------------------------------
if (NETWORK::NETWORK_IS_PARTICIPANT_ACTIVE(PLAYER::INT_TO_PARTICIPANTINDEX(i)))
```
]]
native "INT_TO_PLAYERINDEX"
hash "0x41BD2A6B006AF756"
jhash (0x98DD98F1)
arguments {
int "value" [=[ {} ]=],
}
ns "PLAYER"
returns "Player"
doc [[!
```
Simply returns whatever is passed to it (Regardless of whether the handle is valid or not).
```
]]
native "IS_PLAYER_BATTLE_AWARE"
hash "0x38D28DA81E4E9BF9"
jhash (0x013B4F72)
arguments {
Player "player" [=[ {} ]=],
}
alias "0x38D28DA81E4E9BF9"
ns "PLAYER"
returns "BOOL"
doc [[!
```
Returns true if an unk value is greater than 0.0f
```
]]
native "IS_PLAYER_BEING_ARRESTED"
hash "0x388A47C51ABDAC8E"
jhash (0x7F6A60D3)
arguments {
Player "player" [=[ {} ]=],
BOOL "atArresting" [=[ {} ]=],
}
ns "PLAYER"
returns "BOOL"
doc [[!
```
Return true while player is being arrested / busted.
If atArresting is set to 1, this function will return 1 when player is being arrested (while player is putting his hand up, but still have control)
If atArresting is set to 0, this function will return 1 only when the busted screen is shown.
```
]]
native "IS_PLAYER_BLUETOOTH_ENABLE"
hash "0x65FAEE425DE637B0"
jhash (0xEA01BD4A)
arguments {
Player "player" [=[ {} ]=],
}
alias "0x65FAEE425DE637B0"
ns "PLAYER"
returns "BOOL"
doc [[!
]]
native "IS_PLAYER_CLIMBING"
hash "0x95E8F73DC65EFB9C"
jhash (0x4A9E9AE0)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "BOOL"
doc [[!
```
Returns TRUE if the player ('s ped) is climbing at the moment.
```
]]
native "IS_PLAYER_CONTROL_ON"
hash "0x49C32D60007AFA47"
jhash (0x618857F2)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "BOOL"
doc [[!
```
Can the player control himself, used to disable controls for player for things like a cutscene.
---
You can't disable controls with this, use SET_PLAYER_CONTROL(...) for this.
```
]]
native "IS_PLAYER_DEAD"
hash "0x424D4687FA1E5652"
jhash (0x140CA5A8)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "BOOL"
doc [[!
]]
native "IS_PLAYER_FREE_AIMING"
hash "0x2E397FD2ECD37C87"
jhash (0x1DEC67B7)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "BOOL"
doc [[!
```
Gets a value indicating whether the specified player is currently aiming freely.
```
]]
native "IS_PLAYER_FREE_AIMING_AT_ENTITY"
hash "0x3C06B5C839B38F7B"
jhash (0x7D80EEAA)
arguments {
Player "player" [=[ {} ]=],
Entity "entity" [=[ {} ]=],
}
ns "PLAYER"
returns "BOOL"
doc [[!
```
Gets a value indicating whether the specified player is currently aiming freely at the specified entity.
```
]]
native "IS_PLAYER_FREE_FOR_AMBIENT_TASK"
hash "0xDCCFD3F106C36AB4"
jhash (0x85C7E232)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "BOOL"
doc [[!
]]
native "IS_PLAYER_LOGGING_IN_NP"
hash "0x74556E1420867ECA"
jhash (0x8F72FAD0)
ns "PLAYER"
returns "BOOL"
doc [[!
```
this function is hard-coded to always return 0.
```
]]
native "IS_PLAYER_ONLINE"
hash "0xF25D331DC2627BBC"
jhash (0x9FAB6729)
ns "PLAYER"
returns "BOOL"
doc [[!
It returns true if the player is online, suggesting they are also logged in locally. Note that this is an alias for `NETWORK_IS_SIGNED_ONLINE`.
It provides a true value if the game is in online mode and false if it's in offline mode.
]]
native "IS_PLAYER_PLAYING"
hash "0x5E9564D8246B909A"
jhash (0xE15D777F)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "BOOL"
doc [[!
```
Checks whether the specified player has a Ped, the Ped is not dead, is not injured and is not arrested.
```
]]
native "IS_PLAYER_PRESSING_HORN"
hash "0xFA1E2BF8B10598F9"
jhash (0xED1D1662)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "BOOL"
doc [[!
]]
native "IS_PLAYER_READY_FOR_CUTSCENE"
hash "0x908CBECC2CAA3690"
jhash (0xBB77E9CD)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "BOOL"
doc [[!
]]
native "IS_PLAYER_RIDING_TRAIN"
hash "0x4EC12697209F2196"
jhash (0x9765E71D)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "BOOL"
doc [[!
```
Returns true if the player is riding a train.
```
]]
native "IS_PLAYER_SCRIPT_CONTROL_ON"
hash "0x8A876A65283DD7D7"
jhash (0x61B00A84)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "BOOL"
doc [[!
]]
native "IS_PLAYER_TARGETTING_ANYTHING"
hash "0x78CFE51896B6B8A4"
jhash (0x456DB50D)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "BOOL"
doc [[!
]]
native "IS_PLAYER_TARGETTING_ENTITY"
hash "0x7912F7FC4F6264B6"
jhash (0xF3240B77)
arguments {
Player "player" [=[ {} ]=],
Entity "entity" [=[ {} ]=],
}
ns "PLAYER"
returns "BOOL"
doc [[!
]]
native "IS_PLAYER_TELEPORT_ACTIVE"
hash "0x02B15662D7F8886F"
jhash (0x3A11D118)
ns "PLAYER"
returns "BOOL"
doc [[!
]]
native "IS_PLAYER_WANTED_LEVEL_GREATER"
hash "0x238DB2A2C23EE9EF"
jhash (0x589A2661)
arguments {
Player "player" [=[ {} ]=],
int "wantedLevel" [=[ {} ]=],
}
ns "PLAYER"
returns "BOOL"
doc [[!
]]
native "IS_SPECIAL_ABILITY_ACTIVE"
hash "0x3E5F7FC85D854E15"
jhash (0x1B17E334)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "BOOL"
doc [[!
```
NativeDB Added Parameter 2: Any p1
```
]]
native "IS_SPECIAL_ABILITY_ENABLED"
hash "0xB1D200FE26AEF3CB"
jhash (0xC01238CC)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "BOOL"
doc [[!
```
NativeDB Added Parameter 2: Any p1
```
]]
native "IS_SPECIAL_ABILITY_METER_FULL"
hash "0x05A1FE504B7F2587"
jhash (0x2E19D7F6)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "BOOL"
doc [[!
```
NativeDB Added Parameter 2: Any p1
```
]]
native "IS_SPECIAL_ABILITY_UNLOCKED"
hash "0xC6017F6A6CDFA694"
jhash (0xC9C75E82)
arguments {
Hash "playerModel" [=[ {} ]=],
}
ns "PLAYER"
returns "BOOL"
doc [[!
]]
native "IS_SYSTEM_UI_BEING_DISPLAYED"
hash "0x5D511E3867C87139"
jhash (0xE495B6DA)
ns "PLAYER"
returns "BOOL"
doc [[!
]]
native "NETWORK_PLAYER_ID_TO_INT"
hash "0xEE68096F9F37341E"
jhash (0x8DD5B838)
ns "PLAYER"
returns "int"
doc [[!
```
Does exactly the same thing as PLAYER_ID()
```
]]
native "PLAYER_ATTACH_VIRTUAL_BOUND"
hash "0xED51733DC73AED51"
jhash (0xECD12E60)
arguments {
float "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
float "p4" [=[ {} ]=],
float "p5" [=[ {} ]=],
float "p6" [=[ {} ]=],
float "p7" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
Only 1 match. ob_sofa_michael.
PLAYER::PLAYER_ATTACH_VIRTUAL_BOUND(-804.5928f, 173.1801f, 71.68436f, 0f, 0f, 0.590625f, 1f, 0.7f);1.0.335.2, 1.0.350.1/2, 1.0.372.2, 1.0.393.2, 1.0.393.4, 1.0.463.1;
```
]]
native "PLAYER_DETACH_VIRTUAL_BOUND"
hash "0x1DD5897E2FA6E7C9"
jhash (0x96100EA4)
ns "PLAYER"
returns "void"
doc [[!
```
1.0.335.2, 1.0.350.1/2, 1.0.372.2, 1.0.393.2, 1.0.393.4, 1.0.463.1;
```
]]
native "PLAYER_ID"
hash "0x4F8644AF03D0E0D6"
jhash (0x8AEA886C)
ns "PLAYER"
returns "Player"
doc [[!
Returns the player index for the local player.
The local player's player index.
]]
native "PLAYER_PED_ID"
hash "0xD80958FC74E988A6"
jhash (0xFA92E226)
ns "PLAYER"
returns "Ped"
doc [[!
Returns the entity handle for the local player ped. Note that this entity handle will change after using commands such as SET_PLAYER_MODEL.
The local player ped's entity handle.
]]
native "REMOVE_PLAYER_HELMET"
hash "0xF3AC26D3CC576528"
jhash (0x6255F3B4)
arguments {
Player "player" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "PLAYER"
annotations [=[ {"cs_type":"Any"} ]=]
returns "void"
doc [[!
]]
native "REPORT_CRIME"
hash "0xE9B09589827545E7"
jhash (0xD8EB3A44)
arguments {
Player "player" [=[ {} ]=],
int "crimeType" [=[ {} ]=],
int "wantedLvlThresh" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
PLAYER::REPORT_CRIME(PLAYER::PLAYER_ID(), 37, PLAYER::GET_WANTED_LEVEL_THRESHOLD(1));
From am_armybase.ysc.c4:
PLAYER::REPORT_CRIME(PLAYER::PLAYER_ID(4), 36, PLAYER::GET_WANTED_LEVEL_THRESHOLD(4));
-----
This was taken from the GTAV.exe v1.334. The function is called sub_140592CE8. For a full decompilation of the function, see here: pastebin.com/09qSMsN7
-----
crimeType:
1: Firearms possession
2: Person running a red light ("5-0-5")
3: Reckless driver
4: Speeding vehicle (a "5-10")
5: Traffic violation (a "5-0-5")
6: Motorcycle rider without a helmet
7: Vehicle theft (a "5-0-3")
8: Grand Theft Auto
9: ???
10: ???
11: Assault on a civilian (a "2-40")
12: Assault on an officer
13: Assault with a deadly weapon (a "2-45")
14: Officer shot (a "2-45")
15: Pedestrian struck by a vehicle
16: Officer struck by a vehicle
17: Helicopter down (an "AC"?)
18: Civilian on fire (a "2-40")
19: Officer set on fire (a "10-99")
20: Car on fire
21: Air unit down (an "AC"?)
22: An explosion (a "9-96")
23: A stabbing (a "2-45") (also something else I couldn't understand)
24: Officer stabbed (also something else I couldn't understand)
25: Attack on a vehicle ("MDV"?)
26: Damage to property
27: Suspect threatening officer with a firearm
28: Shots fired
29: ???
30: ???
31: ???
32: ???
33: ???
34: A "2-45"
35: ???
36: A "9-25"
37: ???
38: ???
39: ???
40: ???
41: ???
42: ???
43: Possible disturbance
44: Civilian in need of assistance
45: ???
46: ???
```
]]
native "REPORT_POLICE_SPOTTED_PLAYER"
hash "0xDC64D2C53493ED12"
jhash (0xD15C4B1C)
arguments {
Player "player" [=[ {} ]=],
}
alias "0xDC64D2C53493ED12"
ns "PLAYER"
returns "void"
doc [[!
]]
native "RESET_PLAYER_ARREST_STATE"
hash "0x2D03E13C460760D6"
jhash (0x453C7CAB)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
]]
native "RESET_PLAYER_INPUT_GAIT"
hash "0x19531C47A2ABD691"
jhash (0x4A701EE1)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
]]
native "RESET_PLAYER_STAMINA"
hash "0xA6F312FCCE9C1DFE"
jhash (0xC0445A9C)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
]]
native "RESET_WANTED_LEVEL_DIFFICULTY"
hash "0xB9D0DD990DC141DD"
jhash (0xA64C378D)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
]]
native "RESET_WORLD_BOUNDARY_FOR_PLAYER"
hash "0xDA1DF03D5A315F4E"
jhash (0xA97C2F6C)
ns "PLAYER"
returns "void"
doc [[!
```
NativeDB Introduced: v323
```
]]
native "RESTORE_PLAYER_STAMINA"
hash "0xA352C1B864CAFD33"
jhash (0x62A93608)
arguments {
Player "player" [=[ {} ]=],
float "percentage" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
Adds a percentage to a players stamina
player to restore the stamina for
seems to be a percentage that ranges from 0.0 to 1.0 (1.0 being 100%)
]]
native "SET_AIR_DRAG_MULTIPLIER_FOR_PLAYERS_VEHICLE"
hash "0xCA7DC8329F0A1E9E"
jhash (0xF20F72E5)
arguments {
Player "player" [=[ {} ]=],
float "multiplier" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
This can be between 1.0f - 14.9f
You can change the max in IDA from 15.0. I say 15.0 as the function blrs if what you input is greater than or equal to 15.0 hence why it's 14.9 max default.
On PC the multiplier can be between 0.0f and 50.0f (inclusive).
```
]]
native "SET_ALL_RANDOM_PEDS_FLEE"
hash "0x056E0FE8534C2949"
jhash (0x49EAE968)
arguments {
Player "player" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
Sets whether all random peds will run away from the player if they are agitated (threatened) (bool=true), or if they will stand their ground (bool=false).
The Player ID for whom you want to set this behavior.
true/false.
]]
native "SET_ALL_RANDOM_PEDS_FLEE_THIS_FRAME"
hash "0x471D2FF42A94B4F2"
jhash (0xBF974891)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
]]
native "SET_AUTO_GIVE_PARACHUTE_WHEN_ENTER_PLANE"
hash "0x9F343285A00B4BB6"
jhash (0xA97C2059)
arguments {
Player "player" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
]]
native "SET_AUTO_GIVE_SCUBA_GEAR_WHEN_EXIT_VEHICLE"
hash "0xD2B315B6689D537D"
jhash (0xA25D767E)
arguments {
Player "player" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0xD2B315B6689D537D"
ns "PLAYER"
returns "void"
doc [[!
]]
native "SET_DISABLE_AMBIENT_MELEE_MOVE"
hash "0x2E8AABFA40A84F8C"
jhash (0xCCD937E7)
arguments {
Player "player" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
]]
native "SET_DISPATCH_COPS_FOR_PLAYER"
hash "0xDB172424876553F4"
jhash (0x48A18913)
arguments {
Player "player" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
]]
native "SET_EVERYONE_IGNORE_PLAYER"
hash "0x8EEDA153AD141BA4"
jhash (0xC915285E)
arguments {
Player "player" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
]]
native "SET_IGNORE_LOW_PRIORITY_SHOCKING_EVENTS"
hash "0x596976B02B6B5700"
jhash (0xA3D675ED)
arguments {
Player "player" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
]]
native "SET_MAX_WANTED_LEVEL"
hash "0xAA5F02DB48D704B9"
jhash (0x665A06F5)
arguments {
int "maxWantedLevel" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
]]
native "SET_PLAYER_BLUETOOTH_STATE"
hash "0x5DC40A8869C22141"
jhash (0x7A6B0EF8)
arguments {
Player "player" [=[ {"cs_type":"BOOL"} ]=],
BOOL "state" [=[ {"cs_type":"ScrHandle"} ]=],
}
alias "0x5DC40A8869C22141"
ns "PLAYER"
returns "void"
doc [[!
]]
native "SET_PLAYER_CAN_BE_HASSLED_BY_GANGS"
hash "0xD5E460AD7020A246"
jhash (0x71B305BB)
arguments {
Player "player" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
Sets whether this player can be hassled by gangs.
```
]]
native "SET_PLAYER_CAN_DO_DRIVE_BY"
hash "0x6E8834B52EC20C77"
jhash (0xF4D99685)
arguments {
Player "player" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
Sets whether the player is able to do drive-bys in vehicle (shooting & aiming in vehicles), this also includes middle finger taunts.
This is a toggle, it does not have to be ran every frame.
The player to target.
If set to false, disables the players ability to do drive bys.
]]
native "SET_PLAYER_CAN_LEAVE_PARACHUTE_SMOKE_TRAIL"
hash "0xF401B182DBA8AF53"
jhash (0x832DEB7A)
arguments {
Player "player" [=[ {} ]=],
BOOL "enabled" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
]]
native "SET_PLAYER_CAN_USE_COVER"
hash "0xD465A8599DFF6814"
jhash (0x13CAFAFA)
arguments {
Player "player" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PLAYER"
annotations [=[ {"cs_type":"Any"} ]=]
returns "void"
doc [[!
```
Sets whether this player can take cover.
```
]]
native "SET_PLAYER_CLOTH_LOCK_COUNTER"
hash "0x14D913B777DFF5DA"
jhash (0x8D9FD4D1)
arguments {
int "value" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
6 matches across 4 scripts. 5 occurrences were 240. The other was 255.
```
]]
native "SET_PLAYER_CLOTH_PACKAGE_INDEX"
hash "0x9F7BBA2EA6372500"
jhash (0xB8209F16)
arguments {
int "index" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
Every occurrence was either 0 or 2.
```
]]
native "SET_PLAYER_CLOTH_PIN_FRAMES"
hash "0x749FADDF97DFE930"
jhash (0xF7A0F00F)
arguments {
Player "player" [=[ {} ]=],
int "p1" [=[ {"cs_type":"BOOL"} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
]]
native "SET_PLAYER_CONTROL"
hash "0x8D32347D6D4C40A2"
jhash (0xD17AFCD8)
arguments {
Player "player" [=[ {} ]=],
BOOL "bHasControl" [=[ {} ]=],
int "flags" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
Flags:
SPC_AMBIENT_SCRIPT = (1 << 1),
SPC_CLEAR_TASKS = (1 << 2),
SPC_REMOVE_FIRES = (1 << 3),
SPC_REMOVE_EXPLOSIONS = (1 << 4),
SPC_REMOVE_PROJECTILES = (1 << 5),
SPC_DEACTIVATE_GADGETS = (1 << 6),
SPC_REENABLE_CONTROL_ON_DEATH = (1 << 7),
SPC_LEAVE_CAMERA_CONTROL_ON = (1 << 8),
SPC_ALLOW_PLAYER_DAMAGE = (1 << 9),
SPC_DONT_STOP_OTHER_CARS_AROUND_PLAYER = (1 << 10),
SPC_PREVENT_EVERYBODY_BACKOFF = (1 << 11),
SPC_ALLOW_PAD_SHAKE = (1 << 12)
See: https://alloc8or.re/gta5/doc/enums/eSetPlayerControlFlag.txt
```
]]
native "SET_PLAYER_FORCE_SKIP_AIM_INTRO"
hash "0x7651BC64AE59E128"
jhash (0x374F42F0)
arguments {
Player "player" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
]]
native "SET_PLAYER_FORCED_AIM"
hash "0x0FEE4F80AC44A726"
jhash (0x94E42E2E)
arguments {
Player "player" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
]]
native "SET_PLAYER_FORCED_ZOOM"
hash "0x75E7D505F2B15902"
jhash (0xB0C576CB)
arguments {
Player "player" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
]]
native "SET_PLAYER_HAS_RESERVE_PARACHUTE"
hash "0x7DDAB28D31FAC363"
jhash (0xA3E4798E)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
]]
native "SET_PLAYER_HEALTH_RECHARGE_MULTIPLIER"
hash "0x5DB660B38DD98A31"
jhash (0x45514731)
arguments {
Player "player" [=[ {} ]=],
float "regenRate" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
This multiplier is reset to `1.0` every time the player ped is changed, often times via [`SET_PLAYER_MODEL`](#\_0x00A1CADD00108836) or [`CHANGE_PLAYER_PED`](#\_0x048189FAC643DEEE).
The local player ID, see [PLAYER_ID](#\_0x4F8644AF03D0E0D6).
The recharge multiplier, this value needs to be a positive float value to work.
]]
native "SET_PLAYER_INVINCIBLE"
hash "0x239528EACDC3E7DE"
jhash (0xDFB9A2A2)
arguments {
Player "player" [=[ {} ]=],
BOOL "bInvincible" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
Make the player impervious to all forms of damage.
The player index.
]]
native "SET_PLAYER_LEAVE_PED_BEHIND"
hash "0xFF300C7649724A0B"
jhash (0xAD8383FA)
arguments {
Player "player" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0xFF300C7649724A0B"
ns "PLAYER"
returns "void"
doc [[!
]]
native "SET_PLAYER_LOCKON"
hash "0x5C8B2F450EE4328E"
jhash (0x0B270E0F)
arguments {
Player "player" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
Used to toggle the square up aim.
```
The player ID to toggle the lock on for.
Set to false to prevent lock on, set to true to allow for lock on.
]]
native "SET_PLAYER_LOCKON_RANGE_OVERRIDE"
hash "0x29961D490E5814FD"
jhash (0x74D42C03)
arguments {
Player "player" [=[ {} ]=],
float "range" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
Affects the range of auto aim target.
```
]]
native "SET_PLAYER_MAX_ARMOUR"
hash "0x77DFCCF5948B8C71"
jhash (0xC6C3C53B)
arguments {
Player "player" [=[ {} ]=],
int "value" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
Default is 100. Use player id and not ped id. For instance: PLAYER::SET_PLAYER_MAX_ARMOUR(PLAYER::PLAYER_ID(), 100); // main_persistent.ct4
```
]]
native "SET_PLAYER_MAY_NOT_ENTER_ANY_VEHICLE"
hash "0x1DE37BBF9E9CC14A"
jhash (0xAF7AFCC4)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
Establishes a reset flag to prevent the player from entering any vehicle. Not that this native must be called every frame.
The player index.
]]
native "SET_PLAYER_MAY_ONLY_ENTER_THIS_VEHICLE"
hash "0x8026FF78F208978A"
jhash (0xA454DD29)
arguments {
Player "player" [=[ {} ]=],
Vehicle "vehicle" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
Limit the player to only enter this vehicle. Note set vehicle to false if you want them to access any vehicle.
The player index.
Vehicle id.
]]
native "SET_PLAYER_MELEE_WEAPON_DAMAGE_MODIFIER"
hash "0x4A3DC7ECCC321032"
jhash (0x362E69AD)
arguments {
Player "player" [=[ {} ]=],
float "modifier" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
NativeDB Added Parameter 3: BOOL p2
```
]]
native "SET_PLAYER_MELEE_WEAPON_DEFENSE_MODIFIER"
hash "0xAE540335B4ABC4E2"
jhash (0x9F3D577F)
arguments {
Player "player" [=[ {} ]=],
float "modifier" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
modifier's min value is 0.1
```
]]
native "SET_PLAYER_MODEL"
hash "0x00A1CADD00108836"
jhash (0x774A4C54)
arguments {
Player "player" [=[ {} ]=],
Hash "model" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
Set the model for a specific Player. Note that this will destroy the current Ped for the Player and create a new one, any reference to the old ped will be invalid after calling this.
As per usual, make sure to request the model first and wait until it has loaded.
The player to set the model for
The model to use
]]
native "SET_PLAYER_NOISE_MULTIPLIER"
hash "0xDB89EF50FF25FCE9"
jhash (0x15786DD1)
arguments {
Player "player" [=[ {} ]=],
float "multiplier" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
]]
native "SET_PLAYER_PARACHUTE_MODEL_OVERRIDE"
hash "0x977DB4641F6FC3DB"
jhash (0x5D382498)
arguments {
Player "player" [=[ {} ]=],
Hash "model" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
example:
PLAYER::SET_PLAYER_PARACHUTE_MODEL_OVERRIDE(PLAYER::PLAYER_ID(), 0x73268708);
```
]]
native "SET_PLAYER_PARACHUTE_PACK_MODEL_OVERRIDE"
hash "0xDC80A4C2F18A2B64"
jhash (0xA877FF5E)
arguments {
Player "player" [=[ {} ]=],
Hash "model" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
]]
native "SET_PLAYER_PARACHUTE_PACK_TINT_INDEX"
hash "0x93B0FB27C9A04060"
jhash (0xD79D5D1B)
arguments {
Player "player" [=[ {} ]=],
int "tintIndex" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
tints 0- 13
0 - unkown
1 - unkown
2 - unkown
3 - unkown
4 - unkown
```
]]
native "SET_PLAYER_PARACHUTE_SMOKE_TRAIL_COLOR"
hash "0x8217FD371A4625CF"
jhash (0x14FE9264)
arguments {
Player "player" [=[ {} ]=],
int "r" [=[ {} ]=],
int "g" [=[ {} ]=],
int "b" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
]]
native "SET_PLAYER_PARACHUTE_TINT_INDEX"
hash "0xA3D0E54541D9A5E5"
jhash (0x8EA12EDB)
arguments {
Player "player" [=[ {} ]=],
int "tintIndex" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
Tints:
None = -1,
Rainbow = 0,
Red = 1,
SeasideStripes = 2,
WidowMaker = 3,
Patriot = 4,
Blue = 5,
Black = 6,
Hornet = 7,
AirFocce = 8,
Desert = 9,
Shadow = 10,
HighAltitude = 11,
Airbone = 12,
Sunrise = 13,
```
]]
native "SET_PLAYER_PARACHUTE_VARIATION_OVERRIDE"
hash "0xD9284A8C0D48352C"
jhash (0x9254249D)
arguments {
Player "player" [=[ {} ]=],
int "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
BOOL "p4" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
p1 was always 5.
p4 was always false.
```
]]
native "SET_PLAYER_RESERVE_PARACHUTE_TINT_INDEX"
hash "0xAF04C87F5DC1DF38"
jhash (0x70689638)
arguments {
Player "player" [=[ {} ]=],
int "index" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
Tints:
None = -1,
Rainbow = 0,
Red = 1,
SeasideStripes = 2,
WidowMaker = 3,
Patriot = 4,
Blue = 5,
Black = 6,
Hornet = 7,
AirFocce = 8,
Desert = 9,
Shadow = 10,
HighAltitude = 11,
Airbone = 12,
Sunrise = 13,
```
]]
native "SET_PLAYER_RESET_FLAG_PREFER_REAR_SEATS"
hash "0x11D5F725F0E780E0"
jhash (0x725C6174)
arguments {
Player "player" [=[ {} ]=],
int "flags" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
example:
flags: 0-6
PLAYER::SET_PLAYER_RESET_FLAG_PREFER_REAR_SEATS(PLAYER::PLAYER_ID(), 6);
wouldnt the flag be the seatIndex?
```
]]
native "SET_PLAYER_SIMULATE_AIMING"
hash "0xC54C95DA968EC5B5"
jhash (0xF1E0CAFC)
arguments {
Player "player" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
]]
native "SET_PLAYER_SNEAKING_NOISE_MULTIPLIER"
hash "0xB2C1A29588A9F47C"
jhash (0x8D2D89C4)
arguments {
Player "player" [=[ {} ]=],
float "multiplier" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
Values around 1.0f to 2.0f used in game scripts.
```
]]
native "SET_PLAYER_SPRINT"
hash "0xA01B8075D8B92DF4"
jhash (0x7DD7900C)
arguments {
Player "player" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
]]
native "SET_PLAYER_STEALTH_PERCEPTION_MODIFIER"
hash "0x4E9021C1FCDD507A"
jhash (0x3D26105F)
arguments {
Player "player" [=[ {} ]=],
float "value" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
]]
native "SET_PLAYER_TARGET_LEVEL"
hash "0x5702B917B99DB1CD"
jhash (0x772DA539)
arguments {
int "targetLevel" [=[ {} ]=],
}
alias "0x5702B917B99DB1CD"
ns "PLAYER"
returns "void"
doc [[!
]]
native "SET_PLAYER_TARGETING_MODE"
hash "0xB1906895227793F3"
jhash (0x61CAE253)
arguments {
int "targetMode" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
Sets your targeting mode.
0 = Assisted Aim - Full
1 = Assisted Aim - Partial
2 = Free Aim - Assisted
3 = Free Aim
```
]]
native "SET_PLAYER_TEAM"
hash "0x0299FA38396A4940"
jhash (0x725ADCF2)
arguments {
Player "player" [=[ {} ]=],
int "team" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
Set the player's current team.
The player index.
]]
native "SET_PLAYER_VEHICLE_DAMAGE_MODIFIER"
hash "0xA50E117CDDF82F0C"
jhash (0x823ECA63)
arguments {
Player "player" [=[ {} ]=],
float "modifier" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
modifier's min value is 0.1
```
]]
native "SET_PLAYER_VEHICLE_DEFENSE_MODIFIER"
hash "0x4C60E6EFDAFF2462"
jhash (0xA16626C7)
arguments {
Player "player" [=[ {} ]=],
float "modifier" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
modifier's min value is 0.1
```
]]
native "SET_PLAYER_WANTED_CENTRE_POSITION"
hash "0x520E541A97A13354"
jhash (0xF261633A)
arguments {
Player "player" [=[ {} ]=],
Vector3Ptr "position" [=[ {"cs_type":"float"} ]=],
BOOL "p2" [=[ {"cs_type":"float"} ]=],
BOOL "p3" [=[ {"cs_type":"float"} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
# Predominant call signatures
PLAYER::SET_PLAYER_WANTED_CENTRE_POSITION(PLAYER::PLAYER_ID(), ENTITY::GET_ENTITY_COORDS(PLAYER::PLAYER_PED_ID(), 1));
# Parameter value ranges
P0: PLAYER::PLAYER_ID()
P1: ENTITY::GET_ENTITY_COORDS(PLAYER::PLAYER_PED_ID(), 1)
P2: Not set by any call
```
]]
native "SET_PLAYER_WANTED_LEVEL"
hash "0x39FF19C64EF7DA5B"
jhash (0xB7A0914B)
arguments {
Player "player" [=[ {} ]=],
int "wantedLevel" [=[ {} ]=],
BOOL "delayedResponse" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
the target player
the wanted level 1-5
false = 0-10sec police spawn response time, true = 10-20sec police spawn response time
]]
native "SET_PLAYER_WANTED_LEVEL_NO_DROP"
hash "0x340E61DE7F471565"
jhash (0xED6F44F5)
arguments {
Player "player" [=[ {} ]=],
int "wantedLevel" [=[ {} ]=],
BOOL "delayedResponse" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
the target player
the wanted level 1-5
false = 0-10sec police spawn response time, true = 10-20sec police spawn response time
]]
native "SET_PLAYER_WANTED_LEVEL_NOW"
hash "0xE0A7D1E497FFCD6F"
jhash (0xAF3AFD83)
arguments {
Player "player" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
Forces any pending wanted level to be applied to the specified player immediately.
Call SET_PLAYER_WANTED_LEVEL with the desired wanted level, followed by SET_PLAYER_WANTED_LEVEL_NOW.
Second parameter is unknown (always false).
```
]]
native "SET_PLAYER_WEAPON_DAMAGE_MODIFIER"
hash "0xCE07B9F7817AADA3"
jhash (0xB02C2F39)
arguments {
Player "player" [=[ {} ]=],
float "modifier" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
The native ensures the 'modifier' parameter is 0.1 or greater.
]]
native "SET_PLAYER_WEAPON_DEFENSE_MODIFIER"
hash "0x2D83BC011CA14A3C"
jhash (0xAE446344)
arguments {
Player "player" [=[ {} ]=],
float "modifier" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
]]
native "SET_POLICE_IGNORE_PLAYER"
hash "0x32C62AA929C2DA6A"
jhash (0xE6DE71B7)
arguments {
Player "player" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
The player will be ignored by the police if toggle is set to true
```
]]
native "SET_POLICE_RADAR_BLIPS"
hash "0x43286D561B72B8BF"
jhash (0x8E114B10)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
If toggle is set to false:
The police won't be shown on the (mini)map
If toggle is set to true:
The police will be shown on the (mini)map
```
]]
native "SET_RUN_SPRINT_MULTIPLIER_FOR_PLAYER"
hash "0x6DB47AA77FD94E09"
jhash (0x825423C2)
arguments {
Player "player" [=[ {} ]=],
float "multiplier" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
Multiplier goes up to 1.49 any value above will be completely overruled by the game and the multiplier will not take effect, this can be edited in memory however.
Just call it one time, it is not required to be called once every tick.
Note: At least the IDA method if you change the max float multiplier from 1.5 it will change it for both this and SWIM above. I say 1.5 as the function blrs if what you input is greater than or equal to 1.5 hence why it's 1.49 max default.
It is not possible to "decrease" speed. Anything below 1 will be ignored.
```
]]
native "SET_SPECIAL_ABILITY_MULTIPLIER"
hash "0xA49C426ED0CA4AB7"
jhash (0xFF1BC556)
arguments {
float "multiplier" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
]]
native "SET_SWIM_MULTIPLIER_FOR_PLAYER"
hash "0xA91C6F0FF7D16A13"
jhash (0xB986FF47)
arguments {
Player "player" [=[ {} ]=],
float "multiplier" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
Swim speed multiplier.
Multiplier goes up to 1.49
Just call it one time, it is not required to be called once every tick. - Note copied from below native.
Note: At least the IDA method if you change the max float multiplier from 1.5 it will change it for both this and RUN_SPRINT below. I say 1.5 as the function blrs if what you input is greater than or equal to 1.5 hence why it's 1.49 max default.
```
]]
native "SET_WANTED_LEVEL_DIFFICULTY"
hash "0x9B0BB33B04405E7A"
jhash (0xB552626C)
arguments {
Player "player" [=[ {} ]=],
float "difficulty" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
Max value is 1.0
```
]]
native "SET_WANTED_LEVEL_MULTIPLIER"
hash "0x020E5F00CDA207BA"
jhash (0x1359292F)
arguments {
float "multiplier" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
]]
native "SIMULATE_PLAYER_INPUT_GAIT"
hash "0x477D5D63E63ECA5D"
jhash (0x0D77CC34)
arguments {
Player "player" [=[ {} ]=],
float "amount" [=[ {} ]=],
int "gaitType" [=[ {} ]=],
float "rotationSpeed" [=[ {} ]=],
BOOL "p4" [=[ {} ]=],
BOOL "p5" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
This is to make the player walk without accepting input.
Call this native every frame so you can control the direction of your ped.
The player to target (always your local player id).
For game pads, using anything less than 1.0 will make it partially press analog controls (like sticks/triggers).
Value in increments of 100's. 2000, 500, 300, 200, etc. Set to -1 if you want your ped to walk forever.
Determines the counterclockwise rotation angle when walking.
Always true
Always false
]]
native "SPECIAL_ABILITY_CHARGE_ABSOLUTE"
hash "0xB7B0870EB531D08D"
jhash (0x72429998)
arguments {
Player "player" [=[ {} ]=],
int "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
p1 appears as 5, 10, 15, 25, or 30. p2 is always true.
```
```
NativeDB Added Parameter 4: Any p3
```
]]
native "SPECIAL_ABILITY_CHARGE_CONTINUOUS"
hash "0xED481732DFF7E997"
jhash (0x5FEE98A2)
arguments {
Player "player" [=[ {} ]=],
Ped "p2" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
p1 appears to always be 1 (only comes up twice)
```
```
NativeDB Added Parameter 3: Any p2
```
]]
native "SPECIAL_ABILITY_CHARGE_LARGE"
hash "0xF733F45FA4497D93"
jhash (0xF440C04D)
arguments {
Player "player" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
2 matches. p1 was always true.
```
```
NativeDB Added Parameter 4: Any p3
```
]]
native "SPECIAL_ABILITY_CHARGE_MEDIUM"
hash "0xF113E3AA9BC54613"
jhash (0xAB55D8F3)
arguments {
Player "player" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
Only 1 match. Both p1 & p2 were true.
```
```
NativeDB Added Parameter 4: Any p3
```
]]
native "SPECIAL_ABILITY_CHARGE_NORMALIZED"
hash "0xA0696A65F009EE18"
jhash (0x8C7E68C1)
arguments {
Player "player" [=[ {} ]=],
float "normalizedValue" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
alias "RESET_SPECIAL_ABILITY_CONTROLS_CINEMATIC"
ns "PLAYER"
returns "void"
doc [[!
```
normalizedValue is from 0.0 - 1.0
p2 is always 1
```
```
NativeDB Added Parameter 4: Any p3
```
]]
native "SPECIAL_ABILITY_CHARGE_ON_MISSION_FAILED"
hash "0xC9A763D8FE87436A"
jhash (0x4136829A)
arguments {
Player "player" [=[ {} ]=],
}
alias "0xC9A763D8FE87436A"
ns "PLAYER"
returns "void"
doc [[!
```
NativeDB Added Parameter 2: Any p1
```
]]
native "SPECIAL_ABILITY_CHARGE_SMALL"
hash "0x2E7B9B683481687D"
jhash (0x6F463F56)
arguments {
Player "player" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
Every occurrence of p1 & p2 were both true.
```
```
NativeDB Added Parameter 4: Any p3
```
]]
native "SPECIAL_ABILITY_DEACTIVATE"
hash "0xD6A953C6D1492057"
jhash (0x80C2AB09)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
NativeDB Added Parameter 2: Any p1
```
]]
native "SPECIAL_ABILITY_DEACTIVATE_FAST"
hash "0x9CB5CE07A3968D5A"
jhash (0x0751908A)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
NativeDB Added Parameter 2: Any p1
```
]]
native "SPECIAL_ABILITY_DEPLETE_METER"
hash "0x1D506DBBBC51E64B"
jhash (0x9F80F6DF)
arguments {
Player "player" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
p1 was always true.
```
```
NativeDB Added Parameter 3: Any p2
```
]]
native "SPECIAL_ABILITY_FILL_METER"
hash "0x3DACA8DDC6FD4980"
jhash (0xB71589DA)
arguments {
Player "player" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
Also known as _RECHARGE_SPECIAL_ABILITY
```
```
NativeDB Added Parameter 3: Any p2
```
]]
native "SPECIAL_ABILITY_LOCK"
hash "0x6A09D0D590A47D13"
jhash (0x1B7BB388)
arguments {
Hash "playerModel" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
NativeDB Added Parameter 2: Any p1
```
]]
native "SPECIAL_ABILITY_RESET"
hash "0x375F0E738F861A94"
jhash (0xA7D8BCD3)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
NativeDB Added Parameter 2: Any p1
```
]]
native "SPECIAL_ABILITY_UNLOCK"
hash "0xF145F3BE2EFA9A3B"
jhash (0x1FDB2919)
arguments {
Hash "playerModel" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
NativeDB Added Parameter 2: Any p1
```
]]
native "START_FIRING_AMNESTY"
hash "0xBF9BD71691857E48"
jhash (0x5F8A22A6)
arguments {
int "duration" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
]]
native "START_PLAYER_TELEPORT"
hash "0xAD15F075A4DA0FDE"
jhash (0xC552E06C)
arguments {
Player "player" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "heading" [=[ {} ]=],
BOOL "teleportWithVehicle" [=[ {} ]=],
BOOL "findCollisionLand" [=[ {} ]=],
BOOL "p7" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
Teleports the player to the given coordinates.
If findCollisionLand is true it will try to find the Z value for you, this however has a timeout of 100 frames.
When trying to find the Z value the native will take longer the higher the difference from the given Z to the ground, this combined with the timeout can cause the teleport to just teleport to the given Z value, so try to estimate the z value, so don't just pass in 1000.0.
Also if you're in a vehicle and teleportWithVehicle is true it will not find the Z value for you.
Teleports the player along with the vehicle they are in.
Attempt to find a ground coordinate at the given XY location; overriding the Z value.
]]
native "STOP_PLAYER_TELEPORT"
hash "0xC449EDED9D73009C"
jhash (0x86AB8DBB)
ns "PLAYER"
returns "void"
doc [[!
```
Disables the player's teleportation
```
]]
native "SUPPRESS_CRIME_THIS_FRAME"
hash "0x9A987297ED8BD838"
jhash (0x59B5C2A2)
arguments {
Player "player" [=[ {} ]=],
int "crimeType" [=[ {} ]=],
}
alias "0x9A987297ED8BD838"
alias "_SWITCH_CRIME_TYPE"
ns "PLAYER"
returns "void"
doc [[!
Suppresses a crime for a given player for this frame only.
**Note:** This native needs to be executed inside a thread if a crime is meant to be suppressed for a given amount of time.
The player we are suppressing the crime for.
The crime to suppress, see [`REPORT_CRIME`](#\_0xE9B09589827545E7) for available types.
]]
native "_CLEAR_PLAYER_RESERVE_PARACHUTE_MODEL_OVERRIDE"
hash "0x290D248E25815AE8"
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "_GET_ACHIEVEMENT_PROGRESS"
hash "0x1C186837D0619335"
arguments {
int "achievement" [=[ {} ]=],
}
alias "0x1C186837D0619335"
alias "_GET_ACHIEVEMENT_PROGRESSION"
ns "PLAYER"
returns "int"
doc [[!
```
For Steam.
Always returns 0 in retail version of the game.
```
Returns the progression of an achievement; 0 if the achievement cannot be progressed.
]]
native "_GET_NUMBER_OF_PLAYERS_IN_TEAM"
hash "0x1FC200409F10E6F1"
arguments {
int "team" [=[ {} ]=],
}
ns "PLAYER"
returns "int"
doc [[!
```
NativeDB Introduced: v1180
```
]]
native "_GET_PLAYER_HEALTH_RECHARGE_LIMIT"
hash "0x8BC515BAE4AAF8FF"
arguments {
Player "player" [=[ {} ]=],
}
alias "0x8BC515BAE4AAF8FF"
ns "PLAYER"
returns "float"
doc [[!
]]
native "_GET_PLAYER_PARACHUTE_MODEL_OVERRIDE"
hash "0xC219887CA3E65C41"
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "Hash"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "_GET_PLAYER_RESERVE_PARACHUTE_MODEL_OVERRIDE"
hash "0x37FAAA68DCA9D08D"
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "Hash"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "_GET_WANTED_LEVEL_PAROLE_DURATION"
hash "0xA72200F51875FEA4"
alias "0xA72200F51875FEA4"
ns "PLAYER"
returns "int"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "_HAS_PLAYER_BEEN_SHOT_BY_COP"
hash "0xBC0753C9CA14B506"
jhash (0x9DF75B2A)
arguments {
Player "player" [=[ {} ]=],
int "ms" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
alias "0xBC0753C9CA14B506"
ns "PLAYER"
returns "BOOL"
doc [[!
Time since last bullet fired
Always false
]]
native "_IS_PLAYER_DRIVING_DANGEROUSLY"
hash "0xF10B44FD479D69F3"
jhash (0x1E359CC8)
arguments {
Player "player" [=[ {} ]=],
int "type" [=[ {} ]=],
}
alias "0xF10B44FD479D69F3"
ns "PLAYER"
returns "BOOL"
doc [[!
```cpp
enum eViolationType {
// Checks if the player is driving on pedestrians walk ways
VT_PAVED_PEDESTRIAN_AREAS = 0,
// Checks if the player is running through red lights
// This takes some time to return true.
VT_RUNNING_REDS = 1,
// checks if the player is driving on the wrong side of the road
VT_AGAINST_TRAFFIC = 2
};
```
Used solely in "Al Di Napoli" with type 2 for a voiceline.
Player ID
Refer to `eViolationType`.
Returns true if the player is performing the `type` traffic violation.
]]
native "_SET_ACHIEVEMENT_PROGRESS"
hash "0xC2AFFFDABBDC2C5C"
arguments {
int "achievement" [=[ {} ]=],
int "progress" [=[ {} ]=],
}
alias "0xC2AFFFDABBDC2C5C"
alias "_SET_ACHIEVEMENT_PROGRESSION"
ns "PLAYER"
returns "BOOL"
doc [[!
For Steam.
Does nothing and always returns false in the retail version of the game.
]]
native "_SET_PLAYER_FALL_DISTANCE"
hash "0xEFD79FA81DFBA9CB"
arguments {
Player "player" [=[ {} ]=],
float "distance" [=[ {} ]=],
}
alias "0xEFD79FA81DFBA9CB"
ns "PLAYER"
returns "void"
doc [[!
]]
native "_SET_PLAYER_HEALTH_RECHARGE_LIMIT"
hash "0xC388A0F065F5BC34"
arguments {
Player "player" [=[ {} ]=],
float "limit" [=[ {} ]=],
}
alias "0xC388A0F065F5BC34"
ns "PLAYER"
returns "void"
doc [[!
The local player ID.
A value between 0.0 and 1.0, 0.5 is default.
]]
native "_SET_PLAYER_HOMING_ROCKET_DISABLED"
hash "0xEE4EBDD2593BA844"
arguments {
Player "player" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
alias "0xEE4EBDD2593BA844"
ns "PLAYER"
returns "void"
doc [[!
```
NativeDB Introduced: v1180
```
]]
native "_SET_PLAYER_INVINCIBLE_KEEP_RAGDOLL_ENABLED"
hash "0x6BC97F4F4BB3C04B"
arguments {
Player "player" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x6BC97F4F4BB3C04B"
ns "PLAYER"
returns "void"
doc [[!
]]
native "_SET_PLAYER_RESERVE_PARACHUTE_MODEL_OVERRIDE"
hash "0x0764486AEDE748DB"
arguments {
Player "player" [=[ {} ]=],
Hash "model" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "_SET_PLAYER_UNDERWATER_TIME_REMAINING"
hash "0xA0D3E4F7AAFB7E78"
arguments {
Player "player" [=[ {} ]=],
float "percentage" [=[ {} ]=],
}
alias "0xA0D3E4F7AAFB7E78"
ns "PLAYER"
returns "Any"
doc [[!
Seems to lock the underwater timer of the specified player. Set `percentage` to `50.0` will reduce the value of [GET_PLAYER_UNDERWATER_TIME_REMAINING](#\_0xA1FCF8E6AF40B731) to 5.0.
If you want to increase the underwater time for ped, use [SET_PED_MAX_TIME_UNDERWATER](#\_0x6BA428C528D9E522) instead.
Using this native after [SET_PED_MAX_TIME_UNDERWATER](#\_0x6BA428C528D9E522) **WILL NOT** get what you want. For example, if you set the max time underwater to `100.0` seconds using [SET_PED_MAX_TIME_UNDERWATER](#\_0x6BA428C528D9E522) and then call this native and set the `percentage` to 50.0, you will not get `50.0`, instead `2.0`.
Player id.
Maximum is `100.0`. Any value above `100.0` and less than `0.0` will have no effect on [GET_PLAYER_UNDERWATER_TIME_REMAINING](#\_0xA1FCF8E6AF40B731).
]]
native "_SET_PLAYER_WEAPON_DEFENSE_MODIFIER_2"
hash "0xBCFDE9EDE4CF27DC"
arguments {
Player "player" [=[ {} ]=],
float "modifier" [=[ {} ]=],
}
alias "0xBCFDE9EDE4CF27DC"
ns "PLAYER"
returns "void"
doc [[!
]]
native "_SET_SPECIAL_ABILITY"
hash "0xB214D570EAD7F81A"
arguments {
Player "player" [=[ {} ]=],
int "p1" [=[ {} ]=],
}
alias "0xB214D570EAD7F81A"
ns "PLAYER"
returns "void"
doc [[!
```
NativeDB Added Parameter 3: Any p2
```
]]
native "_SET_WANTED_LEVEL_HIDDEN_EVASION_TIME"
hash "0x49B856B1360C47C7"
arguments {
Player "player" [=[ {} ]=],
int "wantedLevel" [=[ {} ]=],
int "lossTime" [=[ {} ]=],
}
alias "0x49B856B1360C47C7"
ns "PLAYER"
returns "void"
doc [[!
```
NativeDB Introduced: v2060
```
]]
native "_SPECIAL_ABILITY_ACTIVATE"
hash "0x821FDC827D6F4090"
arguments {
Any "player" [=[ {} ]=],
}
alias "0x821FDC827D6F4090"
ns "PLAYER"
returns "void"
doc [[!
```
NativeDB Added Parameter 2: Any p1
```
]]
native "_SPECIAL_ABILITY_DEPLETE"
hash "0x17F7471EACA78290"
arguments {
Any "p0" [=[ {} ]=],
}
alias "0x17F7471EACA78290"
ns "PLAYER"
returns "void"
doc [[!
```
NativeDB Added Parameter 2: Any p1
```
]]
native "_UPDATE_PLAYER_TELEPORT"
hash "0xE23D5873C2394C61"
arguments {
Player "player" [=[ {} ]=],
}
alias "0xE23D5873C2394C61"
alias "_HAS_PLAYER_TELEPORT_FINISHED"
ns "PLAYER"
returns "BOOL"
doc [[!
]]
native "0x0032A6DBA562C518"
hash "0x0032A6DBA562C518"
jhash (0x47CAB814)
ns "PLAYER"
returns "void"
doc [[!
```
2 matches in 1 script - am_hold_up
Used in multiplayer scripts?
```
]]
native "0x237440E46D918649"
hash "0x237440E46D918649"
arguments {
Any "p0" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "0x2382AB11450AE7BA"
hash "0x2382AB11450AE7BA"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
]]
native "0x2F41A3BAE005E5FA"
hash "0x2F41A3BAE005E5FA"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
]]
native "0x2F7CEB6520288061"
hash "0x2F7CEB6520288061"
jhash (0x2849D4B2)
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
Used with radios:
void sub_cf383(auto _a0) {
if ((a_0)==1) {
if (MISC::IS_BIT_SET((g_240005._f1), 3)) {
PLAYER::_2F7CEB6520288061(0);
AUDIO::SET_AUDIO_FLAG("AllowRadioDuringSwitch", 0);
AUDIO::SET_MOBILE_PHONE_RADIO_STATE(0);
AUDIO::SET_AUDIO_FLAG("MobileRadioInGame", 0);
}
sub_cf3f6(1);
} else {
if (MISC::IS_BIT_SET((g_240005._f1), 3)) {
PLAYER::_2F7CEB6520288061(1);
AUDIO::SET_AUDIO_FLAG("AllowRadioDuringSwitch", 1);
AUDIO::SET_MOBILE_PHONE_RADIO_STATE(1);
AUDIO::SET_AUDIO_FLAG("MobileRadioInGame", 1);
}
sub_cf3f6(0);
}
}
SET_PLAYER_S*
```
]]
native "0x31E90B8873A4CD3B"
hash "0x31E90B8873A4CD3B"
arguments {
Player "player" [=[ {} ]=],
float "p1" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
]]
native "0x36F1B38855F2A8DF"
hash "0x36F1B38855F2A8DF"
jhash (0x3A7E5FB6)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
]]
native "0x4669B3ED80F24B4E"
hash "0x4669B3ED80F24B4E"
jhash (0xB9FB142F)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
This has been found in use in the decompiled files.
```
]]
native "0x5501B7A5CDB79D37"
hash "0x5501B7A5CDB79D37"
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
Name between DISABLE_ALL_CONTROL_ACTIONS and DISABLE_CONTROL_ACTION
```
]]
native "0x55FCC0C390620314"
hash "0x55FCC0C390620314"
arguments {
Player "player1" [=[ {} ]=],
Player "player2" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
]]
native "0x690A61A6D13583F6"
hash "0x690A61A6D13583F6"
jhash (0x1D371529)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "BOOL"
doc [[!
```
IS_*
```
]]
native "0x6E4361FF3E8CD7CA"
hash "0x6E4361FF3E8CD7CA"
arguments {
Any "p0" [=[ {} ]=],
}
ns "PLAYER"
returns "Any"
doc [[!
]]
native "0x70A382ADEC069DD3"
hash "0x70A382ADEC069DD3"
arguments {
float "coordX" [=[ {} ]=],
float "coordY" [=[ {} ]=],
float "coordZ" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
NativeDB Introduced: v1604
```
]]
native "0x7148E0F43D11F0D9"
hash "0x7148E0F43D11F0D9"
ns "PLAYER"
returns "void"
doc [[!
```
NativeDB Introduced: v1604
```
]]
native "0x7BAE68775557AE0B"
hash "0x7BAE68775557AE0B"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "0x7E07C78925D5FD96"
hash "0x7E07C78925D5FD96"
arguments {
Any "p0" [=[ {} ]=],
}
ns "PLAYER"
returns "Any"
doc [[!
]]
native "0x823EC8E82BA45986"
hash "0x823EC8E82BA45986"
arguments {
Any "p0" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
NativeDB Introduced: v2060
```
]]
native "0x8D768602ADEF2245"
hash "0x8D768602ADEF2245"
arguments {
Player "player" [=[ {} ]=],
float "p1" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
SET_PLAYER_MAX_*
```
]]
native "0x9097EB6D4BB9A12A"
hash "0x9097EB6D4BB9A12A"
arguments {
Player "player" [=[ {} ]=],
Entity "entity" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
ADD_\*
```
NativeDB Introduced: v1868
```
]]
native "0x9EDD76E87D5D51BA"
hash "0x9EDD76E87D5D51BA"
jhash (0xE30A64DC)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
]]
native "0x9F260BFB59ADBCA3"
hash "0x9F260BFB59ADBCA3"
arguments {
Player "player" [=[ {} ]=],
Entity "entity" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
REMOVE_\*
```
NativeDB Introduced: v1868
```
]]
native "0xAD73CE5A09E42D12"
hash "0xAD73CE5A09E42D12"
jhash (0x85725848)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
This has been found in use in the decompiled files.
```
]]
native "0xB45EFF719D8427A6"
hash "0xB45EFF719D8427A6"
jhash (0xBF6993C7)
arguments {
float "p0" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
PLAYER::0xBF6993C7(rPtr((&l_122) + 71)); // Found in decompilation
***
In "am_hold_up.ysc" used once:
l_8d._f47 = MISC::GET_RANDOM_FLOAT_IN_RANGE(18.0, 28.0);
PLAYER::_B45EFF719D8427A6((l_8d._f47));
```
]]
native "0xB885852C39CC265D"
hash "0xB885852C39CC265D"
jhash (0x47D6004E)
ns "PLAYER"
returns "void"
doc [[!
```
Disables something. Used only once in R* scripts (freemode.ysc).
DISABLE_PLAYER_*
```
]]
native "0xB9CF1F793A9F1BF1"
hash "0xB9CF1F793A9F1BF1"
ns "PLAYER"
returns "BOOL"
doc [[!
```
Returns profile setting 237.
GET_*
```
]]
native "0xBC9490CA15AEA8FB"
hash "0xBC9490CA15AEA8FB"
jhash (0x6B34A160)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
Seems to only appear in scripts used in Singleplayer.
Always used like this in scripts
PLAYER::_BC9490CA15AEA8FB(PLAYER::PLAYER_ID());
```
]]
native "0xC3376F42B1FACCC6"
hash "0xC3376F42B1FACCC6"
jhash (0x02DF7AF4)
arguments {
Player "player" [=[ {} ]=],
}
alias "SET_AREAS_GENERATOR_ORIENTATION"
ns "PLAYER"
returns "void"
doc [[!
```
- This is called after SET_ALL_RANDOM_PEDS_FLEE_THIS_FRAME
```
]]
native "0xCAC57395B151135F"
hash "0xCAC57395B151135F"
jhash (0x00563E0D)
arguments {
Player "player" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
Found in "director_mode", "fm_bj_race_controler", "fm_deathmatch_controler", "fm_impromptu_dm_controler", "fm_race_controler", "gb_deathmatch".
```
]]
native "0xCB645E85E97EA48B"
hash "0xCB645E85E97EA48B"
ns "PLAYER"
returns "BOOL"
doc [[!
```
Returns profile setting 243.
GET_*
```
]]
native "0xD821056B9ACF8052"
hash "0xD821056B9ACF8052"
arguments {
Player "player" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
]]
native "0xDCC07526B8EC45AF"
hash "0xDCC07526B8EC45AF"
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "BOOL"
doc [[!
Always returns false.
```
NativeDB Introduced: v1868
```
]]
native "0xDD2620B7B9D16FF1"
hash "0xDD2620B7B9D16FF1"
jhash (0x8CB53C9F)
arguments {
Player "player" [=[ {} ]=],
float "p1" [=[ {} ]=],
}
ns "PLAYER"
returns "BOOL"
doc [[!
```
2 occurrences in agency_heist3a. p1 was 0.7f then 0.4f.
```
]]
native "0xDE45D1A1EF45EE61"
hash "0xDE45D1A1EF45EE61"
jhash (0x274631FE)
arguments {
Player "player" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "SET_HUD_ANIM_STOP_LEVEL"
ns "PLAYER"
returns "void"
doc [[!
]]
native "0xFAC75988A7D078D3"
hash "0xFAC75988A7D078D3"
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
]]
native "0xFFEE8FA29AB9A18E"
hash "0xFFEE8FA29AB9A18E"
jhash (0x5D0FE25B)
arguments {
Player "player" [=[ {} ]=],
}
ns "PLAYER"
returns "void"
doc [[!
```
NativeDB Added Parameter 2: Any p1
```
]]
native "_DISABLE_ROCKSTAR_EDITOR_CAMERA_CHANGES"
hash "0xAF66DCEE6609B148"
alias "0xAF66DCEE6609B148"
ns "RECORDING"
returns "void"
doc [[!
This will disable the ability to make camera changes in R\* Editor.
]]
native "_IS_RECORDING"
hash "0x1897CA71995A90B4"
ns "RECORDING"
returns "BOOL"
doc [[!
Checks if you're recording.
Whether recording is currently running, true when you start recording (F1) or turn on action replay (F2)
]]
native "_SAVE_RECORDING_CLIP"
hash "0x644546EC5287471B"
alias "0x644546EC5287471B"
ns "RECORDING"
returns "BOOL"
doc [[!
]]
native "_START_RECORDING"
hash "0xC3AC2FFF9612AC81"
arguments {
int "mode" [=[ {} ]=],
}
alias "0xC3AC2FFF9612AC81"
ns "RECORDING"
returns "void"
doc [[!
Starts recording a replay.\
If already recording a replay, does nothing.
0 turns on action replay, 1 starts recording
]]
native "_STOP_RECORDING_AND_DISCARD_CLIP"
hash "0x88BB3507ED41A240"
alias "0x88BB3507ED41A240"
ns "RECORDING"
returns "void"
doc [[!
Stops recording and discards the recorded clip.
]]
native "_STOP_RECORDING_AND_SAVE_CLIP"
hash "0x071A5197D6AFC8B3"
alias "_STOP_RECORDING"
ns "RECORDING"
returns "void"
doc [[!
Stops recording and saves the recorded clip.
]]
native "_STOP_RECORDING_THIS_FRAME"
hash "0xEB2D525B57F42B40"
alias "0xEB2D525B57F42B40"
ns "RECORDING"
returns "void"
doc [[!
Disable recording for this frame only.
]]
native "0x13B350B8AD0EEE10"
hash "0x13B350B8AD0EEE10"
ns "RECORDING"
returns "void"
doc [[!
]]
native "0x208784099002BC30"
hash "0x208784099002BC30"
arguments {
charPtr "missionNameLabel" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "RECORDING"
returns "void"
doc [[!
```
-This function appears to be deprecated/ unused. Tracing the call internally leads to a _nullsub -
first one seems to be a string of a mission name, second one seems to be a bool/toggle
p1 was always 0.
```
]]
native "0x293220DA1B46CEBC"
hash "0x293220DA1B46CEBC"
arguments {
float "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
int "p2" [=[ {} ]=],
}
ns "RECORDING"
returns "void"
doc [[!
]]
native "0x33D47E85B476ABCD"
hash "0x33D47E85B476ABCD"
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "RECORDING"
returns "BOOL"
doc [[!
]]
native "0x4282E08174868BE3"
hash "0x4282E08174868BE3"
ns "RECORDING"
returns "Any"
doc [[!
]]
native "0x48621C9FCA3EBD28"
hash "0x48621C9FCA3EBD28"
arguments {
int "p0" [=[ {} ]=],
}
ns "RECORDING"
returns "void"
doc [[!
]]
native "0x66972397E0757E7A"
hash "0x66972397E0757E7A"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
ns "RECORDING"
returns "void"
doc [[!
**This native does absolutely nothing, just a nullsub**
]]
native "0x81CBAE94390F9F89"
hash "0x81CBAE94390F9F89"
ns "RECORDING"
returns "void"
doc [[!
]]
native "0xDF4B952F7D381B95"
hash "0xDF4B952F7D381B95"
ns "RECORDING"
returns "Any"
doc [[!
]]
native "0xF854439EFBB3B583"
hash "0xF854439EFBB3B583"
ns "RECORDING"
returns "void"
doc [[!
]]
native "_ACTIVATE_ROCKSTAR_EDITOR"
hash "0x49DA8145672B2725"
alias "0x49DA8145672B2725"
ns "REPLAY"
returns "void"
doc [[!
Please note that you will need to call DO_SCREEN_FADE_IN after exiting the Rockstar Editor when you call this.
```
NativeDB Added Parameter 1: int p0
```
]]
native "_IS_INTERIOR_RENDERING_DISABLED"
hash "0x95AB8B5C992C7B58"
ns "REPLAY"
returns "BOOL"
doc [[!
```
Returns a bool if interior rendering is disabled, if yes, all "normal" rendered interiors are invisible
```
]]
native "_RESET_EDITOR_VALUES"
hash "0x3353D13F09307691"
alias "0x3353D13F09307691"
ns "REPLAY"
returns "void"
doc [[!
```
Sets (almost, not sure) all Rockstar Editor values (bIsRecording etc) to 0.
```
]]
native "0x5AD3932DAEB1E5D3"
hash "0x5AD3932DAEB1E5D3"
ns "REPLAY"
returns "void"
doc [[!
```
Disables some other rendering (internal)
```
]]
native "0x7E2BD3EF6C205F09"
hash "0x7E2BD3EF6C205F09"
arguments {
charPtr "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "REPLAY"
returns "void"
doc [[!
**This native does absolutely nothing, just a nullsub**
```
Something to do with phone cameras.
startup.c4:
void sub_2a3d() {
UNK2::_7E2BD3EF6C205F09("No_Filter", 1);
UNK2::_7E2BD3EF6C205F09("phone_cam1", 1);
UNK2::_7E2BD3EF6C205F09("phone_cam2", 1);
UNK2::_7E2BD3EF6C205F09("phone_cam3", 1);
UNK2::_7E2BD3EF6C205F09("phone_cam4", 1);
UNK2::_7E2BD3EF6C205F09("phone_cam5", 1);
UNK2::_7E2BD3EF6C205F09("phone_cam6", 1);
UNK2::_7E2BD3EF6C205F09("phone_cam7", 1);
UNK2::_7E2BD3EF6C205F09("phone_cam9", 1);
UNK2::_7E2BD3EF6C205F09("phone_cam12", 0);
}
```
]]
native "0xE058175F8EAFE79A"
hash "0xE058175F8EAFE79A"
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "REPLAY"
returns "void"
doc [[!
]]
native "0x690B76BD2763E068"
hash "0x690B76BD2763E068"
ns "SAVEMIGRATION"
returns "Any"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "0x84B418E93894AC1C"
hash "0x84B418E93894AC1C"
ns "SAVEMIGRATION"
returns "Any"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "0xE5E9746A66359F9D"
hash "0xE5E9746A66359F9D"
ns "SAVEMIGRATION"
returns "Any"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "BG_END_CONTEXT"
hash "0xDC2BACD920D0A0DD"
jhash (0x11F38FB3)
arguments {
charPtr "contextName" [=[ {} ]=],
}
ns "SCRIPT"
returns "void"
doc [[!
```
Deletes the given context from the background scripts context map.
NativeDB Introduced: v323
```
]]
native "BG_END_CONTEXT_HASH"
hash "0x107E5CC7CA942BC1"
jhash (0x3D981EBF)
arguments {
Hash "contextHash" [=[ {} ]=],
}
ns "SCRIPT"
returns "void"
doc [[!
```
Hashed version of 0xDC2BACD920D0A0DD.
NativeDB Introduced: v323
```
]]
native "BG_START_CONTEXT"
hash "0x9D5A25BADB742ACD"
jhash (0xF3F1D953)
arguments {
charPtr "contextName" [=[ {} ]=],
}
ns "SCRIPT"
returns "void"
doc [[!
```
Inserts the given context into the background scripts context map.
NativeDB Introduced: v323
```
]]
native "BG_START_CONTEXT_HASH"
hash "0x75B18E49607874C7"
jhash (0x67B23E17)
arguments {
Hash "contextHash" [=[ {} ]=],
}
ns "SCRIPT"
returns "void"
doc [[!
```
Hashed version of 0x9D5A25BADB742ACD.
NativeDB Introduced: v323
```
]]
native "DOES_SCRIPT_EXIST"
hash "0xFC04745FBE67C19A"
jhash (0xDEAB87AB)
arguments {
charPtr "scriptName" [=[ {} ]=],
}
ns "SCRIPT"
returns "BOOL"
doc [[!
]]
native "DOES_SCRIPT_WITH_NAME_HASH_EXIST"
hash "0xF86AA3C56BA31381"
jhash (0x19EAE282)
arguments {
Hash "scriptHash" [=[ {} ]=],
}
alias "0xF86AA3C56BA31381"
alias "_DOES_SCRIPT_WITH_NAME_HASH_EXIST"
ns "SCRIPT"
returns "BOOL"
doc [[!
]]
native "GET_EVENT_AT_INDEX"
hash "0xD8F66A3A60C62153"
jhash (0xB49C1442)
arguments {
int "eventGroup" [=[ {} ]=],
int "eventIndex" [=[ {} ]=],
}
ns "SCRIPT"
returns "int"
doc [[!
```
eventGroup: 0 = SCRIPT_EVENT_QUEUE_AI (CEventGroupScriptAI), 1 = SCRIPT_EVENT_QUEUE_NETWORK (CEventGroupScriptNetwork)
```
]]
native "GET_EVENT_DATA"
hash "0x2902843FCD2B2D79"
jhash (0x4280F92F)
arguments {
int "eventGroup" [=[ {} ]=],
int "eventIndex" [=[ {} ]=],
intPtr "eventData" [=[ {} ]=],
int "eventDataSize" [=[ {} ]=],
}
ns "SCRIPT"
returns "BOOL"
doc [[!
```
eventGroup: 0 = SCRIPT_EVENT_QUEUE_AI (CEventGroupScriptAI), 1 = SCRIPT_EVENT_QUEUE_NETWORK (CEventGroupScriptNetwork)
Note: eventDataSize is NOT the size in bytes, it is the size determined by the SIZE_OF operator (RAGE Script operator, not C/C++ sizeof). That is, the size in bytes divided by 8 (script variables are always 8-byte aligned!).
```
]]
native "GET_EVENT_EXISTS"
hash "0x936E6168A9BCEDB5"
jhash (0xA1B447B5)
arguments {
int "eventGroup" [=[ {} ]=],
int "eventIndex" [=[ {} ]=],
}
ns "SCRIPT"
returns "BOOL"
doc [[!
```
eventGroup: 0 = SCRIPT_EVENT_QUEUE_AI (CEventGroupScriptAI), 1 = SCRIPT_EVENT_QUEUE_NETWORK (CEventGroupScriptNetwork)
```
]]
native "GET_HASH_OF_THIS_SCRIPT_NAME"
hash "0x8A1C8B1738FFE87E"
jhash (0x2BEE1F45)
alias "_GET_THIS_SCRIPT_HASH"
ns "SCRIPT"
returns "Hash"
doc [[!
]]
native "GET_ID_OF_THIS_THREAD"
hash "0xC30338E8088E2E21"
jhash (0xDE524830)
ns "SCRIPT"
returns "int"
doc [[!
]]
native "GET_NO_LOADING_SCREEN"
hash "0x18C1270EA7F199BC"
jhash (0x27512BA0)
alias "_GET_NO_LOADING_SCREEN"
ns "SCRIPT"
returns "BOOL"
doc [[!
]]
native "GET_NUMBER_OF_EVENTS"
hash "0x5F92A689A06620AA"
jhash (0xA3525D60)
arguments {
int "eventGroup" [=[ {} ]=],
}
ns "SCRIPT"
returns "int"
doc [[!
```
eventGroup: 0 = SCRIPT_EVENT_QUEUE_AI (CEventGroupScriptAI), 1 = SCRIPT_EVENT_QUEUE_NETWORK (CEventGroupScriptNetwork)
```
]]
native "GET_THIS_SCRIPT_NAME"
hash "0x442E0A7EDE4A738A"
jhash (0xA40FD5D9)
ns "SCRIPT"
returns "charPtr"
doc [[!
]]
native "HAS_SCRIPT_LOADED"
hash "0xE6CC9F3BA0FB9EF1"
jhash (0x5D67F751)
arguments {
charPtr "scriptName" [=[ {} ]=],
}
ns "SCRIPT"
returns "BOOL"
doc [[!
Returns if a script has been loaded into the game. Used to see if a script was loaded after requesting.
]]
native "HAS_SCRIPT_WITH_NAME_HASH_LOADED"
hash "0x5F0F0C783EB16C04"
jhash (0x06674818)
arguments {
Hash "scriptHash" [=[ {} ]=],
}
alias "_HAS_STREAMED_SCRIPT_LOADED"
ns "SCRIPT"
returns "BOOL"
doc [[!
]]
native "IS_THREAD_ACTIVE"
hash "0x46E9AE36D8FA6417"
jhash (0x78D7A5A0)
arguments {
int "threadId" [=[ {} ]=],
}
ns "SCRIPT"
returns "BOOL"
doc [[!
]]
native "REQUEST_SCRIPT"
hash "0x6EB5F71AA68F2E8E"
jhash (0xE26B2666)
arguments {
charPtr "scriptName" [=[ {} ]=],
}
ns "SCRIPT"
returns "void"
doc [[!
]]
native "REQUEST_SCRIPT_WITH_NAME_HASH"
hash "0xD62A67D26D9653E6"
jhash (0x1C68D9DC)
arguments {
Hash "scriptHash" [=[ {} ]=],
}
alias "_REQUEST_STREAMED_SCRIPT"
ns "SCRIPT"
returns "void"
doc [[!
```
formerly _REQUEST_STREAMED_SCRIPT
```
]]
native "SCRIPT_THREAD_ITERATOR_GET_NEXT_THREAD_ID"
hash "0x30B4FA1C82DD4B9F"
jhash (0x1E28B28F)
alias "0x30B4FA1C82DD4B9F"
alias "_GET_ID_OF_NEXT_THREAD_IN_ENUMERATION"
ns "SCRIPT"
returns "int"
doc [[!
```
If the function returns 0, the end of the iteration has been reached.
```
]]
native "SCRIPT_THREAD_ITERATOR_RESET"
hash "0xDADFADA5A20143A8"
jhash (0xBB4E2F66)
alias "0xDADFADA5A20143A8"
alias "_BEGIN_ENUMERATING_THREADS"
ns "SCRIPT"
returns "void"
doc [[!
Starts a new iteration of the current threads.
Call this first, then SCRIPT_THREAD_ITERATOR_GET_NEXT_THREAD_ID (0x30B4FA1C82DD4B9F)
]]
native "SET_NO_LOADING_SCREEN"
hash "0x5262CC1995D07E09"
jhash (0xC8055034)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "SCRIPT"
returns "void"
doc [[!
]]
native "SET_SCRIPT_AS_NO_LONGER_NEEDED"
hash "0xC90D2DCACD56184C"
jhash (0x6FCB7795)
arguments {
charPtr "scriptName" [=[ {} ]=],
}
ns "SCRIPT"
returns "void"
doc [[!
]]
native "SET_SCRIPT_WITH_NAME_HASH_AS_NO_LONGER_NEEDED"
hash "0xC5BC038960E9DB27"
jhash (0x96C26F66)
arguments {
Hash "scriptHash" [=[ {} ]=],
}
alias "_SET_STREAMED_SCRIPT_AS_NO_LONGER_NEEDED"
ns "SCRIPT"
returns "void"
doc [[!
]]
native "SHUTDOWN_LOADING_SCREEN"
hash "0x078EBE9809CCD637"
jhash (0xA2826D17)
ns "SCRIPT"
returns "void"
doc [[!
]]
native "TERMINATE_THIS_THREAD"
hash "0x1090044AD1DA76FA"
jhash (0x3CD9CBB7)
ns "SCRIPT"
returns "void"
doc [[!
]]
native "TERMINATE_THREAD"
hash "0xC8B189ED9138BCD4"
jhash (0x253FD520)
arguments {
int "threadId" [=[ {} ]=],
}
ns "SCRIPT"
returns "void"
doc [[!
]]
native "TRIGGER_SCRIPT_EVENT"
hash "0x5AE99C571D5BBE5D"
jhash (0x54763B35)
arguments {
int "eventGroup" [=[ {} ]=],
intPtr "eventData" [=[ {} ]=],
int "eventDataSize" [=[ {} ]=],
int "playerBits" [=[ {} ]=],
}
ns "SCRIPT"
returns "void"
doc [[!
```
eventGroup: 0 = SCRIPT_EVENT_QUEUE_AI (CEventGroupScriptAI), 1 = SCRIPT_EVENT_QUEUE_NETWORK (CEventGroupScriptNetwork)
Note: eventDataSize is NOT the size in bytes, it is the size determined by the SIZE_OF operator (RAGE Script operator, not C/C++ sizeof). That is, the size in bytes divided by 8 (script variables are always 8-byte aligned!).
playerBits (also known as playersToBroadcastTo) is a bitset that indicates which players this event should be sent to. In order to send the event to specific players only, use (1 << playerIndex). Set all bits if it should be broadcast to all players.
```
]]
native "_GET_NAME_OF_THREAD"
hash "0x05A42BA9FC8DA96B"
jhash (0xBE7ACD89)
arguments {
int "threadId" [=[ {} ]=],
}
alias "_GET_THREAD_NAME"
ns "SCRIPT"
returns "charPtr"
doc [[!
]]
native "_GET_NUMBER_OF_REFERENCES_OF_SCRIPT_WITH_NAME_HASH"
hash "0x2C83A9DA6BFFC4F9"
jhash (0x029D3841)
arguments {
Hash "scriptHash" [=[ {} ]=],
}
alias "_GET_NUMBER_OF_INSTANCES_OF_STREAMED_SCRIPT"
alias "_GET_NUMBER_OF_INSTANCES_OF_SCRIPT_WITH_NAME_HASH"
ns "SCRIPT"
returns "int"
doc [[!
```
Gets the number of instances of the specified script is currently running.
Actually returns numRefs - 1.
if (program)
v3 = rage::scrProgram::GetNumRefs(program) - 1;
return v3;
```
]]
native "_LOCK_LOADING_SCREEN_BUTTONS"
hash "0xB1577667C3708F9B"
jhash (0xB03BCCDF)
alias "0xB1577667C3708F9B"
ns "SCRIPT"
returns "void"
doc [[!
Updates the display of the MP/SP loading buttons, and locks the state so that other options are not displayed or changed. This can only be done once.
]]
native "_TRIGGER_SCRIPT_EVENT_2"
hash "0xA40CC53DF8E50837"
arguments {
int "eventGroup" [=[ {"cs_type":"BOOL"} ]=],
intPtr "eventData" [=[ {} ]=],
int "eventDataSize" [=[ {} ]=],
int "playerBits" [=[ {} ]=],
}
alias "0xA40CC53DF8E50837"
ns "SCRIPT"
returns "void"
doc [[!
```
See TRIGGER_SCRIPT_EVENT
```
]]
native "0x0F6F1EBBC4E1D5E6"
hash "0x0F6F1EBBC4E1D5E6"
jhash (0xF8E5F73A)
arguments {
int "scriptIndex" [=[ {} ]=],
charPtr "p1" [=[ {} ]=],
}
ns "SCRIPT"
returns "BOOL"
doc [[!
```
BG_*
NativeDB Introduced: v323
```
]]
native "0x22E21FBCFC88C149"
hash "0x22E21FBCFC88C149"
jhash (0x682CB7E1)
arguments {
int "scriptIndex" [=[ {} ]=],
charPtr "p1" [=[ {} ]=],
}
ns "SCRIPT"
returns "int"
doc [[!
```
BG_*
NativeDB Introduced: v323
```
]]
native "0x760910B49D2B98EA"
hash "0x760910B49D2B98EA"
jhash (0x5C95B670)
ns "SCRIPT"
returns "void"
doc [[!
```
Sets bit 1 in GtaThread+0x154
BG_*
NativeDB Introduced: v323
```
]]
native "0x829CD22E043A2577"
hash "0x829CD22E043A2577"
jhash (0xC515E735)
arguments {
Hash "p0" [=[ {} ]=],
}
ns "SCRIPT"
returns "int"
doc [[!
```
BG_*
NativeDB Introduced: v323
```
]]
native "0x836B62713E0534CA"
hash "0x836B62713E0534CA"
jhash (0x22B9F132)
ns "SCRIPT"
returns "BOOL"
doc [[!
```
Returns true if bit 0 in GtaThread+0x154 is set.
BG_*
NativeDB Introduced: v323
```
]]
native "GET_SHAPE_TEST_RESULT"
hash "0x3D87450E15D98694"
jhash (0xF3C2875A)
arguments {
int "shapeTestHandle" [=[ {} ]=],
BOOLPtr "hit" [=[ {} ]=],
Vector3Ptr "endCoords" [=[ {} ]=],
Vector3Ptr "surfaceNormal" [=[ {} ]=],
EntityPtr "entityHit" [=[ {} ]=],
}
alias "_GET_RAYCAST_RESULT"
ns "SHAPETEST"
returns "int"
doc [[!
Returns the result of a shape test.
When used with an asynchronous shape test, this native should be looped until returning 0 or 2, after which the handle is invalidated.
Unless the return value is 2, the other return values are undefined.
A shape test handle.
Whether or not the shape test hit any collisions.
The resulting coordinates where the shape test hit a collision.
The surface normal of the hit position.
Any dynamic entity hit by the shape test.
`0` if the handle is invalid, `1` if the shape test is still pending, or `2` if the shape test has completed, and the handle should be invalidated.
]]
native "GET_SHAPE_TEST_RESULT_INCLUDING_MATERIAL"
hash "0x65287525D951F6BE"
jhash (0x4301E10C)
arguments {
int "shapeTestHandle" [=[ {} ]=],
BOOLPtr "hit" [=[ {} ]=],
Vector3Ptr "endCoords" [=[ {} ]=],
Vector3Ptr "surfaceNormal" [=[ {} ]=],
HashPtr "materialHash" [=[ {} ]=],
EntityPtr "entityHit" [=[ {} ]=],
}
alias "0x65287525D951F6BE"
alias "_GET_SHAPE_TEST_RESULT_EX"
ns "SHAPETEST"
returns "int"
doc [[!
Returns the result of a shape test, also returning the material of any touched surface.
When used with an asynchronous shape test, this native should be looped until returning 0 or 2, after which the handle is invalidated.
Unless the return value is 2, the other return values are undefined.
A shape test handle.
Whether or not the shape test hit any collisions.
The resulting coordinates where the shape test hit a collision.
The surface normal of the hit position.
hash of the hit material or surface type, see materialFX.dat
Any dynamic entity hit by the shape test.
`0` if the handle is invalid, `1` if the shape test is still pending, or `2` if the shape test has completed, and the handle should be invalidated.
]]
native "RELEASE_SCRIPT_GUID_FROM_ENTITY"
hash "0x2B3334BCA57CD799"
jhash (0xEC2AAF06)
arguments {
Entity "entity" [=[ {} ]=],
}
alias "0x2B3334BCA57CD799"
alias "_SHAPE_TEST_RESULT_ENTITY"
ns "SHAPETEST"
returns "void"
doc [[!
Invalidates the entity handle passed by removing the fwScriptGuid from the entity. This should be used when receiving an
ambient entity from shape testing natives, but can also be used for other natives returning an 'irrelevant' entity handle.
The entity handle to invalidate.
]]
native "START_EXPENSIVE_SYNCHRONOUS_SHAPE_TEST_LOS_PROBE"
hash "0x377906D8A31E5586"
jhash (0x8251485D)
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
int "flags" [=[ {} ]=],
Entity "entity" [=[ {} ]=],
int "p8" [=[ {} ]=],
}
alias "_CAST_RAY_POINT_TO_POINT"
alias "_START_SHAPE_TEST_RAY"
ns "SHAPETEST"
returns "int"
doc [[!
Does the same as [START_SHAPE_TEST_LOS_PROBE](#\_0x7EE9F5D83DD4F90E), except blocking until the shape test completes.
Use [START_SHAPE_TEST_LOS_PROBE](#\_0x7EE9F5D83DD4F90E) instead. Literally. Rockstar named this correctly: it's expensive, and it's synchronous.
Starting X coordinate.
Starting Y coordinate.
Starting Z coordinate.
Ending X coordinate.
Ending Y coordinate.
Ending Z coordinate.
See [START_SHAPE_TEST_LOS_PROBE](#\_0x7EE9F5D83DD4F90E).
An entity to ignore, or 0.
A bit mask with bits 1, 2 and/or 4, relating to collider types. 4 should usually be used.
A shape test handle.
]]
native "START_SHAPE_TEST_BOUND"
hash "0x37181417CE7C8900"
jhash (0x13BC46C0)
arguments {
Entity "entity" [=[ {} ]=],
int "flags1" [=[ {} ]=],
int "flags2" [=[ {} ]=],
}
alias "0x37181417CE7C8900"
ns "SHAPETEST"
returns "int"
doc [[!
See [`START_SHAPE_TEST_LOS_PROBE`](#\_0x7EE9F5D83DD4F90E) for flags.
]]
native "START_SHAPE_TEST_BOUNDING_BOX"
hash "0x052837721A854EC7"
jhash (0xCEEAD94B)
arguments {
Entity "entity" [=[ {} ]=],
int "flags1" [=[ {} ]=],
int "flags2" [=[ {} ]=],
}
alias "0x052837721A854EC7"
ns "SHAPETEST"
returns "int"
doc [[!
See [`START_SHAPE_TEST_LOS_PROBE`](#\_0x7EE9F5D83DD4F90E) for flags.
]]
native "START_SHAPE_TEST_BOX"
hash "0xFE466162C4401D18"
jhash (0x249BC876)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "rotX" [=[ {} ]=],
float "rotY" [=[ {} ]=],
float "rotZ" [=[ {} ]=],
int "p9" [=[ {} ]=],
int "flags" [=[ {} ]=],
Entity "entity" [=[ {} ]=],
int "p12" [=[ {} ]=],
}
alias "0xFE466162C4401D18"
ns "SHAPETEST"
returns "int"
doc [[!
For more information, see [`START_EXPENSIVE_SYNCHRONOUS_SHAPE_TEST_LOS_PROBE`](#\_0x377906D8A31E5586) and [`START_SHAPE_TEST_LOS_PROBE`](#\_0x7EE9F5D83DD4F90E).
Starting X coordinate.
Starting Y coordinate.
Starting Z coordinate.
Ending X coordinate.
Ending Y coordinate.
Ending Z coordinate.
Unknown, always 2 or 0
See [`START_SHAPE_TEST_LOS_PROBE`](#\_0x7EE9F5D83DD4F90E)
A bit mask with bits 1, 2, 4, or 7 relating to collider types. 4 and 7 are usually used.
]]
native "START_SHAPE_TEST_CAPSULE"
hash "0x28579D1B8F8AAC80"
jhash (0x591EA833)
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
float "radius" [=[ {} ]=],
int "flags" [=[ {} ]=],
Entity "entity" [=[ {} ]=],
int "p9" [=[ {} ]=],
}
alias "_CAST_3D_RAY_POINT_TO_POINT"
ns "SHAPETEST"
returns "int"
doc [[!
Raycast from point to point, where the ray has a radius.
Starting X coordinate.
Starting Y coordinate.
Starting Z coordinate.
Ending X coordinate.
Ending Y coordinate.
Ending Z coordinate.
See [`START_SHAPE_TEST_LOS_PROBE`](#\_0x7EE9F5D83DD4F90E)
Entity to ignore, or 0.
A bit mask with bits 1, 2, 4, or 7 relating to collider types. 4 and 7 are usually used.
]]
native "START_SHAPE_TEST_LOS_PROBE"
hash "0x7EE9F5D83DD4F90E"
jhash (0xEFAF4BA6)
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
int "traceFlags" [=[ {} ]=],
Entity "entity" [=[ {} ]=],
int "optionFlags" [=[ {} ]=],
}
alias "0x7EE9F5D83DD4F90E"
ns "SHAPETEST"
returns "int"
doc [[!
Asynchronously starts a line-of-sight (raycast) world probe shape test.
```cpp
enum eTraceFlags
{
None = 0,
IntersectWorld = 1,
IntersectVehicles = 2,
IntersectPeds = 4,
IntersectRagdolls = 8,
IntersectObjects = 16,
IntersectPickup = 32,
IntersectGlass = 64,
IntersectRiver = 128,
IntersectFoliage = 256,
IntersectEverything = 511
}
```
```cpp
enum eTraceOptionFlags
{
None = 0,
OptionIgnoreGlass = 1,
OptionIgnoreSeeThrough = 2,
OptionIgnoreNoCollision = 4,
OptionDefault = 7
}
```
NOTE: Raycasts that intersect with mission_entites (flag = 2) has limited range and will not register for far away entites. The range seems to be about 30 metres.
Use the handle with [GET_SHAPE_TEST_RESULT](#\_0x3D87450E15D98694) or [GET_SHAPE_TEST_RESULT_INCLUDING_MATERIAL](#\_0x65287525D951F6BE) until it returns 0 or 2.
Starting X coordinate.
Starting Y coordinate.
Starting Z coordinate.
Ending X coordinate.
Ending Y coordinate.
Ending Z coordinate.
Refer to `eTraceFlags`, this defines what the shape test will intersect with
An entity to ignore, or 0.
Refer to `eTraceOptionFlags`, this defines additional options for the shape test
A shape test handle.
]]
native "START_SHAPE_TEST_SWEPT_SPHERE"
hash "0xE6AC6C45FBE83004"
jhash (0x4559460A)
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
float "radius" [=[ {} ]=],
int "flags" [=[ {} ]=],
Entity "entity" [=[ {} ]=],
int "p9" [=[ {} ]=],
}
alias "0xE6AC6C45FBE83004"
alias "_START_SHAPE_TEST_CAPSULE_2"
ns "SHAPETEST"
returns "int"
doc [[!
Performs the same type of trace as START_SHAPE_TEST_CAPSULE, but with some different hardcoded parameters.
Starting X coordinate.
Starting Y coordinate.
Starting Z coordinate.
Ending X coordinate.
Ending Y coordinate.
Ending Z coordinate.
See [`START_SHAPE_TEST_LOS_PROBE`](#\_0x7EE9F5D83DD4F90E)
An entity to ignore, or 0.
A bit mask with bits 1, 2, 4, or 7 relating to collider types. 4 and 7 are usually used.
]]
native "_START_SHAPE_TEST_SURROUNDING_COORDS"
hash "0xFF6BE494C7987F34"
arguments {
Vector3Ptr "pVec1" [=[ {} ]=],
Vector3Ptr "pVec2" [=[ {} ]=],
int "flag" [=[ {} ]=],
Entity "entity" [=[ {} ]=],
int "flag2" [=[ {} ]=],
}
alias "0xFF6BE494C7987F34"
ns "SHAPETEST"
returns "int"
doc [[!
Since it is only used in the PC version, likely some mouse-friendly shape test. Uses **in** vector arguments.
Asynchronous.
```
it returns a ShapeTest handle that can be used with GET_SHAPE_TEST_RESULT.
In its only usage in game scripts its called with flag set to 511, entity to player_ped_id and flag2 set to 7
```
See [`START_SHAPE_TEST_LOS_PROBE`](#\_0x7EE9F5D83DD4F90E) for flags.
]]
native "ACTIVATE_DAMAGE_TRACKER_ON_NETWORK_ID"
hash "0xD45B1FFCCD52FF19"
jhash (0x95D07BA5)
arguments {
int "netID" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "BAD_SPORT_PLAYER_LEFT_DETECTED"
hash "0xEC5E3AF5289DCA81"
jhash (0x4C2C6B6A)
arguments {
intPtr "networkHandle" [=[ {} ]=],
int "event" [=[ {} ]=],
int "amountReceived" [=[ {} ]=],
}
alias "0xEC5E3AF5289DCA81"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "CAN_REGISTER_MISSION_ENTITIES"
hash "0x69778E7564BADE6D"
jhash (0x83794008)
arguments {
int "ped_amt" [=[ {} ]=],
int "vehicle_amt" [=[ {} ]=],
int "object_amt" [=[ {} ]=],
int "pickup_amt" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "CAN_REGISTER_MISSION_OBJECTS"
hash "0x800DD4721A8B008B"
jhash (0x7F85DFDE)
arguments {
int "amount" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "CAN_REGISTER_MISSION_PEDS"
hash "0xBCBF4FEF9FA5D781"
jhash (0xCCAA5CE9)
arguments {
int "amount" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "CAN_REGISTER_MISSION_VEHICLES"
hash "0x7277F1F2E085EE74"
jhash (0x818B6830)
arguments {
int "amount" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "CLOUD_CHECK_AVAILABILITY"
hash "0x4F18196C8D38768D"
jhash (0xC38E9DB0)
alias "0x4F18196C8D38768D"
alias "_DOWNLOAD_CHECK"
ns "NETWORK"
returns "void"
doc [[!
```
Downloads prod.cloud.rockstargames.com/titles/gta5/[platform]/check.json
```
]]
native "CLOUD_DELETE_MEMBER_FILE"
hash "0xC64DED7EF0D2FE37"
jhash (0x2B7B57B3)
arguments {
charPtr "p0" [=[ {} ]=],
}
alias "0xC64DED7EF0D2FE37"
ns "NETWORK"
returns "int"
doc [[!
]]
native "CLOUD_DID_REQUEST_SUCCEED"
hash "0x3A3D5568AF297CD5"
jhash (0x9B9AFFF1)
arguments {
int "handle" [=[ {} ]=],
}
alias "0x3A3D5568AF297CD5"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "CLOUD_GET_AVAILABILITY_CHECK_RESULT"
hash "0x0B0CC10720653F3B"
jhash (0x9262744C)
alias "NETWORK_ENABLE_MOTION_DRUGGED"
alias "0x0B0CC10720653F3B"
ns "NETWORK"
annotations [=[ {"cs_type":"int"} ]=]
returns "BOOL"
doc [[!
]]
native "CLOUD_HAS_REQUEST_COMPLETED"
hash "0x4C61B39930D045DA"
jhash (0xBAF52DD8)
arguments {
int "handle" [=[ {} ]=],
}
alias "0x4C61B39930D045DA"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "CLOUD_IS_CHECKING_AVAILABILITY"
hash "0xC7ABAC5DE675EE3B"
jhash (0x32A4EB22)
alias "0xC7ABAC5DE675EE3B"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "CONVERT_POSIX_TIME"
hash "0xAC97AF97FA68E5D5"
jhash (0xBB7CCE49)
arguments {
int "posixTime" [=[ {} ]=],
AnyPtr "timeStructure" [=[ {} ]=],
}
alias "_GET_DATE_AND_TIME_FROM_UNIX_EPOCH"
ns "NETWORK"
returns "void"
doc [[!
```
Takes the specified time and writes it to the structure specified in the second argument.
struct date_time
{
alignas(8) int year;
alignas(8) int month;
alignas(8) int day;
alignas(8) int hour;
alignas(8) int minute;
alignas(8) int second;
};
```
]]
native "FADE_OUT_LOCAL_PLAYER"
hash "0x416DBD4CD6ED8DD2"
jhash (0x8FA7CEBD)
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
```
Hardcoded to not work in SP.
```
]]
native "FILLOUT_PM_PLAYER_LIST"
hash "0xCBBD7C4991B64809"
jhash (0xCE40F423)
arguments {
intPtr "networkHandle" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "FILLOUT_PM_PLAYER_LIST_WITH_NAMES"
hash "0x716B6DB9D1886106"
jhash (0xB8DF604E)
arguments {
AnyPtr "p0" [=[ {} ]=],
AnyPtr "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "GET_CLOUD_TIME_AS_INT"
hash "0x9A73240B49945C76"
jhash (0xF2FDF2E0)
alias "0x9A73240B49945C76"
ns "NETWORK"
returns "int"
doc [[!
Returns POSIX timestamp.
Renamed from `_GET_POSIX_TIME` to `GET_CLOUD_TIME_AS_INT` because of conflicting native names ([`0xDA488F299A5B164E`](#\_0xDA488F299A5B164E))
An int representing the cloud time.
]]
native "GET_COMMERCE_ITEM_CAT"
hash "0x6F44CBF56D79FAC0"
jhash (0x16E53875)
arguments {
int "index" [=[ {} ]=],
int "index2" [=[ {} ]=],
}
alias "0x6F44CBF56D79FAC0"
ns "NETWORK"
returns "charPtr"
doc [[!
```
index2 is unused
```
]]
native "GET_COMMERCE_ITEM_ID"
hash "0x662635855957C411"
jhash (0x4ACF110C)
arguments {
int "index" [=[ {} ]=],
}
alias "0x662635855957C411"
ns "NETWORK"
returns "charPtr"
doc [[!
]]
native "GET_COMMERCE_ITEM_NAME"
hash "0xB4271092CA7EDF48"
jhash (0x1AA3A0D5)
arguments {
int "index" [=[ {} ]=],
}
alias "0xB4271092CA7EDF48"
ns "NETWORK"
returns "charPtr"
doc [[!
]]
native "GET_COMMERCE_ITEM_NUM_CATS"
hash "0x2A7776C709904AB0"
jhash (0x1CF89DA5)
arguments {
int "index" [=[ {} ]=],
}
alias "0x2A7776C709904AB0"
ns "NETWORK"
returns "int"
doc [[!
]]
native "GET_COMMERCE_ITEM_TEXTURENAME"
hash "0x722F5D28B61C5EA8"
jhash (0x44A58B0A)
arguments {
int "index" [=[ {} ]=],
}
alias "0x722F5D28B61C5EA8"
ns "NETWORK"
returns "charPtr"
doc [[!
```
NativeDB Added Parameter 3: int p2
```
]]
native "GET_COMMERCE_PRODUCT_PRICE"
hash "0xCA94551B50B4932C"
jhash (0x37877757)
arguments {
int "index" [=[ {} ]=],
}
alias "0xCA94551B50B4932C"
ns "NETWORK"
annotations [=[ {"cs_type":"Any"} ]=]
returns "charPtr"
doc [[!
]]
native "GET_MAX_NUM_NETWORK_OBJECTS"
hash "0xC7BE335216B5EC7C"
jhash (0x8687E285)
alias "0xC7BE335216B5EC7C"
ns "NETWORK"
returns "int"
doc [[!
]]
native "GET_MAX_NUM_NETWORK_PEDS"
hash "0x0C1F7D49C39D2289"
jhash (0x744AC008)
alias "0x0C1F7D49C39D2289"
ns "NETWORK"
returns "int"
doc [[!
]]
native "GET_MAX_NUM_NETWORK_PICKUPS"
hash "0xA72835064DD63E4C"
jhash (0x6A036061)
alias "0xA72835064DD63E4C"
ns "NETWORK"
returns "int"
doc [[!
]]
native "GET_MAX_NUM_NETWORK_VEHICLES"
hash "0x0AFCE529F69B21FF"
jhash (0xC3A12135)
alias "0x0AFCE529F69B21FF"
ns "NETWORK"
returns "int"
doc [[!
]]
native "GET_NETWORK_TIME"
hash "0x7A5487FE9FAA6B48"
jhash (0x998103C2)
ns "NETWORK"
returns "int"
doc [[!
Returns the network time this tick, if you want a tick-agnostic version use [`GetNetworkTimeAccurate`](#\_0x89023FBBF9200E9F).
]]
native "GET_NETWORK_TIME_ACCURATE"
hash "0x89023FBBF9200E9F"
jhash (0x98AA48E5)
alias "0x89023FBBF9200E9F"
ns "NETWORK"
returns "int"
doc [[!
Returns the same value as [`GetNetworkTime`](#\_0x7A5487FE9FAA6B48) in freemode, but as opposed to `GetNetworkTime` it always gets the most recent time, instead of once per tick.
Could be used for benchmarking since it can return times in ticks.
Returns the network time as an integer
]]
native "GET_NUM_COMMERCE_ITEMS"
hash "0xF2EAC213D5EA0623"
jhash (0x965EA007)
alias "0xF2EAC213D5EA0623"
ns "NETWORK"
returns "int"
doc [[!
]]
native "GET_NUM_CREATED_MISSION_OBJECTS"
hash "0x12B6281B6C6706C0"
jhash (0x603FA104)
arguments {
BOOL "p0" [=[ {} ]=],
}
alias "0x12B6281B6C6706C0"
ns "NETWORK"
returns "int"
doc [[!
]]
native "GET_NUM_CREATED_MISSION_PEDS"
hash "0xCB215C4B56A7FAE7"
jhash (0xD8FEC4F8)
arguments {
BOOL "p0" [=[ {} ]=],
}
alias "0xCB215C4B56A7FAE7"
ns "NETWORK"
returns "int"
doc [[!
]]
native "GET_NUM_CREATED_MISSION_VEHICLES"
hash "0x0CD9AB83489430EA"
jhash (0x20527695)
arguments {
BOOL "p0" [=[ {} ]=],
}
alias "0x0CD9AB83489430EA"
ns "NETWORK"
returns "int"
doc [[!
]]
native "GET_NUM_RESERVED_MISSION_OBJECTS"
hash "0xAA81B5F10BC43AC2"
jhash (0x16A80CD6)
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "int"
doc [[!
```
p0 appears to be for MP
```
```
NativeDB Added Parameter 2: Any p1
```
]]
native "GET_NUM_RESERVED_MISSION_PEDS"
hash "0x1F13D5AE5CB17E17"
jhash (0x6C25975C)
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "int"
doc [[!
```
p0 appears to be for MP
```
```
NativeDB Added Parameter 2: Any p1
```
]]
native "GET_NUM_RESERVED_MISSION_VEHICLES"
hash "0xCF3A965906452031"
jhash (0xA9A308F3)
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "int"
doc [[!
```
p0 appears to be for MP
```
```
NativeDB Added Parameter 2: Any p1
```
]]
native "GET_STATUS_OF_TEXTURE_DOWNLOAD"
hash "0x8BD6C6DEA20E82C6"
jhash (0x03225BA3)
arguments {
int "p0" [=[ {} ]=],
}
alias "0x8BD6C6DEA20E82C6"
alias "_GET_STATUS_OF_TEXTURE_DOWNLOAD"
ns "NETWORK"
returns "int"
doc [[!
```
0 = succeeded
1 = pending
2 = failed
```
]]
native "GET_TIME_AS_STRING"
hash "0x9E23B1777A927DAD"
jhash (0x8218944E)
arguments {
int "time" [=[ {} ]=],
}
alias "_FORMAT_TIME"
ns "NETWORK"
returns "charPtr"
doc [[!
]]
native "GET_TIME_DIFFERENCE"
hash "0xA2C6FC031D46FFF0"
jhash (0x5666A837)
arguments {
int "timeA" [=[ {} ]=],
int "timeB" [=[ {} ]=],
}
ns "NETWORK"
returns "int"
doc [[!
```
Subtracts the second argument from the first.
```
]]
native "GET_TIME_OFFSET"
hash "0x017008CCDAD48503"
jhash (0x2E079AE6)
arguments {
int "timeA" [=[ {} ]=],
int "timeB" [=[ {} ]=],
}
ns "NETWORK"
returns "int"
doc [[!
```
Adds the first argument to the second.
```
]]
native "HAS_NETWORK_TIME_STARTED"
hash "0x46718ACEEDEAFC84"
jhash (0x4538C4A2)
alias "0x46718ACEEDEAFC84"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "IS_COMMERCE_DATA_VALID"
hash "0xEA14EEF5B7CD2C30"
jhash (0xEEFC8A55)
alias "0xEA14EEF5B7CD2C30"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "IS_COMMERCE_STORE_OPEN"
hash "0x2EAC52B4019E2782"
jhash (0x25E2DBA9)
alias "0x2EAC52B4019E2782"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "IS_DAMAGE_TRACKER_ACTIVE_ON_NETWORK_ID"
hash "0x6E192E33AD436366"
jhash (0x597063BA)
arguments {
int "netID" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "IS_NETWORK_ID_OWNED_BY_PARTICIPANT"
hash "0xA1607996431332DF"
jhash (0xEA5176C0)
arguments {
int "netId" [=[ {} ]=],
}
alias "0xA1607996431332DF"
alias "_NETWORK_CAN_NETWORK_ID_BE_SEEN"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "IS_PLAYER_IN_CUTSCENE"
hash "0xE73092F4157CD126"
jhash (0xE0A619BD)
arguments {
Player "player" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "IS_SPHERE_VISIBLE_TO_ANOTHER_MACHINE"
hash "0xD82CF8E64C8729D8"
jhash (0x23C5274E)
arguments {
float "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "IS_SPHERE_VISIBLE_TO_PLAYER"
hash "0xDC3A310219E5DA62"
jhash (0xE9FCFB32)
arguments {
Any "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
float "p4" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "IS_STORE_AVAILABLE_TO_USER"
hash "0x883D79C4071E18B3"
jhash (0xD32FA11F)
alias "0x883D79C4071E18B3"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "IS_TIME_EQUAL_TO"
hash "0xF5BC95857BD6D512"
jhash (0x8B4D1C06)
arguments {
int "timeA" [=[ {} ]=],
int "timeB" [=[ {} ]=],
}
alias "_ARE_INTEGERS_EQUAL"
ns "NETWORK"
returns "BOOL"
doc [[!
```
Returns true if the two times are equal; otherwise returns false.
```
]]
native "IS_TIME_LESS_THAN"
hash "0xCB2CF5148012C8D0"
jhash (0x50EF8FC6)
arguments {
int "timeA" [=[ {} ]=],
int "timeB" [=[ {} ]=],
}
alias "_SUBTRACT_B_FROM_A_AND_CHECK_IF_NEGATIVE"
ns "NETWORK"
returns "BOOL"
doc [[!
```
Subtracts the second argument from the first, then returns whether the result is negative.
```
]]
native "IS_TIME_MORE_THAN"
hash "0xDE350F8651E4346C"
jhash (0xBBB6DF61)
arguments {
int "timeA" [=[ {} ]=],
int "timeB" [=[ {} ]=],
}
alias "_SUBTRACT_A_FROM_B_AND_CHECK_IF_NEGATIVE"
ns "NETWORK"
returns "BOOL"
doc [[!
```
Subtracts the first argument from the second, then returns whether the result is negative.
```
]]
native "NET_TO_ENT"
hash "0xBFFEAB45A9A9094A"
jhash (0x5E149683)
arguments {
int "netHandle" [=[ {} ]=],
}
ns "NETWORK"
returns "Entity"
doc [[!
```
gets the entity id of a network id
```
]]
native "NET_TO_OBJ"
hash "0xD8515F5FEA14CB3F"
jhash (0x27AA14D8)
arguments {
int "netHandle" [=[ {} ]=],
}
ns "NETWORK"
returns "Object"
doc [[!
```
gets the object id of a network id
```
]]
native "NET_TO_PED"
hash "0xBDCD95FC216A8B3E"
jhash (0x87717DD4)
arguments {
int "netHandle" [=[ {} ]=],
}
ns "NETWORK"
returns "Ped"
doc [[!
```
gets the ped id of a network id
```
]]
native "NET_TO_VEH"
hash "0x367B936610BA360C"
jhash (0x7E02FAEA)
arguments {
int "netHandle" [=[ {} ]=],
}
ns "NETWORK"
returns "Vehicle"
doc [[!
]]
native "NETWORK_ACCEPT_PRESENCE_INVITE"
hash "0xFA91550DF9318B22"
jhash (0xE5DA4CED)
arguments {
Any "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_ACCESS_TUNABLE_BOOL"
hash "0xAA6A47A573ABB75A"
jhash (0x8A04E1FE)
arguments {
charPtr "tunableContext" [=[ {} ]=],
charPtr "tunableName" [=[ {} ]=],
}
alias "0xAA6A47A573ABB75A"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_ACCESS_TUNABLE_BOOL_HASH"
hash "0xEA16B69D93D71A45"
jhash (0x18867C61)
arguments {
Hash "tunableContext" [=[ {} ]=],
Hash "tunableName" [=[ {} ]=],
}
alias "0xEA16B69D93D71A45"
alias "_NETWORK_ACCESS_TUNABLE_BOOL_HASH"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_ACCESS_TUNABLE_FLOAT"
hash "0xE5608CA7BC163A5F"
jhash (0x41E8912A)
arguments {
charPtr "tunableContext" [=[ {} ]=],
charPtr "tunableName" [=[ {} ]=],
floatPtr "value" [=[ {} ]=],
}
alias "0xE5608CA7BC163A5F"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_ACCESS_TUNABLE_FLOAT_HASH"
hash "0x972BC203BBC4C4D5"
jhash (0x3972551F)
arguments {
Hash "tunableContext" [=[ {} ]=],
Hash "tunableName" [=[ {} ]=],
floatPtr "value" [=[ {} ]=],
}
alias "0x972BC203BBC4C4D5"
alias "_NETWORK_ACCESS_TUNABLE_FLOAT_HASH"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_ACCESS_TUNABLE_INT"
hash "0x8BE1146DFD5D4468"
jhash (0xE4B3726A)
arguments {
charPtr "tunableContext" [=[ {} ]=],
charPtr "tunableName" [=[ {} ]=],
intPtr "value" [=[ {} ]=],
}
alias "0x8BE1146DFD5D4468"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_ACCESS_TUNABLE_INT_HASH"
hash "0x40FCE03E50E8DBE8"
jhash (0xB2E83B75)
arguments {
Hash "tunableContext" [=[ {} ]=],
Hash "tunableName" [=[ {} ]=],
intPtr "value" [=[ {} ]=],
}
alias "0x40FCE03E50E8DBE8"
alias "_NETWORK_ACCESS_TUNABLE_INT_HASH"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_ACTION_FOLLOW_INVITE"
hash "0xC88156EBB786F8D5"
jhash (0xAB969F00)
alias "0xC88156EBB786F8D5"
ns "NETWORK"
returns "Any"
doc [[!
]]
native "NETWORK_ADD_ENTITY_ANGLED_AREA"
hash "0x376C6375BA60293A"
jhash (0xCD69BEA1)
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
float "width" [=[ {} ]=],
}
alias "0x376C6375BA60293A"
alias "_NETWORK_ADD_ENTITY_ANGLED_AREA"
ns "NETWORK"
returns "Any"
doc [[!
To remove, see: [`NETWORK_REMOVE_ENTITY_AREA`](#\_0x93CF869BAA0C4874).
See [`IS_POINT_IN_ANGLED_AREA`](#\_0x2A70BAE8883E4C81) for the definition of an angled area.
X dimension of the angled area 'origin'
Y dimension of the angled area 'origin'
Z dimension of the angled area 'origin'
X dimension of the angled area 'extent'
Y dimension of the angled area 'extent'
Z dimension of the angled area 'extent'
Width of the angled area
]]
native "NETWORK_ADD_ENTITY_AREA"
hash "0x494C8FB299290269"
jhash (0x51030E5B)
arguments {
float "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
float "p4" [=[ {} ]=],
float "p5" [=[ {} ]=],
}
ns "NETWORK"
returns "Any"
doc [[!
]]
native "NETWORK_ADD_ENTITY_DISPLAYED_BOUNDARIES"
hash "0x25B99872D588A101"
jhash (0x4C2C2B12)
arguments {
float "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
float "p4" [=[ {} ]=],
float "p5" [=[ {} ]=],
}
alias "0x25B99872D588A101"
ns "NETWORK"
returns "Any"
doc [[!
]]
native "NETWORK_ADD_ENTITY_TO_SYNCHRONISED_SCENE"
hash "0xF2404D68CBC855FA"
jhash (0x10DD636C)
arguments {
Entity "entity" [=[ {} ]=],
int "netScene" [=[ {} ]=],
charPtr "animDict" [=[ {} ]=],
charPtr "animName" [=[ {} ]=],
float "blendIn" [=[ {} ]=],
float "blendOut" [=[ {} ]=],
int "flag" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
Adds an entity to a network synchronised scene.
Entity handle to add to the scene.
Which network scene to add this entity to (Returned by [`NETWORK_CREATE_SYNCHRONISED_SCENE`](#\_0x7CD6BC4C2BBDD526))
Animation dictionary to play on this entity.
Animation clip from the dictionary to play on this entity.
Blend in speed of the animation. Default is `8.0`.
Blend out speed of the animation. Default is `-8.0`.
Synchronized scene flags. See [`NETWORK_ADD_PED_TO_SYNCHRONISED_SCENE`](#\_0x742A637471BCECD9) for more info.
]]
native "NETWORK_ADD_FOLLOWERS"
hash "0x236406F60CF216D6"
jhash (0x0EC62629)
arguments {
intPtr "p0" [=[ {} ]=],
int "p1" [=[ {} ]=],
}
alias "0x236406F60CF216D6"
ns "NETWORK"
returns "void"
doc [[!
```
..
```
]]
native "NETWORK_ADD_FRIEND"
hash "0x8E02D73914064223"
jhash (0x20E5B3EE)
arguments {
intPtr "networkHandle" [=[ {} ]=],
charPtr "message" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_ADD_MAP_ENTITY_TO_SYNCHRONISED_SCENE"
hash "0x45F35C0EDC33B03B"
arguments {
int "netScene" [=[ {} ]=],
Hash "modelHash" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
charPtr "animDict" [=[ {"cs_type":"float"} ]=],
charPtr "animName" [=[ {} ]=],
float "blendInSpeed" [=[ {} ]=],
float "blendOutSpeed" [=[ {} ]=],
int "flags" [=[ {} ]=],
}
alias "0x45F35C0EDC33B03B"
ns "NETWORK"
returns "void"
doc [[!
Adds a map entity to a network synchronized scene. This native function is utilized only once as of game build 2944 within the casino_slots script.
Please note that it's only possible to add a single map entity to synchronised scenes.
It's advisable to initially locate the object and retrieve its actual coordinates using [`GET_CLOSEST_OBJECT_OF_TYPE`](#\_0xE143FA2249364369).
```
NativeDB Introduced: v1734
```
Net scene ID returned by [`NETWORK_CREATE_SYNCHRONISED_SCENE`](#\_0x7CD6BC4C2BBDD526)
Model hash of the object the script should look for.
Object X coord.
Object Y coord.
Object Z coord.
Anim dictionary to play on this object.
Anim name to play on this object.
Float representing how quickly the animation should be blended into. Default is `8.0`.
Float representing how quickly the animation should be blended out of. Default is `-8.0`
See [`NETWORK_ADD_PED_TO_SYNCHRONISED_SCENE`](#\_0x742A637471BCECD9).
]]
native "NETWORK_ADD_PED_TO_SYNCHRONISED_SCENE"
hash "0x742A637471BCECD9"
jhash (0xB386713E)
arguments {
Ped "ped" [=[ {} ]=],
int "netScene" [=[ {} ]=],
charPtr "animDict" [=[ {} ]=],
charPtr "animClip" [=[ {} ]=],
float "blendInSpeed" [=[ {} ]=],
float "blendOutSpeed" [=[ {} ]=],
int "syncedSceneFlags" [=[ {} ]=],
int "ragdollFlags" [=[ {} ]=],
float "moverBlendInDelta" [=[ {} ]=],
int "ikFlags" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
Adds a ped to a networked synchronised scene.
Synchronized scene playback flags (Also works in other `NETWORK_ADD_*_TO_SYNCHRONISED_SCENE` natives):
| Value | Name | Notes |
| :-------: | :---------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------: |
| `0` | None | No flag set. |
| `1` | USE_PHYSICS | Allows the ped to have physics during the scene. |
| `2` | TAG_SYNC_OUT | The task will do a tag synchronized blend out with the movement behaviour of the ped. |
| `4` | DONT_INTERRUPT | The scene will not be interrupted by external events. |
| `8` | ON_ABORT_STOP_SCENE | The scene will be stopped if the scripted task is aborted. |
| `16` | ABORT_ON_WEAPON_DAMAGE | The scene will be stopped if the ped is damaged by a weapon. |
| `32` | BLOCK_MOVER_UPDATE | The task will not update the mover. |
| `64` | LOOP_WITHIN_SCENE | Animations within this scene will be looped until the scene is finished. |
| `128` | PRESERVE_VELOCITY | The task will keep it's velocity when the scene is cleaned up/stopped. Do note that the `USE_PHYSICS` flag must also be present. |
| `256` | EXPAND_PED_CAPSULE_FROM_SKELETON | The task will apply the `ExpandPedCapsuleFromSkeleton` reset flag to the ped (See [`SET_PED_RESET_FLAG`](#\_0xC1E8A365BF3B29F2)). |
| `512` | ACTIVATE_RAGDOLL_ON_COLLISION | The ped will be ragdoll if it comes in contact with an object. |
| `1024` | HIDE_WEAPON | The ped's current weapon will be hidden during the scene. |
| `2048` | ABORT_ON_DEATH | The synchronised scene will be aborted if the ped dies. |
| `4096` | VEHICLE_ABORT_ON_LARGE_IMPACT | If the scene is running on a vehicle, then it will be aborted if the vehicle takes a heavy collision with another vehicle. |
| `8192` | VEHICLE_ALLOW_PLAYER_ENTRY | If the scene is on a vehicle, it allows players to enter it. |
| `16384` | PROCESS_ATTACHMENTS_ON_START | Attachments will be processed at the start of the scene. |
| `32768` | NET_ON_EARLY_NON_PED_STOP_RETURN_TO_START | A non-ped entity will be returned to their starting position if the scene finishes early. |
| `65536` | SET_PED_OUT_OF_VEHICLE_AT_START | If the ped is in a vehicle when the scene starts, it will be set out of the vehicle. |
| `131072` | NET_DISREGARD_ATTACHMENT_CHECKS | Attachment checks will be disregarded when the scene is running. |
These flags can be combined with the `|` operator.
Ped handle to add.
Network scene handle (Returned by [`NETWORK_CREATE_SYNCHRONISED_SCENE`](#\_0x7CD6BC4C2BBDD526))
Dictionary of the animation that the ped will play. Network synchronised scenes don't require the animation dictionary to be loaded, unlike [`TASK_SYNCHRONIZED_SCENE`](#\_0xEEA929141F699854).
Clip name from the anim dictionary that the ped will play.
Blend in speed. The lower the value, the slower the blend in speed is. Default is `8.0`.
Blend out speed. This should be the negative value of `blendInSpeed`. Default is `-8.0`.
Synchronized scene flags bit field from the above table.
Ragdoll blocking flags. Default is `0`.
Determines the rate at which the mover blends in to the scene. Useful for ensuring a seamless entry onto a synchronized scene. Default is `1000.0`.
Inverse kinematics flags. Default is `0`.
]]
native "NETWORK_ADD_PED_TO_SYNCHRONISED_SCENE_WITH_IK"
hash "0xA5EAFE473E45C442"
arguments {
Ped "ped" [=[ {"cs_type":"Any"} ]=],
int "netSceneID" [=[ {} ]=],
charPtr "animDict" [=[ {"cs_type":"Any"} ]=],
charPtr "animClip" [=[ {"cs_type":"Any"} ]=],
float "blendIn" [=[ {"cs_type":"Any"} ]=],
float "blendOut" [=[ {"cs_type":"Any"} ]=],
int "sceneFlags" [=[ {} ]=],
int "ragdollFlags" [=[ {} ]=],
float "moverBlendInDelta" [=[ {"cs_type":"Any"} ]=],
int "ikFlags" [=[ {} ]=],
}
alias "0xA5EAFE473E45C442"
ns "NETWORK"
returns "void"
doc [[!
Adds a ped to a networked synchronized scene but extends [`NETWORK_ADD_PED_TO_SYNCHRONISED_SCENE`](#\_0x742A637471BCECD9) to support IK flags.
There is barely any difference between this and [`NETWORK_ADD_PED_TO_SYNCHRONISED_SCENE`](#\_0x742A637471BCECD9).
```
NativeDB Introduced: v1290
```
Index of the ped to add to the scene.
Network scene ID returned by [`NETWORK_CREATE_SYNCHRONISED_SCENE`](#\_0x7CD6BC4C2BBDD526).
Which anim dictionary to use on this ped.
Which clip from the anim dictionary to use on this ped.
Blend in speed of the animation. Default is `8.0`.
Blend out speed of the animation. Default is `-8.0`.
Synchronized scene flags. See [`NETWORK_ADD_PED_TO_SYNCHRONISED_SCENE`](#\_0x742A637471BCECD9).
Ragdoll blocking flags. Default is 0.
Determines the rate at which the mover blends in to the scene. Useful for ensuring a seamless entry onto a synchronized scene. Default is `1000.0`.
Inverse kinematics flags. Default is `0`.
]]
native "NETWORK_ADD_SYNCHRONISED_SCENE_CAMERA"
hash "0xCF8BD3B0BD6D42D7"
jhash (0xBFFE8B5C)
arguments {
int "netScene" [=[ {} ]=],
charPtr "animDict" [=[ {} ]=],
charPtr "animName" [=[ {} ]=],
}
alias "0xCF8BD3B0BD6D42D7"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_ALLOW_REMOTE_ATTACHMENT_MODIFICATION"
hash "0x267C78C60E806B9A"
jhash (0xBB2D33D3)
arguments {
Entity "entity" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x267C78C60E806B9A"
alias "_NETWORK_ALLOW_LOCAL_ENTITY_ATTACHMENT"
ns "NETWORK"
returns "void"
doc [[!
Allows scripts to use attachment commands on entities (eg. [`ATTACH_ENTITY_TO_ENTITY`](#\_0x6B9BBD38AB0796DF)) that are not controlled by the client.
**Note:** This is only local and does not affect entities on other machines. This is used by the ferris wheel script to sync players on carts.
Entity handle to allow remote attachment for.
true/false.
]]
native "NETWORK_AM_I_BLOCKED_BY_GAMER"
hash "0x15337C7C268A27B2"
jhash (0xD19B312C)
arguments {
AnyPtr "networkHandle" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_AM_I_BLOCKED_BY_PLAYER"
hash "0x87F395D957D4353D"
jhash (0x953EF45E)
arguments {
Player "player" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_AM_I_MUTED_BY_GAMER"
hash "0xDF02A2C93F1F26DA"
jhash (0x7685B333)
arguments {
AnyPtr "networkHandle" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_AM_I_MUTED_BY_PLAYER"
hash "0x9D6981DFC91A8604"
jhash (0xE128F2B0)
arguments {
Player "player" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_APPLY_CACHED_PLAYER_HEAD_BLEND_DATA"
hash "0x99B72C7ABDE5C910"
jhash (0x99F58A07)
arguments {
Ped "ped" [=[ {} ]=],
Player "player" [=[ {} ]=],
}
alias "0x99B72C7ABDE5C910"
alias "_NETWORK_COPY_PED_BLEND_DATA"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_APPLY_PED_SCAR_DATA"
hash "0xE66C690248F11150"
jhash (0x4818ACD0)
arguments {
Ped "ped" [=[ {} ]=],
int "p1" [=[ {} ]=],
}
alias "0xE66C690248F11150"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_APPLY_TRANSITION_PARAMETER"
hash "0x521638ADA1BA0D18"
jhash (0xCEE79711)
arguments {
int "p0" [=[ {} ]=],
int "p1" [=[ {} ]=],
}
alias "0x521638ADA1BA0D18"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_APPLY_TRANSITION_PARAMETER_STRING"
hash "0xEBEFC2E77084F599"
jhash (0xE0C28DB5)
arguments {
int "p0" [=[ {} ]=],
charPtr "string" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
alias "0xEBEFC2E77084F599"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_APPLY_VOICE_PROXIMITY_OVERRIDE"
hash "0xDBD2056652689917"
jhash (0xF1E84832)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
alias "IS_NETWORK_VEHICLE_BEEN_DAMAGED_BY_ANY_OBJECT"
ns "NETWORK"
annotations [=[ {"cs_type":"BOOL"} ]=]
returns "void"
doc [[!
]]
native "NETWORK_ARE_HANDLES_THE_SAME"
hash "0x57DBA049E110F217"
jhash (0x45975AE3)
arguments {
intPtr "netHandle1" [=[ {} ]=],
intPtr "netHandle2" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_ARE_SOCIAL_CLUB_POLICIES_CURRENT"
hash "0xBA9775570DB788CF"
jhash (0x358D1D77)
alias "0xBA9775570DB788CF"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_ARE_TRANSITION_DETAILS_VALID"
hash "0x2615AA2A695930C1"
jhash (0xCDEBCCE7)
arguments {
Any "p0" [=[ {} ]=],
}
alias "0x2615AA2A695930C1"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_ATTACH_SYNCHRONISED_SCENE_TO_ENTITY"
hash "0x478DCBD2A98B705A"
jhash (0x3FE5B222)
arguments {
int "netScene" [=[ {} ]=],
Entity "entity" [=[ {} ]=],
int "bone" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_BAIL"
hash "0x95914459A87EBA28"
jhash (0x87D79A04)
ns "NETWORK"
returns "void"
doc [[!
```
NativeDB Added Parameter 1: int p0
NativeDB Added Parameter 2: int p1
NativeDB Added Parameter 3: int p2
```
]]
native "NETWORK_BAIL_TRANSITION"
hash "0xEAA572036990CD1B"
jhash (0xB59D74CA)
ns "NETWORK"
returns "void"
doc [[!
```
NativeDB Added Parameter 1: int p0
NativeDB Added Parameter 2: int p1
NativeDB Added Parameter 3: int p2
```
]]
native "NETWORK_BLOCK_INVITES"
hash "0x34F9E9049454A7A0"
jhash (0xD156FD1A)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_BLOCK_JOIN_QUEUE_INVITES"
hash "0xCFEB8AF24FC1D0BB"
jhash (0x8AB4890B)
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0xCFEB8AF24FC1D0BB"
alias "_NETWORK_BLOCK_INVITES_2"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_CACHE_LOCAL_PLAYER_HEAD_BLEND_DATA"
hash "0xBD0BE0BFC927EAC1"
jhash (0x94AB35A9)
alias "0xBD0BE0BFC927EAC1"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_CAN_ACCESS_MULTIPLAYER"
hash "0xAF50DA1A3F8B1BA4"
jhash (0xA520B982)
arguments {
intPtr "loadingState" [=[ {} ]=],
}
alias "0xAF50DA1A3F8B1BA4"
ns "NETWORK"
returns "BOOL"
doc [[!
```
11 - Need to download tunables.
12 - Need to download background script.
Returns 1 if the multiplayer is loaded, otherwhise 0.
```
]]
native "NETWORK_CAN_BAIL"
hash "0x580CE4438479CC61"
jhash (0x60E1FEDF)
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_CAN_COMMUNICATE_WITH_GAMER"
hash "0xA150A4F065806B1F"
jhash (0xD05EB7F6)
arguments {
intPtr "networkHandle" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_CAN_ENTER_MULTIPLAYER"
hash "0x7E782A910C362C25"
jhash (0x4A23B9C9)
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_CAN_SESSION_END"
hash "0x4EEBC3694E49C572"
jhash (0xE1FCCDBA)
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_CAN_SET_WAYPOINT"
hash "0xC927EC229934AF60"
jhash (0x009E68F3)
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_CANCEL_RESPAWN_SEARCH"
hash "0xFB8F2A6F3DF08CBE"
jhash (0x44BFB619)
alias "0xFB8F2A6F3DF08CBE"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_CHANGE_TRANSITION_SLOTS"
hash "0xEEEDA5E6D7080987"
jhash (0x1E5F6AEF)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
alias "0xEEEDA5E6D7080987"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_CHECK_COMMUNICATION_PRIVILEGES"
hash "0x83F28CE49FBBFFBA"
jhash (0xA79E5B05)
arguments {
int "p0" [=[ {} ]=],
int "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
alias "0x83F28CE49FBBFFBA"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_CHECK_DATA_MANAGER_SUCCEEDED_FOR_HANDLE"
hash "0x44B37CDCAE765AAE"
jhash (0x13301529)
arguments {
int "friendDataIndex" [=[ {} ]=],
intPtr "networkHandle" [=[ {} ]=],
}
alias "0x44B37CDCAE765AAE"
ns "NETWORK"
returns "BOOL"
doc [[!
Checks if the friendDataIndex in the friend data manager contains the data for the specified networkHandle
]]
native "NETWORK_CHECK_USER_CONTENT_PRIVILEGES"
hash "0x595F028698072DD9"
jhash (0xBB54AA3D)
arguments {
int "p0" [=[ {} ]=],
int "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
alias "0x595F028698072DD9"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_CLAN_ANY_DOWNLOAD_MEMBERSHIP_PENDING"
hash "0xB3F64A6A91432477"
jhash (0x83ED8E08)
alias "0xB3F64A6A91432477"
alias "_NETWORK_IS_CLAN_MEMBERSHIP_FINISHED_DOWNLOADING"
ns "NETWORK"
returns "BOOL"
doc [[!
True if there are any pending downloads, false otherwise.
]]
native "NETWORK_CLAN_DOWNLOAD_MEMBERSHIP"
hash "0xA989044E70010ABE"
jhash (0x8E8CB520)
arguments {
intPtr "networkHandle" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_CLAN_DOWNLOAD_MEMBERSHIP_PENDING"
hash "0x5B9E023DC6EBEDC0"
jhash (0x1FDB590F)
arguments {
AnyPtr "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_CLAN_GET_EMBLEM_TXD_NAME"
hash "0x5835D9CD92E83184"
jhash (0xBA672146)
arguments {
AnyPtr "netHandle" [=[ {} ]=],
charPtr "txdName" [=[ {"cs_type":"AnyPtr"} ]=],
}
alias "0x5835D9CD92E83184"
alias "_NETWORK_GET_PLAYER_CREW_EMBLEM_TXD_NAME"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_CLAN_GET_LOCAL_MEMBERSHIPS_COUNT"
hash "0x1F471B79ACC90BEF"
jhash (0x807B3450)
alias "0x1F471B79ACC90BEF"
alias "_GET_NUM_MEMBERSHIP_DESC"
alias "_NETWORK_CLAN_GET_NUM_MEMBERSHIP_DESC"
ns "NETWORK"
returns "int"
doc [[!
]]
native "NETWORK_CLAN_GET_MEMBERSHIP"
hash "0xC8BC2011F67B3411"
jhash (0xCDC4A590)
arguments {
intPtr "networkHandle" [=[ {} ]=],
intPtr "clanMembership" [=[ {} ]=],
int "membershipIndex" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
Retrieves a membership for a player, from the cache (i.e. downloaded via NETWORK_CLAN_DOWNLOAD_MEMBERSHIP).
Test C++ code:
https://pastebin.com/CD8wni4C
A player network handle.
Output buffer for the membership data. Also known as "desc".
If the player has multiple crews/memberships, use \[0-9], or -1 to get the active crew/membership.
Returns true on success, false otherwise.
]]
native "NETWORK_CLAN_GET_MEMBERSHIP_COUNT"
hash "0xAAB11F6C4ADBC2C1"
jhash (0x25924010)
arguments {
intPtr "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "int"
doc [[!
]]
native "NETWORK_CLAN_GET_MEMBERSHIP_DESC"
hash "0x48DE78AF2C8885B8"
jhash (0x3369DD1F)
arguments {
intPtr "memberDesc" [=[ {} ]=],
int "p1" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_CLAN_GET_MEMBERSHIP_VALID"
hash "0x48A59CF88D43DF0E"
jhash (0x48914F6A)
arguments {
intPtr "networkHandle" [=[ {} ]=],
int "membershipIndex" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
Checks if a crew/membership for a player, from the cache (i.e. downloaded via NETWORK_CLAN_DOWNLOAD_MEMBERSHIP) is valid.
A player network handle.
If the player has multiple crews/memberships, use \[0-9], or -1 to get the active crew/membership.
Returns true if valid, false otherwise.
]]
native "NETWORK_CLAN_GET_UI_FORMATTED_TAG"
hash "0xF45352426FF3A4F0"
jhash (0xF633805A)
arguments {
intPtr "clanDesc" [=[ {} ]=],
int "bufferSize" [=[ {} ]=],
charPtr "formattedTag" [=[ {"cs_type":"intPtr"} ]=],
}
alias "0xF45352426FF3A4F0"
ns "NETWORK"
returns "void"
doc [[!
```
bufferSize is 35 in the scripts.
```
]]
native "NETWORK_CLAN_IS_EMBLEM_READY"
hash "0xA134777FF7F33331"
jhash (0x88B13CDC)
arguments {
Any "p0" [=[ {} ]=],
AnyPtr "p1" [=[ {} ]=],
}
alias "0xA134777FF7F33331"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_CLAN_IS_ROCKSTAR_CLAN"
hash "0x7543BB439F63792B"
jhash (0x54E79E9C)
arguments {
intPtr "clanDesc" [=[ {} ]=],
int "bufferSize" [=[ {} ]=],
}
alias "0x7543BB439F63792B"
ns "NETWORK"
returns "BOOL"
doc [[!
```
bufferSize is 35 in the scripts.
```
]]
native "NETWORK_CLAN_JOIN"
hash "0x9FAAA4F4FC71F87F"
jhash (0x79C916C5)
arguments {
int "clanDesc" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_CLAN_PLAYER_GET_DESC"
hash "0xEEE6EACBE8874FBA"
jhash (0x6EE4A282)
arguments {
intPtr "clanDesc" [=[ {} ]=],
int "bufferSize" [=[ {} ]=],
intPtr "networkHandle" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
```
bufferSize is 35 in the scripts.
bufferSize is the elementCount of p0(desc), sizeof(p0) == 280 == p1*8 == 35 * 8, p2(netHandle) is obtained from NETWORK::NETWORK_HANDLE_FROM_PLAYER. And no, I can't explain why 35 * sizeof(int) == 280 and not 140, but I'll get back to you on that.
the answer is: because p0 an int64_t* / int64_t[35]. and FYI p2 is an int64_t[13]
pastebin.com/cSZniHak
```
]]
native "NETWORK_CLAN_PLAYER_IS_ACTIVE"
hash "0xB124B57F571D8F18"
jhash (0xAB8319A3)
arguments {
intPtr "networkHandle" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_CLAN_RELEASE_EMBLEM"
hash "0x113E6E3E50E286B0"
jhash (0xD6E3D5EA)
arguments {
Any "p0" [=[ {} ]=],
}
alias "0x113E6E3E50E286B0"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_CLAN_REMOTE_MEMBERSHIPS_ARE_IN_CACHE"
hash "0xBB6E6FEE99D866B2"
jhash (0x40202867)
arguments {
intPtr "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_CLAN_REQUEST_EMBLEM"
hash "0x13518FF1C6B28938"
jhash (0x7963FA4D)
arguments {
Any "p0" [=[ {} ]=],
}
alias "0x13518FF1C6B28938"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_CLAN_SERVICE_IS_VALID"
hash "0x579CCED0265D4896"
jhash (0xF5F4BD95)
alias "_NETWORK_PLAYER_IS_IN_CLAN"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_CLEAR_CLOCK_TIME_OVERRIDE"
hash "0xD972DF67326F966E"
jhash (0xC4AEAF49)
alias "0xD972DF67326F966E"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_CLEAR_FOLLOW_INVITE"
hash "0x439BFDE3CD0610F6"
jhash (0x3242F952)
alias "0x439BFDE3CD0610F6"
ns "NETWORK"
returns "Any"
doc [[!
]]
native "NETWORK_CLEAR_FOLLOWERS"
hash "0x058F43EC59A8631A"
jhash (0x5E557307)
alias "0x058F43EC59A8631A"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_CLEAR_FOUND_GAMERS"
hash "0x6D14CCEE1B40381A"
jhash (0x6AA9A154)
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_CLEAR_GET_GAMER_STATUS"
hash "0x86E0660E4F5C956D"
jhash (0x3F7EDBBD)
alias "0x86E0660E4F5C956D"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_CLEAR_GROUP_ACTIVITY"
hash "0x1888694923EF4591"
jhash (0x157D44D3)
alias "0x1888694923EF4591"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_CLEAR_PROPERTY_ID"
hash "0xC2B82527CA77053E"
jhash (0x38BC35C8)
alias "0xC2B82527CA77053E"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_CLEAR_TRANSITION_CREATOR_HANDLE"
hash "0xFB3272229A82C759"
jhash (0x8BB336F7)
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_CLEAR_VOICE_CHANNEL"
hash "0xE036A705F989E049"
jhash (0x9ECF722A)
alias "0xE036A705F989E049"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_CLEAR_VOICE_PROXIMITY_OVERRIDE"
hash "0xF03755696450470C"
jhash (0x7F9B9052)
alias "0xF03755696450470C"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_CLOSE_TRANSITION_MATCHMAKING"
hash "0x43F4DBA69710E01E"
jhash (0x82D32D07)
alias "0x43F4DBA69710E01E"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_CONCEAL_PLAYER"
hash "0xBBDF066252829606"
jhash (0x72052DB3)
arguments {
Player "player" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
BOOL "bAllowDamagingWhileConcealed" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
This is what R\* uses to hide players in MP interiors.
To manage player visibility with NetworkConcealPlayer, here’s a solid approach:
**General Population (players not in any instance):**
* Use NetworkConcealPlayer to hide players who are in any instance. This way, general population players won’t see or interact with instance players.
**Instance Players (players in a specific instance):**
* Use NetworkConcealPlayer to hide players who aren’t in the same instance. Instance players can still see and interact with the general population but not with players in other instances.
This setup keeps instance players separate from each other while allowing interaction with the general population.
]]
native "NETWORK_CREATE_SYNCHRONISED_SCENE"
hash "0x7CD6BC4C2BBDD526"
jhash (0xB06FE3FE)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "xRot" [=[ {} ]=],
float "yRot" [=[ {} ]=],
float "zRot" [=[ {} ]=],
int "rotationOrder" [=[ {} ]=],
BOOL "holdLastFrame" [=[ {} ]=],
BOOL "looped" [=[ {} ]=],
float "phaseToStopScene" [=[ {} ]=],
float "phaseToStartScene" [=[ {} ]=],
float "animSpeed" [=[ {} ]=],
}
ns "NETWORK"
returns "int"
doc [[!
Creates a networked synchronized scene.
Be sure to actually start the scene with [`NETWORK_START_SYNCHRONISED_SCENE`](#\_0x9A1B3FCDB36C8697) after you're done adding peds or entities to the scene.
X coord of the scene position (If the scene is for an object, the position should be of the object's coordinates most of the time)
Y coord of the scene position.
Z coord of the scene position.
Value x of the scene rotation.
Value y of the scene rotation.
Value z of the scene rotation (It's heading).
Rotation order. Default is 2.
If true, the scene stays on the last frame once it finishes, making `GetSynchronizedScenePhase` keep returning `1.0`. Script is expected to clean up it's memory and stop the animation if this is passed as true and the phase reaches `1.0`.
If true, the scene will be looped and `holdLastFrame` will be disregarded.
Which phase (from `0.0` to `1.0` to stop the scene. Default is `1.0`)
Which phase (from `0.0` to `1.0` to start the scene. Default is `0.0`)
Speed of the animation. Default is `1.0`
Returns the network synchronized scene's handle. You can get information regarding the phase, rate etc of this synchronised scene by using local synchronized scene natives (e.g [`GET_SYNCHRONIZED_SCENE_PHASE`](#\_0xE4A310B1D7FA73CC)).
Do note that you need to get the local scene handle from the network scene handle (using [`NETWORK_GET_LOCAL_SCENE_FROM_NETWORK_ID`](#\_0x02C40BF885C567B6)) and then pass the returned value to the local synchronized scene info natives.
]]
native "NETWORK_DID_FIND_GAMERS_SUCCEED"
hash "0xF9B83B77929D8863"
jhash (0xBEDC4503)
alias "0xF9B83B77929D8863"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_DID_GET_GAMER_STATUS_SUCCEED"
hash "0x5AE17C6B0134B7F1"
jhash (0xC871E745)
alias "0x5AE17C6B0134B7F1"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_DISABLE_INVINCIBLE_FLASHING"
hash "0x9DD368BF06983221"
jhash (0x8D27280E)
arguments {
Player "player" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x9DD368BF06983221"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_DISABLE_LEAVE_REMOTE_PED_BEHIND"
hash "0xC505036A35AFD01B"
jhash (0xA100CC97)
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0xC505036A35AFD01B"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_DISABLE_PROXIMITY_MIGRATION"
hash "0x407091CF6037118E"
jhash (0x9F82917F)
arguments {
int "netID" [=[ {} ]=],
}
alias "0x407091CF6037118E"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_DO_TRANSITION_QUICKMATCH"
hash "0x71FB0EBCD4915D56"
jhash (0x2FF65C0B)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
alias "0x71FB0EBCD4915D56"
ns "NETWORK"
returns "BOOL"
doc [[!
```
NativeDB Added Parameter 5: Any p4
NativeDB Added Parameter 6: Any p5
```
]]
native "NETWORK_DO_TRANSITION_QUICKMATCH_ASYNC"
hash "0xA091A5E44F0072E5"
jhash (0x47D61C99)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
alias "0xA091A5E44F0072E5"
ns "NETWORK"
returns "BOOL"
doc [[!
```
NativeDB Added Parameter 5: Any p4
NativeDB Added Parameter 6: Any p5
```
]]
native "NETWORK_DO_TRANSITION_QUICKMATCH_WITH_GROUP"
hash "0x9C4AB58491FDC98A"
jhash (0x5CE60A11)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
AnyPtr "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
```
NativeDB Added Parameter 7: Any p6
NativeDB Added Parameter 8: Any p7
```
]]
native "NETWORK_DO_TRANSITION_TO_FREEMODE"
hash "0x3AAD8B2FCA1E289F"
jhash (0xC7CB8ADF)
arguments {
AnyPtr "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
int "players" [=[ {} ]=],
BOOL "p4" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
```
p2 is true 3/4 of the occurrences I found.
'players' is the number of players for a session. On PS3/360 it's always 18. On PC it's 32.
```
]]
native "NETWORK_DO_TRANSITION_TO_GAME"
hash "0x3E9BB38102A589B0"
jhash (0x1B2114D2)
arguments {
BOOL "p0" [=[ {} ]=],
int "maxPlayers" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_DO_TRANSITION_TO_NEW_FREEMODE"
hash "0x9E80A5BA8109F974"
jhash (0xAD13375E)
arguments {
AnyPtr "p0" [=[ {} ]=],
AnyPtr "p1" [=[ {} ]=],
int "players" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
BOOL "p4" [=[ {} ]=],
BOOL "p5" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_DO_TRANSITION_TO_NEW_GAME"
hash "0x4665F51EFED00034"
jhash (0x58AFBE63)
arguments {
BOOL "p0" [=[ {} ]=],
int "maxPlayers" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_DOES_ENTITY_EXIST_WITH_NETWORK_ID"
hash "0x18A47D074708FD68"
jhash (0x1E2E3177)
arguments {
int "netId" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_DOES_NETWORK_ID_EXIST"
hash "0x38CE16C96BD11344"
jhash (0xB8D2C99E)
arguments {
int "netId" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_DOES_TUNABLE_EXIST"
hash "0x85E5F8B9B898B20A"
jhash (0x9FCE9C9A)
arguments {
charPtr "tunableContext" [=[ {} ]=],
charPtr "tunableName" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_DOES_TUNABLE_EXIST_HASH"
hash "0xE4E53E1419D81127"
jhash (0x25915CB9)
arguments {
Hash "tunableContext" [=[ {} ]=],
Hash "tunableName" [=[ {} ]=],
}
alias "0xE4E53E1419D81127"
alias "_NETWORK_DOES_TUNABLE_EXIST_HASH"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_END_TUTORIAL_SESSION"
hash "0xD0AFAFF5A51D72F7"
jhash (0xBA57E53E)
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_ENTITY_AREA_DOES_EXIST"
hash "0xE64A3CA08DFA37A9"
jhash (0x69956127)
arguments {
int "areaHandle" [=[ {} ]=],
}
alias "0xE64A3CA08DFA37A9"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_ENTITY_AREA_IS_OCCUPIED"
hash "0x4A2D4E8BF4265B0F"
jhash (0xC6D53AA0)
arguments {
int "areaHandle" [=[ {} ]=],
}
alias "0x4A2D4E8BF4265B0F"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_EXPLODE_HELI"
hash "0x2A5E0621DD815A9A"
jhash (0x955B31BF)
arguments {
Vehicle "heli" [=[ {} ]=],
BOOL "isAudible" [=[ {} ]=],
BOOL "isInvisible" [=[ {} ]=],
int "netScriptEntityId" [=[ {} ]=],
}
alias "0x2A5E0621DD815A9A"
ns "NETWORK"
returns "void"
doc [[!
Heli to explode
]]
native "NETWORK_EXPLODE_VEHICLE"
hash "0x301A42153C9AD707"
jhash (0x0E1B38AE)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "isAudible" [=[ {} ]=],
BOOL "isInvisible" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
}
ns "NETWORK"
annotations [=[ {"cs_type":"Any"} ]=]
returns "void"
doc [[!
```
In the console script dumps, this is only referenced once.
NETWORK::NETWORK_EXPLODE_VEHICLE(vehicle, 1, 0, 0);
^^^^^ That must be PC script dumps? In X360 Script Dumps it is reference a few times with 2 differences in the parameters.
Which as you see below is 1, 0, 0 + 1, 1, 0 + 1, 0, and a *param?
am_plane_takedown.c
network_explode_vehicle(net_to_veh(Local_40.imm_2), 1, 1, 0);
armenian2.c
network_explode_vehicle(Local_80[6 <2>], 1, 0, 0);
fm_horde_controler.c
network_explode_vehicle(net_to_veh(*uParam0), 1, 0, *uParam0);
fm_mission_controller.c, has 6 hits so not going to list them.
Side note, setting the first parameter to 0 seems to mute sound or so?
Seems it's like ADD_EXPLOSION, etc. the first 2 params. The 3rd atm no need to worry since it always seems to be 0.
```
]]
native "NETWORK_FADE_IN_ENTITY"
hash "0x1F4ED342ACEFE62D"
jhash (0x9B9FCD02)
arguments {
Entity "entity" [=[ {} ]=],
BOOL "bNetwork" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
Fade the given entity back in, usually used after the entity has been faded out with [NETWORK_FADE_OUT_ENTITY](#\_0xDE564951F95E09ED)
When used on a entity which isn't invisible or faded out then the native will still work, it will just instanly make the ped invisible before fading in.
**Additional Parameters**:
* **flash**: If set to true the entity will flash while fading in.
The entity to fade in
When set to true the fade in will be networked.
]]
native "NETWORK_FADE_OUT_ENTITY"
hash "0xDE564951F95E09ED"
jhash (0x47EDEE56)
arguments {
Entity "entity" [=[ {} ]=],
BOOL "normal" [=[ {} ]=],
BOOL "slow" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
```
normal - transition like when your coming out of LSC
slow - transition like when you walk into a mission
```
]]
native "NETWORK_FIND_GAMERS_IN_CREW"
hash "0xE532D6811B3A4D2A"
jhash (0x7771AB83)
arguments {
Any "p0" [=[ {} ]=],
}
alias "0xE532D6811B3A4D2A"
alias "NETWORK_X_AFFECTS_GAMERS"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_FIND_MATCHED_GAMERS"
hash "0xF7B2CFDE5C9F700D"
jhash (0xA13045D4)
arguments {
Any "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
}
alias "0xF7B2CFDE5C9F700D"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_FINISH_BROADCASTING_DATA"
hash "0x64F62AFB081E260D"
jhash (0xA71A1D2A)
alias "0x64F62AFB081E260D"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_FORCE_LOCAL_USE_OF_SYNCED_SCENE_CAMERA"
hash "0xC9B43A33D09CADA7"
jhash (0xC3AA2EC7)
arguments {
int "sceneId" [=[ {} ]=],
}
alias "0xC9B43A33D09CADA7"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_GAMER_HAS_HEADSET"
hash "0xF2FD55CB574BCC55"
jhash (0xD036DA4A)
arguments {
AnyPtr "networkHandle" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_GAMERTAG_FROM_HANDLE_PENDING"
hash "0xB071E27958EF4CF0"
jhash (0xF000828E)
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_GAMERTAG_FROM_HANDLE_START"
hash "0x9F0C0A981D73FA56"
jhash (0xEBA00C2A)
arguments {
intPtr "networkHandle" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_GAMERTAG_FROM_HANDLE_SUCCEEDED"
hash "0xFD00798DBA7523DD"
jhash (0x89C2B5EA)
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_GET_ACTIVITY_PLAYER_NUM"
hash "0x73E2B500410DA5A2"
jhash (0x31F951FD)
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "int"
doc [[!
]]
native "NETWORK_GET_AGE_GROUP"
hash "0x9614B71F8ADB982B"
jhash (0xAB07CBBE)
alias "0x9614B71F8ADB982B"
ns "NETWORK"
returns "int"
doc [[!
]]
native "NETWORK_GET_BACKGROUND_LOADING_RECIPIENTS"
hash "0x97A770BEEF227E2B"
jhash (0x1CFB3F51)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
AnyPtr "p2" [=[ {} ]=],
AnyPtr "p3" [=[ {} ]=],
}
alias "0x97A770BEEF227E2B"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_GET_CONTENT_MODIFIER_LIST_ID"
hash "0x187382F8A3E0A6C3"
jhash (0xA78571CA)
arguments {
Hash "contentHash" [=[ {} ]=],
}
alias "0x187382F8A3E0A6C3"
alias "_GET_TUNABLES_CONTENT_MODIFIER_ID"
ns "NETWORK"
returns "int"
doc [[!
```
Return the content modifier id (the tunables context if you want) of a specific content.
It takes the content hash (which is the mission id hash), and return the content modifier id, used as the tunables context.
The mission id can be found on the Social club, for example, 'socialclub.rockstargames.com/games/gtav/jobs/job/A8M6Bz8MLEC5xngvDCzGwA'
'A8M6Bz8MLEC5xngvDCzGwA' is the mission id, so the game hash this and use it as the parameter for this native.
```
]]
native "NETWORK_GET_CURRENTLY_SELECTED_GAMER_HANDLE_FROM_INVITE_MENU"
hash "0x74881E6BCAE2327C"
jhash (0x72BA00CE)
arguments {
AnyPtr "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_GET_DESTROYER_OF_NETWORK_ID"
hash "0x7A1ADEEF01740A24"
jhash (0x4FCA6436)
arguments {
int "netId" [=[ {} ]=],
HashPtr "weaponHash" [=[ {} ]=],
}
ns "NETWORK"
returns "int"
doc [[!
]]
native "NETWORK_GET_ENTITY_FROM_NETWORK_ID"
hash "0xCE4E5D9B0A4FF560"
jhash (0x5B912C3F)
arguments {
int "netId" [=[ {} ]=],
}
ns "NETWORK"
returns "Entity"
doc [[!
Get the local entity handle of the given network id
Through this native you can get back the entity that you previously converted to netid with [NetworkGetNetworkIdFromEntity](#\_0x9E35DAB6) or with the `ToNet` natives
the network id of the entity
The local entity handle of the network id
]]
native "NETWORK_GET_ENTITY_IS_LOCAL"
hash "0x0991549DE4D64762"
jhash (0x813353ED)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_GET_ENTITY_IS_NETWORKED"
hash "0xC7827959479DCC78"
jhash (0xD7F934F4)
arguments {
Entity "entity" [=[ {} ]=],
}
alias "0xC7827959479DCC78"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_GET_ENTITY_KILLER_OF_PLAYER"
hash "0x42B2DAA6B596F5F8"
jhash (0xA7E7E04F)
arguments {
Player "player" [=[ {} ]=],
HashPtr "weaponHash" [=[ {} ]=],
}
ns "NETWORK"
returns "Entity"
doc [[!
]]
native "NETWORK_GET_FOUND_GAMER"
hash "0x9DCFF2AFB68B3476"
jhash (0xA08C9141)
arguments {
AnyPtr "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_GET_FRIEND_COUNT"
hash "0x203F1CFD823B27A4"
jhash (0xA396ACDE)
ns "NETWORK"
returns "int"
doc [[!
]]
native "NETWORK_GET_FRIEND_NAME"
hash "0xE11EBBB2A783FE8B"
jhash (0x97420B6D)
arguments {
int "friendIndex" [=[ {} ]=],
}
ns "NETWORK"
returns "charPtr"
doc [[!
]]
native "NETWORK_GET_GAMER_STATUS_FROM_QUEUE"
hash "0x2CC848A861D01493"
jhash (0xBEB98840)
alias "0x2CC848A861D01493"
ns "NETWORK"
annotations [=[ {"cs_type":"Any"} ]=]
returns "BOOL"
doc [[!
]]
native "NETWORK_GET_GAMER_STATUS_RESULT"
hash "0x02A8BEC6FD9AF660"
jhash (0xB5ABC4B4)
arguments {
AnyPtr "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
alias "0x02A8BEC6FD9AF660"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_GET_GAMERTAG_FROM_HANDLE"
hash "0x426141162EBE5CDB"
jhash (0xA18A1B26)
arguments {
intPtr "networkHandle" [=[ {} ]=],
}
ns "NETWORK"
returns "charPtr"
doc [[!
]]
native "NETWORK_GET_GLOBAL_MULTIPLAYER_CLOCK"
hash "0x6D03BFBD643B2A02"
jhash (0x74E8C53E)
arguments {
intPtr "hours" [=[ {} ]=],
intPtr "minutes" [=[ {} ]=],
intPtr "seconds" [=[ {} ]=],
}
alias "0x6D03BFBD643B2A02"
alias "_NETWORK_GET_SERVER_TIME"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_GET_HOST_OF_SCRIPT"
hash "0x1D6A14F1F9A736FC"
jhash (0x9C95D0BB)
arguments {
charPtr "scriptName" [=[ {} ]=],
int "p1" [=[ {} ]=],
int "p2" [=[ {} ]=],
}
ns "NETWORK"
returns "Player"
doc [[!
```
scriptName examples:
"freemode", "AM_CR_SecurityVan", ...
Most of the time, these values are used:
p1 = -1
p2 = 0
```
]]
native "NETWORK_GET_HOST_OF_THIS_SCRIPT"
hash "0xC7B4D79B01FA7A5C"
jhash (0x89EA7B54)
ns "NETWORK"
returns "Player"
doc [[!
]]
native "NETWORK_GET_INSTANCE_ID_OF_THIS_SCRIPT"
hash "0x638A3A81733086DB"
jhash (0xDB8B5D71)
alias "0x638A3A81733086DB"
ns "NETWORK"
returns "int"
doc [[!
]]
native "NETWORK_GET_LOCAL_HANDLE"
hash "0xE86051786B66CD8E"
jhash (0x08023B16)
arguments {
intPtr "networkHandle" [=[ {} ]=],
int "bufferSize" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
```
Retrieves the local player's NetworkHandle* and stores it in the given buffer.
* Currently unknown struct
```
]]
native "NETWORK_GET_LOCAL_SCENE_FROM_NETWORK_ID"
hash "0x02C40BF885C567B6"
jhash (0x16AED87B)
arguments {
int "netSceneId" [=[ {} ]=],
}
alias "0x02C40BF885C567B6"
alias "_NETWORK_UNLINK_NETWORKED_SYNCHRONISED_SCENE"
alias "_NETWORK_CONVERT_SYNCHRONISED_SCENE_TO_SYNCHRONIZED_SCENE"
ns "NETWORK"
returns "int"
doc [[!
Returns a local synchronized scene handle of a networked synchronised scene.
Network synchronised scene ID (returned by [`NETWORK_CREATE_SYNCHRONISED_SCENE`](#\_0x7CD6BC4C2BBDD526)).
Local synchronized scene ID. This value can be used with natives such as: [`GET_SYNCHRONIZED_SCENE_PHASE`](#\_0xE4A310B1D7FA73CC), [`GET_SYNCHRONIZED_SCENE_RATE`](#\_0xD80932D577274D40), [`IS_SYNCHRONIZED_SCENE_RUNNING`](#\_0x25D39B935A038A26) and more.
]]
native "NETWORK_GET_MAX_FRIENDS"
hash "0xAFEBB0D5D8F687D2"
jhash (0x048171BC)
ns "NETWORK"
returns "int"
doc [[!
]]
native "NETWORK_GET_MAX_NUM_PARTICIPANTS"
hash "0xA6C90FBC38E395EE"
jhash (0xCCD8C02D)
alias "_NETWORK_GET_NUM_PARTICIPANTS_HOST"
ns "NETWORK"
returns "int"
doc [[!
```
Seems to always return 0, but it's used in quite a few loops.
for (num3 = 0; num3 < NETWORK::0xCCD8C02D(); num3++)
{
if (NETWORK::NETWORK_IS_PARTICIPANT_ACTIVE(PLAYER::0x98F3B274(num3)) != 0)
{
var num5 = NETWORK::NETWORK_GET_PLAYER_INDEX(PLAYER::0x98F3B274(num3));
```
]]
native "NETWORK_GET_NETWORK_ID_FROM_ENTITY"
hash "0xA11700682F3AD45C"
jhash (0x9E35DAB6)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "NETWORK"
returns "int"
doc [[!
Get the network id of the given entity
An entity network id represents a given entity for other clients, it's a handle shared between clients, can be reconverted to a client entity handle.\
These (entity network IDs) can and will be reused, the network id will not change.
If you need to refer to an entity across machines (clients, or the server), you should use its network id.
Read more at [Network and local IDs](https://docs.fivem.net/docs/scripting-manual/networking/ids/)
the handle of the entity from which the network id should be taken
The network id of the given entity
]]
native "NETWORK_GET_NUM_CONNECTED_PLAYERS"
hash "0xA4A79DD2D9600654"
jhash (0xF7952E62)
ns "NETWORK"
returns "int"
doc [[!
```
Returns the amount of players connected in the current session. Only works when connected to a session/server.
```
]]
native "NETWORK_GET_NUM_FOUND_GAMERS"
hash "0xA1B043EE79A916FB"
jhash (0xF4B80C7E)
ns "NETWORK"
returns "int"
doc [[!
]]
native "NETWORK_GET_NUM_PARTICIPANTS"
hash "0x18D0456E86604654"
jhash (0x3E25A3C5)
ns "NETWORK"
returns "int"
doc [[!
]]
native "NETWORK_GET_NUM_PRESENCE_INVITES"
hash "0xCEFA968912D0F78D"
jhash (0x3FDA00F3)
alias "0xCEFA968912D0F78D"
ns "NETWORK"
returns "int"
doc [[!
]]
native "NETWORK_GET_NUM_SCRIPT_PARTICIPANTS"
hash "0x3658E8CD94FC121A"
jhash (0x8F7D9F46)
arguments {
AnyPtr "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
alias "0x3658E8CD94FC121A"
ns "NETWORK"
returns "int"
doc [[!
]]
native "NETWORK_GET_PARTICIPANT_INDEX"
hash "0x1B84DF6AF2A46938"
jhash (0xC4D91094)
arguments {
int "index" [=[ {} ]=],
}
ns "NETWORK"
returns "int"
doc [[!
]]
native "NETWORK_GET_PLATFORM_PARTY_MEMBERS"
hash "0x120364DE2845DAF8"
jhash (0xF30E5814)
arguments {
AnyPtr "data" [=[ {} ]=],
int "dataSize" [=[ {} ]=],
}
alias "0x120364DE2845DAF8"
ns "NETWORK"
returns "int"
doc [[!
]]
native "NETWORK_GET_PLAYER_FROM_GAMER_HANDLE"
hash "0xCE5F689CF5A0A49D"
jhash (0x2E96EF1E)
arguments {
intPtr "networkHandle" [=[ {} ]=],
}
ns "NETWORK"
returns "Player"
doc [[!
]]
native "NETWORK_GET_PLAYER_INDEX"
hash "0x24FB80D107371267"
jhash (0xBE1C1506)
arguments {
Player "player" [=[ {} ]=],
}
ns "NETWORK"
returns "int"
doc [[!
]]
native "NETWORK_GET_PLAYER_INDEX_FROM_PED"
hash "0x6C0E2E0125610278"
jhash (0x40DBF464)
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0x6C0E2E0125610278"
ns "NETWORK"
returns "Player"
doc [[!
```
Returns the Player associated to a given Ped when in an online session.
```
]]
native "NETWORK_GET_PLAYER_LOUDNESS"
hash "0x21A1684A25C2867F"
jhash (0xF2F67014)
arguments {
Player "player" [=[ {} ]=],
}
ns "NETWORK"
returns "float"
doc [[!
]]
native "NETWORK_GET_PLAYER_OWNS_WAYPOINT"
hash "0x82377B65E943F72D"
jhash (0xB802B671)
arguments {
Player "player" [=[ {} ]=],
}
alias "0x82377B65E943F72D"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_GET_PLAYER_TUTORIAL_SESSION_INSTANCE"
hash "0x3B39236746714134"
jhash (0x5E1020CC)
arguments {
Player "player" [=[ {} ]=],
}
alias "0x3B39236746714134"
ns "NETWORK"
returns "int"
doc [[!
]]
native "NETWORK_GET_PRESENCE_INVITE_CONTENT_ID"
hash "0x24409FC4C55CB22D"
jhash (0xA4302183)
arguments {
Any "p0" [=[ {} ]=],
}
alias "0x24409FC4C55CB22D"
ns "NETWORK"
returns "charPtr"
doc [[!
]]
native "NETWORK_GET_PRESENCE_INVITE_FROM_ADMIN"
hash "0x3DBF2DF0AEB7D289"
jhash (0xF5E3401C)
arguments {
Any "p0" [=[ {} ]=],
}
alias "0x3DBF2DF0AEB7D289"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_GET_PRESENCE_INVITE_HANDLE"
hash "0x38D5B0FEBB086F75"
jhash (0xB2451429)
arguments {
Any "p0" [=[ {} ]=],
AnyPtr "p1" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_GET_PRESENCE_INVITE_ID"
hash "0xDFF09646E12EC386"
jhash (0xD50DF46C)
arguments {
Any "p0" [=[ {} ]=],
}
alias "0xDFF09646E12EC386"
ns "NETWORK"
returns "Any"
doc [[!
]]
native "NETWORK_GET_PRESENCE_INVITE_INVITER"
hash "0x4962CC4AA2F345B7"
jhash (0x19EC65D9)
arguments {
int "inviteIndex" [=[ {} ]=],
}
alias "0x4962CC4AA2F345B7"
ns "NETWORK"
returns "charPtr"
doc [[!
Returns the Name of the inviter of the specific selected Invite.
The Name of the inviter.
]]
native "NETWORK_GET_PRESENCE_INVITE_IS_TOURNAMENT"
hash "0x8806CEBFABD3CE05"
jhash (0x7D593B4C)
arguments {
Any "p0" [=[ {} ]=],
}
alias "0x8806CEBFABD3CE05"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_GET_PRESENCE_INVITE_PLAYLIST_CURRENT"
hash "0x728C4CC7920CD102"
jhash (0x4677C656)
arguments {
Any "p0" [=[ {} ]=],
}
alias "0x728C4CC7920CD102"
ns "NETWORK"
returns "Any"
doc [[!
]]
native "NETWORK_GET_PRESENCE_INVITE_PLAYLIST_LENGTH"
hash "0xD39B3FFF8FFDD5BF"
jhash (0x51B2D848)
arguments {
Any "p0" [=[ {} ]=],
}
alias "0xD39B3FFF8FFDD5BF"
ns "NETWORK"
returns "Any"
doc [[!
]]
native "NETWORK_GET_PRESENCE_INVITE_SESSION_ID"
hash "0x26E1CD96B0903D60"
jhash (0xC5E0C989)
arguments {
int "inviteIndex" [=[ {} ]=],
}
alias "0x26E1CD96B0903D60"
ns "NETWORK"
returns "Hash"
doc [[!
The Native returns a hash of the session id as string from the specific invite index!
A hash of the session id.
]]
native "NETWORK_GET_PRIMARY_CLAN_DATA_CANCEL"
hash "0x042E4B70B93E6054"
jhash (0x455DDF5C)
alias "0x042E4B70B93E6054"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_GET_PRIMARY_CLAN_DATA_CLEAR"
hash "0x9AA46BADAD0E27ED"
jhash (0xE22445DA)
alias "0x9AA46BADAD0E27ED"
ns "NETWORK"
returns "Any"
doc [[!
]]
native "NETWORK_GET_PRIMARY_CLAN_DATA_NEW"
hash "0xC080FF658B2E41DA"
jhash (0x9B8631EB)
arguments {
AnyPtr "p0" [=[ {} ]=],
AnyPtr "p1" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_GET_PRIMARY_CLAN_DATA_PENDING"
hash "0xB5074DB804E28CE7"
jhash (0xA4EF02F3)
alias "0xB5074DB804E28CE7"
ns "NETWORK"
returns "Any"
doc [[!
]]
native "NETWORK_GET_PRIMARY_CLAN_DATA_START"
hash "0xCE86D8191B762107"
jhash (0x89DB0EC7)
arguments {
AnyPtr "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_GET_PRIMARY_CLAN_DATA_SUCCESS"
hash "0x5B4F04F19376A0BA"
jhash (0x068A054E)
alias "0x5B4F04F19376A0BA"
ns "NETWORK"
returns "Any"
doc [[!
]]
native "NETWORK_GET_RANDOM_INT"
hash "0x599E4FA1F87EB5FF"
jhash (0x208DD848)
alias "0x599E4FA1F87EB5FF"
ns "NETWORK"
returns "int"
doc [[!
]]
native "NETWORK_GET_RANDOM_INT_RANGED"
hash "0xE30CF56F1EFA5F43"
jhash (0xF9B6426D)
arguments {
int "rangeStart" [=[ {} ]=],
int "rangeEnd" [=[ {} ]=],
}
alias "0xE30CF56F1EFA5F43"
alias "_NETWORK_GET_RANDOM_INT_IN_RANGE"
ns "NETWORK"
returns "int"
doc [[!
```
Same as GET_RANDOM_INT_IN_RANGE
```
]]
native "NETWORK_GET_RESPAWN_RESULT"
hash "0x371EA43692861CF1"
jhash (0xDDFE9FBC)
arguments {
int "randomInt" [=[ {} ]=],
Vector3Ptr "coordinates" [=[ {} ]=],
floatPtr "heading" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
```
Based on scripts such as in freemode.c how they call their vars vVar and fVar the 2nd and 3rd param it a Vector3 and Float, but the first is based on get_random_int_in_range..
```
]]
native "NETWORK_GET_RESPAWN_RESULT_FLAGS"
hash "0x6C34F1208B8923FD"
jhash (0x03287FD2)
arguments {
Any "p0" [=[ {} ]=],
}
alias "0x6C34F1208B8923FD"
ns "NETWORK"
returns "Any"
doc [[!
]]
native "NETWORK_GET_SCRIPT_STATUS"
hash "0x57D158647A6BFABF"
jhash (0x2BE9235A)
ns "NETWORK"
returns "int"
doc [[!
]]
native "NETWORK_GET_TALKER_PROXIMITY"
hash "0x84F0F13120B4E098"
jhash (0x19991ADD)
ns "NETWORK"
returns "float"
doc [[!
]]
native "NETWORK_GET_THIS_SCRIPT_IS_NETWORK_SCRIPT"
hash "0x2910669969E9535E"
jhash (0xD9BF6549)
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_GET_TIMEOUT_TIME"
hash "0x5ED0356A0CE3A34F"
jhash (0xE1F86C6A)
alias "0x5ED0356A0CE3A34F"
ns "NETWORK"
returns "int"
doc [[!
]]
native "NETWORK_GET_TOTAL_NUM_PLAYERS"
hash "0xCF61D4B4702EE9EB"
jhash (0xF4F13B06)
alias "0xCF61D4B4702EE9EB"
ns "NETWORK"
returns "int"
doc [[!
]]
native "NETWORK_GET_TRANSITION_HOST"
hash "0x65042B9774C4435E"
jhash (0x73098D40)
arguments {
intPtr "networkHandle" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_GET_TRANSITION_MEMBERS"
hash "0x73B000F7FBC55829"
jhash (0x31F19263)
arguments {
AnyPtr "data" [=[ {} ]=],
int "dataCount" [=[ {} ]=],
}
ns "NETWORK"
returns "int"
doc [[!
```
Returns count.
```
]]
native "NETWORK_GET_TUNABLE_CLOUD_CRC"
hash "0x10BD227A753B0D84"
jhash (0x231CFD12)
alias "0x10BD227A753B0D84"
alias "_NETWORK_GET_TUNABLES_VERSION"
ns "NETWORK"
returns "int"
doc [[!
```
Actually returns the version (TUNABLE_VERSION)
```
]]
native "NETWORK_HANDLE_FROM_FRIEND"
hash "0xD45CB817D7E177D2"
jhash (0x3B0BB3A3)
arguments {
int "friendIndex" [=[ {} ]=],
intPtr "networkHandle" [=[ {} ]=],
int "bufferSize" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_HANDLE_FROM_MEMBER_ID"
hash "0xA0FD21BED61E5C4C"
jhash (0x9BFC9FE2)
arguments {
charPtr "memberId" [=[ {} ]=],
intPtr "networkHandle" [=[ {} ]=],
int "bufferSize" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
```
Returns a NetworkHandle* from the specified member ID and stores it in a given buffer.
* Currently unknown struct
```
]]
native "NETWORK_HANDLE_FROM_PLAYER"
hash "0x388EB2B86C73B6B3"
jhash (0xD3498917)
arguments {
Player "player" [=[ {} ]=],
intPtr "networkHandle" [=[ {} ]=],
int "bufferSize" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
```
Returns a handle to networkHandle* from the specified player handle and stores it in a given buffer.
* Currently unknown struct
Example:
std::vector GetPlayerNetworkHandle(Player player) {
const int size = 13;
uint64_t *buffer = std::make_unique(size).get();
NETWORK::NETWORK_HANDLE_FROM_PLAYER(player, reinterpret_cast(buffer), 13);
for (int i = 0; i < size; i++) {
Log::Msg("networkhandle[%i]: %llx", i, buffer[i]);
}
std::vector result(buffer, buffer + sizeof(buffer));
return result;
}
```
]]
native "NETWORK_HANDLE_FROM_USER_ID"
hash "0xDCD51DD8F87AEC5C"
jhash (0x74C2C1B7)
arguments {
charPtr "userId" [=[ {} ]=],
intPtr "networkHandle" [=[ {} ]=],
int "bufferSize" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
```
Returns a NetworkHandle* from the specified user ID and stores it in a given buffer.
* Currently unknown struct
```
]]
native "NETWORK_HAS_CACHED_PLAYER_HEAD_BLEND_DATA"
hash "0x237D5336A9A54108"
jhash (0x7B2A0337)
arguments {
Player "player" [=[ {} ]=],
}
alias "0x237D5336A9A54108"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_HAS_CONTROL_OF_DOOR"
hash "0xCB3C68ADB06195DF"
jhash (0x136326EC)
arguments {
Hash "doorHash" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_HAS_CONTROL_OF_ENTITY"
hash "0x01BF60A500E28887"
jhash (0x005FD797)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_HAS_CONTROL_OF_NETWORK_ID"
hash "0x4D36070FE0215186"
jhash (0x92E77D21)
arguments {
int "netId" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_HAS_CONTROL_OF_PICKUP"
hash "0x5BC9495F0B3B6FA6"
jhash (0xF7784FC8)
arguments {
Pickup "pickup" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_HAS_ENTITY_BEEN_REGISTERED_WITH_THIS_THREAD"
hash "0xB07D3185E11657A5"
jhash (0xEDA68956)
arguments {
Entity "entity" [=[ {} ]=],
}
alias "0xB07D3185E11657A5"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_HAS_FOLLOW_INVITE"
hash "0x76D9B976C4C09FDE"
jhash (0xE96CFE7D)
alias "0x76D9B976C4C09FDE"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_HAS_HEADSET"
hash "0xE870F9F1F7B4F1FA"
jhash (0xA7DC5657)
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_HAS_INVITE_BEEN_ACKED"
hash "0x71DC455F5CD1C2B1"
jhash (0xF6F9D1B9)
arguments {
intPtr "networkHandle" [=[ {} ]=],
}
alias "0x71DC455F5CD1C2B1"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_HAS_INVITED_GAMER"
hash "0x4D86CD31E8976ECE"
jhash (0xEC651BC0)
arguments {
AnyPtr "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_HAS_INVITED_GAMER_TO_TRANSITION"
hash "0x7284A47B3540E6CF"
jhash (0x4F41DF6B)
arguments {
AnyPtr "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_HAS_PENDING_INVITE"
hash "0xAC8C7B9B88C4A668"
jhash (0x0C207D6E)
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_HAS_PLAYER_STARTED_TRANSITION"
hash "0x9AC9CCBFA8C29795"
jhash (0x4ABD1E59)
arguments {
Player "player" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_HAS_RECEIVED_HOST_BROADCAST_DATA"
hash "0x5D10B3795F3FC886"
jhash (0x0B739F53)
alias "0x5D10B3795F3FC886"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_HAS_ROS_PRIVILEGE"
hash "0xA699957E60D80214"
jhash (0xFD261E30)
arguments {
int "index" [=[ {} ]=],
}
alias "0xA699957E60D80214"
ns "NETWORK"
returns "BOOL"
doc [[!
```
index is always 18 in scripts
```
]]
native "NETWORK_HAS_ROS_PRIVILEGE_END_DATE"
hash "0xC22912B1D85F26B1"
jhash (0x8570DD34)
arguments {
int "privilege" [=[ {} ]=],
intPtr "banType" [=[ {} ]=],
Vector3Ptr "timeData" [=[ {} ]=],
}
alias "0xC22912B1D85F26B1"
alias "_NETWORK_GET_BAN_DATA"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_HAS_SOCIAL_CLUB_ACCOUNT"
hash "0x67A5589628E0CFF6"
jhash (0x66EC713F)
alias "0x67A5589628E0CFF6"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_HAS_SOCIAL_NETWORKING_SHARING_PRIV"
hash "0x76BF03FADBF154F5"
jhash (0xEB864288)
alias "0x76BF03FADBF154F5"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_HAS_TRANSITION_INVITE_BEEN_ACKED"
hash "0x3F9990BF5F22759C"
jhash (0x00F26CDC)
arguments {
intPtr "networkHandle" [=[ {} ]=],
}
alias "0x3F9990BF5F22759C"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_HAS_VALID_ROS_CREDENTIALS"
hash "0x85443FF4C328F53B"
jhash (0x3FB40673)
alias "0x85443FF4C328F53B"
alias "_NETWORK_ARE_ROS_AVAILABLE"
alias "NETWORK_HAVE_JUST_UPLOAD_LATER"
ns "NETWORK"
returns "BOOL"
doc [[!
```
Returns whether the signed-in user has valid Rockstar Online Services (ROS) credentials.
```
]]
native "NETWORK_HASH_FROM_GAMER_HANDLE"
hash "0x58575AC3CF2CA8EC"
jhash (0x5AC9F04D)
arguments {
intPtr "networkHandle" [=[ {} ]=],
}
alias "0x58575AC3CF2CA8EC"
alias "_NETWORK_HASH_FROM_GAMER_HANDLE"
ns "NETWORK"
returns "Hash"
doc [[!
]]
native "NETWORK_HASH_FROM_PLAYER_HANDLE"
hash "0xBC1D768F2F5D6C05"
jhash (0xF8D7AF3B)
arguments {
Player "player" [=[ {} ]=],
}
alias "0xBC1D768F2F5D6C05"
alias "_NETWORK_HASH_FROM_PLAYER_HANDLE"
ns "NETWORK"
returns "Hash"
doc [[!
]]
native "NETWORK_HAVE_COMMUNICATION_PRIVILEGES"
hash "0xAEEF48CDF5B6CE7C"
jhash (0x2D817A5E)
arguments {
int "p0" [=[ {} ]=],
Player "player" [=[ {} ]=],
}
alias "0xAEEF48CDF5B6CE7C"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_HAVE_ONLINE_PRIVILEGES"
hash "0x25CB5A9F37BFD063"
jhash (0xEF63BFDF)
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_HAVE_ROS_BANNED_PRIV"
hash "0x8020A73847E0CA7D"
jhash (0xD3BBE42F)
alias "_IS_ROCKSTAR_BANNED"
alias "_NETWORK_HAS_PLAYER_BEEN_BANNED"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_HAVE_ROS_CREATE_TICKET_PRIV"
hash "0xA0AD7E2AF5349F61"
jhash (0xBDBB5948)
alias "_IS_SOCIALCLUB_BANNED"
alias "_NETWORK_HAVE_SOCIAL_CLUB_PRIVILEGE"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_HAVE_ROS_LEADERBOARD_WRITE_PRIV"
hash "0x422D396F80A96547"
jhash (0xC6EA802E)
alias "0x422D396F80A96547"
alias "_NETWORK_GET_ROS_PRIVILEGE_4"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_HAVE_ROS_MULTIPLAYER_PRIV"
hash "0x5F91D5D0B36AA310"
jhash (0x97287D68)
alias "_IS_PLAYER_BANNED"
alias "_CAN_PLAY_ONLINE"
alias "_NETWORK_GET_ROS_PRIVILEGE_3"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_HAVE_ROS_SOCIAL_CLUB_PRIV"
hash "0x606E4D3E3CCCF3EB"
jhash (0x424C6E27)
alias "0x606E4D3E3CCCF3EB"
alias "_NETWORK_GET_ROS_PRIVILEGE_10"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_HAVE_USER_CONTENT_PRIVILEGES"
hash "0x72D918C99BCACC54"
jhash (0x1F88819D)
arguments {
int "p0" [=[ {} ]=],
}
alias "0x72D918C99BCACC54"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_HOST_TRANSITION"
hash "0xA60BB5CE242BB254"
jhash (0x146764FB)
arguments {
int "p0" [=[ {} ]=],
int "p1" [=[ {} ]=],
int "p2" [=[ {} ]=],
int "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
BOOL "p5" [=[ {} ]=],
BOOL "p6" [=[ {} ]=],
int "p7" [=[ {} ]=],
Any "p8" [=[ {} ]=],
int "p9" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
From what I can tell it looks like it does the following:
Creates/hosts a new transition to another online session, using this in FiveM will result in other players being disconencted from the server/preventing them from joining. This is most likely because I entered the wrong session parameters since they're pretty much all unknown right now.
You also need to use `NetworkJoinTransition(Player player)` and `NetworkLaunchTransition()`.
Unknown int
Unknown int
Unknown int
Unknown int
Unknown always 0 in decompiled scripts
BOOL purpose unknown, both 0 and 1 are used in decompiled scripts.
BOOL purpose unknown, both 0 and 1 are used in decompiled scripts.
Unknown int, it's an int according to decompiled scripts, however the value is always 0 or 1.
Unknown int, it's an int according to decompiled scripts, however the value is always 0 or 1.
Unknown int, sometimes 0, but also 32768 or 16384 appear in decompiled scripst, maybe a flag of some sort?
Probably a bool indicating if the transition was created.
]]
native "NETWORK_INVITE_GAMERS"
hash "0x9D80CD1D0E6327DE"
jhash (0x52FB8074)
arguments {
AnyPtr "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
AnyPtr "p2" [=[ {} ]=],
AnyPtr "p3" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_INVITE_GAMERS_TO_TRANSITION"
hash "0x4A595C32F77DFF76"
jhash (0x5332E645)
arguments {
AnyPtr "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_ACTIVITY_SESSION"
hash "0x05095437424397FA"
jhash (0x577DAA8A)
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_ACTIVITY_SPECTATOR"
hash "0x12103B9E0C9F92FB"
jhash (0xAF329720)
ns "NETWORK"
annotations [=[ {"cs_type":"Any"} ]=]
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_ACTIVITY_SPECTATOR_FROM_HANDLE"
hash "0x2763BBAA72A7BCB9"
jhash (0x58F1DF7D)
arguments {
intPtr "networkHandle" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_ADDING_FRIEND"
hash "0x6EA101606F6E4D81"
jhash (0xBB7EC8C4)
ns "NETWORK"
annotations [=[ {"cs_type":"BOOL"} ]=]
returns "Any"
doc [[!
]]
native "NETWORK_IS_CABLE_CONNECTED"
hash "0xEFFB25453D8600F9"
jhash (0x5C065D55)
alias "0xEFFB25453D8600F9"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_CHATTING_IN_PLATFORM_PARTY"
hash "0x8DE9945BCC9AEC52"
jhash (0x51367B34)
arguments {
intPtr "networkHandle" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
```
This would be nice to see if someone is in party chat, but 2 sad notes.
1) It only becomes true if said person is speaking in that party at the time.
2) It will never, become true unless you are in that party with said person.
```
]]
native "NETWORK_IS_CLOCK_TIME_OVERRIDDEN"
hash "0xD7C95D322FF57522"
jhash (0x2465296D)
alias "0xD7C95D322FF57522"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_CLOUD_AVAILABLE"
hash "0x9A4CF4F48AD77302"
jhash (0xC7FF5AFC)
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_CLOUD_BACKGROUND_SCRIPT_REQUEST_PENDING"
hash "0x8132C0EB8B2B3293"
jhash (0x20AB933A)
alias "0x8132C0EB8B2B3293"
alias "_HAS_BG_SCRIPT_BEEN_DOWNLOADED"
alias "_NETWORK_IS_CLOUD_BACKGROUND_SCRIPTS_REQUEST_PENDING"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_DOOR_NETWORKED"
hash "0xC01E93FAC20C3346"
jhash (0xD14D9C07)
arguments {
Hash "doorHash" [=[ {} ]=],
}
alias "0xC01E93FAC20C3346"
alias "_NETWORK_HAS_CONTROL_OF_PAVEMENT_STATS"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_ENTITY_FADING"
hash "0x422F32CC7E56ABAD"
jhash (0xB5087ACF)
arguments {
Entity "entity" [=[ {} ]=],
}
alias "0x422F32CC7E56ABAD"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_FINDING_GAMERS"
hash "0xDDDF64C91BFCF0AA"
jhash (0xA6DAA79F)
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_FRIEND"
hash "0x1A24A179F9B31654"
jhash (0x2DA4C282)
arguments {
intPtr "networkHandle" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_FRIEND_IN_MULTIPLAYER"
hash "0x57005C18827F3A28"
jhash (0x400BDDD9)
arguments {
charPtr "friendName" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_FRIEND_IN_SAME_TITLE"
hash "0x2EA9A3BEDF3F17B8"
jhash (0xC54365C2)
arguments {
charPtr "friendName" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
```
In scripts R* calls 'NETWORK_GET_FRIEND_NAME' in this param.
```
]]
native "NETWORK_IS_FRIEND_INDEX_ONLINE"
hash "0xBAD8F2A42B844821"
jhash (0x94AE7172)
arguments {
int "friendIndex" [=[ {} ]=],
}
alias "0xBAD8F2A42B844821"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_FRIEND_ONLINE"
hash "0x425A44533437B64D"
jhash (0xE0A42430)
arguments {
charPtr "name" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_GAME_IN_PROGRESS"
hash "0x10FAB35428CCC9D7"
jhash (0x09B88E3E)
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_GAMER_BLOCKED_BY_ME"
hash "0xE944C4F5AF1B5883"
jhash (0x3FDCC8D7)
arguments {
AnyPtr "networkHandle" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_GAMER_IN_MY_SESSION"
hash "0x0F10B05DDF8D16E9"
jhash (0x59127716)
arguments {
intPtr "networkHandle" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_GAMER_MUTED_BY_ME"
hash "0xCE60DE011B6C7978"
jhash (0x001B4046)
arguments {
intPtr "networkHandle" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_GAMER_TALKING"
hash "0x71C33B22606CD88A"
jhash (0x99B58DBC)
arguments {
intPtr "networkHandle" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_GETTING_GAMER_STATUS"
hash "0x94A8394D150B013A"
jhash (0x08029970)
alias "0x94A8394D150B013A"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_HANDLE_VALID"
hash "0x6F79B93B0A8E4133"
jhash (0xF0996C6E)
arguments {
intPtr "networkHandle" [=[ {} ]=],
int "bufferSize" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_HOST"
hash "0x8DB296B814EDDA07"
jhash (0xE46AC10F)
ns "NETWORK"
returns "BOOL"
doc [[!
```
If you are host, returns true else returns false.
```
]]
native "NETWORK_IS_HOST_OF_THIS_SCRIPT"
hash "0x83CD99A1E6061AB5"
jhash (0x6970BA94)
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_IN_MP_CUTSCENE"
hash "0x6CC27C9FA2040220"
jhash (0x4BB33316)
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_IN_PARTY"
hash "0x966C2BC2A7FE3F30"
jhash (0xF9D7D67D)
ns "NETWORK"
returns "BOOL"
doc [[!
```
Note according to IDA TU27 X360(Console),
This native & 'NETWORK_IS_PARTY_MEMBER' both jump to the same location.
Side note: This location just stops where it's at once jumped to.
Screenshot for side note,
h t t p ://i.imgur.com/m2ci1mF.png
h t t p://i.imgur.com/Z0Wx2B6.png
```
]]
native "NETWORK_IS_IN_PLATFORM_PARTY"
hash "0x2FC5650B0271CB57"
jhash (0xA812B6CB)
alias "0x2FC5650B0271CB57"
ns "NETWORK"
returns "BOOL"
doc [[!
```
Hardcoded to return false.
```
]]
native "NETWORK_IS_IN_PLATFORM_PARTY_CHAT"
hash "0xFD8B834A8BA05048"
jhash (0xC6609191)
alias "0xFD8B834A8BA05048"
ns "NETWORK"
returns "BOOL"
doc [[!
```
Hardcoded to return false.
```
]]
native "NETWORK_IS_IN_SESSION"
hash "0xCA97246103B63917"
jhash (0x4BC4105E)
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_IN_SPECTATOR_MODE"
hash "0x048746E388762E11"
jhash (0x3EAD9DB8)
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_IN_TRANSITION"
hash "0x68049AEFF83D8F0A"
jhash (0xC3CDB626)
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_IN_TUTORIAL_SESSION"
hash "0xADA24309FE08DACF"
jhash (0x34DD7B28)
ns "NETWORK"
annotations [=[ {"cs_type":"Any"} ]=]
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_INACTIVE_PROFILE"
hash "0x7E58745504313A2E"
jhash (0x95481343)
arguments {
intPtr "networkHandle" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
Checks if the networkHandle is the same as any other user that is signed in on the local machine.
For example, if your console has two or more users signed in (on different controllers), the profile that is not controlling the game would be "inactive".
Returns true if the networkHandle is signed in on the same machine, but is not the main player.
]]
native "NETWORK_IS_LOCAL_PLAYER_INVINCIBLE"
hash "0x8A8694B48715B000"
jhash (0x8DE13B36)
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_LOCAL_TALKING"
hash "0xC0D2AF00BCC234CA"
jhash (0xAC00A5BE)
alias "0xC0D2AF00BCC234CA"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_MULTIPLAYER_DISABLED"
hash "0x9747292807126EDA"
jhash (0x05518C0F)
alias "0x9747292807126EDA"
ns "NETWORK"
annotations [=[ {"cs_type":"ScrHandle"} ]=]
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_OFFLINE_INVITE_PENDING"
hash "0x74698374C45701D2"
jhash (0x70ED476A)
alias "0x74698374C45701D2"
ns "NETWORK"
annotations [=[ {"cs_type":"Any"} ]=]
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_PARTICIPANT_ACTIVE"
hash "0x6FF8FF40B6357D45"
jhash (0x4E2C348B)
arguments {
int "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_PARTY_MEMBER"
hash "0x676ED266AADD31E0"
jhash (0x1D0C929D)
arguments {
intPtr "networkHandle" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
```
Note according to IDA TU27 X360(Console),
This native & 'NETWORK_IS_PARTY_MEMBER' both jump to the same location.
Side note: This location just stops where it's at once jumped to.
Screenshot for side note,
h t t p ://i.imgur.com/m2ci1mF.png
h t t p://i.imgur.com/Z0Wx2B6.png
```
]]
native "NETWORK_IS_PENDING_FRIEND"
hash "0x0BE73DA6984A6E33"
jhash (0x5C85FF81)
arguments {
Any "p0" [=[ {} ]=],
}
ns "NETWORK"
annotations [=[ {"cs_type":"BOOL"} ]=]
returns "Any"
doc [[!
```
This function is hard-coded to always return 0.
```
]]
native "NETWORK_IS_PLAYER_A_PARTICIPANT"
hash "0x3CA58F6CB7CBD784"
jhash (0xB08B6992)
arguments {
Player "player" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_PLAYER_A_PARTICIPANT_ON_SCRIPT"
hash "0x1AD5B71586B94820"
jhash (0xCEA55F4C)
arguments {
Player "player1" [=[ {} ]=],
charPtr "script" [=[ {} ]=],
Player "player2" [=[ {} ]=],
}
alias "0x1AD5B71586B94820"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_PLAYER_ACTIVE"
hash "0xB8DFD30D6973E135"
jhash (0x43657B17)
arguments {
Player "player" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_PLAYER_BLOCKED_BY_ME"
hash "0x57AF1F8E27483721"
jhash (0xAE4F4560)
arguments {
Player "player" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_PLAYER_CONCEALED"
hash "0x919B3C98ED8292F9"
jhash (0xB0313590)
arguments {
Player "player" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_PLAYER_CONNECTED"
hash "0x93DC1BE4E1ABE9D1"
jhash (0x168EE2C2)
arguments {
Player "player" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_PLAYER_FADING"
hash "0x631DC5DFF4B110E3"
jhash (0x065C597B)
arguments {
Player "player" [=[ {} ]=],
}
alias "0x631DC5DFF4B110E3"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_PLAYER_IN_MP_CUTSCENE"
hash "0x63F9EE203C3619F2"
jhash (0x56F961E4)
arguments {
Player "player" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_PLAYER_MUTED_BY_ME"
hash "0x8C71288AE68EDE39"
jhash (0x7A21050E)
arguments {
Player "player" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_PLAYER_TALKING"
hash "0x031E11F3D447647E"
jhash (0xDA9FD9DB)
arguments {
Player "player" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
```
returns true if someone is screaming or talking in a microphone
```
]]
native "NETWORK_IS_SCRIPT_ACTIVE"
hash "0x9D40DF90FAD26098"
jhash (0x4A65250C)
arguments {
charPtr "scriptName" [=[ {} ]=],
Player "player" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_SESSION_ACTIVE"
hash "0xD83C2B94E7508980"
jhash (0x715CB8C4)
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_SESSION_BUSY"
hash "0xF4435D66A8E2905E"
jhash (0x8592152D)
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_SESSION_STARTED"
hash "0x9DE624D2FC4B603F"
jhash (0x9D854A37)
ns "NETWORK"
returns "BOOL"
doc [[!
```
This checks if player is playing on gta online or not.
Please add an if and block your mod if this is "true".
```
]]
native "NETWORK_IS_SIGNED_IN"
hash "0x054354A99211EB96"
jhash (0xADD0B40F)
ns "NETWORK"
returns "BOOL"
doc [[!
```
Returns whether the player is signed into Social Club.
```
]]
native "NETWORK_IS_SIGNED_ONLINE"
hash "0x1077788E268557C2"
jhash (0x6E5BDCE2)
ns "NETWORK"
returns "BOOL"
doc [[!
```
Returns whether the game is not in offline mode.
seemed not to work for some ppl
```
]]
native "NETWORK_IS_TRANSITION_BUSY"
hash "0x520F3282A53D26B7"
jhash (0xA357A2C6)
ns "NETWORK"
annotations [=[ {"cs_type":"Any"} ]=]
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_TRANSITION_CLOSED_CREW"
hash "0x0DBD5D7E3C5BEC3B"
jhash (0xB97A966B)
alias "0x0DBD5D7E3C5BEC3B"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_TRANSITION_CLOSED_FRIENDS"
hash "0x6512765E3BE78C50"
jhash (0x95FFACF8)
alias "0x6512765E3BE78C50"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_TRANSITION_HOST"
hash "0x0B824797C9BF2159"
jhash (0x0C0900BC)
ns "NETWORK"
annotations [=[ {"cs_type":"Any"} ]=]
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_TRANSITION_HOST_FROM_HANDLE"
hash "0x6B5C83BA3EFE6A10"
jhash (0x0E2854C4)
arguments {
intPtr "networkHandle" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_TRANSITION_MATCHMAKING"
hash "0x292564C735375EDF"
jhash (0x8262C70E)
alias "0x292564C735375EDF"
ns "NETWORK"
annotations [=[ {"cs_type":"Any"} ]=]
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_TRANSITION_OPEN_TO_MATCHMAKING"
hash "0x37A4494483B9F5C9"
jhash (0xC901AA9F)
alias "0x37A4494483B9F5C9"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_TRANSITION_PRIVATE"
hash "0x5A6AA44FF8E931E6"
jhash (0x104DDE8D)
alias "0x5A6AA44FF8E931E6"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_TRANSITION_SOLO"
hash "0x5DC577201723960A"
jhash (0x063DC4A5)
alias "0x5DC577201723960A"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_TRANSITION_STARTED"
hash "0x53FA83401D9C07FE"
jhash (0x7917E111)
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_TRANSITION_TO_GAME"
hash "0x9D7696D8F4FA6CB7"
jhash (0x17146B2B)
ns "NETWORK"
annotations [=[ {"cs_type":"Any"} ]=]
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_TRANSITION_VISIBILITY_LOCKED"
hash "0xD0A484CB2F829FBE"
jhash (0xF637166E)
alias "0xD0A484CB2F829FBE"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_TUNABLE_CLOUD_REQUEST_PENDING"
hash "0x0467C11ED88B7D28"
jhash (0x47978D7F)
alias "0x0467C11ED88B7D28"
alias "_HAS_TUNABLES_BEEN_DOWNLOADED"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_IS_TUTORIAL_SESSION_CHANGE_PENDING"
hash "0x35F0B98A8387274D"
jhash (0xA003C40B)
alias "0x35F0B98A8387274D"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_JOIN_GROUP_ACTIVITY"
hash "0xA06509A691D12BE4"
jhash (0x0D7E5CF9)
alias "0xA06509A691D12BE4"
ns "NETWORK"
returns "Any"
doc [[!
]]
native "NETWORK_JOIN_PREVIOUSLY_FAILED_SESSION"
hash "0x59DF79317F85A7E0"
jhash (0x6CDAA7D2)
alias "0x59DF79317F85A7E0"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_JOIN_PREVIOUSLY_FAILED_TRANSITION"
hash "0xFFE1E5B792D92B34"
jhash (0xBF21818E)
alias "0xFFE1E5B792D92B34"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_JOIN_TRANSITION"
hash "0x9D060B08CD63321A"
jhash (0xB054EC4B)
arguments {
Player "player" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
```
int handle[76];
NETWORK_HANDLE_FROM_FRIEND(iSelectedPlayer, &handle[0], 13);
Player uVar2 = NETWORK_GET_PLAYER_FROM_GAMER_HANDLE(&handle[0]);
NETWORK_JOIN_TRANSITION(uVar2);
nothing doin.
```
]]
native "NETWORK_LAUNCH_TRANSITION"
hash "0x2DCF46CB1A4F0884"
jhash (0xE3570BA2)
ns "NETWORK"
annotations [=[ {"cs_type":"Any"} ]=]
returns "BOOL"
doc [[!
]]
native "NETWORK_LEAVE_TRANSITION"
hash "0xD23A1A815D21DB19"
jhash (0x3A3599B7)
ns "NETWORK"
annotations [=[ {"cs_type":"Any"} ]=]
returns "BOOL"
doc [[!
]]
native "NETWORK_MARK_TRANSITION_GAMER_AS_FULLY_JOINED"
hash "0x5728BB6D63E3FF1D"
jhash (0x03383F57)
arguments {
AnyPtr "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_MEMBER_ID_FROM_GAMER_HANDLE"
hash "0xC82630132081BB6F"
jhash (0x62EF0A63)
arguments {
intPtr "networkHandle" [=[ {} ]=],
}
ns "NETWORK"
returns "charPtr"
doc [[!
]]
native "NETWORK_OPEN_TRANSITION_MATCHMAKING"
hash "0x2B3A8F7CA3A38FDE"
jhash (0xC71E607B)
alias "0x2B3A8F7CA3A38FDE"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_OVERRIDE_CHAT_RESTRICTIONS"
hash "0x3039AE5AD2C9C0C4"
jhash (0x74EE2D8B)
arguments {
Player "player" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x3039AE5AD2C9C0C4"
ns "NETWORK"
returns "void"
doc [[!
```
Could possibly bypass being muted or automatically muted
```
]]
native "NETWORK_OVERRIDE_CLOCK_TIME"
hash "0xE679E3E06E363892"
jhash (0xC077BCD6)
arguments {
int "hours" [=[ {} ]=],
int "minutes" [=[ {} ]=],
int "seconds" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
Overrides the game clock time for the local player, allowing for manipulation of the in-game time. This native is effective in both multiplayer and singleplayer modes.
**Note:** Passing wrong data (e.g. hours above 23) will cause the game to crash.
The hour to set (0-23).
The minute to set (0-59).
The second to set (0-59).
]]
native "NETWORK_OVERRIDE_COORDS_AND_HEADING"
hash "0xA7E30DE9272B6D49"
jhash (0x644141C5)
arguments {
Entity "entity" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "heading" [=[ {} ]=],
}
alias "0xA7E30DE9272B6D49"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_OVERRIDE_RECEIVE_RESTRICTIONS"
hash "0xDDF73E2B1FEC5AB4"
jhash (0x95F1C60D)
arguments {
Player "player" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0xDDF73E2B1FEC5AB4"
ns "NETWORK"
returns "void"
doc [[!
```
R* uses this to hear all player when spectating.
It allows you to hear other online players when their chat is on none, crew and or friends
```
]]
native "NETWORK_OVERRIDE_RECEIVE_RESTRICTIONS_ALL"
hash "0x0FF2862B61A58AF9"
jhash (0x1BCD3DDF)
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0x0FF2862B61A58AF9"
ns "NETWORK"
returns "void"
doc [[!
```
p0 is always false in scripts.
```
]]
native "NETWORK_OVERRIDE_SEND_RESTRICTIONS"
hash "0x97DD4C5944CC2E6A"
jhash (0x6C344AE3)
arguments {
Player "player" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x97DD4C5944CC2E6A"
alias "_NETWORK_OVERRIDE_SEND_RESTRICTIONS"
ns "NETWORK"
returns "void"
doc [[!
```
This is used alongside the native,
'NETWORK_OVERRIDE_RECEIVE_RESTRICTIONS'. Read its description for more info.
```
]]
native "NETWORK_OVERRIDE_SEND_RESTRICTIONS_ALL"
hash "0x57B192B4D4AD23D5"
jhash (0x2F98B405)
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0x57B192B4D4AD23D5"
alias "_NETWORK_CHAT_MUTE"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_OVERRIDE_TEAM_RESTRICTIONS"
hash "0x6F697A66CE78674E"
jhash (0xC8CC9E75)
arguments {
int "team" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x6F697A66CE78674E"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_OVERRIDE_TRANSITION_CHAT"
hash "0xAF66059A131AA269"
jhash (0xCAB21090)
arguments {
BOOL "p0" [=[ {} ]=],
}
alias "0xAF66059A131AA269"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_PLAYER_GET_CHEATER_REASON"
hash "0x172F75B6EE2233BA"
jhash (0x1720ABA6)
alias "0x172F75B6EE2233BA"
alias "_NETWORK_PLAYER_IS_UNK"
ns "NETWORK"
annotations [=[ {"cs_type":"BOOL"} ]=]
returns "int"
doc [[!
]]
native "NETWORK_PLAYER_GET_NAME"
hash "0x7718D2E2060837D2"
jhash (0xCE48F260)
arguments {
Player "player" [=[ {} ]=],
}
ns "NETWORK"
returns "charPtr"
doc [[!
```
Returns the name of a given player. Returns "**Invalid**" if CPlayerInfo of the given player cannot be retrieved or the player doesn't exist.
```
]]
native "NETWORK_PLAYER_GET_USERID"
hash "0x4927FC39CD0869A0"
jhash (0x4EC0D983)
arguments {
Player "player" [=[ {} ]=],
intPtr "userID" [=[ {"cs_type":"charPtr"} ]=],
}
alias "_NETWORK_PLAYER_GET_USER_ID"
ns "NETWORK"
returns "charPtr"
doc [[!
```
Takes a 24 char buffer. Returns the buffer or "**Invalid**" if CPlayerInfo of the given player cannot be retrieved or the player doesn't exist.
```
]]
native "NETWORK_PLAYER_HAS_HEADSET"
hash "0x3FB99A8B08D18FD6"
jhash (0x451FB6B6)
arguments {
Player "player" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_PLAYER_INDEX_IS_CHEATER"
hash "0x565E430DB3B05BEC"
jhash (0xD265B049)
arguments {
Player "player" [=[ {} ]=],
}
alias "0x565E430DB3B05BEC"
alias "_NETWORK_PLAYER_SOMETHING"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_PLAYER_IS_BADSPORT"
hash "0x19D8DA0E5A68045A"
jhash (0xA19708E3)
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_PLAYER_IS_CHEATER"
hash "0x655B91F1495A9090"
jhash (0xA51DC214)
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_PLAYER_IS_ROCKSTAR_DEV"
hash "0x544ABDDA3B409B6D"
jhash (0xF6659045)
arguments {
Player "player" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
```
Checks if a specific value (BYTE) in CPlayerInfo is nonzero.
Returns always false in Singleplayer.
No longer used for dev checks since first mods were released on PS3 & 360.
R* now checks with the is_dlc_present native for the dlc hash 2532323046,
if that is present it will unlock dev stuff.
```
]]
native "NETWORK_QUERY_RESPAWN_RESULTS"
hash "0x3C891A251567DFCE"
jhash (0x90700C7D)
arguments {
AnyPtr "p0" [=[ {} ]=],
}
alias "0x3C891A251567DFCE"
ns "NETWORK"
returns "Any"
doc [[!
]]
native "NETWORK_QUEUE_GAMER_FOR_STATUS"
hash "0x85A0EF54A500882C"
jhash (0x42BD0780)
arguments {
AnyPtr "p0" [=[ {} ]=],
}
alias "0x85A0EF54A500882C"
alias "_NETWORK_GET_GAMER_STATUS"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_QUIT_MP_TO_DESKTOP"
hash "0x45A83257ED02D9BC"
alias "0x45A83257ED02D9BC"
ns "NETWORK"
returns "void"
doc [[!
Forces the "Are you sure you want to quit Grand Theft Auto V?" warning message (Same as when you Alt+F4) to show.
Doesn't work in singleplayer.
]]
native "NETWORK_REGISTER_ENTITY_AS_NETWORKED"
hash "0x06FAACD625D80CAA"
jhash (0x31A630A4)
arguments {
Entity "entity" [=[ {} ]=],
}
alias "0x06FAACD625D80CAA"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_REGISTER_HOST_BROADCAST_VARIABLES"
hash "0x3E9B2F01C50DF595"
jhash (0xDAF3B0AE)
arguments {
intPtr "vars" [=[ {} ]=],
int "numVars" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_REGISTER_PLAYER_BROADCAST_VARIABLES"
hash "0x3364AA97340CA215"
jhash (0xBE3D32B4)
arguments {
intPtr "vars" [=[ {} ]=],
int "numVars" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_REMOVE_ALL_TRANSITION_INVITE"
hash "0x726E0375C7A26368"
jhash (0xF7134E73)
alias "0x726E0375C7A26368"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_REMOVE_ENTITY_AREA"
hash "0x93CF869BAA0C4874"
jhash (0xEAB97F25)
arguments {
Any "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_REMOVE_PRESENCE_INVITE"
hash "0xF0210268DB0974B1"
jhash (0x93C665FA)
arguments {
Any "p0" [=[ {} ]=],
}
alias "0xF0210268DB0974B1"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_REMOVE_TRANSITION_INVITE"
hash "0x7524B431B2E6F7EE"
jhash (0xFDE84CB7)
arguments {
AnyPtr "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_REQUEST_CLOUD_BACKGROUND_SCRIPTS"
hash "0x924426BFFD82E915"
jhash (0x98EFB921)
alias "0x924426BFFD82E915"
alias "_NETWORK_REQUEST_CLOUD_BACKGROUND_SCRIPTS"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_REQUEST_CLOUD_TUNABLES"
hash "0x42FB3B532D526E6C"
jhash (0xD760CAD5)
alias "0x42FB3B532D526E6C"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_REQUEST_CONTROL_OF_DOOR"
hash "0x870DDFD5A4A796E4"
jhash (0xF60DAAF6)
arguments {
int "doorID" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_REQUEST_CONTROL_OF_ENTITY"
hash "0xB69317BF5E782347"
jhash (0xA05FEBD7)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_REQUEST_CONTROL_OF_NETWORK_ID"
hash "0xA670B3662FAFFBD0"
jhash (0x9262A60A)
arguments {
int "netId" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_RESET_BODY_TRACKER"
hash "0x72433699B4E6DD64"
jhash (0x3914463F)
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_RESURRECT_LOCAL_PLAYER"
hash "0xEA23C49EAA83ACFB"
jhash (0xF1F9D4B4)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "heading" [=[ {} ]=],
int "nInvincibilityTime" [=[ {"cs_type":"BOOL"} ]=],
BOOL "bLeaveDeadPed" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
Revives our local player who was previously dead.
**Note:** Call this once you resurrect the player (this does not need to be called every frame).
```cpp
enum ePlayerSpawnLocation {
// system will decide
SPAWN_LOCATION_AUTOMATIC = 0,
SPAWN_LOCATION_NEAR_DEATH = 1,
SPAWN_LOCATION_NEAR_TEAM_MATES = 2,
// script defined area
SPAWN_LOCATION_MISSION_AREA = 3,
SPAWN_LOCATION_NEAR_OTHER_PLAYERS = 4,
SPAWN_LOCATION_NEAR_CURRENT_POSITION = 5,
SPAWN_LOCATION_AT_CURRENT_POSITION = 6,
SPAWN_LOCATION_NET_TEST_BED = 7,
SPAWN_LOCATION_CUSTOM_SPAWN_POINTS = 8,
SPAWN_LOCATION_OUTSIDE_SIMEON_GARAGE = 9,
SPAWN_LOCATION_NEAR_SPECIFIC_COORDS = 10,
SPAWN_LOCATION_AT_SPECIFIC_COORDS = 11,
SPAWN_LOCATION_AT_AIRPORT_ARRIVALS = 12,
SPAWN_LOCATION_AT_SPECIFIC_COORDS_IF_POSSIBLE = 13,
SPAWN_LOCATION_IN_SPECIFIC_ANGLED_AREA = 14,
SPAWN_LOCATION_NEAREST_RESPAWN_POINT = 15,
SPAWN_LOCATION_AT_SPECIFIC_COORDS_RACE_CORONA = 16,
SPAWN_LOCATION_INSIDE_GARAGE = 17,
SPAWN_LOCATION_INSIDE_PROPERTY = 18,
SPAWN_LOCATION_INSIDE_PROPERTY_OR_GARAGE = 19,
SPAWN_LOCATION_NEAR_DEATH_IMPROMPTU = 20,
SPAWN_LOCATION_NEAR_CURRENT_POSITION_SPREAD_OUT = 21,
SPAWN_LOCATION_NEAREST_RESPAWN_POINT_TO_SPECIFIC_COORDS = 22,
SPAWN_LOCATION_NEAREST_HOSPITAL = 23,
SPAWN_LOCATION_NEAREST_POLICE_STATION = 24,
SPAWN_LOCATION_NEAREST_HOTEL_TO_SPECIFIC_COORDS = 25,
SPAWN_LOCATION_MISSION_AREA_NEAR_CURRENT_POSITION = 26,
SPAWN_LOCATION_PRIVATE_YACHT = 27,
SPAWN_LOCATION_PRIVATE_YACHT_APARTMENT = 28,
SPAWN_LOCATION_PRIVATE_FRIEND_YACHT = 29,
SPAWN_LOCATION_PRIVATE_YACHT_NEAR_SHORE = 30,
SPAWN_LOCATION_NEAR_GANG_BOSS = 31,
SPAWN_LOCATION_NEAR_SPECIFIC_COORDS_WITH_GANG = 32,
SPAWN_LOCATION_GANG_DM = 33,
SPAWN_LOCATION_GANG_BOSS_PRIVATE_YACHT = 34,
SPAWN_LOCATION_OFFICE = 35,
SPAWN_LOCATION_CLUBHOUSE = 36,
SPAWN_LOCATION_NEAR_CURRENT_POSITION_AS_POSSIBLE = 37,
SPAWN_LOCATION_NEAR_CURRENT_PERCEIVED_POSITION = 38,
SPAWN_LOCATION_IE_WAREHOUSE = 39,
SPAWN_LOCATION_BUNKER = 40,
SPAWN_LOCATION_HANGAR = 41,
SPAWN_LOCATION_DEFUNCT_BASE = 42,
SPAWN_LOCATION_NIGHTCLUB = 43,
SPAWN_LOCATION_ARENA_GARAGE = 44,
SPAWN_LOCATION_CASINO = 45,
SPAWN_LOCATION_CASINO_APARTMENT = 46,
SPAWN_LOCATION_CASINO_OUTSIDE = 47,
SPAWN_LOCATION_ARCADE = 48,
SPAWN_LOCATION_CASINO_NIGHTCLUB = 49,
SPAWN_LOCATION_SUBMARINE = 50,
SPAWN_LOCATION_HEIST_ISLAND_NEAR_DEATH = 51,
SPAWN_LOCATION_HEIST_ISLAND_BEACH_PARTY = 52,
SPAWN_LOCATION_LAND_NEAR_SUBMARINE = 53,
SPAWN_LOCATION_CAR_MEET = 54,
SPAWN_LOCATION_AUTO_SHOP = 55,
SPAWN_LOCATION_FIXER_HQ = 56,
SPAWN_LOCATION_SITTING_SMOKING = 57,
SPAWN_LOCATION_DRUNK_WAKE_UP_MUSIC_STUDIO = 58,
SPAWN_LOCATION_MUSIC_STUDIO = 59,
TOTAL_SPAWN_LOCATIONS = 60
};
```
```cpp
enum eSpawnReason {
SPAWN_REASON_DEATH = 0,
SPAWN_REASON_TRANSITION,
SPAWN_REASON_MANUAL,
SPAWN_REASON_RESTORE_CHARACTER,
SPAWN_REASON_IN_VEHICLE
};
```
### Added parameters
* **bUnpauseRenderPhases**: This boolean parameter will unpause the render phases when set to `true`.
* **iSpawnLocation**: This integer parameter sets the player's spawn location metric for telemetry. See `ePlayerSpawnLocation` enum.
* **iSpawnReason**: This integer parameter sets the player's spawn reason metric for telemetry. See `eSpawnReason` enum.
This is the length of time in milliseconds that the player will be invincible for after resurrection.
Leaves the dead ped behind when resurrecting.
]]
native "NETWORK_SEED_RANDOM_NUMBER_GENERATOR"
hash "0xF1B84178F8674195"
jhash (0x41702C8A)
arguments {
int "seed" [=[ {} ]=],
}
alias "0xF1B84178F8674195"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_SEND_INVITE_VIA_PRESENCE"
hash "0xC3C7A6AFDB244624"
jhash (0x8B99B72B)
arguments {
intPtr "networkHandle" [=[ {} ]=],
AnyPtr "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
alias "0xC3C7A6AFDB244624"
alias "_NETWORK_SEND_PRESENCE_INVITE"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_SEND_TEXT_MESSAGE"
hash "0x3A214F2EC889B100"
jhash (0xAFFEA720)
arguments {
charPtr "message" [=[ {} ]=],
intPtr "networkHandle" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
```
Message is limited to 64 characters.
```
]]
native "NETWORK_SEND_TRANSITION_GAMER_INSTRUCTION"
hash "0x31D1D2B858D25E6B"
jhash (0x468B0884)
arguments {
intPtr "networkHandle" [=[ {} ]=],
charPtr "p1" [=[ {} ]=],
int "p2" [=[ {} ]=],
int "p3" [=[ {} ]=],
BOOL "p4" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
```
the first arg seems to be the network player handle (&handle) and the second var is pretty much always "" and the third seems to be a number between 0 and ~10 and the 4th is is something like 0 to 5 and I guess the 5th is a bool cuz it is always 0 or 1
does this send an invite to a player?
```
]]
native "NETWORK_SESSION_ACTIVITY_QUICKMATCH"
hash "0xBE3E347A87ACEB82"
jhash (0x3F75CC38)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
alias "0xBE3E347A87ACEB82"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_SESSION_ADD_ACTIVE_MATCHMAKING_GROUP"
hash "0xCAE55F48D3D7875C"
jhash (0x5BE529F7)
arguments {
int "groupId" [=[ {} ]=],
}
alias "0xCAE55F48D3D7875C"
ns "NETWORK"
returns "void"
doc [[!
An identifier value between zero and four
]]
native "NETWORK_SESSION_BLOCK_JOIN_REQUESTS"
hash "0xA73667484D7037C3"
jhash (0xE6EEF8AF)
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0xA73667484D7037C3"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_SESSION_CANCEL_INVITE"
hash "0x2FBF47B1B36D36F9"
jhash (0x20317535)
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_SESSION_CHANGE_SLOTS"
hash "0xB4AB419E0D86ACAE"
jhash (0x6BB93227)
arguments {
int "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
alias "0xB4AB419E0D86ACAE"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_SESSION_CREW_MATCHMAKING"
hash "0x94BC51E9449D917F"
jhash (0xD7624E6B)
arguments {
int "p0" [=[ {} ]=],
int "p1" [=[ {} ]=],
int "p2" [=[ {} ]=],
int "maxPlayers" [=[ {} ]=],
BOOL "p4" [=[ {} ]=],
}
alias "0x94BC51E9449D917F"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_SESSION_END"
hash "0xA02E59562D711006"
jhash (0xBCACBEA2)
arguments {
BOOL "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
```
p0 is always false and p1 varies.
NETWORK_SESSION_END(0, 1)
NETWORK_SESSION_END(0, 0)
Results in: "Connection to session lost due to an unknown network error. Please return to Grand Theft Auto V and try again later."
```
]]
native "NETWORK_SESSION_ENTER"
hash "0x330ED4D05491934F"
jhash (0x543CD2BE)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
int "maxPlayers" [=[ {} ]=],
Any "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
}
ns "NETWORK"
returns "Any"
doc [[!
```
unknown params
p0 = 0, 2, or 999 (The global is 999 by default.)
p1 = 0 (Always in every script it's found in atleast.)
p2 = 0, 3, or 4 (Based on a var that is determined by a function.)
p3 = maxPlayers (It's obvious in x360 scripts it's always 18)
p4 = 0 (Always in every script it's found in atleast.)
p5 = 0 or 1. (1 if network_can_enter_multiplayer, but set to 0 if other checks after that are passed.)
p5 is reset to 0 if,
Global_1315318 = 0 or Global_1315323 = 9 or 12 or (Global_1312629 = 0 && Global_1312631 = true/1) those are passed.
```
]]
native "NETWORK_SESSION_FORCE_CANCEL_INVITE"
hash "0xA29177F7703B5644"
jhash (0x3FD49D3B)
alias "0xA29177F7703B5644"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_SESSION_FRIEND_MATCHMAKING"
hash "0x2CFC76E0D087C994"
jhash (0x4E53202A)
arguments {
int "p0" [=[ {} ]=],
int "p1" [=[ {} ]=],
int "maxPlayers" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
}
alias "0x2CFC76E0D087C994"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_SESSION_GET_INVITER"
hash "0xE57397B4A3429DD0"
jhash (0xE9C6B3FD)
arguments {
intPtr "networkHandle" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_SESSION_GET_KICK_VOTE"
hash "0xD6D09A6F32F49EF1"
jhash (0x8A559D26)
arguments {
Player "player" [=[ {} ]=],
}
alias "_NETWORK_SESSION_ARE_PLAYERS_VOTING_TO_KICK"
alias "_NETWORK_SESSION_IS_PLAYER_VOTED_TO_KICK"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_SESSION_GET_MATCHMAKING_GROUP_FREE"
hash "0x56CE820830EF040B"
jhash (0x36EAD960)
arguments {
int "p0" [=[ {} ]=],
}
alias "0x56CE820830EF040B"
alias "_NETWORK_SESSION_GET_UNK"
ns "NETWORK"
returns "int"
doc [[!
]]
native "NETWORK_SESSION_GET_PRIVATE_SLOTS"
hash "0x53AFD64C6758F2F9"
jhash (0xE642F2FD)
alias "0x53AFD64C6758F2F9"
ns "NETWORK"
returns "int"
doc [[!
]]
native "NETWORK_SESSION_HOST"
hash "0x6F3D4ED9BEE4E61D"
jhash (0x6716460F)
arguments {
int "p0" [=[ {} ]=],
int "maxPlayers" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
```
Does nothing in online but in offline it will cause the screen to fade to black. Nothing happens past then, the screen will sit at black until you restart GTA. Other stuff must be needed to actually host a session.
```
]]
native "NETWORK_SESSION_HOST_CLOSED"
hash "0xED34C0C02C098BB7"
jhash (0x8AC9EA19)
arguments {
int "p0" [=[ {} ]=],
int "maxPlayers" [=[ {} ]=],
}
alias "0xED34C0C02C098BB7"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_SESSION_HOST_FRIENDS_ONLY"
hash "0xB9CFD27A5D578D83"
jhash (0x26864403)
arguments {
int "p0" [=[ {} ]=],
int "maxPlayers" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
```
Does nothing in online but in offline it will cause the screen to fade to black. Nothing happens past then, the screen will sit at black until you restart GTA. Other stuff must be needed to actually host a session.
```
]]
native "NETWORK_SESSION_HOST_SINGLE_PLAYER"
hash "0xC74C33FCA52856D5"
jhash (0xF3B1CA85)
arguments {
int "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
```
Loads up the map that is loaded when beeing in mission creator
Player gets placed in a mix between online/offline mode
p0 is always 2 in R* scripts.
Appears to be patched in gtav b757 (game gets terminated) alonside with most other network natives to prevent online modding ~ghost30812
```
]]
native "NETWORK_SESSION_IS_CLOSED_CREW"
hash "0x74732C6CA90DA2B4"
jhash (0xA95299B9)
alias "0x74732C6CA90DA2B4"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_SESSION_IS_CLOSED_FRIENDS"
hash "0xFBCFA2EA2E206890"
jhash (0x56E75FE4)
alias "0xFBCFA2EA2E206890"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_SESSION_IS_IN_VOICE_SESSION"
hash "0x855BC38818F6F684"
jhash (0x60AA4AA1)
alias "0x855BC38818F6F684"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_SESSION_IS_PRIVATE"
hash "0xCEF70AA5B3F89BA1"
jhash (0xDB67785D)
alias "0xCEF70AA5B3F89BA1"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_SESSION_IS_SOLO"
hash "0xF3929C2379B60CCE"
jhash (0x3D2C1916)
alias "0xF3929C2379B60CCE"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_SESSION_IS_VISIBLE"
hash "0xBA416D68C631496A"
jhash (0x4977AC28)
alias "0xBA416D68C631496A"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_SESSION_IS_VOICE_SESSION_BUSY"
hash "0xEF0912DDF7C4CB4B"
jhash (0x132CA01E)
alias "0xEF0912DDF7C4CB4B"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_SESSION_JOIN_INVITE"
hash "0xC6F8AB8A4189CF3A"
jhash (0x3D6360B5)
alias "NETWORK_IS_PLAYER_ANIMATION_DRAWING_SYNCHRONIZED"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_SESSION_KICK_PLAYER"
hash "0xFA8904DC5F304220"
jhash (0x1E20138A)
arguments {
Player "player" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
```
Only works as host.
```
]]
native "NETWORK_SESSION_LEAVE_SINGLE_PLAYER"
hash "0x3442775428FD2DAA"
jhash (0xC692F86A)
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_SESSION_MARK_VISIBLE"
hash "0x271CC6AB59EBF9A5"
jhash (0x7017257D)
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0x271CC6AB59EBF9A5"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_SESSION_SET_MATCHMAKING_GROUP"
hash "0x49EC8030F5015F8B"
jhash (0x3C3E2AB6)
arguments {
int "matchmakingGroup" [=[ {} ]=],
}
alias "0x49EC8030F5015F8B"
alias "_NETWORK_SCTV_SLOTS"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_SESSION_SET_MATCHMAKING_GROUP_MAX"
hash "0x8B6A4DD0AF9CE215"
jhash (0x5F29A7E0)
arguments {
int "playerType" [=[ {} ]=],
int "playerCount" [=[ {} ]=],
}
alias "0x8B6A4DD0AF9CE215"
alias "_NETWORK_SESSION_SET_MAX_PLAYERS"
ns "NETWORK"
returns "void"
doc [[!
```
playerTypes:
0 = regular joiner
4 = spectator
8 = unknown
```
]]
native "NETWORK_SESSION_SET_MATCHMAKING_MENTAL_STATE"
hash "0xF1EEA2DDA9FFA69D"
jhash (0x6CC062FC)
arguments {
Any "p0" [=[ {} ]=],
}
alias "0xF1EEA2DDA9FFA69D"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_SESSION_SET_MATCHMAKING_PROPERTY_ID"
hash "0x3F52E880AAF6C8CA"
jhash (0xB3D9A67F)
arguments {
BOOL "p0" [=[ {} ]=],
}
alias "0x3F52E880AAF6C8CA"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_SESSION_VALIDATE_JOIN"
hash "0xC19F6C8E7865A6FF"
jhash (0xF3768F90)
arguments {
BOOL "p0" [=[ {} ]=],
}
alias "0xC19F6C8E7865A6FF"
alias "_NETWORK_SESSION_HOSTED"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_SESSION_VOICE_CONNECT_TO_PLAYER"
hash "0xABD5E88B8A2D3DB2"
jhash (0x9DFD89E6)
arguments {
AnyPtr "globalPtr" [=[ {} ]=],
}
alias "0xABD5E88B8A2D3DB2"
alias "_NETWORK_VOICE_CONNECT_TO_PLAYER"
ns "NETWORK"
returns "void"
doc [[!
```
Only one occurence in the scripts:
auto sub_cb43(auto a_0, auto a_1) {
if (g_2594CB._f1) {
if (NETWORK::_855BC38818F6F684()) {
NETWORK::_ABD5E88B8A2D3DB2(&a_0._fB93);
g_2594CB._f14/*{13}*/ = a_0._fB93;
g_2594CB._f4/*"64"*/ = a_1;
return 1;
}
}
return 0;
}
other:
looks like it passes a player in the paramater
Contains string "NETWORK_VOICE_CONNECT_TO_PLAYER" in ida
```
]]
native "NETWORK_SESSION_VOICE_HOST"
hash "0x9C1556705F864230"
jhash (0x345C2980)
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_SESSION_VOICE_LEAVE"
hash "0x6793E42BE02B575D"
jhash (0xE566C7DA)
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_SESSION_VOICE_RESPOND_TO_REQUEST"
hash "0x7F8413B7FC2AA6B9"
jhash (0x075321B5)
arguments {
BOOL "p0" [=[ {} ]=],
int "p1" [=[ {} ]=],
}
alias "NETWORK_SET_KEEP_FOCUSPOINT"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_SESSION_VOICE_SET_TIMEOUT"
hash "0x5B8ED3DB018927B1"
jhash (0x6EFC2FD0)
arguments {
int "timeout" [=[ {} ]=],
}
alias "_0x5B8ED3DB018927B1"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_SESSION_WAS_INVITED"
hash "0x23DFB504655D0CE4"
jhash (0x6A0BEA60)
alias "0x23DFB504655D0CE4"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_SET_ACTIVITY_PLAYER_MAX"
hash "0x0E4F77F7B9D74D84"
jhash (0x04CB2AB4)
arguments {
int "playerCount" [=[ {} ]=],
}
alias "0x0E4F77F7B9D74D84"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_SET_ACTIVITY_SPECTATOR"
hash "0x75138790B4359A74"
jhash (0xFC9AD060)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_SET_ACTIVITY_SPECTATOR_MAX"
hash "0x9D277B76D1D12222"
jhash (0x74E0BC0A)
arguments {
int "maxSpectators" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_SET_CHOICE_MIGRATE_OPTIONS"
hash "0x5C707A667DF8B9FA"
jhash (0x64235620)
arguments {
BOOL "toggle" [=[ {} ]=],
Player "player" [=[ {} ]=],
}
alias "0x5C707A667DF8B9FA"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_SET_CURRENTLY_SELECTED_GAMER_HANDLE_FROM_INVITE_MENU"
hash "0x7206F674F2A3B1BB"
jhash (0xFD95899E)
arguments {
AnyPtr "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "NETWORK_SET_ENTITY_CAN_BLEND"
hash "0xD830567D88A1E873"
jhash (0xDE8C0DB8)
arguments {
Entity "entity" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_SET_FRIENDLY_FIRE_OPTION"
hash "0xF808475FA571D823"
jhash (0x6BAF95FA)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_SET_GAMER_INVITED_TO_TRANSITION"
hash "0xCA2C8073411ECDB6"
jhash (0x17F1C69D)
arguments {
intPtr "networkHandle" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_SET_IN_FREE_CAM_MODE"
hash "0xFC18DB55AE19E046"
jhash (0xA7E36020)
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0xFC18DB55AE19E046"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_SET_IN_MP_CUTSCENE"
hash "0x9CA5DE655269FEC4"
jhash (0x8434CB43)
arguments {
BOOL "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_SET_IN_SPECTATOR_MODE"
hash "0x423DE3854BB50894"
jhash (0x5C4C8458)
arguments {
BOOL "toggle" [=[ {} ]=],
Ped "playerPed" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_SET_IN_SPECTATOR_MODE_EXTENDED"
hash "0x419594E137637120"
jhash (0x54058F5F)
arguments {
BOOL "toggle" [=[ {} ]=],
Ped "playerPed" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
alias "0x419594E137637120"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_SET_INVITE_ON_CALL_FOR_INVITE_MENU"
hash "0x66F010A4B031A331"
jhash (0x11378777)
arguments {
intPtr "networkHandle" [=[ {} ]=],
}
alias "0x66F010A4B031A331"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_SET_LOCAL_PLAYER_INVINCIBLE_TIME"
hash "0x2D95C7E2D7E07307"
jhash (0xFEA9B85C)
arguments {
int "time" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_SET_LOCAL_PLAYER_SYNC_LOOK_AT"
hash "0x524FF0AEFF9C3973"
jhash (0xB72F086D)
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0x524FF0AEFF9C3973"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_SET_MISSION_FINISHED"
hash "0x3B3D11CD9FFCDFC9"
jhash (0x3083FAD7)
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_SET_NO_SPECTATOR_CHAT"
hash "0xF46A1E03E8755980"
jhash (0xD33AFF79)
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0xF46A1E03E8755980"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_SET_OVERRIDE_SPECTATOR_MODE"
hash "0x70DA3BF8DACD3210"
jhash (0xA0FD42D3)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_SET_PLAYER_IS_PASSIVE"
hash "0x1B857666604B1A74"
jhash (0x76A9FEB6)
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0x1B857666604B1A74"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_SET_PROPERTY_ID"
hash "0x1775961C2FBBCB5C"
jhash (0x5A74E873)
arguments {
int "id" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
```
value must be < 255
```
]]
native "NETWORK_SET_RICH_PRESENCE"
hash "0x1DCCACDCFC569362"
jhash (0x932A6CED)
arguments {
int "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
```
On PC it's a nullsub which means it does absolutely nothing.
Now that Discord supports Rich Presence, R* might finally implement this for PC. Or maybe in future games like RDR2, GTA VI...
```
]]
native "NETWORK_SET_RICH_PRESENCE_STRING"
hash "0x3E200C2BCF4164EB"
jhash (0x017E6777)
arguments {
int "p0" [=[ {} ]=],
charPtr "textLabel" [=[ {} ]=],
}
alias "0x3E200C2BCF4164EB"
alias "_NETWORK_SET_RICH_PRESENCE_2"
ns "NETWORK"
returns "void"
doc [[!
This native does absolutely nothing, just a nullsub
]]
native "NETWORK_SET_SCRIPT_READY_FOR_EVENTS"
hash "0x7AC752103856FB20"
jhash (0xA639DCA2)
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0x7AC752103856FB20"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_SET_TALKER_PROXIMITY"
hash "0xCBF12D65F95AD686"
jhash (0x67555C66)
arguments {
float "value" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_SET_TEAM_ONLY_CHAT"
hash "0xD5B4883AC32F24C3"
jhash (0x3813019A)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_SET_THIS_SCRIPT_IS_NETWORK_SCRIPT"
hash "0x1CA59E306ECB80A5"
jhash (0x470810ED)
arguments {
int "maxNumMissionParticipants" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
int "instanceId" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_SET_TRANSITION_ACTIVITY_ID"
hash "0x30DE938B516F0AD2"
jhash (0xCCA9C022)
arguments {
Any "p0" [=[ {} ]=],
}
alias "0x30DE938B516F0AD2"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_SET_TRANSITION_CREATOR_HANDLE"
hash "0xEF26739BCD9907D5"
jhash (0x1DD01FE7)
arguments {
AnyPtr "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_SET_TRANSITION_VISIBILITY_LOCK"
hash "0x0C978FDA19692C2C"
jhash (0x4AF0ADF5)
arguments {
BOOL "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
alias "0x0C978FDA19692C2C"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_SET_VOICE_ACTIVE"
hash "0xBABEC9E69A91C57B"
jhash (0x8011247F)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_SET_VOICE_CHANNEL"
hash "0xEF6212C2EFEF1A23"
jhash (0x3974879F)
arguments {
int "channel" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_SHOW_PROFILE_UI"
hash "0x859ED1CEA343FCA8"
jhash (0xF00A20B0)
arguments {
intPtr "networkHandle" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
```
Example:
int playerHandle;
NETWORK_HANDLE_FROM_PLAYER(selectedPlayer, &playerHandle, 13);
NETWORK_SHOW_PROFILE_UI(&playerHandle);
```
]]
native "NETWORK_START_RESPAWN_SEARCH_FOR_PLAYER"
hash "0x5A6FFA2433E2F14C"
jhash (0xC62E77B3)
arguments {
Player "player" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "radius" [=[ {} ]=],
float "p5" [=[ {} ]=],
float "p6" [=[ {} ]=],
float "p7" [=[ {} ]=],
int "flags" [=[ {} ]=],
}
alias "0x5A6FFA2433E2F14C"
ns "NETWORK"
returns "BOOL"
doc [[!
```
One of the first things it does is get the players ped.
Then it calls a function that is used in some tasks and ped based functions.
```
p5, p6, p7 is another coordinate (or zero), often related to `GET_BLIP_COORDS`, in the decompiled scripts.
]]
native "NETWORK_START_RESPAWN_SEARCH_IN_ANGLED_AREA_FOR_PLAYER"
hash "0x4BA92A18502BCA61"
jhash (0x74D6B13C)
arguments {
Player "player" [=[ {} ]=],
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
float "width" [=[ {} ]=],
float "p8" [=[ {} ]=],
float "p9" [=[ {} ]=],
float "p10" [=[ {} ]=],
int "flags" [=[ {} ]=],
}
alias "0x4BA92A18502BCA61"
ns "NETWORK"
returns "BOOL"
doc [[!
p8, p9, p10 is another coordinate, or zero, often related to `GET_BLIP_COORDS` in the decompiled scripts.
X dimension of the angled area 'origin'
Y dimension of the angled area 'origin'
Z dimension of the angled area 'origin'
X dimension of the angled area 'extent'
Y dimension of the angled area 'extent'
Z dimension of the angled area 'extent'
Width of the angled area
]]
native "NETWORK_START_SOLO_TUTORIAL_SESSION"
hash "0x17E0198B3882C2CB"
jhash (0x408A9436)
alias "0x17E0198B3882C2CB"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_START_SYNCHRONISED_SCENE"
hash "0x9A1B3FCDB36C8697"
jhash (0xA9DFDC40)
arguments {
int "netScene" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_STOP_SYNCHRONISED_SCENE"
hash "0xC254481A4574CB2F"
jhash (0x97B1CDF6)
arguments {
int "netScene" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_SUPPRESS_INVITE"
hash "0xA0682D67EF1FBA3D"
jhash (0x323DC78C)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_TRY_ACCESS_TUNABLE_BOOL_HASH"
hash "0xC7420099936CE286"
jhash (0x8AFE3D90)
arguments {
Hash "tunableContext" [=[ {} ]=],
Hash "tunableName" [=[ {} ]=],
BOOL "defaultValue" [=[ {} ]=],
}
alias "0xC7420099936CE286"
alias "_NETWORK_ACCESS_TUNABLE_BOOL_HASH_FAIL_VAL"
ns "NETWORK"
returns "BOOL"
doc [[!
```
Returns defaultValue if the tunable doesn't exist.
```
]]
native "NETWORK_UNREGISTER_NETWORKED_ENTITY"
hash "0x7368E683BB9038D6"
jhash (0x5C645F64)
arguments {
Entity "entity" [=[ {} ]=],
}
alias "0x7368E683BB9038D6"
ns "NETWORK"
returns "void"
doc [[!
]]
native "NETWORK_USE_HIGH_PRECISION_BLENDING"
hash "0x2B1813ABA29016C5"
jhash (0x155465EE)
arguments {
int "netID" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x2B1813ABA29016C5"
alias "_NETWORK_SET_NETWORK_ID_DYNAMIC"
ns "NETWORK"
returns "void"
doc [[!
```
Old name: _NETWORK_SET_NETWORK_ID_DYNAMIC
```
]]
native "NETWORK_USE_LOGARITHMIC_BLENDING_THIS_FRAME"
hash "0xCD71A4ECAB22709E"
jhash (0xBC54371B)
arguments {
Entity "entity" [=[ {} ]=],
}
alias "0xCD71A4ECAB22709E"
ns "NETWORK"
returns "void"
doc [[!
]]
native "OBJ_TO_NET"
hash "0x99BFDC94A603E541"
jhash (0x1E05F29F)
arguments {
Object "object" [=[ {} ]=],
}
ns "NETWORK"
returns "int"
doc [[!
```
Lets objects spawn online simply do it like this:
int createdObject = OBJ_TO_NET(CREATE_OBJECT_NO_OFFSET(oball, pCoords.x, pCoords.y, pCoords.z, 1, 0, 0));
```
]]
native "OPEN_COMMERCE_STORE"
hash "0x58C21165F6545892"
jhash (0x365C50EE)
arguments {
charPtr "p0" [=[ {} ]=],
charPtr "p1" [=[ {} ]=],
}
alias "0x58C21165F6545892"
ns "NETWORK"
returns "void"
doc [[!
```
Has a 3rd param (int) since patch [???].
```
```
NativeDB Added Parameter 3: int p2
```
]]
native "PARTICIPANT_ID"
hash "0x90986E8876CE0A83"
jhash (0x9C35A221)
ns "NETWORK"
returns "Player"
doc [[!
```
Return the local Participant ID
```
]]
native "PARTICIPANT_ID_TO_INT"
hash "0x57A3BDDAD8E5AA0A"
jhash (0x907498B0)
ns "NETWORK"
returns "int"
doc [[!
```
Return the local Participant ID.
This native is exactly the same as 'PARTICIPANT_ID' native.
```
]]
native "PED_TO_NET"
hash "0x0EDEC3C276198689"
jhash (0x86A0B759)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "NETWORK"
returns "int"
doc [[!
```
gets the network id of a ped
```
]]
native "REFRESH_PLAYER_LIST_STATS"
hash "0xE26CCFF8094D8C74"
jhash (0xF49C1533)
arguments {
int "p0" [=[ {} ]=],
}
alias "USING_NETWORK_WEAPONTYPE"
alias "0xE26CCFF8094D8C74"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "RELEASE_ALL_COMMERCE_ITEM_IMAGES"
hash "0x72D0706CD6CCDB58"
jhash (0xCA7A0A49)
alias "0x72D0706CD6CCDB58"
ns "NETWORK"
returns "void"
doc [[!
]]
native "REMOVE_ALL_STICKY_BOMBS_FROM_ENTITY"
hash "0x715135F4B82AC90D"
jhash (0xCEAE5AFC)
arguments {
Entity "entity" [=[ {} ]=],
}
alias "0x715135F4B82AC90D"
ns "NETWORK"
returns "void"
doc [[!
```
Used in am_mp_property_ext and am_mp_property_int
```
```
NativeDB Added Parameter 2: Ped ped
```
]]
native "REQUEST_COMMERCE_ITEM_IMAGE"
hash "0xA2F952104FC6DD4B"
jhash (0x1FDC75DC)
arguments {
int "index" [=[ {} ]=],
}
alias "0xA2F952104FC6DD4B"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "RESERVE_NETWORK_MISSION_OBJECTS"
hash "0x4E5C93BD0C32FBF8"
jhash (0x391DF4F3)
arguments {
int "amount" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "RESERVE_NETWORK_MISSION_PEDS"
hash "0xB60FEBA45333D36F"
jhash (0x54998C37)
arguments {
int "amount" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "RESERVE_NETWORK_MISSION_VEHICLES"
hash "0x76B02E21ED27A469"
jhash (0x5062875E)
arguments {
int "amount" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "SET_BALANCE_ADD_MACHINE"
hash "0x815E5E3073DA1D67"
jhash (0xE123C7AC)
arguments {
charPtr "contentId" [=[ {"cs_type":"AnyPtr"} ]=],
charPtr "contentTypeName" [=[ {"cs_type":"AnyPtr"} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "SET_BALANCE_ADD_MACHINES"
hash "0xB8322EEB38BE7C26"
jhash (0x22C33603)
arguments {
AnyPtr "data" [=[ {} ]=],
int "dataCount" [=[ {} ]=],
charPtr "contentTypeName" [=[ {"cs_type":"AnyPtr"} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "SET_ENTITY_LOCALLY_INVISIBLE"
hash "0xE135A9FF3F5D05D8"
jhash (0x51ADCC5F)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
Sets the provided entity not visible for yourself for the current frame.
]]
native "SET_ENTITY_LOCALLY_VISIBLE"
hash "0x241E289B5C059EDC"
jhash (0x235A57B3)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
Sets the provided entity visible for yourself for the current frame.
The entity to set locally visible.
]]
native "SET_ENTITY_VISIBLE_IN_CUTSCENE"
hash "0xE0031D3C8F36AB82"
jhash (0xDBFB067B)
arguments {
Any "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "SET_LOCAL_PLAYER_INVISIBLE_LOCALLY"
hash "0xE5F773C1A1D9D168"
jhash (0x764F6222)
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "SET_LOCAL_PLAYER_VISIBLE_IN_CUTSCENE"
hash "0xD1065D68947E7B6E"
jhash (0x59F3479B)
arguments {
BOOL "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "SET_LOCAL_PLAYER_VISIBLE_LOCALLY"
hash "0x7619364C82D3BF14"
jhash (0x324B56DB)
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "SET_NETWORK_CUTSCENE_ENTITIES"
hash "0xAAA553E7DD28A457"
jhash (0xFD0F7EDD)
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0xAAA553E7DD28A457"
ns "NETWORK"
returns "void"
doc [[!
]]
native "SET_NETWORK_ID_ALWAYS_EXISTS_FOR_PLAYER"
hash "0xA8A024587329F36A"
jhash (0x4D15FDB1)
arguments {
int "netId" [=[ {} ]=],
Player "player" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0xA8A024587329F36A"
alias "_SET_NETWORK_ID_SYNC_TO_PLAYER"
ns "NETWORK"
returns "void"
doc [[!
]]
native "SET_NETWORK_ID_CAN_MIGRATE"
hash "0x299EEB23175895FC"
jhash (0x47C8E5FF)
arguments {
int "netId" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
```
Whether or not another player is allowed to take control of the entity
```
]]
native "SET_NETWORK_ID_EXISTS_ON_ALL_MACHINES"
hash "0xE05E81A888FA63C8"
jhash (0x68D486B2)
arguments {
int "netId" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "SET_NETWORK_ID_VISIBLE_IN_CUTSCENE"
hash "0xA6928482543022B4"
jhash (0x199E75EF)
arguments {
int "netId" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "SET_NETWORK_VEHICLE_AS_GHOST"
hash "0x6274C4712850841E"
jhash (0xEA235081)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x6274C4712850841E"
alias "_SET_NETWORK_OBJECT_NON_CONTACT"
ns "NETWORK"
returns "void"
doc [[!
]]
native "SET_NETWORK_VEHICLE_RESPOT_TIMER"
hash "0xEC51713AB6EC36E8"
jhash (0x2C30912D)
arguments {
int "netId" [=[ {} ]=],
int "time" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
```
NativeDB Added Parameter 3: Any p2
NativeDB Added Parameter 4: Any p3
```
]]
native "SET_PLAYER_INVISIBLE_LOCALLY"
hash "0x12B37D54667DB0B8"
jhash (0x18227209)
arguments {
Player "player" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "SET_PLAYER_VISIBLE_LOCALLY"
hash "0xFAA10F1FAFB11AF2"
jhash (0xBA2BB4B4)
arguments {
Player "player" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "SET_STORE_ENABLED"
hash "0x9641A9FF718E9C5E"
jhash (0xC1F6443B)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
```
Access to the store for shark cards etc...
```
]]
native "SHUTDOWN_AND_LAUNCH_SINGLE_PLAYER_GAME"
hash "0x593850C16A36B692"
jhash (0x92B7351C)
ns "NETWORK"
returns "void"
doc [[!
```
Starts a new singleplayer game (at the prologue).
```
]]
native "TEXTURE_DOWNLOAD_GET_NAME"
hash "0x3448505B6E35262D"
jhash (0xA40EF65A)
arguments {
int "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "charPtr"
doc [[!
]]
native "TEXTURE_DOWNLOAD_HAS_FAILED"
hash "0x5776ED562C134687"
jhash (0xE4547765)
arguments {
int "p0" [=[ {} ]=],
}
alias "0x5776ED562C134687"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "TEXTURE_DOWNLOAD_RELEASE"
hash "0x487EB90B98E9FB19"
jhash (0xEE8D9E70)
arguments {
int "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "TEXTURE_DOWNLOAD_REQUEST"
hash "0x16160DA74A8E74A2"
jhash (0xAD546CC3)
arguments {
intPtr "PlayerHandle" [=[ {} ]=],
charPtr "FilePath" [=[ {} ]=],
charPtr "Name" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
}
ns "NETWORK"
returns "int"
doc [[!
]]
native "TITLE_TEXTURE_DOWNLOAD_REQUEST"
hash "0x0B203B4AFDE53A4F"
jhash (0x1856D008)
arguments {
charPtr "FilePath" [=[ {} ]=],
charPtr "Name" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
alias "0x0B203B4AFDE53A4F"
ns "NETWORK"
returns "int"
doc [[!
]]
native "UGC_CANCEL_QUERY"
hash "0xE9B99B6853181409"
jhash (0x021D5A94)
alias "0xE9B99B6853181409"
ns "NETWORK"
returns "void"
doc [[!
]]
native "UGC_CLEAR_CREATE_RESULT"
hash "0x17440AA15D1D3739"
jhash (0x133FF2D5)
alias "0x17440AA15D1D3739"
ns "NETWORK"
returns "void"
doc [[!
]]
native "UGC_CLEAR_MODIFY_RESULT"
hash "0xA1E5E0204A6FCC70"
jhash (0x405ECA16)
alias "0xA1E5E0204A6FCC70"
ns "NETWORK"
returns "void"
doc [[!
]]
native "UGC_CLEAR_OFFLINE_QUERY"
hash "0x61A885D3F7CFEE9A"
jhash (0xE13C1F7F)
alias "0x61A885D3F7CFEE9A"
ns "NETWORK"
returns "void"
doc [[!
]]
native "UGC_CLEAR_QUERY_RESULTS"
hash "0xBA96394A0EECFA65"
jhash (0x0D35DD93)
alias "0xBA96394A0EECFA65"
ns "NETWORK"
returns "void"
doc [[!
]]
native "UGC_COPY_CONTENT"
hash "0x152D90E4C1B4738A"
jhash (0x08243B79)
arguments {
AnyPtr "p0" [=[ {} ]=],
AnyPtr "p1" [=[ {} ]=],
}
alias "0x152D90E4C1B4738A"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "UGC_DID_GET_SUCCEED"
hash "0x941E5306BCD7C2C7"
jhash (0x3970B0DA)
alias "0x941E5306BCD7C2C7"
ns "NETWORK"
returns "Any"
doc [[!
]]
native "UGC_GET_BOOKMARKED_CONTENT"
hash "0xD5A4B59980401588"
jhash (0x4609D596)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
AnyPtr "p2" [=[ {} ]=],
AnyPtr "p3" [=[ {} ]=],
}
alias "0xD5A4B59980401588"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "UGC_GET_CACHED_DESCRIPTION"
hash "0x40F7E66472DF3E5C"
jhash (0x70A2845C)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
alias "0x40F7E66472DF3E5C"
ns "NETWORK"
returns "charPtr"
doc [[!
]]
native "UGC_GET_CONTENT_CATEGORY"
hash "0xA7BAB11E7C9C6C5A"
jhash (0x5E8A7559)
arguments {
int "p0" [=[ {} ]=],
}
alias "0xA7BAB11E7C9C6C5A"
alias "_GET_CONTENT_CATEGORY"
ns "NETWORK"
returns "int"
doc [[!
]]
native "UGC_GET_CONTENT_DESCRIPTION_HASH"
hash "0x7CF0448787B23758"
jhash (0x91534C6E)
arguments {
Any "p0" [=[ {} ]=],
}
alias "0x7CF0448787B23758"
alias "_GET_CONTENT_DESCRIPTION_HASH"
ns "NETWORK"
returns "int"
doc [[!
]]
native "UGC_GET_CONTENT_FILE_VERSION"
hash "0x37025B27D9B658B1"
jhash (0xFF7D44E6)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
alias "0x37025B27D9B658B1"
alias "_GET_CONTENT_FILE_VERSION"
ns "NETWORK"
returns "Any"
doc [[!
]]
native "UGC_GET_CONTENT_HAS_PLAYER_BOOKMARKED"
hash "0x993CBE59D350D225"
jhash (0x0DEB3F5A)
arguments {
Any "p0" [=[ {} ]=],
}
alias "0x993CBE59D350D225"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "UGC_GET_CONTENT_HAS_PLAYER_RECORD"
hash "0x70EA8DA57840F9BE"
jhash (0x11DC0F27)
arguments {
Any "p0" [=[ {} ]=],
}
alias "0x70EA8DA57840F9BE"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "UGC_GET_CONTENT_HASH"
hash "0x3A17A27D75C74887"
jhash (0x8E1D8F78)
alias "0x3A17A27D75C74887"
ns "NETWORK"
annotations [=[ {"cs_type":"Any"} ]=]
returns "Hash"
doc [[!
]]
native "UGC_GET_CONTENT_ID"
hash "0x55AA95F481D694D2"
jhash (0x331AEABF)
arguments {
int "p0" [=[ {} ]=],
}
alias "0x55AA95F481D694D2"
alias "_GET_CONTENT_ID"
ns "NETWORK"
returns "charPtr"
doc [[!
```
Return the mission id of a job.
```
]]
native "UGC_GET_CONTENT_IS_PUBLISHED"
hash "0x3054F114121C21EA"
jhash (0xA850DDE1)
arguments {
Any "p0" [=[ {} ]=],
}
alias "0x3054F114121C21EA"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "UGC_GET_CONTENT_IS_VERIFIED"
hash "0xA9240A96C74CCA13"
jhash (0x8F6754AE)
arguments {
Any "p0" [=[ {} ]=],
}
alias "0xA9240A96C74CCA13"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "UGC_GET_CONTENT_LANGUAGE"
hash "0x32DD916F3F7C9672"
jhash (0xA2C5BD9D)
arguments {
Any "p0" [=[ {} ]=],
}
alias "0x32DD916F3F7C9672"
ns "NETWORK"
returns "Any"
doc [[!
]]
native "UGC_GET_CONTENT_NAME"
hash "0xBF09786A7FCAB582"
jhash (0xA5A0C695)
arguments {
Any "p0" [=[ {} ]=],
}
alias "0xBF09786A7FCAB582"
ns "NETWORK"
returns "charPtr"
doc [[!
]]
native "UGC_GET_CONTENT_NUM"
hash "0xE0A6138401BCB837"
jhash (0x2DE69817)
alias "0xE0A6138401BCB837"
ns "NETWORK"
returns "Any"
doc [[!
]]
native "UGC_GET_CONTENT_PATH"
hash "0xBAF6BABF9E7CCC13"
jhash (0x744A9EA5)
arguments {
int "p0" [=[ {} ]=],
int "p1" [=[ {"cs_type":"AnyPtr"} ]=],
}
alias "0xBAF6BABF9E7CCC13"
alias "_UGC_GET_CLOUD_PATH"
ns "NETWORK"
returns "charPtr"
doc [[!
]]
native "UGC_GET_CONTENT_RATING"
hash "0x1ACCFBA3D8DAB2EE"
jhash (0x1E34953F)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
alias "0x1ACCFBA3D8DAB2EE"
ns "NETWORK"
returns "Any"
doc [[!
]]
native "UGC_GET_CONTENT_RATING_COUNT"
hash "0x759299C5BB31D2A9"
jhash (0x771FE190)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
alias "0x759299C5BB31D2A9"
ns "NETWORK"
returns "Any"
doc [[!
]]
native "UGC_GET_CONTENT_RATING_NEGATIVE_COUNT"
hash "0x4E548C0D7AE39FF9"
jhash (0x41A0FB02)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
alias "0x4E548C0D7AE39FF9"
ns "NETWORK"
returns "Any"
doc [[!
]]
native "UGC_GET_CONTENT_RATING_POSITIVE_COUNT"
hash "0x87E5C46C187FE0AE"
jhash (0x3276D9D3)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
alias "0x87E5C46C187FE0AE"
ns "NETWORK"
returns "Any"
doc [[!
]]
native "UGC_GET_CONTENT_TOTAL"
hash "0x769951E2455E2EB5"
jhash (0x81BD8D3B)
alias "0x769951E2455E2EB5"
ns "NETWORK"
returns "Any"
doc [[!
]]
native "UGC_GET_CONTENT_UPDATED_DATE"
hash "0xCFD115B373C0DF63"
jhash (0xA19A238D)
arguments {
Any "p0" [=[ {} ]=],
AnyPtr "p1" [=[ {} ]=],
}
alias "0xCFD115B373C0DF63"
ns "NETWORK"
returns "void"
doc [[!
]]
native "UGC_GET_CONTENT_USER_ID"
hash "0xCD67AD041A394C9C"
jhash (0x8F3137E6)
arguments {
int "p0" [=[ {} ]=],
}
alias "0xCD67AD041A394C9C"
alias "_GET_CONTENT_USER_ID"
alias "GET_PLAYER_ADVANCED_MODIFIER_PRIVILEGES"
ns "NETWORK"
returns "charPtr"
doc [[!
]]
native "UGC_GET_CONTENT_USER_NAME"
hash "0x703F12425ECA8BF5"
jhash (0xB9137BA7)
arguments {
Any "p0" [=[ {} ]=],
}
alias "0x703F12425ECA8BF5"
ns "NETWORK"
returns "charPtr"
doc [[!
]]
native "UGC_GET_CREATE_CONTENT_ID"
hash "0xC55A0B40FFB1ED23"
jhash (0x82146BE9)
alias "0xC55A0B40FFB1ED23"
ns "NETWORK"
returns "charPtr"
doc [[!
]]
native "UGC_GET_CREATE_RESULT"
hash "0xFBC5E768C7A77A6A"
jhash (0xCE569932)
alias "0xFBC5E768C7A77A6A"
ns "NETWORK"
returns "Any"
doc [[!
]]
native "UGC_GET_CREATOR_NUM"
hash "0x597F8DBA9B206FC7"
jhash (0x410C61D1)
alias "0x597F8DBA9B206FC7"
ns "NETWORK"
returns "Any"
doc [[!
]]
native "UGC_GET_CREW_CONTENT"
hash "0x9F6E2821885CAEE2"
jhash (0xA6D8B798)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
AnyPtr "p3" [=[ {} ]=],
AnyPtr "p4" [=[ {} ]=],
}
alias "0x9F6E2821885CAEE2"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "UGC_GET_FRIEND_CONTENT"
hash "0xF9E1CCAE8BA4C281"
jhash (0x9EFBD5D1)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
AnyPtr "p2" [=[ {} ]=],
AnyPtr "p3" [=[ {} ]=],
}
alias "0xF9E1CCAE8BA4C281"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "UGC_GET_GET_BY_CATEGORY"
hash "0x678BB03C1A3BD51E"
jhash (0x67E74842)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
AnyPtr "p3" [=[ {} ]=],
AnyPtr "p4" [=[ {} ]=],
}
alias "0x678BB03C1A3BD51E"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "UGC_GET_MODIFY_RESULT"
hash "0x5A0A3D1A186A5508"
jhash (0x1F0DD8AF)
alias "0x5A0A3D1A186A5508"
ns "NETWORK"
returns "Any"
doc [[!
]]
native "UGC_GET_MY_CONTENT"
hash "0x3195F8DD0D531052"
jhash (0x4C2C0D1F)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
AnyPtr "p2" [=[ {} ]=],
AnyPtr "p3" [=[ {} ]=],
}
alias "0x3195F8DD0D531052"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "UGC_GET_QUERY_RESULT"
hash "0xEDF7F927136C224B"
jhash (0xCC2356E3)
alias "0xEDF7F927136C224B"
ns "NETWORK"
returns "Any"
doc [[!
]]
native "UGC_GET_ROOT_CONTENT_ID"
hash "0xC0173D6BFF4E0348"
jhash (0x0E5E8E5C)
arguments {
int "p0" [=[ {} ]=],
}
alias "0xC0173D6BFF4E0348"
alias "_GET_ROOT_CONTENT_ID"
ns "NETWORK"
returns "charPtr"
doc [[!
```
Return the root content id of a job.
```
]]
native "UGC_HAS_CREATE_FINISHED"
hash "0x5E24341A7F92A74B"
jhash (0xE69E8D0D)
alias "0x5E24341A7F92A74B"
ns "NETWORK"
annotations [=[ {"cs_type":"Any"} ]=]
returns "BOOL"
doc [[!
]]
native "UGC_HAS_GET_FINISHED"
hash "0x02ADA21EA2F6918F"
jhash (0x50296140)
alias "0x02ADA21EA2F6918F"
ns "NETWORK"
annotations [=[ {"cs_type":"Any"} ]=]
returns "BOOL"
doc [[!
]]
native "UGC_HAS_MODIFY_FINISHED"
hash "0x299EF3C576773506"
jhash (0x611E0BE2)
alias "0x299EF3C576773506"
ns "NETWORK"
annotations [=[ {"cs_type":"Any"} ]=]
returns "BOOL"
doc [[!
]]
native "UGC_IS_GETTING"
hash "0xD53ACDBEF24A46E8"
jhash (0x4908A514)
alias "0xD53ACDBEF24A46E8"
ns "NETWORK"
annotations [=[ {"cs_type":"Any"} ]=]
returns "BOOL"
doc [[!
]]
native "UGC_IS_LANGUAGE_SUPPORTED"
hash "0xF53E48461B71EECB"
jhash (0xB4668B23)
arguments {
Any "p0" [=[ {} ]=],
}
alias "0xF53E48461B71EECB"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "UGC_POLICIES_MAKE_PRIVATE"
hash "0x5CAE833B0EE0C500"
jhash (0x0D4F845D)
arguments {
Any "p0" [=[ {} ]=],
}
alias "0x5CAE833B0EE0C500"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "UGC_PUBLISH"
hash "0x1DE0F5F50D723CAA"
jhash (0xAD334B40)
arguments {
charPtr "contentId" [=[ {} ]=],
charPtr "baseContentId" [=[ {} ]=],
charPtr "contentTypeName" [=[ {} ]=],
}
alias "0x1DE0F5F50D723CAA"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "UGC_QUERY_BY_CONTENT_ID"
hash "0x158EC424F35EC469"
jhash (0xDED82A6E)
arguments {
charPtr "contentId" [=[ {} ]=],
BOOL "latestVersion" [=[ {} ]=],
charPtr "contentTypeName" [=[ {} ]=],
}
alias "0x158EC424F35EC469"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "UGC_QUERY_BY_CONTENT_IDS"
hash "0xC7397A83F7A2A462"
jhash (0x47B3C35E)
arguments {
AnyPtr "data" [=[ {} ]=],
int "count" [=[ {} ]=],
BOOL "latestVersion" [=[ {} ]=],
charPtr "contentTypeName" [=[ {} ]=],
}
alias "0xC7397A83F7A2A462"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "UGC_QUERY_MY_CONTENT"
hash "0x9BF438815F5D96EA"
jhash (0xCBA7242F)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
AnyPtr "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
}
alias "0x9BF438815F5D96EA"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "UGC_REQUEST_CACHED_DESCRIPTION"
hash "0x5E0165278F6339EE"
jhash (0x1C4F9FDB)
arguments {
int "p0" [=[ {} ]=],
}
alias "0x5E0165278F6339EE"
ns "NETWORK"
returns "int"
doc [[!
]]
native "UGC_REQUEST_CONTENT_DATA_FROM_INDEX"
hash "0x171DF6A0C07FB3DC"
jhash (0x84315226)
arguments {
int "p0" [=[ {} ]=],
int "p1" [=[ {} ]=],
}
alias "0x171DF6A0C07FB3DC"
ns "NETWORK"
returns "int"
doc [[!
]]
native "UGC_REQUEST_CONTENT_DATA_FROM_PARAMS"
hash "0x7FD2990AF016795E"
jhash (0x38FC2EEB)
arguments {
charPtr "contentTypeName" [=[ {} ]=],
charPtr "contentId" [=[ {} ]=],
int "p2" [=[ {} ]=],
int "p3" [=[ {} ]=],
int "p4" [=[ {} ]=],
}
alias "0x7FD2990AF016795E"
ns "NETWORK"
returns "int"
doc [[!
]]
native "UGC_SET_BOOKMARKED"
hash "0x274A1519DFC1094F"
jhash (0x980D45D7)
arguments {
charPtr "contentId" [=[ {} ]=],
BOOL "bookmarked" [=[ {} ]=],
charPtr "contentTypeName" [=[ {} ]=],
}
alias "0x274A1519DFC1094F"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "UGC_SET_DELETED"
hash "0xD05D1A6C74DA3498"
jhash (0x48CCC328)
arguments {
AnyPtr "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
AnyPtr "p2" [=[ {} ]=],
}
alias "0xD05D1A6C74DA3498"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "UGC_SET_QUERY_DATA_FROM_OFFLINE"
hash "0xF98DDE0A8ED09323"
jhash (0x213C6D36)
arguments {
BOOL "p0" [=[ {} ]=],
}
alias "0xF98DDE0A8ED09323"
ns "NETWORK"
returns "void"
doc [[!
]]
native "UGC_TEXTURE_DOWNLOAD_REQUEST"
hash "0x308F96458B7087CC"
jhash (0x68C9AF69)
arguments {
AnyPtr "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
AnyPtr "p4" [=[ {} ]=],
BOOL "p5" [=[ {} ]=],
}
alias "0x308F96458B7087CC"
ns "NETWORK"
returns "Any"
doc [[!
]]
native "USE_PLAYER_COLOUR_INSTEAD_OF_TEAM_COLOUR"
hash "0x77758139EC9B66C7"
jhash (0x4DD46DAE)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "VEH_TO_NET"
hash "0xB4C94523F023419C"
jhash (0xF17634EB)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "NETWORK"
returns "int"
doc [[!
```
calls from vehicle to net.
```
]]
native "_ACTIVATE_DAMAGE_TRACKER_ON_PLAYER"
hash "0xBEC0816FF5ACBCDA"
arguments {
Player "player" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0xBEC0816FF5ACBCDA"
ns "NETWORK"
returns "void"
doc [[!
]]
native "_CAN_REGISTER_MISSION_PICKUPS"
hash "0x0A49D1CB6E34AF72"
arguments {
int "amount" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "_CLEAR_LAUNCH_PARAMS"
hash "0x966DD84FB6A46017"
alias "0x966DD84FB6A46017"
ns "NETWORK"
returns "void"
doc [[!
**This native does absolutely nothing, just a nullsub**
]]
native "_FACEBOOK_DO_UNK_CHECK"
hash "0xA75E2B6733DA5142"
jhash (0x11E8B5CD)
alias "0xA75E2B6733DA5142"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "_FACEBOOK_IS_AVAILABLE"
hash "0x43865688AE10F0D7"
jhash (0x429AEAB3)
alias "0x43865688AE10F0D7"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "_FACEBOOK_IS_SENDING_DATA"
hash "0x62B9FEC9A11F10EF"
jhash (0x37A28C26)
alias "0x62B9FEC9A11F10EF"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "_FACEBOOK_SET_CREATE_CHARACTER_COMPLETE"
hash "0xDC48473142545431"
jhash (0x02DAD93F)
alias "0xDC48473142545431"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "_FACEBOOK_SET_HEIST_COMPLETE"
hash "0x098AB65B9ED9A9EC"
jhash (0x30B51753)
arguments {
charPtr "heistName" [=[ {} ]=],
int "cashEarned" [=[ {} ]=],
int "xpEarned" [=[ {} ]=],
}
alias "0x098AB65B9ED9A9EC"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "_FACEBOOK_SET_MILESTONE_COMPLETE"
hash "0x0AE1F1653B554AB9"
jhash (0x2D947814)
arguments {
int "milestoneId" [=[ {} ]=],
}
alias "0x0AE1F1653B554AB9"
ns "NETWORK"
returns "BOOL"
doc [[!
```
milestoneId:
0 = "percentcomplete"
1 = "storycomplete"
2 = "vehicles"
3 = "properties"
4 = "psych"
5 = "mapreveal"
6 = "prologue"
```
]]
native "_GET_CLOUD_TIME_AS_STRING"
hash "0xF12E6CD06C73D69E"
alias "0xF12E6CD06C73D69E"
ns "NETWORK"
returns "charPtr"
doc [[!
```
Same as GET_CLOUD_TIME_AS_INT but returns the value as a hex string (%I64X).
```
]]
native "_GET_ONLINE_VERSION"
hash "0xFCA9373EF340AC0A"
alias "_GET_GAME_VERSION"
ns "NETWORK"
returns "charPtr"
doc [[!
```
Online version is defined here: update\update.rpf\common\data\version.txt
Example:
[ONLINE_VERSION_NUMBER]
1.33
_GET_ONLINE_VERSION() will return "1.33"
```
]]
native "_IS_DAMAGE_TRACKER_ACTIVE_ON_PLAYER"
hash "0xB2092A1EAA7FD45F"
arguments {
Player "player" [=[ {} ]=],
}
alias "0xB2092A1EAA7FD45F"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "_IS_ENTITY_GHOSTED_TO_LOCAL_PLAYER"
hash "0x21D04D7BC538C146"
arguments {
Entity "entity" [=[ {} ]=],
}
alias "0x21D04D7BC538C146"
alias "_IS_ENTITY_A_GHOST"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "_NETWORK_ACCEPT_INVITE"
hash "0x62A0296C1BB1CEB3"
jhash (0x0907A6BF)
alias "0x62A0296C1BB1CEB3"
ns "NETWORK"
returns "BOOL"
doc [[!
```
NETWORK_RE*
Triggers a CEventNetworkInviteConfirmed event
```
]]
native "_NETWORK_ALLOCATE_TUNABLES_REGISTRATION_DATA_MAP"
hash "0xFAFC23AEE23868DB"
alias "0xFAFC23AEE23868DB"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "_NETWORK_ARE_CUTSCENE_ENTITIES"
hash "0x66D6A5E9C511214A"
ns "NETWORK"
returns "BOOL"
doc [[!
```
Getter for SET_NETWORK_CUTSCENE_ENTITIES.
```
```
NativeDB Introduced: v2699
```
]]
native "_NETWORK_BAIL_TRANSITION_QUICKMATCH"
hash "0x023782EFC70585EE"
ns "NETWORK"
returns "void"
doc [[!
```
NativeDB Introduced: v2699
```
]]
native "_NETWORK_BLOCK_KICKED_PLAYERS"
hash "0x6B07B9CE4D390375"
jhash (0x0FCE995D)
arguments {
BOOL "p0" [=[ {} ]=],
}
alias "0x6B07B9CE4D390375"
ns "NETWORK"
returns "void"
doc [[!
]]
native "_NETWORK_CAN_COMMUNICATE_WITH_GAMER_2"
hash "0x8F5D1AD832AEB06C"
arguments {
AnyPtr "networkHandle" [=[ {} ]=],
}
alias "0x8F5D1AD832AEB06C"
ns "NETWORK"
returns "BOOL"
doc [[!
```
Same as NETWORK_CAN_COMMUNICATE_WITH_GAMER
NETWORK_CAN_*
```
]]
native "_NETWORK_CAN_GAMER_PLAY_MULTIPLAYER_WITH_ME"
hash "0x135F9B7B7ADD2185"
arguments {
AnyPtr "networkHandle" [=[ {} ]=],
}
alias "0x135F9B7B7ADD2185"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "_NETWORK_CAN_PLAY_MULTIPLAYER_WITH_GAMER"
hash "0x07DD29D5E22763F1"
arguments {
AnyPtr "networkHandle" [=[ {} ]=],
}
alias "0x07DD29D5E22763F1"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "_NETWORK_CAN_VIEW_GAMER_USER_CONTENT"
hash "0xB57A49545BA53CE7"
arguments {
AnyPtr "networkHandle" [=[ {} ]=],
}
alias "0xB57A49545BA53CE7"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "_NETWORK_CLAN_ANIMATION"
hash "0x729E3401F0430686"
jhash (0xBDA90BAC)
arguments {
charPtr "animDict" [=[ {} ]=],
charPtr "animName" [=[ {} ]=],
}
alias "0x729E3401F0430686"
ns "NETWORK"
returns "BOOL"
doc [[!
```
Only documented...
```
]]
native "_NETWORK_CONCEAL_ENTITY"
hash "0x1632BE0AC1E62876"
arguments {
Entity "entity" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "_NETWORK_DISPLAYNAMES_FROM_HANDLES_START"
hash "0xD66C9E72B3CC4982"
arguments {
AnyPtr "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
alias "0xD66C9E72B3CC4982"
ns "NETWORK"
returns "int"
doc [[!
```
Hardcoded to return -1.
```
]]
native "_NETWORK_GET_AVERAGE_LATENCY_FOR_PLAYER"
hash "0xD414BE129BB81B32"
arguments {
Player "player" [=[ {} ]=],
}
alias "0xD414BE129BB81B32"
ns "NETWORK"
returns "float"
doc [[!
```
NativeDB Introduced: v323
```
]]
native "_NETWORK_GET_AVERAGE_LATENCY_FOR_PLAYER_2"
hash "0x0E3A041ED6AC2B45"
arguments {
Player "player" [=[ {} ]=],
}
alias "0x0E3A041ED6AC2B45"
ns "NETWORK"
returns "float"
doc [[!
```
Same as _NETWORK_GET_AVERAGE_LATENCY_FOR_PLAYER (0xD414BE129BB81B32)
```
```
NativeDB Introduced: v323
```
]]
native "_NETWORK_GET_AVERAGE_PACKET_LOSS_FOR_PLAYER"
hash "0x350C23949E43686C"
arguments {
Player "player" [=[ {} ]=],
}
alias "0x350C23949E43686C"
ns "NETWORK"
returns "float"
doc [[!
```
NETWORK_GET_*
NativeDB Introduced: v323
```
]]
native "_NETWORK_GET_DESTROYER_OF_ENTITY"
hash "0x4CACA84440FA26F6"
jhash (0x28A45454)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
HashPtr "weaponHash" [=[ {} ]=],
}
alias "0x4CACA84440FA26F6"
alias "_NETWORK_GET_DESROYER_OF_ENTITY"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "_NETWORK_GET_DISPLAYNAMES_FROM_HANDLES"
hash "0x58CC181719256197"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
alias "0x58CC181719256197"
ns "NETWORK"
returns "int"
doc [[!
Hard-coded to always return 0.
]]
native "_NETWORK_GET_ENTITY_NET_SCRIPT_ID"
hash "0x815F18AD865F057F"
arguments {
Entity "entity" [=[ {} ]=],
}
alias "0x815F18AD865F057F"
ns "NETWORK"
returns "int"
doc [[!
]]
native "_NETWORK_GET_FRIEND_NAME_FROM_INDEX"
hash "0x4164F227D052E293"
arguments {
int "friendIndex" [=[ {} ]=],
}
ns "NETWORK"
returns "charPtr"
doc [[!
]]
native "_NETWORK_GET_LAST_VELOCITY_RECEIVED"
hash "0x33DE49EDF4DDE77A"
arguments {
Entity "entity" [=[ {} ]=],
}
alias "0x33DE49EDF4DDE77A"
ns "NETWORK"
returns "Vector3"
doc [[!
```
Used by NetBlender
```
]]
native "_NETWORK_GET_NUM_BODY_TRACKERS"
hash "0xD38C4A6D047C019D"
jhash (0x17CBC608)
alias "0xD38C4A6D047C019D"
ns "NETWORK"
returns "int"
doc [[!
]]
native "_NETWORK_GET_NUM_UNACKED_FOR_PLAYER"
hash "0xFF8FCF9FFC458A1C"
arguments {
Player "player" [=[ {} ]=],
}
ns "NETWORK"
returns "int"
doc [[!
```
NativeDB Introduced: v323
```
]]
native "_NETWORK_GET_OLDEST_RESEND_COUNT_FOR_PLAYER"
hash "0x52C1EADAF7B10302"
arguments {
Player "player" [=[ {} ]=],
}
ns "NETWORK"
returns "int"
doc [[!
```
NETWORK_GET_*
NativeDB Introduced: v323
```
]]
native "_NETWORK_GET_PLATFORM_PARTY_UNK"
hash "0x01ABCE5E7CBDA196"
alias "0x01ABCE5E7CBDA196"
ns "NETWORK"
returns "int"
doc [[!
]]
native "_NETWORK_GET_PLAYER_COORDS"
hash "0x125E6D638B8605D4"
arguments {
Player "player" [=[ {} ]=],
}
alias "0x125E6D638B8605D4"
ns "NETWORK"
returns "Vector3"
doc [[!
Returns the coordinates of another player.
Does not work if you enter your own player id as p0 (will return `(0.0, 0.0, 0.0)` in that case).
The player id, MUST be another player.
A Vector3 containing the coordinates of another player.
]]
native "_NETWORK_GET_POSITION_HASH_OF_THIS_SCRIPT"
hash "0x257ED0FADF750BCF"
alias "0x257ED0FADF750BCF"
ns "NETWORK"
returns "Any"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "_NETWORK_GET_ROS_PRIVILEGE_24"
hash "0x593570C289A77688"
alias "0x593570C289A77688"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "_NETWORK_GET_ROS_PRIVILEGE_25"
hash "0x91B87C55093DE351"
alias "0x91B87C55093DE351"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "_NETWORK_GET_ROS_PRIVILEGE_9"
hash "0x66B59CFFD78467AF"
jhash (0x0CA1167F)
alias "0x66B59CFFD78467AF"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "_NETWORK_GET_TARGETING_MODE"
hash "0xDFFA5BE8381C3314"
alias "0xDFFA5BE8381C3314"
ns "NETWORK"
returns "int"
doc [[!
]]
native "_NETWORK_GET_UNRELIABLE_RESEND_COUNT_FOR_PLAYER"
hash "0x3765C3A3E8192E10"
arguments {
Player "player" [=[ {} ]=],
}
alias "0x3765C3A3E8192E10"
ns "NETWORK"
returns "int"
doc [[!
```
NETWORK_*
NativeDB Introduced: v323
```
]]
native "_NETWORK_HAS_AGE_RESTRICTED_PROFILE"
hash "0x1353F87E89946207"
alias "0x1353F87E89946207"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "_NETWORK_HAS_GAME_BEEN_ALTERED"
hash "0x659CF2EF7F550C4F"
alias "0x659CF2EF7F550C4F"
ns "NETWORK"
returns "BOOL"
doc [[!
```
Returns true if dinput8.dll is present in the game directory.
You will get following error message if that is true: "You are attempting to access GTA Online servers with an altered version of the game."
```
]]
native "_NETWORK_HAS_VIEW_GAMER_USER_CONTENT_RESULT"
hash "0xCCA4318E1AB03F1F"
arguments {
AnyPtr "networkHandle" [=[ {} ]=],
}
alias "0xCCA4318E1AB03F1F"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "_NETWORK_HAVE_ONLINE_PRIVILEGE_2"
hash "0x5EA784D197556507"
alias "0x5EA784D197556507"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "_NETWORK_IS_CONNECTION_ENDPOINT_RELAY_SERVER"
hash "0x16D3D49902F697BB"
arguments {
Player "player" [=[ {} ]=],
}
alias "0x16D3D49902F697BB"
ns "NETWORK"
returns "BOOL"
doc [[!
```
NETWORK_IS_*
NativeDB Introduced: v323
```
]]
native "_NETWORK_IS_ENTITY_CONCEALED"
hash "0x71302EC70689052A"
arguments {
Entity "entity" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
Note: This only works for vehicles, which appears to be a bug (since the setter *does* work for every entity type and the name is 99% correct).
]]
native "_NETWORK_IS_FRIEND_HANDLE_ONLINE"
hash "0x87EB7A3FFCB314DB"
arguments {
intPtr "networkHandle" [=[ {} ]=],
}
alias "0x87EB7A3FFCB314DB"
alias "_NETWORK_IS_FRIEND_ONLINE_2"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "_NETWORK_IS_NETWORK_ID_A_CLONE"
hash "0x7242F8B741CE1086"
arguments {
int "netId" [=[ {} ]=],
}
alias "0x7242F8B741CE1086"
ns "NETWORK"
returns "BOOL"
doc [[!
Returns true if the specified network id is controlled by someone else.
The network id for an object or entity.
Probably a bool, returns 1 if you don't have control over the netId entity.
]]
native "_NETWORK_IS_PLAYER_EQUAL_TO_INDEX"
hash "0x9DE986FC9A87C474"
jhash (0xE66A0B40)
arguments {
Player "player" [=[ {} ]=],
int "index" [=[ {} ]=],
}
alias "0x9DE986FC9A87C474"
ns "NETWORK"
returns "BOOL"
doc [[!
```
NETWORK_ARE_*
```
]]
native "_NETWORK_IS_PSN_AVAILABLE"
hash "0x8D11E61A4ABF49CC"
alias "0x8D11E61A4ABF49CC"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "_NETWORK_IS_SCRIPT_ACTIVE_BY_HASH"
hash "0xDA7DE67F5FE5EE13"
arguments {
Hash "scriptHash" [=[ {} ]=],
int "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
int "p3" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
```
NativeDB Introduced: v2245
```
]]
native "_NETWORK_IS_TEXT_CHAT_ACTIVE"
hash "0x5FCF4D7069B09026"
ns "NETWORK"
returns "BOOL"
doc [[!
```
Same as _IS_TEXT_CHAT_ACTIVE, except it does not check if the text chat HUD component is initialized, and therefore may crash.
```
]]
native "_NETWORK_IS_THIS_SCRIPT_MARKED"
hash "0xD1110739EEADB592"
arguments {
Any "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
alias "0xD1110739EEADB592"
alias "_NETWORK_SET_THIS_SCRIPT_MARKED"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "_NETWORK_OVERRIDE_CLOCK_MILLISECONDS_PER_GAME_MINUTE"
hash "0x42BF1D2E723B6D7E"
arguments {
int "ms" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
```
NativeDB Introduced: v2189
```
]]
native "_NETWORK_PED_FORCE_GAME_STATE_UPDATE"
hash "0xF0BC9BCD24A511D5"
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0xF0BC9BCD24A511D5"
ns "NETWORK"
returns "void"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "_NETWORK_REGISTER_TUNABLE_BOOL_HASH"
hash "0x697F508861875B42"
arguments {
Hash "contextHash" [=[ {"cs_type":"Any"} ]=],
Hash "nameHash" [=[ {"cs_type":"Any"} ]=],
BOOLPtr "value" [=[ {} ]=],
}
alias "0x697F508861875B42"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "_NETWORK_REGISTER_TUNABLE_FLOAT_HASH"
hash "0x1950DAE9848A4739"
arguments {
Hash "contextHash" [=[ {"cs_type":"Any"} ]=],
Hash "nameHash" [=[ {"cs_type":"Any"} ]=],
floatPtr "value" [=[ {} ]=],
}
alias "0x1950DAE9848A4739"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "_NETWORK_REGISTER_TUNABLE_INT_HASH"
hash "0x3A8B55FDA4C8DDEF"
arguments {
Hash "contextHash" [=[ {"cs_type":"Any"} ]=],
Hash "nameHash" [=[ {"cs_type":"Any"} ]=],
intPtr "value" [=[ {} ]=],
}
alias "0x3A8B55FDA4C8DDEF"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "_NETWORK_REPORT_MYSELF"
hash "0x5626D9D6810730D5"
alias "0x5626D9D6810730D5"
ns "NETWORK"
returns "void"
doc [[!
]]
native "_NETWORK_RESPAWN_COORDS"
hash "0x9769F811D1785B03"
jhash (0xBE6A30C3)
arguments {
Player "player" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
BOOL "p4" [=[ {} ]=],
BOOL "p5" [=[ {} ]=],
}
alias "0x9769F811D1785B03"
ns "NETWORK"
returns "void"
doc [[!
```
p4 and p5 are always 0 in scripts
```
]]
native "_NETWORK_SEND_PRESENCE_TRANSITION_INVITE"
hash "0xC116FF9B4D488291"
jhash (0x877C0E1C)
arguments {
AnyPtr "p0" [=[ {} ]=],
AnyPtr "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
alias "0xC116FF9B4D488291"
ns "NETWORK"
returns "BOOL"
doc [[!
```
String "NETWORK_SEND_PRESENCE_TRANSITION_INVITE" is contained in the function in ida so this one is correct.
```
]]
native "_NETWORK_SET_CURRENT_DATA_MANAGER_HANDLE"
hash "0x796A87B3B68D1F3D"
arguments {
AnyPtr "p0" [=[ {} ]=],
}
alias "0x796A87B3B68D1F3D"
alias "_NETWORK_CHECK_DATA_MANAGER_FOR_HANDLE"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "_NETWORK_SET_CURRENT_MISSION_ID"
hash "0x2C863ACDCD12B3DB"
arguments {
charPtr "missionId" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
```
NativeDB Introduced: v2699
```
]]
native "_NETWORK_SET_CURRENT_SPAWN_SETTING"
hash "0xAA6D5451DC3448B6"
arguments {
Hash "mpSettingSpawn" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
```cpp
enum eMpSettingSpawn
{
MP_SETTING_SPAWN_NULL = 0,
MP_SETTING_SPAWN_PROPERTY = 1,
MP_SETTING_SPAWN_LAST_POSITION = 2,
MP_SETTING_SPAWN_GARAGE = 3,
MP_SETTING_SPAWN_RANDOM = 4,
MP_SETTING_SPAWN_PRIVATE_YACHT = 5,
MP_SETTING_SPAWN_OFFICE = 6,
MP_SETTING_SPAWN_CLUBHOUSE = 7,
MP_SETTING_SPAWN_IE_WAREHOUSE = 8,
MP_SETTING_SPAWN_BUNKER = 9,
MP_SETTING_SPAWN_HANGAR = 10,
MP_SETTING_SPAWN_DEFUNCT_BASE = 11,
MP_SETTING_SPAWN_NIGHTCLUB = 12,
MP_SETTING_SPAWN_ARENA_GARAGE = 13,
MP_SETTING_SPAWN_CASINO_APARTMENT = 14,
MP_SETTING_SPAWN_ARCADE = 15,
MP_SETTING_SPAWN_SUBMARINE = 16,
MP_SETTING_SPAWN_CAR_MEET = 17,
MP_SETTING_SPAWN_AUTO_SHOP = 18,
MP_SETTING_SPAWN_FIXER_HQ = 19,
MP_SETTING_SPAWN_MAX = 20,
};
```
```
NativeDB Introduced: v2699
```
]]
native "_NETWORK_SET_ENTITY_GHOSTED_WITH_OWNER"
hash "0x4BA166079D658ED4"
arguments {
Entity "entity" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
alias "0x4BA166079D658ED4"
ns "NETWORK"
returns "void"
doc [[!
]]
native "_NETWORK_SET_ENTITY_INVISIBLE_TO_NETWORK"
hash "0xF1CA12B18AEF5298"
jhash (0x09CBC4B0)
arguments {
Entity "entity" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0xF1CA12B18AEF5298"
alias "_NETWORK_SET_ENTITY_VISIBLE_TO_NETWORK"
ns "NETWORK"
returns "void"
doc [[!
```
if set to true other network players can't see it
if set to false other network player can see it
=========================================
^^ I attempted this by grabbing an object with GET_ENTITY_PLAYER_IS_FREE_AIMING_AT and setting this naive no matter the toggle he could still see it.
pc or last gen?
^^ last-gen
```
]]
native "_NETWORK_SET_OBJECT_FORCE_STATIC_BLEND"
hash "0x0379DAF89BA09AA5"
arguments {
Object "object" [=[ {} ]=],
BOOL "enabled" [=[ {} ]=],
}
alias "0x0379DAF89BA09AA5"
ns "NETWORK"
returns "void"
doc [[!
Sets whether or not an object (created using `CREATE_OBJECT`, or similar) should have its position/rotation synchronized,
even if it is a 'static' object (for example, having flag 32 - Static - set in its archetype definition).
This has to be called during the same frame the object is created/registered for network, as otherwise it may already
have a remote clone created.
Once a remote clone is created, changing this value will not have any effect on said clone.
The object to set forced blending state for.
`true` to enable forced blending.
]]
native "_NETWORK_SET_VEHICLE_TEST_DRIVE"
hash "0x8C70252FC40F320B"
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
```
Used by Metric VEHICLE_DIST_DRIVEN
```
```
NativeDB Introduced: v2699
```
]]
native "_NETWORK_SET_VEHICLE_WHEELS_DESTRUCTIBLE"
hash "0x890E2C5ABED7236D"
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x890E2C5ABED7236D"
ns "NETWORK"
returns "void"
doc [[!
```
Allow vehicle wheels to be destructible even when the Vehicle entity is invincible.
```
```
NativeDB Introduced: v1365
```
]]
native "_NETWORK_SHOULD_SHOW_CONNECTIVITY_TROUBLESHOOTING"
hash "0x82A2B386716608F1"
alias "0x82A2B386716608F1"
ns "NETWORK"
returns "BOOL"
doc [[!
```
Returns true if the NAT type is Strict (3) and a certain number of connections have failed.
```
]]
native "_NETWORK_START_USER_CONTENT_PERMISSIONS_CHECK"
hash "0xDEB2B99A1AF1A2A6"
arguments {
Any "netHandle" [=[ {} ]=],
}
alias "0xDEB2B99A1AF1A2A6"
ns "NETWORK"
returns "int"
doc [[!
```
Always returns -1. Seems to be XB1 specific.
```
]]
native "_NETWORK_TRANSITION_TRACK"
hash "0xC3BFED92026A2AAD"
arguments {
Hash "hash" [=[ {"cs_type":"Any"} ]=],
int "p1" [=[ {} ]=],
int "p2" [=[ {} ]=],
int "state" [=[ {} ]=],
int "p4" [=[ {} ]=],
}
alias "0xC3BFED92026A2AAD"
ns "NETWORK"
returns "void"
doc [[!
]]
native "_NETWORK_UGC_NAV"
hash "0xC1447451DDB512F0"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
alias "0xC1447451DDB512F0"
ns "NETWORK"
returns "void"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "_NETWORK_UPDATE_PLAYER_SCARS"
hash "0xB7C7F6AD6424304B"
jhash (0x371BBA08)
alias "0xB7C7F6AD6424304B"
ns "NETWORK"
returns "void"
doc [[!
]]
native "_REMOTE_CHEAT_DETECTED"
hash "0x472841A026D26D8B"
alias "0x472841A026D26D8B"
ns "NETWORK"
returns "BOOL"
doc [[!
```
NativeDB Added Parameter 1: Player player
NativeDB Added Parameter 2: int a
NativeDB Added Parameter 3: int b
```
]]
native "_RESERVE_NETWORK_LOCAL_OBJECTS"
hash "0x797F9C5E661D920E"
arguments {
int "amount" [=[ {} ]=],
}
alias "0x797F9C5E661D920E"
ns "NETWORK"
returns "void"
doc [[!
```
Internal logging string: SCRIPT_RESERVING_LOCAL_OBJECTS
```
```
NativeDB Introduced: v1290
```
]]
native "_RESERVE_NETWORK_LOCAL_PEDS"
hash "0x2C8DF5D129595281"
arguments {
int "amount" [=[ {} ]=],
}
alias "0x2C8DF5D129595281"
ns "NETWORK"
returns "void"
doc [[!
```
Internal logging string: SCRIPT_RESERVING_LOCAL_PEDS
```
```
NativeDB Introduced: v1493
```
]]
native "_RESERVE_NETWORK_LOCAL_VEHICLES"
hash "0x42613035157E4208"
arguments {
int "amount" [=[ {} ]=],
}
alias "0x42613035157E4208"
ns "NETWORK"
returns "void"
doc [[!
]]
native "_RESET_GHOSTED_ENTITY_ALPHA"
hash "0x17330EBF2F2124A8"
alias "0x17330EBF2F2124A8"
ns "NETWORK"
returns "void"
doc [[!
Sets the alpha value used by [`_SET_LOCAL_PLAYER_AS_GHOST`](#\_0x5FFE9B4144F9712F), [`SET_NETWORK_VEHICLE_AS_GHOST`](#\_0x6274C4712850841E), and [`_NETWORK_SET_ENTITY_GHOSTED_WITH_OWNER`](#\_0x4BA166079D658ED4).
]]
native "_SET_GHOSTED_ENTITY_ALPHA"
hash "0x658500AE6D723A7E"
arguments {
int "alpha" [=[ {} ]=],
}
alias "0x658500AE6D723A7E"
ns "NETWORK"
returns "void"
doc [[!
Sets the alpha value used by [`_SET_LOCAL_PLAYER_AS_GHOST`](#\_0x5FFE9B4144F9712F), [`SET_NETWORK_VEHICLE_AS_GHOST`](#\_0x6274C4712850841E), and [`_NETWORK_SET_ENTITY_GHOSTED_WITH_OWNER`](#\_0x4BA166079D658ED4).
'Solidness' cannot be achieved using 255 - this will have the opposite effect of it defaulting to 128 it seems (or just having no effect at all).
A value between 1 and 254. Default: 128
]]
native "_SET_LOCAL_PLAYER_AS_GHOST"
hash "0x5FFE9B4144F9712F"
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
Formerly incorrectly named `USE_PLAYER_COLOUR_INSTEAD_OF_TEAM_COLOUR` due to incorrect treatment of console vs. PC native registration.
Native name guessed through ordering.
```
NativeDB Added Parameter 2: BOOL p1
```
]]
native "_SET_NETWORK_ENABLE_VEHICLE_POSITION_CORRECTION"
hash "0x838DA0936A24ED4D"
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x838DA0936A24ED4D"
ns "NETWORK"
returns "void"
doc [[!
```
Enables a periodic ShapeTest within the NetBlender and invokes rage::netBlenderLinInterp::GoStraightToTarget (or some functional wrapper).
```
]]
native "_SET_NETWORK_VEHICLE_POSITION_UPDATE_MULTIPLIER"
hash "0xA2A707979FE754DC"
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "multiplier" [=[ {} ]=],
}
alias "0xA2A707979FE754DC"
alias "_SET_NETWORK_VEHICLE_BLENDER_DISTANCE_MULTIPLIER"
ns "NETWORK"
returns "void"
doc [[!
```
rage::netBlenderLinInterp::GetPositionMaxForUpdateLevel
```
]]
native "_SET_RELATIONSHIP_TO_PLAYER"
hash "0xA7C511FA1C5BDA38"
arguments {
Player "player" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
alias "0xA7C511FA1C5BDA38"
ns "NETWORK"
returns "void"
doc [[!
Enables ghosting between specific players. Name is between `_SET_RELATIONSHIP_GROUP_DONT_AFFECT_WANTED_LEVEL` and `SET_ROADS_BACK_TO_ORIGINAL`.
]]
native "_SHUTDOWN_AND_LOAD_MOST_RECENT_SAVE"
hash "0x9ECA15ADFE141431"
alias "0x9ECA15ADFE141431"
ns "NETWORK"
returns "BOOL"
doc [[!
Disconnects you from the session, and starts loading single player, however you still remain connected to the server (only if you're the host, if you're not then you also (most likely) get disconnected from the server) and other players will not be able to join until you exit the game.
If you're already in SP then it'll re-load singleplayer.
You might need to DoScreenFadeIn and ShutdownLoadingScreen otherwise you probably won't end up loading into SP at all.
Somewhat related note: opening the pause menu after loading into this 'singleplayer' mode crashes the game.
always seems to be 1
]]
native "_TRIGGER_SCRIPT_CRC_CHECK_ON_PLAYER"
hash "0x46FB3ED415C7641C"
jhash (0xF9A51B92)
arguments {
Player "player" [=[ {} ]=],
int "p1" [=[ {} ]=],
Hash "scriptHash" [=[ {} ]=],
}
alias "0x46FB3ED415C7641C"
alias "_NETWORK_IS_PLAYER_IN_SCRIPT"
ns "NETWORK"
returns "BOOL"
doc [[!
```
p1 = 6
```
]]
native "_UGC_QUERY_RECENTLY_CREATED_CONTENT"
hash "0x6D4CB481FAC835E8"
jhash (0x40CF0783)
arguments {
int "offset" [=[ {} ]=],
int "count" [=[ {} ]=],
charPtr "contentTypeName" [=[ {} ]=],
int "p3" [=[ {} ]=],
}
alias "0x6D4CB481FAC835E8"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "0x023ACAB2DC9DC4A4"
hash "0x023ACAB2DC9DC4A4"
ns "NETWORK"
returns "Any"
doc [[!
```
NativeDB Introduced: v1493
```
]]
native "0x041C7F2A6C9894E6"
hash "0x041C7F2A6C9894E6"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
ns "NETWORK"
returns "Any"
doc [[!
]]
native "0x04918A41BC9B8157"
hash "0x04918A41BC9B8157"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
ns "NETWORK"
returns "Any"
doc [[!
]]
native "0x07EAB372C8841D99"
hash "0x07EAB372C8841D99"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
ns "NETWORK"
returns "Any"
doc [[!
]]
native "0x0CF6CC51AA18F0F8"
hash "0x0CF6CC51AA18F0F8"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
ns "NETWORK"
returns "Any"
doc [[!
```
NativeDB Introduced: v1180
```
]]
native "0x0D77A82DC2D0DA59"
hash "0x0D77A82DC2D0DA59"
jhash (0x0808D4CC)
arguments {
AnyPtr "p0" [=[ {} ]=],
AnyPtr "p1" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
```
NETWORK_SET_*
```
]]
native "0x0EDE326D47CD0F3E"
hash "0x0EDE326D47CD0F3E"
jhash (0xBEB7281A)
arguments {
Ped "ped" [=[ {} ]=],
Player "player" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "0x0F1A4B45B7693B95"
hash "0x0F1A4B45B7693B95"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
```
NativeDB Introduced: v2189
```
]]
native "0x1153FA02A659051C"
hash "0x1153FA02A659051C"
jhash (0x57F9BC83)
ns "NETWORK"
returns "void"
doc [[!
]]
native "0x1171A97A3D3981B6"
hash "0x1171A97A3D3981B6"
arguments {
AnyPtr "p0" [=[ {} ]=],
AnyPtr "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "0x1398582B7F72B3ED"
hash "0x1398582B7F72B3ED"
arguments {
Any "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "0x13F1FCB111B820B0"
hash "0x13F1FCB111B820B0"
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
```
SET_NETWORK_*
```
]]
native "0x140E6A44870A11CE"
hash "0x140E6A44870A11CE"
jhash (0x50507BED)
ns "NETWORK"
returns "void"
doc [[!
]]
native "0x144DA052257AE7D8"
hash "0x144DA052257AE7D8"
arguments {
Any "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "0x14922ED3E38761F0"
hash "0x14922ED3E38761F0"
jhash (0x8FA6EE0E)
ns "NETWORK"
returns "BOOL"
doc [[!
```
NETWORK_IS_*
```
]]
native "0x155467ACA0F55705"
hash "0x155467ACA0F55705"
ns "NETWORK"
returns "int"
doc [[!
```
Checks some commerce stuff
NativeDB Introduced: v1290
```
]]
native "0x162C23CA83ED0A62"
hash "0x162C23CA83ED0A62"
jhash (0xB3BBD241)
arguments {
Any "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "0x17C9E241111A674D"
hash "0x17C9E241111A674D"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
```
NativeDB Introduced: v2060
```
]]
native "0x1D4DC17C38FEAFF0"
hash "0x1D4DC17C38FEAFF0"
jhash (0xED4A272F)
ns "NETWORK"
returns "BOOL"
doc [[!
```
IS_COMMERCE_*
```
]]
native "0x1D610EB0FEA716D9"
hash "0x1D610EB0FEA716D9"
arguments {
int "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "0x1F7BC3539F9E0224"
hash "0x1F7BC3539F9E0224"
ns "NETWORK"
returns "void"
doc [[!
```
NativeDB Introduced: v1180
```
]]
native "0x1F8E00FB18239600"
hash "0x1F8E00FB18239600"
arguments {
Any "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "0x2302C0264EA58D31"
hash "0x2302C0264EA58D31"
jhash (0x8DCFE77D)
ns "NETWORK"
returns "void"
doc [[!
]]
native "0x24E4E51FC16305F9"
hash "0x24E4E51FC16305F9"
jhash (0x742075FE)
ns "NETWORK"
returns "Any"
doc [[!
]]
native "0x2555CF7DA5473794"
hash "0x2555CF7DA5473794"
ns "NETWORK"
returns "void"
doc [[!
```
Does nothing (it's a nullsub).
NativeDB Introduced: v323
```
]]
native "0x25D990F8E0E3F13C"
hash "0x25D990F8E0E3F13C"
ns "NETWORK"
returns "void"
doc [[!
]]
native "0x261E97AD7BCF3D40"
hash "0x261E97AD7BCF3D40"
jhash (0x7EF353E1)
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "0x265559DA40B3F327"
hash "0x265559DA40B3F327"
arguments {
Any "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "0x265635150FB0D82E"
hash "0x265635150FB0D82E"
jhash (0xA7FA70AE)
ns "NETWORK"
returns "void"
doc [[!
]]
native "0x26F07DD83A5F7F98"
hash "0x26F07DD83A5F7F98"
jhash (0x9A176B6E)
ns "NETWORK"
returns "Any"
doc [[!
]]
native "0x283B6062A2C01E9B"
hash "0x283B6062A2C01E9B"
jhash (0x96E28FE2)
ns "NETWORK"
returns "void"
doc [[!
]]
native "0x2B1C623823DB0D9D"
hash "0x2B1C623823DB0D9D"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
Any "p6" [=[ {} ]=],
}
ns "NETWORK"
returns "Any"
doc [[!
]]
native "0x2B51EDBEFC301339"
hash "0x2B51EDBEFC301339"
jhash (0x8E952B12)
arguments {
int "p0" [=[ {} ]=],
charPtr "p1" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "0x2BF66D2E7414F686"
hash "0x2BF66D2E7414F686"
jhash (0x9156EFC0)
ns "NETWORK"
returns "Any"
doc [[!
]]
native "0x2CE9D95E4051AECD"
hash "0x2CE9D95E4051AECD"
arguments {
Any "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "0x2D5DC831176D0114"
hash "0x2D5DC831176D0114"
jhash (0xA69AE16C)
arguments {
Any "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "0x2DA41ED6E1FCD7A5"
hash "0x2DA41ED6E1FCD7A5"
arguments {
Any "p0" [=[ {} ]=],
intPtr "TypeOfWeapon" [=[ {} ]=],
}
ns "NETWORK"
returns "Any"
doc [[!
]]
native "0x2E0BF682CC778D49"
hash "0x2E0BF682CC778D49"
jhash (0xBFAA349B)
arguments {
Any "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "0x2E4C123D1C8A710E"
hash "0x2E4C123D1C8A710E"
arguments {
intPtr "retPlayerIds" [=[ {} ]=],
intPtr "retNumber" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
Any "p6" [=[ {} ]=],
}
ns "NETWORK"
returns "Any"
doc [[!
]]
native "0x32EBD154CB6B8B99"
hash "0x32EBD154CB6B8B99"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "0x36391F397731595D"
hash "0x36391F397731595D"
arguments {
Any "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "Any"
doc [[!
]]
native "0x367EF5E2F439B4C6"
hash "0x367EF5E2F439B4C6"
jhash (0x53C9563C)
arguments {
int "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "0x37D5F739FD494675"
hash "0x37D5F739FD494675"
arguments {
Any "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "int"
doc [[!
I've had this return the player's ped handle sometimes, but also other random entities.
Whatever p0 is, it's at least not synced to other players.
At least not all the time, some p0 values actually output the same entity, (different handle of course, but same entity).
But another p0 value may return an entity for player x, but not for player y (it'll just return -1 even if the entity exists on both clients).
unknown.
Returns an entity handle or -1, value changes based on p0's value.
]]
native "0x3855FB5EB2C5E8B2"
hash "0x3855FB5EB2C5E8B2"
arguments {
Any "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "Any"
doc [[!
]]
native "0x38B7C51AB1EDC7D8"
hash "0x38B7C51AB1EDC7D8"
arguments {
Entity "entity" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
```
NativeDB Introduced: v1734
```
]]
native "0x39917E1B4CB0F911"
hash "0x39917E1B4CB0F911"
jhash (0xF60986FC)
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "0x3C5C1E2C2FF814B1"
hash "0x3C5C1E2C2FF814B1"
jhash (0xC9DDA85B)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
```
Sets some voice chat related value.
NETWORK_SET_*
```
]]
native "0x3FA36981311FA4FF"
hash "0x3FA36981311FA4FF"
jhash (0x00AE4E17)
arguments {
int "netId" [=[ {} ]=],
BOOL "state" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "0x3FC795691834481D"
hash "0x3FC795691834481D"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
nullsub, doesn't do anything
```
NativeDB Introduced: v1868
```
]]
native "0x4237E822315D8BA9"
hash "0x4237E822315D8BA9"
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "0x4348BFDA56023A2F"
hash "0x4348BFDA56023A2F"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "NETWORK"
returns "Any"
doc [[!
]]
native "0x444C4525ECE0A4B9"
hash "0x444C4525ECE0A4B9"
jhash (0xCC7DCE24)
ns "NETWORK"
returns "void"
doc [[!
```
related to:
NETWORK_BAIL
NETWORK_BAIL_TRANSITION
NETWORK_JOIN_GROUP_ACTIVITY
NETWORK_JOIN_TRANSITION
NETWORK_LAUNCH_TRANSITION
NETWORK_SESSION_HOST
NETWORK_SESSION_HOST_CLOSED
NETWORK_SESSION_HOST_FRIENDS_ONLY
NETWORK_SESSION_HOST_SINGLE_PLAYER
NETWORK_SESSION_VOICE_LEAVE
```
]]
native "0x45E816772E93A9DB"
hash "0x45E816772E93A9DB"
jhash (0x8E664EFD)
ns "NETWORK"
returns "Any"
doc [[!
]]
native "0x4811BBAC21C5FCD5"
hash "0x4811BBAC21C5FCD5"
jhash (0xE5961511)
arguments {
Any "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "0x4A9FDE3A5A6D0437"
hash "0x4A9FDE3A5A6D0437"
jhash (0x18F03AFD)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
**This native does absolutely nothing, just a nullsub**
]]
native "0x4AD490AE1536933B"
hash "0x4AD490AE1536933B"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "NETWORK"
returns "Any"
doc [[!
]]
native "0x4C2A9FDC22377075"
hash "0x4C2A9FDC22377075"
ns "NETWORK"
returns "void"
doc [[!
]]
native "0x4C9034162368E206"
hash "0x4C9034162368E206"
ns "NETWORK"
returns "Any"
doc [[!
```
NativeDB Introduced: v2060
```
]]
native "0x4D02279C83BE69FE"
hash "0x4D02279C83BE69FE"
jhash (0xA7F3F82B)
ns "NETWORK"
returns "Any"
doc [[!
]]
native "0x4DF7CFFF471A7FB1"
hash "0x4DF7CFFF471A7FB1"
jhash (0xCB1CD6D3)
arguments {
Any "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "0x5324A0E3E4CE3570"
hash "0x5324A0E3E4CE3570"
jhash (0x87D1E6BD)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
AnyPtr "p2" [=[ {} ]=],
AnyPtr "p3" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "0x53C10C8BD774F2C9"
hash "0x53C10C8BD774F2C9"
ns "NETWORK"
returns "Any"
doc [[!
]]
native "0x5539C3EBF104A53A"
hash "0x5539C3EBF104A53A"
jhash (0xAE396263)
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "0x559EBF901A8C68E0"
hash "0x559EBF901A8C68E0"
arguments {
AnyPtr "gamerHandle" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
```
_NETWORK_CAN_VIEW_* - _NETWORK_CAN_SESSION*
NETWORK_CAN_PLAY_GAMER_USER_CONTENT?
```
```
NativeDB Introduced: v2699
```
]]
native "0x560B423D73015E77"
hash "0x560B423D73015E77"
arguments {
Any "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "Any"
doc [[!
```
NativeDB Introduced: v1604
```
]]
native "0x584770794D758C18"
hash "0x584770794D758C18"
arguments {
Any "p0" [=[ {} ]=],
AnyPtr "p1" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "0x59328EB08C5CEB2B"
hash "0x59328EB08C5CEB2B"
jhash (0x70F6D3AD)
ns "NETWORK"
returns "BOOL"
doc [[!
```
IS_*
```
]]
native "0x59D421683D31835A"
hash "0x59D421683D31835A"
arguments {
Any "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "0x5A34CD9C3C5BEC44"
hash "0x5A34CD9C3C5BEC44"
jhash (0x346B506C)
arguments {
Any "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "0x5C497525F803486B"
hash "0x5C497525F803486B"
ns "NETWORK"
returns "void"
doc [[!
**This native does absolutely nothing, just a nullsub**
]]
native "0x5E3AA4CA2B6FB0EE"
hash "0x5E3AA4CA2B6FB0EE"
jhash (0x7BBEA8CF)
arguments {
Any "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "0x5ECD378EE64450AB"
hash "0x5ECD378EE64450AB"
arguments {
Any "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "0x600F8CB31C7AAB6E"
hash "0x600F8CB31C7AAB6E"
jhash (0x959E43A3)
arguments {
Any "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "0x60EDD13EB3AC1FF3"
hash "0x60EDD13EB3AC1FF3"
jhash (0x4DEBC227)
ns "NETWORK"
returns "BOOL"
doc [[!
```
Returns true if profile setting 901 is set to true and sets it to false.
NETWORK_C*
```
]]
native "0x617F49C2668E6155"
hash "0x617F49C2668E6155"
ns "NETWORK"
returns "int"
doc [[!
```
NETWORK_GET_NUM_*
```
]]
native "0x63B406D7884BFA95"
hash "0x63B406D7884BFA95"
jhash (0xF79FFF3C)
ns "NETWORK"
returns "Any"
doc [[!
]]
native "0x64D779659BC37B19"
hash "0x64D779659BC37B19"
arguments {
Entity "entity" [=[ {} ]=],
}
ns "NETWORK"
returns "Vector3"
doc [[!
```
NETWORK_GET_*
```
]]
native "0x64E5C4CC82847B73"
hash "0x64E5C4CC82847B73"
ns "NETWORK"
returns "BOOL"
doc [[!
Hardcoded to return false.
```
NativeDB Introduced: v1734
```
]]
native "0x67FC09BC554A75E5"
hash "0x67FC09BC554A75E5"
ns "NETWORK"
returns "Any"
doc [[!
Hard-coded to always return 0.
]]
native "0x68103E2247887242"
hash "0x68103E2247887242"
jhash (0x0095DB71)
ns "NETWORK"
returns "void"
doc [[!
]]
native "0x692D58DF40657E8C"
hash "0x692D58DF40657E8C"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
AnyPtr "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
BOOL "p5" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "0x6A5D89D7769A40D8"
hash "0x6A5D89D7769A40D8"
jhash (0x4FFEFE43)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
```
Sets some voice chat related value.
NETWORK_SET_*
```
]]
native "0x6BFF5F84102DF80A"
hash "0x6BFF5F84102DF80A"
arguments {
Player "player" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
**This native does absolutely nothing, just a nullsub**
]]
native "0x6CE50E47F5543D0C"
hash "0x6CE50E47F5543D0C"
ns "NETWORK"
returns "void"
doc [[!
]]
native "0x6FB7BB3607D27FA2"
hash "0x6FB7BB3607D27FA2"
ns "NETWORK"
returns "Any"
doc [[!
Hard-coded to always return 0.
]]
native "0x6FD992C4A1C1B986"
hash "0x6FD992C4A1C1B986"
ns "NETWORK"
returns "void"
doc [[!
```
Does nothing (it's a nullsub).
NativeDB Introduced: v323
```
]]
native "0x702BC4D605522539"
hash "0x702BC4D605522539"
jhash (0x913FD7D6)
arguments {
Any "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "0x741A3D8380319A81"
hash "0x741A3D8380319A81"
jhash (0x331D9A27)
ns "NETWORK"
returns "void"
doc [[!
```
Has something to do with a host request.
NETWORK_RE*
```
]]
native "0x742B58F723233ED9"
hash "0x742B58F723233ED9"
jhash (0x5E832444)
arguments {
Any "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "Any"
doc [[!
]]
native "0x74FB3E29E6D10FA9"
hash "0x74FB3E29E6D10FA9"
ns "NETWORK"
returns "int"
doc [[!
```
Hardcoded to return zero.
==== PS4 specific info ====
Returns some sort of unavailable reason:
-1 = REASON_INVALID
0 = REASON_OTHER
1 = REASON_SYSTEM_UPDATE
2 = REASON_GAME_UPDATE
3 = REASON_SIGNED_OUT
4 = REASON_AGE
5 = REASON_CONNECTION
=================================
```
Hard-coded to always return 0.
]]
native "0x754615490A029508"
hash "0x754615490A029508"
ns "NETWORK"
returns "int"
doc [[!
```
Checks some commerce stuff
NativeDB Introduced: v1290
```
]]
native "0x76B3F29D3F967692"
hash "0x76B3F29D3F967692"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
```
NativeDB Introduced: v2189
```
]]
native "0x77FADDCBE3499DF7"
hash "0x77FADDCBE3499DF7"
jhash (0x8179C48A)
arguments {
Any "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "0x7808619F31FF22DB"
hash "0x7808619F31FF22DB"
ns "NETWORK"
returns "Any"
doc [[!
Hard-coded to always return 1.
]]
native "0x78321BEA235FD8CD"
hash "0x78321BEA235FD8CD"
arguments {
Any "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "0x793FF272D5B365F4"
hash "0x793FF272D5B365F4"
jhash (0xF0211AC1)
ns "NETWORK"
returns "Any"
doc [[!
]]
native "0x7D395EA61622E116"
hash "0x7D395EA61622E116"
jhash (0x5C05B7E1)
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "0x7DB53B37A2F211A0"
hash "0x7DB53B37A2F211A0"
jhash (0x053BB329)
ns "NETWORK"
returns "int"
doc [[!
]]
native "0x7EF7649B64D7FF10"
hash "0x7EF7649B64D7FF10"
arguments {
Entity "entity" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
```
IS_*
```
]]
native "0x7FCC39C46C3C03BD"
hash "0x7FCC39C46C3C03BD"
arguments {
int "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "0x83660B734994124D"
hash "0x83660B734994124D"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
intPtr "damageDealt" [=[ {} ]=],
}
ns "NETWORK"
returns "Any"
doc [[!
]]
native "0x83FE8D7229593017"
hash "0x83FE8D7229593017"
ns "NETWORK"
returns "void"
doc [[!
]]
native "0x88B588B41FF7868E"
hash "0x88B588B41FF7868E"
ns "NETWORK"
returns "Any"
doc [[!
Hard-coded to always return 0.
]]
native "0x8B0C2964BA471961"
hash "0x8B0C2964BA471961"
ns "NETWORK"
returns "Any"
doc [[!
Hard-coded to always return 0.
]]
native "0x8B4FFC790CA131EF"
hash "0x8B4FFC790CA131EF"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "NETWORK"
returns "Any"
doc [[!
]]
native "0x8C8D2739BA44AF0F"
hash "0x8C8D2739BA44AF0F"
arguments {
Any "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "0x8EF52ACAECC51D9C"
hash "0x8EF52ACAECC51D9C"
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
NETWORK_SET_\*
```
NativeDB Introduced: v1734
```
]]
native "0x906CA41A4B74ECA4"
hash "0x906CA41A4B74ECA4"
ns "NETWORK"
returns "Any"
doc [[!
```
NativeDB Introduced: v1493
```
]]
native "0x94538037EE44F5CF"
hash "0x94538037EE44F5CF"
jhash (0x6B97075B)
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "0x9465E683B12D3F6B"
hash "0x9465E683B12D3F6B"
jhash (0x273C6180)
ns "NETWORK"
returns "void"
doc [[!
]]
native "0x95BAF97C82464629"
hash "0x95BAF97C82464629"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
```
NativeDB Introduced: v1604
```
]]
native "0x973D76AA760A6CB6"
hash "0x973D76AA760A6CB6"
jhash (0x0532DDD2)
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "0x9D724B400A7E8FFC"
hash "0x9D724B400A7E8FFC"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
```
NativeDB Introduced: v2189
```
]]
native "0x9D7AFCBF21C51712"
hash "0x9D7AFCBF21C51712"
jhash (0xE5219410)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
```
Sets some voice chat related value.
NETWORK_SET_*
```
]]
native "0x9FEDF86898F100E9"
hash "0x9FEDF86898F100E9"
jhash (0x798D6C27)
ns "NETWORK"
returns "Any"
doc [[!
]]
native "0xA0FA4EC6A05DA44E"
hash "0xA0FA4EC6A05DA44E"
ns "NETWORK"
returns "Any"
doc [[!
Hard-coded to always return 0.
]]
native "0xA12D3A5A3753CC23"
hash "0xA12D3A5A3753CC23"
ns "NETWORK"
returns "Any"
doc [[!
]]
native "0xA2E9C1AB8A92E8CD"
hash "0xA2E9C1AB8A92E8CD"
jhash (0x8D014B23)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
```
Appears to set whether a transition should be started when the session is migrating.
NETWORK_SET_*
```
]]
native "0xA306F470D1660581"
hash "0xA306F470D1660581"
ns "NETWORK"
returns "Any"
doc [[!
]]
native "0xA6FCECCF4721D679"
hash "0xA6FCECCF4721D679"
arguments {
Any "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
```
NativeDB Introduced: v1604
```
]]
native "0xA7862BC5ED1DFD7E"
hash "0xA7862BC5ED1DFD7E"
jhash (0x37F5BD93)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
AnyPtr "p2" [=[ {} ]=],
AnyPtr "p3" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "0xA8ACB6459542A8C8"
hash "0xA8ACB6459542A8C8"
ns "NETWORK"
returns "Any"
doc [[!
]]
native "0xAA5FAFCD2C5F5E47"
hash "0xAA5FAFCD2C5F5E47"
ns "NETWORK"
returns "Vector3"
doc [[!
```
NativeDB Added Parameter 1: Entity entity
```
]]
native "0xADB57E5B663CCA8B"
hash "0xADB57E5B663CCA8B"
jhash (0x92268BB5)
arguments {
Player "p0" [=[ {} ]=],
floatPtr "p1" [=[ {} ]=],
floatPtr "p2" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
```
gets 2 floats from the CNetGamePlayer of p0 and stores them in p1 and p2.
Possibly waypoint?
```
]]
native "0xAEAB987727C5A8A4"
hash "0xAEAB987727C5A8A4"
jhash (0x9FEEAA9C)
arguments {
Any "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "0xAEDF1BC1C133D6E3"
hash "0xAEDF1BC1C133D6E3"
ns "NETWORK"
returns "void"
doc [[!
```
Does nothing (it's a nullsub).
NativeDB Introduced: v323
```
]]
native "0xB13E88E655E5A3BC"
hash "0xB13E88E655E5A3BC"
jhash (0x36A5F2DA)
ns "NETWORK"
returns "void"
doc [[!
]]
native "0xB309EBEA797E001F"
hash "0xB309EBEA797E001F"
jhash (0x5C0AB2A9)
arguments {
Any "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "Any"
doc [[!
]]
native "0xB37E4E6A2388CA7B"
hash "0xB37E4E6A2388CA7B"
jhash (0x755A2B3E)
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "0xB5D3453C98456528"
hash "0xB5D3453C98456528"
ns "NETWORK"
returns "Any"
doc [[!
]]
native "0xB606E6CC59664972"
hash "0xB606E6CC59664972"
jhash (0x866D1B67)
arguments {
Any "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
**This native does absolutely nothing, just a nullsub**
]]
native "0xB746D20B17F2A229"
hash "0xB746D20B17F2A229"
jhash (0x9567392B)
arguments {
AnyPtr "p0" [=[ {} ]=],
AnyPtr "p1" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "0xB9351A07A0D458B1"
hash "0xB9351A07A0D458B1"
arguments {
Any "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "Any"
doc [[!
```
NativeDB Introduced: v2060
```
]]
native "0xBA7F0B77D80A4EB7"
hash "0xBA7F0B77D80A4EB7"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "0xBD545D44CCE70597"
hash "0xBD545D44CCE70597"
ns "NETWORK"
returns "BOOL"
doc [[!
Hard-coded to always return 1.
]]
native "0xBDB6F89C729CF388"
hash "0xBDB6F89C729CF388"
jhash (0x9374523F)
ns "NETWORK"
returns "BOOL"
doc [[!
```
NETWORK_SESSION_IS_*
```
]]
native "0xBF22E0F32968E967"
hash "0xBF22E0F32968E967"
jhash (0x22E03AD0)
arguments {
Player "player" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "0xC32EA7A2F6CA7557"
hash "0xC32EA7A2F6CA7557"
jhash (0x966C90FD)
ns "NETWORK"
returns "Any"
doc [[!
]]
native "0xC42DD763159F3461"
hash "0xC42DD763159F3461"
jhash (0xFBBAC350)
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "0xC434133D9BA52777"
hash "0xC434133D9BA52777"
arguments {
Any "p0" [=[ {} ]=],
intPtr "TypeOfWeapon" [=[ {} ]=],
}
ns "NETWORK"
returns "Any"
doc [[!
]]
native "0xC571D0E77D8BBC29"
hash "0xC571D0E77D8BBC29"
jhash (0x4F4BB300)
ns "NETWORK"
returns "BOOL"
doc [[!
```
NETWORK_IS_TRANSITION_*
```
]]
native "0xC87E740D9F3872CC"
hash "0xC87E740D9F3872CC"
jhash (0xC1487110)
ns "NETWORK"
returns "Any"
doc [[!
]]
native "0xCA575C391FEA25CC"
hash "0xCA575C391FEA25CC"
jhash (0xE797A4B6)
arguments {
Any "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "0xCA59CCAE5D01E4CE"
hash "0xCA59CCAE5D01E4CE"
ns "NETWORK"
returns "void"
doc [[!
NETWORK_S\*
```
NativeDB Introduced: v1734
```
]]
native "0xCFEB46DCD7D8D5EB"
hash "0xCFEB46DCD7D8D5EB"
jhash (0x1A3EA6CD)
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "0xD313DE83394AF134"
hash "0xD313DE83394AF134"
jhash (0x3EA9D44C)
ns "NETWORK"
returns "BOOL"
doc [[!
```
NETWORK_SESSION_IS_*
```
]]
native "0xD6D7478CA62B8D41"
hash "0xD6D7478CA62B8D41"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
```
NativeDB Introduced: v1868
```
]]
native "0xD7B6C73CAD419BCF"
hash "0xD7B6C73CAD419BCF"
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "0xDB663CC9FF3407A9"
hash "0xDB663CC9FF3407A9"
arguments {
Player "player" [=[ {} ]=],
}
ns "NETWORK"
returns "int"
doc [[!
```
NativeDB Introduced: v1734
```
]]
native "0xE16AA70CE9BEEDC3"
hash "0xE16AA70CE9BEEDC3"
arguments {
Any "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "Any"
doc [[!
]]
native "0xE42D626EEC94E5D9"
hash "0xE42D626EEC94E5D9"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
intPtr "numReservedPeds" [=[ {} ]=],
intPtr "numReservedVehicles" [=[ {} ]=],
intPtr "numReservedObjects" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "0xE6717E652B8C8D8A"
hash "0xE6717E652B8C8D8A"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "0xEA8C0DDB10E2822A"
hash "0xEA8C0DDB10E2822A"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
```
NativeDB Introduced: v1868
```
]]
native "0xEBCAB9E5048434F4"
hash "0xEBCAB9E5048434F4"
ns "NETWORK"
returns "Any"
doc [[!
Hard-coded to always return 1.
]]
native "0xEBF8284D8CADEB53"
hash "0xEBF8284D8CADEB53"
jhash (0x9773F36A)
ns "NETWORK"
returns "void"
doc [[!
]]
native "0xEBFA8D50ADDC54C4"
hash "0xEBFA8D50ADDC54C4"
jhash (0xF50BC67A)
arguments {
Any "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "BOOL"
doc [[!
]]
native "0xF083835B70BA9BFE"
hash "0xF083835B70BA9BFE"
jhash (0xC47352E7)
ns "NETWORK"
returns "void"
doc [[!
```
NETWORK_RE*
```
]]
native "0xF287F506767CC8A9"
hash "0xF287F506767CC8A9"
ns "NETWORK"
returns "Any"
doc [[!
]]
native "0xF49ABC20D8552257"
hash "0xF49ABC20D8552257"
jhash (0x454C7B67)
arguments {
Any "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "0xF6F4383B7C92F11A"
hash "0xF6F4383B7C92F11A"
arguments {
Any "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "0xF814FEC6A19FD6E0"
hash "0xF814FEC6A19FD6E0"
jhash (0x32B7A076)
ns "NETWORK"
returns "void"
doc [[!
]]
native "0xFA2888E3833C8E96"
hash "0xFA2888E3833C8E96"
jhash (0x7F70C15A)
ns "NETWORK"
returns "void"
doc [[!
]]
native "0xFAC18E7356BD3210"
hash "0xFAC18E7356BD3210"
ns "NETWORK"
returns "void"
doc [[!
```
NativeDB Introduced: v1180
```
]]
native "0xFAE628F1E9ADB239"
hash "0xFAE628F1E9ADB239"
jhash (0xD59A822B)
arguments {
Hash "p0" [=[ {"cs_type":"Any"} ]=],
int "p1" [=[ {} ]=],
Hash "p2" [=[ {"cs_type":"Any"} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "0xFB1F9381E80FA13F"
hash "0xFB1F9381E80FA13F"
jhash (0x0679CE71)
arguments {
int "p0" [=[ {} ]=],
AnyPtr "p1" [=[ {} ]=],
}
ns "NETWORK"
returns "Any"
doc [[!
```
p0 is always 0. p1 is pointing to a global.
```
]]
native "0xFB680D403909DC70"
hash "0xFB680D403909DC70"
jhash (0xFFB2ADA1)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "0xFD75DABC0957BF33"
hash "0xFD75DABC0957BF33"
jhash (0x511E6F50)
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "NETWORK"
returns "void"
doc [[!
]]
native "SC_EMAIL_MESSAGE_CLEAR_RECIP_LIST"
hash "0x55DF6DB45179236E"
jhash (0xD094F11A)
alias "0x55DF6DB45179236E"
ns "SOCIALCLUB"
returns "void"
doc [[!
]]
native "SC_EMAIL_MESSAGE_PUSH_GAMER_TO_RECIP_LIST"
hash "0x2330C12A7A605D16"
jhash (0x9A703A2B)
arguments {
intPtr "networkHandle" [=[ {} ]=],
}
ns "SOCIALCLUB"
returns "void"
doc [[!
]]
native "SC_GAMERDATA_GET_BOOL"
hash "0x8416FE4E4629D7D7"
jhash (0xDF45B2A7)
arguments {
charPtr "name" [=[ {} ]=],
}
alias "0x8416FE4E4629D7D7"
alias "_SC_GET_IS_PROFILE_ATTRIBUTE_SET"
ns "SOCIALCLUB"
returns "BOOL"
doc [[!
```
sfink: from scripts:
func_720(socialclub::_0x8416FE4E4629D7D7("bIgnoreCheaterOverride"));
func_719(socialclub::_0x8416FE4E4629D7D7("bIgnoreBadSportOverride"));
```
]]
native "SC_GAMERDATA_GET_FLOAT"
hash "0xA770C8EEC6FB2AC5"
jhash (0x515AF67C)
arguments {
charPtr "name" [=[ {} ]=],
floatPtr "outValue" [=[ {} ]=],
}
alias "_0xA770C8EEC6FB2AC5"
ns "SOCIALCLUB"
returns "BOOL"
doc [[!
```
NativeDB Introduced: v323
```
]]
native "SC_GAMERDATA_GET_INT"
hash "0xC85A7127E7AD02AA"
jhash (0xF8BDA989)
arguments {
charPtr "name" [=[ {} ]=],
intPtr "outValue" [=[ {} ]=],
}
alias "_0xC85A7127E7AD02AA"
ns "SOCIALCLUB"
returns "BOOL"
doc [[!
```
NativeDB Introduced: v323
```
]]
native "SC_INBOX_GET_MESSAGE_IS_READ_AT_INDEX"
hash "0x93028F1DB42BFD08"
jhash (0xD1ED1D48)
arguments {
int "msgIndex" [=[ {} ]=],
}
alias "0x93028F1DB42BFD08"
alias "_IS_SC_INBOX_VALID"
ns "SOCIALCLUB"
returns "BOOL"
doc [[!
]]
native "SC_INBOX_GET_MESSAGE_TYPE_AT_INDEX"
hash "0xBB8EA16ECBC976C4"
jhash (0x5ECF955D)
arguments {
int "msgIndex" [=[ {} ]=],
}
alias "0xBB8EA16ECBC976C4"
alias "_SC_INBOX_MESSAGE_INIT"
ns "SOCIALCLUB"
returns "Hash"
doc [[!
]]
native "SC_INBOX_GET_TOTAL_NUM_MESSAGES"
hash "0x03A93FF1A2CA0864"
jhash (0x6BE5DF29)
alias "0x03A93FF1A2CA0864"
alias "_GET_TOTAL_SC_INBOX_IDS"
ns "SOCIALCLUB"
returns "int"
doc [[!
]]
native "SC_INBOX_MESSAGE_DO_APPLY"
hash "0x9A2C8064B6C1E41A"
jhash (0xEBE420A4)
arguments {
int "p0" [=[ {} ]=],
}
alias "0x9A2C8064B6C1E41A"
alias "_SC_INBOX_MESSAGE_PUSH"
ns "SOCIALCLUB"
returns "BOOL"
doc [[!
]]
native "SC_INBOX_MESSAGE_GET_DATA_INT"
hash "0xA00EFE4082C4056E"
jhash (0x88068C7C)
arguments {
int "p0" [=[ {} ]=],
charPtr "context" [=[ {} ]=],
intPtr "out" [=[ {} ]=],
}
ns "SOCIALCLUB"
returns "BOOL"
doc [[!
]]
native "SC_INBOX_MESSAGE_GET_DATA_STRING"
hash "0x7572EF42FC6A9B6D"
jhash (0x15607620)
arguments {
int "p0" [=[ {} ]=],
charPtr "context" [=[ {} ]=],
charPtr "out" [=[ {} ]=],
}
ns "SOCIALCLUB"
returns "BOOL"
doc [[!
]]
native "SC_INBOX_MESSAGE_GET_UGCDATA"
hash "0x69D82604A1A5A254"
jhash (0x88CA3BFC)
arguments {
Any "p0" [=[ {} ]=],
AnyPtr "p1" [=[ {} ]=],
}
ns "SOCIALCLUB"
returns "BOOL"
doc [[!
]]
native "SC_LICENSEPLATE_ADD"
hash "0x1989C6E6F67E76A8"
jhash (0xEEDE7FAB)
arguments {
charPtr "plateText" [=[ {} ]=],
charPtr "plateData" [=[ {} ]=],
intPtr "tokenOut" [=[ {} ]=],
}
alias "0x1989C6E6F67E76A8"
ns "SOCIALCLUB"
returns "BOOL"
doc [[!
Social Club native to add license plate for the user
]]
native "SC_LICENSEPLATE_GET_ADD_IS_PENDING"
hash "0x07C61676E5BB52CD"
jhash (0xE190E45A)
arguments {
int "token" [=[ {} ]=],
}
alias "0x07C61676E5BB52CD"
ns "SOCIALCLUB"
returns "BOOL"
doc [[!
Returns true if the add license plate text request is still pending.
]]
native "SC_LICENSEPLATE_GET_ADD_STATUS"
hash "0x8147FFF6A718E1AD"
jhash (0x930B3AE5)
arguments {
int "token" [=[ {} ]=],
}
alias "0x8147FFF6A718E1AD"
ns "SOCIALCLUB"
returns "int"
doc [[!
Returns a status for adding the license plate
]]
native "SC_LICENSEPLATE_GET_COUNT"
hash "0x700569DBA175A77C"
jhash (0x159FE39C)
arguments {
int "token" [=[ {} ]=],
}
alias "0x700569DBA175A77C"
ns "SOCIALCLUB"
returns "int"
doc [[!
Gets number of plates in the response of the get license plates request.
Range: \[0, count) can be used as second argument to \_0x1D4446A62D35B0D0 and \_0x2E89990DDFF670C3
]]
native "SC_LICENSEPLATE_GET_ISVALID_IS_PENDING"
hash "0xD302E99EDF0449CF"
jhash (0x86DAE6D6)
arguments {
int "token" [=[ {} ]=],
}
alias "0xD302E99EDF0449CF"
ns "SOCIALCLUB"
returns "BOOL"
doc [[!
Checks if the "is valid license plate" request is still pending.
]]
native "SC_LICENSEPLATE_GET_ISVALID_STATUS"
hash "0x5C4EBFFA98BDB41C"
jhash (0x9AA2BA3F)
arguments {
int "token" [=[ {} ]=],
}
alias "0x5C4EBFFA98BDB41C"
ns "SOCIALCLUB"
returns "int"
doc [[!
Gets the status of the is valid license plate request
]]
native "SC_LICENSEPLATE_GET_PLATE"
hash "0x1D4446A62D35B0D0"
jhash (0x4CE9BAA7)
arguments {
int "token" [=[ {} ]=],
int "plateIndex" [=[ {} ]=],
}
ns "SOCIALCLUB"
returns "charPtr"
doc [[!
Gets license plate text related to the get license plate info request
The plate index from the list of result plates. Use SC_LICENSEPLATE_GET_COUNT for the number of plates.
]]
native "SC_LICENSEPLATE_GET_PLATE_DATA"
hash "0x2E89990DDFF670C3"
jhash (0x05303FC8)
arguments {
int "token" [=[ {} ]=],
int "plateIndex" [=[ {} ]=],
}
alias "0x2E89990DDFF670C3"
ns "SOCIALCLUB"
returns "charPtr"
doc [[!
Gets license plate data related to the get license plate info request
The plate index from the list of result plates. Use SC_LICENSEPLATE_GET_COUNT for the number of plates.
]]
native "SC_LICENSEPLATE_ISVALID"
hash "0x0F73393BAC7E6730"
jhash (0x5298F472)
arguments {
charPtr "plateText" [=[ {} ]=],
intPtr "tokenOut" [=[ {} ]=],
}
alias "_0x0F73393BAC7E6730"
ns "SOCIALCLUB"
returns "BOOL"
doc [[!
SC native to start a request for if license plate text is valid
]]
native "SC_LICENSEPLATE_SET_PLATE_DATA"
hash "0xD0EE05FE193646EA"
jhash (0x9F98FA5C)
arguments {
charPtr "oldPlateText" [=[ {} ]=],
charPtr "newPlateText" [=[ {} ]=],
charPtr "plateData" [=[ {} ]=],
}
alias "0xD0EE05FE193646EA"
ns "SOCIALCLUB"
returns "BOOL"
doc [[!
Changes the license plate for the user (no insert).
]]
native "SC_PRESENCE_ATTR_SET_FLOAT"
hash "0xC4C4575F62534A24"
jhash (0x94BF0D35)
alias "0xC4C4575F62534A24"
ns "SOCIALCLUB"
returns "BOOL"
doc [[!
```
NativeDB Introduced: v323
NativeDB Added Parameter 1: Hash attrHash
NativeDB Added Parameter 2: float value
```
]]
native "SC_PRESENCE_ATTR_SET_INT"
hash "0x1F1E9682483697C7"
jhash (0x90C74343)
arguments {
Hash "attrHash" [=[ {} ]=],
int "value" [=[ {} ]=],
}
alias "0x1F1E9682483697C7"
ns "SOCIALCLUB"
returns "BOOL"
doc [[!
]]
native "SC_PRESENCE_ATTR_SET_STRING"
hash "0x287F1F75D2803595"
jhash (0x3ACE6D6B)
arguments {
Hash "attrHash" [=[ {} ]=],
charPtr "value" [=[ {} ]=],
}
alias "0x287F1F75D2803595"
ns "SOCIALCLUB"
returns "BOOL"
doc [[!
]]
native "SC_PROFANITY_CHECK_STRING"
hash "0x75632C5ECD7ED843"
jhash (0xDF084A6B)
arguments {
charPtr "string" [=[ {} ]=],
intPtr "token" [=[ {} ]=],
}
alias "0x75632C5ECD7ED843"
alias "_SC_START_CHECK_STRING_TASK"
ns "SOCIALCLUB"
returns "BOOL"
doc [[!
Starts a task to check an entered string for profanity on the ROS/Social Club services.
See also: [`SC_PROFANITY_GET_CHECK_IS_VALID`](#\_0x1753344C770358AE) and [`SC_PROFANITY_GET_CHECK_IS_PENDING`](#\_0x82E4A58BABC15AE7).
]]
native "SC_PROFANITY_GET_CHECK_IS_PENDING"
hash "0x82E4A58BABC15AE7"
jhash (0xA796D7A7)
arguments {
int "token" [=[ {} ]=],
}
alias "0x82E4A58BABC15AE7"
alias "_SC_GET_CHECK_STRING_STATUS"
ns "SOCIALCLUB"
annotations [=[ {"cs_type":"int"} ]=]
returns "BOOL"
doc [[!
]]
native "SC_PROFANITY_GET_CHECK_IS_VALID"
hash "0x1753344C770358AE"
jhash (0xFFED3676)
arguments {
int "token" [=[ {} ]=],
}
alias "0x1753344C770358AE"
alias "_SC_HAS_CHECK_STRING_TASK_COMPLETED"
ns "SOCIALCLUB"
returns "BOOL"
doc [[!
]]
native "SC_PROFANITY_GET_STRING_PASSED"
hash "0x85535ACF97FC0969"
jhash (0x09497F31)
arguments {
int "token" [=[ {} ]=],
}
alias "0x85535ACF97FC0969"
ns "SOCIALCLUB"
returns "BOOL"
doc [[!
]]
native "SC_PROFANITY_GET_STRING_STATUS"
hash "0x930DE22F07B1CCE3"
jhash (0x4D8A6521)
arguments {
int "token" [=[ {} ]=],
}
alias "0x930DE22F07B1CCE3"
ns "SOCIALCLUB"
returns "int"
doc [[!
]]
native "_IS_ROCKSTAR_MESSAGE_READY_FOR_SCRIPT"
hash "0xBC1CC91205EC8D6E"
jhash (0x6C5738AB)
alias "0xBC1CC91205EC8D6E"
ns "SOCIALCLUB"
returns "BOOL"
doc [[!
]]
native "_ROCKSTAR_MESSAGE_GET_STRING"
hash "0xDF649C4E9AFDD788"
jhash (0x468668F0)
alias "0xDF649C4E9AFDD788"
ns "SOCIALCLUB"
returns "charPtr"
doc [[!
]]
native "_SC_GET_HAS_ACHIEVEMENT_BEEN_PASSED"
hash "0x418DC16FAE452C1C"
arguments {
int "achievement" [=[ {} ]=],
}
alias "0x418DC16FAE452C1C"
ns "SOCIALCLUB"
returns "BOOL"
doc [[!
```
Same as HAS_ACHIEVEMENT_BEEN_PASSED
```
]]
native "_SC_GET_NICKNAME"
hash "0x198D161F458ECC7F"
ns "SOCIALCLUB"
annotations [=[ {"cs_type":"Entity"} ]=]
returns "charPtr"
doc [[!
```
Returns the nickname of the logged-in Rockstar Social Club account.
```
]]
native "_SC_INBOX_GET_EMAILS"
hash "0x040ADDCBAFA1018A"
arguments {
int "offset" [=[ {} ]=],
int "limit" [=[ {} ]=],
}
alias "0x040ADDCBAFA1018A"
ns "SOCIALCLUB"
returns "void"
doc [[!
]]
native "_SC_INBOX_MESSAGE_GET_BOUNTY_DATA"
hash "0x87E0052F08BD64E6"
jhash (0xAB3346B5)
arguments {
int "index" [=[ {} ]=],
intPtr "outData" [=[ {} ]=],
}
alias "0x87E0052F08BD64E6"
ns "SOCIALCLUB"
returns "BOOL"
doc [[!
]]
native "_SC_INBOX_MESSAGE_GET_DATA_BOOL"
hash "0xFFE5C16F402D851D"
arguments {
int "p0" [=[ {} ]=],
charPtr "p1" [=[ {} ]=],
}
alias "0xFFE5C16F402D851D"
ns "SOCIALCLUB"
returns "BOOL"
doc [[!
]]
native "_SC_INBOX_MESSAGE_GET_STRING"
hash "0xF3E31D16CBDCB304"
jhash (0x2C959AF9)
arguments {
int "p0" [=[ {} ]=],
}
alias "0xF3E31D16CBDCB304"
ns "SOCIALCLUB"
returns "charPtr"
doc [[!
]]
native "_SC_INBOX_MESSAGE_POP"
hash "0x2C015348CF19CA1D"
jhash (0x19EE0CCB)
arguments {
int "p0" [=[ {} ]=],
}
alias "0x2C015348CF19CA1D"
ns "SOCIALCLUB"
returns "BOOL"
doc [[!
]]
native "_SC_INBOX_MESSAGE_PUSH_GAMER_TO_EVENT_RECIP_LIST"
hash "0xDA024BDBD600F44A"
jhash (0x0B9A3512)
arguments {
intPtr "networkHandle" [=[ {} ]=],
}
alias "0xDA024BDBD600F44A"
ns "SOCIALCLUB"
returns "void"
doc [[!
]]
native "_SC_INBOX_MESSAGE_SEND_BOUNTY_PRESENCE_EVENT"
hash "0x6AFD2CD753FEEF83"
jhash (0x628F489B)
arguments {
charPtr "data" [=[ {} ]=],
}
alias "0x6AFD2CD753FEEF83"
ns "SOCIALCLUB"
returns "BOOL"
doc [[!
]]
native "_SC_INBOX_MESSAGE_SEND_UGC_STAT_UPDATE_EVENT"
hash "0xA68D3D229F4F3B06"
jhash (0x75324674)
arguments {
charPtr "data" [=[ {} ]=],
}
alias "0xA68D3D229F4F3B06"
ns "SOCIALCLUB"
returns "void"
doc [[!
]]
native "_SC_PROFANITY_CHECK_UGC_STRING"
hash "0xEB2BF817463DFA28"
arguments {
charPtr "string" [=[ {} ]=],
intPtr "token" [=[ {} ]=],
}
alias "0xEB2BF817463DFA28"
ns "SOCIALCLUB"
returns "BOOL"
doc [[!
]]
native "_SET_HANDLE_ROCKSTAR_MESSAGE_VIA_SCRIPT"
hash "0xBFA0A56A817C6C7D"
jhash (0x2FB9F53C)
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0xBFA0A56A817C6C7D"
ns "SOCIALCLUB"
returns "void"
doc [[!
]]
native "0x07DBD622D9533857"
hash "0x07DBD622D9533857"
arguments {
Any "p0" [=[ {} ]=],
}
ns "SOCIALCLUB"
returns "Any"
doc [[!
]]
native "0x116FB94DC4B79F17"
hash "0x116FB94DC4B79F17"
jhash (0xAF3C081B)
arguments {
charPtr "p0" [=[ {} ]=],
}
ns "SOCIALCLUB"
returns "void"
doc [[!
]]
native "0x16DA8172459434AA"
hash "0x16DA8172459434AA"
ns "SOCIALCLUB"
returns "Any"
doc [[!
]]
native "0x19853B5B17D77BCA"
hash "0x19853B5B17D77BCA"
jhash (0xD26CCA46)
arguments {
Any "p0" [=[ {} ]=],
AnyPtr "p1" [=[ {} ]=],
}
ns "SOCIALCLUB"
returns "BOOL"
doc [[!
]]
native "0x1D12A56FC95BE92E"
hash "0x1D12A56FC95BE92E"
jhash (0x92452C0E)
ns "SOCIALCLUB"
annotations [=[ {"cs_type":"Any"} ]=]
returns "BOOL"
doc [[!
```
NativeDB Added Parameter 1: char* p0
NativeDB Added Parameter 2: char* p1
NativeDB Added Parameter 3: char* p2
NativeDB Introduced: v323
```
]]
native "0x225798743970412B"
hash "0x225798743970412B"
arguments {
intPtr "p0" [=[ {} ]=],
}
ns "SOCIALCLUB"
returns "BOOL"
doc [[!
]]
native "0x2570E26BE63964E3"
hash "0x2570E26BE63964E3"
jhash (0x59394583)
ns "SOCIALCLUB"
annotations [=[ {"cs_type":"Any"} ]=]
returns "BOOL"
doc [[!
```
NativeDB Added Parameter 1: char* p0
NativeDB Added Parameter 2: float* p1
NativeDB Added Parameter 3: char* p2
NativeDB Introduced: v323
```
]]
native "0x2D874D4AE612A65F"
hash "0x2D874D4AE612A65F"
ns "SOCIALCLUB"
returns "Any"
doc [[!
```
NativeDB Introduced: v323
```
]]
native "0x3001BEF2FECA3680"
hash "0x3001BEF2FECA3680"
jhash (0x4D4C37B3)
ns "SOCIALCLUB"
returns "BOOL"
doc [[!
]]
native "0x33DF47CC0642061B"
hash "0x33DF47CC0642061B"
jhash (0xBBA8D34D)
ns "SOCIALCLUB"
annotations [=[ {"cs_type":"Any"} ]=]
returns "BOOL"
doc [[!
```
NativeDB Added Parameter 1: char* p0
NativeDB Added Parameter 2: char* p1
NativeDB Introduced: v323
```
]]
native "0x44ACA259D67651DB"
hash "0x44ACA259D67651DB"
arguments {
AnyPtr "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "SOCIALCLUB"
returns "void"
doc [[!
]]
native "0x450819D8CF90C416"
hash "0x450819D8CF90C416"
jhash (0x0572EB5E)
ns "SOCIALCLUB"
annotations [=[ {"cs_type":"Any"} ]=]
returns "BOOL"
doc [[!
```
NativeDB Added Parameter 1: char* p0
NativeDB Introduced: v323
```
]]
native "0x4737980E8A283806"
hash "0x4737980E8A283806"
arguments {
int "p0" [=[ {} ]=],
AnyPtr "p1" [=[ {} ]=],
}
ns "SOCIALCLUB"
returns "BOOL"
doc [[!
]]
native "0x487912FD248EFDDF"
hash "0x487912FD248EFDDF"
jhash (0x579B4510)
arguments {
Any "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
}
ns "SOCIALCLUB"
returns "BOOL"
doc [[!
]]
native "0x4A7D6E727F941747"
hash "0x4A7D6E727F941747"
jhash (0x8E7AEEB7)
arguments {
AnyPtr "p0" [=[ {} ]=],
}
ns "SOCIALCLUB"
returns "Any"
doc [[!
]]
native "0x4ED9C8D6DA297639"
hash "0x4ED9C8D6DA297639"
jhash (0xC5E08B66)
ns "SOCIALCLUB"
returns "Any"
doc [[!
```
NativeDB Introduced: v323
```
]]
native "0x50A8A36201DBF83E"
hash "0x50A8A36201DBF83E"
jhash (0x8DA93C3D)
ns "SOCIALCLUB"
annotations [=[ {"cs_type":"Any"} ]=]
returns "BOOL"
doc [[!
```
NativeDB Added Parameter 1: char* p0
NativeDB Added Parameter 2: float* p1
NativeDB Introduced: v323
```
]]
native "0x675721C9F644D161"
hash "0x675721C9F644D161"
jhash (0x486867E6)
ns "SOCIALCLUB"
returns "void"
doc [[!
]]
native "0x699E4A5C8C893A18"
hash "0x699E4A5C8C893A18"
jhash (0xCE7D50A8)
arguments {
int "p0" [=[ {} ]=],
charPtr "p1" [=[ {} ]=],
AnyPtr "p2" [=[ {} ]=],
}
ns "SOCIALCLUB"
returns "BOOL"
doc [[!
]]
native "0x6BFB12CE158E3DD4"
hash "0x6BFB12CE158E3DD4"
jhash (0x24D84334)
arguments {
Any "p0" [=[ {} ]=],
}
ns "SOCIALCLUB"
returns "BOOL"
doc [[!
]]
native "0x710BCDA8071EDED1"
hash "0x710BCDA8071EDED1"
jhash (0x04EE74A3)
ns "SOCIALCLUB"
annotations [=[ {"cs_type":"Any"} ]=]
returns "BOOL"
doc [[!
```
NativeDB Added Parameter 1: char* p0
NativeDB Added Parameter 2: int* p1
NativeDB Introduced: v323
```
]]
native "0x7DB18CA8CAD5B098"
hash "0x7DB18CA8CAD5B098"
ns "SOCIALCLUB"
returns "Any"
doc [[!
]]
native "0x7FFCBFEE44ECFABF"
hash "0x7FFCBFEE44ECFABF"
ns "SOCIALCLUB"
returns "Any"
doc [[!
```
NativeDB Introduced: v323
```
]]
native "0x8A4416C0DB05FA66"
hash "0x8A4416C0DB05FA66"
arguments {
AnyPtr "newsStoryData" [=[ {} ]=],
}
ns "SOCIALCLUB"
annotations [=[ {"cs_type":"Any"} ]=]
returns "BOOL"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "0x8CC469AB4D349B7C"
hash "0x8CC469AB4D349B7C"
jhash (0xE778B2A7)
arguments {
int "p0" [=[ {} ]=],
charPtr "p1" [=[ {} ]=],
AnyPtr "p2" [=[ {} ]=],
}
ns "SOCIALCLUB"
returns "BOOL"
doc [[!
]]
native "0x9237E334F6E43156"
hash "0x9237E334F6E43156"
jhash (0x65D84665)
arguments {
Any "p0" [=[ {} ]=],
}
ns "SOCIALCLUB"
returns "Any"
doc [[!
]]
native "0x92DA6E70EF249BD1"
hash "0x92DA6E70EF249BD1"
jhash (0xAED95A6F)
arguments {
charPtr "p0" [=[ {} ]=],
intPtr "p1" [=[ {} ]=],
}
ns "SOCIALCLUB"
returns "BOOL"
doc [[!
]]
native "0x9DE5D2F723575ED0"
hash "0x9DE5D2F723575ED0"
jhash (0x37DD48B5)
ns "SOCIALCLUB"
annotations [=[ {"cs_type":"Any"} ]=]
returns "BOOL"
doc [[!
```
NativeDB Added Parameter 1: char* p0
NativeDB Added Parameter 2: char* p1
NativeDB Introduced: v323
```
]]
native "0xA468E0BE12B12C70"
hash "0xA468E0BE12B12C70"
jhash (0xB21288FA)
ns "SOCIALCLUB"
annotations [=[ {"cs_type":"Any"} ]=]
returns "BOOL"
doc [[!
```
NativeDB Added Parameter 1: int p0
NativeDB Introduced: v323
```
]]
native "0xC2C97EA97711D1AE"
hash "0xC2C97EA97711D1AE"
jhash (0xF929F61D)
ns "SOCIALCLUB"
annotations [=[ {"cs_type":"Any"} ]=]
returns "BOOL"
doc [[!
```
NativeDB Added Parameter 1: char* p0
NativeDB Introduced: v323
```
]]
native "0xC5A35C73B68F3C49"
hash "0xC5A35C73B68F3C49"
jhash (0x7E24BD6E)
ns "SOCIALCLUB"
annotations [=[ {"cs_type":"Any"} ]=]
returns "BOOL"
doc [[!
```
NativeDB Added Parameter 1: int p0
NativeDB Added Parameter 2: char* p1
NativeDB Added Parameter 3: float* p2
NativeDB Introduced: v323
```
]]
native "0xD8122C407663B995"
hash "0xD8122C407663B995"
jhash (0x1C65B038)
ns "SOCIALCLUB"
returns "Any"
doc [[!
]]
native "0xE4F6E8D07A2F0F51"
hash "0xE4F6E8D07A2F0F51"
arguments {
Any "p0" [=[ {} ]=],
}
ns "SOCIALCLUB"
returns "Any"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "0xE75A4A2E5E316D86"
hash "0xE75A4A2E5E316D86"
jhash (0x28C57FA0)
ns "SOCIALCLUB"
annotations [=[ {"cs_type":"Any"} ]=]
returns "BOOL"
doc [[!
```
NativeDB Added Parameter 1: char* p0
NativeDB Added Parameter 2: int* p1
NativeDB Added Parameter 3: char* p2
NativeDB Introduced: v323
```
]]
native "0xEA95C0853A27888E"
hash "0xEA95C0853A27888E"
ns "SOCIALCLUB"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "0xF22CA0FD74B80E7A"
hash "0xF22CA0FD74B80E7A"
jhash (0xF379DCE4)
arguments {
Any "p0" [=[ {} ]=],
}
ns "SOCIALCLUB"
returns "BOOL"
doc [[!
]]
native "0xF6BAAAF762E1BF40"
hash "0xF6BAAAF762E1BF40"
jhash (0x7AA36406)
arguments {
charPtr "p0" [=[ {} ]=],
intPtr "p1" [=[ {} ]=],
}
ns "SOCIALCLUB"
returns "BOOL"
doc [[!
]]
native "0xFE4C1D0D3B9CC17E"
hash "0xFE4C1D0D3B9CC17E"
jhash (0x8A023024)
arguments {
Any "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "SOCIALCLUB"
returns "BOOL"
doc [[!
]]
native "0xFF8F3A92B75ED67A"
hash "0xFF8F3A92B75ED67A"
jhash (0xC96456BA)
ns "SOCIALCLUB"
returns "Any"
doc [[!
]]
native "ADD_ARMOUR_TO_PED"
hash "0x5BA652A0CD14DF2F"
jhash (0xF686B26E)
arguments {
Ped "ped" [=[ {} ]=],
int "amount" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
Same as SET_PED_ARMOUR, but ADDS 'amount' to the armor the Ped already has.
```
]]
native "ADD_PED_DECORATION_FROM_HASHES"
hash "0x5F5D1665E352A839"
jhash (0x70559AC7)
arguments {
Ped "ped" [=[ {} ]=],
Hash "collection" [=[ {} ]=],
Hash "overlay" [=[ {} ]=],
}
alias "_APPLY_PED_OVERLAY"
alias "_SET_PED_DECORATION"
ns "PED"
returns "void"
doc [[!
```
Applies an Item from a PedDecorationCollection to a ped. These include tattoos and shirt decals.
collection - PedDecorationCollection filename hash
overlay - Item name hash
Example:
Entry inside "mpbeach_overlays.xml" -
-
FM_Hair_Fuzz
mp_hair_fuzz
mp_hair_fuzz
ZONE_HEAD
TYPE_TATTOO
FM
All
GENDER_DONTCARE
Code:
PED::_0x5F5D1665E352A839(PLAYER::PLAYER_PED_ID(), MISC::GET_HASH_KEY("mpbeach_overlays"), MISC::GET_HASH_KEY("fm_hair_fuzz"))
```
]]
native "ADD_PED_DECORATION_FROM_HASHES_IN_CORONA"
hash "0x5619BFA07CFD7833"
jhash (0x8CD3E487)
arguments {
Ped "ped" [=[ {} ]=],
Hash "collection" [=[ {} ]=],
Hash "overlay" [=[ {} ]=],
}
alias "0x5619BFA07CFD7833"
alias "_SET_PED_FACIAL_DECORATION"
ns "PED"
returns "void"
doc [[!
]]
native "ADD_RELATIONSHIP_GROUP"
hash "0xF372BC22FCB88606"
jhash (0x8B635546)
arguments {
charPtr "name" [=[ {} ]=],
HashPtr "groupHash" [=[ {} ]=],
}
ns "PED"
returns "Any"
doc [[!
```
Can't select void. This function returns nothing. The hash of the created relationship group is output in the second parameter.
```
]]
native "ADD_SCENARIO_BLOCKING_AREA"
hash "0x1B5C85C612E5256E"
jhash (0xA38C0234)
arguments {
float "posMinX" [=[ {} ]=],
float "posMinY" [=[ {} ]=],
float "posMinZ" [=[ {} ]=],
float "posMaxX" [=[ {} ]=],
float "posMaxY" [=[ {} ]=],
float "posMaxZ" [=[ {} ]=],
BOOL "network" [=[ {} ]=],
BOOL "cancelActive" [=[ {} ]=],
BOOL "blockPeds" [=[ {} ]=],
BOOL "blockVehicles" [=[ {} ]=],
}
ns "PED"
returns "int"
doc [[!
Sets an area where scenarios are blocked
Min X Coordinate.
Min Y Coordinate.
Min Z Coordinate.
Max X Coordinate.
Max Y Coordinate.
Max Z Coordinate.
Optionally networked to all other players
Should this cause peds already in active scenario points in the area specified to leave
if this area effects scenarios with peds
if this area effects scenarios with vehicles
]]
native "APPLY_DAMAGE_TO_PED"
hash "0x697157CED63F18D4"
jhash (0x4DC27FCF)
arguments {
Ped "ped" [=[ {} ]=],
int "damageAmount" [=[ {} ]=],
BOOL "armorFirst" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
damages a ped with the given amount
----
armorFirst means it will damage/lower the armor first before damaging the player.
setting damageAmount to a negative amount will cause the player or the armor (depending on armorFirst) to be healed by damageAmount instead.
```
```
NativeDB Added Parameter 4: Any p3
```
]]
native "APPLY_PED_BLOOD"
hash "0x83F7E01C7B769A26"
jhash (0x376CE3C0)
arguments {
Ped "ped" [=[ {} ]=],
int "boneIndex" [=[ {} ]=],
float "xRot" [=[ {} ]=],
float "yRot" [=[ {} ]=],
float "zRot" [=[ {} ]=],
charPtr "woundType" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
Found one occurence in re_crashrescue.c4
PED::APPLY_PED_BLOOD(l_4B, 3, 0.0, 0.0, 0.0, "wound_sheet");
```
]]
native "APPLY_PED_BLOOD_BY_ZONE"
hash "0x3311E47B91EDCBBC"
jhash (0x8F3F3A9C)
arguments {
Ped "ped" [=[ {} ]=],
Any "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
AnyPtr "p4" [=[ {} ]=],
}
alias "0x3311E47B91EDCBBC"
ns "PED"
returns "void"
doc [[!
]]
native "APPLY_PED_BLOOD_DAMAGE_BY_ZONE"
hash "0x816F6981C60BF53B"
jhash (0x1E54DB12)
arguments {
Ped "ped" [=[ {} ]=],
Any "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
}
alias "0x816F6981C60BF53B"
ns "PED"
returns "void"
doc [[!
]]
native "APPLY_PED_BLOOD_SPECIFIC"
hash "0xEF0D582CBF2D9B0F"
jhash (0xFC13CE80)
arguments {
Ped "ped" [=[ {} ]=],
int "component" [=[ {} ]=],
float "u" [=[ {} ]=],
float "v" [=[ {} ]=],
float "rotation" [=[ {} ]=],
float "scale" [=[ {} ]=],
int "forcedFrame" [=[ {} ]=],
float "preAge" [=[ {} ]=],
charPtr "bloodName" [=[ {"cs_type":"Any*"} ]=],
}
alias "0xEF0D582CBF2D9B0F"
ns "PED"
returns "void"
doc [[!
Applies blood damage to a ped with specific parameters for zone, UV offsets, rotation, scale, and initial aging.
```
NativeDB Introduced: v323
```
The Ped to which blood damage is applied.
Specific component or body part.
UV texture coordinates for placing the decal in the specified zone.
UV texture coordinates for placing the decal in the specified zone.
Angle in degrees for the rotation of the blood decal.
Scale factor for the damage, ranging from 0.0 to 1.0.
Allows a specific frame of damage to be chosen (-1 for random selection).
Number of seconds to pre-age the damage for an "old wound" effect (0.0 for fresh wound).
Name of the blood type, matching an entry in peddamage.xml.
]]
native "APPLY_PED_DAMAGE_DECAL"
hash "0x397C38AA7B4A5F83"
jhash (0x8A13A41F)
arguments {
Ped "ped" [=[ {} ]=],
int "damageZone" [=[ {} ]=],
float "xOffset" [=[ {} ]=],
float "yOffset" [=[ {} ]=],
float "heading" [=[ {} ]=],
float "scale" [=[ {} ]=],
float "alpha" [=[ {} ]=],
int "variation" [=[ {} ]=],
BOOL "fadeIn" [=[ {} ]=],
charPtr "decalName" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
scar
blushing
cs_flush_anger
cs_flush_anger_face
bruise
bruise_large
herpes
ArmorBullet
basic_dirt_cloth
basic_dirt_skin
cs_trev1_dirt
```
Refer to `ePedDecorationZone` in [GET_PED_DECORATION_ZONE_FROM_HASHES](#\_0x9FD452BFBE7A7A8B)
]]
native "APPLY_PED_DAMAGE_PACK"
hash "0x46DF918788CB093F"
jhash (0x208D0CB8)
arguments {
Ped "ped" [=[ {} ]=],
charPtr "damagePack" [=[ {} ]=],
float "damage" [=[ {} ]=],
float "mult" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
Damage Packs:
"SCR_TrevorTreeBang"
"HOSPITAL_0"
"HOSPITAL_1"
"HOSPITAL_2"
"HOSPITAL_3"
"HOSPITAL_4"
"HOSPITAL_5"
"HOSPITAL_6"
"HOSPITAL_7"
"HOSPITAL_8"
"HOSPITAL_9"
"SCR_Dumpster"
"BigHitByVehicle"
"SCR_Finale_Michael_Face"
"SCR_Franklin_finb"
"SCR_Finale_Michael"
"SCR_Franklin_finb2"
"Explosion_Med"
"SCR_Torture"
"SCR_TracySplash"
"Skin_Melee_0"
Additional damage packs:
gist.github.com/alexguirre/f3f47f75ddcf617f416f3c8a55ae2227
```
]]
native "ATTACH_SYNCHRONIZED_SCENE_TO_ENTITY"
hash "0x272E4723B56A3B96"
jhash (0xE9BA6189)
arguments {
int "sceneID" [=[ {} ]=],
Entity "entity" [=[ {} ]=],
int "boneIndex" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "CAN_CREATE_RANDOM_BIKE_RIDER"
hash "0xEACEEDA81751915C"
jhash (0x7018BE31)
ns "PED"
returns "BOOL"
doc [[!
]]
native "CAN_CREATE_RANDOM_COPS"
hash "0x5EE2CAFF7F17770D"
jhash (0xAA73DAD9)
ns "PED"
returns "BOOL"
doc [[!
]]
native "CAN_CREATE_RANDOM_DRIVER"
hash "0xB8EB95E5B4E56978"
jhash (0x99861609)
ns "PED"
returns "BOOL"
doc [[!
]]
native "CAN_CREATE_RANDOM_PED"
hash "0x3E8349C08E4B82E4"
jhash (0xF9ABE88F)
arguments {
BOOL "unk" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "CAN_KNOCK_PED_OFF_VEHICLE"
hash "0x51AC07A44D4F5B8A"
jhash (0xC9D098B3)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "CAN_PED_IN_COMBAT_SEE_TARGET"
hash "0xEAD42DE3610D0721"
jhash (0xCCD525E1)
arguments {
Ped "ped" [=[ {} ]=],
Ped "target" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "CAN_PED_RAGDOLL"
hash "0x128F79EDCECE4FD5"
jhash (0xC0EFB7A3)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
```
Prevents the ped from going limp.
[Example: Can prevent peds from falling when standing on moving vehicles.]
```
]]
native "CAN_PED_SEE_HATED_PED"
hash "0x6CD5A433374D4CFB"
jhash (0x74A0F291)
arguments {
Ped "ped1" [=[ {} ]=],
Ped "ped2" [=[ {} ]=],
}
alias "0x6CD5A433374D4CFB"
alias "_CAN_PED_SEE_PED"
ns "PED"
returns "BOOL"
doc [[!
]]
native "CLEAR_ALL_PED_PROPS"
hash "0xCD8A7537A9B52F06"
jhash (0x81DF8B43)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
The ped handle.
]]
native "CLEAR_ALL_PED_VEHICLE_FORCED_SEAT_USAGE"
hash "0xE6CA85E7259CE16B"
jhash (0xCC1D8F66)
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0xE6CA85E7259CE16B"
ns "PED"
returns "void"
doc [[!
]]
native "CLEAR_FACIAL_IDLE_ANIM_OVERRIDE"
hash "0x726256CC1EEB182F"
jhash (0x5244F4E2)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "CLEAR_PED_ALTERNATE_MOVEMENT_ANIM"
hash "0xD8D19675ED5FBDCE"
jhash (0x7A7F5BC3)
arguments {
Ped "ped" [=[ {} ]=],
int "stance" [=[ {} ]=],
float "p2" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "CLEAR_PED_ALTERNATE_WALK_ANIM"
hash "0x8844BBFCE30AA9E9"
jhash (0x5736FB23)
arguments {
Ped "ped" [=[ {} ]=],
float "p1" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "CLEAR_PED_BLOOD_DAMAGE"
hash "0x8FE22675A5A45817"
jhash (0xF7ADC960)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
Clears the blood on a ped.
Ped id.
]]
native "CLEAR_PED_BLOOD_DAMAGE_BY_ZONE"
hash "0x56E3B78C5408D9F4"
jhash (0xF210BE69)
arguments {
Ped "ped" [=[ {} ]=],
int "p1" [=[ {} ]=],
}
alias "0x56E3B78C5408D9F4"
ns "PED"
returns "void"
doc [[!
```
Somehow related to changing ped's clothes.
```
]]
native "CLEAR_PED_DAMAGE_DECAL_BY_ZONE"
hash "0x523C79AEEFCC4A2A"
jhash (0x70AA5B7D)
arguments {
Ped "ped" [=[ {} ]=],
int "p1" [=[ {} ]=],
charPtr "p2" [=[ {} ]=],
}
alias "0x523C79AEEFCC4A2A"
ns "PED"
returns "void"
doc [[!
```
p1: from 0 to 5 in the b617d scripts.
p2: "blushing" and "ALL" found in the b617d scripts.
```
]]
native "CLEAR_PED_DECORATIONS"
hash "0x0E5173C163976E38"
jhash (0xD4496BF3)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "CLEAR_PED_DECORATIONS_LEAVE_SCARS"
hash "0xE3B27E70CEAB9F0C"
jhash (0xEFD58EB9)
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0xE3B27E70CEAB9F0C"
alias "_CLEAR_PED_FACIAL_DECORATIONS"
ns "PED"
returns "void"
doc [[!
]]
native "CLEAR_PED_DRIVE_BY_CLIPSET_OVERRIDE"
hash "0x4AFE3690D7E0B5AC"
jhash (0xAEC9163B)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "CLEAR_PED_ENV_DIRT"
hash "0x6585D955A68452A5"
jhash (0xA993915F)
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0x6585D955A68452A5"
ns "PED"
returns "void"
doc [[!
]]
native "CLEAR_PED_LAST_DAMAGE_BONE"
hash "0x8EF6B7AC68E2F01B"
jhash (0x56CB715E)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "CLEAR_PED_NON_CREATION_AREA"
hash "0x2E05208086BA0651"
jhash (0x6F7043A3)
ns "PED"
returns "void"
doc [[!
]]
native "CLEAR_PED_PARACHUTE_PACK_VARIATION"
hash "0x1280804F7CFD2D6C"
jhash (0x7BCD8991)
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0x1280804F7CFD2D6C"
ns "PED"
returns "void"
doc [[!
]]
native "CLEAR_PED_PROP"
hash "0x0943E5B8E078E76E"
jhash (0x2D23D743)
arguments {
Ped "ped" [=[ {} ]=],
int "propId" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
The ped handle.
The prop id you want to clear from the ped. Refer to [SET_PED_PROP_INDEX](#\_0x93376B65A266EB5F).
]]
native "CLEAR_PED_SCUBA_GEAR_VARIATION"
hash "0xB50EB4CCB29704AC"
jhash (0x080275EE)
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0xB50EB4CCB29704AC"
alias "_REMOVE_PED_SCUBA_GEAR_NOW"
ns "PED"
returns "void"
doc [[!
Removes the scubagear (for mp male: component id: 8, drawableId: 123, textureId: any) from peds. Does not play the 'remove scuba gear' animation, but instantly removes it.
The ped to remove the scuba gear from.
]]
native "CLEAR_PED_STORED_HAT_PROP"
hash "0x687C0B594907D2E8"
jhash (0x24A1284E)
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0x687C0B594907D2E8"
ns "PED"
returns "void"
doc [[!
]]
native "CLEAR_PED_WETNESS"
hash "0x9C720776DAA43E7E"
jhash (0x629F15BD)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
It clears the wetness of the selected Ped/Player. Clothes have to be wet to notice the difference.
```
]]
native "CLEAR_RAGDOLL_BLOCKING_FLAGS"
hash "0xD86D101FCFD00A4B"
jhash (0x77CBA290)
arguments {
Ped "ped" [=[ {} ]=],
int "flags" [=[ {} ]=],
}
alias "0xD86D101FCFD00A4B"
alias "_RESET_PED_RAGDOLL_BLOCKING_FLAGS"
ns "PED"
returns "void"
doc [[!
```
There seem to be 26 flags
```
]]
native "CLEAR_RELATIONSHIP_BETWEEN_GROUPS"
hash "0x5E29243FB56FC6D4"
jhash (0x994B8C2D)
arguments {
int "relationship" [=[ {} ]=],
Hash "group1" [=[ {} ]=],
Hash "group2" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
Clears the relationship between two groups. This should be called twice (once for each group).
Relationship types:
0 = Companion
1 = Respect
2 = Like
3 = Neutral
4 = Dislike
5 = Hate
255 = Pedestrians
(Credits: Inco)
Example:
PED::CLEAR_RELATIONSHIP_BETWEEN_GROUPS(2, l_1017, 0xA49E591C);
PED::CLEAR_RELATIONSHIP_BETWEEN_GROUPS(2, 0xA49E591C, l_1017);
```
]]
native "CLONE_PED"
hash "0xEF29A16337FACADB"
jhash (0x8C8A8D6E)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "isNetwork" [=[ {"cs_type":"float"} ]=],
BOOL "bScriptHostPed" [=[ {} ]=],
BOOL "copyHeadBlendFlag" [=[ {} ]=],
}
ns "PED"
returns "Ped"
doc [[!
Creates a copy of the passed ped, optionally setting it as local and/or shallow-copying the head blend data.
The input ped.
Whether or not the ped should be registered as a network object.
Script host flag.
If true, head blend data is referenced, not copied.
A new ped handle representing the ped's copy.
]]
native "CLONE_PED_TO_TARGET"
hash "0xE952D6431689AD9A"
jhash (0xFC70EEC7)
arguments {
Ped "ped" [=[ {} ]=],
Ped "targetPed" [=[ {} ]=],
}
alias "_ASSIGN_PLAYER_TO_PED"
ns "PED"
returns "void"
doc [[!
```
Copies ped's components and props to targetPed.
```
]]
native "CREATE_GROUP"
hash "0x90370EBE0FEE1A3D"
jhash (0x8DC0368D)
arguments {
int "unused" [=[ {} ]=],
}
ns "PED"
returns "int"
doc [[!
```
Creates a new ped group.
Groups can contain up to 8 peds.
The parameter is unused.
Returns a handle to the created group, or 0 if a group couldn't be created.
```
]]
native "CREATE_NM_MESSAGE"
hash "0x418EF2A1BCE56685"
jhash (0x1CFBFD4B)
arguments {
BOOL "startImmediately" [=[ {} ]=],
int "messageId" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
Creates a new NaturalMotion message.
startImmediately: If set to true, the character will perform the message the moment it receives it by GIVE_PED_NM_MESSAGE. If false, the Ped will get the message but won't perform it yet. While it's a boolean value, if negative, the message will not be initialized.
messageId: The ID of the NaturalMotion message.
If a message already exists, this function does nothing. A message exists until the point it has been successfully dispatched by GIVE_PED_NM_MESSAGE.
```
]]
native "CREATE_PARACHUTE_BAG_OBJECT"
hash "0x8C4F3BF23B6237DB"
jhash (0x19198A16)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
alias "0x8C4F3BF23B6237DB"
alias "_CREATE_PARACHUTE_OBJECT"
ns "PED"
returns "Object"
doc [[!
]]
native "CREATE_PED"
hash "0xD49F9B0955C367DE"
jhash (0x0389EF71)
arguments {
int "pedType" [=[ {} ]=],
Hash "modelHash" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "heading" [=[ {} ]=],
BOOL "isNetwork" [=[ {} ]=],
BOOL "bScriptHostPed" [=[ {} ]=],
}
ns "PED"
returns "Ped"
doc [[!
Creates a ped (biped character, pedestrian, actor) with the specified model at the specified position and heading.
This ped will initially be owned by the creating script as a mission entity, and the model should be loaded already
(e.g. using REQUEST_MODEL).
Unused. Peds get set to CIVMALE/CIVFEMALE/etc. no matter the value specified.
The model of ped to spawn.
Spawn coordinate X component.
Spawn coordinate Y component.
Spawn coordinate Z component.
Heading to face towards, in degrees.
Whether to create a network object for the ped. If false, the ped exists only locally.
Whether to register the ped as pinned to the script host in the R\* network model.
A script handle (fwScriptGuid index) for the ped, or `0` if the ped failed to be created.
]]
native "CREATE_PED_INSIDE_VEHICLE"
hash "0x7DD959874C1FD534"
jhash (0x3000F092)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "pedType" [=[ {} ]=],
Hash "modelHash" [=[ {} ]=],
int "seat" [=[ {} ]=],
BOOL "isNetwork" [=[ {} ]=],
BOOL "bScriptHostPed" [=[ {} ]=],
}
ns "PED"
returns "Ped"
doc [[!
See [`CREATE_PED`](#\_0xD49F9B0955C367DE)
]]
native "CREATE_RANDOM_PED"
hash "0xB4AC7D0CF06BFE8F"
jhash (0x5A949543)
arguments {
float "posX" [=[ {} ]=],
float "posY" [=[ {} ]=],
float "posZ" [=[ {} ]=],
}
ns "PED"
returns "Ped"
doc [[!
```
vb.net
Dim ped_handle As Integer
With Game.Player.Character
Dim pos As Vector3 = .Position + .ForwardVector * 3
ped_handle = Native.Function.Call(Of Integer)(Hash.CREATE_RANDOM_PED, pos.X, pos.Y, pos.Z)
End With
Creates a Ped at the specified location, returns the Ped Handle.
Ped will not act until SET_PED_AS_NO_LONGER_NEEDED is called.
```
]]
native "CREATE_RANDOM_PED_AS_DRIVER"
hash "0x9B62392B474F44A0"
jhash (0xB927CE9A)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "returnHandle" [=[ {} ]=],
}
ns "PED"
returns "Ped"
doc [[!
]]
native "CREATE_SYNCHRONIZED_SCENE"
hash "0x8C18E0F9080ADD73"
jhash (0xFFDDF8FA)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "roll" [=[ {} ]=],
float "pitch" [=[ {} ]=],
float "yaw" [=[ {} ]=],
int "p6" [=[ {} ]=],
}
ns "PED"
returns "int"
doc [[!
```
p6 always 2 (but it doesnt seem to matter...)
roll and pitch 0
yaw to Ped.rotation
```
]]
native "DELETE_PED"
hash "0x9614299DCB53E54B"
jhash (0x13EFB9A0)
arguments {
PedPtr "ped" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
Deletes the specified ped, then sets the handle pointed to by the pointer to NULL.
```
]]
native "DETACH_SYNCHRONIZED_SCENE"
hash "0x6D38F1F04CBB37EA"
jhash (0x52A1CAB2)
arguments {
int "sceneID" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "DISABLE_HEAD_BLEND_PALETTE_COLOR"
hash "0xA21C118553BBDF02"
jhash (0xC6F36292)
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0xA21C118553BBDF02"
ns "PED"
returns "void"
doc [[!
]]
native "DISABLE_PED_HEATSCALE_OVERRIDE"
hash "0x600048C60D5C2C51"
jhash (0x0688DE64)
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0x600048C60D5C2C51"
ns "PED"
returns "void"
doc [[!
]]
native "DOES_GROUP_EXIST"
hash "0x7C6B0C22F9F40BBE"
jhash (0x935C978D)
arguments {
int "groupId" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "DROP_AMBIENT_PROP"
hash "0xAFF4710E2A0A6C12"
jhash (0x728D3D53)
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0xAFF4710E2A0A6C12"
ns "PED"
returns "void"
doc [[!
]]
native "EXPLODE_PED_HEAD"
hash "0x2D05CED3A38D0F3A"
jhash (0x05CC1380)
arguments {
Ped "ped" [=[ {} ]=],
Hash "weaponHash" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
Applies lethal damage (FLT_MAX) to the `SKEL_Head` bone of the specified ped using the weapon passed, leading to the
ped's untimely demise.
The naming of the native is a legacy leftover (formerly EXPLODE_CHAR_HEAD in GTA3) as in the early 3D GTA games, lethal
damage to a ped head would 'explode' it.
Do note that this native function does not work in multiplayer/network environment.
The ped to lethally injure.
The weapon to attribute the damage to.
]]
native "FINALIZE_HEAD_BLEND"
hash "0x4668D80430D6C299"
jhash (0x894314A4)
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0x4668D80430D6C299"
ns "PED"
returns "void"
doc [[!
]]
native "FORCE_PED_AI_AND_ANIMATION_UPDATE"
hash "0x2208438012482A1A"
jhash (0x187B9070)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "forceAiPreCameraUpdate" [=[ {} ]=],
BOOL "forceZeroTimestep" [=[ {} ]=],
}
alias "0x2208438012482A1A"
ns "PED"
returns "void"
doc [[!
Forces an instant ped AI and Animation update. Use this if your transitions between animations (especially secondary upper body animations) are janky or not smooth.
Do note this is an expensive function.
]]
native "FORCE_PED_MOTION_STATE"
hash "0xF28965D04F570DCA"
jhash (0x164DDEFF)
arguments {
Ped "ped" [=[ {} ]=],
Hash "motionStateHash" [=[ {} ]=],
BOOL "shouldReset" [=[ {} ]=],
int "updateState" [=[ {"cs_type":"BOOL"} ]=],
BOOL "forceAIPreCameraUpdate" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
```cpp
enum ePedMotionState
{
MOTIONSTATE_NONE = -294553821, // MotionState_None
MOTIONSTATE_IDLE = -1871534317, // MotionState_Idle
MOTIONSTATE_WALK = -668482597, // MotionState_Walk
MOTIONSTATE_RUN = -530524, // MotionState_Run
MOTIONSTATE_SPRINT = -1115154469, // MotionState_Sprint
MOTIONSTATE_CROUCH_IDLE = 1140525470, // MotionState_Crouch_Idle
MOTIONSTATE_CROUCH_WALK = 147004056, // MotionState_Crouch_Walk
MOTIONSTATE_CROUCH_RUN = 898879241, // MotionState_Crouch_Run
MOTIONSTATE_DONOTHING = 247561816, // MotionState_DoNothing
MOTIONSTATE_ANIMATEDVELOCITY = 1427811395, // MotionState_AnimatedVelocity
MOTIONSTATE_INVEHICLE = -1797663347, // MotionState_InVehicle
MOTIONSTATE_AIMING = 1063765679, // MotionState_Aiming
MOTIONSTATE_DIVING_IDLE = 1212730861, // MotionState_Diving_Idle
MOTIONSTATE_DIVING_SWIM = -1855028596, // MotionState_Diving_Swim
MOTIONSTATE_SWIMMING_TREADWATER = -776007225, // MotionState_Swimming_TreadWater
MOTIONSTATE_DEAD = 230360860, // MotionState_Dead
MOTIONSTATE_STEALTH_IDLE = 1110276645, // MotionState_Stealth_Idle
MOTIONSTATE_STEALTH_WALK = 69908130, // MotionState_Stealth_Walk
MOTIONSTATE_STEALTH_RUN = -83133983, // MotionState_Stealth_Run
MOTIONSTATE_PARACHUTING = -1161760501, // MotionState_Parachuting
MOTIONSTATE_ACTIONMODE_IDLE = -633298724, // MotionState_ActionMode_Idle
MOTIONSTATE_ACTIONMODE_WALK = -762290521, // MotionState_ActionMode_Walk
MOTIONSTATE_ACTIONMODE_RUN = 834330132, // MotionState_ActionMode_Run
MOTIONSTATE_JETPACK = 1398696542 // MotionState_Jetpack
}
```
The ped handle.
The motion state hash.
If the motion state should be set even if the ped is already in the specified motion state.
Integer but treated as a boolean (only allows 1 or 0). Sets ped reset flags `CPED_RESET_FLAG_ForcePreCameraAiAnimUpdateIfFirstPerson` and `CPED_RESET_FLAG_ForcePostCameraAnimUpdate`.
If `updateState` is 1, will set either `CPED_RESET_FLAG_ForcePreCameraAIUpdate` (if true) or `CPED_RESET_FLAG_ForcePostCameraAIUpdate` (if false) ped reset flags.
Whether or not the motion state was forced on the ped successfully.
]]
native "FORCE_PED_TO_OPEN_PARACHUTE"
hash "0x16E42E800B472221"
jhash (0xA819680B)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "GET_ANIM_INITIAL_OFFSET_POSITION"
hash "0xBE22B26DD764C040"
jhash (0xC59D4268)
arguments {
charPtr "animDict" [=[ {} ]=],
charPtr "animName" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "xRot" [=[ {} ]=],
float "yRot" [=[ {} ]=],
float "zRot" [=[ {} ]=],
float "p8" [=[ {} ]=],
int "p9" [=[ {} ]=],
}
ns "PED"
returns "Vector3"
doc [[!
[Animations list](https://alexguirre.github.io/animations-list/)
]]
native "GET_ANIM_INITIAL_OFFSET_ROTATION"
hash "0x4B805E6046EE9E47"
jhash (0x5F7789E6)
arguments {
charPtr "animDict" [=[ {} ]=],
charPtr "animName" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "xRot" [=[ {} ]=],
float "yRot" [=[ {} ]=],
float "zRot" [=[ {} ]=],
float "p8" [=[ {} ]=],
int "p9" [=[ {} ]=],
}
ns "PED"
returns "Vector3"
doc [[!
[Animations list](https://alexguirre.github.io/animations-list/)
]]
native "GET_CLOSEST_PED"
hash "0xC33AB876A77F8164"
jhash (0x8F6C1F55)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "radius" [=[ {} ]=],
BOOL "p4" [=[ {} ]=],
BOOL "p5" [=[ {} ]=],
PedPtr "outPed" [=[ {} ]=],
BOOL "p7" [=[ {} ]=],
BOOL "p8" [=[ {} ]=],
int "pedType" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
```
Gets the closest ped in a radius.
Ped Types:
Any ped = -1
Player = 1
Male = 4
Female = 5
Cop = 6
Human = 26
SWAT = 27
Animal = 28
Army = 29
------------------
P4 P5 P7 P8
1 0 x x = return nearest walking Ped
1 x 0 x = return nearest walking Ped
x 1 1 x = return Ped you are using
0 0 x x = no effect
0 x 0 x = no effect
x = can be 1 or 0. Does not have any obvious changes.
This function does not return ped who is:
1. Standing still
2. Driving
3. Fleeing
4. Attacking
This function only work if the ped is:
1. walking normally.
2. waiting to cross a road.
Note: PED::GET_PED_NEARBY_PEDS works for more peds.
```
]]
native "GET_COMBAT_FLOAT"
hash "0x52DFF8A10508090A"
jhash (0x511D7EF8)
arguments {
Ped "ped" [=[ {} ]=],
int "p1" [=[ {} ]=],
}
ns "PED"
returns "float"
doc [[!
```
p0: Ped Handle
p1: int i | 0 <= i <= 27
p1 probably refers to the attributes configured in combatbehavior.meta. There are 13. Example:
-------------Confirmed by editing combatbehavior.meta:
p1:
0=BlindFireChance
1=BurstDurationInCover
3=TimeBetweenBurstsInCover
4=TimeBetweenPeeks
5=StrafeWhenMovingChance
8=WalkWhenStrafingChance
11=AttackWindowDistanceForCover
12=TimeToInvalidateInjuredTarget
16=OptimalCoverDistance
```
]]
native "GET_DEAD_PED_PICKUP_COORDS"
hash "0xCD5003B097200F36"
jhash (0x129F9DC1)
arguments {
Ped "ped" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
}
ns "PED"
returns "Vector3"
doc [[!
]]
native "GET_GROUP_SIZE"
hash "0x8DE69FE35CA09A45"
jhash (0xF7E1A691)
arguments {
int "groupID" [=[ {} ]=],
AnyPtr "unknown" [=[ {} ]=],
intPtr "sizeInMembers" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
p1 may be a BOOL representing whether or not the group even exists
```
]]
native "GET_JACK_TARGET"
hash "0x5486A79D9FBD342D"
jhash (0x1D196361)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "Ped"
doc [[!
]]
native "GET_MELEE_TARGET_FOR_PED"
hash "0x18A3E9EE1297FD39"
jhash (0xAFEC26A4)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "Ped"
doc [[!
]]
native "GET_MOUNT"
hash "0xE7E11B8DCBED1058"
jhash (0xDD31EC4E)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "Ped"
doc [[!
```
Function just returns 0
void __fastcall ped__get_mount(NativeContext *a1)
{
NativeContext *v1; // rbx@1
v1 = a1;
GetAddressOfPedFromScriptHandle(a1->Args->Arg1);
v1->Returns->Item1= 0;
}
```
]]
native "GET_NUMBER_OF_PED_DRAWABLE_VARIATIONS"
hash "0x27561561732A7842"
jhash (0x9754C27D)
arguments {
Ped "ped" [=[ {} ]=],
int "componentId" [=[ {} ]=],
}
ns "PED"
returns "int"
doc [[!
The ped handle.
The component id you want to get the drawable variatons of. Refer to [SET_PED_COMPONENT_VARIATION](#\_0x262B14F48D29DE80)
]]
native "GET_NUMBER_OF_PED_PROP_DRAWABLE_VARIATIONS"
hash "0x5FAF9754E789FB47"
jhash (0xC9780B95)
arguments {
Ped "ped" [=[ {} ]=],
int "propId" [=[ {} ]=],
}
ns "PED"
returns "int"
doc [[!
The ped handle.
The prop id you want to get the drawable variations of. Refer to [SET_PED_PROP_INDEX](#\_0x93376B65A266EB5F)
]]
native "GET_NUMBER_OF_PED_PROP_TEXTURE_VARIATIONS"
hash "0xA6E7F1CEB523E171"
jhash (0x4892B882)
arguments {
Ped "ped" [=[ {} ]=],
int "propId" [=[ {} ]=],
int "drawableId" [=[ {} ]=],
}
ns "PED"
returns "int"
doc [[!
```
Need to check behavior when drawableId = -1
```
The ped handle.
The prop id you want to get the texture variations of. Refer to [SET_PED_PROP_INDEX](#\_0x93376B65A266EB5F)
The drawable id of the prop you want to get the texture variations of. Refer to [GET_NUMBER_OF_PED_PROP_DRAWABLE_VARIATIONS](#\_0x5FAF9754E789FB47).
]]
native "GET_NUMBER_OF_PED_TEXTURE_VARIATIONS"
hash "0x8F7156A3142A6BAD"
jhash (0x83D9FBE7)
arguments {
Ped "ped" [=[ {} ]=],
int "componentId" [=[ {} ]=],
int "drawableId" [=[ {} ]=],
}
ns "PED"
returns "int"
doc [[!
The ped handle.
The component id you want to get the texture variations of. Refer to [SET_PED_COMPONENT_VARIATION](#\_0x262B14F48D29DE80).
The drawable id of the component you want to get the texture variations of. Refer to [GET_NUMBER_OF_PED_PROP_DRAWABLE_VARIATIONS](#\_0x5FAF9754E789FB47).
]]
native "GET_PED_ACCURACY"
hash "0x37F4AD56ECBC0CD6"
jhash (0x0A2A0AA0)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "int"
doc [[!
]]
native "GET_PED_ALERTNESS"
hash "0xF6AA118530443FD2"
jhash (0xF83E4DAF)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "int"
doc [[!
```
Returns the ped's alertness (0-3).
Values :
0 : Neutral
1 : Heard something (gun shot, hit, etc)
2 : Knows (the origin of the event)
3 : Fully alerted (is facing the event?)
If the Ped does not exist, returns -1.
```
]]
native "GET_PED_ARMOUR"
hash "0x9483AF821605B1D8"
jhash (0x2CE311A7)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "int"
doc [[!
]]
native "GET_PED_AS_GROUP_LEADER"
hash "0x5CCE68DBD5FE93EC"
jhash (0x52873C6A)
arguments {
int "groupID" [=[ {} ]=],
}
alias "_GET_PED_AS_GROUP_LEADER"
ns "PED"
returns "Ped"
doc [[!
]]
native "GET_PED_AS_GROUP_MEMBER"
hash "0x51455483CF23ED97"
jhash (0x9AA3CC8C)
arguments {
int "groupID" [=[ {} ]=],
int "memberNumber" [=[ {} ]=],
}
ns "PED"
returns "Ped"
doc [[!
```
from fm_mission_controller.c4 (variable names changed for clarity):
int groupID = PLAYER::GET_PLAYER_GROUP(PLAYER::PLAYER_ID());
PED::GET_GROUP_SIZE(group, &unused, &groupSize);
if (groupSize >= 1) {
. . . . for (int memberNumber = 0; memberNumber < groupSize; memberNumber++) {
. . . . . . . . Ped ped1 = PED::GET_PED_AS_GROUP_MEMBER(groupID, memberNumber);
. . . . . . . . //and so on
```
]]
native "GET_PED_BONE_COORDS"
hash "0x17C07FC640E86B4E"
jhash (0x4579CAB1)
arguments {
Ped "ped" [=[ {} ]=],
int "boneId" [=[ {} ]=],
float "offsetX" [=[ {} ]=],
float "offsetY" [=[ {} ]=],
float "offsetZ" [=[ {} ]=],
}
ns "PED"
returns "Vector3"
doc [[!
```
Gets the position of the specified bone of the specified ped.
ped: The ped to get the position of a bone from.
boneId: The ID of the bone to get the position from. This is NOT the index.
offsetX: The X-component of the offset to add to the position relative to the bone's rotation.
offsetY: The Y-component of the offset to add to the position relative to the bone's rotation.
offsetZ: The Z-component of the offset to add to the position relative to the bone's rotation.
```
]]
native "GET_PED_BONE_INDEX"
hash "0x3F428D08BE5AAE31"
jhash (0x259C6BA2)
arguments {
Ped "ped" [=[ {} ]=],
int "boneId" [=[ {} ]=],
}
ns "PED"
returns "int"
doc [[!
```cpp
enum ePedBoneId : uint16_t
{
SKEL_ROOT = 0x0,
SKEL_Pelvis = 0x2E28,
SKEL_L_Thigh = 0xE39F,
SKEL_L_Calf = 0xF9BB,
SKEL_L_Foot = 0x3779,
SKEL_L_Toe0 = 0x83C,
EO_L_Foot = 0x84C5,
EO_L_Toe = 0x68BD,
IK_L_Foot = 0xFEDD,
PH_L_Foot = 0xE175,
MH_L_Knee = 0xB3FE,
SKEL_R_Thigh = 0xCA72,
SKEL_R_Calf = 0x9000,
SKEL_R_Foot = 0xCC4D,
SKEL_R_Toe0 = 0x512D,
EO_R_Foot = 0x1096,
EO_R_Toe = 0x7163,
IK_R_Foot = 0x8AAE,
PH_R_Foot = 0x60E6,
MH_R_Knee = 0x3FCF,
RB_L_ThighRoll = 0x5C57,
RB_R_ThighRoll = 0x192A,
SKEL_Spine_Root = 0xE0FD,
SKEL_Spine0 = 0x5C01,
SKEL_Spine1 = 0x60F0,
SKEL_Spine2 = 0x60F1,
SKEL_Spine3 = 0x60F2,
SKEL_L_Clavicle = 0xFCD9,
SKEL_L_UpperArm = 0xB1C5,
SKEL_L_Forearm = 0xEEEB,
SKEL_L_Hand = 0x49D9,
SKEL_L_Finger00 = 0x67F2,
SKEL_L_Finger01 = 0xFF9,
SKEL_L_Finger02 = 0xFFA,
SKEL_L_Finger10 = 0x67F3,
SKEL_L_Finger11 = 0x1049,
SKEL_L_Finger12 = 0x104A,
SKEL_L_Finger20 = 0x67F4,
SKEL_L_Finger21 = 0x1059,
SKEL_L_Finger22 = 0x105A,
SKEL_L_Finger30 = 0x67F5,
SKEL_L_Finger31 = 0x1029,
SKEL_L_Finger32 = 0x102A,
SKEL_L_Finger40 = 0x67F6,
SKEL_L_Finger41 = 0x1039,
SKEL_L_Finger42 = 0x103A,
PH_L_Hand = 0xEB95,
IK_L_Hand = 0x8CBD,
RB_L_ForeArmRoll = 0xEE4F,
RB_L_ArmRoll = 0x1470,
MH_L_Elbow = 0x58B7,
SKEL_R_Clavicle = 0x29D2,
SKEL_R_UpperArm = 0x9D4D,
SKEL_R_Forearm = 0x6E5C,
SKEL_R_Hand = 0xDEAD,
SKEL_R_Finger00 = 0xE5F2,
SKEL_R_Finger01 = 0xFA10,
SKEL_R_Finger02 = 0xFA11,
SKEL_R_Finger10 = 0xE5F3,
SKEL_R_Finger11 = 0xFA60,
SKEL_R_Finger12 = 0xFA61,
SKEL_R_Finger20 = 0xE5F4,
SKEL_R_Finger21 = 0xFA70,
SKEL_R_Finger22 = 0xFA71,
SKEL_R_Finger30 = 0xE5F5,
SKEL_R_Finger31 = 0xFA40,
SKEL_R_Finger32 = 0xFA41,
SKEL_R_Finger40 = 0xE5F6,
SKEL_R_Finger41 = 0xFA50,
SKEL_R_Finger42 = 0xFA51,
PH_R_Hand = 0x6F06,
IK_R_Hand = 0x188E,
RB_R_ForeArmRoll = 0xAB22,
RB_R_ArmRoll = 0x90FF,
MH_R_Elbow = 0xBB0,
SKEL_Neck_1 = 0x9995,
SKEL_Head = 0x796E,
IK_Head = 0x322C,
FACIAL_facialRoot = 0xFE2C,
FB_L_Brow_Out_000 = 0xE3DB,
FB_L_Lid_Upper_000 = 0xB2B6,
FB_L_Eye_000 = 0x62AC,
FB_L_CheekBone_000 = 0x542E,
FB_L_Lip_Corner_000 = 0x74AC,
FB_R_Lid_Upper_000 = 0xAA10,
FB_R_Eye_000 = 0x6B52,
FB_R_CheekBone_000 = 0x4B88,
FB_R_Brow_Out_000 = 0x54C,
FB_R_Lip_Corner_000 = 0x2BA6,
FB_Brow_Centre_000 = 0x9149,
FB_UpperLipRoot_000 = 0x4ED2,
FB_UpperLip_000 = 0xF18F,
FB_L_Lip_Top_000 = 0x4F37,
FB_R_Lip_Top_000 = 0x4537,
FB_Jaw_000 = 0xB4A0,
FB_LowerLipRoot_000 = 0x4324,
FB_LowerLip_000 = 0x508F,
FB_L_Lip_Bot_000 = 0xB93B,
FB_R_Lip_Bot_000 = 0xC33B,
FB_Tongue_000 = 0xB987,
RB_Neck_1 = 0x8B93,
SPR_L_Breast = 0xFC8E,
SPR_R_Breast = 0x885F,
IK_Root = 0xDD1C,
SKEL_Neck_2 = 0x5FD4,
SKEL_Pelvis1 = 0xD003,
SKEL_PelvisRoot = 0x45FC,
SKEL_SADDLE = 0x9524,
MH_L_CalfBack = 0x1013,
MH_L_ThighBack = 0x600D,
SM_L_Skirt = 0xC419,
MH_R_CalfBack = 0xB013,
MH_R_ThighBack = 0x51A3,
SM_R_Skirt = 0x7712,
SM_M_BackSkirtRoll = 0xDBB,
SM_L_BackSkirtRoll = 0x40B2,
SM_R_BackSkirtRoll = 0xC141,
SM_M_FrontSkirtRoll = 0xCDBB,
SM_L_FrontSkirtRoll = 0x9B69,
SM_R_FrontSkirtRoll = 0x86F1,
SM_CockNBalls_ROOT = 0xC67D,
SM_CockNBalls = 0x9D34,
MH_L_Finger00 = 0x8C63,
MH_L_FingerBulge00 = 0x5FB8,
MH_L_Finger10 = 0x8C53,
MH_L_FingerTop00 = 0xA244,
MH_L_HandSide = 0xC78A,
MH_Watch = 0x2738,
MH_L_Sleeve = 0x933C,
MH_R_Finger00 = 0x2C63,
MH_R_FingerBulge00 = 0x69B8,
MH_R_Finger10 = 0x2C53,
MH_R_FingerTop00 = 0xEF4B,
MH_R_HandSide = 0x68FB,
MH_R_Sleeve = 0x92DC,
FACIAL_jaw = 0xB21,
FACIAL_underChin = 0x8A95,
FACIAL_L_underChin = 0x234E,
FACIAL_chin = 0xB578,
FACIAL_chinSkinBottom = 0x98BC,
FACIAL_L_chinSkinBottom = 0x3E8F,
FACIAL_R_chinSkinBottom = 0x9E8F,
FACIAL_tongueA = 0x4A7C,
FACIAL_tongueB = 0x4A7D,
FACIAL_tongueC = 0x4A7E,
FACIAL_tongueD = 0x4A7F,
FACIAL_tongueE = 0x4A80,
FACIAL_L_tongueE = 0x35F2,
FACIAL_R_tongueE = 0x2FF2,
FACIAL_L_tongueD = 0x35F1,
FACIAL_R_tongueD = 0x2FF1,
FACIAL_L_tongueC = 0x35F0,
FACIAL_R_tongueC = 0x2FF0,
FACIAL_L_tongueB = 0x35EF,
FACIAL_R_tongueB = 0x2FEF,
FACIAL_L_tongueA = 0x35EE,
FACIAL_R_tongueA = 0x2FEE,
FACIAL_chinSkinTop = 0x7226,
FACIAL_L_chinSkinTop = 0x3EB3,
FACIAL_chinSkinMid = 0x899A,
FACIAL_L_chinSkinMid = 0x4427,
FACIAL_L_chinSide = 0x4A5E,
FACIAL_R_chinSkinMid = 0xF5AF,
FACIAL_R_chinSkinTop = 0xF03B,
FACIAL_R_chinSide = 0xAA5E,
FACIAL_R_underChin = 0x2BF4,
FACIAL_L_lipLowerSDK = 0xB9E1,
FACIAL_L_lipLowerAnalog = 0x244A,
FACIAL_L_lipLowerThicknessV = 0xC749,
FACIAL_L_lipLowerThicknessH = 0xC67B,
FACIAL_lipLowerSDK = 0x7285,
FACIAL_lipLowerAnalog = 0xD97B,
FACIAL_lipLowerThicknessV = 0xC5BB,
FACIAL_lipLowerThicknessH = 0xC5ED,
FACIAL_R_lipLowerSDK = 0xA034,
FACIAL_R_lipLowerAnalog = 0xC2D9,
FACIAL_R_lipLowerThicknessV = 0xC6E9,
FACIAL_R_lipLowerThicknessH = 0xC6DB,
FACIAL_nose = 0x20F1,
FACIAL_L_nostril = 0x7322,
FACIAL_L_nostrilThickness = 0xC15F,
FACIAL_noseLower = 0xE05A,
FACIAL_L_noseLowerThickness = 0x79D5,
FACIAL_R_noseLowerThickness = 0x7975,
FACIAL_noseTip = 0x6A60,
FACIAL_R_nostril = 0x7922,
FACIAL_R_nostrilThickness = 0x36FF,
FACIAL_noseUpper = 0xA04F,
FACIAL_L_noseUpper = 0x1FB8,
FACIAL_noseBridge = 0x9BA3,
FACIAL_L_nasolabialFurrow = 0x5ACA,
FACIAL_L_nasolabialBulge = 0xCD78,
FACIAL_L_cheekLower = 0x6907,
FACIAL_L_cheekLowerBulge1 = 0xE3FB,
FACIAL_L_cheekLowerBulge2 = 0xE3FC,
FACIAL_L_cheekInner = 0xE7AB,
FACIAL_L_cheekOuter = 0x8161,
FACIAL_L_eyesackLower = 0x771B,
FACIAL_L_eyeball = 0x1744,
FACIAL_L_eyelidLower = 0x998C,
FACIAL_L_eyelidLowerOuterSDK = 0xFE4C,
FACIAL_L_eyelidLowerOuterAnalog = 0xB9AA,
FACIAL_L_eyelashLowerOuter = 0xD7F6,
FACIAL_L_eyelidLowerInnerSDK = 0xF151,
FACIAL_L_eyelidLowerInnerAnalog = 0x8242,
FACIAL_L_eyelashLowerInner = 0x4CCF,
FACIAL_L_eyelidUpper = 0x97C1,
FACIAL_L_eyelidUpperOuterSDK = 0xAF15,
FACIAL_L_eyelidUpperOuterAnalog = 0x67FA,
FACIAL_L_eyelashUpperOuter = 0x27B7,
FACIAL_L_eyelidUpperInnerSDK = 0xD341,
FACIAL_L_eyelidUpperInnerAnalog = 0xF092,
FACIAL_L_eyelashUpperInner = 0x9B1F,
FACIAL_L_eyesackUpperOuterBulge = 0xA559,
FACIAL_L_eyesackUpperInnerBulge = 0x2F2A,
FACIAL_L_eyesackUpperOuterFurrow = 0xC597,
FACIAL_L_eyesackUpperInnerFurrow = 0x52A7,
FACIAL_forehead = 0x9218,
FACIAL_L_foreheadInner = 0x843,
FACIAL_L_foreheadInnerBulge = 0x767C,
FACIAL_L_foreheadOuter = 0x8DCB,
FACIAL_skull = 0x4221,
FACIAL_foreheadUpper = 0xF7D6,
FACIAL_L_foreheadUpperInner = 0xCF13,
FACIAL_L_foreheadUpperOuter = 0x509B,
FACIAL_R_foreheadUpperInner = 0xCEF3,
FACIAL_R_foreheadUpperOuter = 0x507B,
FACIAL_L_temple = 0xAF79,
FACIAL_L_ear = 0x19DD,
FACIAL_L_earLower = 0x6031,
FACIAL_L_masseter = 0x2810,
FACIAL_L_jawRecess = 0x9C7A,
FACIAL_L_cheekOuterSkin = 0x14A5,
FACIAL_R_cheekLower = 0xF367,
FACIAL_R_cheekLowerBulge1 = 0x599B,
FACIAL_R_cheekLowerBulge2 = 0x599C,
FACIAL_R_masseter = 0x810,
FACIAL_R_jawRecess = 0x93D4,
FACIAL_R_ear = 0x1137,
FACIAL_R_earLower = 0x8031,
FACIAL_R_eyesackLower = 0x777B,
FACIAL_R_nasolabialBulge = 0xD61E,
FACIAL_R_cheekOuter = 0xD32,
FACIAL_R_cheekInner = 0x737C,
FACIAL_R_noseUpper = 0x1CD6,
FACIAL_R_foreheadInner = 0xE43,
FACIAL_R_foreheadInnerBulge = 0x769C,
FACIAL_R_foreheadOuter = 0x8FCB,
FACIAL_R_cheekOuterSkin = 0xB334,
FACIAL_R_eyesackUpperInnerFurrow = 0x9FAE,
FACIAL_R_eyesackUpperOuterFurrow = 0x140F,
FACIAL_R_eyesackUpperInnerBulge = 0xA359,
FACIAL_R_eyesackUpperOuterBulge = 0x1AF9,
FACIAL_R_nasolabialFurrow = 0x2CAA,
FACIAL_R_temple = 0xAF19,
FACIAL_R_eyeball = 0x1944,
FACIAL_R_eyelidUpper = 0x7E14,
FACIAL_R_eyelidUpperOuterSDK = 0xB115,
FACIAL_R_eyelidUpperOuterAnalog = 0xF25A,
FACIAL_R_eyelashUpperOuter = 0xE0A,
FACIAL_R_eyelidUpperInnerSDK = 0xD541,
FACIAL_R_eyelidUpperInnerAnalog = 0x7C63,
FACIAL_R_eyelashUpperInner = 0x8172,
FACIAL_R_eyelidLower = 0x7FDF,
FACIAL_R_eyelidLowerOuterSDK = 0x1BD,
FACIAL_R_eyelidLowerOuterAnalog = 0x457B,
FACIAL_R_eyelashLowerOuter = 0xBE49,
FACIAL_R_eyelidLowerInnerSDK = 0xF351,
FACIAL_R_eyelidLowerInnerAnalog = 0xE13,
FACIAL_R_eyelashLowerInner = 0x3322,
FACIAL_L_lipUpperSDK = 0x8F30,
FACIAL_L_lipUpperAnalog = 0xB1CF,
FACIAL_L_lipUpperThicknessH = 0x37CE,
FACIAL_L_lipUpperThicknessV = 0x38BC,
FACIAL_lipUpperSDK = 0x1774,
FACIAL_lipUpperAnalog = 0xE064,
FACIAL_lipUpperThicknessH = 0x7993,
FACIAL_lipUpperThicknessV = 0x7981,
FACIAL_L_lipCornerSDK = 0xB1C,
FACIAL_L_lipCornerAnalog = 0xE568,
FACIAL_L_lipCornerThicknessUpper = 0x7BC,
FACIAL_L_lipCornerThicknessLower = 0xDD42,
FACIAL_R_lipUpperSDK = 0x7583,
FACIAL_R_lipUpperAnalog = 0x51CF,
FACIAL_R_lipUpperThicknessH = 0x382E,
FACIAL_R_lipUpperThicknessV = 0x385C,
FACIAL_R_lipCornerSDK = 0xB3C,
FACIAL_R_lipCornerAnalog = 0xEE0E,
FACIAL_R_lipCornerThicknessUpper = 0x54C3,
FACIAL_R_lipCornerThicknessLower = 0x2BBA,
MH_MulletRoot = 0x3E73,
MH_MulletScaler = 0xA1C2,
MH_Hair_Scale = 0xC664,
MH_Hair_Crown = 0x1675,
SM_Torch = 0x8D6,
FX_Light = 0x8959,
FX_Light_Scale = 0x5038,
FX_Light_Switch = 0xE18E,
BagRoot = 0xAD09,
BagPivotROOT = 0xB836,
BagPivot = 0x4D11,
BagBody = 0xAB6D,
BagBone_R = 0x937,
BagBone_L = 0x991,
SM_LifeSaver_Front = 0x9420,
SM_R_Pouches_ROOT = 0x2962,
SM_R_Pouches = 0x4141,
SM_L_Pouches_ROOT = 0x2A02,
SM_L_Pouches = 0x4B41,
SM_Suit_Back_Flapper = 0xDA2D,
SPR_CopRadio = 0x8245,
SM_LifeSaver_Back = 0x2127,
MH_BlushSlider = 0xA0CE,
SKEL_Tail_01 = 0x347,
SKEL_Tail_02 = 0x348,
MH_L_Concertina_B = 0xC988,
MH_L_Concertina_A = 0xC987,
MH_R_Concertina_B = 0xC8E8,
MH_R_Concertina_A = 0xC8E7,
MH_L_ShoulderBladeRoot = 0x8711,
MH_L_ShoulderBlade = 0x4EAF,
MH_R_ShoulderBladeRoot = 0x3A0A,
MH_R_ShoulderBlade = 0x54AF,
FB_R_Ear_000 = 0x6CDF,
SPR_R_Ear = 0x63B6,
FB_L_Ear_000 = 0x6439,
SPR_L_Ear = 0x5B10,
FB_TongueA_000 = 0x4206,
FB_TongueB_000 = 0x4207,
FB_TongueC_000 = 0x4208,
SKEL_L_Toe1 = 0x1D6B,
SKEL_R_Toe1 = 0xB23F,
SKEL_Tail_03 = 0x349,
SKEL_Tail_04 = 0x34A,
SKEL_Tail_05 = 0x34B,
SPR_Gonads_ROOT = 0xBFDE,
SPR_Gonads = 0x1C00,
FB_L_Brow_Out_001 = 0xE3DB,
FB_L_Lid_Upper_001 = 0xB2B6,
FB_L_Eye_001 = 0x62AC,
FB_L_CheekBone_001 = 0x542E,
FB_L_Lip_Corner_001 = 0x74AC,
FB_R_Lid_Upper_001 = 0xAA10,
FB_R_Eye_001 = 0x6B52,
FB_R_CheekBone_001 = 0x4B88,
FB_R_Brow_Out_001 = 0x54C,
FB_R_Lip_Corner_001 = 0x2BA6,
FB_Brow_Centre_001 = 0x9149,
FB_UpperLipRoot_001 = 0x4ED2,
FB_UpperLip_001 = 0xF18F,
FB_L_Lip_Top_001 = 0x4F37,
FB_R_Lip_Top_001 = 0x4537,
FB_Jaw_001 = 0xB4A0,
FB_LowerLipRoot_001 = 0x4324,
FB_LowerLip_001 = 0x508F,
FB_L_Lip_Bot_001 = 0xB93B,
FB_R_Lip_Bot_001 = 0xC33B,
FB_Tongue_001 = 0xB987
};
```
]]
native "GET_PED_CAUSE_OF_DEATH"
hash "0x16FFE42AB2D2DC59"
jhash (0x63458C27)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "Hash"
doc [[!
```
Returns the hash of the weapon/model/object that killed the ped.
```
]]
native "GET_PED_COMBAT_MOVEMENT"
hash "0xDEA92412FCAEB3F5"
jhash (0xF3E7730E)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "int"
doc [[!
]]
native "GET_PED_COMBAT_RANGE"
hash "0xF9D9F7F2DB8E2FA0"
jhash (0x9B9B7163)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "int"
doc [[!
]]
native "GET_PED_CONFIG_FLAG"
hash "0x7EE53118C892B513"
jhash (0xABE98267)
arguments {
Ped "ped" [=[ {} ]=],
int "flagId" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
See [`SET_PED_CONFIG_FLAG`](#\_0x1913FE4CBF41C463).
]]
native "GET_PED_DECORATION_ZONE_FROM_HASHES"
hash "0x9FD452BFBE7A7A8B"
jhash (0x3543019E)
arguments {
Hash "collection" [=[ {} ]=],
Hash "overlay" [=[ {} ]=],
}
alias "_GET_TATTOO_ZONE"
ns "PED"
returns "int"
doc [[!
```cpp
enum ePedDecorationZone
{
ZONE_TORSO = 0,
ZONE_HEAD = 1,
ZONE_LEFT_ARM = 2,
ZONE_RIGHT_ARM = 3,
ZONE_LEFT_LEG = 4,
ZONE_RIGHT_LEG = 5,
ZONE_UNKNOWN = 6,
ZONE_NONE = 7
};
```
Returns the doeciration zone for the specific collection and overlay combination, refer to `ePedDecorationZone`
]]
native "GET_PED_DECORATIONS_STATE"
hash "0x71EAB450D86954A1"
jhash (0x47187F7F)
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0x71EAB450D86954A1"
ns "PED"
returns "int"
doc [[!
]]
native "GET_PED_DEFENSIVE_AREA_POSITION"
hash "0x3C06B8786DD94CD1"
jhash (0xCB65198D)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "PED"
returns "Vector3"
doc [[!
]]
native "GET_PED_DRAWABLE_VARIATION"
hash "0x67F3780DD425D4FC"
jhash (0x29850FE2)
arguments {
Ped "ped" [=[ {} ]=],
int "componentId" [=[ {} ]=],
}
ns "PED"
returns "int"
doc [[!
```
Ids
0 - Head
1 - Beard
2 - Hair
3 - Torso
4 - Legs
5 - Hands
6 - Foot
7 - Scarfs/Neck Accessories
8 - Accessories 1
9 - Accessories 2
10- Decals
11 - Auxiliary parts for torso
```
]]
native "GET_PED_ENVEFF_SCALE"
hash "0x9C14D30395A51A3C"
jhash (0xA3421E39)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "float"
doc [[!
]]
native "GET_PED_EXTRACTED_DISPLACEMENT"
hash "0xE0AF41401ADF87E3"
jhash (0x5231F901)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "worldSpace" [=[ {} ]=],
}
ns "PED"
returns "Vector3"
doc [[!
```
Gets the offset the specified ped has moved since the previous tick.
If worldSpace is false, the returned offset is relative to the ped. That is, if the ped has moved 1 meter right and 5 meters forward, it'll return 1,5,0.
If worldSpace is true, the returned offset is relative to the world. That is, if the ped has moved 1 meter on the X axis and 5 meters on the Y axis, it'll return 1,5,0.
```
]]
native "GET_PED_GROUP_INDEX"
hash "0xF162E133B4E7A675"
jhash (0x134E0785)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "int"
doc [[!
```
Returns the group id of which the specified ped is a member of.
```
]]
native "GET_PED_HEAD_BLEND_DATA"
hash "0x2746BD9D88C5C5D0"
jhash (0x44E1680C)
arguments {
Ped "ped" [=[ {} ]=],
AnyPtr "headBlendData" [=[ {} ]=],
}
alias "_GET_PED_HEAD_BLEND_DATA"
ns "PED"
returns "BOOL"
doc [[!
```
The pointer is to a padded struct that matches the arguments to SET_PED_HEAD_BLEND_DATA(...). There are 4 bytes of padding after each field.
pass this struct in the second parameter
typedef struct
{
int shapeFirst, shapeSecond, shapeThird;
int skinFirst, skinSecond, skinThird;
float shapeMix, skinMix, thirdMix;
} headBlendData;
```
]]
native "GET_PED_HEAD_BLEND_FIRST_INDEX"
hash "0x68D353AB88B97E0C"
jhash (0x211DEFEC)
arguments {
int "type" [=[ {} ]=],
}
alias "_GET_FIRST_PARENT_ID_FOR_PED_TYPE"
ns "PED"
returns "int"
doc [[!
```
Type equals 0 for male non-dlc, 1 for female non-dlc, 2 for male dlc, and 3 for female dlc.
Used when calling SET_PED_HEAD_BLEND_DATA.
```
]]
native "GET_PED_HEAD_BLEND_NUM_HEADS"
hash "0x5EF37013A6539C9D"
jhash (0x095D3BD8)
arguments {
int "type" [=[ {} ]=],
}
alias "_GET_NUM_PARENT_PEDS_OF_TYPE"
ns "PED"
returns "int"
doc [[!
```
Type equals 0 for male non-dlc, 1 for female non-dlc, 2 for male dlc, and 3 for female dlc.
```
]]
native "GET_PED_HEAD_OVERLAY_NUM"
hash "0xCF1CE768BB43480E"
jhash (0xFF43C18D)
arguments {
int "overlayID" [=[ {} ]=],
}
alias "_GET_NUM_HEAD_OVERLAY_VALUES"
ns "PED"
returns "int"
doc [[!
```
Used with freemode (online) characters.
```
]]
native "GET_PED_HELMET_STORED_HAT_PROP_INDEX"
hash "0x451294E859ECC018"
jhash (0x8A3A3116)
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0x451294E859ECC018"
ns "PED"
returns "int"
doc [[!
]]
native "GET_PED_HELMET_STORED_HAT_TEX_INDEX"
hash "0x9D728C1E12BF5518"
jhash (0x74EB662D)
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0x9D728C1E12BF5518"
ns "PED"
returns "int"
doc [[!
]]
native "GET_PED_LAST_DAMAGE_BONE"
hash "0xD75960F6BD9EA49C"
jhash (0xAB933841)
arguments {
Ped "ped" [=[ {} ]=],
intPtr "outBone" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "GET_PED_MAX_HEALTH"
hash "0x4700A416E8324EF3"
jhash (0xA45B6C8D)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "int"
doc [[!
]]
native "GET_PED_MONEY"
hash "0x3F69145BBA87BAE7"
jhash (0xEB3C4C7E)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "int"
doc [[!
]]
native "GET_PED_NEARBY_PEDS"
hash "0x23F8F5FC7E8C4A6B"
jhash (0x4D3325F4)
arguments {
Ped "ped" [=[ {} ]=],
intPtr "sizeAndPeds" [=[ {} ]=],
int "ignore" [=[ {} ]=],
}
ns "PED"
returns "int"
doc [[!
Console/PC structure definitions and example: pastebin.com/SsFej963
For FiveM/Cfx.Re use-cases refer to: [`GET_GAME_POOL`](#\_0x2B9D4F50).
Ped type to ignore
]]
native "GET_PED_NEARBY_VEHICLES"
hash "0xCFF869CBFA210D82"
jhash (0xCB716F68)
arguments {
Ped "ped" [=[ {} ]=],
intPtr "sizeAndVehs" [=[ {} ]=],
}
ns "PED"
returns "int"
doc [[!
```
Returns size of array, passed into the second variable.
See below for usage information.
This function actually requires a struct, where the first value is the maximum number of elements to return. Here is a sample of how I was able to get it to work correctly, without yet knowing the struct format.
//Setup the array
const int numElements = 10;
const int arrSize = numElements * 2 + 2;
Any veh[arrSize];
//0 index is the size of the array
veh[0] = numElements;
int count = PED::GET_PED_NEARBY_VEHICLES(PLAYER::PLAYER_PED_ID(), veh);
if (veh != NULL)
{
//Simple loop to go through results
for (int i = 0; i < count; i++)
{
int offsettedID = i * 2 + 2;
//Make sure it exists
if (veh[offsettedID] != NULL && ENTITY::DOES_ENTITY_EXIST(veh[offsettedID]))
{
//Do something
}
}
}
Here's the right way to do it (console and pc):
pastebin.com/SsFej963
```
]]
native "GET_PED_PALETTE_VARIATION"
hash "0xE3DD5F2A84B42281"
jhash (0xEF1BC082)
arguments {
Ped "ped" [=[ {} ]=],
int "componentId" [=[ {} ]=],
}
ns "PED"
returns "int"
doc [[!
The ped handle.
The component id to get the palette variation from. Refer to [SET_PED_COMPONENT_VARIATION](#\_0x262B14F48D29DE80).
]]
native "GET_PED_PARACHUTE_LANDING_TYPE"
hash "0x8B9F1FC6AE8166C0"
jhash (0x01F3B035)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "int"
doc [[!
```
-1: no landing
0: landing on both feet
1: stumbling
2: rolling
3: ragdoll
```
]]
native "GET_PED_PARACHUTE_STATE"
hash "0x79CFD9827CC979B6"
jhash (0x7D4BC475)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "int"
doc [[!
```
Returns:
-1: Normal
0: Wearing parachute on back
1: Parachute opening
2: Parachute open
3: Falling to doom (e.g. after exiting parachute)
Normal means no parachute?
```
]]
native "GET_PED_PARACHUTE_TINT_INDEX"
hash "0xEAF5F7E5AE7C6C9D"
jhash (0xE9E7FAC5)
arguments {
Ped "ped" [=[ {} ]=],
intPtr "outTintIndex" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "GET_PED_PROP_INDEX"
hash "0x898CC20EA75BACD8"
jhash (0x746DDAC0)
arguments {
Ped "ped" [=[ {} ]=],
int "componentId" [=[ {} ]=],
}
ns "PED"
returns "int"
doc [[!
The ped handle.
The component id to get the prop index from. Refer to [SET_PED_COMPONENT_VARIATION](#\_0x262B14F48D29DE80).
]]
native "GET_PED_PROP_TEXTURE_INDEX"
hash "0xE131A28626F81AB2"
jhash (0x922A6653)
arguments {
Ped "ped" [=[ {} ]=],
int "componentId" [=[ {} ]=],
}
ns "PED"
returns "int"
doc [[!
The ped handle.
The component id to get the prop texture index from. Refer to [SET_PED_COMPONENT_VARIATION](#\_0x262B14F48D29DE80).
]]
native "GET_PED_RAGDOLL_BONE_INDEX"
hash "0x2057EF813397A772"
jhash (0x849F0716)
arguments {
Ped "ped" [=[ {} ]=],
int "bone" [=[ {} ]=],
}
ns "PED"
returns "int"
doc [[!
]]
native "GET_PED_RELATIONSHIP_GROUP_DEFAULT_HASH"
hash "0x42FDD0F017B1E38E"
jhash (0x714BD6E4)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "Hash"
doc [[!
]]
native "GET_PED_RELATIONSHIP_GROUP_HASH"
hash "0x7DBDD04862D95F04"
jhash (0x354F283C)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "Hash"
doc [[!
]]
native "GET_PED_RESET_FLAG"
hash "0xAF9E59B1B1FBF2A0"
jhash (0x2FC10D11)
arguments {
Ped "ped" [=[ {} ]=],
int "flagId" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "GET_PED_SOURCE_OF_DEATH"
hash "0x93C8B64DEB84728C"
jhash (0x84ADF9EB)
arguments {
Ped "ped" [=[ {} ]=],
}
alias "_GET_PED_KILLER"
ns "PED"
returns "Entity"
doc [[!
```
Returns the Entity (Ped, Vehicle, or ?Object?) that killed the 'ped'
Is best to check if the Ped is dead before asking for its killer.
```
]]
native "GET_PED_STEALTH_MOVEMENT"
hash "0x7C2AC9CA66575FBF"
jhash (0x40321B83)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
```
Returns whether the entity is in stealth mode
```
]]
native "GET_PED_TEXTURE_VARIATION"
hash "0x04A355E041E004E6"
jhash (0xC0A8590A)
arguments {
Ped "ped" [=[ {} ]=],
int "componentId" [=[ {} ]=],
}
ns "PED"
returns "int"
doc [[!
The ped handle.
The component id to get the texture variation from. Refer to [SET_PED_COMPONENT_VARIATION](#\_0x262B14F48D29DE80).
]]
native "GET_PED_TIME_OF_DEATH"
hash "0x1E98817B311AE98A"
jhash (0xDF6D5D54)
arguments {
Ped "ped" [=[ {} ]=],
}
alias "_GET_PED_TIME_OF_DEATH"
alias "0x1E98817B311AE98A"
ns "PED"
returns "int"
doc [[!
]]
native "GET_PED_TYPE"
hash "0xFF059E1E4C01E63C"
jhash (0xB1460D43)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "int"
doc [[!
Ped types:
```cpp
enum ePedType
{
PED_TYPE_PLAYER_0 = 0,
PED_TYPE_PLAYER_1 = 1,
PED_TYPE_NETWORK_PLAYER = 2,
PED_TYPE_PLAYER_2 = 3,
PED_TYPE_CIVMALE = 4,
PED_TYPE_CIVFEMALE = 5,
PED_TYPE_COP = 6,
PED_TYPE_GANG_ALBANIAN = 7,
PED_TYPE_GANG_BIKER_1 = 8,
PED_TYPE_GANG_BIKER_2 = 9,
PED_TYPE_GANG_ITALIAN = 10,
PED_TYPE_GANG_RUSSIAN = 11,
PED_TYPE_GANG_RUSSIAN_2 = 12,
PED_TYPE_GANG_IRISH = 13,
PED_TYPE_GANG_JAMAICAN = 14,
PED_TYPE_GANG_AFRICAN_AMERICAN = 15,
PED_TYPE_GANG_KOREAN = 16,
PED_TYPE_GANG_CHINESE_JAPANESE = 17,
PED_TYPE_GANG_PUERTO_RICAN = 18,
PED_TYPE_DEALER = 19,
PED_TYPE_MEDIC = 20,
PED_TYPE_FIREMAN = 21,
PED_TYPE_CRIMINAL = 22,
PED_TYPE_BUM = 23,
PED_TYPE_PROSTITUTE = 24,
PED_TYPE_SPECIAL = 25,
PED_TYPE_MISSION = 26,
PED_TYPE_SWAT = 27,
PED_TYPE_ANIMAL = 28,
PED_TYPE_ARMY = 29
};
```
]]
native "GET_PEDHEADSHOT_TXD_STRING"
hash "0xDB4EACD4AD0A5D6B"
jhash (0x76D28E96)
arguments {
int "id" [=[ {} ]=],
}
ns "PED"
returns "charPtr"
doc [[!
```
gtaforums.com/topic/885580-ped-headshotmugshot-txd/
```
]]
native "GET_PEDS_JACKER"
hash "0x9B128DC36C1E04CF"
jhash (0xDE1DBB59)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "Ped"
doc [[!
]]
native "GET_PLAYER_PED_IS_FOLLOWING"
hash "0x6A3975DEA89F9A17"
jhash (0xDE7442EE)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "Player"
doc [[!
]]
native "GET_RANDOM_PED_AT_COORD"
hash "0x876046A8E3A4B71C"
jhash (0xDC8239EB)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "xRadius" [=[ {} ]=],
float "yRadius" [=[ {} ]=],
float "zRadius" [=[ {} ]=],
int "pedType" [=[ {} ]=],
}
ns "PED"
returns "Ped"
doc [[!
```
Gets a random ped in the x/y/zRadius near the x/y/z coordinates passed.
Ped Types:
Any = -1
Player = 1
Male = 4
Female = 5
Cop = 6
Human = 26
SWAT = 27
Animal = 28
Army = 29
```
]]
native "GET_RELATIONSHIP_BETWEEN_GROUPS"
hash "0x9E6B70061662AE5C"
jhash (0x4E372FE2)
arguments {
Hash "group1" [=[ {} ]=],
Hash "group2" [=[ {} ]=],
}
ns "PED"
returns "int"
doc [[!
```
Gets the relationship between two groups. This should be called twice (once for each group).
Relationship types:
0 = Companion
1 = Respect
2 = Like
3 = Neutral
4 = Dislike
5 = Hate
255 = Pedestrians
Example:
PED::GET_RELATIONSHIP_BETWEEN_GROUPS(l_1017, 0xA49E591C);
PED::GET_RELATIONSHIP_BETWEEN_GROUPS(0xA49E591C, l_1017);
```
]]
native "GET_RELATIONSHIP_BETWEEN_PEDS"
hash "0xEBA5AD3A0EAF7121"
jhash (0xE254C39C)
arguments {
Ped "ped1" [=[ {} ]=],
Ped "ped2" [=[ {} ]=],
}
ns "PED"
returns "int"
doc [[!
```
Gets the relationship between two peds. This should be called twice (once for each ped).
Relationship types:
0 = Companion
1 = Respect
2 = Like
3 = Neutral
4 = Dislike
5 = Hate
255 = Pedestrians
(Credits: Inco)
Example:
PED::GET_RELATIONSHIP_BETWEEN_PEDS(2, l_1017, 0xA49E591C);
PED::GET_RELATIONSHIP_BETWEEN_PEDS(2, 0xA49E591C, l_1017);
```
]]
native "GET_SEAT_PED_IS_TRYING_TO_ENTER"
hash "0x6F4C85ACD641BCD2"
jhash (0xACF162E0)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "int"
doc [[!
]]
native "GET_SYNCHRONIZED_SCENE_PHASE"
hash "0xE4A310B1D7FA73CC"
jhash (0xB0B2C852)
arguments {
int "sceneID" [=[ {} ]=],
}
ns "PED"
returns "float"
doc [[!
]]
native "GET_SYNCHRONIZED_SCENE_RATE"
hash "0xD80932D577274D40"
jhash (0x89365F0D)
arguments {
int "sceneID" [=[ {} ]=],
}
ns "PED"
returns "float"
doc [[!
]]
native "GET_VEHICLE_PED_IS_ENTERING"
hash "0xF92691AED837A5FC"
jhash (0x56E0C163)
arguments {
Ped "ped" [=[ {} ]=],
}
alias "SET_EXCLUSIVE_PHONE_RELATIONSHIPS"
ns "PED"
returns "Vehicle"
doc [[!
]]
native "GET_VEHICLE_PED_IS_IN"
hash "0x9A9112A0FE9A4713"
jhash (0xAFE92319)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "lastVehicle" [=[ {} ]=],
}
ns "PED"
returns "Vehicle"
doc [[!
Retrieves the vehicle the specified ped is currently in, or the last vehicle they were in.
The target ped
A boolean value where `false` represents the current vehicle the Ped is in, and `true` represents the last vehicle the Ped was in.
The vehicle id. Returns 0 if the ped is/was not in a vehicle.
]]
native "GET_VEHICLE_PED_IS_TRYING_TO_ENTER"
hash "0x814FA8BE5449445D"
jhash (0x99968B37)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "Vehicle"
doc [[!
]]
native "GET_VEHICLE_PED_IS_USING"
hash "0x6094AD011A2EA87D"
jhash (0x6DE3AADA)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "Vehicle"
doc [[!
```
Gets ID of vehicle player using. It means it can get ID at any interaction with vehicle. Enter\exit for example. And that means it is faster than GET_VEHICLE_PED_IS_IN but less safe.
```
]]
native "GIVE_PED_HELMET"
hash "0x54C7C4A94367717E"
jhash (0x1862A461)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "cannotRemove" [=[ {} ]=],
int "helmetFlag" [=[ {} ]=],
int "textureIndex" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
Gives the ped a helmet. Can be removed by invoking [`REMOVE_PED_HELMET`](#\_0xA7B2458D0AD6DED8).
```cpp
enum ePedCompFlags {
PV_FLAG_NONE = 0, // 0
PV_FLAG_BULKY = 1, // 1<<0
PV_FLAG_JOB = 2, // 1<<1
PV_FLAG_SUNNY = 4, // 1<<2
PV_FLAG_WET = 8, // 1<<3
PV_FLAG_COLD = 16, // 1<<4
PV_FLAG_NOT_IN_CAR = 32, // 1<<5
PV_FLAG_BIKE_ONLY = 64, // 1<<6
PV_FLAG_NOT_INDOORS = 128, // 1<<7
PV_FLAG_FIRE_RETARDENT = 256, // 1<<8
PV_FLAG_ARMOURED = 512, // 1<<9
PV_FLAG_LIGHTLY_ARMOURED = 1024, // 1<<10
PV_FLAG_HIGH_DETAIL = 2048, // 1<<11
PV_FLAG_DEFAULT_HELMET = 4096, // 1<<12
PV_FLAG_RANDOM_HELMET = 8192, // 1<<13
PV_FLAG_SCRIPT_HELMET = 16384, // 1<<14
PV_FLAG_FLIGHT_HELMET = 32768, // 1<<15
PV_FLAG_HIDE_IN_FIRST_PERSON = 65536, // 1<<16
PV_FLAG_USE_PHYSICS_HAT_2 = 131072, // 1<<17
PV_FLAG_PILOT_HELMET = 262144 // 1<<18
};
```
Ped index.
Can remove helmet or not.
Flag for the helmet, the helmet appearance depends on the ped it's being applied on.
Texture index; any value other than `-1` will overwrite the default texture index. The helmet texture index needs to be valid for it to be applied.
]]
native "GIVE_PED_NM_MESSAGE"
hash "0xB158DFCCC56E5C5B"
jhash (0x737C3689)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
Sends the message that was created by a call to CREATE_NM_MESSAGE to the specified Ped.
If a message hasn't been created already, this function does nothing.
If the Ped is not ragdolled with Euphoria enabled, this function does nothing.
The following call can be used to ragdoll the Ped with Euphoria enabled: SET_PED_TO_RAGDOLL(ped, 4000, 5000, 1, 1, 1, 0);
Call order:
SET_PED_TO_RAGDOLL
CREATE_NM_MESSAGE
GIVE_PED_NM_MESSAGE
Multiple messages can be chained. Eg. to make the ped stagger and swing his arms around, the following calls can be made:
SET_PED_TO_RAGDOLL(ped, 4000, 5000, 1, 1, 1, 0);
CREATE_NM_MESSAGE(true, 0); // stopAllBehaviours - Stop all other behaviours, in case the Ped is already doing some Euphoria stuff.
GIVE_PED_NM_MESSAGE(ped); // Dispatch message to Ped.
CREATE_NM_MESSAGE(true, 1151); // staggerFall - Attempt to walk while falling.
GIVE_PED_NM_MESSAGE(ped); // Dispatch message to Ped.
CREATE_NM_MESSAGE(true, 372); // armsWindmill - Swing arms around.
GIVE_PED_NM_MESSAGE(ped); // Dispatch message to Ped.
```
]]
native "HAS_ACTION_MODE_ASSET_LOADED"
hash "0xE4B5F4BF2CB24E65"
jhash (0xF7EB2BF1)
arguments {
charPtr "asset" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "HAS_PED_HEAD_BLEND_FINISHED"
hash "0x654CD0A825161131"
jhash (0x2B1BD9C5)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "HAS_PED_PRELOAD_PROP_DATA_FINISHED"
hash "0x784002A632822099"
jhash (0x3B0CA391)
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0x784002A632822099"
ns "PED"
returns "BOOL"
doc [[!
]]
native "HAS_PED_PRELOAD_VARIATION_DATA_FINISHED"
hash "0x66680A92700F43DF"
jhash (0xC6517D52)
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0x66680A92700F43DF"
ns "PED"
returns "BOOL"
doc [[!
]]
native "HAS_PED_RECEIVED_EVENT"
hash "0x8507BCB710FA6DC0"
jhash (0xECD73DB0)
arguments {
Ped "ped" [=[ {} ]=],
int "eventId" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "HAS_PEDHEADSHOT_IMG_UPLOAD_FAILED"
hash "0x876928DDDFCCC9CD"
jhash (0x05023F8F)
alias "0x876928DDDFCCC9CD"
ns "PED"
annotations [=[ {"cs_type":"Any"} ]=]
returns "BOOL"
doc [[!
]]
native "HAS_PEDHEADSHOT_IMG_UPLOAD_SUCCEEDED"
hash "0xE8A169E666CBC541"
jhash (0xAA39FD6C)
alias "0xE8A169E666CBC541"
ns "PED"
annotations [=[ {"cs_type":"Any"} ]=]
returns "BOOL"
doc [[!
]]
native "HAS_STEALTH_MODE_ASSET_LOADED"
hash "0xE977FC5B08AF3441"
jhash (0x39245667)
arguments {
charPtr "asset" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "HAVE_ALL_STREAMING_REQUESTS_COMPLETED"
hash "0x7350823473013C02"
jhash (0xF9FB4B71)
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0x7350823473013C02"
alias "_HAS_STREAMED_PED_ASSETS_LOADED"
ns "PED"
returns "BOOL"
doc [[!
]]
native "HIDE_PED_BLOOD_DAMAGE_BY_ZONE"
hash "0x62AB793144DE75DC"
jhash (0x0CB6C4ED)
arguments {
Ped "ped" [=[ {} ]=],
Any "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
alias "0x62AB793144DE75DC"
ns "PED"
returns "void"
doc [[!
]]
native "INSTANTLY_FILL_PED_POPULATION"
hash "0x4759CC730F947C81"
jhash (0x8C555ADD)
alias "0x4759CC730F947C81"
ns "PED"
returns "void"
doc [[!
]]
native "IS_ANY_HOSTILE_PED_NEAR_POINT"
hash "0x68772DB2B2526F9F"
jhash (0x1A464167)
arguments {
Ped "ped" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "radius" [=[ {} ]=],
}
alias "0x68772DB2B2526F9F"
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_ANY_PED_NEAR_POINT"
hash "0x083961498679DC9F"
jhash (0xFBD9B050)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "radius" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_ANY_PED_SHOOTING_IN_AREA"
hash "0xA0D3D71EA1086C55"
jhash (0x91833867)
arguments {
float "minX" [=[ {} ]=],
float "minY" [=[ {} ]=],
float "minZ" [=[ {} ]=],
float "maxX" [=[ {} ]=],
float "maxY" [=[ {} ]=],
float "maxZ" [=[ {} ]=],
BOOL "bHighlightArea" [=[ {} ]=],
BOOL "bDo3DCheck" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
Verifies whether a ped is firing within a specific area.
Minimum X vector
Minimum Y vector
Minimum Z vector
Maximum X vector
Maximum Y vector
Maximum Z vector
Highlights the area to check when set to `true`.
Conducts a 3D height check when set to `true`.
`true` if a ped is within the defined area, `false` otherwise.
]]
native "IS_CONVERSATION_PED_DEAD"
hash "0xE0A0AEC214B1FABA"
jhash (0x1FA39EFE)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_COP_PED_IN_AREA_3D"
hash "0x16EC4839969F9F5E"
jhash (0xB98DB96B)
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
```
xyz - relative to the world origin.
```
]]
native "IS_PED_A_PLAYER"
hash "0x12534C348C6CB68B"
jhash (0x404794CA)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
```
Returns true if the given ped has a valid pointer to CPlayerInfo in its CPed class. That's all.
```
]]
native "IS_PED_AIMING_FROM_COVER"
hash "0x3998B1276A3300E5"
jhash (0xDEBAB2AF)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_BEING_JACKED"
hash "0x9A497FE2DF198913"
jhash (0xD45D605C)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_BEING_STEALTH_KILLED"
hash "0x863B23EFDE9C5DF2"
jhash (0xD044C8AF)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_BEING_STUNNED"
hash "0x4FBACCE3B4138EE8"
jhash (0x0A66CE30)
arguments {
Ped "ped" [=[ {} ]=],
int "p1" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
```
p1 is always 0
```
]]
native "IS_PED_CLIMBING"
hash "0x53E8CB4F48BFE623"
jhash (0xBCE03D35)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_COMPONENT_VARIATION_VALID"
hash "0xE825F6B6CEA7671D"
jhash (0x952ABD9A)
arguments {
Ped "ped" [=[ {} ]=],
int "componentId" [=[ {} ]=],
int "drawableId" [=[ {} ]=],
int "textureId" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
Checks if the component variation is valid, this works great for randomizing components using loops.
The ped handle.
The component id to check the variation of. Refer to [SET_PED_COMPONENT_VARIATION](#\_0x262B14F48D29DE80).
The drawable id to get the component variation of. Refer to [GET_NUMBER_OF_PED_PROP_DRAWABLE_VARIATIONS](#\_0x5FAF9754E789FB47).
The texture id to get the component variation of. Refer to [GET_NUMBER_OF_PED_PROP_TEXTURE_VARIATIONS](#\_0xA6E7F1CEB523E171).
]]
native "IS_PED_DEAD_OR_DYING"
hash "0x3317DEDB88C95038"
jhash (0xCBDB7739)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "checkMeleeDeathFlags" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
Determines if a ped is dead. Contrary to what the name might suggest, it does not always detect when a ped is in the 'dying' phase (transitioning to death). The exception is when `checkMeleeDeathFlags` is set to `true`, which then includes peds in the midst of melee takedown moves as being in a dying state, even if the death task has not yet started.
```
NativeDB Introduced: v323
```
The ped to check.
If set to `true`, extends the check to include melee takedown moves as part of the dying phase.
Returns `true` if the ped is dead. When `checkMeleeDeathFlags` is set to `true`, it also considers peds in melee takedown moves as dying, although the broader 'dying' phase may not be detected.
]]
native "IS_PED_DEFENSIVE_AREA_ACTIVE"
hash "0xBA63D9FE45412247"
jhash (0x6D88BCD3)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
alias "0xBA63D9FE45412247"
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_DIVING"
hash "0x5527B8246FEF9B11"
jhash (0x7BC5BF3C)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_DOING_DRIVEBY"
hash "0xB2C086CC1BF8F2BF"
jhash (0xAC3CEB9C)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_DUCKING"
hash "0xD125AE748725C6BC"
jhash (0x9199C77D)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_EVASIVE_DIVING"
hash "0x414641C26E105898"
jhash (0xD82829DC)
arguments {
Ped "ped" [=[ {} ]=],
EntityPtr "evadingEntity" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
```
Presumably returns the Entity that the Ped is currently diving out of the way of.
var num3;
if (PED::IS_PED_EVASIVE_DIVING(A_0, &num3) != 0)
if (ENTITY::IS_ENTITY_A_VEHICLE(num3) != 0)
```
]]
native "IS_PED_FACING_PED"
hash "0xD71649DB0A545AA3"
jhash (0x0B775838)
arguments {
Ped "ped" [=[ {} ]=],
Ped "otherPed" [=[ {} ]=],
float "angle" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
```
angle is ped's view cone
```
]]
native "IS_PED_FALLING"
hash "0xFB92A102F1C4DFA3"
jhash (0xABF77334)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_FATALLY_INJURED"
hash "0xD839450756ED5A80"
jhash (0xBADA0093)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
```
Gets a value indicating whether this ped's health is below its fatally injured threshold. The default threshold is 100.
If the handle is invalid, the function returns true.
```
]]
native "IS_PED_FLEEING"
hash "0xBBCCE00B381F8482"
jhash (0x85D813C6)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_GETTING_INTO_A_VEHICLE"
hash "0xBB062B2B5722478E"
jhash (0x90E805AC)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_GOING_INTO_COVER"
hash "0x9F65DBC537E59AD5"
jhash (0xA3589628)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_GROUP_MEMBER"
hash "0x9BB01E3834671191"
jhash (0x876D5363)
arguments {
Ped "ped" [=[ {} ]=],
int "groupId" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_HANGING_ON_TO_VEHICLE"
hash "0x1C86D8AEF8254B78"
jhash (0x9678D4FF)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_HEADING_TOWARDS_POSITION"
hash "0xFCF37A457CB96DC0"
jhash (0x45037B9B)
arguments {
Ped "ped" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "p4" [=[ {} ]=],
}
alias "0xFCF37A457CB96DC0"
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_HEADTRACKING_ENTITY"
hash "0x813A0A7C9D2E831F"
jhash (0x233C9ACF)
arguments {
Ped "ped" [=[ {} ]=],
Entity "entity" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_HEADTRACKING_PED"
hash "0x5CD3CB88A7F8850D"
jhash (0x2A5DF721)
arguments {
Ped "ped1" [=[ {} ]=],
Ped "ped2" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_HUMAN"
hash "0xB980061DA992779D"
jhash (0x194BB7B0)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
```
Returns true/false if the ped is/isn't humanoid.
```
]]
native "IS_PED_HURT"
hash "0x5983BB449D7FDB12"
jhash (0x69DFA0AF)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
```
Returns whether the specified ped is hurt.
```
]]
native "IS_PED_IN_ANY_BOAT"
hash "0x2E0E1C2B4F6CB339"
jhash (0x1118A947)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_IN_ANY_HELI"
hash "0x298B91AE825E5705"
jhash (0x7AB5523B)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_IN_ANY_PLANE"
hash "0x5FFF4CFC74D8FB80"
jhash (0x51BBCE7E)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_IN_ANY_POLICE_VEHICLE"
hash "0x0BD04E29640C9C12"
jhash (0x84FA790D)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_IN_ANY_SUB"
hash "0xFBFC01CCFB35D99E"
jhash (0xE65F8059)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_IN_ANY_TAXI"
hash "0x6E575D6A898AB852"
jhash (0x16FD386C)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_IN_ANY_TRAIN"
hash "0x6F972C1AB75A1ED0"
jhash (0x759EF63A)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_IN_ANY_VEHICLE"
hash "0x997ABD671D25CA0B"
jhash (0x3B0171EE)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "atGetIn" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
Returns whether the specified ped is in any vehicle. If `atGetIn` is set to true, also returns true if the ped is
currently in the process of entering a vehicle (a specific stage check for `CTaskEnterVehicle`).
The ped to check.
`true` to also consider attempting to enter a vehicle.
Whether or not the ped is currently involved in any vehicle.
]]
native "IS_PED_IN_COMBAT"
hash "0x4859F1FC66A6278E"
jhash (0xFE027CB5)
arguments {
Ped "ped" [=[ {} ]=],
Ped "target" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
Examines whether the ped is engaged in combat; when given a target ped index, it confirms if the ped is actively fighting the specified target, returning true if engaged and false if not.
Ped index.
]]
native "IS_PED_IN_COVER"
hash "0x60DFD0691A170B88"
jhash (0x972C5A8B)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "exceptUseWeapon" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
```
p1 is nearly always 0 in the scripts.
```
]]
native "IS_PED_IN_COVER_FACING_LEFT"
hash "0x845333B3150583AB"
jhash (0xB89DBB80)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_IN_FLYING_VEHICLE"
hash "0x9134873537FA419C"
jhash (0xCA072485)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_IN_GROUP"
hash "0x5891CAC5D4ACFF74"
jhash (0x836D9795)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_IN_HIGH_COVER"
hash "0x6A03BF943D767C93"
jhash (0xDD5D08A7)
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0x6A03BF943D767C93"
alias "_IS_PED_STANDING_IN_COVER"
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_IN_MELEE_COMBAT"
hash "0x4E209B2C1EAD5159"
jhash (0xFD7814A5)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
```
Notes: The function only returns true while the ped is:
A.) Swinging a random melee attack (including pistol-whipping)
B.) Reacting to being hit by a melee attack (including pistol-whipping)
C.) Is locked-on to an enemy (arms up, strafing/skipping in the default fighting-stance, ready to dodge+counter).
You don't have to be holding the melee-targetting button to be in this stance; you stay in it by default for a few seconds after swinging at someone. If you do a sprinting punch, it returns true for the duration of the punch animation and then returns false again, even if you've punched and made-angry many peds
```
]]
native "IS_PED_IN_MODEL"
hash "0x796D90EFB19AA332"
jhash (0xA6438D4B)
arguments {
Ped "ped" [=[ {} ]=],
Hash "modelHash" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_IN_PARACHUTE_FREE_FALL"
hash "0x7DCE8BDA0F1C1200"
jhash (0xCD71F11B)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_IN_SPHERE_AREA_OF_ANY_ENEMY_PEDS"
hash "0x082D79E15302F0C2"
arguments {
Ped "ped" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "range" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
```
NativeDB Introduced: v3407
```
The ped to check.
X coordinate
Y coordinate
Z coordinate
Radius of sphere.
Returns `true` if ped is within range of any enemies, `false` otherwise.
]]
native "IS_PED_IN_VEHICLE"
hash "0xA3EE4A07279BB9DB"
jhash (0x7DA6BC83)
arguments {
Ped "ped" [=[ {} ]=],
Vehicle "vehicle" [=[ {} ]=],
BOOL "atGetIn" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
```
Gets a value indicating whether the specified ped is in the specified vehicle.
If 'atGetIn' is false, the function will not return true until the ped is sitting in the vehicle and is about to close the door. If it's true, the function returns true the moment the ped starts to get onto the seat (after opening the door). Eg. if false, and the ped is getting into a submersible, the function will not return true until the ped has descended down into the submersible and gotten into the seat, while if it's true, it'll return true the moment the hatch has been opened and the ped is about to descend into the submersible.
```
]]
native "IS_PED_INJURED"
hash "0x84A2DD9AC37C35C1"
jhash (0x2530A087)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
Indicates whether this ped's health is below its injured threshold.
The default threshold is 100, these are stored in the `pedhealth.meta` file located in `common:\data\`
### Below are some of the values
| InjuredHealthThreshold | Name |
|------------------------|-----------|
| 100.000000 | Strong |
| 100.000000 | Average |
| 100.000000 | Weak |
The ped to check for injuries.
Returns `true` if the ped is injured, `false` otherwise.
]]
native "IS_PED_JACKING"
hash "0x4AE4FF911DFB61DA"
jhash (0x3B321816)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_JUMPING"
hash "0xCEDABC5900A0BF97"
jhash (0x07E5BC0E)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_JUMPING_OUT_OF_VEHICLE"
hash "0x433DDFFE2044B636"
jhash (0xB19215F6)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_MALE"
hash "0x6D9F5FAA7488BA46"
jhash (0x90950455)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
```
Returns true/false if the ped is/isn't male.
```
]]
native "IS_PED_MODEL"
hash "0xC9D55B1A358A5BF7"
jhash (0x5F1DDFCB)
arguments {
Ped "ped" [=[ {} ]=],
Hash "modelHash" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_ON_ANY_BIKE"
hash "0x94495889E22C6479"
jhash (0x4D885B2E)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_ON_FOOT"
hash "0x01FEE67DB37F59B2"
jhash (0xC60D0785)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_ON_MOUNT"
hash "0x460BC76A0E10655E"
jhash (0x43103006)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
```
Same function call as PED::GET_MOUNT, aka just returns 0
```
]]
native "IS_PED_ON_SPECIFIC_VEHICLE"
hash "0xEC5F66E459AF3BB2"
jhash (0x63CB4603)
arguments {
Ped "ped" [=[ {} ]=],
Vehicle "vehicle" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_ON_VEHICLE"
hash "0x67722AEB798E5FAB"
jhash (0xA1AE7CC7)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
```
Gets a value indicating whether the specified ped is on top of any vehicle.
Return 1 when ped is on vehicle.
Return 0 when ped is not on a vehicle.
```
]]
native "IS_PED_PERFORMING_DEPENDENT_COMBO_LIMIT"
hash "0xEBD0EDBA5BE957CF"
jhash (0x9BE7C860)
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0xEBD0EDBA5BE957CF"
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_PERFORMING_MELEE_ACTION"
hash "0xDCCA191DF9980FD7"
jhash (0x139C0875)
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0xDCCA191DF9980FD7"
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_PERFORMING_STEALTH_KILL"
hash "0xFD4CCDBCC59941B7"
jhash (0x9ADD7B21)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_PLANTING_BOMB"
hash "0xC70B5FAE151982D8"
jhash (0x0EDAC574)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_PRONE"
hash "0xD6A86331A537A7B9"
jhash (0x02C2A6C3)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_RAGDOLL"
hash "0x47E4E977581C5B55"
jhash (0xC833BBE1)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
```
If the ped handle passed through the parenthesis is in a ragdoll state this will return true.
```
]]
native "IS_PED_RELOADING"
hash "0x24B100C68C645951"
jhash (0x961E1745)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
```
Returns whether the specified ped is reloading.
```
]]
native "IS_PED_RESPONDING_TO_EVENT"
hash "0x625B774D75C87068"
jhash (0x7A877554)
arguments {
Ped "ped" [=[ {} ]=],
Any "event" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_RUNNING_MELEE_TASK"
hash "0xD1871251F3B5ACD7"
jhash (0xBD4236F6)
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0xD1871251F3B5ACD7"
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_RUNNING_MOBILE_PHONE_TASK"
hash "0x2AFE52F782F25775"
jhash (0xFB2AFED1)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_RUNNING_RAGDOLL_TASK"
hash "0xE3B6097CC25AA69E"
jhash (0x44A153F2)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_SHOOTING"
hash "0x34616828CD07F1A1"
jhash (0xE7C3405E)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
```
Returns whether the specified ped is shooting.
```
]]
native "IS_PED_SHOOTING_IN_AREA"
hash "0x7E9DFE24AC1E58EF"
jhash (0x741BF04F)
arguments {
Ped "ped" [=[ {} ]=],
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
BOOL "p7" [=[ {} ]=],
BOOL "p8" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_SITTING_IN_ANY_VEHICLE"
hash "0x826AA586EDB9FEF8"
jhash (0x0EA9CA03)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
```
Detect if ped is in any vehicle
[True/False]
```
]]
native "IS_PED_SITTING_IN_VEHICLE"
hash "0xA808AA1D79230FC2"
jhash (0xDDDE26FA)
arguments {
Ped "ped" [=[ {} ]=],
Vehicle "vehicle" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
```
Detect if ped is sitting in the specified vehicle
[True/False]
```
]]
native "IS_PED_STOPPED"
hash "0x530944F6F4B8A214"
jhash (0xA0DC0B87)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
```
Returns true if the ped doesn't do any movement. If the ped is being pushed forwards by using APPLY_FORCE_TO_ENTITY for example, the function returns false.
```
]]
native "IS_PED_SWIMMING"
hash "0x9DE327631295B4C2"
jhash (0x7AB43DB8)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_SWIMMING_UNDER_WATER"
hash "0xC024869A53992F34"
jhash (0x0E8D524F)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_TAKING_OFF_HELMET"
hash "0x14590DDBEDB1EC85"
jhash (0xA1008E0E)
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0x14590DDBEDB1EC85"
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_TRACKED"
hash "0x4C5E1F087CD10BB7"
jhash (0x7EB613D9)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_TRYING_TO_ENTER_A_LOCKED_VEHICLE"
hash "0x44D28D5DDFE5F68C"
jhash (0x46828B4E)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
If the ped is attempting to enter a locked vehicle.
Ped index.
]]
native "IS_PED_USING_ACTION_MODE"
hash "0x00E73468D085F745"
jhash (0x5AE7EDA2)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_USING_ANY_SCENARIO"
hash "0x57AB4A3080F85143"
jhash (0x195EF5B7)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
The ped handle.
Returns true if the ped is using any scenario.
]]
native "IS_PED_USING_SCENARIO"
hash "0x1BF094736DD62C2E"
jhash (0x0F65B0D4)
arguments {
Ped "ped" [=[ {} ]=],
charPtr "scenario" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
See [`TASK_START_SCENARIO_IN_PLACE`](#\_0x142A02425FF02BD9) for a list of scenarios.
The ped handle.
The scenario name.
Returns true if the specified ped is using the specified scenario.
]]
native "IS_PED_VAULTING"
hash "0x117C70D1F5730B5E"
jhash (0xC3169BDA)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_PED_WEARING_HELMET"
hash "0xF33BDFE19B309B19"
jhash (0x0D680D49)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
```
Returns true if the ped passed through the parenthesis is wearing a helmet.
```
]]
native "IS_PEDHEADSHOT_IMG_UPLOAD_AVAILABLE"
hash "0xEBB376779A760AA8"
jhash (0x810158F8)
alias "0xEBB376779A760AA8"
ns "PED"
annotations [=[ {"cs_type":"Any"} ]=]
returns "BOOL"
doc [[!
]]
native "IS_PEDHEADSHOT_READY"
hash "0x7085228842B13A67"
jhash (0x761CD02E)
arguments {
int "id" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
```
gtaforums.com/topic/885580-ped-headshotmugshot-txd/
```
]]
native "IS_PEDHEADSHOT_VALID"
hash "0xA0A9668F158129A2"
jhash (0x0B1080C4)
arguments {
int "id" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
```
gtaforums.com/topic/885580-ped-headshotmugshot-txd/
```
]]
native "IS_SCRIPTED_SCENARIO_PED_USING_CONDITIONAL_ANIM"
hash "0x6EC47A344923E1ED"
jhash (0x3C30B447)
arguments {
Ped "ped" [=[ {} ]=],
charPtr "animDict" [=[ {} ]=],
charPtr "anim" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
[Animations list](https://alexguirre.github.io/animations-list/)
]]
native "IS_SYNCHRONIZED_SCENE_HOLD_LAST_FRAME"
hash "0x7F2F4F13AC5257EF"
jhash (0x72CF2514)
arguments {
int "sceneID" [=[ {} ]=],
}
alias "0x7F2F4F13AC5257EF"
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_SYNCHRONIZED_SCENE_LOOPED"
hash "0x62522002E0C391BA"
jhash (0x47D87A84)
arguments {
int "sceneID" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "IS_SYNCHRONIZED_SCENE_RUNNING"
hash "0x25D39B935A038A26"
jhash (0x57A282F1)
arguments {
int "sceneId" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
```
Returns true if a synchronized scene is running
```
]]
native "IS_TRACKED_PED_VISIBLE"
hash "0x91C8E617F64188AC"
jhash (0x33248CC1)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
```
returns whether or not a ped is visible within your FOV, not this check auto's to false after a certain distance.
Target needs to be tracked.. won't work otherwise.
```
]]
native "KNOCK_OFF_PED_PROP"
hash "0x6FD7816A36615F48"
jhash (0x08D8B180)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
BOOL "p4" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "KNOCK_PED_OFF_VEHICLE"
hash "0x45BBCBA77C29A841"
jhash (0xACDD0674)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "PLAY_FACIAL_ANIM"
hash "0xE1E65CA8AC9C00ED"
jhash (0x1F6CCDDE)
arguments {
Ped "ped" [=[ {} ]=],
charPtr "animName" [=[ {} ]=],
charPtr "animDict" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "REGISTER_HATED_TARGETS_AROUND_PED"
hash "0x9222F300BF8354FE"
jhash (0x7F87559E)
arguments {
Ped "ped" [=[ {} ]=],
float "radius" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
Based on TASK_COMBAT_HATED_TARGETS_AROUND_PED, the parameters are likely similar (PedHandle, and area to attack in).
```
]]
native "REGISTER_PEDHEADSHOT"
hash "0x4462658788425076"
jhash (0xFFE2667B)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "int"
doc [[!
```
gtaforums.com/topic/885580-ped-headshotmugshot-txd/
```
The ped you want to take the "headshot" of.
It returns a Pedheadshot handle, which can be used by natives such as [`GET_PEDHEADSHOT_TXD_STRING`](#\_0xDB4EACD4AD0A5D6B)
]]
native "REGISTER_PEDHEADSHOT_TRANSPARENT"
hash "0x953563CE563143AF"
jhash (0x4DD03628)
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0x953563CE563143AF"
ns "PED"
returns "int"
doc [[!
Similar to REGISTER_PEDHEADSHOT but creates a transparent background instead of black.
**Result of the example code:**
A ped handle.
The Pedheadshot handle.
]]
native "REGISTER_TARGET"
hash "0x2F25D9AEFA34FBA2"
jhash (0x50A95442)
arguments {
Ped "ped" [=[ {} ]=],
Ped "target" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
PED::REGISTER_TARGET(l_216, PLAYER::PLAYER_PED_ID()); from re_prisonbreak.txt.
l_216 = RECSBRobber1
```
]]
native "RELEASE_PED_PRELOAD_PROP_DATA"
hash "0xF79F9DEF0AADE61A"
jhash (0xFD103BA7)
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0xF79F9DEF0AADE61A"
ns "PED"
returns "void"
doc [[!
]]
native "RELEASE_PED_PRELOAD_VARIATION_DATA"
hash "0x5AAB586FFEC0FD96"
jhash (0x6435F67F)
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0x5AAB586FFEC0FD96"
ns "PED"
returns "void"
doc [[!
]]
native "RELEASE_PEDHEADSHOT_IMG_UPLOAD"
hash "0x5D517B27CF6ECD04"
jhash (0x0DBB2FA7)
arguments {
int "id" [=[ {} ]=],
}
alias "0x5D517B27CF6ECD04"
ns "PED"
returns "void"
doc [[!
]]
native "REMOVE_ACTION_MODE_ASSET"
hash "0x13E940F88470FA51"
jhash (0x3F480F92)
arguments {
charPtr "asset" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "REMOVE_GROUP"
hash "0x8EB2F69076AF7053"
jhash (0x48D72B88)
arguments {
int "groupId" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "REMOVE_PED_DEFENSIVE_AREA"
hash "0x74D4E028107450A9"
jhash (0x34AAAFA5)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
Ped will no longer get angry when you stay near him.
```
]]
native "REMOVE_PED_ELEGANTLY"
hash "0xAC6D445B994DF95E"
jhash (0x4FFB8C6C)
arguments {
PedPtr "ped" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
Judging purely from a quick disassembly, if the ped is in a vehicle, the ped will be deleted immediately. If not, it'll be marked as no longer needed.
```
]]
native "REMOVE_PED_FROM_GROUP"
hash "0xED74007FFB146BC2"
jhash (0x82697713)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "REMOVE_PED_HELMET"
hash "0xA7B2458D0AD6DED8"
jhash (0x2086B1F0)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "instantly" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
Remove a helmet from a ped
Ped index.
Force to remove.
]]
native "REMOVE_PED_PREFERRED_COVER_SET"
hash "0xFDDB234CF74073D9"
jhash (0xA0134498)
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0xFDDB234CF74073D9"
ns "PED"
returns "void"
doc [[!
]]
native "REMOVE_RELATIONSHIP_GROUP"
hash "0xB6BA2444AB393DA2"
jhash (0x4A1DC59A)
arguments {
Hash "groupHash" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "REMOVE_SCENARIO_BLOCKING_AREA"
hash "0x31D16B74C6E29D66"
jhash (0x4483EF06)
arguments {
int "scenarioBlockingIndex" [=[ {} ]=],
BOOL "bNetwork" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
the index of the Scenario blocking area
Optionally networked to all other players
]]
native "REMOVE_SCENARIO_BLOCKING_AREAS"
hash "0xD37401D78A929A49"
jhash (0x4DDF845F)
ns "PED"
returns "void"
doc [[!
]]
native "REMOVE_STEALTH_MODE_ASSET"
hash "0x9219857D21F0E842"
jhash (0x8C0B243A)
arguments {
charPtr "asset" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "REQUEST_ACTION_MODE_ASSET"
hash "0x290E2780BB7AA598"
jhash (0x572BA553)
arguments {
charPtr "asset" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "REQUEST_PED_VEHICLE_VISIBILITY_TRACKING"
hash "0x2BC338A7B21F4608"
jhash (0x31C31DAA)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
alias "GET_PED_FLOOD_INVINCIBILITY"
ns "PED"
returns "void"
doc [[!
]]
native "REQUEST_PED_VISIBILITY_TRACKING"
hash "0x7D7A2E43E74E2EB8"
jhash (0x840D24D3)
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0x7D7A2E43E74E2EB8"
ns "PED"
returns "void"
doc [[!
]]
native "REQUEST_PEDHEADSHOT_IMG_UPLOAD"
hash "0xF0DAEF2F545BEE25"
jhash (0x10F2C023)
arguments {
int "id" [=[ {} ]=],
}
alias "0xF0DAEF2F545BEE25"
ns "PED"
returns "BOOL"
doc [[!
]]
native "REQUEST_STEALTH_MODE_ASSET"
hash "0x2A0A62FCDEE16D4F"
jhash (0x280A004A)
arguments {
charPtr "asset" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "RESET_AI_MELEE_WEAPON_DAMAGE_MODIFIER"
hash "0x46E56A7CD1D63C3F"
jhash (0x97886238)
ns "PED"
returns "void"
doc [[!
]]
native "RESET_AI_WEAPON_DAMAGE_MODIFIER"
hash "0xEA16670E7BA4743C"
jhash (0x6E965420)
ns "PED"
returns "void"
doc [[!
]]
native "RESET_GROUP_FORMATION_DEFAULT_SPACING"
hash "0x63DAB4CCB3273205"
jhash (0x267FCEAD)
arguments {
int "groupHandle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "RESET_PED_IN_VEHICLE_CONTEXT"
hash "0x22EF8FF8778030EB"
jhash (0x3C94D88A)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "RESET_PED_LAST_VEHICLE"
hash "0xBB8DE8CF6A8DD8BB"
jhash (0x5E3B5942)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
Resets the value for the last vehicle driven by the Ped.
```
]]
native "RESET_PED_MOVEMENT_CLIPSET"
hash "0xAA74EC0CB0AAEA2C"
jhash (0xB83CEE93)
arguments {
Ped "ped" [=[ {} ]=],
float "transitionSpeed" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "RESET_PED_RAGDOLL_TIMER"
hash "0x9FA4664CF62E47E8"
jhash (0xF2865370)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "RESET_PED_STRAFE_CLIPSET"
hash "0x20510814175EA477"
jhash (0xF1967A12)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "RESET_PED_VISIBLE_DAMAGE"
hash "0x3AC1F7B898F30C05"
jhash (0xC4BC4841)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
annotations [=[ {"cs_type":"Any"} ]=]
returns "void"
doc [[!
]]
native "RESET_PED_WEAPON_MOVEMENT_CLIPSET"
hash "0x97B0DB5B4AA74E77"
jhash (0xC60C9ACD)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "RESURRECT_PED"
hash "0x71BC8E838B9C6035"
jhash (0xA4B82097)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
This function will simply bring the dead person back to life.
Try not to use it alone, since using this function alone, will make peds fall through ground in hell(well for the most of the times).
Instead, before calling this function, you may want to declare the position, where your Resurrected ped to be spawn at.(For instance, Around 2 floats of Player's current position.)
Also, disabling any assigned task immediately helped in the number of scenarios, where If you want peds to perform certain decided tasks.
```
]]
native "REVIVE_INJURED_PED"
hash "0x8D8ACD8388CD99CE"
jhash (0x14D3E6E3)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
It will revive/cure the injured ped. The condition is ped must not be dead.
Upon setting and converting the health int, found, if health falls below 5, the ped will lay on the ground in pain(Maximum default health is 100).
This function is well suited there.
```
]]
native "SET_AI_MELEE_WEAPON_DAMAGE_MODIFIER"
hash "0x66460DEDDD417254"
jhash (0x0F9A401F)
arguments {
float "modifier" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_AI_WEAPON_DAMAGE_MODIFIER"
hash "0x1B1E2A40A65B8521"
jhash (0x516E30EE)
arguments {
float "value" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_AMBIENT_PEDS_DROP_MONEY"
hash "0x6B0E6172C9A4D902"
jhash (0x30B98369)
arguments {
BOOL "p0" [=[ {} ]=],
}
alias "0x6B0E6172C9A4D902"
ns "PED"
returns "void"
doc [[!
]]
native "SET_BLOCKING_OF_NON_TEMPORARY_EVENTS"
hash "0x9F8AA94D6D97DBF4"
jhash (0xDFE34E4A)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
works with TASK::TASK_SET_BLOCKING_OF_NON_TEMPORARY_EVENTS to make a ped completely oblivious to all events going on around him
```
]]
native "SET_CAN_ATTACK_FRIENDLY"
hash "0xB3B1CB349FF9C75D"
jhash (0x47C60963)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
Setting ped to true allows the ped to shoot "friendlies".
p2 set to true when toggle is also true seams to make peds permanently unable to aim at, even if you set p2 back to false.
p1 = false & p2 = false for unable to aim at.
p1 = true & p2 = false for able to aim at.
```
]]
native "SET_COMBAT_FLOAT"
hash "0xFF41B4B141ED981C"
jhash (0xD8B7637C)
arguments {
Ped "ped" [=[ {} ]=],
int "combatType" [=[ {} ]=],
float "p2" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
A value between 0-14, See [`GET_COMBAT_FLOAT`](#\_0x52DFF8A10508090A) for a list of possible parameters.
]]
native "SET_CREATE_RANDOM_COPS"
hash "0x102E68B2024D536D"
jhash (0x23441648)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_CREATE_RANDOM_COPS_NOT_ON_SCENARIOS"
hash "0x8A4986851C4EF6E7"
jhash (0x82E548CC)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_CREATE_RANDOM_COPS_ON_SCENARIOS"
hash "0x444CB7D7DBE6973D"
jhash (0xEDC31475)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_DRIVER_ABILITY"
hash "0xB195FFA8042FC5C3"
jhash (0xAAD4012C)
arguments {
Ped "driver" [=[ {} ]=],
float "ability" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
The function specifically verifies the value is equal to, or less than 1.0f. If it is greater than 1.0f, the function does nothing at all.
```
]]
native "SET_DRIVER_AGGRESSIVENESS"
hash "0xA731F608CA104E3C"
jhash (0x8B02A8FB)
arguments {
Ped "driver" [=[ {} ]=],
float "aggressiveness" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
range 0.0f - 1.0f
```
]]
native "SET_DRIVER_RACING_MODIFIER"
hash "0xDED5AF5A0EA4B297"
jhash (0x6D55B3B3)
arguments {
Ped "driver" [=[ {} ]=],
float "modifier" [=[ {} ]=],
}
alias "0xDED5AF5A0EA4B297"
ns "PED"
returns "void"
doc [[!
```
Scripts use 0.2, 0.5 and 1.0. Value must be >= 0.0 && <= 1.0
```
]]
native "SET_ENABLE_BOUND_ANKLES"
hash "0xC52E0F855C58FC2E"
jhash (0x9208D689)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
Used with [SET_ENABLE_HANDCUFFS](#\_0xDF1AF8B5D56542FA) in decompiled scripts. From my observations, I have noticed that while being ragdolled you are not able to get up but you can still run. Your legs can also bend.
]]
native "SET_ENABLE_HANDCUFFS"
hash "0xDF1AF8B5D56542FA"
jhash (0xAC9BBA23)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
Sets the IsHandCuffed (120) config flag on the ped. This blocks the ped from switching weapons (with the exception of switching to `weapon_unarmed`), makes the ped ragdoll on getting punched and forces a different get-up animation after ragdolling. The ped can also not vault over or climb on top of objects.
Used in combination with [SET_ENABLE_BOUND_ANKLES](#\_0xC52E0F855C58FC2E) in decompiled scripts.
The ped to toggle handcuffs on
true to enable handcuffs, false to disable
]]
native "SET_ENABLE_PED_ENVEFF_SCALE"
hash "0xD2C5AA0C0E8D0F1E"
jhash (0xC70F4A84)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_ENABLE_SCUBA"
hash "0xF99F62004024D506"
jhash (0x7BF61471)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
Enables diving motion when underwater.
```
]]
native "SET_FACIAL_IDLE_ANIM_OVERRIDE"
hash "0xFFC24B988B938B38"
jhash (0x9BA19C13)
arguments {
Ped "ped" [=[ {} ]=],
charPtr "animName" [=[ {} ]=],
charPtr "animDict" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_FORCE_FOOTSTEP_UPDATE"
hash "0x129466ED55140F8D"
jhash (0x37DBC2AD)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x129466ED55140F8D"
ns "PED"
returns "void"
doc [[!
]]
native "SET_FORCE_STEP_TYPE"
hash "0xCB968B53FC7F916D"
jhash (0xC0F1BC91)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
int "type" [=[ {} ]=],
int "p3" [=[ {} ]=],
}
alias "0xCB968B53FC7F916D"
ns "PED"
returns "void"
doc [[!
]]
native "SET_GROUP_FORMATION"
hash "0xCE2F5FC3AF7E8C1E"
jhash (0x08FAC739)
arguments {
int "groupId" [=[ {} ]=],
int "formationType" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
0: Freedom to move
1: Circle Around Leader
2: Alternative Circle Around Leader
3: Line, with Leader at center
4: Arrow Formation
5: "V" Formation
6: Line Follow Formation
7: Single Formation
8: Pairwise
```
]]
native "SET_GROUP_FORMATION_SPACING"
hash "0x1D9D45004C28C916"
jhash (0xB1E086FF)
arguments {
int "groupId" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_GROUP_SEPARATION_RANGE"
hash "0x4102C7858CFEE4E4"
jhash (0x7B820CD5)
arguments {
int "groupHandle" [=[ {} ]=],
float "separationRange" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
Sets the range at which members will automatically leave the group.
```
]]
native "SET_HEAD_BLEND_PALETTE_COLOR"
hash "0xCC9682B8951C5229"
jhash (0x57E5B3F9)
arguments {
Ped "ped" [=[ {} ]=],
int "r" [=[ {} ]=],
int "g" [=[ {} ]=],
int "b" [=[ {} ]=],
int "id" [=[ {} ]=],
}
alias "0xCC9682B8951C5229"
ns "PED"
returns "void"
doc [[!
Preview: https://gfycat.com/MaleRareAmazonparrot
From 0 to 3.
]]
native "SET_IK_TARGET"
hash "0xC32779C16FCEECD9"
jhash (0x6FE5218C)
arguments {
Ped "ped" [=[ {} ]=],
int "ikIndex" [=[ {} ]=],
Entity "entityLookAt" [=[ {} ]=],
int "boneLookAt" [=[ {} ]=],
float "offsetX" [=[ {} ]=],
float "offsetY" [=[ {} ]=],
float "offsetZ" [=[ {} ]=],
int "ikTargetFlags" [=[ {} ]=],
int "blendInDuration" [=[ {} ]=],
int "blendOutDuration" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
Sets the IK target for a given IK part belonging to the ped.
**Please note:** The IK target will only be valid for one update, so it needs to be set for as long as it is needed (to avoid IK targets not being cleared and getting stuck enabled).
```cpp
enum eIkPart {
IK_PART_INVALID = 0,
// head
IK_PART_HEAD = 1,
// spine
IK_PART_SPINE = 2,
// Left Arm
IK_PART_ARM_LEFT = 3,
// Right Arm
IK_PART_ARM_RIGHT = 4,
// Left Leg
IK_PART_LEG_LEFT = 5,
// Right Leg
IK_PART_LEG_RIGHT = 6
};
```
```cpp
enum eIkTargetFlags {
ITF_DEFAULT = 0,
// arm target relative to the handbone
ITF_ARM_TARGET_WRT_HANDBON = 1,
// arm target relative to the pointhelper
ITF_ARM_TARGET_WRT_POINTHELPER = 2,
// arm target relative to the ikhelper
ITF_ARM_TARGET_WRT_IKHELPE = 4,
// use animation tags directly
ITF_IK_TAG_MODE_NORMAL = 8,
// use animation tags in ALLOW mode
ITF_IK_TAG_MODE_ALLOW = 16,
// use animation tags in BLOCK mode
ITF_IK_TAG_MODE_BLOCK = 32,
// solve for orientation in addition to position
ITF_ARM_USE_ORIENTATION = 64
};
```
```
NativeDB Introduced: v323
```
The ped handle.
See `eIkPart` for indexes.
Set to 0 for no entity, offsets will be world coordinates instead.
Set to -1 for no target bone.
X-axis offset calculated from the position of `entityLookAt`.
Y-axis offset calculated from the position of `entityLookAt`.
Z-axis offset calculated from the position of `entityLookAt`.
See `eIkTargetFlags` for flags.
Animation blending in (in ms). `-1` by default.
Animation blending out (in ms). `-1` by default.
]]
native "SET_MOVEMENT_MODE_OVERRIDE"
hash "0x781DE8FA214E87D2"
jhash (0x83BAE814)
arguments {
Ped "ped" [=[ {} ]=],
charPtr "name" [=[ {} ]=],
}
alias "0x781DE8FA214E87D2"
ns "PED"
returns "void"
doc [[!
```
name: "MP_FEMALE_ACTION" found multiple times in the b617d scripts.
```
]]
native "SET_PED_ACCURACY"
hash "0x7AEFB85C1D49DEB6"
jhash (0x6C17122E)
arguments {
Ped "ped" [=[ {} ]=],
int "accuracy" [=[ {} ]=],
}
ns "PED"
annotations [=[ {"cs_type":"Any"} ]=]
returns "void"
doc [[!
```
accuracy = 0-100, 100 being perfectly accurate
```
]]
native "SET_PED_ALERTNESS"
hash "0xDBA71115ED9941A6"
jhash (0x2C32D9AE)
arguments {
Ped "ped" [=[ {} ]=],
int "value" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
value ranges from 0 to 3.
```
]]
native "SET_PED_ALLOW_VEHICLES_OVERRIDE"
hash "0x3C028C636A414ED9"
jhash (0x58A80BD5)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_ALLOWED_TO_DUCK"
hash "0xDA1F1B7BE1A8766F"
jhash (0xC4D122F8)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_ALTERNATE_MOVEMENT_ANIM"
hash "0x90A43CC281FFAB46"
jhash (0xBA84FD8C)
arguments {
Ped "ped" [=[ {} ]=],
int "stance" [=[ {} ]=],
charPtr "animDictionary" [=[ {} ]=],
charPtr "animationName" [=[ {} ]=],
float "p4" [=[ {} ]=],
BOOL "p5" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
stance:
0 = idle
1 = walk
2 = running
p5 = usually set to true
```
[Animations list](https://alexguirre.github.io/animations-list/)
]]
native "SET_PED_ALTERNATE_WALK_ANIM"
hash "0x6C60394CB4F75E9A"
jhash (0x895E1D67)
arguments {
Ped "ped" [=[ {} ]=],
charPtr "animDict" [=[ {} ]=],
charPtr "animName" [=[ {} ]=],
float "p3" [=[ {} ]=],
BOOL "p4" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
[Animations list](https://alexguirre.github.io/animations-list/)
]]
native "SET_PED_ANGLED_DEFENSIVE_AREA"
hash "0xC7F76DF27A5045A1"
jhash (0x3EFBDD9B)
arguments {
Ped "ped" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
float "p4" [=[ {} ]=],
float "p5" [=[ {} ]=],
float "p6" [=[ {} ]=],
float "p7" [=[ {} ]=],
BOOL "p8" [=[ {} ]=],
BOOL "p9" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_AO_BLOB_RENDERING"
hash "0x2B5AA717A181FB4C"
jhash (0x98E29ED0)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x2B5AA717A181FB4C"
ns "PED"
returns "void"
doc [[!
```
Enable/disable ped shadow (ambient occlusion). https://gfycat.com/thankfulesteemedgecko
```
]]
native "SET_PED_ARMOUR"
hash "0xCEA04D83135264CC"
jhash (0x4E3A0CC4)
arguments {
Ped "ped" [=[ {} ]=],
int "amount" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
Sets the armor of the specified ped.
ped: The Ped to set the armor of.
amount: A value between 0 and 100 indicating the value to set the Ped's armor to.
```
]]
native "SET_PED_AS_COP"
hash "0xBB03C38DD3FB7FFD"
jhash (0x84E7DE9F)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
Turns the desired ped into a cop. If you use this on the player ped, you will become almost invisible to cops dispatched for you. You will also report your own crimes, get a generic cop voice, get a cop-vision-cone on the radar, and you will be unable to shoot at other cops. SWAT and Army will still shoot at you. Toggling ped as "false" has no effect; you must change p0's ped model to disable the effect.
```
]]
native "SET_PED_AS_ENEMY"
hash "0x02A0C9720B854BFA"
jhash (0xAE620A1B)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_AS_GROUP_LEADER"
hash "0x2A7819605465FBCE"
jhash (0x7265BEA2)
arguments {
Ped "ped" [=[ {} ]=],
int "groupId" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_AS_GROUP_MEMBER"
hash "0x9F3480FE65DB31B5"
jhash (0x0EE13F92)
arguments {
Ped "ped" [=[ {} ]=],
int "groupId" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_BLEND_FROM_PARENTS"
hash "0x137BBD05230DB22D"
jhash (0x837BD370)
arguments {
Ped "ped" [=[ {} ]=],
Ped "father" [=[ {} ]=],
Ped "mother" [=[ {} ]=],
float "fathersSide" [=[ {} ]=],
float "mothersSide" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_BLOCKS_PATHING_WHEN_DEAD"
hash "0x576594E8D64375E2"
jhash (0x1D87DDC1)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x576594E8D64375E2"
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_BOUNDS_ORIENTATION"
hash "0x4F5F651ACCC9C4CF"
jhash (0xCFA20D68)
arguments {
Ped "ped" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
float "p4" [=[ {} ]=],
float "p5" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_CAN_ARM_IK"
hash "0x6C3B4D6D13B4C841"
jhash (0x343B4DE0)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_CAN_BE_DRAGGED_OUT"
hash "0xC1670E958EEE24E5"
jhash (0xAA7F1131)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_CAN_BE_KNOCKED_OFF_VEHICLE"
hash "0x7A6535691B477C48"
jhash (0x8A251612)
arguments {
Ped "ped" [=[ {} ]=],
int "state" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
state: https://alloc8or.re/gta5/doc/enums/eKnockOffVehicle.txt
```
]]
native "SET_PED_CAN_BE_SHOT_IN_VEHICLE"
hash "0xC7EF1BA83230BA07"
jhash (0x5DB7B3A9)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_CAN_BE_TARGETED_WHEN_INJURED"
hash "0x638C03B0F9878F57"
jhash (0x6FD9A7CD)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_CAN_BE_TARGETED_WITHOUT_LOS"
hash "0x4328652AE5769C71"
jhash (0x7FDDC0A6)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_CAN_BE_TARGETTED"
hash "0x63F58F7C80513AAD"
jhash (0x75C49F74)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_CAN_BE_TARGETTED_BY_PLAYER"
hash "0x66B57B72E0836A76"
jhash (0xD050F490)
arguments {
Ped "ped" [=[ {} ]=],
Player "player" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_CAN_BE_TARGETTED_BY_TEAM"
hash "0xBF1CA77833E58F2C"
jhash (0xB103A8E1)
arguments {
Ped "ped" [=[ {} ]=],
int "team" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_CAN_COWER_IN_COVER"
hash "0xCB7553CDCEF4A735"
jhash (0x5194658B)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
It simply makes the said ped to cower behind cover object(wall, desk, car)
Peds flee attributes must be set to not to flee, first. Else, most of the peds, will just flee from gunshot sounds or any other panic situations.
```
]]
native "SET_PED_CAN_EVASIVE_DIVE"
hash "0x6B7A646C242A7059"
jhash (0x542FEB4D)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_CAN_HEAD_IK"
hash "0xC11C18092C5530DC"
jhash (0xD3B04476)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_CAN_LEG_IK"
hash "0x73518ECE2485412B"
jhash (0x9955BC6F)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_CAN_LOSE_PROPS_ON_DAMAGE"
hash "0xE861D0B05C7662B8"
jhash (0x2F9550C2)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "loseProps" [=[ {} ]=],
int "p2" [=[ {} ]=],
}
alias "0xE861D0B05C7662B8"
ns "PED"
returns "void"
doc [[!
It makes the ped lose (or not lose) their props (like glasses or helmets/hat) when someone punches or pushes the ped.
This is probably what's being used in GTA:O to keep players from knocking other player's hats/glasses off when in combat.
The target ped
true = allow props to fall off, false = don't let props fall off
purpose unknown, usually 0
]]
native "SET_PED_CAN_PEEK_IN_COVER"
hash "0xC514825C507E3736"
jhash (0xC1DAE216)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_CAN_PLAY_AMBIENT_ANIMS"
hash "0x6373D1349925A70E"
jhash (0xF8053081)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_CAN_PLAY_AMBIENT_BASE_ANIMS"
hash "0x0EB0585D15254740"
jhash (0x5720A5DD)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_CAN_PLAY_GESTURE_ANIMS"
hash "0xBAF20C5432058024"
jhash (0xE131E3B3)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_CAN_PLAY_VISEME_ANIMS"
hash "0xF833DDBA3B104D43"
jhash (0xA2FDAF27)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
p2 usually 0
```
]]
native "SET_PED_CAN_RAGDOLL"
hash "0xB128377056A54E2A"
jhash (0xCF1384C4)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_CAN_RAGDOLL_FROM_PLAYER_IMPACT"
hash "0xDF993EE5E90ABA25"
jhash (0xE9BD733A)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_CAN_SMASH_GLASS"
hash "0x1CCE141467FF42A2"
jhash (0x149C60A8)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_CAN_SWITCH_WEAPON"
hash "0xED7F7EFE9FABF340"
jhash (0xB5F8BA28)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_CAN_TELEPORT_TO_GROUP_LEADER"
hash "0x2E2F4240B3F24647"
jhash (0xD0D8BDBC)
arguments {
Ped "pedHandle" [=[ {} ]=],
int "groupHandle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
This only will teleport the ped to the group leader if the group leader teleports (sets coords).
Only works in singleplayer
```
]]
native "SET_PED_CAN_TORSO_IK"
hash "0xF2B7106D37947CE0"
jhash (0x8E5D4EAB)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_CAN_TORSO_REACT_IK"
hash "0xF5846EDB26A98A24"
jhash (0x7B0040A8)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
alias "0xF5846EDB26A98A24"
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_CAN_TORSO_VEHICLE_IK"
hash "0x6647C5F6F5792496"
jhash (0x0FDA62DE)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
alias "0x6647C5F6F5792496"
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_CAN_USE_AUTO_CONVERSATION_LOOKAT"
hash "0xEC4686EC06434678"
jhash (0x584C5178)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_CAPSULE"
hash "0x364DF566EC833DE2"
jhash (0xB153E1B9)
arguments {
Ped "ped" [=[ {} ]=],
float "value" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
Overrides the ped's collision capsule radius for the current tick.
Must be called every tick to be effective.
Setting this to 0.001 will allow warping through some objects.
```
]]
native "SET_PED_CLOTH_PACKAGE_INDEX"
hash "0x78C4E9961DB3EB5B"
jhash (0xFC942D7C)
arguments {
Ped "ped" [=[ {} ]=],
int "p1" [=[ {} ]=],
}
alias "0x78C4E9961DB3EB5B"
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_CLOTH_PRONE"
hash "0x82A3D6D9CC2CB8E3"
jhash (0x89EEE07B)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
alias "0x82A3D6D9CC2CB8E3"
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_COMBAT_ABILITY"
hash "0xC7622C0D36B2FDA8"
jhash (0x6C23D329)
arguments {
Ped "ped" [=[ {} ]=],
int "p1" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
100 would equal attack
less then 50ish would mean run away
Only the values 0, 1 and 2 occur in the decompiled scripts. Most likely refers directly to the values also described in combatbehaviour.meta:
0: CA_Poor
1: CA_Average
2: CA_Professional
Tested this and got the same results as the first explanation here. Could not find any difference between 0, 1 and 2.
```
]]
native "SET_PED_COMBAT_ATTRIBUTES"
hash "0x9F7794730795E019"
jhash (0x81D64248)
arguments {
Ped "ped" [=[ {} ]=],
int "attributeIndex" [=[ {} ]=],
BOOL "enabled" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
These combat attributes seem to be the same as the BehaviourFlags from combatbehaviour.meta.
So far, these are the equivalents found:
```cpp
enum eCombatAttribute
{
CA_INVALID = -1,
// AI will only use cover if this is set
CA_USE_COVER = 0,
// AI will only use vehicles if this is set
CA_USE_VEHICLE = 1,
// AI will only driveby from a vehicle if this is set
CA_DO_DRIVEBYS = 2,
// Will be forced to stay in a ny vehicel if this isn't set
CA_LEAVE_VEHICLES = 3,
// This ped can make decisions on whether to strafe or not based on distance to destination, recent bullet events, etc.
CA_CAN_USE_DYNAMIC_STRAFE_DECISIONS = 4,
// Ped will always fight upon getting threat response task
CA_ALWAYS_FIGHT = 5,
// If in combat and in a vehicle, the ped will flee rather than attacking
CA_FLEE_WHILST_IN_VEHICLE = 6,
// If in combat and chasing in a vehicle, the ped will keep a distance behind rather than ramming
CA_JUST_FOLLOW_VEHICLE = 7,
// Deprecated
CA_PLAY_REACTION_ANIMS = 8,
// Peds will scan for and react to dead peds found
CA_WILL_SCAN_FOR_DEAD_PEDS = 9,
// Deprecated
CA_IS_A_GUARD = 10,
// The ped will seek cover only
CA_JUST_SEEK_COVER = 11,
// Ped will only blind fire when in cover
CA_BLIND_FIRE_IN_COVER = 12,
// Ped may advance
CA_AGGRESSIVE = 13,
// Ped can investigate events such as distant gunfire, footsteps, explosions etc
CA_CAN_INVESTIGATE = 14,
// Ped can use a radio to call for backup (happens after a reaction)
CA_CAN_USE_RADIO = 15,
// Deprecated
CA_CAN_CAPTURE_ENEMY_PEDS = 16,
// Ped will always flee upon getting threat response task
CA_ALWAYS_FLEE = 17,
// Ped can do unarmed taunts in vehicle
CA_CAN_TAUNT_IN_VEHICLE = 20,
// Ped will be able to chase their targets if both are on foot and the target is running away
CA_CAN_CHASE_TARGET_ON_FOOT = 21,
// Ped can drag injured peds to safety
CA_WILL_DRAG_INJURED_PEDS_TO_SAFETY = 22,
// Ped will require LOS to the target it is aiming at before shooting
CA_REQUIRES_LOS_TO_SHOOT = 23,
// Ped is allowed to use proximity based fire rate (increasing fire rate at closer distances)
CA_USE_PROXIMITY_FIRING_RATE = 24,
// Normally peds can switch briefly to a secondary target in combat, setting this will prevent that
CA_DISABLE_SECONDARY_TARGET = 25,
// This will disable the flinching combat entry reactions for peds, instead only playing the turn and aim anims
CA_DISABLE_ENTRY_REACTIONS = 26,
// Force ped to be 100% accurate in all situations (added by Jay Reinebold)
CA_PERFECT_ACCURACY = 27,
// If we don't have cover and can't see our target it's possible we will advance, even if the target is in cover
CA_CAN_USE_FRUSTRATED_ADVANCE = 28,
// This will have the ped move to defensive areas and within attack windows before performing the cover search
CA_MOVE_TO_LOCATION_BEFORE_COVER_SEARCH = 29,
// Allow shooting of our weapon even if we don't have LOS (this isn't X-ray vision as it only affects weapon firing)
CA_CAN_SHOOT_WITHOUT_LOS = 30,
// Ped will try to maintain a min distance to the target, even if using defensive areas (currently only for cover finding + usage)
CA_MAINTAIN_MIN_DISTANCE_TO_TARGET = 31,
// Allows ped to use steamed variations of peeking anims
CA_CAN_USE_PEEKING_VARIATIONS = 34,
// Disables pinned down behaviors
CA_DISABLE_PINNED_DOWN = 35,
// Disables pinning down others
CA_DISABLE_PIN_DOWN_OTHERS = 36,
// When defensive area is reached the area is cleared and the ped is set to use defensive combat movement
CA_OPEN_COMBAT_WHEN_DEFENSIVE_AREA_IS_REACHED = 37,
// Disables bullet reactions
CA_DISABLE_BULLET_REACTIONS = 38,
// Allows ped to bust the player
CA_CAN_BUST = 39,
// This ped is ignored by other peds when wanted
CA_IGNORED_BY_OTHER_PEDS_WHEN_WANTED = 40,
// Ped is allowed to "jack" vehicles when needing to chase a target in combat
CA_CAN_COMMANDEER_VEHICLES = 41,
// Ped is allowed to flank
CA_CAN_FLANK = 42,
// Ped will switch to advance if they can't find cover
CA_SWITCH_TO_ADVANCE_IF_CANT_FIND_COVER = 43,
// Ped will switch to defensive if they are in cover
CA_SWITCH_TO_DEFENSIVE_IF_IN_COVER = 44,
// Ped will clear their primary defensive area when it is reached
CA_CLEAR_PRIMARY_DEFENSIVE_AREA_WHEN_REACHED = 45,
// Ped is allowed to fight armed peds when not armed
CA_CAN_FIGHT_ARMED_PEDS_WHEN_NOT_ARMED = 46,
// Ped is not allowed to use tactical points if set to use defensive movement (will only use cover)
CA_ENABLE_TACTICAL_POINTS_WHEN_DEFENSIVE = 47,
// Ped cannot adjust cover arcs when testing cover safety (atm done on corner cover points when ped usingdefensive area + no LOS)
CA_DISABLE_COVER_ARC_ADJUSTMENTS = 48,
// Ped may use reduced accuracy with large number of enemies attacking the same local player target
CA_USE_ENEMY_ACCURACY_SCALING = 49,
// Ped is allowed to charge the enemy position
CA_CAN_CHARGE = 50,
// When defensive area is reached the area is cleared and the ped is set to use will advance movement
CA_REMOVE_AREA_SET_WILL_ADVANCE_WHEN_DEFENSIVE_AREA_REACHED = 51,
// Use the vehicle attack mission during combat (only works on driver)
CA_USE_VEHICLE_ATTACK = 52,
// Use the vehicle attack mission during combat if the vehicle has mounted guns (only works on driver)
CA_USE_VEHICLE_ATTACK_IF_VEHICLE_HAS_MOUNTED_GUNS = 53,
// Always equip best weapon in combat
CA_ALWAYS_EQUIP_BEST_WEAPON = 54,
// Ignores in water at depth visibility check
CA_CAN_SEE_UNDERWATER_PEDS = 55,
// Will prevent this ped from aiming at any AI targets that are in helicopters
CA_DISABLE_AIM_AT_AI_TARGETS_IN_HELIS = 56,
// Disables peds seeking due to no clear line of sight
CA_DISABLE_SEEK_DUE_TO_LINE_OF_SIGHT = 57,
// To be used when releasing missions peds if we don't want them fleeing from combat (mission peds already prevent flee)
CA_DISABLE_FLEE_FROM_COMBAT = 58,
// Disables target changes during vehicle pursuit
CA_DISABLE_TARGET_CHANGES_DURING_VEHICLE_PURSUIT = 59,
// Ped may throw a smoke grenade at player loitering in combat
CA_CAN_THROW_SMOKE_GRENADE = 60,
// Will clear a set defensive area if that area cannot be reached
CA_CLEAR_AREA_SET_DEFENSIVE_IF_DEFENSIVE_CANNOT_BE_REACHED = 62,
// Disable block from pursue during vehicle chases
CA_DISABLE_BLOCK_FROM_PURSUE_DURING_VEHICLE_CHASE = 64,
// Disable spin out during vehicle chases
CA_DISABLE_SPIN_OUT_DURING_VEHICLE_CHASE = 65,
// Disable cruise in front during block during vehicle chases
CA_DISABLE_CRUISE_IN_FRONT_DURING_BLOCK_DURING_VEHICLE_CHASE = 66,
// Makes it more likely that the ped will continue targeting a target with blocked los for a few seconds
CA_CAN_IGNORE_BLOCKED_LOS_WEIGHTING = 67,
// Disables the react to buddy shot behaviour.
CA_DISABLE_REACT_TO_BUDDY_SHOT = 68,
// Prefer pathing using navmesh over road nodes
CA_PREFER_NAVMESH_DURING_VEHICLE_CHASE = 69,
// Ignore road edges when avoiding
CA_ALLOWED_TO_AVOID_OFFROAD_DURING_VEHICLE_CHASE = 70,
// Permits ped to charge a target outside the assigned defensive area.
CA_PERMIT_CHARGE_BEYOND_DEFENSIVE_AREA = 71,
// This ped will switch to an RPG if target is in a vehicle, otherwise will use alternate weapon.
CA_USE_ROCKETS_AGAINST_VEHICLES_ONLY = 72,
// Disables peds moving to a tactical point without clear los
CA_DISABLE_TACTICAL_POINTS_WITHOUT_CLEAR_LOS = 73,
// Disables pull alongside during vehicle chase
CA_DISABLE_PULL_ALONGSIDE_DURING_VEHICLE_CHASE = 74,
// If set on a ped, they will not flee when all random peds flee is set to TRUE (they are still able to flee due to other reasons)
CA_DISABLE_ALL_RANDOMS_FLEE = 78,
// This ped will send out a script DeadPedSeenEvent when they see a dead ped
CA_WILL_GENERATE_DEAD_PED_SEEN_SCRIPT_EVENTS = 79,
// This will use the receiving peds sense range rather than the range supplied to the communicate event
CA_USE_MAX_SENSE_RANGE_WHEN_RECEIVING_EVENTS = 80,
// When aiming from a vehicle the ped will only aim at targets on his side of the vehicle
CA_RESTRICT_IN_VEHICLE_AIMING_TO_CURRENT_SIDE = 81,
// LOS to the target is blocked we return to our default position and direction until we have LOS (no aiming)
CA_USE_DEFAULT_BLOCKED_LOS_POSITION_AND_DIRECTION = 82,
// LOS to the target is blocked we return to our default position and direction until we have LOS (no aiming)
CA_REQUIRES_LOS_TO_AIM = 83,
// Allow vehicles spawned infront of target facing away to enter cruise and wait to block approaching target
CA_CAN_CRUISE_AND_BLOCK_IN_VEHICLE = 84,
// Peds flying aircraft will prefer to target other aircraft over entities on the ground
CA_PREFER_AIR_COMBAT_WHEN_IN_AIRCRAFT = 85,
//Allow peds flying aircraft to use dog fighting behaviours
CA_ALLOW_DOG_FIGHTING = 86,
// This will make the weight of targets who aircraft vehicles be reduced greatly compared to targets on foot or in ground based vehicles
CA_PREFER_NON_AIRCRAFT_TARGETS = 87,
//When peds are tasked to go to combat, they keep searching for a known target for a while before forcing an unknown one
CA_PREFER_KNOWN_TARGETS_WHEN_COMBAT_CLOSEST_TARGET = 88,
// Only allow mounted weapons to fire if within the correct attack angle (default 25-degree cone). On a flag in order to keep exiting behaviour and only fix in specific cases.
CA_FORCE_CHECK_ATTACK_ANGLE_FOR_MOUNTED_GUNS = 89,
// Blocks the firing state for passenger-controlled mounted weapons. Existing flags CA_USE_VEHICLE_ATTACK and CA_USE_VEHICLE_ATTACK_IF_VEHICLE_HAS_MOUNTED_GUNS only work for drivers.
CA_BLOCK_FIRE_FOR_VEHICLE_PASSENGER_MOUNTED_GUNS = 90
};
```
The ped to set attributes to.
The attribute index to set. See `eCombatAttribute` enum.
A boolean to enable/disable the attribute (true/false).
]]
native "SET_PED_COMBAT_MOVEMENT"
hash "0x4D9CA1009AFBD057"
jhash (0x12E62F9E)
arguments {
Ped "ped" [=[ {} ]=],
int "combatMovement" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
0 - Stationary (Will just stand in place)
1 - Defensive (Will try to find cover and very likely to blind fire)
2 - Offensive (Will attempt to charge at enemy but take cover as well)
3 - Suicidal Offensive (Will try to flank enemy in a suicidal attack)
```
]]
native "SET_PED_COMBAT_RANGE"
hash "0x3C606747B23E497B"
jhash (0x8818A959)
arguments {
Ped "ped" [=[ {} ]=],
int "range" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
Define the scope within which the ped will engage in combat with the target.
```cpp
enum eCombatRange {
CR_NEAR = 0, // keeps within 5-15m
CR_MEDIUM = 1, // keeps within 7-30m
CR_FAR = 2, // keeps within 15-40m
CR_VERY_FAR = 3 // keeps within 22-45m
};
```
Ped index
See `eCombatRange` enum.
]]
native "SET_PED_COMPONENT_VARIATION"
hash "0x262B14F48D29DE80"
jhash (0xD4F7B05C)
arguments {
Ped "ped" [=[ {} ]=],
int "componentId" [=[ {} ]=],
int "drawableId" [=[ {} ]=],
int "textureId" [=[ {} ]=],
int "paletteId" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
This native is used to set component variation on a ped. Components, drawables and textures IDs are related to the ped model.
### MP Freemode list of components
**0**: Face
**1**: Mask
**2**: Hair
**3**: Torso
**4**: Leg
**5**: Parachute / bag
**6**: Shoes
**7**: Accessory
**8**: Undershirt
**9**: Kevlar
**10**: Badge
**11**: Torso 2
List of Component IDs
```cpp
// Components
enum ePedVarComp
{
PV_COMP_INVALID = 0xFFFFFFFF,
PV_COMP_HEAD = 0, // "HEAD"
PV_COMP_BERD = 1, // "BEARD"
PV_COMP_HAIR = 2, // "HAIR"
PV_COMP_UPPR = 3, // "UPPER"
PV_COMP_LOWR = 4, // "LOWER"
PV_COMP_HAND = 5, // "HAND"
PV_COMP_FEET = 6, // "FEET"
PV_COMP_TEEF = 7, // "TEETH"
PV_COMP_ACCS = 8, // "ACCESSORIES"
PV_COMP_TASK = 9, // "TASK"
PV_COMP_DECL = 10, // "DECL"
PV_COMP_JBIB = 11, // "JBIB"
PV_COMP_MAX = 12,
};
```
The ped handle.
The component that you want to set.
The drawable id that is going to be set. Refer to [GET_NUMBER_OF_PED_DRAWABLE_VARIATIONS](#\_0x27561561732A7842).
The texture id of the drawable. Refer to [GET_NUMBER_OF_PED_TEXTURE_VARIATIONS](#\_0x8F7156A3142A6BAD).
0 to 3.
]]
native "SET_PED_CONFIG_FLAG"
hash "0x1913FE4CBF41C463"
jhash (0x9CFBE10D)
arguments {
Ped "ped" [=[ {} ]=],
int "flagId" [=[ {} ]=],
BOOL "value" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```cpp
// Potential names and hash collisions included as comments
enum ePedConfigFlags {
CPED_CONFIG_FLAG_CreatedByFactory = 0,
CPED_CONFIG_FLAG_CanBeShotInVehicle = 1,
CPED_CONFIG_FLAG_NoCriticalHits = 2,
CPED_CONFIG_FLAG_DrownsInWater = 3,
CPED_CONFIG_FLAG_DrownsInSinkingVehicle = 4,
CPED_CONFIG_FLAG_DiesInstantlyWhenSwimming = 5,
CPED_CONFIG_FLAG_HasBulletProofVest = 6,
CPED_CONFIG_FLAG_UpperBodyDamageAnimsOnly = 7,
CPED_CONFIG_FLAG_NeverFallOffSkis = 8,
CPED_CONFIG_FLAG_NeverEverTargetThisPed = 9,
CPED_CONFIG_FLAG_ThisPedIsATargetPriority = 10,
CPED_CONFIG_FLAG_TargettableWithNoLos = 11,
CPED_CONFIG_FLAG_DoesntListenToPlayerGroupCommands = 12,
CPED_CONFIG_FLAG_NeverLeavesGroup = 13,
CPED_CONFIG_FLAG_DoesntDropWeaponsWhenDead = 14,
CPED_CONFIG_FLAG_SetDelayedWeaponAsCurrent = 15,
CPED_CONFIG_FLAG_KeepTasksAfterCleanUp = 16,
CPED_CONFIG_FLAG_BlockNonTemporaryEvents = 17,
CPED_CONFIG_FLAG_HasAScriptBrain = 18,
CPED_CONFIG_FLAG_WaitingForScriptBrainToLoad = 19,
CPED_CONFIG_FLAG_AllowMedicsToReviveMe = 20,
CPED_CONFIG_FLAG_MoneyHasBeenGivenByScript = 21,
CPED_CONFIG_FLAG_NotAllowedToCrouch = 22,
CPED_CONFIG_FLAG_DeathPickupsPersist = 23,
CPED_CONFIG_FLAG_IgnoreSeenMelee = 24,
CPED_CONFIG_FLAG_ForceDieIfInjured = 25,
CPED_CONFIG_FLAG_DontDragMeOutCar = 26,
CPED_CONFIG_FLAG_StayInCarOnJack = 27,
CPED_CONFIG_FLAG_ForceDieInCar = 28,
CPED_CONFIG_FLAG_GetOutUndriveableVehicle = 29,
CPED_CONFIG_FLAG_WillRemainOnBoatAfterMissionEnds = 30,
CPED_CONFIG_FLAG_DontStoreAsPersistent = 31,
CPED_CONFIG_FLAG_WillFlyThroughWindscreen = 32,
CPED_CONFIG_FLAG_DieWhenRagdoll = 33,
CPED_CONFIG_FLAG_HasHelmet = 34,
CPED_CONFIG_FLAG_UseHelmet = 35,
CPED_CONFIG_FLAG_DontTakeOffHelmet = 36,
CPED_CONFIG_FLAG_HideInCutscene = 37,
CPED_CONFIG_FLAG_PedIsEnemyToPlayer = 38,
CPED_CONFIG_FLAG_DisableEvasiveDives = 39,
CPED_CONFIG_FLAG_PedGeneratesDeadBodyEvents = 40,
CPED_CONFIG_FLAG_DontAttackPlayerWithoutWantedLevel = 41,
CPED_CONFIG_FLAG_DontInfluenceWantedLevel = 42,
CPED_CONFIG_FLAG_DisablePlayerLockon = 43,
CPED_CONFIG_FLAG_DisableLockonToRandomPeds = 44,
CPED_CONFIG_FLAG_AllowLockonToFriendlyPlayers = 45,
_0xDB115BFA = 46,
CPED_CONFIG_FLAG_PedBeingDeleted = 47,
CPED_CONFIG_FLAG_BlockWeaponSwitching = 48,
CPED_CONFIG_FLAG_BlockGroupPedAimedAtResponse = 49,
CPED_CONFIG_FLAG_WillFollowLeaderAnyMeans = 50,
CPED_CONFIG_FLAG_BlippedByScript = 51,
CPED_CONFIG_FLAG_DrawRadarVisualField = 52,
CPED_CONFIG_FLAG_StopWeaponFiringOnImpact = 53,
CPED_CONFIG_FLAG_DissableAutoFallOffTests = 54,
CPED_CONFIG_FLAG_SteerAroundDeadBodies = 55,
CPED_CONFIG_FLAG_ConstrainToNavMesh = 56,
CPED_CONFIG_FLAG_SyncingAnimatedProps = 57,
CPED_CONFIG_FLAG_IsFiring = 58,
CPED_CONFIG_FLAG_WasFiring = 59,
CPED_CONFIG_FLAG_IsStanding = 60,
CPED_CONFIG_FLAG_WasStanding = 61,
CPED_CONFIG_FLAG_InVehicle = 62,
CPED_CONFIG_FLAG_OnMount = 63,
CPED_CONFIG_FLAG_AttachedToVehicle = 64,
CPED_CONFIG_FLAG_IsSwimming = 65,
CPED_CONFIG_FLAG_WasSwimming = 66,
CPED_CONFIG_FLAG_IsSkiing = 67,
CPED_CONFIG_FLAG_IsSitting = 68,
CPED_CONFIG_FLAG_KilledByStealth = 69,
CPED_CONFIG_FLAG_KilledByTakedown = 70,
CPED_CONFIG_FLAG_Knockedout = 71,
CPED_CONFIG_FLAG_ClearRadarBlipOnDeath = 72,
CPED_CONFIG_FLAG_JustGotOffTrain = 73,
CPED_CONFIG_FLAG_JustGotOnTrain = 74,
CPED_CONFIG_FLAG_UsingCoverPoint = 75,
CPED_CONFIG_FLAG_IsInTheAir = 76,
CPED_CONFIG_FLAG_KnockedUpIntoAir = 77,
CPED_CONFIG_FLAG_IsAimingGun = 78,
CPED_CONFIG_FLAG_HasJustLeftCar = 79,
CPED_CONFIG_FLAG_TargetWhenInjuredAllowed = 80,
CPED_CONFIG_FLAG_CurrLeftFootCollNM = 81,
CPED_CONFIG_FLAG_PrevLeftFootCollNM = 82,
CPED_CONFIG_FLAG_CurrRightFootCollNM = 83,
CPED_CONFIG_FLAG_PrevRightFootCollNM = 84,
CPED_CONFIG_FLAG_HasBeenBumpedInCar = 85,
CPED_CONFIG_FLAG_InWaterTaskQuitToClimbLadder = 86,
CPED_CONFIG_FLAG_NMTwoHandedWeaponBothHandsConstrained = 87,
CPED_CONFIG_FLAG_CreatedBloodPoolTimer = 88,
CPED_CONFIG_FLAG_DontActivateRagdollFromAnyPedImpact = 89,
CPED_CONFIG_FLAG_GroupPedFailedToEnterCover = 90,
CPED_CONFIG_FLAG_AlreadyChattedOnPhone = 91,
CPED_CONFIG_FLAG_AlreadyReactedToPedOnRoof = 92,
CPED_CONFIG_FLAG_ForcePedLoadCover = 93,
CPED_CONFIG_FLAG_BlockCoweringInCover = 94,
CPED_CONFIG_FLAG_BlockPeekingInCover = 95,
CPED_CONFIG_FLAG_JustLeftCarNotCheckedForDoors = 96,
CPED_CONFIG_FLAG_VaultFromCover = 97,
CPED_CONFIG_FLAG_AutoConversationLookAts = 98,
CPED_CONFIG_FLAG_UsingCrouchedPedCapsule = 99,
CPED_CONFIG_FLAG_HasDeadPedBeenReported = 100,
CPED_CONFIG_FLAG_ForcedAim = 101,
CPED_CONFIG_FLAG_SteersAroundPeds = 102,
CPED_CONFIG_FLAG_SteersAroundObjects = 103,
CPED_CONFIG_FLAG_OpenDoorArmIK = 104,
CPED_CONFIG_FLAG_ForceReload = 105,
CPED_CONFIG_FLAG_DontActivateRagdollFromVehicleImpact = 106,
CPED_CONFIG_FLAG_DontActivateRagdollFromBulletImpact = 107,
CPED_CONFIG_FLAG_DontActivateRagdollFromExplosions = 108,
CPED_CONFIG_FLAG_DontActivateRagdollFromFire = 109,
CPED_CONFIG_FLAG_DontActivateRagdollFromElectrocution = 110,
CPED_CONFIG_FLAG_IsBeingDraggedToSafety = 111,
CPED_CONFIG_FLAG_HasBeenDraggedToSafety = 112,
CPED_CONFIG_FLAG_KeepWeaponHolsteredUnlessFired = 113,
CPED_CONFIG_FLAG_ForceScriptControlledKnockout = 114,
CPED_CONFIG_FLAG_FallOutOfVehicleWhenKilled = 115,
CPED_CONFIG_FLAG_GetOutBurningVehicle = 116,
CPED_CONFIG_FLAG_BumpedByPlayer = 117,
CPED_CONFIG_FLAG_RunFromFiresAndExplosions = 118,
CPED_CONFIG_FLAG_TreatAsPlayerDuringTargeting = 119,
CPED_CONFIG_FLAG_IsHandCuffed = 120,
CPED_CONFIG_FLAG_IsAnkleCuffed = 121,
CPED_CONFIG_FLAG_DisableMelee = 122,
CPED_CONFIG_FLAG_DisableUnarmedDrivebys = 123,
CPED_CONFIG_FLAG_JustGetsPulledOutWhenElectrocuted = 124,
CPED_CONFIG_FLAG_UNUSED_REPLACE_ME = 125,
CPED_CONFIG_FLAG_WillNotHotwireLawEnforcementVehicle = 126,
CPED_CONFIG_FLAG_WillCommandeerRatherThanJack = 127,
CPED_CONFIG_FLAG_CanBeAgitated = 128,
CPED_CONFIG_FLAG_ForcePedToFaceLeftInCover = 129,
CPED_CONFIG_FLAG_ForcePedToFaceRightInCover = 130,
CPED_CONFIG_FLAG_BlockPedFromTurningInCover = 131,
CPED_CONFIG_FLAG_KeepRelationshipGroupAfterCleanUp = 132,
CPED_CONFIG_FLAG_ForcePedToBeDragged = 133,
CPED_CONFIG_FLAG_PreventPedFromReactingToBeingJacked = 134,
CPED_CONFIG_FLAG_IsScuba = 135,
CPED_CONFIG_FLAG_WillArrestRatherThanJack = 136,
CPED_CONFIG_FLAG_RemoveDeadExtraFarAway = 137,
CPED_CONFIG_FLAG_RidingTrain = 138,
CPED_CONFIG_FLAG_ArrestResult = 139,
CPED_CONFIG_FLAG_CanAttackFriendly = 140,
CPED_CONFIG_FLAG_WillJackAnyPlayer = 141,
CPED_CONFIG_FLAG_BumpedByPlayerVehicle = 142,
CPED_CONFIG_FLAG_DodgedPlayerVehicle = 143,
CPED_CONFIG_FLAG_WillJackWantedPlayersRatherThanStealCar = 144,
CPED_CONFIG_FLAG_NoCopWantedAggro = 145,
CPED_CONFIG_FLAG_DisableLadderClimbing = 146,
CPED_CONFIG_FLAG_StairsDetected = 147,
CPED_CONFIG_FLAG_SlopeDetected = 148,
CPED_CONFIG_FLAG_HelmetHasBeenShot = 149,
CPED_CONFIG_FLAG_CowerInsteadOfFlee = 150,
CPED_CONFIG_FLAG_CanActivateRagdollWhenVehicleUpsideDown = 151,
CPED_CONFIG_FLAG_AlwaysRespondToCriesForHelp = 152,
CPED_CONFIG_FLAG_DisableBloodPoolCreation = 153,
CPED_CONFIG_FLAG_ShouldFixIfNoCollision = 154,
CPED_CONFIG_FLAG_CanPerformArrest = 155,
CPED_CONFIG_FLAG_CanPerformUncuff = 156,
CPED_CONFIG_FLAG_CanBeArrested = 157,
CPED_CONFIG_FLAG_MoverConstrictedByOpposingCollisions = 158,
CPED_CONFIG_FLAG_PlayerPreferFrontSeatMP = 159,
CPED_CONFIG_FLAG_DontActivateRagdollFromImpactObject = 160,
CPED_CONFIG_FLAG_DontActivateRagdollFromMelee = 161,
CPED_CONFIG_FLAG_DontActivateRagdollFromWaterJet = 162,
CPED_CONFIG_FLAG_DontActivateRagdollFromDrowning = 163,
CPED_CONFIG_FLAG_DontActivateRagdollFromFalling = 164,
CPED_CONFIG_FLAG_DontActivateRagdollFromRubberBullet = 165,
CPED_CONFIG_FLAG_IsInjured = 166,
CPED_CONFIG_FLAG_DontEnterVehiclesInPlayersGroup = 167,
CPED_CONFIG_FLAG_SwimmingTasksRunning = 168,
CPED_CONFIG_FLAG_PreventAllMeleeTaunts = 169,
CPED_CONFIG_FLAG_ForceDirectEntry = 170,
CPED_CONFIG_FLAG_AlwaysSeeApproachingVehicles = 171,
CPED_CONFIG_FLAG_CanDiveAwayFromApproachingVehicles = 172,
CPED_CONFIG_FLAG_AllowPlayerToInterruptVehicleEntryExit = 173,
CPED_CONFIG_FLAG_OnlyAttackLawIfPlayerIsWanted = 174,
CPED_CONFIG_FLAG_PlayerInContactWithKinematicPed = 175,
CPED_CONFIG_FLAG_PlayerInContactWithSomethingOtherThanKinematicPed = 176,
CPED_CONFIG_FLAG_PedsJackingMeDontGetIn = 177,
CPED_CONFIG_FLAG_AdditionalRappellingPed = 178,
CPED_CONFIG_FLAG_PedIgnoresAnimInterruptEvents = 179,
CPED_CONFIG_FLAG_IsInCustody = 180,
CPED_CONFIG_FLAG_ForceStandardBumpReactionThresholds = 181,
CPED_CONFIG_FLAG_LawWillOnlyAttackIfPlayerIsWanted = 182,
CPED_CONFIG_FLAG_IsAgitated = 183,
CPED_CONFIG_FLAG_PreventAutoShuffleToDriversSeat = 184,
CPED_CONFIG_FLAG_UseKinematicModeWhenStationary = 185,
CPED_CONFIG_FLAG_EnableWeaponBlocking = 186,
CPED_CONFIG_FLAG_HasHurtStarted = 187,
CPED_CONFIG_FLAG_DisableHurt = 188,
CPED_CONFIG_FLAG_PlayerIsWeird = 189,
CPED_CONFIG_FLAG_PedHadPhoneConversation = 190,
CPED_CONFIG_FLAG_BeganCrossingRoad = 191,
CPED_CONFIG_FLAG_WarpIntoLeadersVehicle = 192,
CPED_CONFIG_FLAG_DoNothingWhenOnFootByDefault = 193,
CPED_CONFIG_FLAG_UsingScenario = 194,
CPED_CONFIG_FLAG_VisibleOnScreen = 195,
CPED_CONFIG_FLAG_DontCollideWithKinematic = 196,
CPED_CONFIG_FLAG_ActivateOnSwitchFromLowPhysicsLod = 197,
CPED_CONFIG_FLAG_DontActivateRagdollOnPedCollisionWhenDead = 198,
CPED_CONFIG_FLAG_DontActivateRagdollOnVehicleCollisionWhenDead = 199,
CPED_CONFIG_FLAG_HasBeenInArmedCombat = 200,
CPED_CONFIG_FLAG_UseDiminishingAmmoRate = 201,
CPED_CONFIG_FLAG_Avoidance_Ignore_All = 202,
CPED_CONFIG_FLAG_Avoidance_Ignored_by_All = 203,
CPED_CONFIG_FLAG_Avoidance_Ignore_Group1 = 204,
CPED_CONFIG_FLAG_Avoidance_Member_of_Group1 = 205,
CPED_CONFIG_FLAG_ForcedToUseSpecificGroupSeatIndex = 206,
CPED_CONFIG_FLAG_LowPhysicsLodMayPlaceOnNavMesh = 207,
CPED_CONFIG_FLAG_DisableExplosionReactions = 208,
CPED_CONFIG_FLAG_DodgedPlayer = 209,
CPED_CONFIG_FLAG_WaitingForPlayerControlInterrupt = 210,
CPED_CONFIG_FLAG_ForcedToStayInCover = 211,
CPED_CONFIG_FLAG_GeneratesSoundEvents = 212,
CPED_CONFIG_FLAG_ListensToSoundEvents = 213,
CPED_CONFIG_FLAG_AllowToBeTargetedInAVehicle = 214,
CPED_CONFIG_FLAG_WaitForDirectEntryPointToBeFreeWhenExiting = 215,
CPED_CONFIG_FLAG_OnlyRequireOnePressToExitVehicle = 216,
CPED_CONFIG_FLAG_ForceExitToSkyDive = 217,
CPED_CONFIG_FLAG_SteersAroundVehicles = 218,
CPED_CONFIG_FLAG_AllowPedInVehiclesOverrideTaskFlags = 219,
CPED_CONFIG_FLAG_DontEnterLeadersVehicle = 220,
CPED_CONFIG_FLAG_DisableExitToSkyDive = 221,
CPED_CONFIG_FLAG_ScriptHasDisabledCollision = 222,
CPED_CONFIG_FLAG_UseAmbientModelScaling = 223,
CPED_CONFIG_FLAG_DontWatchFirstOnNextHurryAway = 224,
CPED_CONFIG_FLAG_DisablePotentialToBeWalkedIntoResponse = 225,
CPED_CONFIG_FLAG_DisablePedAvoidance = 226,
CPED_CONFIG_FLAG_ForceRagdollUponDeath = 227,
CPED_CONFIG_FLAG_CanLosePropsOnDamage = 228,
CPED_CONFIG_FLAG_DisablePanicInVehicle = 229,
CPED_CONFIG_FLAG_AllowedToDetachTrailer = 230,
CPED_CONFIG_FLAG_HasShotBeenReactedToFromFront = 231,
CPED_CONFIG_FLAG_HasShotBeenReactedToFromBack = 232,
CPED_CONFIG_FLAG_HasShotBeenReactedToFromLeft = 233,
CPED_CONFIG_FLAG_HasShotBeenReactedToFromRight = 234,
CPED_CONFIG_FLAG_AllowBlockDeadPedRagdollActivation = 235,
CPED_CONFIG_FLAG_IsHoldingProp = 236,
CPED_CONFIG_FLAG_BlocksPathingWhenDead = 237,
CPED_CONFIG_FLAG_ForcePlayNormalScenarioExitOnNextScriptCommand = 238,
CPED_CONFIG_FLAG_ForcePlayImmediateScenarioExitOnNextScriptCommand = 239,
CPED_CONFIG_FLAG_ForceSkinCharacterCloth = 240,
CPED_CONFIG_FLAG_LeaveEngineOnWhenExitingVehicles = 241,
CPED_CONFIG_FLAG_PhoneDisableTextingAnimations = 242,
CPED_CONFIG_FLAG_PhoneDisableTalkingAnimations = 243,
CPED_CONFIG_FLAG_PhoneDisableCameraAnimations = 244,
CPED_CONFIG_FLAG_DisableBlindFiringInShotReactions = 245,
CPED_CONFIG_FLAG_AllowNearbyCoverUsage = 246,
CPED_CONFIG_FLAG_InStrafeTransition = 247,
CPED_CONFIG_FLAG_CanPlayInCarIdles = 248,
CPED_CONFIG_FLAG_CanAttackNonWantedPlayerAsLaw = 249,
CPED_CONFIG_FLAG_WillTakeDamageWhenVehicleCrashes = 250,
CPED_CONFIG_FLAG_AICanDrivePlayerAsRearPassenger = 251,
CPED_CONFIG_FLAG_PlayerCanJackFriendlyPlayers = 252,
CPED_CONFIG_FLAG_OnStairs = 253,
CPED_CONFIG_FLAG_SimulatingAiming = 254,
CPED_CONFIG_FLAG_AIDriverAllowFriendlyPassengerSeatEntry = 255,
CPED_CONFIG_FLAG_ParentCarIsBeingRemoved = 256,
CPED_CONFIG_FLAG_AllowMissionPedToUseInjuredMovement = 257,
CPED_CONFIG_FLAG_CanLoseHelmetOnDamage = 258,
CPED_CONFIG_FLAG_NeverDoScenarioExitProbeChecks = 259,
CPED_CONFIG_FLAG_SuppressLowLODRagdollSwitchWhenCorpseSettles = 260,
CPED_CONFIG_FLAG_PreventUsingLowerPrioritySeats = 261,
CPED_CONFIG_FLAG_JustLeftVehicleNeedsReset = 262,
CPED_CONFIG_FLAG_TeleportIfCantReachPlayer = 263,
CPED_CONFIG_FLAG_PedsInVehiclePositionNeedsReset = 264,
CPED_CONFIG_FLAG_PedsFullyInSeat = 265,
CPED_CONFIG_FLAG_AllowPlayerLockOnIfFriendly = 266,
CPED_CONFIG_FLAG_UseCameraHeadingForDesiredDirectionLockOnTest = 267,
CPED_CONFIG_FLAG_TeleportToLeaderVehicle = 268,
CPED_CONFIG_FLAG_Avoidance_Ignore_WeirdPedBuffer = 269,
CPED_CONFIG_FLAG_OnStairSlope = 270,
CPED_CONFIG_FLAG_HasPlayedNMGetup = 271,
CPED_CONFIG_FLAG_DontBlipCop = 272,
CPED_CONFIG_FLAG_SpawnedAtExtendedRangeScenario = 273,
CPED_CONFIG_FLAG_WalkAlongsideLeaderWhenClose = 274,
CPED_CONFIG_FLAG_KillWhenTrapped = 275,
CPED_CONFIG_FLAG_EdgeDetected = 276,
CPED_CONFIG_FLAG_AlwaysWakeUpPhysicsOfIntersectedPeds = 277,
CPED_CONFIG_FLAG_EquippedAmbientLoadOutWeapon = 278,
CPED_CONFIG_FLAG_AvoidTearGas = 279,
CPED_CONFIG_FLAG_StoppedSpeechUponFreezing = 280,
CPED_CONFIG_FLAG_DisableGoToWritheWhenInjured = 281,
CPED_CONFIG_FLAG_OnlyUseForcedSeatWhenEnteringHeliInGroup = 282,
CPED_CONFIG_FLAG_ThrownFromVehicleDueToExhaustion = 283,
CPED_CONFIG_FLAG_UpdateEnclosedSearchRegion = 284,
CPED_CONFIG_FLAG_DisableWeirdPedEvents = 285,
CPED_CONFIG_FLAG_ShouldChargeNow = 286,
CPED_CONFIG_FLAG_RagdollingOnBoat = 287,
CPED_CONFIG_FLAG_HasBrandishedWeapon = 288,
CPED_CONFIG_FLAG_AllowMinorReactionsAsMissionPed = 289,
CPED_CONFIG_FLAG_BlockDeadBodyShockingEventsWhenDead = 290,
CPED_CONFIG_FLAG_PedHasBeenSeen = 291,
CPED_CONFIG_FLAG_PedIsInReusePool = 292,
CPED_CONFIG_FLAG_PedWasReused = 293,
CPED_CONFIG_FLAG_DisableShockingEvents = 294,
CPED_CONFIG_FLAG_MovedUsingLowLodPhysicsSinceLastActive = 295,
CPED_CONFIG_FLAG_NeverReactToPedOnRoof = 296,
CPED_CONFIG_FLAG_ForcePlayFleeScenarioExitOnNextScriptCommand = 297,
CPED_CONFIG_FLAG_JustBumpedIntoVehicle = 298,
CPED_CONFIG_FLAG_DisableShockingDrivingOnPavementEvents = 299,
CPED_CONFIG_FLAG_ShouldThrowSmokeNow = 300,
CPED_CONFIG_FLAG_DisablePedConstraints = 301,
CPED_CONFIG_FLAG_ForceInitialPeekInCover = 302,
CPED_CONFIG_FLAG_CreatedByDispatch = 303,
CPED_CONFIG_FLAG_PointGunLeftHandSupporting = 304,
CPED_CONFIG_FLAG_DisableJumpingFromVehiclesAfterLeader = 305,
CPED_CONFIG_FLAG_DontActivateRagdollFromPlayerPedImpact = 306,
CPED_CONFIG_FLAG_DontActivateRagdollFromAiRagdollImpact = 307,
CPED_CONFIG_FLAG_DontActivateRagdollFromPlayerRagdollImpact = 308,
CPED_CONFIG_FLAG_DisableQuadrupedSpring = 309,
CPED_CONFIG_FLAG_IsInCluster = 310,
CPED_CONFIG_FLAG_ShoutToGroupOnPlayerMelee = 311,
CPED_CONFIG_FLAG_IgnoredByAutoOpenDoors = 312,
CPED_CONFIG_FLAG_PreferInjuredGetup = 313,
CPED_CONFIG_FLAG_ForceIgnoreMeleeActiveCombatant = 314,
CPED_CONFIG_FLAG_CheckLoSForSoundEvents = 315,
CPED_CONFIG_FLAG_JackedAbandonedCar = 316,
CPED_CONFIG_FLAG_CanSayFollowedByPlayerAudio = 317,
CPED_CONFIG_FLAG_ActivateRagdollFromMinorPlayerContact = 318,
CPED_CONFIG_FLAG_HasPortablePickupAttached = 319,
CPED_CONFIG_FLAG_ForcePoseCharacterCloth = 320,
CPED_CONFIG_FLAG_HasClothCollisionBounds = 321,
CPED_CONFIG_FLAG_HasHighHeels = 322,
CPED_CONFIG_FLAG_TreatAsAmbientPedForDriverLockOn = 323,
CPED_CONFIG_FLAG_DontBehaveLikeLaw = 324,
CPED_CONFIG_FLAG_SpawnedAtScenario = 325,
CPED_CONFIG_FLAG_DisablePoliceInvestigatingBody = 326,
CPED_CONFIG_FLAG_DisableWritheShootFromGround = 327,
CPED_CONFIG_FLAG_LowerPriorityOfWarpSeats = 328,
CPED_CONFIG_FLAG_DisableTalkTo = 329,
CPED_CONFIG_FLAG_DontBlip = 330,
CPED_CONFIG_FLAG_IsSwitchingWeapon = 331,
CPED_CONFIG_FLAG_IgnoreLegIkRestrictions = 332,
CPED_CONFIG_FLAG_ScriptForceNoTimesliceIntelligenceUpdate = 333,
CPED_CONFIG_FLAG_JackedOutOfMyVehicle = 334,
CPED_CONFIG_FLAG_WentIntoCombatAfterBeingJacked = 335,
CPED_CONFIG_FLAG_DontActivateRagdollForVehicleGrab = 336,
CPED_CONFIG_FLAG_ForcePackageCharacterCloth = 337,
CPED_CONFIG_FLAG_DontRemoveWithValidOrder = 338,
CPED_CONFIG_FLAG_AllowTaskDoNothingTimeslicing = 339,
CPED_CONFIG_FLAG_ForcedToStayInCoverDueToPlayerSwitch = 340,
CPED_CONFIG_FLAG_ForceProneCharacterCloth = 341,
CPED_CONFIG_FLAG_NotAllowedToJackAnyPlayers = 342,
CPED_CONFIG_FLAG_InToStrafeTransition = 343,
CPED_CONFIG_FLAG_KilledByStandardMelee = 344,
CPED_CONFIG_FLAG_AlwaysLeaveTrainUponArrival = 345,
CPED_CONFIG_FLAG_ForcePlayDirectedNormalScenarioExitOnNextScriptCommand = 346,
CPED_CONFIG_FLAG_OnlyWritheFromWeaponDamage = 347,
CPED_CONFIG_FLAG_UseSloMoBloodVfx = 348,
CPED_CONFIG_FLAG_EquipJetpack = 349,
CPED_CONFIG_FLAG_PreventDraggedOutOfCarThreatResponse = 350,
CPED_CONFIG_FLAG_ScriptHasCompletelyDisabledCollision = 351,
CPED_CONFIG_FLAG_NeverDoScenarioNavChecks = 352,
CPED_CONFIG_FLAG_ForceSynchronousScenarioExitChecking = 353,
CPED_CONFIG_FLAG_ThrowingGrenadeWhileAiming = 354,
CPED_CONFIG_FLAG_HeadbobToRadioEnabled = 355,
CPED_CONFIG_FLAG_ForceDeepSurfaceCheck = 356,
CPED_CONFIG_FLAG_DisableDeepSurfaceAnims = 357,
CPED_CONFIG_FLAG_DontBlipNotSynced = 358,
CPED_CONFIG_FLAG_IsDuckingInVehicle = 359,
CPED_CONFIG_FLAG_PreventAutoShuffleToTurretSeat = 360,
CPED_CONFIG_FLAG_DisableEventInteriorStatusCheck = 361,
CPED_CONFIG_FLAG_HasReserveParachute = 362,
CPED_CONFIG_FLAG_UseReserveParachute = 363,
CPED_CONFIG_FLAG_TreatDislikeAsHateWhenInCombat = 364,
CPED_CONFIG_FLAG_OnlyUpdateTargetWantedIfSeen = 365,
CPED_CONFIG_FLAG_AllowAutoShuffleToDriversSeat = 366,
CPED_CONFIG_FLAG_DontActivateRagdollFromSmokeGrenade = 367,
CPED_CONFIG_FLAG_LinkMBRToOwnerOnChain = 368,
CPED_CONFIG_FLAG_AmbientFriendBumpedByPlayer = 369,
CPED_CONFIG_FLAG_AmbientFriendBumpedByPlayerVehicle = 370,
CPED_CONFIG_FLAG_InFPSUnholsterTransition = 371,
CPED_CONFIG_FLAG_PreventReactingToSilencedCloneBullets = 372,
CPED_CONFIG_FLAG_DisableInjuredCryForHelpEvents = 373,
CPED_CONFIG_FLAG_NeverLeaveTrain = 374,
CPED_CONFIG_FLAG_DontDropJetpackOnDeath = 375,
CPED_CONFIG_FLAG_UseFPSUnholsterTransitionDuringCombatRoll = 376,
CPED_CONFIG_FLAG_ExitingFPSCombatRoll = 377,
CPED_CONFIG_FLAG_ScriptHasControlOfPlayer = 378,
CPED_CONFIG_FLAG_PlayFPSIdleFidgetsForProjectile = 379,
CPED_CONFIG_FLAG_DisableAutoEquipHelmetsInBikes = 380,
CPED_CONFIG_FLAG_DisableAutoEquipHelmetsInAircraft = 381,
CPED_CONFIG_FLAG_WasPlayingFPSGetup = 382,
CPED_CONFIG_FLAG_WasPlayingFPSMeleeActionResult = 383,
CPED_CONFIG_FLAG_PreferNoPriorityRemoval = 384,
CPED_CONFIG_FLAG_FPSFidgetsAbortedOnFire = 385,
CPED_CONFIG_FLAG_ForceFPSIKWithUpperBodyAnim = 386,
CPED_CONFIG_FLAG_SwitchingCharactersInFirstPerson = 387,
CPED_CONFIG_FLAG_IsClimbingLadder = 388,
CPED_CONFIG_FLAG_HasBareFeet = 389,
CPED_CONFIG_FLAG_UNUSED_REPLACE_ME_2 = 390,
CPED_CONFIG_FLAG_GoOnWithoutVehicleIfItIsUnableToGetBackToRoad = 391,
CPED_CONFIG_FLAG_BlockDroppingHealthSnacksOnDeath = 392,
CPED_CONFIG_FLAG_ResetLastVehicleOnVehicleExit = 393,
CPED_CONFIG_FLAG_ForceThreatResponseToNonFriendToFriendMeleeActions = 394,
CPED_CONFIG_FLAG_DontRespondToRandomPedsDamage = 395,
CPED_CONFIG_FLAG_AllowContinuousThreatResponseWantedLevelUpdates = 396,
CPED_CONFIG_FLAG_KeepTargetLossResponseOnCleanup = 397,
CPED_CONFIG_FLAG_PlayersDontDragMeOutOfCar = 398,
CPED_CONFIG_FLAG_BroadcastRepondedToThreatWhenGoingToPointShooting = 399,
CPED_CONFIG_FLAG_IgnorePedTypeForIsFriendlyWith = 400,
CPED_CONFIG_FLAG_TreatNonFriendlyAsHateWhenInCombat = 401,
CPED_CONFIG_FLAG_DontLeaveVehicleIfLeaderNotInVehicle = 402,
CPED_CONFIG_FLAG_ChangeFromPermanentToAmbientPopTypeOnMigration = 403,
CPED_CONFIG_FLAG_AllowMeleeReactionIfMeleeProofIsOn = 404,
CPED_CONFIG_FLAG_UsingLowriderLeans = 405,
CPED_CONFIG_FLAG_UsingAlternateLowriderLeans = 406,
CPED_CONFIG_FLAG_UseNormalExplosionDamageWhenBlownUpInVehicle = 407,
CPED_CONFIG_FLAG_DisableHomingMissileLockForVehiclePedInside = 408,
CPED_CONFIG_FLAG_DisableTakeOffScubaGear = 409,
CPED_CONFIG_FLAG_IgnoreMeleeFistWeaponDamageMult = 410,
CPED_CONFIG_FLAG_LawPedsCanFleeFromNonWantedPlayer = 411,
CPED_CONFIG_FLAG_ForceBlipSecurityPedsIfPlayerIsWanted = 412,
CPED_CONFIG_FLAG_IsHolsteringWeapon = 413,
CPED_CONFIG_FLAG_UseGoToPointForScenarioNavigation = 414,
CPED_CONFIG_FLAG_DontClearLocalPassengersWantedLevel = 415,
CPED_CONFIG_FLAG_BlockAutoSwapOnWeaponPickups = 416,
CPED_CONFIG_FLAG_ThisPedIsATargetPriorityForAI = 417,
CPED_CONFIG_FLAG_IsSwitchingHelmetVisor = 418,
CPED_CONFIG_FLAG_ForceHelmetVisorSwitch = 419,
CPED_CONFIG_FLAG_IsPerformingVehicleMelee = 420,
CPED_CONFIG_FLAG_UseOverrideFootstepPtFx = 421,
CPED_CONFIG_FLAG_DisableVehicleCombat = 422,
CPED_CONFIG_FLAG_TreatAsFriendlyForTargetingAndDamage = 423,
CPED_CONFIG_FLAG_AllowBikeAlternateAnimations = 424,
CPED_CONFIG_FLAG_TreatAsFriendlyForTargetingAndDamageNonSynced = 425,
CPED_CONFIG_FLAG_UseLockpickVehicleEntryAnimations = 426,
CPED_CONFIG_FLAG_IgnoreInteriorCheckForSprinting = 427,
CPED_CONFIG_FLAG_SwatHeliSpawnWithinLastSpottedLocation = 428,
CPED_CONFIG_FLAG_DisableStartEngine = 429,
CPED_CONFIG_FLAG_IgnoreBeingOnFire = 430,
CPED_CONFIG_FLAG_DisableTurretOrRearSeatPreference = 431,
CPED_CONFIG_FLAG_DisableWantedHelicopterSpawning = 432,
CPED_CONFIG_FLAG_UseTargetPerceptionForCreatingAimedAtEvents = 433,
CPED_CONFIG_FLAG_DisableHomingMissileLockon = 434,
CPED_CONFIG_FLAG_ForceIgnoreMaxMeleeActiveSupportCombatants = 435,
CPED_CONFIG_FLAG_StayInDefensiveAreaWhenInVehicle = 436,
CPED_CONFIG_FLAG_DontShoutTargetPosition = 437,
CPED_CONFIG_FLAG_DisableHelmetArmor = 438,
CPED_CONFIG_FLAG_CreatedByConcealedPlayer = 439,
CPED_CONFIG_FLAG_PermanentlyDisablePotentialToBeWalkedIntoResponse = 440,
CPED_CONFIG_FLAG_PreventVehExitDueToInvalidWeapon = 441,
CPED_CONFIG_FLAG_IgnoreNetSessionFriendlyFireCheckForAllowDamage = 442,
CPED_CONFIG_FLAG_DontLeaveCombatIfTargetPlayerIsAttackedByPolice = 443,
CPED_CONFIG_FLAG_CheckLockedBeforeWarp = 444,
CPED_CONFIG_FLAG_DontShuffleInVehicleToMakeRoom = 445,
CPED_CONFIG_FLAG_GiveWeaponOnGetup = 446,
CPED_CONFIG_FLAG_DontHitVehicleWithProjectiles = 447,
CPED_CONFIG_FLAG_DisableForcedEntryForOpenVehiclesFromTryLockedDoor = 448,
CPED_CONFIG_FLAG_FiresDummyRockets = 449,
CPED_CONFIG_FLAG_PedIsArresting = 450,
CPED_CONFIG_FLAG_IsDecoyPed = 451,
CPED_CONFIG_FLAG_HasEstablishedDecoy = 452,
CPED_CONFIG_FLAG_BlockDispatchedHelicoptersFromLanding = 453,
CPED_CONFIG_FLAG_DontCryForHelpOnStun = 454,
CPED_CONFIG_FLAG_HitByTranqWeapon = 455,
CPED_CONFIG_FLAG_CanBeIncapacitated = 456,
CPED_CONFIG_FLAG_ForcedAimFromArrest = 457,
CPED_CONFIG_FLAG_DontChangeTargetFromMelee = 458,
_0x4376ABF2 = 459,
CPED_CONFIG_FLAG_RagdollFloatsIndefinitely = 460,
CPED_CONFIG_FLAG_BlockElectricWeaponDamage = 461,
_0x262A3B8E = 462,
_0x1AA79A25 = 463,
}
```
]]
native "SET_PED_COORDS_KEEP_VEHICLE"
hash "0x9AFEFF481A85AB2E"
jhash (0xD66AE1D3)
arguments {
Ped "ped" [=[ {} ]=],
float "posX" [=[ {} ]=],
float "posY" [=[ {} ]=],
float "posZ" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
teleports ped to coords along with the vehicle ped is in
```
]]
native "SET_PED_COORDS_NO_GANG"
hash "0x87052FE446E07247"
jhash (0x9561AD98)
arguments {
Ped "ped" [=[ {} ]=],
float "posX" [=[ {} ]=],
float "posY" [=[ {} ]=],
float "posZ" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_COWER_HASH"
hash "0xA549131166868ED3"
jhash (0x16F30DF4)
arguments {
Ped "ped" [=[ {} ]=],
charPtr "p1" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
p1: Only "CODE_HUMAN_STAND_COWER" found in the b617d scripts.
```
]]
native "SET_PED_DEFAULT_COMPONENT_VARIATION"
hash "0x45EEE61580806D63"
jhash (0xC866A984)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
Sets Ped Default Clothes
```
]]
native "SET_PED_DEFENSIVE_AREA_ATTACHED_TO_PED"
hash "0x4EF47FE21698A8B6"
jhash (0x74BDA7CE)
arguments {
Ped "ped" [=[ {} ]=],
Ped "attachPed" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
float "p4" [=[ {} ]=],
float "p5" [=[ {} ]=],
float "p6" [=[ {} ]=],
float "p7" [=[ {} ]=],
float "p8" [=[ {} ]=],
BOOL "p9" [=[ {} ]=],
BOOL "p10" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_DEFENSIVE_AREA_DIRECTION"
hash "0x413C6C763A4AFFAD"
jhash (0xB66B0C9A)
arguments {
Ped "ped" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
BOOL "p4" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_DEFENSIVE_SPHERE_ATTACHED_TO_PED"
hash "0xF9B8F91AAD3B953E"
jhash (0x40638BDC)
arguments {
Ped "ped" [=[ {} ]=],
Ped "target" [=[ {} ]=],
float "xOffset" [=[ {} ]=],
float "yOffset" [=[ {} ]=],
float "zOffset" [=[ {} ]=],
float "radius" [=[ {} ]=],
BOOL "p6" [=[ {} ]=],
}
alias "0xF9B8F91AAD3B953E"
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_DEFENSIVE_SPHERE_ATTACHED_TO_VEHICLE"
hash "0xE4723DB6E736CCFF"
jhash (0x4763B2C6)
arguments {
Ped "ped" [=[ {} ]=],
Vehicle "target" [=[ {} ]=],
float "xOffset" [=[ {} ]=],
float "yOffset" [=[ {} ]=],
float "zOffset" [=[ {} ]=],
float "radius" [=[ {} ]=],
BOOL "p6" [=[ {} ]=],
}
alias "0xE4723DB6E736CCFF"
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_DENSITY_MULTIPLIER_THIS_FRAME"
hash "0x95E3D6257B166CF2"
jhash (0x039C82BB)
arguments {
float "multiplier" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
**Usage:** Call this native every frame
Adjust from 0.0 (minimum, indicating no pedestrians in the street) to 1.0 (maximum, representing a normal amount of pedestrians on the street).
]]
native "SET_PED_DESIRED_HEADING"
hash "0xAA5A7ECE2AA8FE70"
jhash (0x961458F9)
arguments {
Ped "ped" [=[ {} ]=],
float "heading" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_DIES_IN_SINKING_VEHICLE"
hash "0xD718A22995E2B4BC"
jhash (0x8D4D9ABB)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_DIES_IN_VEHICLE"
hash "0x2A30922C90C9B42C"
jhash (0x6FE1E440)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_DIES_IN_WATER"
hash "0x56CEF0AC79073BDE"
jhash (0x604C872B)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_DIES_INSTANTLY_IN_WATER"
hash "0xEEB64139BA29A7CF"
jhash (0xFE2554FC)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_DIES_WHEN_INJURED"
hash "0x5BA7919BED300023"
jhash (0xE94E24D4)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
annotations [=[ {"cs_type":"Any"} ]=]
returns "void"
doc [[!
]]
native "SET_PED_DRIVE_BY_CLIPSET_OVERRIDE"
hash "0xED34AB6C5CB36520"
jhash (0xD4C73595)
arguments {
Ped "ped" [=[ {} ]=],
charPtr "clipset" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_DUCKING"
hash "0x030983CA930B692D"
jhash (0xB90353D7)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
This is the SET_CHAR_DUCKING from GTA IV, that makes Peds duck. This function does nothing in GTA V. It cannot set the ped as ducking in vehicles, and IS_PED_DUCKING will always return false.
```
]]
native "SET_PED_ENABLE_WEAPON_BLOCKING"
hash "0x97A790315D3831FD"
jhash (0x4CAD1A4A)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
annotations [=[ {"cs_type":"Any"} ]=]
returns "void"
doc [[!
]]
native "SET_PED_ENVEFF_COLOR_MODULATOR"
hash "0xD69411AA0CEBF9E9"
jhash (0x87A0C174)
arguments {
Ped "ped" [=[ {} ]=],
int "r" [=[ {} ]=],
int "g" [=[ {} ]=],
int "b" [=[ {} ]=],
}
alias "0xD69411AA0CEBF9E9"
ns "PED"
returns "void"
doc [[!
```
Something related to the environmental effects natives.
In the "agency_heist3b" script, p1 - p3 are always under 100 - usually they are {87, 81, 68}. If SET_PED_ENVEFF_SCALE is set to 0.65 (instead of the usual 1.0), they use {74, 69, 60}
```
]]
native "SET_PED_ENVEFF_SCALE"
hash "0xBF29516833893561"
jhash (0xFC1CFC27)
arguments {
Ped "ped" [=[ {} ]=],
float "value" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
Values look to be between 0.0 and 1.0
From decompiled scripts: 0.0, 0.6, 0.65, 0.8, 1.0
You are correct, just looked in IDA it breaks from the function if it's less than 0.0f or greater than 1.0f.
```
]]
native "SET_PED_FIRING_PATTERN"
hash "0x9AC577F5A12AD8A9"
jhash (0xB4629D66)
arguments {
Ped "ped" [=[ {} ]=],
Hash "patternHash" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
FIRING_PATTERN_BURST_FIRE = 0xD6FF6D61 ( 1073727030 )
FIRING_PATTERN_BURST_FIRE_IN_COVER = 0x026321F1 ( 40051185 )
FIRING_PATTERN_BURST_FIRE_DRIVEBY = 0xD31265F2 ( -753768974 )
FIRING_PATTERN_FROM_GROUND = 0x2264E5D6 ( 577037782 )
FIRING_PATTERN_DELAY_FIRE_BY_ONE_SEC = 0x7A845691 ( 2055493265 )
FIRING_PATTERN_FULL_AUTO = 0xC6EE6B4C ( -957453492 )
FIRING_PATTERN_SINGLE_SHOT = 0x5D60E4E0 ( 1566631136 )
FIRING_PATTERN_BURST_FIRE_PISTOL = 0xA018DB8A ( -1608983670 )
FIRING_PATTERN_BURST_FIRE_SMG = 0xD10DADEE ( 1863348768 )
FIRING_PATTERN_BURST_FIRE_RIFLE = 0x9C74B406 ( -1670073338 )
FIRING_PATTERN_BURST_FIRE_MG = 0xB573C5B4 ( -1250703948 )
FIRING_PATTERN_BURST_FIRE_PUMPSHOTGUN = 0x00BAC39B ( 12239771 )
FIRING_PATTERN_BURST_FIRE_HELI = 0x914E786F ( -1857128337 )
FIRING_PATTERN_BURST_FIRE_MICRO = 0x42EF03FD ( 1122960381 )
FIRING_PATTERN_SHORT_BURSTS = 0x1A92D7DF ( 445831135 )
FIRING_PATTERN_SLOW_FIRE_TANK = 0xE2CA3A71 ( -490063247 )
if anyone is interested firing pattern info: pastebin.com/Px036isB
```
]]
native "SET_PED_FLEE_ATTRIBUTES"
hash "0x70A2D1137C8ED7C9"
jhash (0xA717A875)
arguments {
Ped "ped" [=[ {} ]=],
int "attributeFlags" [=[ {} ]=],
BOOL "enable" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
bit 15 (0x8000) = force cower
```
]]
native "SET_PED_GENERATES_DEAD_BODY_EVENTS"
hash "0x7FB17BA2E7DECA5B"
jhash (0xE9B97A2B)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_GESTURE_GROUP"
hash "0xDDF803377F94AAA8"
jhash (0x170DA109)
arguments {
Ped "ped" [=[ {} ]=],
charPtr "animGroupGesture" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
From the scripts:
PED::SET_PED_GESTURE_GROUP(PLAYER::PLAYER_PED_ID(),
"ANIM_GROUP_GESTURE_MISS_FRA0");
PED::SET_PED_GESTURE_GROUP(PLAYER::PLAYER_PED_ID(),
"ANIM_GROUP_GESTURE_MISS_DocksSetup1");
```
]]
native "SET_PED_GET_OUT_UPSIDE_DOWN_VEHICLE"
hash "0xBC0ED94165A48BC2"
jhash (0x89AD49FF)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_GRAVITY"
hash "0x9FF447B6B6AD960A"
jhash (0x3CA16652)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
enable or disable the gravity of a ped
Examples:
PED::SET_PED_GRAVITY(PLAYER::PLAYER_PED_ID(), 0x00000001);
PED::SET_PED_GRAVITY(Local_289[iVar0 /*20*/], 0x00000001);
```
]]
native "SET_PED_GROUP_MEMBER_PASSENGER_INDEX"
hash "0x0BDDB8D9EC6BCF3C"
jhash (0x2AB3670B)
arguments {
Ped "ped" [=[ {} ]=],
int "index" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_HAIR_TINT"
hash "0x4CFFC65454C93A49"
arguments {
Ped "ped" [=[ {} ]=],
int "colorID" [=[ {} ]=],
int "highlightColorID" [=[ {} ]=],
}
alias "_SET_PED_HAIR_COLOR"
ns "PED"
returns "void"
doc [[!
Sets the tint index for the hair on the specified ped.
```
NativeDB Introduced: v323
```
The Ped whose hair tint is to be set.
The tint index for the primary hair color.
The tint index for the hair highlight color.
]]
native "SET_PED_HEAD_BLEND_DATA"
hash "0x9414E18B9434C2FE"
jhash (0x60746B88)
arguments {
Ped "ped" [=[ {} ]=],
int "shapeFirstID" [=[ {} ]=],
int "shapeSecondID" [=[ {} ]=],
int "shapeThirdID" [=[ {} ]=],
int "skinFirstID" [=[ {} ]=],
int "skinSecondID" [=[ {} ]=],
int "skinThirdID" [=[ {} ]=],
float "shapeMix" [=[ {} ]=],
float "skinMix" [=[ {} ]=],
float "thirdMix" [=[ {} ]=],
BOOL "isParent" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
For more info and the list of faceIDs please refer to [this](https://gtaforums.com/topic/858970-all-gtao-face-ids-pedset-ped-head-blend-data-explained) topic. Note that the Skin and Shape IDs are shared. This native will use this same list for both Skin and Shape IDs.
**Other information:**
IDs start at zero and go Male Non-DLC, Female Non-DLC, Male DLC, and Female DLC.
This native function is often called prior to calling natives such as:
* [`SetPedHairColor`](#\_0xA23FE32C)
* [`SetPedHeadOverlayColor`](#\_0x78935A27)
* [`SetPedHeadOverlay`](#\_0xD28DBA90)
* [`SetPedFaceFeature`](#\_0x6C8D4458)
The ped entity
Controls the shape of the first ped's face
Controls the shape of the second ped's face
Controls the shape of the third ped's face
Controls the first id's skin tone
Controls the second id's skin tone
Controls the third id's skin tone
0.0 - 1.0 Of whose characteristics to take Mother -> Father (shapeFirstID and shapeSecondID)
0.0 - 1.0 Of whose characteristics to take Mother -> Father (skinFirstID and skinSecondID)
Overrides the others in favor of the third IDs.
IsParent is set for "children" of the player character's grandparents during old-gen character creation. It has unknown effect otherwise.
]]
native "SET_PED_HEAD_OVERLAY"
hash "0x48F44967FA05CC1E"
jhash (0xD28DBA90)
arguments {
Ped "ped" [=[ {} ]=],
int "overlayID" [=[ {} ]=],
int "index" [=[ {} ]=],
float "opacity" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
OverlayID ranges from 0 to 12, index from 0 to _GET_NUM_OVERLAY_VALUES(overlayID)-1, and opacity from 0.0 to 1.0.
overlayID Part Index, to disable
0 Blemishes 0 - 23, 255
1 Facial Hair 0 - 28, 255
2 Eyebrows 0 - 33, 255
3 Ageing 0 - 14, 255
4 Makeup 0 - 74, 255
5 Blush 0 - 6, 255
6 Complexion 0 - 11, 255
7 Sun Damage 0 - 10, 255
8 Lipstick 0 - 9, 255
9 Moles/Freckles 0 - 17, 255
10 Chest Hair 0 - 16, 255
11 Body Blemishes 0 - 11, 255
12 Add Body Blemishes 0 - 1, 255
```
**Note:**
You may need to call [`SetPedHeadBlendData`](#\_0x9414E18B9434C2FE) prior to calling this native in order for it to work.
The ped entity
The overlay id displayed up above.
An integer representing the index (from 0 to `_GET_NUM_OVERLAY_VALUES(overlayID)-1`)
A float ranging from 0.0 to 1.0
]]
native "SET_PED_HEARING_RANGE"
hash "0x33A8F7F7D5F7F33C"
jhash (0xB32087E0)
arguments {
Ped "ped" [=[ {} ]=],
float "value" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_HEATSCALE_OVERRIDE"
hash "0xC1F6EBF9A3D55538"
jhash (0xEF9142DB)
arguments {
Ped "ped" [=[ {} ]=],
float "heatScale" [=[ {"cs_type":"Any"} ]=],
}
alias "0xC1F6EBF9A3D55538"
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_HELMET"
hash "0x560A43136EB58105"
jhash (0xED366E53)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "bEnable" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
Sets whether a pedestrian should wear a helmet.
Ped index.
Boolean value that indicates whether the helmet should be worn or not.
]]
native "SET_PED_HELMET_FLAG"
hash "0xC0E78D5C2CE3EB25"
jhash (0x12677780)
arguments {
Ped "ped" [=[ {} ]=],
int "helmetFlag" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_HELMET_PROP_INDEX"
hash "0x26D83693ED99291C"
jhash (0xA316D13F)
arguments {
Ped "ped" [=[ {} ]=],
int "propIndex" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
NativeDB Added Parameter 3: BOOL p2
```
The ped handle.
The prop index to set the helmet to. Refer to [SET_PED_PROP_INDEX](#\_0x93376B65A266EB5F).
]]
native "SET_PED_HELMET_TEXTURE_INDEX"
hash "0xF1550C4BD22582E2"
jhash (0x5F6C3328)
arguments {
Ped "ped" [=[ {} ]=],
int "textureIndex" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_HIGHLY_PERCEPTIVE"
hash "0x52D59AB61DDC05DD"
jhash (0x9A2180FF)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x52D59AB61DDC05DD"
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_ID_RANGE"
hash "0xF107E836A70DCE05"
jhash (0xEF3B4ED9)
arguments {
Ped "ped" [=[ {} ]=],
float "value" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_IN_VEHICLE_CONTEXT"
hash "0x530071295899A8C6"
jhash (0x27F25C0E)
arguments {
Ped "ped" [=[ {} ]=],
Hash "context" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
PED::SET_PED_IN_VEHICLE_CONTEXT(l_128, MISC::GET_HASH_KEY("MINI_PROSTITUTE_LOW_PASSENGER"));
PED::SET_PED_IN_VEHICLE_CONTEXT(l_128, MISC::GET_HASH_KEY("MINI_PROSTITUTE_LOW_RESTRICTED_PASSENGER"));
PED::SET_PED_IN_VEHICLE_CONTEXT(l_3212, MISC::GET_HASH_KEY("MISS_FAMILY1_JIMMY_SIT"));
PED::SET_PED_IN_VEHICLE_CONTEXT(l_3212, MISC::GET_HASH_KEY("MISS_FAMILY1_JIMMY_SIT_REAR"));
PED::SET_PED_IN_VEHICLE_CONTEXT(l_95, MISC::GET_HASH_KEY("MISS_FAMILY2_JIMMY_BICYCLE"));
PED::SET_PED_IN_VEHICLE_CONTEXT(num3, MISC::GET_HASH_KEY("MISSFBI2_MICHAEL_DRIVEBY"));
PED::SET_PED_IN_VEHICLE_CONTEXT(PLAYER::PLAYER_PED_ID(), MISC::GET_HASH_KEY("MISS_ARMENIAN3_FRANKLIN_TENSE"));
PED::SET_PED_IN_VEHICLE_CONTEXT(PLAYER::PLAYER_PED_ID(), MISC::GET_HASH_KEY("MISSFBI5_TREVOR_DRIVING"));
```
]]
native "SET_PED_INCREASED_AVOIDANCE_RADIUS"
hash "0x570389D1C3DE3C6B"
jhash (0x59C52BE6)
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0x570389D1C3DE3C6B"
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_INTO_VEHICLE"
hash "0xF75B0D629E1C063D"
jhash (0x07500C79)
arguments {
Ped "ped" [=[ {} ]=],
Vehicle "vehicle" [=[ {} ]=],
int "seatIndex" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
See eSeatPosition declared in [`IS_VEHICLE_SEAT_FREE`](#\_0x22AC59A870E6A669). -2 for the first available seat.
]]
native "SET_PED_KEEP_TASK"
hash "0x971D38760FBC02EF"
jhash (0xA7EC79CE)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_LEG_IK_MODE"
hash "0xC396F5B86FF9FEBD"
jhash (0xFDDB042E)
arguments {
Ped "ped" [=[ {} ]=],
int "mode" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
"IK" stands for "Inverse kinematics." I assume this has something to do with how the ped uses his legs to balance. In the scripts, the second parameter is always an int with a value of 2, 0, or sometimes 1
```
]]
native "SET_PED_LOD_MULTIPLIER"
hash "0xDC2C5C242AAC342B"
jhash (0x1D2B5C70)
arguments {
Ped "ped" [=[ {} ]=],
float "multiplier" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_MAX_HEALTH"
hash "0xF5F6378C4F3419D3"
jhash (0x5533F60B)
arguments {
Ped "ped" [=[ {} ]=],
int "value" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
The ped handle we're setting this for.
The new max health.
]]
native "SET_PED_MAX_MOVE_BLEND_RATIO"
hash "0x433083750C5E064A"
jhash (0xEAD0269A)
arguments {
Ped "ped" [=[ {} ]=],
float "value" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_MAX_TIME_IN_WATER"
hash "0x43C851690662113D"
jhash (0xFE0A106B)
arguments {
Ped "ped" [=[ {} ]=],
float "value" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_MAX_TIME_UNDERWATER"
hash "0x6BA428C528D9E522"
jhash (0x082EF240)
arguments {
Ped "ped" [=[ {} ]=],
float "value" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
Set the maximum time a ped can stay underwater. Maximum seems to be 50 seconds.
Ped id.
Time in seconds. Maximum is 50.0, any value above will be changed to 50.0.
]]
native "SET_PED_MIN_GROUND_TIME_FOR_STUNGUN"
hash "0xFA0675AB151073FA"
jhash (0x2F0D0973)
arguments {
Ped "ped" [=[ {} ]=],
int "minTimeInMs" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
Overwrites the minimum time the ped will stay on the ground for after being stunned. Setting this while the ped is stunned will not alter the duration of the current stun but will still effect future stuns.
Passing -1 into the second parameter `minTimeInMs` will reset the modifier, making it use the weapons original `DamageTime` as the stun duration (see `update/update.rpf/common/data/ai/weapons.meta`)
**NOTE**: Unlike what the native name implies, this works on any weapon that has its `DamageType` in the `weapons.meta` set to `ELECTRIC`.
The ped to set the min ground time for
The minimum time the stun should last in milliseconds.
]]
native "SET_PED_MIN_MOVE_BLEND_RATIO"
hash "0x01A898D26E2333DD"
jhash (0x383EC364)
arguments {
Ped "ped" [=[ {} ]=],
float "value" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_MODEL_IS_SUPPRESSED"
hash "0xE163A4BCE4DE6F11"
jhash (0x7820CA43)
arguments {
Hash "model" [=[ {"cs_type":"int"} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_MONEY"
hash "0xA9C8960E8684C1B5"
jhash (0x40D90BF2)
arguments {
Ped "ped" [=[ {} ]=],
int "amount" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
Maximum possible amount of money on MP is 2000. ~JX
-----------------------------------------------------------------------------
Maximum amount that a ped can theoretically have is 65535 (0xFFFF) since the amount is stored as an unsigned short (uint16_t) value.
```
]]
native "SET_PED_MOTION_BLUR"
hash "0x0A986918B102B448"
jhash (0xA211A128)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_MOVE_ANIMS_BLEND_OUT"
hash "0x9E8C908F41584ECD"
jhash (0x20E01957)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_MOVE_RATE_OVERRIDE"
hash "0x085BF80FA50A39D1"
jhash (0x900008C6)
arguments {
Ped "ped" [=[ {} ]=],
float "value" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
Min: 0.00
Max: 10.00
Can be used in combo with fast run cheat.
When value is set to 10.00:
Sprinting without fast run cheat: 66 m/s
Sprinting with fast run cheat: 77 m/s
Needs to be looped!
Note: According to IDA for the Xbox360 xex, when they check bgt they seem to have the min to 0.0f, but the max set to 1.15f not 10.0f.
```
]]
native "SET_PED_MOVEMENT_CLIPSET"
hash "0xAF8A94EDE7712BEF"
jhash (0xA817CDEB)
arguments {
Ped "ped" [=[ {} ]=],
charPtr "clipSet" [=[ {} ]=],
float "transitionSpeed" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
List of movement clipsets:
Thanks to elsewhat for list.
"ANIM_GROUP_MOVE_BALLISTIC"
"ANIM_GROUP_MOVE_LEMAR_ALLEY"
"clipset@move@trash_fast_turn"
"FEMALE_FAST_RUNNER"
"missfbi4prepp1_garbageman"
"move_characters@franklin@fire"
"move_characters@Jimmy@slow@"
"move_characters@michael@fire"
"move_f@flee@a"
"move_f@scared"
"move_f@sexy@a"
"move_heist_lester"
"move_injured_generic"
"move_lester_CaneUp"
"move_m@bag"
"MOVE_M@BAIL_BOND_NOT_TAZERED"
"MOVE_M@BAIL_BOND_TAZERED"
"move_m@brave"
"move_m@casual@d"
"move_m@drunk@moderatedrunk"
"MOVE_M@DRUNK@MODERATEDRUNK"
"MOVE_M@DRUNK@MODERATEDRUNK_HEAD_UP"
"MOVE_M@DRUNK@SLIGHTLYDRUNK"
"MOVE_M@DRUNK@VERYDRUNK"
"move_m@fire"
"move_m@gangster@var_e"
"move_m@gangster@var_f"
"move_m@gangster@var_i"
"move_m@JOG@"
"MOVE_M@PRISON_GAURD"
"MOVE_P_M_ONE"
"MOVE_P_M_ONE_BRIEFCASE"
"move_p_m_zero_janitor"
"move_p_m_zero_slow"
"move_ped_bucket"
"move_ped_crouched"
"move_ped_mop"
"MOVE_M@FEMME@"
"MOVE_F@FEMME@"
"MOVE_M@GANGSTER@NG"
"MOVE_F@GANGSTER@NG"
"MOVE_M@POSH@"
"MOVE_F@POSH@"
"MOVE_M@TOUGH_GUY@"
"MOVE_F@TOUGH_GUY@"
~ NotCrunchyTaco
```
time in seconds it takes to transition from one movement clipset to another.
]]
native "SET_PED_NAME_DEBUG"
hash "0x98EFA132A4117BE1"
jhash (0x20D6273E)
arguments {
Ped "ped" [=[ {} ]=],
charPtr "name" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
NOTE: Debugging functions are not present in the retail version of the game.
*untested but char *name could also be a hash for a localized string
```
]]
native "SET_PED_NEVER_LEAVES_GROUP"
hash "0x3DBFC55D5C9BB447"
jhash (0x0E038813)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_NON_CREATION_AREA"
hash "0xEE01041D559983EA"
jhash (0x7A97283F)
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
The distance between these points, is the diagonal of a box (remember it's 3D).
```
]]
native "SET_PED_PANIC_EXIT_SCENARIO"
hash "0xFE07FF6495D52E2A"
jhash (0x59DE73AC)
arguments {
Ped "ped" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
alias "0xFE07FF6495D52E2A"
ns "PED"
returns "Any"
doc [[!
]]
native "SET_PED_PARACHUTE_TINT_INDEX"
hash "0x333FC8DB079B7186"
jhash (0x5AEFEC3A)
arguments {
Ped "ped" [=[ {} ]=],
int "tintIndex" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_PHONE_PALETTE_IDX"
hash "0x83A169EABCDB10A2"
arguments {
Ped "ped" [=[ {} ]=],
int "index" [=[ {} ]=],
}
alias "0x83A169EABCDB10A2"
ns "PED"
returns "void"
doc [[!
Sets the palette index of a ped's phone.
| Value | Color |
| :---: | :-----: |
| `0` | Light Blue |
| `1` | Green |
| `2` | Red |
| `3` | Orange |
| `4` | Grey |
| `5` | Purple |
| `6` | Pink |
```
NativeDB Introduced: v323
```
The Ped whose phone palette is to be set.
The index of the color palette to apply to the ped's phone.
]]
native "SET_PED_PINNED_DOWN"
hash "0xAAD6D1ACF08F4612"
jhash (0xCC78999D)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "pinned" [=[ {} ]=],
int "i" [=[ {} ]=],
}
ns "PED"
returns "Any"
doc [[!
```
i could be time. Only example in the decompiled scripts uses it as -1.
```
]]
native "SET_PED_PLAYS_HEAD_ON_HORN_ANIM_WHEN_DIES_IN_VEHICLE"
hash "0x94D94BF1A75AED3D"
jhash (0x7C563CD2)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
**This native does absolutely nothing, just a nullsub**
```
Points to the same function as for example GET_RANDOM_VEHICLE_MODEL_IN_MEMORY and it does absolutely nothing.
```
]]
native "SET_PED_PREFERRED_COVER_SET"
hash "0x8421EB4DA7E391B9"
jhash (0xF3B7EFBF)
arguments {
Ped "ped" [=[ {} ]=],
Any "itemSet" [=[ {} ]=],
}
alias "0x8421EB4DA7E391B9"
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_PRELOAD_PROP_DATA"
hash "0x2B16A3BFF1FBCE49"
jhash (0xC0E23671)
arguments {
Ped "ped" [=[ {} ]=],
int "componentId" [=[ {} ]=],
int "drawableId" [=[ {} ]=],
int "textureId" [=[ {} ]=],
}
alias "0x2B16A3BFF1FBCE49"
alias "_IS_PED_PROP_VALID"
ns "PED"
returns "BOOL"
doc [[!
The ped handle.
The component that you want to set. Refer to [SET_PED_COMPONENT_VARIATION](#\_0x262B14F48D29DE80).
The drawable id that is going to be set. Refer to [GET_NUMBER_OF_PED_PROP_DRAWABLE_VARIATIONS](#\_0x5FAF9754E789FB47).
The texture id of the drawable. Refer to [GET_NUMBER_OF_PED_PROP_TEXTURE_VARIATIONS](#\_0xA6E7F1CEB523E171).
]]
native "SET_PED_PRELOAD_VARIATION_DATA"
hash "0x39D55A620FCB6A3A"
jhash (0x45F3BDFB)
arguments {
Ped "ped" [=[ {} ]=],
int "slot" [=[ {} ]=],
int "drawableId" [=[ {} ]=],
int "textureId" [=[ {} ]=],
}
alias "0x39D55A620FCB6A3A"
ns "PED"
returns "Any"
doc [[!
```
from extreme3.c4
PED::_39D55A620FCB6A3A(PLAYER::PLAYER_PED_ID(), 8, PED::GET_PED_DRAWABLE_VARIATION(PLAYER::PLAYER_PED_ID(), 8), PED::GET_PED_TEXTURE_VARIATION(PLAYER::PLAYER_PED_ID(), 8));
p1 is probably componentId
```
]]
native "SET_PED_PRIMARY_LOOKAT"
hash "0xCD17B554996A8D9E"
jhash (0x6DEF6F1C)
arguments {
Ped "ped" [=[ {} ]=],
Ped "lookAt" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
This is only called once in the scripts.
sub_1CD9(&l_49, 0, getElem(3, &l_34, 4), "MICHAEL", 0, 1);
sub_1CA8("WORLD_HUMAN_SMOKING", 2);
PED::SET_PED_PRIMARY_LOOKAT(getElem(3, &l_34, 4), PLAYER::PLAYER_PED_ID());
```
]]
native "SET_PED_PROP_INDEX"
hash "0x93376B65A266EB5F"
jhash (0x0829F2E2)
arguments {
Ped "ped" [=[ {} ]=],
int "componentId" [=[ {} ]=],
int "drawableId" [=[ {} ]=],
int "textureId" [=[ {} ]=],
BOOL "attach" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
This native is used to set prop variation on a ped. Components, drawables and textures IDs are related to the ped model.
### MP Freemode list of props
**0**: Hats
**1**: Glasses
**2**: Ears
**6**: Watches
**7**: Bracelets
List of Prop IDs
```cpp
enum eAnchorPoints
{
ANCHOR_HEAD = 0, // "p_head"
ANCHOR_EYES = 1, // "p_eyes"
ANCHOR_EARS = 2, // "p_ears"
ANCHOR_MOUTH = 3, // "p_mouth"
ANCHOR_LEFT_HAND = 4, // "p_lhand"
ANCHOR_RIGHT_HAND = 5, // "p_rhand"
ANCHOR_LEFT_WRIST = 6, // "p_lwrist"
ANCHOR_RIGHT_WRIST = 7, // "p_rwrist"
ANCHOR_HIP = 8, // "p_lhip"
ANCHOR_LEFT_FOOT = 9, // "p_lfoot"
ANCHOR_RIGHT_FOOT = 10, // "p_rfoot"
ANCHOR_PH_L_HAND = 11, // "ph_lhand"
ANCHOR_PH_R_HAND = 12, // "ph_rhand"
NUM_ANCHORS = 13,
};
```
The ped handle.
The component that you want to set. Refer to [SET_PED_COMPONENT_VARIATION](#\_0x262B14F48D29DE80).
The drawable id that is going to be set. Refer to [GET_NUMBER_OF_PED_PROP_DRAWABLE_VARIATIONS](#\_0x5FAF9754E789FB47).
The texture id of the drawable. Refer to [GET_NUMBER_OF_PED_PROP_TEXTURE_VARIATIONS](#\_0xA6E7F1CEB523E171).
Attached or not.
]]
native "SET_PED_RAGDOLL_FORCE_FALL"
hash "0x01F6594B923B9251"
jhash (0x20A5BDE0)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
annotations [=[ {"cs_type":"Any"} ]=]
returns "void"
doc [[!
]]
native "SET_PED_RAGDOLL_ON_COLLISION"
hash "0xF0A4F1BBF4FA7497"
jhash (0x2654A0F4)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
Causes Ped to ragdoll on collision with any object (e.g Running into trashcan). If applied to player you will sometimes trip on the sidewalk.
Needs to be recalled after each ragdoll from a Collision.
]]
native "SET_PED_RANDOM_COMPONENT_VARIATION"
hash "0xC8A9481A01E63C28"
jhash (0x4111BA46)
arguments {
Ped "ped" [=[ {} ]=],
int "p1" [=[ {"cs_type":"BOOL"} ]=],
}
ns "PED"
returns "void"
doc [[!
```
p1 is always 0 in R* scripts; and a quick disassembly seems to indicate that p1 is unused.
```
]]
native "SET_PED_RANDOM_PROPS"
hash "0xC44AA05345C992C6"
jhash (0xE3318E0E)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
The ped handle.
]]
native "SET_PED_RELATIONSHIP_GROUP_DEFAULT_HASH"
hash "0xADB3F206518799E8"
jhash (0x423B7BA2)
arguments {
Ped "ped" [=[ {} ]=],
Hash "hash" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_RELATIONSHIP_GROUP_HASH"
hash "0xC80A74AC829DDD92"
jhash (0x79F8C18C)
arguments {
Ped "ped" [=[ {} ]=],
Hash "hash" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_RESERVE_PARACHUTE_TINT_INDEX"
hash "0xE88DA0751C22A2AD"
jhash (0x177EFC79)
arguments {
Ped "ped" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_RESET_FLAG"
hash "0xC1E8A365BF3B29F2"
jhash (0xCFF6FF66)
arguments {
Ped "ped" [=[ {} ]=],
int "flagId" [=[ {} ]=],
BOOL "doReset" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
PED::SET_PED_RESET_FLAG(PLAYER::PLAYER_PED_ID(), 240, 1);
Known values:
]]
native "SET_PED_SEEING_RANGE"
hash "0xF29CF591C4BF6CEE"
jhash (0x4BD72FE8)
arguments {
Ped "ped" [=[ {} ]=],
float "value" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_SHOOT_RATE"
hash "0x614DA022990752DC"
jhash (0xFB301746)
arguments {
Ped "ped" [=[ {} ]=],
int "shootRate" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
shootRate 0-1000
```
]]
native "SET_PED_SHOOTS_AT_COORD"
hash "0x96A05E4FB321B1BA"
jhash (0xFD64EAE5)
arguments {
Ped "ped" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
Fires a weapon at a coordinate using a ped.
Ped index.
]]
native "SET_PED_SHOULD_PLAY_FLEE_SCENARIO_EXIT"
hash "0xEEED8FAFEC331A70"
jhash (0x7B4C3E6F)
arguments {
Ped "ped" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
alias "0xEEED8FAFEC331A70"
ns "PED"
returns "Any"
doc [[!
]]
native "SET_PED_SHOULD_PLAY_IMMEDIATE_SCENARIO_EXIT"
hash "0xF1C03A5352243A30"
jhash (0x4C684C81)
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0xF1C03A5352243A30"
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_SHOULD_PLAY_NORMAL_SCENARIO_EXIT"
hash "0xA3A9299C4F2ADB98"
jhash (0x033F43FA)
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0xA3A9299C4F2ADB98"
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_SPHERE_DEFENSIVE_AREA"
hash "0x9D3151A373974804"
jhash (0xBD96D8E8)
arguments {
Ped "ped" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "radius" [=[ {} ]=],
BOOL "p5" [=[ {} ]=],
BOOL "p6" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_STAY_IN_VEHICLE_WHEN_JACKED"
hash "0xEDF4079F9D54C9A1"
jhash (0xB014A09C)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_STEALTH_MOVEMENT"
hash "0x88CBB5CEB96B7BD2"
jhash (0x67E28E1D)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
charPtr "action" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
p1 is usually 0 in the scripts. action is either 0 or a pointer to "DEFAULT_ACTION".
```
]]
native "SET_PED_STEERS_AROUND_OBJECTS"
hash "0x1509C089ADC208BF"
jhash (0x3BD9B0A6)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_STEERS_AROUND_PEDS"
hash "0x46F2193B3AD1D891"
jhash (0x797CAE4F)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_STEERS_AROUND_VEHICLES"
hash "0xEB6FB9D48DDE23EC"
jhash (0x533C0651)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_STRAFE_CLIPSET"
hash "0x29A28F3F8CF6D854"
jhash (0x0BACF010)
arguments {
Ped "ped" [=[ {} ]=],
charPtr "clipSet" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_SUFFERS_CRITICAL_HITS"
hash "0xEBD76F2359F190AC"
jhash (0x6F6FC7E6)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
Ped no longer takes critical damage modifiers if set to FALSE.
Example: Headshotting a player no longer one shots them. Instead they will take the same damage as a torso shot.
]]
native "SET_PED_SWEAT"
hash "0x27B0405F59637D1F"
jhash (0x76A1DB9F)
arguments {
Ped "ped" [=[ {} ]=],
float "sweat" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
Sweat is set to 100.0 or 0.0 in the decompiled scripts.
```
]]
native "SET_PED_TARGET_LOSS_RESPONSE"
hash "0x0703B9079823DA4A"
jhash (0xCFA613FF)
arguments {
Ped "ped" [=[ {} ]=],
int "responseType" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
Only 1 and 2 appear in the scripts. combatbehaviour.meta seems to only have TLR_SearchForTarget for all peds, but we don't know if that's 1 or 2.
```
]]
native "SET_PED_TO_INFORM_RESPECTED_FRIENDS"
hash "0x112942C6E708F70B"
jhash (0xD78AC46C)
arguments {
Ped "ped" [=[ {} ]=],
float "radius" [=[ {} ]=],
int "maxFriends" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_TO_LOAD_COVER"
hash "0x332B562EEDA62399"
jhash (0xCF94BA97)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_TO_RAGDOLL"
hash "0xAE99FB955581844A"
jhash (0x83CB5052)
arguments {
Ped "ped" [=[ {} ]=],
int "minTime" [=[ {} ]=],
int "maxTime" [=[ {} ]=],
int "ragdollType" [=[ {} ]=],
BOOL "bAbortIfInjured" [=[ {} ]=],
BOOL "bAbortIfDead" [=[ {} ]=],
BOOL "bForceScriptControl" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
p4/p5: Unusued in TU27
### Ragdoll Types
**0**: CTaskNMRelax
**1**: CTaskNMScriptControl: Hardcoded not to work in networked environments.
**Else**: CTaskNMBalance
The ped to ragdoll.
Time(ms) Ped is in ragdoll mode; only applies to ragdoll types 0 and not 1.
unused
unused
]]
native "SET_PED_TO_RAGDOLL_WITH_FALL"
hash "0xD76632D99E4966C8"
jhash (0xFA12E286)
arguments {
Ped "ped" [=[ {} ]=],
int "minTime" [=[ {} ]=],
int "maxTime" [=[ {} ]=],
int "nFallType" [=[ {} ]=],
float "dirX" [=[ {} ]=],
float "dirY" [=[ {} ]=],
float "dirZ" [=[ {} ]=],
float "fGroundHeight" [=[ {} ]=],
float "grab1X" [=[ {} ]=],
float "grab1Y" [=[ {} ]=],
float "grab1Z" [=[ {} ]=],
float "grab2X" [=[ {} ]=],
float "grab2Y" [=[ {} ]=],
float "grab2Z" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
```cpp
enum eNMFallType {
TYPE_FROM_HIGH = 0,
TYPE_OVER_WALL = 1,
TYPE_DOWN_STAIRS = 2,
TYPE_DIE_TYPES = 3,
TYPE_DIE_FROM_HIGH = 4,
TYPE_DIE_OVER_WALL = 5,
TYPE_DIE_DOWN_STAIRS = 6
}
```
```
Return variable is never used in R*'s scripts.
Not sure what p2 does. It seems like it would be a time judging by it's usage in R*'s scripts, but didn't seem to affect anything in my testings.
x, y, and z are coordinates, most likely to where the ped will fall.
p7 is probably the force of the fall, but untested, so I left the variable name the same.
p8 to p13 are always 0f in R*'s scripts.
(Simplified) Example of the usage of the function from R*'s scripts:
ped::set_ped_to_ragdoll_with_fall(ped, 1500, 2000, 1, -entity::get_entity_forward_vector(ped), 1f, 0f, 0f, 0f, 0f, 0f, 0f);
```
The ped to ragdoll.
The type of fall.
The x direction of the fall.
The y direction of the fall.
The z direction of the fall.
The ground height (z).
unused
unused
unused
unused
unused
unused
]]
native "SET_PED_USING_ACTION_MODE"
hash "0xD75ACCF5E0FB5367"
jhash (0x8802F696)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
int "p2" [=[ {} ]=],
charPtr "action" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
p2 is usually -1 in the scripts. action is either 0 or "DEFAULT_ACTION".
```
]]
native "SET_PED_VEHICLE_FORCED_SEAT_USAGE"
hash "0x952F06BEECD775CC"
jhash (0x79CA237B)
arguments {
Ped "ped" [=[ {} ]=],
Vehicle "vehicle" [=[ {} ]=],
int "seatIndex" [=[ {} ]=],
int "flags" [=[ {} ]=],
}
alias "0x952F06BEECD775CC"
ns "PED"
returns "void"
doc [[!
```
NativeDB Added Parameter 5: Any p4
```
See eSeatPosition declared in [`IS_VEHICLE_SEAT_FREE`](#\_0x22AC59A870E6A669).
]]
native "SET_PED_VISUAL_FIELD_CENTER_ANGLE"
hash "0x3B6405E8AB34A907"
jhash (0xE57202A1)
arguments {
Ped "ped" [=[ {} ]=],
float "angle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_VISUAL_FIELD_MAX_ANGLE"
hash "0x70793BDCA1E854D4"
jhash (0x0CEA0F9A)
arguments {
Ped "ped" [=[ {} ]=],
float "value" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_VISUAL_FIELD_MAX_ELEVATION_ANGLE"
hash "0x78D0B67629D75856"
jhash (0x39D9102F)
arguments {
Ped "ped" [=[ {} ]=],
float "angle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
This native refers to the field of vision the ped has above them, starting at 0 degrees. 90f would let the ped see enemies directly above of them.
```
]]
native "SET_PED_VISUAL_FIELD_MIN_ANGLE"
hash "0x2DB492222FB21E26"
jhash (0x72E2E18B)
arguments {
Ped "ped" [=[ {} ]=],
float "value" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_VISUAL_FIELD_MIN_ELEVATION_ANGLE"
hash "0x7A276EB2C224D70F"
jhash (0x5CC2F1B8)
arguments {
Ped "ped" [=[ {} ]=],
float "angle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
This native refers to the field of vision the ped has below them, starting at 0 degrees. The angle value should be negative.
```
]]
native "SET_PED_VISUAL_FIELD_PERIPHERAL_RANGE"
hash "0x9C74B0BC831B753A"
jhash (0xFDF2F7C2)
arguments {
Ped "ped" [=[ {} ]=],
float "range" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_WEAPON_MOVEMENT_CLIPSET"
hash "0x2622E35B77D3ACA2"
jhash (0xF8BE54DC)
arguments {
Ped "ped" [=[ {} ]=],
charPtr "clipSet" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_PED_WETNESS_ENABLED_THIS_FRAME"
hash "0xB5485E4907B53019"
jhash (0xBDE749F7)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
combined with PED::SET_PED_WETNESS_HEIGHT(), this native makes the ped drenched in water up to the height specified in the other function
```
]]
native "SET_PED_WETNESS_HEIGHT"
hash "0x44CB6447D2571AA0"
jhash (0x7B33289A)
arguments {
Ped "ped" [=[ {} ]=],
float "height" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
It adds the wetness level to the player clothing/outfit. As if player just got out from water surface.
```
]]
native "SET_POP_CONTROL_SPHERE_THIS_FRAME"
hash "0xD8C3BE3EE94CAF2D"
jhash (0x4BBE5E2C)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "min" [=[ {} ]=],
float "max" [=[ {} ]=],
}
alias "0xD8C3BE3EE94CAF2D"
ns "PED"
returns "void"
doc [[!
```
Min and max are usually 100.0 and 200.0
```
]]
native "SET_RAGDOLL_BLOCKING_FLAGS"
hash "0x26695EC767728D84"
jhash (0x9C8F830D)
arguments {
Ped "ped" [=[ {} ]=],
int "flags" [=[ {} ]=],
}
alias "0x26695EC767728D84"
alias "_SET_PED_RAGDOLL_BLOCKING_FLAGS"
ns "PED"
returns "void"
doc [[!
```
Works for both player and peds, but some flags don't seem to work for the player (1, for example)
1 - Blocks ragdolling when shot.
2 - Blocks ragdolling when hit by a vehicle. The ped still might play a falling animation.
4 - Blocks ragdolling when set on fire.
-----------------------------------------------------------------------
There seem to be 26 flags
```
]]
native "SET_RELATIONSHIP_BETWEEN_GROUPS"
hash "0xBF25EB89375A37AD"
jhash (0xD4A215BA)
arguments {
int "relationship" [=[ {} ]=],
Hash "group1" [=[ {} ]=],
Hash "group2" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
Sets the relationship between two groups. This should be called twice (once for each group).
Relationship types:
0 = Companion
1 = Respect
2 = Like
3 = Neutral
4 = Dislike
5 = Hate
255 = Pedestrians
Example:
PED::SET_RELATIONSHIP_BETWEEN_GROUPS(2, l_1017, 0xA49E591C);
PED::SET_RELATIONSHIP_BETWEEN_GROUPS(2, 0xA49E591C, l_1017);
```
]]
native "SET_SCENARIO_PED_DENSITY_MULTIPLIER_THIS_FRAME"
hash "0x7A556143A1C03898"
jhash (0x2909ABF0)
arguments {
float "interiorMult" [=[ {} ]=],
float "exteriorMult" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
Set the number of scenario peds on the entire map
Multiplier for ped scenarios inside interiors.
Multiplier for ped scenarios outside interiors.
]]
native "SET_SCENARIO_PEDS_SPAWN_IN_SPHERE_AREA"
hash "0x28157D43CF600981"
jhash (0x80EAD297)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "range" [=[ {} ]=],
int "p4" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_SCENARIO_PEDS_TO_BE_RETURNED_BY_NEXT_COMMAND"
hash "0x14F19A8782C8071E"
jhash (0x85615FD0)
arguments {
BOOL "value" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
Sets a value indicating whether scenario peds should be returned by the next call to a command that returns peds. Eg. GET_CLOSEST_PED.
```
]]
native "SET_SCRIPTED_ANIM_SEAT_OFFSET"
hash "0x5917BBA32D06C230"
jhash (0x7CEFFA45)
arguments {
Ped "ped" [=[ {} ]=],
float "p1" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_SCRIPTED_CONVERSION_COORD_THIS_FRAME"
hash "0x5086C7843552CF85"
jhash (0x25EA2AA5)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_SYNCHRONIZED_SCENE_HOLD_LAST_FRAME"
hash "0x394B9CD12435C981"
jhash (0x2DE48DA1)
arguments {
int "sceneID" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x394B9CD12435C981"
alias "_SET_SYNCHRONIZED_SCENE_OCCLUSION_PORTAL"
ns "PED"
returns "void"
doc [[!
]]
native "SET_SYNCHRONIZED_SCENE_LOOPED"
hash "0xD9A897A4C6C2974F"
jhash (0x32ED9F82)
arguments {
int "sceneID" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_SYNCHRONIZED_SCENE_ORIGIN"
hash "0x6ACF6B7225801CD7"
jhash (0x2EC2A0B2)
arguments {
int "sceneID" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "roll" [=[ {} ]=],
float "pitch" [=[ {} ]=],
float "yaw" [=[ {} ]=],
BOOL "p7" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_SYNCHRONIZED_SCENE_PHASE"
hash "0x734292F4F0ABF6D0"
jhash (0xF5AB0D98)
arguments {
int "sceneID" [=[ {} ]=],
float "phase" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SET_SYNCHRONIZED_SCENE_RATE"
hash "0xB6C49F8A5E295A5D"
jhash (0xF10112FD)
arguments {
int "sceneID" [=[ {} ]=],
float "rate" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "SPAWNPOINTS_CANCEL_SEARCH"
hash "0xFEE4A5459472A9F8"
jhash (0x492C9E46)
alias "0xFEE4A5459472A9F8"
ns "PED"
returns "void"
doc [[!
]]
native "SPAWNPOINTS_GET_NUM_SEARCH_RESULTS"
hash "0xA635C11B8C44AFC2"
jhash (0xF46B4DC8)
alias "0xA635C11B8C44AFC2"
ns "PED"
returns "int"
doc [[!
]]
native "SPAWNPOINTS_GET_SEARCH_RESULT"
hash "0x280C7E3AC7F56E90"
jhash (0x36A4AC65)
arguments {
int "randomInt" [=[ {} ]=],
floatPtr "x" [=[ {} ]=],
floatPtr "y" [=[ {} ]=],
floatPtr "z" [=[ {} ]=],
}
alias "0x280C7E3AC7F56E90"
ns "PED"
returns "void"
doc [[!
]]
native "SPAWNPOINTS_GET_SEARCH_RESULT_FLAGS"
hash "0xB782F8238512BAD5"
jhash (0xBA699DDF)
arguments {
Any "p0" [=[ {} ]=],
AnyPtr "p1" [=[ {} ]=],
}
alias "0xB782F8238512BAD5"
ns "PED"
returns "void"
doc [[!
]]
native "SPAWNPOINTS_IS_SEARCH_ACTIVE"
hash "0x3C67506996001F5E"
jhash (0x814A28F4)
alias "0x3C67506996001F5E"
ns "PED"
returns "BOOL"
doc [[!
]]
native "SPAWNPOINTS_IS_SEARCH_COMPLETE"
hash "0xA586FBEB32A53DBB"
jhash (0x0B60D2BA)
alias "0xA586FBEB32A53DBB"
ns "PED"
returns "BOOL"
doc [[!
]]
native "SPAWNPOINTS_IS_SEARCH_FAILED"
hash "0xF445DE8DA80A1792"
jhash (0x6B83ABDF)
alias "0xF445DE8DA80A1792"
ns "PED"
returns "BOOL"
doc [[!
]]
native "SPAWNPOINTS_START_SEARCH"
hash "0x2DF9038C90AD5264"
jhash (0x909A1D76)
arguments {
float "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
float "p4" [=[ {} ]=],
int "interiorFlags" [=[ {} ]=],
float "scale" [=[ {} ]=],
int "duration" [=[ {} ]=],
}
alias "0x2DF9038C90AD5264"
ns "PED"
returns "void"
doc [[!
]]
native "SPAWNPOINTS_START_SEARCH_IN_ANGLED_AREA"
hash "0xB2AFF10216DEFA2F"
jhash (0x4AAD0ECB)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "p3" [=[ {} ]=],
float "p4" [=[ {} ]=],
float "p5" [=[ {} ]=],
float "p6" [=[ {} ]=],
int "interiorFlags" [=[ {} ]=],
float "scale" [=[ {} ]=],
int "duration" [=[ {} ]=],
}
alias "0xB2AFF10216DEFA2F"
ns "PED"
returns "void"
doc [[!
]]
native "SPECIAL_FUNCTION_DO_NOT_USE"
hash "0xF9ACF4A08098EA25"
jhash (0x141CC936)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "noCollisionUntilClear" [=[ {} ]=],
}
alias "0xF9ACF4A08098EA25"
ns "PED"
returns "void"
doc [[!
Kicks the ped from the current vehicle and keeps the rendering-focus on this ped (also disables its collision). If doing this for your player ped, you'll still be able to drive the vehicle.\
Only to be used in very specific situations where the ped needs to be inside the car still but not attached.
]]
native "STOP_ANY_PED_MODEL_BEING_SUPPRESSED"
hash "0xB47BD05FA66B40CF"
jhash (0x5AD7DC55)
ns "PED"
returns "void"
doc [[!
]]
native "STOP_PED_WEAPON_FIRING_WHEN_DROPPED"
hash "0xC158D28142A34608"
jhash (0x4AC3421E)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "TAKE_OWNERSHIP_OF_SYNCHRONIZED_SCENE"
hash "0xCD9CC7E200A52A6F"
jhash (0xBF7F9035)
arguments {
int "scene" [=[ {} ]=],
}
alias "0xCD9CC7E200A52A6F"
alias "_DISPOSE_SYNCHRONIZED_SCENE"
ns "PED"
returns "void"
doc [[!
Scene ID returned by [`CREATE_SYNCHRONIZED_SCENE`](#\_0x8C18E0F9080ADD73)
]]
native "UNREGISTER_PEDHEADSHOT"
hash "0x96B1361D9B24C2FF"
jhash (0x0879AE45)
arguments {
int "id" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
gtaforums.com/topic/885580-ped-headshotmugshot-txd/
```
]]
native "UPDATE_PED_HEAD_BLEND_DATA"
hash "0x723538F61C647C5A"
jhash (0x5CB76219)
arguments {
Ped "ped" [=[ {} ]=],
float "shapeMix" [=[ {} ]=],
float "skinMix" [=[ {} ]=],
float "thirdMix" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
See [`SET_PED_HEAD_BLEND_DATA`](#\_0x9414E18B9434C2FE)
]]
native "WAS_PED_KILLED_BY_STEALTH"
hash "0xF9800AA1A771B000"
jhash (0x2EA4B54E)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
Verifies whether ped was eliminated through stealth.
Ped index
]]
native "WAS_PED_KILLED_BY_TAKEDOWN"
hash "0x7F08E26039C7347C"
jhash (0xBDD3CE69)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "WAS_PED_KNOCKED_OUT"
hash "0x61767F73EACEED21"
jhash (0x3993092B)
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0x61767F73EACEED21"
ns "PED"
returns "BOOL"
doc [[!
]]
native "WAS_PED_SKELETON_UPDATED"
hash "0x11B499C1E0FF8559"
jhash (0xF7E2FBAD)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
```
Despite this function's name, it simply returns whether the specified handle is a Ped.
```
]]
native "_BLOCK_PED_DEAD_BODY_SHOCKING_EVENTS"
hash "0xE43A13C9E4CCCBCF"
jhash (0xFF1F6AEB)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0xE43A13C9E4CCCBCF"
ns "PED"
returns "void"
doc [[!
]]
native "_CLEAR_FACIAL_CLIPSET_OVERRIDE"
hash "0x637822DC2AFEEBF8"
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0x637822DC2AFEEBF8"
ns "PED"
returns "void"
doc [[!
```
NativeDB Introduced: v1493
```
]]
native "_CLEAR_PED_COVER_CLIPSET_OVERRIDE"
hash "0xC79196DCB36F6121"
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0xC79196DCB36F6121"
ns "PED"
returns "void"
doc [[!
```
CLEAR_PED_*
```
]]
native "_CLONE_PED_EX"
hash "0x668FD40BCBA5DE48"
arguments {
Ped "ped" [=[ {} ]=],
float "heading" [=[ {"cs_type":"Any"} ]=],
BOOL "isNetwork" [=[ {"cs_type":"Any"} ]=],
BOOL "bScriptHostPed" [=[ {"cs_type":"Any"} ]=],
Any "p4" [=[ {} ]=],
}
alias "0x668FD40BCBA5DE48"
alias "_CLONE_PED_2"
ns "PED"
returns "Ped"
doc [[!
Used one time in fmmc_launcher.c instead of CLONE_PED because ?
]]
native "_CLONE_PED_TO_TARGET_EX"
hash "0x148B08C2D2ACB884"
arguments {
Ped "ped" [=[ {} ]=],
Ped "targetPed" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
alias "0x148B08C2D2ACB884"
ns "PED"
returns "void"
doc [[!
]]
native "_CREATE_SYNCHRONIZED_SCENE_2"
hash "0x62EC273D00187DCA"
jhash (0xF3876894)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "radius" [=[ {} ]=],
Hash "object" [=[ {} ]=],
}
alias "0x62EC273D00187DCA"
ns "PED"
returns "int"
doc [[!
]]
native "_DOES_RELATIONSHIP_GROUP_EXIST"
hash "0xCC6E3B6BB69501F1"
arguments {
Hash "groupHash" [=[ {"cs_type":"Any"} ]=],
}
alias "0xCC6E3B6BB69501F1"
ns "PED"
returns "BOOL"
doc [[!
]]
native "_DOES_SCENARIO_BLOCKING_AREA_EXIST"
hash "0x8A24B067D175A7BD"
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
}
alias "0x8A24B067D175A7BD"
ns "PED"
returns "BOOL"
doc [[!
]]
native "_FREEZE_PED_CAMERA_ROTATION"
hash "0xFF287323B0E2C69A"
jhash (0x290421BE)
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0xFF287323B0E2C69A"
ns "PED"
returns "void"
doc [[!
]]
native "_GET_NUM_HAIR_COLORS"
hash "0xE5C0CF872C2AD150"
ns "PED"
returns "int"
doc [[!
```
Used for freemode (online) characters.
```
]]
native "_GET_NUM_MAKEUP_COLORS"
hash "0xD1F7CA1535D22818"
alias "0xD1F7CA1535D22818"
ns "PED"
returns "int"
doc [[!
]]
native "_GET_PED_CURRENT_MOVEMENT_SPEED"
hash "0xF60165E1D2C5370B"
arguments {
Ped "ped" [=[ {} ]=],
floatPtr "speedX" [=[ {} ]=],
floatPtr "speedY" [=[ {} ]=],
}
alias "0xF60165E1D2C5370B"
ns "PED"
returns "BOOL"
doc [[!
]]
native "_GET_PED_DIES_IN_WATER"
hash "0x65671A4FB8218930"
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
```
NativeDB Introduced: v2699
```
]]
native "_GET_PED_EMISSIVE_INTENSITY"
hash "0x1461B28A06717D68"
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0x1461B28A06717D68"
alias "_GET_PED_ILLUMINATED_CLOTHING_GLOW_INTENSITY"
ns "PED"
returns "float"
doc [[!
Use [`SetPedIlluminatedClothingGlowIntensity`](#\_0x4E90D746056E273D) to set the illuminated clothing glow intensity for a specific ped.
The ped to get the glow intensity from.
A float between 0.0 and 1.0 representing the current illuminated clothing glow intensity.
]]
native "_GET_PED_EVENT_DATA"
hash "0xBA656A3BB01BDEA3"
arguments {
Ped "ped" [=[ {} ]=],
int "eventType" [=[ {} ]=],
AnyPtr "outData" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
```
NativeDB Introduced: v2189
```
]]
native "_GET_PED_EYE_COLOR"
hash "0x76BBA2CEE66D47E9"
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0x76BBA2CEE66D47E9"
ns "PED"
returns "int"
doc [[!
A getter for [`_SET_PED_EYE_COLOR`](#\_0x50B56988B170AFDF).
The target ped
Returns ped's eye colour, or -1 if fails to get.
]]
native "_GET_PED_HAIR_RGB_COLOR"
hash "0x4852FC386E2E1BB5"
arguments {
int "hairColorIndex" [=[ {} ]=],
intPtr "outR" [=[ {} ]=],
intPtr "outG" [=[ {} ]=],
intPtr "outB" [=[ {} ]=],
}
alias "0x4852FC386E2E1BB5"
alias "_GET_HAIR_RGB_COLOR"
ns "PED"
returns "void"
doc [[!
Input: Haircolor index, value between 0 and 63 (inclusive).
Output: RGB values for the haircolor specified in the input.
This is used with the hair color swatches scaleform.
Use [`_0x013E5CFC38CD5387`](#\_0x013E5CFC38CD5387) to get the makeup colors.
The hair color index. Value between 0-63 (inclusive).
Output red value.
Output green value.
Output blue value.
]]
native "_GET_PED_HEAD_OVERLAY_VALUE"
hash "0xA60EF3B6461A4D43"
arguments {
Ped "ped" [=[ {} ]=],
int "overlayID" [=[ {} ]=],
}
ns "PED"
returns "int"
doc [[!
```
Likely a char, if that overlay is not set, e.i. "None" option, returns 255;
This might be the once removed native GET_PED_HEAD_OVERLAY.
```
]]
native "_GET_PED_MAKEUP_RGB_COLOR"
hash "0x013E5CFC38CD5387"
arguments {
int "makeupColorIndex" [=[ {} ]=],
intPtr "outR" [=[ {} ]=],
intPtr "outG" [=[ {} ]=],
intPtr "outB" [=[ {} ]=],
}
alias "0x013E5CFC38CD5387"
alias "_GET_MAKEUP_RGB_COLOR"
ns "PED"
returns "void"
doc [[!
Input: Makeup color index, value between 0 and 63 (inclusive).
Output: RGB values for the makeup color specified in the input.
This is used with the makeup color swatches scaleform.
Use [`_0x4852FC386E2E1BB5`](#\_0x4852FC386E2E1BB5) to get the hair colors.
The hair color index. Value between 0-63 (inclusive).
Output red value.
Output green value.
Output blue value.
]]
native "_GET_PED_TASK_COMBAT_TARGET"
hash "0x32C27A11307B01CC"
arguments {
Ped "ped" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
alias "0x32C27A11307B01CC"
ns "PED"
returns "Entity"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "_GET_PED_VISUAL_FIELD_CENTER_ANGLE"
hash "0xEF2C71A32CAD5FBD"
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "float"
doc [[!
```
NativeDB Introduced: v1493
```
]]
native "_GET_TIME_OF_LAST_PED_WEAPON_DAMAGE"
hash "0x36B77BB84687C318"
jhash (0x0170C6E1)
arguments {
Ped "ped" [=[ {} ]=],
Hash "weaponHash" [=[ {"cs_type":"Any"} ]=],
}
alias "0x36B77BB84687C318"
ns "PED"
returns "int"
doc [[!
```
GET_TIME_*
```
]]
native "_IS_PED_BLUSH_COLOR_VALID"
hash "0x604E810189EE3A59"
arguments {
int "colorID" [=[ {} ]=],
}
alias "0x604E810189EE3A59"
ns "PED"
returns "BOOL"
doc [[!
]]
native "_IS_PED_BLUSH_COLOR_VALID_2"
hash "0xF41B5D290C99A3D6"
arguments {
int "colorId" [=[ {} ]=],
}
alias "0xF41B5D290C99A3D6"
ns "PED"
returns "BOOL"
doc [[!
]]
native "_IS_PED_BODY_BLEMISH_VALID"
hash "0x09E7ECA981D9B210"
arguments {
int "colorID" [=[ {} ]=],
}
alias "0x09E7ECA981D9B210"
ns "PED"
annotations [=[ {"cs_type":"Any"} ]=]
returns "BOOL"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "_IS_PED_DOING_BEAST_JUMP"
hash "0x451D05012CCEC234"
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0x451D05012CCEC234"
ns "PED"
returns "BOOL"
doc [[!
]]
native "_IS_PED_HAIR_COLOR_VALID"
hash "0xE0D36E5D9E99CC21"
arguments {
int "colorID" [=[ {} ]=],
}
alias "0xE0D36E5D9E99CC21"
ns "PED"
returns "BOOL"
doc [[!
]]
native "_IS_PED_HAIR_COLOR_VALID_2"
hash "0xED6D8E27A43B8CDE"
arguments {
int "colorId" [=[ {} ]=],
}
alias "0xED6D8E27A43B8CDE"
ns "PED"
returns "BOOL"
doc [[!
]]
native "_IS_PED_HELMET_UNK"
hash "0xB9496CE47546DB2C"
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0xB9496CE47546DB2C"
ns "PED"
returns "BOOL"
doc [[!
]]
native "_IS_PED_LIPSTICK_COLOR_VALID"
hash "0x0525A2C2562F3CD4"
arguments {
int "colorID" [=[ {} ]=],
}
alias "0x0525A2C2562F3CD4"
ns "PED"
returns "BOOL"
doc [[!
]]
native "_IS_PED_LIPSTICK_COLOR_VALID_2"
hash "0x3E802F11FBE27674"
arguments {
int "colorId" [=[ {} ]=],
}
alias "0x3E802F11FBE27674"
ns "PED"
returns "BOOL"
doc [[!
]]
native "_IS_PED_OPENING_A_DOOR"
hash "0x26AF0E8E30BD2A2C"
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0x26AF0E8E30BD2A2C"
ns "PED"
returns "BOOL"
doc [[!
```
IS_PED_*
Returns true if the ped is currently opening a door (CTaskOpenDoor).
```
]]
native "_IS_PED_SHADER_EFFECT_VALID"
hash "0x81AA517FBBA05D39"
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0x81AA517FBBA05D39"
ns "PED"
returns "BOOL"
doc [[!
]]
native "_IS_PED_SWAPPING_WEAPON"
hash "0x3795688A307E1EB6"
arguments {
Ped "Ped" [=[ {} ]=],
}
alias "0x3795688A307E1EB6"
ns "PED"
returns "BOOL"
doc [[!
]]
native "_IS_SCUBA_GEAR_LIGHT_ENABLED"
hash "0x88274C11CF0D866D"
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
```
NativeDB Introduced: v1493
```
]]
native "_REGISTER_PEDHEADSHOT_3"
hash "0xBA8805A1108A2515"
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0xBA8805A1108A2515"
ns "PED"
returns "int"
doc [[!
]]
native "_SET_BLOCK_AMBIENT_PEDS_FROM_DROPPING_WEAPONS_THIS_FRAME"
hash "0xC73EFFC5E043A8BA"
ns "PED"
returns "void"
doc [[!
Prevents ambient peds from dropping their weapons for the current frame.
```
NativeDB Introduced: v3258
```
]]
native "_SET_ENABLE_SCUBA_GEAR_LIGHT"
hash "0xEE2476B9EE4A094F"
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
NativeDB Introduced: v1493
```
]]
native "_SET_FACIAL_CLIPSET_OVERRIDE"
hash "0x5687C7F05B39E401"
arguments {
Ped "ped" [=[ {} ]=],
charPtr "animDict" [=[ {} ]=],
}
alias "0x5687C7F05B39E401"
ns "PED"
returns "void"
doc [[!
Clipsets:
"facials@gen_female@base"
"facials@gen_male@base"
"facials@p_m_zero@base"
Typically followed with [SET_FACIAL_IDLE_ANIM_OVERRIDE](#\_0xFFC24B988B938B38):
"mood_drunk\_1"
"mood_stressed\_1"
"mood_happy\_1"
"mood_talking\_1"
```
NativeDB Introduced: v1493
```
]]
native "_SET_PED_CAN_PLAY_INJURED_ANIMS"
hash "0x33A60D8BDD6E508C"
jhash (0xADB2511A)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
alias "0x33A60D8BDD6E508C"
ns "PED"
returns "void"
doc [[!
]]
native "_SET_PED_COVER_CLIPSET_OVERRIDE"
hash "0x9DBA107B4937F809"
arguments {
Ped "ped" [=[ {} ]=],
charPtr "p1" [=[ {} ]=],
}
alias "0x9DBA107B4937F809"
ns "PED"
returns "void"
doc [[!
```
Found in the b617d scripts:
PED::_9DBA107B4937F809(v_7, "trevor_heist_cover_2h");
SET_PED_MO*
```
]]
native "_SET_PED_EMISSIVE_INTENSITY"
hash "0x4E90D746056E273D"
arguments {
Ped "ped" [=[ {} ]=],
float "intensity" [=[ {} ]=],
}
alias "0x4E90D746056E273D"
alias "_SET_PED_ILLUMINATED_CLOTHING_GLOW_INTENSITY"
ns "PED"
returns "void"
doc [[!
This native sets the glow intensity of illuminated clothing items.
This native does **NOT** need to be executed every tick.
This native is **NOT** synced with other connected players, you will have to set the opacity on the ped on all clients individually.
Glow intensity is a value between `0.0` and `1.0`.
In some older decompiled scripts this is known as `_SET_PED_REFLECTION_INTENSITY`.
Since there's no joaat hash for this, I find `_SET_PED_ILLUMINATED_CLOTHING_GLOW_INTENSITY` more descriptive than `_SET_PED_REFLECTION_INTENSITY`.
Use [`GetPedIlluminatedClothingGlowIntensity`](#\_0x1461B28A06717D68) to get the illuminated clothing glow intensity of a specific ped.
Intensity: `1.0`:

Intensity: `0.0`:

**Examples code result**:

(Direct link if embed doesn't work: [here](https://www.vespura.com/hi/i/2018-11-13\_17-11\_10199\_232.gif))
The ped to set the glow intensity on.
The glow intensity, value between `0.0` and `1.0`.
]]
native "_SET_PED_EYE_COLOR"
hash "0x50B56988B170AFDF"
arguments {
Ped "ped" [=[ {} ]=],
int "index" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
Used for freemode (online) characters.
Indices:
1. black
2. very light blue/green
3. dark blue
4. brown
5. darker brown
6. light brown
7. blue
8. light blue
9. pink
10. yellow
11. purple
12. black
13. dark green
14. light brown
15. yellow/black pattern
16. light colored spiral pattern
17. shiny red
18. shiny half blue/half red
19. half black/half light blue
20. white/red perimter
21. green snake
22. red snake
23. dark blue snake
24. dark yellow
25. bright yellow
26. all black
27. red small pupil
28. devil blue/black
29. white small pupil
30. glossed over
]]
native "_SET_PED_FACE_FEATURE"
hash "0x71A5C1DBA060049E"
arguments {
Ped "ped" [=[ {} ]=],
int "index" [=[ {} ]=],
float "scale" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
Sets the various freemode face features, e.g. nose length, chin shape.
**Indexes (From 0 to 19):**
Parentheses indicate morph scale/direction as in (-1.0 to 1.0)
* **0**: Nose Width (Thin/Wide)
* **1**: Nose Peak (Up/Down)
* **2**: Nose Length (Long/Short)
* **3**: Nose Bone Curveness (Crooked/Curved)
* **4**: Nose Tip (Up/Down)
* **5**: Nose Bone Twist (Left/Right)
* **6**: Eyebrow (Up/Down)
* **7**: Eyebrow (In/Out)
* **8**: Cheek Bones (Up/Down)
* **9**: Cheek Sideways Bone Size (In/Out)
* **10**: Cheek Bones Width (Puffed/Gaunt)
* **11**: Eye Opening (Both) (Wide/Squinted)
* **12**: Lip Thickness (Both) (Fat/Thin)
* **13**: Jaw Bone Width (Narrow/Wide)
* **14**: Jaw Bone Shape (Round/Square)
* **15**: Chin Bone (Up/Down)
* **16**: Chin Bone Length (In/Out or Backward/Forward)
* **17**: Chin Bone Shape (Pointed/Square)
* **18**: Chin Hole (Chin Bum)
* **19**: Neck Thickness (Thin/Thick)
**Note:**
You may need to call [`SetPedHeadBlendData`](#\_0x9414E18B9434C2FE) prior to calling this native in order for it to work.
The ped entity
An integer ranging from 0 to 19
A float ranging from -1.0 to 1.0
]]
native "_SET_PED_HEAD_OVERLAY_COLOR"
hash "0x497BF74A7B9CB952"
arguments {
Ped "ped" [=[ {} ]=],
int "overlayID" [=[ {} ]=],
int "colorType" [=[ {} ]=],
int "colorID" [=[ {} ]=],
int "secondColorID" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
Used for freemode (online) characters.
Called after SET_PED_HEAD_OVERLAY().
```
**Note:**
You may need to call [`SetPedHeadBlendData`](#\_0x9414E18B9434C2FE) prior to calling this native in order for it to work.
The ped entity
An integer representing the overlay id
1 for eyebrows, beards, makeup, and chest hair; 2 for blush and lipstick; and 0 otherwise, though not called in those cases.
An integer representing the primary color id
An integer representing the secondary color id
]]
native "_SET_PED_HELMET_UNK"
hash "0x3F7325574E41B44D"
arguments {
Ped "ped" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
int "p2" [=[ {} ]=],
int "p3" [=[ {} ]=],
}
alias "0x3F7325574E41B44D"
ns "PED"
returns "void"
doc [[!
]]
native "_SET_PED_SCUBA_GEAR_VARIATION"
hash "0x36C6984C3ED0C911"
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0x36C6984C3ED0C911"
ns "PED"
returns "void"
doc [[!
This native sets a scuba mask for freemode models and an oxygen bottle for player_\* models. It works on freemode and player_\* models.
]]
native "_SET_PED_SHOULD_PLAY_DIRECTED_SCENARIO_EXIT"
hash "0xEC6935EBE0847B90"
jhash (0x761F8F48)
arguments {
Ped "ped" [=[ {} ]=],
float "x" [=[ {"cs_type":"Any"} ]=],
float "y" [=[ {"cs_type":"Any"} ]=],
float "z" [=[ {"cs_type":"Any"} ]=],
}
alias "0xEC6935EBE0847B90"
ns "PED"
annotations [=[ {"cs_type":"Any"} ]=]
returns "BOOL"
doc [[!
When this ped receives its next script task, they will exit from their scenario using the normal scenario exit.
Exiting the scenario may take several frames while the ped is playing the exit animation.
If the ped is not currently using a scenario at the time of the command or 0,0,0 is specified as the reaction position,
then the ped will by default attempt to direct their exit forwards.
the ped who should play a normal (unhurried) exit the next time they are given a script command.
X Coordinate.
Y Coordinate.
Z Coordinate.
Returns true if the position was successfully set.
]]
native "_SET_PED_SURVIVES_BEING_OUT_OF_WATER"
hash "0x100CD221F572F6E1"
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
Allows marine animals to survive outside of water (R\* is using it for sharks).
```
NativeDB Introduced: v3407
```
The marine animal ped
`true` to allow survival out of water, `false` to apply normal water restrictions.
Returns `true` if successful.
]]
native "_SET_RELATIONSHIP_GROUP_DONT_AFFECT_WANTED_LEVEL"
hash "0x5615E0C5EB2BC6E2"
arguments {
Hash "group" [=[ {"cs_type":"Any"} ]=],
BOOL "p1" [=[ {} ]=],
}
alias "0x5615E0C5EB2BC6E2"
ns "PED"
returns "void"
doc [[!
]]
native "0x03EA03AF85A85CB7"
hash "0x03EA03AF85A85CB7"
jhash (0x18DD76A1)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
BOOL "p4" [=[ {} ]=],
BOOL "p5" [=[ {} ]=],
BOOL "p6" [=[ {} ]=],
BOOL "p7" [=[ {} ]=],
Any "p8" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "0x06087579E7AA85A9"
hash "0x06087579E7AA85A9"
jhash (0xD0567D41)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
float "p4" [=[ {} ]=],
float "p5" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "0x061CB768363D6424"
hash "0x061CB768363D6424"
jhash (0x7DA12905)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "0x0B3E35AC043707D9"
hash "0x0B3E35AC043707D9"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "0x0F62619393661D6E"
hash "0x0F62619393661D6E"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "0x110F526AB784111F"
hash "0x110F526AB784111F"
jhash (0x3B882533)
arguments {
Ped "ped" [=[ {} ]=],
float "p1" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
In agency_heist3b.c4, its like this 90% of the time:
PED::_110F526AB784111F(ped, 0.099);
PED::SET_PED_ENVEFF_SCALE(ped, 1.0);
PED::_D69411AA0CEBF9E9(ped, 87, 81, 68);
PED::SET_ENABLE_PED_ENVEFF_SCALE(ped, 1);
and its like this 10% of the time:
PED::_110F526AB784111F(ped, 0.2);
PED::SET_PED_ENVEFF_SCALE(ped, 0.65);
PED::_D69411AA0CEBF9E9(ped, 74, 69, 60);
PED::SET_ENABLE_PED_ENVEFF_SCALE(ped, 1);
```
]]
native "0x1216E0BFA72CC703"
hash "0x1216E0BFA72CC703"
jhash (0x7BD26837)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
**This native does absolutely nothing, just a nullsub**
]]
native "0x1A330D297AAC6BC1"
hash "0x1A330D297AAC6BC1"
jhash (0x77BB7CB8)
arguments {
Ped "ped" [=[ {} ]=],
int "p1" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
Only appears in lamar1 script.
```
]]
native "0x1E77FA7A62EE6C4C"
hash "0x1E77FA7A62EE6C4C"
jhash (0x021F5B36)
arguments {
Any "p0" [=[ {} ]=],
}
ns "PED"
returns "Any"
doc [[!
```
GET_*
```
]]
native "0x2016C603D6B8987C"
hash "0x2016C603D6B8987C"
jhash (0xA6F2C057)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
SET_PED_STE*
```
]]
native "0x25361A96E0F7E419"
hash "0x25361A96E0F7E419"
jhash (0x58C0F6CF)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "PED"
returns "Any"
doc [[!
]]
native "0x2735233A786B1BEF"
hash "0x2735233A786B1BEF"
jhash (0x373CC405)
arguments {
Ped "ped" [=[ {} ]=],
float "p1" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "0x288DF530C92DAD6F"
hash "0x288DF530C92DAD6F"
arguments {
Ped "ped" [=[ {} ]=],
float "value" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
[`SET_VEHICLE_STEER_BIAS`](#\_0x42A8EC77D5150CBE) for peds, e.g., `_SET_PED_STEER_BIAS`.
]]
native "0x2B694AFCF64E6994"
hash "0x2B694AFCF64E6994"
arguments {
Ped "ped" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "0x2DFC81C9B9608549"
hash "0x2DFC81C9B9608549"
arguments {
Ped "ped" [=[ {} ]=],
intPtr "p1" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "0x2F074C904D85129E"
hash "0x2F074C904D85129E"
arguments {
float "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
float "p4" [=[ {} ]=],
float "p5" [=[ {} ]=],
float "p6" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "0x2F3C3D9F50681DE4"
hash "0x2F3C3D9F50681DE4"
jhash (0xCC9D7F1A)
arguments {
Any "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "0x336B3D200AB007CB"
hash "0x336B3D200AB007CB"
jhash (0xFB18CB19)
arguments {
Any "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
float "p4" [=[ {} ]=],
}
ns "PED"
returns "Any"
doc [[!
]]
native "0x3E9679C1DFCF422C"
hash "0x3E9679C1DFCF422C"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "0x412F1364FA066CFB"
hash "0x412F1364FA066CFB"
arguments {
Any "p0" [=[ {} ]=],
}
ns "PED"
returns "Any"
doc [[!
]]
native "0x425AECF167663F48"
hash "0x425AECF167663F48"
jhash (0x5BC276AE)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "0x46B05BCAE43856B0"
hash "0x46B05BCAE43856B0"
jhash (0x79543043)
arguments {
Ped "ped" [=[ {} ]=],
int "flag" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
```
Checks if the specified unknown flag is set in the ped's model.
The engine itself seems to exclusively check for flags 1 and 4 (Might be inlined code of the check that checks for other flags).
Game scripts exclusively check for flags 1 and 4.
```
]]
native "0x49E50BDB8BA4DAB2"
hash "0x49E50BDB8BA4DAB2"
jhash (0x397F06E3)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
SET_PED_ALLOW*
```
]]
native "0x511F1A683387C7E2"
hash "0x511F1A683387C7E2"
jhash (0x5B1B70AA)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "int"
doc [[!
```
GET_*
```
]]
native "0x5407B7288D0478B7"
hash "0x5407B7288D0478B7"
jhash (0xEF0B78E6)
arguments {
Any "p0" [=[ {} ]=],
}
ns "PED"
returns "int"
doc [[!
]]
native "0x5A7F62FDA59759BD"
hash "0x5A7F62FDA59759BD"
jhash (0xB48C0C04)
ns "PED"
returns "void"
doc [[!
]]
native "0x5B6010B3CBC29095"
hash "0x5B6010B3CBC29095"
arguments {
Any "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "0x711794453CFD692B"
hash "0x711794453CFD692B"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "0x733C87D4CE22BEA2"
hash "0x733C87D4CE22BEA2"
jhash (0x43709044)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "0x75BA1CB3B7D40CAF"
hash "0x75BA1CB3B7D40CAF"
jhash (0x9194DB71)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
REQUEST_*
```
]]
native "0x80054D7FCC70EEC6"
hash "0x80054D7FCC70EEC6"
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
CLEAR_PED_*
```
]]
native "0x820E9892A77E97CD"
hash "0x820E9892A77E97CD"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "0x87DDEB611B329A9C"
hash "0x87DDEB611B329A9C"
arguments {
float "multiplier" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
SET_A*
```
]]
native "0x9911F4A24485F653"
hash "0x9911F4A24485F653"
jhash (0x02A080C8)
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "0x9A77DFD295E29B09"
hash "0x9A77DFD295E29B09"
jhash (0xC08FE5F6)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "0x9C6A6C19B6C0C496"
hash "0x9C6A6C19B6C0C496"
arguments {
Ped "ped" [=[ {} ]=],
intPtr "p1" [=[ {"cs_type":"AnyPtr"} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "0x9E30E91FB03A2CAF"
hash "0x9E30E91FB03A2CAF"
jhash (0x52559BB6)
arguments {
AnyPtr "p0" [=[ {} ]=],
AnyPtr "p1" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "0xA3F3564A5B3646C0"
hash "0xA3F3564A5B3646C0"
jhash (0x97353375)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
```
Only called once in the scripts:
if (sub_1abd() && (!PED::_A3F3564A5B3646C0(l_8C))) {
if (sub_52e3("RESNA_CELLR", 0)) {
PED::SET_PED_CAN_PLAY_GESTURE_ANIMS(l_8C, 1);
PED::SET_PED_CAN_PLAY_AMBIENT_ANIMS(l_8C, 1);
PED::SET_PED_CAN_PLAY_VISEME_ANIMS(l_8C, 1, 0);
l_184 += 1;
}
}
Checks something related to the mobile phone task.
IS_*
```
]]
native "0xA52D5247A4227E14"
hash "0xA52D5247A4227E14"
jhash (0xB52BA5F5)
arguments {
Any "p0" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "0xA660FAF550EB37E5"
hash "0xA660FAF550EB37E5"
arguments {
Any "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "0xA9B61A329BFDCBEA"
hash "0xA9B61A329BFDCBEA"
jhash (0x2276DE0D)
arguments {
Any "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "0xAAA6A3698A69E048"
hash "0xAAA6A3698A69E048"
arguments {
Any "p0" [=[ {} ]=],
}
ns "PED"
returns "Any"
doc [[!
]]
native "0xAD27D957598E49E9"
hash "0xAD27D957598E49E9"
arguments {
Ped "ped" [=[ {} ]=],
Any "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
Hash "hash" [=[ {"cs_type":"Any"} ]=],
Any "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "0xAFC976FD0580C7B3"
hash "0xAFC976FD0580C7B3"
jhash (0x1572022A)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
SET_PED_*
```
]]
native "0xB282749D5E028163"
hash "0xB282749D5E028163"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
**This native does absolutely nothing, just a nullsub**
]]
native "0xB3352E018D6F89DF"
hash "0xB3352E018D6F89DF"
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
_SET_PED_HEAD_* - _SET_PED_HEARING_*
_SET_PED_HEALTH_...
```
```
NativeDB Introduced: v2699
```
]]
native "0xB8B52E498014F5B0"
hash "0xB8B52E498014F5B0"
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
]]
native "0xC2EE020F5FB4DB53"
hash "0xC2EE020F5FB4DB53"
jhash (0xB7CD0A49)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "0xC30BDAEE47256C13"
hash "0xC30BDAEE47256C13"
arguments {
Any "p0" [=[ {} ]=],
}
ns "PED"
returns "Any"
doc [[!
```
NativeDB Introduced: v1868
```
]]
native "0xC56FBF2F228E1DAC"
hash "0xC56FBF2F228E1DAC"
arguments {
Hash "modelHash" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
ns "PED"
returns "Any"
doc [[!
]]
native "0xCD018C591F94CB43"
hash "0xCD018C591F94CB43"
arguments {
Ped "ped" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
REQUEST_*
```
]]
native "0xCEDA60A74219D064"
hash "0xCEDA60A74219D064"
arguments {
Any "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "0xD33DAA36272177C4"
hash "0xD33DAA36272177C4"
jhash (0xA89A53F2)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "0xDFE68C4B787E1BFB"
hash "0xDFE68C4B787E1BFB"
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
NativeDB Introduced: v1180
```
]]
native "0xE906EC930F5FE7C8"
hash "0xE906EC930F5FE7C8"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
]]
native "0xEA9960D07DADCF10"
hash "0xEA9960D07DADCF10"
arguments {
Any "p0" [=[ {} ]=],
}
ns "PED"
returns "int"
doc [[!
]]
native "0xEC4B4B3B9908052A"
hash "0xEC4B4B3B9908052A"
jhash (0xF30658D2)
arguments {
Ped "ped" [=[ {} ]=],
float "unk" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
SET_PED_*
Has most likely to do with some shooting attributes as it sets the float which is in the same range as shootRate.
```
]]
native "0xED3C76ADFA6D07C4"
hash "0xED3C76ADFA6D07C4"
jhash (0xFB4000DC)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
FORCE_*
```
]]
native "0xF033419D1B81FAE8"
hash "0xF033419D1B81FAE8"
jhash (0x8FDDB5DB)
arguments {
Any "p0" [=[ {} ]=],
}
ns "PED"
returns "Any"
doc [[!
```
GET_*
```
]]
native "0xF2385935BFFD4D92"
hash "0xF2385935BFFD4D92"
jhash (0xFFF149FE)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
Initial guess of native: `_IS_PED_WEARING_MOTORCYCLE_HELMET`.
]]
native "0xF2BEBCDFAFDAA19E"
hash "0xF2BEBCDFAFDAA19E"
jhash (0x6CD58238)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
SET_PED_ALLOW*
toggle was always false except in one instance (b678).
The one time this is set to true seems to do with when you fail the mission.
```
]]
native "0xFAB944D4D481ACCB"
hash "0xFAB944D4D481ACCB"
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
SET_A\*
```
NativeDB Introduced: v1734
```
]]
native "0xFD325494792302D7"
hash "0xFD325494792302D7"
jhash (0x7F67671D)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "SET_TIME_EXCLUSIVE_DISPLAY_TEXTURE"
ns "PED"
returns "void"
doc [[!
]]
native "0xFEC9A3B1820F3331"
hash "0xFEC9A3B1820F3331"
arguments {
Ped "ped" [=[ {} ]=],
}
ns "PED"
returns "BOOL"
doc [[!
Native to check whether [`_SET_PED_SCUBA_GEAR_VARIATION`](#\_0x36C6984C3ED0C911) is enabled/actived.
]]
native "0xFF4803BC019852D9"
hash "0xFF4803BC019852D9"
jhash (0xD41C9AED)
arguments {
float "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "PED"
returns "void"
doc [[!
```
Related to Peds dropping pickup_health_snack; p0 is a value between [0.0, 1.0] that corresponds to drop rate
```
]]
native "CEIL"
hash "0x11E019C8F43ACC8A"
jhash (0xD536A1DF)
arguments {
float "value" [=[ {} ]=],
}
ns "SYSTEM"
returns "int"
doc [[!
```
I'm guessing this rounds a float value up to the next whole number, and FLOOR rounds it down
```
]]
native "COS"
hash "0xD0FFB162F40A139C"
jhash (0x00238FE9)
arguments {
float "value" [=[ {} ]=],
}
ns "SYSTEM"
returns "float"
doc [[!
Returns the cosine of the given number.
The number of degrees (in degrees, not radians)
The cosine of the given number
]]
native "FLOOR"
hash "0xF34EE736CF047844"
jhash (0x32E9BE04)
arguments {
float "value" [=[ {} ]=],
}
ns "SYSTEM"
returns "int"
doc [[!
]]
native "POW"
hash "0xE3621CC40F31FE2E"
jhash (0x85D134F8)
arguments {
float "base" [=[ {} ]=],
float "exponent" [=[ {} ]=],
}
ns "SYSTEM"
returns "float"
doc [[!
]]
native "ROUND"
hash "0xF2DB717A73826179"
jhash (0x323B0E24)
arguments {
float "value" [=[ {} ]=],
}
ns "SYSTEM"
returns "int"
doc [[!
]]
native "SETTIMERA"
hash "0xC1B1E9A034A63A62"
jhash (0x35785333)
arguments {
int "value" [=[ {} ]=],
}
ns "SYSTEM"
returns "void"
doc [[!
Sets the value for the timer A in milliseconds
In milliseconds.
]]
native "SETTIMERB"
hash "0x5AE11BC36633DE4E"
jhash (0x27C1B7C6)
arguments {
int "value" [=[ {} ]=],
}
ns "SYSTEM"
returns "void"
doc [[!
Sets the value for the timer B in milliseconds
In milliseconds.
]]
native "SHIFT_LEFT"
hash "0xEDD95A39E5544DE8"
jhash (0x314CC6CD)
arguments {
int "value" [=[ {} ]=],
int "bitShift" [=[ {} ]=],
}
ns "SYSTEM"
returns "int"
doc [[!
Left bit shifts a value.
It is advised you use the `<<` operator instead of this native. It does the same and is faster.
]]
native "SHIFT_RIGHT"
hash "0x97EF1E5BCE9DC075"
jhash (0x352633CA)
arguments {
int "value" [=[ {} ]=],
int "bitShift" [=[ {} ]=],
}
ns "SYSTEM"
returns "int"
doc [[!
Right bit shifts a value.
It is advised you use the `>>` operator instead of this native. It does the same and is faster.
]]
native "SIN"
hash "0x0BADBFA3B172435F"
jhash (0xBF987F58)
arguments {
float "value" [=[ {} ]=],
}
ns "SYSTEM"
returns "float"
doc [[!
Returns the sine of the given number.
The number of degrees (in degrees, not radians)
The sine of the given number
]]
native "SQRT"
hash "0x71D93B57D07F9804"
jhash (0x145C7701)
arguments {
float "value" [=[ {} ]=],
}
ns "SYSTEM"
returns "float"
doc [[!
]]
native "START_NEW_SCRIPT"
hash "0xE81651AD79516E48"
jhash (0x3F166D0E)
arguments {
charPtr "scriptName" [=[ {} ]=],
int "stackSize" [=[ {} ]=],
}
ns "SYSTEM"
returns "int"
doc [[!
```
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
```
]]
native "START_NEW_SCRIPT_WITH_ARGS"
hash "0xB8BA7F44DF1575E1"
jhash (0x4A2100E4)
arguments {
charPtr "scriptName" [=[ {} ]=],
AnyPtr "args" [=[ {} ]=],
int "argCount" [=[ {} ]=],
int "stackSize" [=[ {} ]=],
}
ns "SYSTEM"
returns "int"
doc [[!
```
return : script thread id, 0 if failed
Pass pointer to struct of args in p1, size of struct goes into p2
```
]]
native "START_NEW_SCRIPT_WITH_NAME_HASH"
hash "0xEB1C67C3A5333A92"
jhash (0x8D15BE5D)
arguments {
Hash "scriptHash" [=[ {} ]=],
int "stackSize" [=[ {} ]=],
}
alias "_START_NEW_STREAMED_SCRIPT"
ns "SYSTEM"
returns "int"
doc [[!
]]
native "START_NEW_SCRIPT_WITH_NAME_HASH_AND_ARGS"
hash "0xC4BB298BD441BE78"
jhash (0xE38A3AD4)
arguments {
Hash "scriptHash" [=[ {} ]=],
AnyPtr "args" [=[ {} ]=],
int "argCount" [=[ {} ]=],
int "stackSize" [=[ {} ]=],
}
alias "_START_NEW_STREAMED_SCRIPT_WITH_ARGS"
ns "SYSTEM"
returns "int"
doc [[!
]]
native "TIMERA"
hash "0x83666F9FB8FEBD4B"
jhash (0x45C8C188)
ns "SYSTEM"
returns "int"
doc [[!
```
Counts up. Every 1000 is 1 real-time second. Use SETTIMERA(int value) to set the timer (e.g.: SETTIMERA(0)).
```
]]
native "TIMERB"
hash "0xC9D9444186B5A374"
jhash (0x330A9C0C)
ns "SYSTEM"
returns "int"
doc [[!
]]
native "TIMESTEP"
hash "0x0000000050597EE2"
jhash (0x50597EE2)
ns "SYSTEM"
returns "float"
doc [[!
```
Gets the current frame time.
```
]]
native "TO_FLOAT"
hash "0xBBDA792448DB5A89"
jhash (0x67116627)
arguments {
int "value" [=[ {} ]=],
}
ns "SYSTEM"
returns "float"
doc [[!
]]
native "VDIST"
hash "0x2A488C176D52CCA5"
jhash (0x3C08ECB7)
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
}
ns "SYSTEM"
returns "float"
doc [[!
Calculates the distance between two points in 3D space. For performance reasons, consider using direct mathematical calculations for distance, as they can be more efficient than calling this native function.
```
NativeDB Introduced: v323
```
X coordinate of the first point.
Y coordinate of the first point.
Z coordinate of the first point. Represents the height or elevation at the first point.
X coordinate of the second point.
Y coordinate of the second point.
Z coordinate of the second point. Represents the height or elevation at the second point.
Returns the distance as a float between the two points (`x1`, `y1`, `z1`) and (`x2`, `y2`, `z2`) in the game world.
]]
native "VDIST2"
hash "0xB7A628320EFF8E47"
jhash (0xC85DEF1F)
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
}
ns "SYSTEM"
returns "float"
doc [[!
Calculates distance between vectors but does not perform Sqrt operations. Its way faster than [`VDIST`](#\_0x2A488C176D52CCA5), but it's not faster than direct mathematical calculations.
```
NativeDB Introduced: v323
```
X coordinate of the first point.
Y coordinate of the first point.
Z coordinate of the first point. Represents the height or elevation at the first point.
X coordinate of the second point.
Y coordinate of the second point.
Z coordinate of the second point. Represents the height or elevation at the second point.
Returns the distance as a float between the two points (`x1`, `y1`, `z1`) and (`x2`, `y2`, `z2`) in the game world.
]]
native "VMAG"
hash "0x652D2EEEF1D3E62C"
jhash (0x1FCF1ECD)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
ns "SYSTEM"
returns "float"
doc [[!
```
Calculates the magnitude of a vector.
```
]]
native "VMAG2"
hash "0xA8CEACB4F35AE058"
jhash (0xE796E629)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
ns "SYSTEM"
returns "float"
doc [[!
```
Calculates the magnitude of a vector but does not perform Sqrt operations. (Its way faster)
```
]]
native "WAIT"
hash "0x4EDE34FBADD967A6"
jhash (0x7715C03B)
arguments {
int "ms" [=[ {} ]=],
}
ns "SYSTEM"
returns "void"
doc [[!
```
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
```
]]
native "_LOG10"
hash "0xE816E655DE37FE20"
arguments {
float "value" [=[ {} ]=],
}
ns "SYSTEM"
returns "float"
doc [[!
```
NativeDB Introduced: v1604
```
]]
native "_SET_THREAD_PRIORITY"
hash "0x42B65DEEF2EDF2A1"
arguments {
int "priority" [=[ {} ]=],
}
alias "0x42B65DEEF2EDF2A1"
ns "SYSTEM"
returns "void"
doc [[!
```
0 = high
1 = normal
2 = low
```
]]
native "ADD_MODEL_TO_CREATOR_BUDGET"
hash "0x0BC3144DEB678666"
jhash (0xC0E83320)
arguments {
Hash "modelHash" [=[ {} ]=],
}
alias "0x0BC3144DEB678666"
ns "STREAMING"
returns "BOOL"
doc [[!
]]
native "ALLOW_PLAYER_SWITCH_ASCENT"
hash "0x8E2A065ABDAE6994"
jhash (0x5B1E995D)
alias "0x8E2A065ABDAE6994"
ns "STREAMING"
returns "void"
doc [[!
]]
native "ALLOW_PLAYER_SWITCH_DESCENT"
hash "0xAD5FDF34B81BFE79"
jhash (0x4B4B9A13)
alias "0xAD5FDF34B81BFE79"
ns "STREAMING"
returns "void"
doc [[!
]]
native "ALLOW_PLAYER_SWITCH_OUTRO"
hash "0x74DE2E8739086740"
jhash (0x1084F2F4)
alias "0x74DE2E8739086740"
ns "STREAMING"
returns "void"
doc [[!
]]
native "ALLOW_PLAYER_SWITCH_PAN"
hash "0x43D1680C6D19A8E9"
jhash (0x55CB21F9)
alias "0x43D1680C6D19A8E9"
ns "STREAMING"
returns "void"
doc [[!
]]
native "BEGIN_SRL"
hash "0x9BADDC94EF83B823"
jhash (0x24F49427)
ns "STREAMING"
returns "void"
doc [[!
]]
native "CLEAR_FOCUS"
hash "0x31B73D1EA9F01DA2"
jhash (0x34D91E7A)
ns "STREAMING"
returns "void"
doc [[!
]]
native "CLEAR_HD_AREA"
hash "0xCE58B1CFB9290813"
jhash (0x7CAC6FA0)
ns "STREAMING"
returns "void"
doc [[!
]]
native "DISABLE_SWITCH_OUTRO_FX"
hash "0xBD605B8E0E18B3BB"
jhash (0x59CC312D)
alias "0xBD605B8E0E18B3BB"
ns "STREAMING"
returns "void"
doc [[!
]]
native "DOES_ANIM_DICT_EXIST"
hash "0x2DA49C3B79856961"
jhash (0xCD31C872)
arguments {
charPtr "animDict" [=[ {} ]=],
}
ns "STREAMING"
returns "BOOL"
doc [[!
]]
native "ENABLE_SWITCH_PAUSE_BEFORE_DESCENT"
hash "0xD4793DFF3AF2ABCD"
jhash (0x4062FF73)
alias "0xD4793DFF3AF2ABCD"
ns "STREAMING"
returns "void"
doc [[!
]]
native "END_SRL"
hash "0x0A41540E63C9EE17"
jhash (0x1977C56A)
ns "STREAMING"
returns "void"
doc [[!
Clear the current srl and stop rendering the area selected by PREFETCH_SRL and started with BEGIN_SRL.
]]
native "GET_IDEAL_PLAYER_SWITCH_TYPE"
hash "0xB5D7B26B45720E05"
jhash (0xD5A450F1)
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
}
ns "STREAMING"
returns "int"
doc [[!
```
x1, y1, z1 -- Coords of your ped model
x2, y2, z2 -- Coords of the ped you want to switch to
```
]]
native "GET_LODSCALE"
hash "0x0C15B0E443B2349D"
jhash (0x7154B6FD)
alias "0x0C15B0E443B2349D"
ns "STREAMING"
returns "float"
doc [[!
]]
native "GET_NUMBER_OF_STREAMING_REQUESTS"
hash "0x4060057271CEBC89"
jhash (0xC2EE9A02)
ns "STREAMING"
returns "int"
doc [[!
]]
native "GET_PLAYER_SHORT_SWITCH_STATE"
hash "0x20F898A5D9782800"
jhash (0x9B7BA38F)
ns "STREAMING"
returns "int"
doc [[!
]]
native "GET_PLAYER_SWITCH_INTERP_OUT_CURRENT_TIME"
hash "0x5B48A06DD0E792A5"
jhash (0xC7A3D279)
alias "0x5B48A06DD0E792A5"
ns "STREAMING"
returns "Any"
doc [[!
]]
native "GET_PLAYER_SWITCH_INTERP_OUT_DURATION"
hash "0x08C2D6C52A3104BB"
jhash (0x569847E3)
alias "SET_PLAYER_INVERTED_UP"
alias "0x08C2D6C52A3104BB"
ns "STREAMING"
returns "int"
doc [[!
]]
native "GET_PLAYER_SWITCH_JUMP_CUT_INDEX"
hash "0x78C0D93253149435"
jhash (0x02BA7AC2)
alias "0x78C0D93253149435"
ns "STREAMING"
returns "int"
doc [[!
]]
native "GET_PLAYER_SWITCH_STATE"
hash "0x470555300D10B2A5"
jhash (0x39A0E1F2)
ns "STREAMING"
returns "int"
doc [[!
* Returns 5 if the player is in the air (in a state of switch).
* Returns 12 if the player is either not in the air or if the switch is completed.
]]
native "GET_PLAYER_SWITCH_TYPE"
hash "0xB3C94A90D9FC9E62"
jhash (0x280DC015)
ns "STREAMING"
returns "int"
doc [[!
]]
native "HAS_ANIM_DICT_LOADED"
hash "0xD031A9162D01088C"
jhash (0x05E6763C)
arguments {
charPtr "animDict" [=[ {} ]=],
}
ns "STREAMING"
returns "BOOL"
doc [[!
]]
native "HAS_ANIM_SET_LOADED"
hash "0xC4EA073D86FB29B0"
jhash (0x4FFF397D)
arguments {
charPtr "animSet" [=[ {} ]=],
}
ns "STREAMING"
returns "BOOL"
doc [[!
Gets whether the specified animation set has finished loading. An animation set provides movement animations for a ped.
Animation set and clip set are synonymous. See [`SET_PED_MOVEMENT_CLIPSET`](#\_0xAF8A94EDE7712BEF).
]]
native "HAS_CLIP_SET_LOADED"
hash "0x318234F4F3738AF3"
jhash (0x230D5455)
arguments {
charPtr "clipSet" [=[ {} ]=],
}
ns "STREAMING"
returns "BOOL"
doc [[!
```
Alias for HAS_ANIM_SET_LOADED.
```
]]
native "HAS_COLLISION_FOR_MODEL_LOADED"
hash "0x22CCA434E368F03A"
jhash (0x41A094F8)
arguments {
Hash "model" [=[ {} ]=],
}
ns "STREAMING"
returns "BOOL"
doc [[!
]]
native "HAS_MODEL_LOADED"
hash "0x98A4EB5D89A0C952"
jhash (0x62BFDB37)
arguments {
Hash "model" [=[ {} ]=],
}
ns "STREAMING"
returns "BOOL"
doc [[!
Returns whether the specified model (archetype) is currently loaded.
Note that this will return 'true' even if the model has been requested and loaded by something other than the current script, if you're intending to actually use the model in a later frame, you should call REQUEST_MODEL anyway.
The model hash to check for.
A boolean indicating whether the archetype is loaded (true) or not (false).
]]
native "HAS_NAMED_PTFX_ASSET_LOADED"
hash "0x8702416E512EC454"
jhash (0x9ACC6446)
arguments {
charPtr "fxName" [=[ {} ]=],
}
ns "STREAMING"
returns "BOOL"
doc [[!
]]
native "HAS_PTFX_ASSET_LOADED"
hash "0xCA7D9B86ECA7481B"
jhash (0x3EFF96BE)
ns "STREAMING"
returns "BOOL"
doc [[!
]]
native "INIT_CREATOR_BUDGET"
hash "0xB5A4DB34FE89B88A"
jhash (0xE243B2AF)
alias "0xB5A4DB34FE89B88A"
alias "_LOAD_MISSION_CREATOR_DATA"
ns "STREAMING"
returns "void"
doc [[!
]]
native "IS_ENTITY_FOCUS"
hash "0x2DDFF3FB9075D747"
jhash (0xB456D707)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "STREAMING"
returns "BOOL"
doc [[!
]]
native "IS_IPL_ACTIVE"
hash "0x88A741E44A2B3495"
jhash (0xB2C33714)
arguments {
charPtr "iplName" [=[ {} ]=],
}
ns "STREAMING"
returns "BOOL"
doc [[!
]]
native "IS_MODEL_A_VEHICLE"
hash "0x19AAC8F07BFEC53E"
jhash (0xFFFC85D4)
arguments {
Hash "model" [=[ {} ]=],
}
ns "STREAMING"
returns "BOOL"
doc [[!
```
Returns whether the specified model represents a vehicle.
```
]]
native "IS_MODEL_IN_CDIMAGE"
hash "0x35B9E0803292B641"
jhash (0x1094782F)
arguments {
Hash "model" [=[ {} ]=],
}
ns "STREAMING"
returns "BOOL"
doc [[!
```
Check if model is in cdimage(rpf)
```
]]
native "IS_MODEL_VALID"
hash "0xC0296A2EDF545E92"
jhash (0xAF8F8E9D)
arguments {
Hash "model" [=[ {} ]=],
}
ns "STREAMING"
returns "BOOL"
doc [[!
```
Returns whether the specified model exists in the game.
```
]]
native "IS_NETWORK_LOADING_SCENE"
hash "0x41CA5A33160EA4AB"
jhash (0x6DCFC021)
ns "STREAMING"
returns "BOOL"
doc [[!
]]
native "IS_NEW_LOAD_SCENE_ACTIVE"
hash "0xA41A05B6CB741B85"
jhash (0xAD234B7F)
ns "STREAMING"
returns "BOOL"
doc [[!
]]
native "IS_NEW_LOAD_SCENE_LOADED"
hash "0x01B8247A7A8B9AD1"
jhash (0x3ECD839F)
ns "STREAMING"
returns "BOOL"
doc [[!
]]
native "IS_PLAYER_SWITCH_IN_PROGRESS"
hash "0xD9D2CFFF49FAB35F"
jhash (0x56135ACC)
alias "0xD9D2CFFF49FAB35F"
ns "STREAMING"
returns "BOOL"
doc [[!
```
Returns true if the player is currently switching, false otherwise.
(When the camera is in the sky moving from Trevor to Franklin for example)
```
]]
native "IS_SRL_LOADED"
hash "0xD0263801A4C5B0BB"
jhash (0x670FA2A6)
ns "STREAMING"
returns "BOOL"
doc [[!
Returns true when the srl from BEGIN_SRL is loaded.
* A boolean once BeginSrl srl is loaded.
]]
native "IS_STREAMVOL_ACTIVE"
hash "0xBC9823AB80A3DCAC"
jhash (0x56253356)
alias "0xBC9823AB80A3DCAC"
ns "STREAMING"
returns "BOOL"
doc [[!
]]
native "IS_SWITCH_READY_FOR_DESCENT"
hash "0xDFA80CB25D0A19B3"
jhash (0x408F7148)
alias "0xDFA80CB25D0A19B3"
ns "STREAMING"
returns "BOOL"
doc [[!
]]
native "IS_SWITCH_SKIPPING_DESCENT"
hash "0x5B74EA8CFD5E3E7E"
jhash (0x90F64284)
alias "DESTROY_PLAYER_IN_PAUSE_MENU"
ns "STREAMING"
annotations [=[ {"cs_type":"Any"} ]=]
returns "BOOL"
doc [[!
]]
native "LOAD_ALL_OBJECTS_NOW"
hash "0xBD6E84632DD4CB3F"
jhash (0xC9DBDA90)
ns "STREAMING"
returns "void"
doc [[!
]]
native "LOAD_SCENE"
hash "0x4448EB75B4904BDB"
jhash (0xB72403F5)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
ns "STREAMING"
returns "void"
doc [[!
]]
native "NETWORK_STOP_LOAD_SCENE"
hash "0x64E630FAF5F60F44"
jhash (0x24857907)
ns "STREAMING"
returns "void"
doc [[!
]]
native "NETWORK_UPDATE_LOAD_SCENE"
hash "0xC4582015556D1C46"
jhash (0xC76E023C)
ns "STREAMING"
annotations [=[ {"cs_type":"void"} ]=]
returns "BOOL"
doc [[!
]]
native "NEW_LOAD_SCENE_START"
hash "0x212A8D0D2BABFAC2"
jhash (0xDF9C38B6)
arguments {
float "posX" [=[ {} ]=],
float "posY" [=[ {} ]=],
float "posZ" [=[ {} ]=],
float "offsetX" [=[ {} ]=],
float "offsetY" [=[ {} ]=],
float "offsetZ" [=[ {} ]=],
float "radius" [=[ {} ]=],
int "p7" [=[ {} ]=],
}
ns "STREAMING"
returns "BOOL"
doc [[!
```
`radius` value is usually between `3f` and `7000f` in original 1868 scripts.
`p7` is 0, 1, 2, 3 or 4 used in decompiled scripts, 0 is by far the most common.
Returns True if success, used only 7 times in decompiled scripts of 1868
```
World `x` coordinate.
World `y` coordinate.
World `z` coordinate.
Offset `x` coordinate.
Offset `y` coordinate.
Offset `z` coordinate.
Action radius, value is usually between `3f` and `7000f` in original 1868 scripts.
0, 1, 2, 3 or 4 used in decompiled scripts, 0 is by far the most common.
True if success, used only 7 times in decompiled scripts of 1868 (https://github.com/root-cause/v-decompiled-scripts).
]]
native "NEW_LOAD_SCENE_START_SPHERE"
hash "0xACCFB4ACF53551B0"
jhash (0xFA037FEB)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "radius" [=[ {} ]=],
Any "p4" [=[ {} ]=],
}
alias "0xACCFB4ACF53551B0"
ns "STREAMING"
returns "BOOL"
doc [[!
```
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)
```
]]
native "NEW_LOAD_SCENE_STOP"
hash "0xC197616D221FF4A4"
jhash (0x7C05B1F6)
ns "STREAMING"
returns "void"
doc [[!
]]
native "OVERRIDE_LODSCALE_THIS_FRAME"
hash "0xA76359FC80B2438E"
jhash (0xE5612C1A)
arguments {
float "scaling" [=[ {} ]=],
}
alias "0xA76359FC80B2438E"
ns "STREAMING"
returns "void"
doc [[!
```
This allows you to override "extended distance scaling" setting. Needs to be called each frame.
Max scaling seems to be 200.0, normal is 1.0
See https://gfycat.com/DetailedHauntingIncatern
```
]]
native "PREFETCH_SRL"
hash "0x3D245789CE12982C"
jhash (0x37BE2FBB)
arguments {
charPtr "srl" [=[ {} ]=],
}
ns "STREAMING"
returns "void"
doc [[!
This native is used to attribute the SRL that BeginSrl is going to load. This is usually used for 'in-game' cinematics (not cutscenes but camera stuff) instead of SetFocusArea because it loads a specific area of the map which is pretty useful when the camera moves from distant areas.
For instance, GTA:O opening cutscene.
https://pastebin.com/2EeKVeLA : a list of SRL found in srllist.meta
https://pastebin.com/zd9XYUWY : here is the content of a SRL file opened with codewalker.
A SRL name.
]]
native "REMOVE_ANIM_DICT"
hash "0xF66A602F829E2A06"
jhash (0x0AE050B5)
arguments {
charPtr "animDict" [=[ {} ]=],
}
ns "STREAMING"
returns "void"
doc [[!
]]
native "REMOVE_ANIM_SET"
hash "0x16350528F93024B3"
jhash (0xD04A817A)
arguments {
charPtr "animSet" [=[ {} ]=],
}
ns "STREAMING"
returns "void"
doc [[!
Unloads the specified animation set. An animation set provides movement animations for a ped.
Animation set and clip set are synonymous. See [`SET_PED_MOVEMENT_CLIPSET`](#\_0xAF8A94EDE7712BEF).
]]
native "REMOVE_CLIP_SET"
hash "0x01F73A131C18CD94"
jhash (0x1E21F7AA)
arguments {
charPtr "clipSet" [=[ {} ]=],
}
ns "STREAMING"
returns "void"
doc [[!
```
Alias for REMOVE_ANIM_SET.
```
]]
native "REMOVE_IPL"
hash "0xEE6C5AD3ECE0A82D"
jhash (0xDF7CBD36)
arguments {
charPtr "iplName" [=[ {} ]=],
}
ns "STREAMING"
returns "void"
doc [[!
IPL list can be found [here](https://gist.github.com/4mmonium/4c8a076b5f712a7cc64666003009a2e7).
]]
native "REMOVE_MODEL_FROM_CREATOR_BUDGET"
hash "0xF086AD9354FAC3A3"
jhash (0x1C576388)
arguments {
Hash "modelHash" [=[ {"cs_type":"Any"} ]=],
}
alias "0xF086AD9354FAC3A3"
ns "STREAMING"
returns "void"
doc [[!
]]
native "REMOVE_NAMED_PTFX_ASSET"
hash "0x5F61EBBE1A00F96D"
jhash (0xC44762A1)
arguments {
charPtr "fxName" [=[ {} ]=],
}
alias "_REMOVE_NAMED_PTFX_ASSET"
ns "STREAMING"
returns "void"
doc [[!
]]
native "REMOVE_PTFX_ASSET"
hash "0x88C6814073DD4A73"
jhash (0xC10F178C)
ns "STREAMING"
returns "void"
doc [[!
]]
native "REQUEST_ADDITIONAL_COLLISION_AT_COORD"
hash "0xC9156DC11411A9EA"
jhash (0xC2CC1DF2)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
ns "STREAMING"
returns "void"
doc [[!
]]
native "REQUEST_ANIM_DICT"
hash "0xD3BD40951412FEF6"
jhash (0xDCA96950)
arguments {
charPtr "animDict" [=[ {} ]=],
}
ns "STREAMING"
returns "void"
doc [[!
]]
native "REQUEST_ANIM_SET"
hash "0x6EA47DAE7FAD0EED"
jhash (0x2988B3FC)
arguments {
charPtr "animSet" [=[ {} ]=],
}
ns "STREAMING"
returns "void"
doc [[!
Starts loading the specified animation set. An animation set provides movement animations for a ped. See [`SET_PED_MOVEMENT_CLIPSET`](#\_0xAF8A94EDE7712BEF).
]]
native "REQUEST_CLIP_SET"
hash "0xD2A71E1A77418A49"
jhash (0x546C627A)
arguments {
charPtr "clipSet" [=[ {} ]=],
}
ns "STREAMING"
returns "void"
doc [[!
]]
native "REQUEST_COLLISION_AT_COORD"
hash "0x07503F7948F491A7"
jhash (0xCD9805E7)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
ns "STREAMING"
annotations [=[ {"cs_type":"Any"} ]=]
returns "void"
doc [[!
]]
native "REQUEST_COLLISION_FOR_MODEL"
hash "0x923CB32A3B874FCB"
jhash (0x3930C042)
arguments {
Hash "model" [=[ {} ]=],
}
ns "STREAMING"
returns "void"
doc [[!
]]
native "REQUEST_IPL"
hash "0x41B4893843BBDB74"
jhash (0x3B70D1DB)
arguments {
charPtr "iplName" [=[ {} ]=],
}
ns "STREAMING"
returns "void"
doc [[!
```
Exemple: REQUEST_IPL("TrevorsTrailerTrash");
```
]]
native "REQUEST_MENU_PED_MODEL"
hash "0xA0261AEF7ACFC51E"
jhash (0x48CEB6B4)
arguments {
Hash "model" [=[ {} ]=],
}
alias "0xA0261AEF7ACFC51E"
ns "STREAMING"
returns "void"
doc [[!
Calls [`REQUEST_MODEL`](#\_0x963D27A58DF860AC) with the `STRFLAG_PRIORITY_LOAD` and `STRFLAG_FORCE_LOAD` set.
The model to request.
]]
native "REQUEST_MODEL"
hash "0x963D27A58DF860AC"
jhash (0xFFF1B500)
arguments {
Hash "model" [=[ {} ]=],
}
ns "STREAMING"
returns "void"
doc [[!
Request a model (archetype) to be loaded for use by the current script. Use SET_MODEL_AS_NO_LONGER_NEEDED when done using the model in script.
The model to request.
]]
native "REQUEST_MODELS_IN_ROOM"
hash "0x8A7A40100EDFEC58"
jhash (0x939243FB)
arguments {
int "interior" [=[ {} ]=],
charPtr "roomName" [=[ {} ]=],
}
alias "0x8A7A40100EDFEC58"
alias "_REQUEST_INTERIOR_ROOM_BY_NAME"
ns "STREAMING"
returns "void"
doc [[!
```
STREAMING::REQUEST_MODELS_IN_ROOM(l_13BC, "V_FIB01_cur_elev");
STREAMING::REQUEST_MODELS_IN_ROOM(l_13BC, "limbo");
STREAMING::REQUEST_MODELS_IN_ROOM(l_13BB, "V_Office_gnd_lifts");
STREAMING::REQUEST_MODELS_IN_ROOM(l_13BB, "limbo");
STREAMING::REQUEST_MODELS_IN_ROOM(l_13BC, "v_fib01_jan_elev");
STREAMING::REQUEST_MODELS_IN_ROOM(l_13BC, "limbo");
```
]]
native "REQUEST_NAMED_PTFX_ASSET"
hash "0xB80D8756B4668AB6"
jhash (0xCFEA19A9)
arguments {
charPtr "fxName" [=[ {} ]=],
}
ns "STREAMING"
returns "void"
doc [[!
```
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");
```
]]
native "REQUEST_PTFX_ASSET"
hash "0x944955FB2A3935C8"
jhash (0x2C649263)
ns "STREAMING"
annotations [=[ {"cs_type":"Any"} ]=]
returns "void"
doc [[!
```
maps script name (thread + 0xD0) by lookup via scriptfx.dat - does nothing when script name is empty
```
]]
native "SET_DITCH_POLICE_MODELS"
hash "0x42CBE54462D92634"
jhash (0x3EA7FCE4)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "STREAMING"
returns "void"
doc [[!
```
This is a NOP function. It does nothing at all.
```
]]
native "SET_FOCUS_ENTITY"
hash "0x198F77705FA0931D"
jhash (0x18DB04AC)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "STREAMING"
returns "void"
doc [[!
```
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.
```
]]
native "SET_FOCUS_POS_AND_VEL"
hash "0xBB7454BAFF08FE25"
jhash (0x14680A60)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "offsetX" [=[ {} ]=],
float "offsetY" [=[ {} ]=],
float "offsetZ" [=[ {} ]=],
}
alias "_SET_FOCUS_AREA"
ns "STREAMING"
returns "void"
doc [[!
```
Override the area where the camera will render the terrain.
p3, p4 and p5 are usually set to 0.0
```
]]
native "SET_GAME_PAUSES_FOR_STREAMING"
hash "0x717CD6E6FAEBBEDC"
jhash (0x9211A28A)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "STREAMING"
returns "void"
doc [[!
]]
native "SET_HD_AREA"
hash "0xB85F26619073E775"
jhash (0x80BAA035)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "radius" [=[ {} ]=],
}
ns "STREAMING"
returns "void"
doc [[!
]]
native "SET_INTERIOR_ACTIVE"
hash "0xE37B76C387BE28ED"
jhash (0xE1013910)
arguments {
int "interiorID" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "STREAMING"
returns "void"
doc [[!
]]
native "SET_ISLAND_ENABLED"
hash "0x9A9D1BA639675CF1"
arguments {
charPtr "islandName" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "_SET_ISLAND_HOPPER_ENABLED"
ns "STREAMING"
returns "void"
doc [[!
Enables the specified island. For more information, see islandhopper.meta
```
NativeDB Introduced: v2189
```
The name of the island to be enabled or disabled.
A boolean value where `true` enables the island and `false` disables it.
]]
native "SET_MAPDATACULLBOX_ENABLED"
hash "0xAF12610C644A35C9"
jhash (0x403CD434)
arguments {
charPtr "name" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0xAF12610C644A35C9"
ns "STREAMING"
returns "void"
doc [[!
```
Possible p0 values:
"prologue"
"Prologue_Main"
```
]]
native "SET_MODEL_AS_NO_LONGER_NEEDED"
hash "0xE532F5D78798DAAB"
jhash (0xAE0F069E)
arguments {
Hash "model" [=[ {} ]=],
}
ns "STREAMING"
returns "void"
doc [[!
Releases the script ownership assigned by REQUEST_MODEL. This command should be used when done using a specific model hash in script.
The model to release ownership of.
]]
native "SET_PED_POPULATION_BUDGET"
hash "0x8C95333CFC3340F3"
jhash (0xD2D026CD)
arguments {
int "budgetLevel" [=[ {} ]=],
}
ns "STREAMING"
returns "void"
doc [[!
Sets the memory budget level for ped population.
Ranges from `0` to `3`, where `0` is lowest (no peds) and `3` is the full budget level.
]]
native "SET_PLAYER_SHORT_SWITCH_STYLE"
hash "0x5F2013F8BC24EE69"
jhash (0xF0BD420D)
arguments {
int "style" [=[ {} ]=],
}
alias "0x5F2013F8BC24EE69"
ns "STREAMING"
returns "void"
doc [[!
Always 0
]]
native "SET_PLAYER_SWITCH_ESTABLISHING_SHOT"
hash "0x0FDE9DBFC0A6BC65"
jhash (0x279077B0)
arguments {
charPtr "name" [=[ {} ]=],
}
alias "0x0FDE9DBFC0A6BC65"
ns "STREAMING"
returns "void"
doc [[!
```
All names can be found in playerswitchestablishingshots.meta
```
]]
native "SET_PLAYER_SWITCH_OUTRO"
hash "0xC208B673CE446B61"
jhash (0x47352E14)
arguments {
float "cameraCoordX" [=[ {} ]=],
float "cameraCoordY" [=[ {} ]=],
float "cameraCoordZ" [=[ {} ]=],
float "camRotationX" [=[ {} ]=],
float "camRotationY" [=[ {} ]=],
float "camRotationZ" [=[ {} ]=],
float "camFov" [=[ {} ]=],
float "camFarClip" [=[ {} ]=],
int "rotationOrder" [=[ {} ]=],
}
alias "0xC208B673CE446B61"
ns "STREAMING"
returns "void"
doc [[!
]]
native "SET_REDUCE_PED_MODEL_BUDGET"
hash "0x77B5F9A36BF96710"
jhash (0xAFCB2B86)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "STREAMING"
returns "void"
doc [[!
]]
native "SET_REDUCE_VEHICLE_MODEL_BUDGET"
hash "0x80C527893080CCF3"
jhash (0xCDB4FB7E)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "STREAMING"
returns "void"
doc [[!
]]
native "SET_RENDER_HD_ONLY"
hash "0x40AEFD1A244741F2"
jhash (0x9FA4AF99)
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0x40AEFD1A244741F2"
ns "STREAMING"
returns "void"
doc [[!
]]
native "SET_SRL_TIME"
hash "0xA74A541C6884E7B8"
jhash (0x30F8A487)
arguments {
float "p0" [=[ {} ]=],
}
ns "STREAMING"
returns "void"
doc [[!
]]
native "SET_STREAMING"
hash "0x6E0C692677008888"
jhash (0x27EF6CB2)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "STREAMING"
returns "void"
doc [[!
]]
native "SET_VEHICLE_POPULATION_BUDGET"
hash "0xCB9E1EB3BE2AF4E9"
jhash (0x1D56993C)
arguments {
int "p0" [=[ {} ]=],
}
ns "STREAMING"
returns "void"
doc [[!
]]
native "SHUTDOWN_CREATOR_BUDGET"
hash "0xCCE26000E9A6FAD7"
jhash (0x897A510F)
alias "0xCCE26000E9A6FAD7"
ns "STREAMING"
returns "void"
doc [[!
]]
native "START_PLAYER_SWITCH"
hash "0xFAA23F2CBA159D67"
jhash (0x0829E975)
arguments {
Ped "from" [=[ {} ]=],
Ped "to" [=[ {} ]=],
int "flags" [=[ {} ]=],
int "switchType" [=[ {} ]=],
}
ns "STREAMING"
returns "void"
doc [[!
```cpp
enum ePlayerSwitchType
{
SWITCH_TYPE_AUTO = 0,
SWITCH_TYPE_LONG = 1,
SWITCH_TYPE_MEDIUM = 2,
SWITCH_TYPE_SHORT = 3
};
```
```cpp
enum eSwitchFlags {
SKIP_INTRO = 1,
SKIP_OUTRO = 2,
PAUSE_BEFORE_PAN = 4,
PAUSE_BEFORE_OUTRO = 8,
SKIP_PAN = 16,
UNKNOWN_DEST = 32,
DESCENT_ONLY = 64,
START_FROM_CAMPOS = 128,
PAUSE_BEFORE_ASCENT = 256,
PAUSE_BEFORE_DESCENT = 512,
ALLOW_SNIPER_AIM_INTRO = 1024,
ALLOW_SNIPER_AIM_OUTRO = 2048,
SKIP_TOP_DESCENT = 4096,
SUPPRESS_OUTRO_FX = 8192,
SUPPRESS_INTRO_FX = 16384,
DELAY_ASCENT_FX = 32768
}
```
Refer to `eSwitchFlags`
Refer to `ePlayerSwitchType`
]]
native "STOP_PLAYER_SWITCH"
hash "0x95C0A5BBDC189AA1"
jhash (0x2832C010)
ns "STREAMING"
returns "void"
doc [[!
]]
native "STREAMVOL_CREATE_FRUSTUM"
hash "0x1F3F018BC3AFA77C"
jhash (0x72344191)
arguments {
float "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
float "p4" [=[ {} ]=],
float "p5" [=[ {} ]=],
float "p6" [=[ {} ]=],
Any "p7" [=[ {} ]=],
Any "p8" [=[ {} ]=],
}
alias "0x1F3F018BC3AFA77C"
ns "STREAMING"
returns "Any"
doc [[!
```
Always returns zero.
```
]]
native "STREAMVOL_CREATE_LINE"
hash "0x0AD9710CEE2F590F"
jhash (0xC0157255)
arguments {
float "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
float "p4" [=[ {} ]=],
float "p5" [=[ {} ]=],
Any "p6" [=[ {} ]=],
}
alias "0x0AD9710CEE2F590F"
ns "STREAMING"
returns "Any"
doc [[!
```
Always returns zero.
```
]]
native "STREAMVOL_CREATE_SPHERE"
hash "0x219C7B8D53E429FD"
jhash (0x10B6AB36)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "rad" [=[ {} ]=],
Any "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
}
alias "0x219C7B8D53E429FD"
alias "FORMAT_FOCUS_HEADING"
ns "STREAMING"
returns "Any"
doc [[!
```
Always returns zero.
```
]]
native "STREAMVOL_DELETE"
hash "0x1EE7D8DF4425F053"
jhash (0xE80F8ABE)
arguments {
Any "unused" [=[ {} ]=],
}
alias "0x1EE7D8DF4425F053"
ns "STREAMING"
returns "void"
doc [[!
]]
native "STREAMVOL_HAS_LOADED"
hash "0x7D41E9D2D17C5B2D"
jhash (0x1B3521F4)
arguments {
Any "unused" [=[ {} ]=],
}
alias "0x7D41E9D2D17C5B2D"
ns "STREAMING"
returns "BOOL"
doc [[!
]]
native "STREAMVOL_IS_VALID"
hash "0x07C313F94746702C"
jhash (0x42CFE9C0)
arguments {
Any "unused" [=[ {} ]=],
}
alias "0x07C313F94746702C"
ns "STREAMING"
returns "BOOL"
doc [[!
]]
native "SWITCH_TO_MULTI_FIRSTPART"
hash "0xAAB3200ED59016BC"
jhash (0xFB4D062D)
arguments {
Ped "ped" [=[ {} ]=],
int "flags" [=[ {} ]=],
int "switchType" [=[ {} ]=],
}
alias "0xAAB3200ED59016BC"
alias "_SWITCH_OUT_PLAYER"
ns "STREAMING"
returns "void"
doc [[!
You can check if the player is in a Switch state with [`IS_PLAYER_SWITCH_IN_PROGRESS`](#\_0xD9D2CFFF49FAB35F).
***Note:** Doesn't act normally when used on Mount Chiliad.*
The Ped (player character) for which the switch is initiated.
Flags control various functionalities: 0 for normal behavior, 1 for no transition, and 255 for Switch IN.
Specifies the type of switch (0 - 3): 0 for 1 step towards ped, 1 for 3 steps out from ped, 2 for 1 step out from ped, and 3 for 1 step towards ped.
]]
native "SWITCH_TO_MULTI_SECONDPART"
hash "0xD8295AF639FD9CB8"
jhash (0x2349373B)
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0xD8295AF639FD9CB8"
alias "_SWITCH_IN_PLAYER"
ns "STREAMING"
returns "void"
doc [[!
After using [`SWITCH_TO_MULTI_FIRSTPART`](#\_0xAAB3200ED59016BC) , use this native to smoothly return the camera to the player's character.
]]
native "_GET_GLOBAL_WATER_TYPE"
hash "0xF741BD853611592D"
ns "STREAMING"
returns "int"
doc [[!
```
NativeDB Introduced: v2189
```
]]
native "_GET_USED_CREATOR_MODEL_MEMORY_PERCENTAGE"
hash "0x3D3D8B3BE5A83D35"
jhash (0x3E9C4CBE)
alias "0x3D3D8B3BE5A83D35"
ns "STREAMING"
returns "float"
doc [[!
```
0.0 = no memory used
1.0 = all memory used
Maximum model memory (as defined in common\data\missioncreatordata.meta) is 100 MiB
GET_*
```
]]
native "_IS_MODEL_A_PED"
hash "0x75816577FEA6DAD5"
arguments {
Hash "model" [=[ {} ]=],
}
ns "STREAMING"
returns "BOOL"
doc [[!
]]
native "_LOAD_GLOBAL_WATER_TYPE"
hash "0x7E3F55ED251B76D3"
arguments {
int "waterType" [=[ {} ]=],
}
ns "STREAMING"
returns "void"
doc [[!
0 - default
1 - HeistIsland
```
NativeDB Introduced: v2189
```
]]
native "0x03F1A106BDA7DD3E"
hash "0x03F1A106BDA7DD3E"
ns "STREAMING"
returns "void"
doc [[!
]]
native "0x0811381EF5062FEC"
hash "0x0811381EF5062FEC"
arguments {
Entity "p0" [=[ {} ]=],
}
ns "STREAMING"
returns "void"
doc [[!
]]
native "0x1E9057A74FD73E23"
hash "0x1E9057A74FD73E23"
ns "STREAMING"
returns "void"
doc [[!
]]
native "0x20C6C7E4EB082A7F"
hash "0x20C6C7E4EB082A7F"
jhash (0xA6459CAA)
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "STREAMING"
returns "void"
doc [[!
]]
native "0x472397322E92A856"
hash "0x472397322E92A856"
jhash (0x4267DA87)
ns "STREAMING"
returns "void"
doc [[!
]]
native "0x4E52E752C76E7E7A"
hash "0x4E52E752C76E7E7A"
jhash (0xA07BAEB9)
arguments {
Any "p0" [=[ {} ]=],
}
ns "STREAMING"
returns "void"
doc [[!
**This native does absolutely nothing, just a nullsub**
]]
native "0x5068F488DDB54DD8"
hash "0x5068F488DDB54DD8"
jhash (0xDAB4BAC0)
ns "STREAMING"
returns "Any"
doc [[!
]]
native "0x63EB2B972A218CAC"
hash "0x63EB2B972A218CAC"
jhash (0xF2CDD6A8)
ns "STREAMING"
returns "void"
doc [[!
]]
native "0x71E7B2E657449AAD"
hash "0x71E7B2E657449AAD"
jhash (0xEAA51103)
ns "STREAMING"
returns "Any"
doc [[!
]]
native "0x933BBEEB8C61B5F4"
hash "0x933BBEEB8C61B5F4"
jhash (0x74C16879)
ns "STREAMING"
returns "BOOL"
doc [[!
```
Probably IS_SWITCH_*
```
]]
native "0x95A7DABDDBB78AE7"
hash "0x95A7DABDDBB78AE7"
jhash (0x9EF0A9CF)
arguments {
charPtr "iplName1" [=[ {} ]=],
charPtr "iplName2" [=[ {} ]=],
}
ns "STREAMING"
returns "void"
doc [[!
]]
native "0xBEB2D9A1D9A8F55A"
hash "0xBEB2D9A1D9A8F55A"
jhash (0x62F02485)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "STREAMING"
returns "void"
doc [[!
]]
native "0xBED8CA5FF5E04113"
hash "0xBED8CA5FF5E04113"
jhash (0x9CD6A451)
arguments {
float "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
}
ns "STREAMING"
returns "void"
doc [[!
]]
native "0xEF39EE20C537E98C"
hash "0xEF39EE20C537E98C"
jhash (0x814D0752)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
}
ns "STREAMING"
returns "void"
doc [[!
]]
native "0xF4A0DADB70F57FA6"
hash "0xF4A0DADB70F57FA6"
jhash (0x3DA7AA5D)
ns "STREAMING"
returns "void"
doc [[!
]]
native "0xF8155A7F03DDFC8E"
hash "0xF8155A7F03DDFC8E"
jhash (0xF8F515E4)
arguments {
Any "p0" [=[ {} ]=],
}
ns "STREAMING"
returns "void"
doc [[!
]]
native "0xFB199266061F820A"
hash "0xFB199266061F820A"
jhash (0x17B0A1CD)
ns "STREAMING"
returns "BOOL"
doc [[!
]]
native "GET_PACKED_BOOL_STAT_KEY"
hash "0x80C75307B1C42837"
jhash (0xB5BF87B2)
arguments {
int "index" [=[ {} ]=],
BOOL "spStat" [=[ {} ]=],
BOOL "charStat" [=[ {} ]=],
int "character" [=[ {} ]=],
}
alias "0x80C75307B1C42837"
alias "_GET_PSTAT_BOOL_HASH"
ns "STATS"
returns "Hash"
doc [[!
]]
native "GET_PACKED_INT_STAT_KEY"
hash "0x61E111E323419E07"
jhash (0x1F938864)
arguments {
int "index" [=[ {} ]=],
BOOL "spStat" [=[ {} ]=],
BOOL "charStat" [=[ {} ]=],
int "character" [=[ {} ]=],
}
alias "0x61E111E323419E07"
alias "_GET_PSTAT_INT_HASH"
ns "STATS"
returns "Hash"
doc [[!
]]
native "GET_PACKED_TU_BOOL_STAT_KEY"
hash "0xC4BB08EE7907471E"
jhash (0x3F8E893B)
arguments {
int "index" [=[ {} ]=],
BOOL "spStat" [=[ {} ]=],
BOOL "charStat" [=[ {} ]=],
int "character" [=[ {} ]=],
}
alias "0xC4BB08EE7907471E"
alias "_GET_TUPSTAT_BOOL_HASH"
alias "_GET_PACKED_TITLE_UPDATE_BOOL_STAT_KEY"
ns "STATS"
returns "Hash"
doc [[!
]]
native "GET_PACKED_TU_INT_STAT_KEY"
hash "0xD16C2AD6B8E32854"
jhash (0xFB93C5A2)
arguments {
int "index" [=[ {} ]=],
BOOL "spStat" [=[ {} ]=],
BOOL "charStat" [=[ {} ]=],
int "character" [=[ {} ]=],
}
alias "0xD16C2AD6B8E32854"
alias "_GET_TUPSTAT_INT_HASH"
alias "_GET_PACKED_TITLE_UPDATE_INT_STAT_KEY"
ns "STATS"
returns "Hash"
doc [[!
]]
native "LEADERBOARDS_CACHE_DATA_ROW"
hash "0xB9BB18E2C40142ED"
jhash (0x44F7D82B)
arguments {
AnyPtr "p0" [=[ {} ]=],
}
ns "STATS"
returns "BOOL"
doc [[!
]]
native "LEADERBOARDS_CLEAR_CACHE_DATA"
hash "0xD4B02A6B476E1FDC"
jhash (0x87F498C1)
ns "STATS"
returns "void"
doc [[!
]]
native "LEADERBOARDS_GET_CACHE_DATA_ROW"
hash "0x9120E8DBA3D69273"
jhash (0xA11289EC)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
AnyPtr "p2" [=[ {} ]=],
}
ns "STATS"
returns "BOOL"
doc [[!
]]
native "LEADERBOARDS_GET_CACHE_EXISTS"
hash "0x9C51349BE6CDFE2C"
jhash (0xFC8A71F3)
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "BOOL"
doc [[!
]]
native "LEADERBOARDS_GET_CACHE_NUMBER_OF_ROWS"
hash "0x58A651CD201D89AD"
jhash (0xCE7CB520)
arguments {
Any "p0" [=[ {} ]=],
}
alias "0x58A651CD201D89AD"
ns "STATS"
returns "int"
doc [[!
]]
native "LEADERBOARDS_GET_CACHE_TIME"
hash "0xF04C1C27DA35F6C8"
jhash (0xEDF02302)
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "Any"
doc [[!
]]
native "LEADERBOARDS_GET_COLUMN_ID"
hash "0xC4B5467A1886EA7E"
jhash (0x3821A334)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
ns "STATS"
returns "Any"
doc [[!
]]
native "LEADERBOARDS_GET_COLUMN_TYPE"
hash "0xBF4FEF46DB7894D3"
jhash (0x6F2820F4)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
ns "STATS"
returns "Any"
doc [[!
]]
native "LEADERBOARDS_GET_NUMBER_OF_COLUMNS"
hash "0x117B45156D7EFF2E"
jhash (0x0A56EE34)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "STATS"
returns "Any"
doc [[!
]]
native "LEADERBOARDS_READ_ANY_PENDING"
hash "0xA31FD15197B192BD"
jhash (0x1789437B)
alias "0xA31FD15197B192BD"
ns "STATS"
returns "BOOL"
doc [[!
]]
native "LEADERBOARDS_READ_CLEAR"
hash "0x7CCE5C737A665701"
jhash (0x7090012F)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
ns "STATS"
returns "Any"
doc [[!
]]
native "LEADERBOARDS_READ_CLEAR_ALL"
hash "0xA34CB6E6F0DF4A0B"
jhash (0x233E058A)
ns "STATS"
returns "Any"
doc [[!
]]
native "LEADERBOARDS_READ_PENDING"
hash "0xAC392C8483342AC2"
jhash (0xEEB8BF5C)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
ns "STATS"
returns "BOOL"
doc [[!
]]
native "LEADERBOARDS_READ_SUCCESSFUL"
hash "0x2FB19228983E832C"
jhash (0x3AC5B2F1)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
ns "STATS"
returns "BOOL"
doc [[!
]]
native "LEADERBOARDS_WRITE_ADD_COLUMN"
hash "0x0BCA1D2C47B0D269"
jhash (0x7524E27B)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
}
alias "0x0BCA1D2C47B0D269"
ns "STATS"
returns "void"
doc [[!
]]
native "LEADERBOARDS_WRITE_ADD_COLUMN_LONG"
hash "0x2E65248609523599"
jhash (0x1C5CCC3A)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
alias "0x2E65248609523599"
ns "STATS"
returns "void"
doc [[!
]]
native "LEADERBOARDS2_READ_BY_HANDLE"
hash "0xC30713A383BFBF0E"
jhash (0x6B553408)
arguments {
AnyPtr "p0" [=[ {} ]=],
AnyPtr "p1" [=[ {} ]=],
}
ns "STATS"
returns "BOOL"
doc [[!
]]
native "LEADERBOARDS2_READ_BY_RADIUS"
hash "0x5CE587FB5A42C8C4"
jhash (0xC5B7E685)
arguments {
AnyPtr "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
AnyPtr "p2" [=[ {} ]=],
}
ns "STATS"
returns "BOOL"
doc [[!
]]
native "LEADERBOARDS2_READ_BY_RANK"
hash "0xBA2C7DB0C129449A"
jhash (0x1B03F59F)
arguments {
AnyPtr "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
ns "STATS"
returns "BOOL"
doc [[!
]]
native "LEADERBOARDS2_READ_BY_ROW"
hash "0xA9CDB1E3F0A49883"
jhash (0xCA931F34)
arguments {
AnyPtr "p0" [=[ {} ]=],
AnyPtr "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
AnyPtr "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
AnyPtr "p5" [=[ {} ]=],
Any "p6" [=[ {} ]=],
}
ns "STATS"
returns "BOOL"
doc [[!
]]
native "LEADERBOARDS2_READ_BY_SCORE_FLOAT"
hash "0xE662C8B759D08F3C"
jhash (0xC678B29F)
arguments {
AnyPtr "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
ns "STATS"
returns "BOOL"
doc [[!
]]
native "LEADERBOARDS2_READ_BY_SCORE_INT"
hash "0x7EEC7E4F6984A16A"
jhash (0xAC020C18)
arguments {
AnyPtr "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
ns "STATS"
returns "BOOL"
doc [[!
]]
native "LEADERBOARDS2_READ_FRIENDS_BY_ROW"
hash "0x918B101666F9CB83"
jhash (0xBD91B136)
arguments {
AnyPtr "p0" [=[ {} ]=],
AnyPtr "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
}
ns "STATS"
returns "BOOL"
doc [[!
]]
native "LEADERBOARDS2_READ_RANK_PREDICTION"
hash "0xC38DC1E90D22547C"
jhash (0x9BEC3401)
arguments {
AnyPtr "p0" [=[ {} ]=],
AnyPtr "p1" [=[ {} ]=],
AnyPtr "p2" [=[ {} ]=],
}
alias "0xC38DC1E90D22547C"
ns "STATS"
returns "BOOL"
doc [[!
]]
native "LEADERBOARDS2_WRITE_DATA"
hash "0xAE2206545888AE49"
jhash (0x5F9DF634)
arguments {
AnyPtr "p0" [=[ {} ]=],
}
ns "STATS"
returns "BOOL"
doc [[!
]]
native "LEADERBOARDS2_WRITE_DATA_FOR_EVENT_TYPE"
hash "0xC980E62E33DF1D5C"
jhash (0x62C19A3D)
arguments {
AnyPtr "p0" [=[ {} ]=],
AnyPtr "p1" [=[ {} ]=],
}
alias "0xC980E62E33DF1D5C"
ns "STATS"
returns "BOOL"
doc [[!
]]
native "PLAYSTATS_ACQUIRED_HIDDEN_PACKAGE"
hash "0x79AB33F0FBFAC40C"
jhash (0x8D5C7B37)
arguments {
Any "p0" [=[ {} ]=],
}
alias "0x79AB33F0FBFAC40C"
ns "STATS"
returns "void"
doc [[!
]]
native "PLAYSTATS_ACTIVITY_DONE"
hash "0xA071E0ED98F91286"
jhash (0x1A66945F)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
alias "0xA071E0ED98F91286"
ns "STATS"
returns "void"
doc [[!
]]
native "PLAYSTATS_AWARD_XP"
hash "0x46F917F6B4128FE4"
jhash (0x8770017B)
arguments {
int "amount" [=[ {} ]=],
Hash "type" [=[ {"cs_type":"Any"} ]=],
Hash "category" [=[ {"cs_type":"Any"} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "PLAYSTATS_BACKGROUND_SCRIPT_ACTION"
hash "0x5009DFD741329729"
jhash (0x61ECC465)
arguments {
charPtr "action" [=[ {} ]=],
int "value" [=[ {} ]=],
}
alias "0x5009DFD741329729"
ns "STATS"
returns "void"
doc [[!
]]
native "PLAYSTATS_CHEAT_APPLIED"
hash "0x6058665D72302D3F"
jhash (0x345166F3)
arguments {
charPtr "cheat" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "PLAYSTATS_CLOTH_CHANGE"
hash "0x34B973047A2268B9"
jhash (0x3AFF9E58)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "PLAYSTATS_CRATE_CREATED"
hash "0xAFC7E5E075A96F46"
jhash (0xD003E648)
arguments {
float "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
}
alias "0xAFC7E5E075A96F46"
alias "_PLAYSTATS_AMBIENT_MISSION_CRATE_CREATED"
alias "_PLAYSTATS_CRATE_CREATED"
alias "_PLAYSTATS_CRATE_CREATED_MISSION_DONE"
ns "STATS"
returns "void"
doc [[!
]]
native "PLAYSTATS_CRATE_DROP_MISSION_DONE"
hash "0x1CAE5D2E3F9A07F0"
jhash (0x6602CED6)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
}
alias "0x1CAE5D2E3F9A07F0"
alias "_PLAYSTATS_CRATE_DROP"
ns "STATS"
returns "void"
doc [[!
```
NativeDB Added Parameter 7: Any p6
NativeDB Added Parameter 8: Any p7
```
]]
native "PLAYSTATS_FRIEND_ACTIVITY"
hash "0x0F71DE29AB2258F1"
jhash (0xD1FA1BDB)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "PLAYSTATS_HEIST_SAVE_CHEAT"
hash "0xF4FF020A08BC8863"
jhash (0xB731DF54)
arguments {
Hash "hash" [=[ {"cs_type":"Any"} ]=],
int "p1" [=[ {} ]=],
}
alias "0xF4FF020A08BC8863"
alias "_PLAYSTATS_HEIST_SAVE_CHEAT"
ns "STATS"
returns "void"
doc [[!
]]
native "PLAYSTATS_HOLD_UP_MISSION_DONE"
hash "0xCB00196B31C39EB1"
jhash (0x759E0EC9)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
alias "0xCB00196B31C39EB1"
alias "_PLAYSTATS_HOLD_UP"
ns "STATS"
returns "void"
doc [[!
]]
native "PLAYSTATS_IDLE_KICK"
hash "0x5DA3A8DE8CB6226F"
jhash (0x9E2B9522)
arguments {
int "time" [=[ {} ]=],
}
alias "0x5DA3A8DE8CB6226F"
ns "STATS"
returns "void"
doc [[!
```
longest time being ilde?
```
]]
native "PLAYSTATS_IMPORT_EXPORT_MISSION_DONE"
hash "0x2B69F5074C894811"
jhash (0x62073DF7)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
alias "0x2B69F5074C894811"
alias "_PLAYSTATS_IMP_EXP"
ns "STATS"
returns "void"
doc [[!
]]
native "PLAYSTATS_JOB_BEND"
hash "0xF5BB8DAC426A52C0"
jhash (0x40520E70)
arguments {
AnyPtr "p0" [=[ {} ]=],
AnyPtr "p1" [=[ {} ]=],
AnyPtr "p2" [=[ {} ]=],
AnyPtr "p3" [=[ {} ]=],
}
alias "0xF5BB8DAC426A52C0"
ns "STATS"
returns "void"
doc [[!
]]
native "PLAYSTATS_LEAVE_JOB_CHAIN"
hash "0xC5BE134EC7BA96A0"
jhash (0xC960E161)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
}
alias "0xC5BE134EC7BA96A0"
ns "STATS"
returns "void"
doc [[!
]]
native "PLAYSTATS_MATCH_STARTED"
hash "0xBC80E22DED931E3D"
jhash (0x2BDE85C1)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
Any "p6" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Removed Parameter 4: Any p3
NativeDB Removed Parameter 5: Any p4
NativeDB Removed Parameter 6: Any p5
NativeDB Removed Parameter 7: Any p6
```
]]
native "PLAYSTATS_MISSION_CHECKPOINT"
hash "0xC900596A63978C1D"
jhash (0xCDC52280)
arguments {
AnyPtr "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "PLAYSTATS_MISSION_OVER"
hash "0x7C4BB33A8CED7324"
jhash (0x5B90B5FF)
arguments {
AnyPtr "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
BOOL "p4" [=[ {} ]=],
BOOL "p5" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "PLAYSTATS_MISSION_STARTED"
hash "0xC19A2925C34D2231"
jhash (0x3AAB699C)
arguments {
AnyPtr "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "PLAYSTATS_NPC_INVITE"
hash "0x93054C88E6AA7C44"
jhash (0x598C06F3)
arguments {
AnyPtr "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "PLAYSTATS_ODDJOB_DONE"
hash "0x69DEA3E9DB727B4C"
jhash (0xFE14A8EA)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
**This native does absolutely nothing, just a nullsub**
]]
native "PLAYSTATS_PROP_CHANGE"
hash "0xBA739D6D5A05D6E7"
jhash (0x25740A1D)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "PLAYSTATS_QUICKFIX_TOOL"
hash "0x90D0622866E80445"
jhash (0x66FEB701)
arguments {
int "element" [=[ {} ]=],
charPtr "item" [=[ {} ]=],
}
alias "0x90D0622866E80445"
ns "STATS"
returns "void"
doc [[!
]]
native "PLAYSTATS_RACE_CHECKPOINT"
hash "0x9C375C315099DDE4"
jhash (0x580D5508)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "PLAYSTATS_RACE_TO_POINT_MISSION_DONE"
hash "0xADDD1C754E2E2914"
jhash (0x06CE3692)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
Any "p6" [=[ {} ]=],
Any "p7" [=[ {} ]=],
Any "p8" [=[ {} ]=],
Any "p9" [=[ {} ]=],
}
alias "0xADDD1C754E2E2914"
alias "_PLAYSTATS_RACE_TO_POINT"
ns "STATS"
returns "void"
doc [[!
```
NativeDB Removed Parameter 5: Any p4
NativeDB Removed Parameter 6: Any p5
NativeDB Removed Parameter 7: Any p6
NativeDB Removed Parameter 8: Any p7
NativeDB Removed Parameter 9: Any p8
NativeDB Removed Parameter 10: Any p9
```
]]
native "PLAYSTATS_RANDOM_MISSION_DONE"
hash "0x71862B1D855F32E1"
jhash (0xAC2C7C63)
arguments {
charPtr "name" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
alias "0x71862B1D855F32E1"
ns "STATS"
returns "void"
doc [[!
]]
native "PLAYSTATS_RANK_UP"
hash "0xC7F2DE41D102BFB4"
jhash (0x56AFB9F5)
arguments {
int "rank" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "PLAYSTATS_ROS_BET"
hash "0x121FB4DDDC2D5291"
jhash (0x413539BC)
arguments {
int "amount" [=[ {} ]=],
int "act" [=[ {} ]=],
Player "player" [=[ {} ]=],
float "cm" [=[ {} ]=],
}
alias "0x121FB4DDDC2D5291"
ns "STATS"
returns "void"
doc [[!
]]
native "PLAYSTATS_SET_JOIN_TYPE"
hash "0xD1032E482629049E"
jhash (0x1AC97138)
arguments {
int "joinType" [=[ {} ]=],
}
alias "0xD1032E482629049E"
ns "STATS"
returns "void"
doc [[!
Sets a byte that is then used in session_host and session_join metrics when hosting or joining a session
]]
native "PLAYSTATS_SHOP_ITEM"
hash "0x176852ACAAC173D1"
jhash (0xA4746384)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "PLAYSTATS_START_TRACKING_STUNTS"
hash "0x928DBFB892638EF3"
alias "0x928DBFB892638EF3"
alias "_PLAYSTATS_STUNT_PERFORMED_EVENT_ALLOW_TRIGGER"
ns "STATS"
returns "void"
doc [[!
Allows stunts to be triggered and sent as a `CEventNetworkStuntPerformed` event.
Event types are shown below:
```cpp
enum eTrackedStuntType
{
ST_FRONTFLIP = 0,
ST_BACKFLIP = 1,
ST_SPIN = 2,
ST_WHEELIE = 3,
ST_STOPPIE = 4,
ST_BOWLING_PIN = 5,
ST_FOOTBALL = 6,
ST_ROLL = 7
};
```
]]
native "PLAYSTATS_STOP_TRACKING_STUNTS"
hash "0x8A800DACCC0DA55D"
alias "0x8A800DACCC0DA55D"
alias "_PLAYSTATS_STUNT_PERFORMED_EVENT_DISALLOW_TRIGGER"
ns "STATS"
returns "void"
doc [[!
Disallows CEventNetworkStuntPerformed to be triggered (Resets [`PLAYSTATS_START_TRACKING_STUNTS`](#\_0x928DBFB892638EF3)).
]]
native "PLAYSTATS_WEAPON_MODE_CHANGE"
hash "0xE95C8A1875A02CA4"
jhash (0x79716890)
arguments {
Hash "weaponHash" [=[ {"cs_type":"Any"} ]=],
Hash "componentHashTo" [=[ {"cs_type":"Any"} ]=],
Hash "componentHashFrom" [=[ {"cs_type":"Any"} ]=],
}
alias "0xE95C8A1875A02CA4"
ns "STATS"
returns "void"
doc [[!
]]
native "PLAYSTATS_WEBSITE_VISITED"
hash "0xDDF24D535060F811"
jhash (0x37D152BB)
arguments {
Hash "scaleformHash" [=[ {} ]=],
int "p1" [=[ {} ]=],
}
alias "0xDDF24D535060F811"
ns "STATS"
returns "void"
doc [[!
]]
native "PRESENCE_EVENT_UPDATESTAT_FLOAT"
hash "0x30A6614C1F7799B8"
jhash (0x3E69E7C3)
arguments {
Hash "statHash" [=[ {"cs_type":"Any"} ]=],
float "value" [=[ {} ]=],
int "p2" [=[ {} ]=],
}
alias "0x30A6614C1F7799B8"
alias "_UPDATE_STAT_FLOAT"
ns "STATS"
returns "void"
doc [[!
]]
native "PRESENCE_EVENT_UPDATESTAT_INT"
hash "0x11FF1C80276097ED"
jhash (0x4AC39C6C)
arguments {
Hash "statHash" [=[ {"cs_type":"charPtr"} ]=],
int "value" [=[ {} ]=],
int "p2" [=[ {} ]=],
}
alias "0x11FF1C80276097ED"
alias "_UPDATE_STAT_INT"
ns "STATS"
returns "void"
doc [[!
]]
native "SET_PROFILE_SETTING_PROLOGUE_COMPLETE"
hash "0xB475F27C6A994D65"
jhash (0xC7DE5C30)
alias "0xB475F27C6A994D65"
ns "STATS"
returns "void"
doc [[!
]]
native "STAT_CLEAR_SLOT_FOR_RELOAD"
hash "0xEB0A72181D4AA4AD"
jhash (0x84BDD475)
arguments {
int "statSlot" [=[ {} ]=],
}
ns "STATS"
returns "Any"
doc [[!
```
Example:
for (v_2 = 0; v_2 <= 4; v_2 += 1) {
STATS::STAT_CLEAR_SLOT_FOR_RELOAD(v_2);
}
```
]]
native "STAT_DELETE_SLOT"
hash "0x49A49BED12794D70"
jhash (0x2F171B94)
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "Any"
doc [[!
]]
native "STAT_GET_BOOL"
hash "0x11B5E6D2AE73F48E"
jhash (0x28A3DD2B)
arguments {
Hash "statHash" [=[ {} ]=],
BOOLPtr "outValue" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
ns "STATS"
returns "BOOL"
doc [[!
]]
native "STAT_GET_BOOL_MASKED"
hash "0x10FE3F1B79F9B071"
jhash (0x6ACE1B7D)
arguments {
Hash "statName" [=[ {} ]=],
int "mask" [=[ {} ]=],
int "p2" [=[ {} ]=],
}
ns "STATS"
returns "BOOL"
doc [[!
```
p2 - Default value? Seems to be -1 most of the time.
```
]]
native "STAT_GET_DATE"
hash "0x8B0FACEFC36C824B"
jhash (0xD762D16C)
arguments {
Hash "statHash" [=[ {} ]=],
AnyPtr "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "STATS"
returns "BOOL"
doc [[!
]]
native "STAT_GET_FLOAT"
hash "0xD7AE6C9C9C6AC54C"
jhash (0xFCBDA612)
arguments {
Hash "statHash" [=[ {} ]=],
floatPtr "outValue" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
ns "STATS"
returns "BOOL"
doc [[!
]]
native "STAT_GET_INT"
hash "0x767FBC2AC802EF3D"
jhash (0x1C6FE43E)
arguments {
Hash "statHash" [=[ {} ]=],
intPtr "outValue" [=[ {} ]=],
int "p2" [=[ {} ]=],
}
ns "STATS"
returns "BOOL"
doc [[!
```
p2 appears to always be -1
```
]]
native "STAT_GET_LICENSE_PLATE"
hash "0x5473D4195058B2E4"
jhash (0x1544B29F)
arguments {
Hash "statName" [=[ {} ]=],
}
ns "STATS"
returns "charPtr"
doc [[!
]]
native "STAT_GET_MASKED_INT"
hash "0x655185A06D9EEAAB"
jhash (0xE9D9B70F)
arguments {
Any "p0" [=[ {} ]=],
AnyPtr "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
}
ns "STATS"
returns "BOOL"
doc [[!
]]
native "STAT_GET_NUMBER_OF_DAYS"
hash "0xE0E854F5280FB769"
jhash (0xFD66A429)
arguments {
Hash "statName" [=[ {} ]=],
}
alias "0xE0E854F5280FB769"
ns "STATS"
returns "int"
doc [[!
]]
native "STAT_GET_NUMBER_OF_HOURS"
hash "0xF2D4B2FE415AAFC3"
jhash (0x9B431236)
arguments {
Hash "statName" [=[ {} ]=],
}
alias "0xF2D4B2FE415AAFC3"
ns "STATS"
returns "int"
doc [[!
]]
native "STAT_GET_NUMBER_OF_MINUTES"
hash "0x7583B4BE4C5A41B5"
jhash (0x347B4436)
arguments {
Hash "statName" [=[ {} ]=],
}
alias "0x7583B4BE4C5A41B5"
ns "STATS"
returns "int"
doc [[!
]]
native "STAT_GET_NUMBER_OF_SECONDS"
hash "0x2CE056FF3723F00B"
jhash (0x2C1D6C31)
arguments {
Hash "statName" [=[ {} ]=],
}
alias "0x2CE056FF3723F00B"
ns "STATS"
returns "int"
doc [[!
]]
native "STAT_GET_POS"
hash "0x350F82CCB186AA1B"
jhash (0xC846ECCE)
arguments {
Any "p0" [=[ {} ]=],
AnyPtr "p1" [=[ {} ]=],
AnyPtr "p2" [=[ {} ]=],
AnyPtr "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
}
ns "STATS"
returns "BOOL"
doc [[!
]]
native "STAT_GET_SAVE_MIGRATION_STATUS"
hash "0x886913BBEACA68C1"
jhash (0xE3F0D62D)
arguments {
AnyPtr "data" [=[ {} ]=],
}
alias "0x886913BBEACA68C1"
ns "STATS"
returns "int"
doc [[!
]]
native "STAT_GET_STRING"
hash "0xE50384ACC2C3DB74"
jhash (0x10CE4BDE)
arguments {
Hash "statHash" [=[ {} ]=],
int "p1" [=[ {} ]=],
}
ns "STATS"
returns "charPtr"
doc [[!
```
p1 is always -1 in the script files
```
]]
native "STAT_GET_USER_ID"
hash "0x2365C388E393BBE2"
jhash (0xE2E8B6BA)
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "charPtr"
doc [[!
```
Needs more research. Seems to return "STAT_UNKNOWN" if no such user id exists.
```
]]
native "STAT_INCREMENT"
hash "0x9B5A68C6489E9909"
jhash (0xDFC5F71E)
arguments {
Hash "statName" [=[ {} ]=],
float "value" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "STAT_LOAD"
hash "0xA651443F437B1CE6"
jhash (0x9E5629F4)
arguments {
int "p0" [=[ {} ]=],
}
ns "STATS"
returns "BOOL"
doc [[!
]]
native "STAT_LOAD_PENDING"
hash "0xA1750FFAFA181661"
jhash (0x4E9AC983)
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "BOOL"
doc [[!
]]
native "STAT_SAVE"
hash "0xE07BCA305B82D2FD"
jhash (0xE10A7CA4)
arguments {
int "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
int "p2" [=[ {} ]=],
}
ns "STATS"
returns "BOOL"
doc [[!
```
NativeDB Added Parameter 4: Any p3
```
]]
native "STAT_SAVE_MIGRATION_STATUS_START"
hash "0xC70DDCE56D0D3A99"
jhash (0x54E775E0)
alias "0xC70DDCE56D0D3A99"
ns "STATS"
returns "BOOL"
doc [[!
]]
native "STAT_SAVE_PENDING"
hash "0x7D3A583856F2C5AC"
jhash (0xC3FD3822)
ns "STATS"
annotations [=[ {"cs_type":"Any"} ]=]
returns "BOOL"
doc [[!
]]
native "STAT_SAVE_PENDING_OR_REQUESTED"
hash "0xBBB6AD006F1BBEA3"
jhash (0xA3407CA3)
ns "STATS"
annotations [=[ {"cs_type":"Any"} ]=]
returns "BOOL"
doc [[!
]]
native "STAT_SET_BLOCK_SAVES"
hash "0xF434A10BA01C37D0"
jhash (0xCE7A2411)
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0xF434A10BA01C37D0"
ns "STATS"
returns "void"
doc [[!
]]
native "STAT_SET_BOOL"
hash "0x4B33C4243DE0C432"
jhash (0x55D79DFB)
arguments {
Hash "statName" [=[ {} ]=],
BOOL "value" [=[ {} ]=],
BOOL "save" [=[ {} ]=],
}
ns "STATS"
returns "BOOL"
doc [[!
```
Example:
STATS::STAT_SET_BOOL(MISC::GET_HASH_KEY("MPPLY_MELEECHLENGECOMPLETED"), trur, true);
```
]]
native "STAT_SET_BOOL_MASKED"
hash "0x5BC62EC1937B9E5B"
jhash (0x7842C4D6)
arguments {
Hash "statName" [=[ {} ]=],
BOOL "value" [=[ {} ]=],
int "mask" [=[ {} ]=],
BOOL "save" [=[ {} ]=],
}
ns "STATS"
returns "BOOL"
doc [[!
]]
native "STAT_SET_CHEAT_IS_ACTIVE"
hash "0x047CBED6F6F8B63C"
jhash (0xA063CABD)
alias "0x047CBED6F6F8B63C"
ns "STATS"
returns "void"
doc [[!
]]
native "STAT_SET_CURRENT_POSIX_TIME"
hash "0xC2F84B7F9C4D0C61"
jhash (0xA286F015)
arguments {
Hash "statName" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "STATS"
returns "BOOL"
doc [[!
```
p1 always true.
```
]]
native "STAT_SET_DATE"
hash "0x2C29BFB64F4FCBE4"
jhash (0x36BE807B)
arguments {
Hash "statName" [=[ {} ]=],
AnyPtr "value" [=[ {} ]=],
int "numFields" [=[ {} ]=],
BOOL "save" [=[ {} ]=],
}
ns "STATS"
returns "BOOL"
doc [[!
```
'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.
```
]]
native "STAT_SET_FLOAT"
hash "0x4851997F37FE9B3C"
jhash (0x6CEA96F2)
arguments {
Hash "statName" [=[ {} ]=],
float "value" [=[ {} ]=],
BOOL "save" [=[ {} ]=],
}
ns "STATS"
returns "BOOL"
doc [[!
```
Example:
STATS::STAT_SET_FLOAT(MISC::GET_HASH_KEY("MP0_WEAPON_ACCURACY"), 66.6f, true);
```
]]
native "STAT_SET_GXT_LABEL"
hash "0x17695002FD8B2AE0"
jhash (0xC1224AA7)
arguments {
Hash "statName" [=[ {} ]=],
charPtr "value" [=[ {} ]=],
BOOL "save" [=[ {} ]=],
}
ns "STATS"
returns "BOOL"
doc [[!
```
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"
```
]]
native "STAT_SET_INT"
hash "0xB3271D7AB655B441"
jhash (0xC9CC1C5C)
arguments {
Hash "statName" [=[ {} ]=],
int "value" [=[ {} ]=],
BOOL "save" [=[ {} ]=],
}
ns "STATS"
returns "BOOL"
doc [[!
]]
native "STAT_SET_LICENSE_PLATE"
hash "0x69FF13266D7296DA"
jhash (0x3507D253)
arguments {
Hash "statName" [=[ {} ]=],
charPtr "str" [=[ {} ]=],
}
ns "STATS"
returns "BOOL"
doc [[!
]]
native "STAT_SET_MASKED_INT"
hash "0x7BBB1B54583ED410"
jhash (0x2CBAA739)
arguments {
Hash "statName" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
int "p3" [=[ {} ]=],
BOOL "save" [=[ {} ]=],
}
ns "STATS"
returns "BOOL"
doc [[!
]]
native "STAT_SET_POS"
hash "0xDB283FDE680FE72E"
jhash (0x1192C9A3)
arguments {
Hash "statName" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
BOOL "save" [=[ {} ]=],
}
ns "STATS"
returns "BOOL"
doc [[!
]]
native "STAT_SET_PROFILE_SETTING_VALUE"
hash "0x68F01422BE1D838F"
jhash (0x24DD4929)
arguments {
int "profileSetting" [=[ {} ]=],
int "value" [=[ {} ]=],
}
alias "0x68F01422BE1D838F"
alias "_STAT_SET_PROFILE_SETTING"
ns "STATS"
returns "void"
doc [[!
```
Does not take effect immediately, unfortunately.
profileSetting seems to only be 936, 937 and 938 in scripts
```
]]
native "STAT_SET_STRING"
hash "0xA87B2335D12531D7"
jhash (0xB1EF2E21)
arguments {
Hash "statName" [=[ {} ]=],
charPtr "value" [=[ {} ]=],
BOOL "save" [=[ {} ]=],
}
ns "STATS"
returns "BOOL"
doc [[!
]]
native "STAT_SET_USER_ID"
hash "0x8CDDF1E452BABE11"
jhash (0xDBE78ED7)
arguments {
Hash "statName" [=[ {} ]=],
charPtr "value" [=[ {} ]=],
BOOL "save" [=[ {} ]=],
}
ns "STATS"
returns "BOOL"
doc [[!
]]
native "STAT_SLOT_IS_LOADED"
hash "0x0D0A9F0E7BD91E3C"
jhash (0x7A299C13)
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "BOOL"
doc [[!
]]
native "_GET_NGSTAT_BOOL_HASH"
hash "0xBA52FF538ED2BC71"
arguments {
int "index" [=[ {} ]=],
BOOL "spStat" [=[ {} ]=],
BOOL "charStat" [=[ {} ]=],
int "character" [=[ {} ]=],
charPtr "section" [=[ {} ]=],
}
alias "0xBA52FF538ED2BC71"
ns "STATS"
returns "Hash"
doc [[!
```
Needs more research. Gets the stat name of a masked bool?
section - values used in the decompiled scripts:
"_NGPSTAT_BOOL"
"_NGTATPSTAT_BOOL"
"_NGDLCPSTAT_BOOL"
"_DLCBIKEPSTAT_BOOL"
"_DLCGUNPSTAT_BOOL"
"_GUNTATPSTAT_BOOL"
"_DLCSMUGCHARPSTAT_BOOL"
"_GANGOPSPSTAT_BOOL"
"_BUSINESSBATPSTAT_BOOL"
"_ARENAWARSPSTAT_BOOL"
"_CASINOPSTAT_BOOL"
"_CASINOHSTPSTAT_BOOL"
"_HEIST3TATTOOSTAT_BOOL"
```
]]
native "_GET_NGSTAT_INT_HASH"
hash "0x2B4CDCA6F07FF3DA"
arguments {
int "index" [=[ {} ]=],
BOOL "spStat" [=[ {} ]=],
BOOL "charStat" [=[ {} ]=],
int "character" [=[ {} ]=],
charPtr "section" [=[ {} ]=],
}
alias "0x2B4CDCA6F07FF3DA"
ns "STATS"
returns "Hash"
doc [[!
```
Needs more research. Gets the stat name of a masked int?
section - values used in the decompiled scripts:
"_NGPSTAT_INT"
"_MP_NGPSTAT_INT"
"_MP_LRPSTAT_INT"
"_MP_APAPSTAT_INT"
"_MP_LR2PSTAT_INT"
"_MP_BIKEPSTAT_INT"
"_MP_IMPEXPPSTAT_INT"
"_MP_GUNRPSTAT_INT"
"_NGDLCPSTAT_INT"
"_MP_NGDLCPSTAT_INT"
"_DLCSMUGCHARPSTAT_INT"
"_GANGOPSPSTAT_INT"
"_BUSINESSBATPSTAT_INT"
"_ARENAWARSPSTAT_INT"
"_CASINOPSTAT_INT"
"_CASINOHSTPSTAT_INT"
```
]]
native "_HIRED_LIMO"
hash "0x792271AB35C356A4"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
alias "0x792271AB35C356A4"
ns "STATS"
returns "void"
doc [[!
]]
native "_LEADERBOARDS_DEATHS"
hash "0x428EAF89E24F6C36"
jhash (0xEE292B91)
arguments {
Hash "statName" [=[ {} ]=],
float "value" [=[ {} ]=],
}
alias "0x428EAF89E24F6C36"
ns "STATS"
returns "void"
doc [[!
]]
native "_LEADERBOARDS2_READ_BY_PLATFORM"
hash "0xF1AE5DCDBFCA2721"
arguments {
AnyPtr "p0" [=[ {} ]=],
charPtr "gamerHandleCsv" [=[ {} ]=],
charPtr "platformName" [=[ {} ]=],
}
alias "0xF1AE5DCDBFCA2721"
ns "STATS"
returns "BOOL"
doc [[!
]]
native "_ORDERED_BOSS_VEHICLE"
hash "0xCEA553E35C2246E1"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Hash "vehicleHash" [=[ {"cs_type":"Any"} ]=],
}
alias "0xCEA553E35C2246E1"
ns "STATS"
returns "void"
doc [[!
]]
native "_PLAYSTATS_ARCADEGAME"
hash "0x533A7D1EA58DF958"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v1734
```
]]
native "_PLAYSTATS_ARENA_WAR_SPECTATOR"
hash "0x6F4F599753F8200A"
arguments {
int "p0" [=[ {} ]=],
int "p1" [=[ {} ]=],
int "p2" [=[ {} ]=],
int "p3" [=[ {} ]=],
int "p4" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v1604
```
]]
native "_PLAYSTATS_ARENA_WARS_ENDED"
hash "0xB479D9F0D48A1BC5"
arguments {
AnyPtr "data" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v1604
```
]]
native "_PLAYSTATS_AWARD_BADSPORT"
hash "0x47B32F5611E6E483"
arguments {
int "id" [=[ {} ]=],
}
alias "0x47B32F5611E6E483"
ns "STATS"
returns "void"
doc [[!
]]
native "_PLAYSTATS_BAN_ALERT"
hash "0x516FC96EB88EEFE5"
arguments {
int "p0" [=[ {} ]=],
}
alias "0x516FC96EB88EEFE5"
ns "STATS"
returns "void"
doc [[!
]]
native "_PLAYSTATS_BUY_CONTRABAND"
hash "0xD6781E42755531F7"
arguments {
AnyPtr "data" [=[ {} ]=],
}
alias "0xD6781E42755531F7"
ns "STATS"
returns "void"
doc [[!
]]
native "_PLAYSTATS_CARCLUB_CHALLENGE"
hash "0x1187CB58D7F3BED7"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
alias "0x1187CB58D7F3BED7"
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "_PLAYSTATS_CARCLUB_POINTS"
hash "0xFF14D6FEEC507BBE"
arguments {
Any "p0" [=[ {} ]=],
}
alias "0xFF14D6FEEC507BBE"
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "_PLAYSTATS_CARCLUB_PRIZE"
hash "0x69C922B677621428"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
alias "0x69C922B677621428"
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "_PLAYSTATS_CASINO_BLACKJACK"
hash "0x3EAE97309727E7AD"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v1734
```
]]
native "_PLAYSTATS_CASINO_BLACKJACK_LIGHT"
hash "0xD5451C7BF151EB6F"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v1734
```
]]
native "_PLAYSTATS_CASINO_CHIP"
hash "0x0999F3F090EC5012"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v1734
```
]]
native "_PLAYSTATS_CASINO_INSIDETRACK"
hash "0x049F059625058A86"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v1734
```
]]
native "_PLAYSTATS_CASINO_INSIDETRACK_LIGHT"
hash "0x23A3CBCD50D54E47"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v1734
```
]]
native "_PLAYSTATS_CASINO_LUCKYSEVEN"
hash "0x0C432C1435F5E4FA"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v1734
```
]]
native "_PLAYSTATS_CASINO_MISSION_ENDED"
hash "0x1A0D4A6C336B7BC5"
arguments {
AnyPtr "data" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v1734
```
]]
native "_PLAYSTATS_CASINO_ROULETTE"
hash "0x95101C443A84E7F1"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v1734
```
]]
native "_PLAYSTATS_CASINO_ROULETTE_LIGHT"
hash "0x6572ABA3DE1197FC"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v1734
```
]]
native "_PLAYSTATS_CASINO_SLOTMACHINE"
hash "0xEF5EC67D392B830A"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v1734
```
]]
native "_PLAYSTATS_CASINO_SLOTMACHINE_LIGHT"
hash "0xE60054A0FAE8227F"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v1734
```
]]
native "_PLAYSTATS_CASINO_STORY_MISSION_ENDED"
hash "0xFCCCAC2BD3C1F180"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v1734
```
]]
native "_PLAYSTATS_CASINO_THREECARDPOKER"
hash "0xF740FB339D471C35"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v1734
```
]]
native "_PLAYSTATS_CASINO_THREECARDPOKER_LIGHT"
hash "0xC9001364B4388F22"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v1734
```
]]
native "_PLAYSTATS_CHANGE_MC_EMBLEM"
hash "0x0A50D2604E05CB94"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
}
alias "0x0A50D2604E05CB94"
ns "STATS"
returns "void"
doc [[!
]]
native "_PLAYSTATS_COLLECTIBLE"
hash "0xCD0A8A9338681CF2"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
Any "p6" [=[ {} ]=],
Any "p7" [=[ {} ]=],
Any "p8" [=[ {} ]=],
Any "p9" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v1734
```
]]
native "_PLAYSTATS_COPY_RANK_INTO_NEW_SLOT"
hash "0xB7257BA2550EA10A"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
Any "p6" [=[ {} ]=],
}
alias "0xB7257BA2550EA10A"
ns "STATS"
returns "void"
doc [[!
]]
native "_PLAYSTATS_DAR_MISSION_END"
hash "0x0BC254FF3A911501"
arguments {
AnyPtr "data" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "_PLAYSTATS_DEFEND_CONTRABAND"
hash "0x2605663BD4F23B5D"
arguments {
AnyPtr "data" [=[ {} ]=],
}
alias "0x2605663BD4F23B5D"
ns "STATS"
returns "void"
doc [[!
]]
native "_PLAYSTATS_DIRECTOR_MODE"
hash "0x46326E13DA4E0546"
arguments {
AnyPtr "p0" [=[ {} ]=],
}
alias "0x46326E13DA4E0546"
ns "STATS"
returns "void"
doc [[!
]]
native "_PLAYSTATS_DRONE_USAGE"
hash "0x66C7BB2416ED3FCE"
arguments {
int "p0" [=[ {} ]=],
int "p1" [=[ {} ]=],
int "p2" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v1493
```
]]
native "_PLAYSTATS_DUPE_DETECTION"
hash "0x848B66100EE33B05"
arguments {
AnyPtr "data" [=[ {} ]=],
}
alias "0x848B66100EE33B05"
ns "STATS"
returns "void"
doc [[!
]]
native "_PLAYSTATS_EARNED_MC_POINTS"
hash "0x501478855A6074CE"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
}
alias "0x501478855A6074CE"
ns "STATS"
returns "void"
doc [[!
]]
native "_PLAYSTATS_ENTER_SESSION_PACK"
hash "0x878FF156D36E9956"
arguments {
AnyPtr "data" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "_PLAYSTATS_EXTRA_EVENT"
hash "0xFA5B74BAB8A7EF99"
arguments {
Any "p0" [=[ {} ]=],
}
alias "0xFA5B74BAB8A7EF99"
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "_PLAYSTATS_GUNRUN_MISSION_ENDED"
hash "0x0EACDF8487D5155A"
arguments {
AnyPtr "data" [=[ {} ]=],
}
alias "0x0EACDF8487D5155A"
ns "STATS"
returns "void"
doc [[!
]]
native "_PLAYSTATS_H2_FMPREP_END"
hash "0xD8AFB345A9C5CCBB"
arguments {
AnyPtr "data" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "_PLAYSTATS_H2_INSTANCE_END"
hash "0x1E1497D0D2108115"
arguments {
AnyPtr "data" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "_PLAYSTATS_INVENTORY"
hash "0x887DAD63CF5B7908"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v2699
```
]]
native "_PLAYSTATS_PASSIVE_MODE"
hash "0x35EEC6C2BC821A71"
arguments {
BOOL "p0" [=[ {} ]=],
int "p1" [=[ {} ]=],
int "p2" [=[ {} ]=],
int "p3" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v1734
```
]]
native "_PLAYSTATS_PEGASAIRCRAFT"
hash "0x9572BD4DD6B72122"
arguments {
Hash "modelHash" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v1180
```
]]
native "_PLAYSTATS_PI_MENU_HIDE_SETTINGS"
hash "0x203B381133817079"
arguments {
AnyPtr "data" [=[ {} ]=],
}
alias "0x203B381133817079"
ns "STATS"
returns "void"
doc [[!
]]
native "_PLAYSTATS_RECOVER_CONTRABAND"
hash "0x04D90BA8207ADA2D"
arguments {
AnyPtr "data" [=[ {} ]=],
}
alias "0x04D90BA8207ADA2D"
ns "STATS"
returns "void"
doc [[!
]]
native "_PLAYSTATS_ROBBERY_FINALE"
hash "0xBBA55BE9AAAABF44"
arguments {
Any "p0" [=[ {} ]=],
}
alias "0xBBA55BE9AAAABF44"
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "_PLAYSTATS_ROBBERY_PREP"
hash "0x1A67DFBF1F5C3835"
arguments {
Any "p0" [=[ {} ]=],
}
alias "0x1A67DFBF1F5C3835"
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "_PLAYSTATS_SELL_CONTRABAND"
hash "0xC729991A9065376E"
arguments {
AnyPtr "data" [=[ {} ]=],
}
alias "0xC729991A9065376E"
ns "STATS"
returns "void"
doc [[!
]]
native "_PLAYSTATS_SMUG_MISSION_ENDED"
hash "0x320C35147D5B5DDD"
arguments {
AnyPtr "data" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v1180
```
]]
native "_PLAYSTATS_SPECTATOR_WHEEL_SPIN"
hash "0x6731DE84A38BFAD0"
arguments {
int "p0" [=[ {} ]=],
int "p1" [=[ {} ]=],
int "p2" [=[ {} ]=],
int "p3" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v1604
```
]]
native "_PLAYSTATS_SPENT_PI_CUSTOM_LOADOUT"
hash "0xBE509B0A3693DE8B"
arguments {
int "amount" [=[ {} ]=],
}
alias "0xBE509B0A3693DE8B"
ns "STATS"
returns "void"
doc [[!
]]
native "_PLAYSTATS_START_OFFLINE_MODE"
hash "0x098760C7461724CD"
jhash (0x896CDF8D)
alias "0x098760C7461724CD"
ns "STATS"
returns "void"
doc [[!
```
PLAYSTATS_START_INVITE_DESPAWNING?
```
]]
native "_PLAYSTATS_STONE_HATCHET_END"
hash "0x35E39E5570358630"
arguments {
AnyPtr "data" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v1493
```
]]
native "_SET_HAS_CONTENT_UNLOCKS_FLAGS"
hash "0xDAC073C7901F9E15"
arguments {
int "value" [=[ {} ]=],
}
alias "0xDAC073C7901F9E15"
ns "STATS"
returns "void"
doc [[!
```
Sets profile setting 866
SET_*
```
]]
native "_SET_SAVE_MIGRATION_TRANSACTION_ID"
hash "0xF6792800AC95350D"
arguments {
int "transactionId" [=[ {} ]=],
}
alias "0xF6792800AC95350D"
ns "STATS"
returns "void"
doc [[!
```
Sets profile setting 501
```
]]
native "_STAT_GET_CANCEL_SAVE_MIGRATION_STATUS"
hash "0x567384DFA67029E6"
alias "0x567384DFA67029E6"
ns "STATS"
returns "int"
doc [[!
]]
native "_STAT_GET_PACKED_BOOL_MASK"
hash "0xF4D8E7AC2A27758C"
jhash (0xDFC25D66)
arguments {
int "p0" [=[ {} ]=],
}
alias "0xF4D8E7AC2A27758C"
ns "STATS"
returns "int"
doc [[!
```
Needs more research. Possibly used to calculate the "mask" when calling "STAT_SET_BOOL_MASKED"?
```
]]
native "_STAT_GET_PACKED_INT_MASK"
hash "0x94F12ABF9C79E339"
jhash (0xCA160BCC)
arguments {
int "p0" [=[ {} ]=],
}
alias "0x94F12ABF9C79E339"
ns "STATS"
returns "int"
doc [[!
```
Needs more research. Possibly used to calculate the "mask" when calling "STAT_SET_MASKED_INT"?
```
]]
native "_STAT_GET_SAVE_MIGRATION_CONSUME_CONTENT_UNLOCK_STATUS"
hash "0xCE5AA445ABA8DEE0"
arguments {
intPtr "p0" [=[ {"cs_type":"AnyPtr"} ]=],
}
alias "0xCE5AA445ABA8DEE0"
ns "STATS"
returns "int"
doc [[!
]]
native "_STAT_MIGRATE_SAVE"
hash "0xA5C80D8E768A9E66"
arguments {
charPtr "platformName" [=[ {} ]=],
}
alias "0xA5C80D8E768A9E66"
ns "STATS"
returns "BOOL"
doc [[!
```
platformName must be one of the following: ps3, xbox360, ps4, xboxone
```
]]
native "_STAT_SAVE_MIGRATION_CANCEL"
hash "0x4FEF53183C3C6414"
alias "0x4FEF53183C3C6414"
ns "STATS"
returns "BOOL"
doc [[!
]]
native "_STAT_SAVE_MIGRATION_CONSUME_CONTENT_UNLOCK"
hash "0x3270F67EED31FBC1"
arguments {
Hash "contentId" [=[ {"cs_type":"Any"} ]=],
charPtr "srcPlatform" [=[ {} ]=],
charPtr "srcGamerHandle" [=[ {} ]=],
}
alias "0x3270F67EED31FBC1"
ns "STATS"
returns "BOOL"
doc [[!
]]
native "0x0077F15613D36993"
hash "0x0077F15613D36993"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v1868
```
]]
native "0x015B03EE1C43E6EC"
hash "0x015B03EE1C43E6EC"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0x03C2EEBB04B3FB72"
hash "0x03C2EEBB04B3FB72"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
Any "p6" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0x06EAF70AE066441E"
hash "0x06EAF70AE066441E"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0x0A9C7F36E5D7B683"
hash "0x0A9C7F36E5D7B683"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0x0B565B0AAE56A0E8"
hash "0x0B565B0AAE56A0E8"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
Any "p6" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0x0B8B7F74BF061C6D"
hash "0x0B8B7F74BF061C6D"
ns "STATS"
returns "Any"
doc [[!
]]
native "0x0D01D20616FC73FB"
hash "0x0D01D20616FC73FB"
jhash (0x2180AE13)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0x14E0B2D1AD1044E0"
hash "0x14E0B2D1AD1044E0"
jhash (0xDDD1F1F3)
arguments {
AnyPtr "p0" [=[ {} ]=],
AnyPtr "p1" [=[ {} ]=],
AnyPtr "p2" [=[ {} ]=],
AnyPtr "p3" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0x14EDA9EE27BD1626"
hash "0x14EDA9EE27BD1626"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0x164C5FF663790845"
hash "0x164C5FF663790845"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0x1A7CE7CD3E653485"
hash "0x1A7CE7CD3E653485"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0x1A8EA222F9C67DBB"
hash "0x1A8EA222F9C67DBB"
arguments {
floatPtr "p0" [=[ {} ]=],
}
ns "STATS"
returns "Any"
doc [[!
]]
native "0x26D7399B9587FE89"
hash "0x26D7399B9587FE89"
jhash (0x343B27E2)
arguments {
int "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
STATS::0x343B27E2(0);
STATS::0x343B27E2(1);
STATS::0x343B27E2(2);
STATS::0x343B27E2(3);
STATS::0x343B27E2(4);
STATS::0x343B27E2(5);
STATS::0x343B27E2(6);
STATS::0x343B27E2(7);
Identical in ingamehud & maintransition.
```
]]
native "0x27AA1C973CACFE63"
hash "0x27AA1C973CACFE63"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
Any "p6" [=[ {} ]=],
Any "p7" [=[ {} ]=],
Any "p8" [=[ {} ]=],
Any "p9" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0x2818FF6638CB09DE"
hash "0x2818FF6638CB09DE"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v2189
```
]]
native "0x282B6739644F4347"
hash "0x282B6739644F4347"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0x28ECB8AC2F607DB2"
hash "0x28ECB8AC2F607DB2"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0x2CD90358F67D0AA8"
hash "0x2CD90358F67D0AA8"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0x2D7A9B577E72385E"
hash "0x2D7A9B577E72385E"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v1493
```
]]
native "0x2E0259BABC27A327"
hash "0x2E0259BABC27A327"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v1868
```
]]
native "0x2FA3173480008493"
hash "0x2FA3173480008493"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v2189
```
]]
native "0x316DB59CD14C1774"
hash "0x316DB59CD14C1774"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v1493
```
]]
native "0x32CAC93C9DE73D32"
hash "0x32CAC93C9DE73D32"
ns "STATS"
returns "Any"
doc [[!
]]
native "0x33D72899E24C3365"
hash "0x33D72899E24C3365"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "STATS"
returns "Any"
doc [[!
]]
native "0x34770B9CE0E03B91"
hash "0x34770B9CE0E03B91"
jhash (0x766A74FE)
arguments {
Any "p0" [=[ {} ]=],
AnyPtr "p1" [=[ {} ]=],
}
ns "STATS"
returns "BOOL"
doc [[!
]]
native "0x38491439B6BA7F7D"
hash "0x38491439B6BA7F7D"
jhash (0x509A286F)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "STATS"
returns "float"
doc [[!
]]
native "0x38BAAA5DD4C9D19F"
hash "0x38BAAA5DD4C9D19F"
jhash (0x726FAE66)
arguments {
int "value" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
Sets profile setting 934
```
]]
native "0x3DE3AA516FB126A4"
hash "0x3DE3AA516FB126A4"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0x3EBEAC6C3F81F6BD"
hash "0x3EBEAC6C3F81F6BD"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0x419615486BBF1956"
hash "0x419615486BBF1956"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0x44919CC079BB60BF"
hash "0x44919CC079BB60BF"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0x4AFF7E02E485E92B"
hash "0x4AFF7E02E485E92B"
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v1868
```
]]
native "0x4C89FE2BDEB3F169"
hash "0x4C89FE2BDEB3F169"
ns "STATS"
returns "Any"
doc [[!
]]
native "0x4DC416F246A41FC8"
hash "0x4DC416F246A41FC8"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v2189
```
]]
native "0x4FCDBD3F0A813C25"
hash "0x4FCDBD3F0A813C25"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v1868
```
]]
native "0x53C31853EC9531FF"
hash "0x53C31853EC9531FF"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v1868
```
]]
native "0x53CAE13E9B426993"
hash "0x53CAE13E9B426993"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0x55384438FC55AD8E"
hash "0x55384438FC55AD8E"
jhash (0xF03895A4)
arguments {
int "value" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
Sets profile setting 935
```
]]
native "0x55A8BECAF28A4EB7"
hash "0x55A8BECAF28A4EB7"
ns "STATS"
returns "Any"
doc [[!
]]
native "0x5688585E6D563CD8"
hash "0x5688585E6D563CD8"
jhash (0xC62406A6)
arguments {
int "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
STAT_SET_*
```
]]
native "0x5A556B229A169402"
hash "0x5A556B229A169402"
jhash (0x46F21343)
ns "STATS"
returns "BOOL"
doc [[!
]]
native "0x5BD5F255321C4AAF"
hash "0x5BD5F255321C4AAF"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "Any"
doc [[!
]]
native "0x5BF29846C6527C54"
hash "0x5BF29846C6527C54"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v1868
```
]]
native "0x5CDAED54B34B0ED0"
hash "0x5CDAED54B34B0ED0"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v1868
```
]]
native "0x5EAD2BF6484852E4"
hash "0x5EAD2BF6484852E4"
jhash (0x23D70C39)
ns "STATS"
returns "BOOL"
doc [[!
```
example from completionpercentage_controller.ysc.c4
if (STATS::_5EAD2BF6484852E4()) {
MISC::SET_BIT(g_17b95._f20df._ff10, 15);
STATS::_11FF1C80276097ED(0xe9ec4dd1, 200, 0);
}
```
]]
native "0x5FF2C33B13A02A11"
hash "0x5FF2C33B13A02A11"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0x60EEDC12AF66E846"
hash "0x60EEDC12AF66E846"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0x629526ABA383BCAA"
hash "0x629526ABA383BCAA"
ns "STATS"
returns "void"
doc [[!
]]
native "0x6483C25849031C4F"
hash "0x6483C25849031C4F"
jhash (0x2FFD2FA5)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
AnyPtr "p3" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0x6551B1F7F6CD46EA"
hash "0x6551B1F7F6CD46EA"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0x678F86D8FC040BDB"
hash "0x678F86D8FC040BDB"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0x6A60E43998228229"
hash "0x6A60E43998228229"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0x6A7F19756F1A9016"
hash "0x6A7F19756F1A9016"
ns "STATS"
returns "BOOL"
doc [[!
```
NativeDB Introduced: v2060
```
]]
native "0x6BC0ACD0673ACEBE"
hash "0x6BC0ACD0673ACEBE"
arguments {
Any "p0" [=[ {} ]=],
intPtr "valueA" [=[ {} ]=],
intPtr "valueB" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0x6BCCF9948492FD85"
hash "0x6BCCF9948492FD85"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0x6DEE77AFF8C21BD1"
hash "0x6DEE77AFF8C21BD1"
jhash (0x489E27E7)
arguments {
intPtr "playerAccountId" [=[ {"cs_type":"AnyPtr"} ]=],
intPtr "posixTime" [=[ {"cs_type":"AnyPtr"} ]=],
}
ns "STATS"
returns "BOOL"
doc [[!
]]
native "0x6E0A5253375C4584"
hash "0x6E0A5253375C4584"
ns "STATS"
returns "Any"
doc [[!
]]
native "0x6F361B8889A792A3"
hash "0x6F361B8889A792A3"
jhash (0x3B4EF322)
ns "STATS"
returns "void"
doc [[!
]]
native "0x7033EEFD9B28088E"
hash "0x7033EEFD9B28088E"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0x71B008056E5692D6"
hash "0x71B008056E5692D6"
jhash (0xF2DB6A82)
ns "STATS"
returns "void"
doc [[!
]]
native "0x723C1CE13FBFDB67"
hash "0x723C1CE13FBFDB67"
jhash (0x4C39CF10)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0x73001E34F85137F8"
hash "0x73001E34F85137F8"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0x79D310A861697CC9"
hash "0x79D310A861697CC9"
arguments {
int "profileSetting" [=[ {} ]=],
int "settingValue" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
Sets profile setting 940 and 941
_SET_F* - _SET_G*
```
```
NativeDB Introduced: v2699
```
]]
native "0x7B18DA61F6BAE9D5"
hash "0x7B18DA61F6BAE9D5"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0x7D36291161859389"
hash "0x7D36291161859389"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0x7D8BA05688AD64C7"
hash "0x7D8BA05688AD64C7"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0x7E6946F68A38B74F"
hash "0x7E6946F68A38B74F"
jhash (0x22804C20)
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "BOOL"
doc [[!
]]
native "0x7EEC2A316C250073"
hash "0x7EEC2A316C250073"
jhash (0x30558CFD)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
_PLAYSTATS_ROB_ARMOURD_TRUCK
```
]]
native "0x7F2C4CDF2E82DF4C"
hash "0x7F2C4CDF2E82DF4C"
jhash (0x0BF0F4B2)
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "BOOL"
doc [[!
]]
native "0x810B5FCC52EC7FF0"
hash "0x810B5FCC52EC7FF0"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v1868
```
]]
native "0x830C3A44EB3F2CF9"
hash "0x830C3A44EB3F2CF9"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v1493
```
]]
native "0x84A810B375E69C0E"
hash "0x84A810B375E69C0E"
ns "STATS"
returns "Any"
doc [[!
]]
native "0x84DFC579C2FC214C"
hash "0x84DFC579C2FC214C"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0x88087EE1F28024AE"
hash "0x88087EE1F28024AE"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0x88578F6EC36B4A3A"
hash "0x88578F6EC36B4A3A"
jhash (0x6B90E730)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "STATS"
returns "Any"
doc [[!
]]
native "0x8989CBD7B4E82534"
hash "0x8989CBD7B4E82534"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
Any "p6" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0x8B9CDBD6C566C38C"
hash "0x8B9CDBD6C566C38C"
ns "STATS"
returns "Any"
doc [[!
]]
native "0x8C9D11605E59D955"
hash "0x8C9D11605E59D955"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0x8D8ADB562F09A245"
hash "0x8D8ADB562F09A245"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0x8EC74CEB042E7CFF"
hash "0x8EC74CEB042E7CFF"
jhash (0x88AE9667)
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0x92FC0EEDFAC04A14"
hash "0x92FC0EEDFAC04A14"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v1868
```
]]
native "0x930F504203F561C9"
hash "0x930F504203F561C9"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0x96E6D5150DBF1C09"
hash "0x96E6D5150DBF1C09"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0x98E2BC1CA26287C3"
hash "0x98E2BC1CA26287C3"
ns "STATS"
returns "void"
doc [[!
]]
native "0x9A62EC95AE10E011"
hash "0x9A62EC95AE10E011"
ns "STATS"
returns "int"
doc [[!
]]
native "0x9B4BD21D69B1E609"
hash "0x9B4BD21D69B1E609"
ns "STATS"
returns "void"
doc [[!
]]
native "0x9EC8858184CD253A"
hash "0x9EC8858184CD253A"
ns "STATS"
returns "Any"
doc [[!
]]
native "0xA0F93D5465B3094D"
hash "0xA0F93D5465B3094D"
jhash (0xC977D6E2)
arguments {
AnyPtr "p0" [=[ {} ]=],
}
ns "STATS"
returns "BOOL"
doc [[!
]]
native "0xA3C53804BDB68ED2"
hash "0xA3C53804BDB68ED2"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0xA6F54BB2FFCA35EA"
hash "0xA6F54BB2FFCA35EA"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0xA736CF7FB7C5BFF4"
hash "0xA736CF7FB7C5BFF4"
jhash (0x31002201)
arguments {
AnyPtr "p0" [=[ {} ]=],
AnyPtr "p1" [=[ {} ]=],
AnyPtr "p2" [=[ {} ]=],
AnyPtr "p3" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0xA761D4AC6115623D"
hash "0xA761D4AC6115623D"
ns "STATS"
returns "Any"
doc [[!
]]
native "0xA78B8FA58200DA56"
hash "0xA78B8FA58200DA56"
jhash (0xE3247582)
arguments {
int "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
STATS::0xE3247582(0);
STATS::0xE3247582(1);
STATS::0xE3247582(2);
STATS::0xE3247582(3);
STATS::0xE3247582(4);
STATS::0xE3247582(5);
STATS::0xE3247582(6);
```
]]
native "0xA8733668D1047B51"
hash "0xA8733668D1047B51"
jhash (0x395D18B1)
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0xA943FD1722E11EFD"
hash "0xA943FD1722E11EFD"
ns "STATS"
returns "Any"
doc [[!
]]
native "0xAA525DFF66BB82F5"
hash "0xAA525DFF66BB82F5"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0xAFF47709F1D5DCCE"
hash "0xAFF47709F1D5DCCE"
ns "STATS"
returns "Any"
doc [[!
]]
native "0xB1D2BB1E1631F5B1"
hash "0xB1D2BB1E1631F5B1"
jhash (0x02F283CE)
ns "STATS"
returns "BOOL"
doc [[!
]]
native "0xB26F670685631727"
hash "0xB26F670685631727"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Added Parameter 2: Any p1
NativeDB Introduced: v1493
```
]]
native "0xB3DA2606774A8E2D"
hash "0xB3DA2606774A8E2D"
ns "STATS"
returns "BOOL"
doc [[!
```
This function is hard-coded to always return 1.
NETWORK_IS_*
```
]]
native "0xBA9749CC94C1FD85"
hash "0xBA9749CC94C1FD85"
ns "STATS"
returns "Any"
doc [[!
]]
native "0xBAA2F0490E146BE8"
hash "0xBAA2F0490E146BE8"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0xBE3DB208333D9844"
hash "0xBE3DB208333D9844"
ns "STATS"
returns "Any"
doc [[!
]]
native "0xBED9F5693F34ED17"
hash "0xBED9F5693F34ED17"
jhash (0xC4110917)
arguments {
Hash "statName" [=[ {} ]=],
int "p1" [=[ {} ]=],
floatPtr "outValue" [=[ {} ]=],
}
ns "STATS"
returns "BOOL"
doc [[!
]]
native "0xBF371CD2B64212FD"
hash "0xBF371CD2B64212FD"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0xBFAFDB5FAAA5C5AB"
hash "0xBFAFDB5FAAA5C5AB"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0xC01D2470F22CDE5A"
hash "0xC01D2470F22CDE5A"
ns "STATS"
returns "void"
doc [[!
**This native does absolutely nothing, just a nullsub**
```
NativeDB Introduced: v2372
```
]]
native "0xC03FAB2C2F92289B"
hash "0xC03FAB2C2F92289B"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v1868
```
]]
native "0xC0E0D686DDFC6EAE"
hash "0xC0E0D686DDFC6EAE"
jhash (0x099FCC86)
ns "STATS"
returns "Any"
doc [[!
]]
native "0xC141B8917E0017EC"
hash "0xC141B8917E0017EC"
jhash (0x0AD43306)
ns "STATS"
returns "void"
doc [[!
]]
native "0xC14BD9F5337219B2"
hash "0xC14BD9F5337219B2"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Added Parameter 2: Any p1
NativeDB Introduced: v1493
```
]]
native "0xC1E963C58664B556"
hash "0xC1E963C58664B556"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v2189
```
]]
native "0xC67E2DA1CBE759E2"
hash "0xC67E2DA1CBE759E2"
ns "STATS"
returns "void"
doc [[!
Sets profile setting 939
```
NativeDB Introduced: v1734
```
]]
native "0xC6E0E2616A7576BB"
hash "0xC6E0E2616A7576BB"
ns "STATS"
returns "Any"
doc [[!
]]
native "0xC847B43F369AC0B5"
hash "0xC847B43F369AC0B5"
ns "STATS"
returns "void"
doc [[!
]]
native "0xCC25A4553DFBF9EA"
hash "0xCC25A4553DFBF9EA"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0xD1A1EE3B4FA8E760"
hash "0xD1A1EE3B4FA8E760"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0xD1C9B92BDD3F151D"
hash "0xD1C9B92BDD3F151D"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0xD4367D310F079DB0"
hash "0xD4367D310F079DB0"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v2189
```
]]
native "0xD558BEC0BBA7E8D2"
hash "0xD558BEC0BBA7E8D2"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0xD6CA58B3B53A0F22"
hash "0xD6CA58B3B53A0F22"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v2189
```
]]
native "0xDAF80797FC534BEC"
hash "0xDAF80797FC534BEC"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0xDEAAF77EB3687E97"
hash "0xDEAAF77EB3687E97"
arguments {
Any "p0" [=[ {} ]=],
AnyPtr "p1" [=[ {} ]=],
}
ns "STATS"
returns "Any"
doc [[!
]]
native "0xDFBD93BF2943E29B"
hash "0xDFBD93BF2943E29B"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v1868
```
]]
native "0xDFCDB14317A9B361"
hash "0xDFCDB14317A9B361"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v2189
```
]]
native "0xE3261D791EB44ACB"
hash "0xE3261D791EB44ACB"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0xE496A53BA5F50A56"
hash "0xE496A53BA5F50A56"
jhash (0xCE6B62B5)
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "Any"
doc [[!
]]
native "0xE8853FBCE7D8D0D6"
hash "0xE8853FBCE7D8D0D6"
ns "STATS"
returns "Any"
doc [[!
]]
native "0xECB41AC6AB754401"
hash "0xECB41AC6AB754401"
jhash (0xED7000C8)
ns "STATS"
returns "BOOL"
doc [[!
```
STAT_LOAD_*
```
]]
native "0xEDBF6C9B0D2C65C8"
hash "0xEDBF6C9B0D2C65C8"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0xF06A6F41CB445443"
hash "0xF06A6F41CB445443"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0xF11F01D98113536A"
hash "0xF11F01D98113536A"
arguments {
floatPtr "p0" [=[ {} ]=],
}
ns "STATS"
returns "Any"
doc [[!
]]
native "0xF1A1803D3476F215"
hash "0xF1A1803D3476F215"
jhash (0xA3DAC790)
arguments {
int "value" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
Sets profile setting 933
```
]]
native "0xF534D94DFA2EAD26"
hash "0xF534D94DFA2EAD26"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0xF8C54A461C3E11DC"
hash "0xF8C54A461C3E11DC"
jhash (0x04181752)
arguments {
AnyPtr "p0" [=[ {} ]=],
AnyPtr "p1" [=[ {} ]=],
AnyPtr "p2" [=[ {} ]=],
AnyPtr "p3" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "0xF9096193DF1F99D4"
hash "0xF9096193DF1F99D4"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
```
NativeDB Introduced: v1868
```
]]
native "0xF9F2922717B819EC"
hash "0xF9F2922717B819EC"
ns "STATS"
returns "Any"
doc [[!
]]
native "0xFCC228E07217FCAC"
hash "0xFCC228E07217FCAC"
arguments {
Any "p0" [=[ {} ]=],
}
ns "STATS"
returns "void"
doc [[!
]]
native "ADD_EXTRA_CALMING_QUAD"
hash "0xFDBF4CDBC07E1706"
jhash (0xA9419B6D)
arguments {
float "xLow" [=[ {} ]=],
float "yLow" [=[ {} ]=],
float "xHigh" [=[ {} ]=],
float "yHigh" [=[ {} ]=],
float "height" [=[ {} ]=],
}
alias "0xFDBF4CDBC07E1706"
alias "_ADD_CURRENT_RISE"
ns "WATER"
returns "int"
doc [[!
Only 8 current rises can exist. If rises need to be changed, use REMOVE_EXTRA_CALMING_QUAD and then ADD_EXTRA_CALMING_QUAD again.
After removing a rise, you will be able to add a rise again.
If succeeded to add, returns a rise index that can be used on REMOVE_EXTRA_CALMING_QUAD.
If failed to add, returns -1 (make sure you don't pass -1 to REMOVE_EXTRA_CALMING_QUAD).
]]
native "GET_DEEP_OCEAN_SCALER"
hash "0x2B2A2CC86778B619"
jhash (0xBD0A67FB)
alias "0x2B2A2CC86778B619"
alias "_GET_WAVES_INTENSITY"
alias "_GET_CURRENT_INTENSITY"
ns "WATER"
returns "float"
doc [[!
```
Gets the aggressiveness factor of the ocean waves.
```
]]
native "GET_WATER_HEIGHT"
hash "0xF6829842C06AE524"
jhash (0xD864E17C)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
floatPtr "height" [=[ {} ]=],
}
ns "WATER"
returns "BOOL"
doc [[!
Retrieves the depth of the water beneath the specified position, accounting for the waves.
**Note:** The result might vary depending on the specific frame when this command is executed due to wave fluctuations.
The coordinate at which to test at for water.
The coordinate at which to test at for water.
The coordinate at which to test at for water.
The height at which to test at for water.
Returns `false` when land at the tested coordinates is higher than water, `true` otherwise.
]]
native "GET_WATER_HEIGHT_NO_WAVES"
hash "0x8EE6B53CE13A9794"
jhash (0x262017F8)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
floatPtr "height" [=[ {} ]=],
}
ns "WATER"
returns "BOOL"
doc [[!
Retrieves the depth of the water beneath the specified position, disregarding wave effects.
**Note:** The result remains consistent across different frames as it doesn't consider wave fluctuations.
]]
native "MODIFY_WATER"
hash "0xC443FD757C3BA637"
jhash (0xC49E005A)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "height" [=[ {} ]=],
float "radius" [=[ {} ]=],
}
ns "WATER"
returns "void"
doc [[!
```
Sets the water height for a given position and radius.
```
]]
native "RESET_DEEP_OCEAN_SCALER"
hash "0x5E5E99285AE812DB"
jhash (0x4AD23212)
alias "0x5E5E99285AE812DB"
alias "_RESET_WAVES_INTENSITY"
alias "_RESET_CURRENT_INTENSITY"
ns "WATER"
returns "void"
doc [[!
```
Sets the waves intensity back to original (1.0 in most cases).
```
]]
native "SET_DEEP_OCEAN_SCALER"
hash "0xB96B00E976BE977F"
jhash (0x53B694B1)
arguments {
float "intensity" [=[ {} ]=],
}
alias "0xB96B00E976BE977F"
alias "_SET_WAVES_INTENSITY"
alias "_SET_CURRENT_INTENSITY"
ns "WATER"
returns "void"
doc [[!
```
Sets a value that determines how aggressive the ocean waves will be. Values of 2.0 or more make for very aggressive waves like you see during a thunderstorm.
Works only ~200 meters around the player.
```
]]
native "TEST_PROBE_AGAINST_ALL_WATER"
hash "0x8974647ED222EA5F"
jhash (0x4A962D55)
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
int "flag" [=[ {} ]=],
Vector3Ptr "result" [=[ {} ]=],
}
ns "WATER"
returns "BOOL"
doc [[!
Flags are identical to START_SHAPE_TEST\*, however, 128 is automatically set.
See [`START_SHAPE_TEST_LOS_PROBE`](#\_0x7EE9F5D83DD4F90E)
]]
native "TEST_PROBE_AGAINST_WATER"
hash "0xFFA5D878809819DB"
jhash (0xAA4AE00C)
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
Vector3Ptr "result" [=[ {} ]=],
}
ns "WATER"
returns "BOOL"
doc [[!
]]
native "TEST_VERTICAL_PROBE_AGAINST_ALL_WATER"
hash "0x2B3451FA1E3142E2"
jhash (0x4C71D143)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
int "flag" [=[ {} ]=],
floatPtr "height" [=[ {} ]=],
}
ns "WATER"
returns "BOOL"
doc [[!
See [`START_SHAPE_TEST_LOS_PROBE`](#\_0x7EE9F5D83DD4F90E)
]]
native "_REMOVE_CURRENT_RISE"
hash "0xB1252E3E59A82AAF"
jhash (0x7DBCEF6F)
arguments {
int "p0" [=[ {} ]=],
}
alias "0xB1252E3E59A82AAF"
ns "WATER"
returns "void"
doc [[!
```
p0 is the handle returned from _0xFDBF4CDBC07E1706
```
]]
native "0x547237AA71AB44DE"
hash "0x547237AA71AB44DE"
jhash (0x6F5A07BA)
arguments {
float "p0" [=[ {} ]=],
}
ns "WATER"
returns "void"
doc [[!
]]
native "ADD_AMMO_TO_PED"
hash "0x78F0424C34306220"
jhash (0x7F0580C7)
arguments {
Ped "ped" [=[ {} ]=],
Hash "weaponHash" [=[ {} ]=],
int "ammo" [=[ {} ]=],
}
ns "WEAPON"
returns "void"
doc [[!
]]
native "CAN_USE_WEAPON_ON_PARACHUTE"
hash "0xBC7BE5ABC0879F74"
jhash (0x135E7AD4)
arguments {
Hash "weaponHash" [=[ {} ]=],
}
ns "WEAPON"
returns "BOOL"
doc [[!
```
this returns if you can use the weapon while using a parachute
```
]]
native "CLEAR_ENTITY_LAST_WEAPON_DAMAGE"
hash "0xAC678E40BE7C74D2"
jhash (0xCEC2732B)
arguments {
Entity "entity" [=[ {} ]=],
}
ns "WEAPON"
returns "void"
doc [[!
]]
native "CLEAR_PED_LAST_WEAPON_DAMAGE"
hash "0x0E98F88A24C5F4B8"
jhash (0x52C68832)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "WEAPON"
returns "void"
doc [[!
Does NOT seem to work with HAS_PED_BEEN_DAMAGED_BY_WEAPON. Use CLEAR_ENTITY_LAST_WEAPON_DAMAGE and HAS_ENTITY_BEEN_DAMAGED_BY_WEAPON instead.
]]
native "CREATE_AIR_DEFENCE_ANGLED_AREA"
hash "0x9DA58CDBF6BDBC08"
jhash (0x7F1E89F4)
arguments {
float "srcCoord1X" [=[ {} ]=],
float "srcCoord1Y" [=[ {} ]=],
float "srcCoord1Z" [=[ {} ]=],
float "srcCoord2X" [=[ {} ]=],
float "srcCoord2Y" [=[ {} ]=],
float "srcCoord2Z" [=[ {} ]=],
float "fWidth" [=[ {} ]=],
float "weaponPositionX" [=[ {} ]=],
float "weaponPositionY" [=[ {} ]=],
float "weaponPositionZ" [=[ {} ]=],
Hash "weaponHash" [=[ {"cs_type":"Any"} ]=],
}
alias "0x9DA58CDBF6BDBC08"
alias "_CREATE_AIR_DEFENSE_AREA"
ns "WEAPON"
returns "int"
doc [[!
]]
native "CREATE_AIR_DEFENCE_SPHERE"
hash "0x91EF34584710BE99"
jhash (0x767C2435)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "radius" [=[ {"cs_type":"int"} ]=],
float "weaponPositionX" [=[ {} ]=],
float "weaponPositionY" [=[ {} ]=],
float "weaponPositionZ" [=[ {} ]=],
Hash "weaponHash" [=[ {} ]=],
}
alias "0x91EF34584710BE99"
alias "_CREATE_AIR_DEFENSE_SPHERE"
ns "WEAPON"
returns "int"
doc [[!
Both coordinates are from objects in the decompiled scripts.
Native related to [\_0xECDC202B25E5CF48](#\_0xECDC202B25E5CF48) p1 value. The only weapon hash used in the decompiled scripts is weapon_air_defence_gun. These two natives are used by the yacht script, decompiled scripts suggest it and the weapon hash used (valkyrie's rockets) are also used by yachts.
Unknown float 150.0 is used in freemode script.
weapon_air_defence_gun and 0 are used in the decompiled scripts.
Seems to be some sort of handle, result is += 1 any time this native is called.
]]
native "CREATE_WEAPON_OBJECT"
hash "0x9541D3CF0D398F36"
jhash (0x62F5987F)
arguments {
Hash "weaponHash" [=[ {} ]=],
int "ammoCount" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
BOOL "bCreateDefaultComponents" [=[ {} ]=],
float "scale" [=[ {} ]=],
int "customModelHash" [=[ {} ]=],
}
ns "WEAPON"
returns "Object"
doc [[!
Create a weapon object that cannot be attached to a ped. If you want to create a weapon object that can be attached to a ped, use [`CREATE_OBJECT`](#\_0x509D5878EB39E842) instead.
```
NativeDB Added Parameter 9: BOOL bRegisterAsNetworkObject
NativeDB Added Parameter 10: BOOL bScriptHostObject
```
The hash of the weapon to create.
The amount of ammo for the weapon.
X coordinate for the weapon's position.
Y coordinate for the weapon's position.
Z coordinate for the weapon's position.
Boolean that indicates whether the default components should be created for that weapon (`true`/`false`).
The size of the object, to increase it, set the scale to a value greater than `1.0`.
The hash of the custom model to use for the weapon object. Set to `0` if you do not intend to use a custom model hash.
]]
native "DOES_WEAPON_TAKE_WEAPON_COMPONENT"
hash "0x5CEE3DF569CECAB0"
jhash (0xB1817BAA)
arguments {
Hash "weaponHash" [=[ {} ]=],
Hash "componentHash" [=[ {} ]=],
}
ns "WEAPON"
returns "BOOL"
doc [[!
]]
native "ENABLE_LASER_SIGHT_RENDERING"
hash "0xC8B46D7727D864AA"
jhash (0xE3438955)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "WEAPON"
returns "void"
doc [[!
```
Enables laser sight on any weapon.
It doesn't work. Neither on tick nor OnKeyDown
```
]]
native "EXPLODE_PROJECTILES"
hash "0xFC4BD125DE7611E4"
jhash (0x35A0B955)
arguments {
Ped "ped" [=[ {} ]=],
Hash "weaponHash" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "WEAPON"
returns "void"
doc [[!
```
WEAPON::EXPLODE_PROJECTILES(PLAYER::PLAYER_PED_ID(), func_221(0x00000003), 0x00000001);
```
]]
native "GET_AMMO_IN_CLIP"
hash "0x2E1202248937775C"
jhash (0x73C100C3)
arguments {
Ped "ped" [=[ {} ]=],
Hash "weaponHash" [=[ {} ]=],
intPtr "ammo" [=[ {} ]=],
}
ns "WEAPON"
returns "BOOL"
doc [[!
]]
native "GET_AMMO_IN_PED_WEAPON"
hash "0x015A522136D7F951"
jhash (0x0C755733)
arguments {
Ped "ped" [=[ {} ]=],
Hash "weaponhash" [=[ {} ]=],
}
ns "WEAPON"
returns "int"
doc [[!
```
WEAPON::GET_AMMO_IN_PED_WEAPON(PLAYER::PLAYER_PED_ID(), a_0)
From decompiled scripts
Returns total ammo in weapon
GTALua Example :
natives.WEAPON.GET_AMMO_IN_PED_WEAPON(plyPed, WeaponHash)
```
]]
native "GET_BEST_PED_WEAPON"
hash "0x8483E98E8B888AE2"
jhash (0xB998D444)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "ignoreAmmoCount" [=[ {} ]=],
}
ns "WEAPON"
returns "Hash"
doc [[!
If set to true, the best weapon can have no ammo, otherwise, it will return the best weapon with ammo. Default value is `0`.
The hash of the best weapon the specified ped has
]]
native "GET_CURRENT_PED_VEHICLE_WEAPON"
hash "0x1017582BCD3832DC"
jhash (0xF26C5D65)
arguments {
Ped "ped" [=[ {} ]=],
HashPtr "weaponHash" [=[ {} ]=],
}
ns "WEAPON"
returns "BOOL"
doc [[!
]]
native "GET_CURRENT_PED_WEAPON"
hash "0x3A87E44BB9A01D54"
jhash (0xB0237302)
arguments {
Ped "ped" [=[ {} ]=],
HashPtr "weaponHash" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "WEAPON"
returns "BOOL"
doc [[!
```
The return value seems to indicate returns true if the hash of the weapon object weapon equals the weapon hash.
p2 seems to be 1 most of the time; and is not implemented.
```
]]
native "GET_CURRENT_PED_WEAPON_ENTITY_INDEX"
hash "0x3B390A939AF0B5FC"
jhash (0x5D73CD20)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "WEAPON"
returns "Entity"
doc [[!
```
NativeDB Added Parameter 2: Any p1
```
]]
native "GET_IS_PED_GADGET_EQUIPPED"
hash "0xF731332072F5156C"
jhash (0x8DDD0B5B)
arguments {
Ped "ped" [=[ {} ]=],
Hash "gadgetHash" [=[ {} ]=],
}
ns "WEAPON"
returns "BOOL"
doc [[!
```
gadgetHash - was always 0xFBAB5776 ("GADGET_PARACHUTE").
```
]]
native "GET_LOCKON_DISTANCE_OF_CURRENT_PED_WEAPON"
hash "0x840F03E9041E2C9C"
jhash (0x3612110D)
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0x840F03E9041E2C9C"
alias "_GET_LOCKON_RANGE_OF_CURRENT_PED_WEAPON"
ns "WEAPON"
returns "float"
doc [[!
]]
native "GET_MAX_AMMO"
hash "0xDC16122C7A20C933"
jhash (0x0B294796)
arguments {
Ped "ped" [=[ {} ]=],
Hash "weaponHash" [=[ {} ]=],
intPtr "ammo" [=[ {} ]=],
}
ns "WEAPON"
returns "BOOL"
doc [[!
]]
native "GET_MAX_AMMO_IN_CLIP"
hash "0xA38DCFFCEA8962FA"
jhash (0x6961E2A4)
arguments {
Ped "ped" [=[ {} ]=],
Hash "weaponHash" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "WEAPON"
returns "int"
doc [[!
```
p2 is mostly 1 in the scripts.
```
]]
native "GET_MAX_RANGE_OF_CURRENT_PED_WEAPON"
hash "0x814C9D19DFD69679"
jhash (0xB2B2BBAA)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "WEAPON"
returns "float"
doc [[!
]]
native "GET_PED_AMMO_BY_TYPE"
hash "0x39D22031557946C1"
jhash (0x54077C4D)
arguments {
Ped "ped" [=[ {} ]=],
Hash "ammoType" [=[ {"cs_type":"Any"} ]=],
}
ns "WEAPON"
returns "int"
doc [[!
]]
native "GET_PED_AMMO_TYPE_FROM_WEAPON"
hash "0x7FEAD38B326B9F74"
jhash (0x09337863)
arguments {
Ped "ped" [=[ {} ]=],
Hash "weaponHash" [=[ {} ]=],
}
alias "_GET_PED_AMMO_TYPE"
ns "WEAPON"
returns "Hash"
doc [[!
```
Returns the current ammo type of the specified ped's specified weapon.
MkII magazines will change the return value, like Pistol MkII returning AMMO_PISTOL without any components and returning AMMO_PISTOL_TRACER after Tracer Rounds component is attached.
Use 0xF489B44DD5AF4BD9 if you always want AMMO_PISTOL.
```
]]
native "GET_PED_LAST_WEAPON_IMPACT_COORD"
hash "0x6C4D0409BA1A2BC2"
jhash (0x9B266079)
arguments {
Ped "ped" [=[ {} ]=],
Vector3Ptr "coords" [=[ {} ]=],
}
ns "WEAPON"
returns "BOOL"
doc [[!
```
Pass ped. Pass address of Vector3.
The coord will be put into the Vector3.
The return will determine whether there was a coord found or not.
```
]]
native "GET_PED_WEAPON_TINT_INDEX"
hash "0x2B9EEDC07BD06B9F"
jhash (0x3F9C90A7)
arguments {
Ped "ped" [=[ {} ]=],
Hash "weaponHash" [=[ {} ]=],
}
ns "WEAPON"
returns "int"
doc [[!
]]
native "GET_PED_WEAPONTYPE_IN_SLOT"
hash "0xEFFED78E9011134D"
jhash (0x9BC64E16)
arguments {
Ped "ped" [=[ {} ]=],
Hash "weaponSlot" [=[ {} ]=],
}
ns "WEAPON"
returns "Hash"
doc [[!
]]
native "GET_SELECTED_PED_WEAPON"
hash "0x0A6DB4965674D243"
jhash (0xD240123E)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "WEAPON"
returns "Hash"
doc [[!
]]
native "GET_WEAPON_CLIP_SIZE"
hash "0x583BE370B1EC6EB4"
jhash (0x8D515E66)
arguments {
Hash "weaponHash" [=[ {} ]=],
}
ns "WEAPON"
returns "int"
doc [[!
```
// Returns the size of the default weapon component clip.
Use it like this:
char cClipSize[32];
Hash cur;
if (WEAPON::GET_CURRENT_PED_WEAPON(playerPed, &cur, 1))
{
if (WEAPON::IS_WEAPON_VALID(cur))
{
int iClipSize = WEAPON::GET_WEAPON_CLIP_SIZE(cur);
sprintf_s(cClipSize, "ClipSize: %.d", iClipSize);
vDrawString(cClipSize, 0.5f, 0.5f);
}
}
```
]]
native "GET_WEAPON_COMPONENT_HUD_STATS"
hash "0xB3CAF387AE12E9F8"
jhash (0xBB5498F4)
arguments {
Hash "componentHash" [=[ {} ]=],
intPtr "outData" [=[ {} ]=],
}
ns "WEAPON"
returns "BOOL"
doc [[!
]]
native "GET_WEAPON_COMPONENT_TYPE_MODEL"
hash "0x0DB57B41EC1DB083"
jhash (0x324FA47A)
arguments {
Hash "componentHash" [=[ {} ]=],
}
ns "WEAPON"
returns "Hash"
doc [[!
]]
native "GET_WEAPON_DAMAGE"
hash "0x3133B907D8B32053"
jhash (0xE81649C0)
arguments {
Hash "weaponHash" [=[ {} ]=],
Hash "componentHash" [=[ {"cs_type":"Any"} ]=],
}
alias "0x3133B907D8B32053"
alias "_GET_WEAPON_DAMAGE"
ns "WEAPON"
returns "float"
doc [[!
This native does not return damages of weapons from the melee and explosive group.
0 in the decompiled scripts.
Damages of the weapon.
]]
native "GET_WEAPON_DAMAGE_TYPE"
hash "0x3BE0BB12D25FB305"
jhash (0x013AFC13)
arguments {
Hash "weaponHash" [=[ {} ]=],
}
ns "WEAPON"
returns "int"
doc [[!
```
0=unknown (or incorrect weaponHash)
1= no damage (flare,snowball, petrolcan)
2=melee
3=bullet
4=force ragdoll fall
5=explosive (RPG, Railgun, grenade)
6=fire(molotov)
8=fall(WEAPON_HELI_CRASH)
10=electric
11=barbed wire
12=extinguisher
13=gas
14=water cannon(WEAPON_HIT_BY_WATER_CANNON)
```
]]
native "GET_WEAPON_HUD_STATS"
hash "0xD92C739EE34C9EBA"
jhash (0xA9AD3D98)
arguments {
Hash "weaponHash" [=[ {} ]=],
AnyPtr "outData" [=[ {} ]=],
}
ns "WEAPON"
returns "BOOL"
doc [[!
```
// members should be aligned to 8 bytes by default but it's best to use alignas here, just to be sure
struct WeaponHudStatsData
{
alignas(8) uint8_t hudDamage; // 0x0000
alignas(8) uint8_t hudSpeed; // 0x0008
alignas(8) uint8_t hudCapacity; // 0x0010
alignas(8) uint8_t hudAccuracy; // 0x0018
alignas(8) uint8_t hudRange; // 0x0020
};
Usage:
WeaponHudStatsData data;
if (GET_WEAPON_HUD_STATS(weaponHash, (Any*)&data))
{
// uint8_t damagePercentage = data.hudDamage etc...
}
```
]]
native "GET_WEAPON_OBJECT_FROM_PED"
hash "0xCAE1DC9A0E22A16D"
jhash (0xDF939A38)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "WEAPON"
returns "Object"
doc [[!
```
Drops the current weapon and returns the object
Unknown behavior when unarmed.
```
]]
native "GET_WEAPON_OBJECT_TINT_INDEX"
hash "0xCD183314F7CD2E57"
jhash (0xD91D9576)
arguments {
Object "weapon" [=[ {} ]=],
}
ns "WEAPON"
returns "int"
doc [[!
]]
native "GET_WEAPON_TINT_COUNT"
hash "0x5DCF6C5CAB2E9BF7"
jhash (0x99E4EAAB)
arguments {
Hash "weaponHash" [=[ {} ]=],
}
ns "WEAPON"
returns "int"
doc [[!
]]
native "GET_WEAPONTYPE_GROUP"
hash "0xC3287EE3050FB74C"
jhash (0x5F2DE833)
arguments {
Hash "weaponHash" [=[ {} ]=],
}
ns "WEAPON"
returns "Hash"
doc [[!
Gets and returns the hash of the group of the specified weapon (group names can be found/changed under "Group" in the weapons' meta file).
Note that the group is **not** the same as the location on the weapon wheel.
The hash of the weapon.
Returns the hash of the group of the weapon. Hashes:| Group | Unsigned | Signed | Example |
|:----------------------:|:----------:|:-----------:|:-----------------------:|
| GROUP_DIGISCANNER | 3539449195 | -755518101 | WEAPON_DIGISCANNER |
| GROUP_FIREEXTINGUISHER | 4257178988 | -37788308 | WEAPON_FIREEXTINGUISHER |
| GROUP_HACKINGDEVICE | 1175761940 | 1175761940 | WEAPON_HACKINGDEVICE |
| GROUP_HEAVY | 2725924767 | -1569042529 | WEAPON_RPG |
| GROUP_MELEE | 3566412244 | -728555052 | WEAPON_BAT |
| GROUP_METALDETECTOR | 3759491383 | -535475913 | WEAPON_METALDETECTOR |
| GROUP_MG | 1159398588 | 1159398588 | WEAPON_COMBATMG |
| GROUP_NIGHTVISION | 3493187224 | -801780072 | GADGET_NIGHTVISION |
| GROUP_PARACHUTE | 431593103 | 431593103 | GADGET_PARACHUTE |
| GROUP_PETROLCAN | 1595662460 | 1595662460 | WEAPON_PETROLCAN |
| GROUP_PISTOL | 416676503 | 416676503 | WEAPON_PISTOL |
| GROUP_RIFLE | 970310034 | 970310034 | WEAPON_ASSAULTRIFLE |
| GROUP_SHOTGUN | 860033945 | 860033945 | WEAPON_PUMPSHOTGUN |
| GROUP_SMG | 3337201093 | -957766203 | WEAPON_MICROSMG |
| GROUP_SNIPER | 3082541095 | -1212426201 | WEAPON_SNIPERRIFLE |
| GROUP_STUNGUN | 690389602 | 690389602 | WEAPON_STUNGUN |
| GROUP_THROWN | 1548507267 | 1548507267 | WEAPON_SNOWBALL |
| GROUP_TRANQILIZER | 75159441 | 75159441 | WEAPON_TRANQUILIZER |
| GROUP_UNARMED | 2685387236 | -1609580060 | WEAPON_UNARMED |
]]
native "GET_WEAPONTYPE_MODEL"
hash "0xF46CDC33180FDA94"
jhash (0x44E1C269)
arguments {
Hash "weaponHash" [=[ {} ]=],
}
ns "WEAPON"
returns "Hash"
doc [[!
```
Returns the model of any weapon.
Can also take an ammo hash?
sub_6663a(&l_115B, WEAPON::GET_WEAPONTYPE_MODEL(${ammo_rpg}));
```
]]
native "GET_WEAPONTYPE_SLOT"
hash "0x4215460B9B8B7FA0"
jhash (0x2E3759AF)
arguments {
Hash "weaponHash" [=[ {} ]=],
}
ns "WEAPON"
returns "Hash"
doc [[!
]]
native "GIVE_DELAYED_WEAPON_TO_PED"
hash "0xB282DC6EBD803C75"
jhash (0x5868D20D)
arguments {
Ped "ped" [=[ {} ]=],
Hash "weaponHash" [=[ {} ]=],
int "ammoCount" [=[ {} ]=],
BOOL "bForceInHand" [=[ {} ]=],
}
ns "WEAPON"
returns "void"
doc [[!
```
Gives a weapon to PED with a delay, example:
WEAPON::GIVE_DELAYED_WEAPON_TO_PED(PED::PLAYER_PED_ID(), MISC::GET_HASH_KEY("WEAPON_PISTOL"), 1000, false)
```
]]
native "GIVE_WEAPON_COMPONENT_TO_PED"
hash "0xD966D51AA5B28BB9"
jhash (0x3E1E286D)
arguments {
Ped "ped" [=[ {} ]=],
Hash "weaponHash" [=[ {} ]=],
Hash "componentHash" [=[ {} ]=],
}
ns "WEAPON"
returns "void"
doc [[!
]]
native "GIVE_WEAPON_COMPONENT_TO_WEAPON_OBJECT"
hash "0x33E179436C0B31DB"
jhash (0xF7612A37)
arguments {
Object "weaponObject" [=[ {} ]=],
Hash "addonHash" [=[ {} ]=],
}
ns "WEAPON"
returns "void"
doc [[!
```
addonHash:
(use WEAPON::GET_WEAPON_COMPONENT_TYPE_MODEL() to get hash value)
${component_at_ar_flsh}, ${component_at_ar_supp}, ${component_at_pi_flsh}, ${component_at_scope_large}, ${component_at_ar_supp_02}
```
]]
native "GIVE_WEAPON_OBJECT_TO_PED"
hash "0xB1FA61371AF7C4B7"
jhash (0x639AF3EF)
arguments {
Object "weaponObject" [=[ {} ]=],
Ped "ped" [=[ {} ]=],
}
ns "WEAPON"
returns "void"
doc [[!
]]
native "GIVE_WEAPON_TO_PED"
hash "0xBF0FD6E56C964FCB"
jhash (0xC4D88A85)
arguments {
Ped "ped" [=[ {} ]=],
Hash "weaponHash" [=[ {} ]=],
int "ammoCount" [=[ {} ]=],
BOOL "isHidden" [=[ {} ]=],
BOOL "bForceInHand" [=[ {} ]=],
}
ns "WEAPON"
returns "void"
doc [[!
]]
native "HAS_ENTITY_BEEN_DAMAGED_BY_WEAPON"
hash "0x131D401334815E94"
jhash (0x6DAABB39)
arguments {
Entity "entity" [=[ {} ]=],
Hash "weaponHash" [=[ {} ]=],
int "weaponType" [=[ {} ]=],
}
ns "WEAPON"
returns "BOOL"
doc [[!
```
It determines what weapons caused damage:
If you want to define only a specific weapon, second parameter=weapon hash code, third parameter=0
If you want to define any melee weapon, second parameter=0, third parameter=1.
If you want to identify any weapon (firearms, melee, rockets, etc.), second parameter=0, third parameter=2.
```
]]
native "HAS_PED_BEEN_DAMAGED_BY_WEAPON"
hash "0x2D343D2219CD027A"
jhash (0xCDFBBCC6)
arguments {
Ped "ped" [=[ {} ]=],
Hash "weaponHash" [=[ {} ]=],
int "weaponType" [=[ {} ]=],
}
ns "WEAPON"
returns "BOOL"
doc [[!
```
It determines what weapons caused damage:
If you want to define only a specific weapon, second parameter=weapon hash code, third parameter=0
If you want to define any melee weapon, second parameter=0, third parameter=1.
If you want to identify any weapon (firearms, melee, rockets, etc.), second parameter=0, third parameter=2.
```
]]
native "HAS_PED_GOT_WEAPON"
hash "0x8DECB02F88F428BC"
jhash (0x43D2FA82)
arguments {
Ped "ped" [=[ {} ]=],
Hash "weaponHash" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "WEAPON"
returns "BOOL"
doc [[!
```
p2 should be FALSE, otherwise it seems to always return FALSE
Bool does not check if the weapon is current equipped, unfortunately.
```
]]
native "HAS_PED_GOT_WEAPON_COMPONENT"
hash "0xC593212475FAE340"
jhash (0xDC0FC145)
arguments {
Ped "ped" [=[ {} ]=],
Hash "weaponHash" [=[ {} ]=],
Hash "componentHash" [=[ {} ]=],
}
ns "WEAPON"
returns "BOOL"
doc [[!
]]
native "HAS_VEHICLE_GOT_PROJECTILE_ATTACHED"
hash "0x717C8481234E3B88"
jhash (0xA57E2E80)
arguments {
Ped "driver" [=[ {} ]=],
Vehicle "vehicle" [=[ {} ]=],
Hash "weaponHash" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "WEAPON"
returns "BOOL"
doc [[!
```
Third Parameter = unsure, but pretty sure it is weapon hash
--> get_hash_key("weapon_stickybomb")
Fourth Parameter = unsure, almost always -1
```
]]
native "HAS_WEAPON_ASSET_LOADED"
hash "0x36E353271F0E90EE"
jhash (0x1891D5BB)
arguments {
Hash "weaponHash" [=[ {} ]=],
}
ns "WEAPON"
returns "BOOL"
doc [[!
]]
native "HAS_WEAPON_GOT_WEAPON_COMPONENT"
hash "0x76A18844E743BF91"
jhash (0x1D368510)
arguments {
Object "weapon" [=[ {} ]=],
Hash "addonHash" [=[ {} ]=],
}
ns "WEAPON"
returns "BOOL"
doc [[!
]]
native "HIDE_PED_WEAPON_FOR_SCRIPTED_CUTSCENE"
hash "0x6F6981D2253C208F"
jhash (0x00CFD6E9)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "WEAPON"
returns "void"
doc [[!
```
Hides the players weapon during a cutscene.
```
]]
native "IS_FLASH_LIGHT_ON"
hash "0x4B7620C47217126C"
jhash (0x76876154)
arguments {
Ped "ped" [=[ {} ]=],
}
alias "SET_WEAPON_SMOKEGRENADE_ASSIGNED"
ns "WEAPON"
returns "BOOL"
doc [[!
]]
native "IS_PED_ARMED"
hash "0x475768A975D5AD17"
jhash (0x0BFC892C)
arguments {
Ped "ped" [=[ {} ]=],
int "typeFlags" [=[ {} ]=],
}
ns "WEAPON"
returns "BOOL"
doc [[!
Checks if the ped is currently equipped with a weapon matching a bit specified using a bitwise-or in typeFlags.
| Bit value | Effect |
|-----------|-------------------|
| 1 | Melee weapons |
| 2 | Explosive weapons |
| 4 | Any other weapons |
Not specifying any bit will lead to the native *always* returning 'false', and for example specifying '4 | 2' will check for any weapon except fists and melee weapons.
The ped to check armed state on.
Type flags to check.
Whether or not the ped is currently equipped with any weapon matching typeFlags.
]]
native "IS_PED_CURRENT_WEAPON_SILENCED"
hash "0x65F0C5AE05943EC7"
jhash (0xBAF7BFBE)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "WEAPON"
returns "BOOL"
doc [[!
```
This native returns a true or false value.
Ped ped = The ped whose weapon you want to check.
```
]]
native "IS_PED_WEAPON_COMPONENT_ACTIVE"
hash "0x0D78DE0572D3969E"
jhash (0x7565FB19)
arguments {
Ped "ped" [=[ {} ]=],
Hash "weaponHash" [=[ {} ]=],
Hash "componentHash" [=[ {} ]=],
}
ns "WEAPON"
returns "BOOL"
doc [[!
]]
native "IS_PED_WEAPON_READY_TO_SHOOT"
hash "0xB80CA294F2F26749"
jhash (0x02A32CB0)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "WEAPON"
returns "BOOL"
doc [[!
]]
native "IS_WEAPON_VALID"
hash "0x937C71165CF334B3"
jhash (0x38CA2954)
arguments {
Hash "weaponHash" [=[ {} ]=],
}
ns "WEAPON"
returns "BOOL"
doc [[!
]]
native "MAKE_PED_RELOAD"
hash "0x20AE33F3AC9C0033"
jhash (0x515292C2)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "WEAPON"
returns "BOOL"
doc [[!
Forces a ped to reload only if they are able to; if they have a full magazine, they will not reload.
]]
native "REFILL_AMMO_INSTANTLY"
hash "0x8C0D57EA686FAD87"
jhash (0x82EEAF0F)
arguments {
Ped "ped" [=[ {} ]=],
}
alias "_PED_SKIP_NEXT_RELOADING"
ns "WEAPON"
returns "BOOL"
doc [[!
]]
native "REMOVE_ALL_PED_WEAPONS"
hash "0xF25DF915FA38C5F3"
jhash (0xA44CE817)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "WEAPON"
returns "void"
doc [[!
Parameter `p1` does not seem to be used or referenced in game binaries.\
**Note:** When called for networked entities, a `CRemoveAllWeaponsEvent` will be created per request.
The ped entity
]]
native "REMOVE_ALL_PROJECTILES_OF_TYPE"
hash "0xFC52E0F37E446528"
jhash (0xA5F89919)
arguments {
Hash "weaponHash" [=[ {} ]=],
BOOL "explode" [=[ {} ]=],
}
ns "WEAPON"
returns "void"
doc [[!
If `explode` true, then removal is done through exploding the projectile. Basically the same as EXPLODE_PROJECTILES but without defining the owner ped.
]]
native "REMOVE_WEAPON_ASSET"
hash "0xAA08EF13F341C8FC"
jhash (0x2C0DFE3C)
arguments {
Hash "weaponHash" [=[ {} ]=],
}
ns "WEAPON"
returns "void"
doc [[!
]]
native "REMOVE_WEAPON_COMPONENT_FROM_PED"
hash "0x1E8BE90C74FB4C09"
jhash (0x412AA00D)
arguments {
Ped "ped" [=[ {} ]=],
Hash "weaponHash" [=[ {} ]=],
Hash "componentHash" [=[ {} ]=],
}
ns "WEAPON"
returns "void"
doc [[!
]]
native "REMOVE_WEAPON_COMPONENT_FROM_WEAPON_OBJECT"
hash "0xF7D82B0D66777611"
jhash (0xA6E7ED3C)
arguments {
Object "weaponObject" [=[ {} ]=],
Hash "addonHash" [=[ {"cs_type":"Any"} ]=],
}
ns "WEAPON"
returns "void"
doc [[!
]]
native "REMOVE_WEAPON_FROM_PED"
hash "0x4899CB088EDF59B8"
jhash (0x9C37F220)
arguments {
Ped "ped" [=[ {} ]=],
Hash "weaponHash" [=[ {} ]=],
}
ns "WEAPON"
returns "void"
doc [[!
```
This native removes a specified weapon from your selected ped.
Weapon Hashes: pastebin.com/0wwDZgkF
Example:
C#:
Function.Call(Hash.REMOVE_WEAPON_FROM_PED, Game.Player.Character, 0x99B507EA);
C++:
WEAPON::REMOVE_WEAPON_FROM_PED(PLAYER::PLAYER_PED_ID(), 0x99B507EA);
The code above removes the knife from the player.
```
]]
native "REQUEST_WEAPON_ASSET"
hash "0x5443438F033E29C3"
jhash (0x65D139A5)
arguments {
Hash "weaponHash" [=[ {} ]=],
int "p1" [=[ {} ]=],
int "p2" [=[ {} ]=],
}
ns "WEAPON"
returns "void"
doc [[!
```
Nearly every instance of p1 I found was 31. Nearly every instance of p2 I found was 0.
REQUEST_WEAPON_ASSET(iLocal_1888, 31, 26);
```
]]
native "REQUEST_WEAPON_HIGH_DETAIL_MODEL"
hash "0x48164DBB970AC3F0"
jhash (0xE3BD00F9)
arguments {
Entity "weaponObject" [=[ {} ]=],
}
ns "WEAPON"
returns "void"
doc [[!
]]
native "SET_AMMO_IN_CLIP"
hash "0xDCD2A934D65CB497"
jhash (0xA54B0B10)
arguments {
Ped "ped" [=[ {} ]=],
Hash "weaponHash" [=[ {} ]=],
int "ammo" [=[ {} ]=],
}
ns "WEAPON"
returns "BOOL"
doc [[!
]]
native "SET_CURRENT_PED_VEHICLE_WEAPON"
hash "0x75C55983C2C39DAA"
jhash (0x8E6F2AF1)
arguments {
Ped "ped" [=[ {} ]=],
Hash "weaponHash" [=[ {} ]=],
}
ns "WEAPON"
returns "BOOL"
doc [[!
]]
native "SET_CURRENT_PED_WEAPON"
hash "0xADF692B254977C0C"
jhash (0xB8278882)
arguments {
Ped "ped" [=[ {} ]=],
Hash "weaponHash" [=[ {} ]=],
BOOL "bForceInHand" [=[ {} ]=],
}
ns "WEAPON"
returns "void"
doc [[!
]]
native "SET_FLASH_LIGHT_FADE_DISTANCE"
hash "0xCEA66DAD478CD39B"
jhash (0xB0127EA7)
arguments {
float "distance" [=[ {} ]=],
}
ns "WEAPON"
returns "Any"
doc [[!
]]
native "SET_PED_AMMO"
hash "0x14E56BC5B5DB6A19"
jhash (0xBF90DF1A)
arguments {
Ped "ped" [=[ {} ]=],
Hash "weaponHash" [=[ {} ]=],
int "ammo" [=[ {} ]=],
}
ns "WEAPON"
returns "void"
doc [[!
```
NativeDB Added Parameter 4: BOOL p3
```
]]
native "SET_PED_AMMO_BY_TYPE"
hash "0x5FD1E1F011E76D7E"
jhash (0x311C52BB)
arguments {
Ped "ped" [=[ {} ]=],
Hash "ammoType" [=[ {"cs_type":"Any"} ]=],
int "ammo" [=[ {} ]=],
}
ns "WEAPON"
returns "void"
doc [[!
]]
native "SET_PED_AMMO_TO_DROP"
hash "0xA4EFEF9440A5B0EF"
jhash (0x2386A307)
arguments {
Ped "ped" [=[ {} ]=],
int "ammo" [=[ {} ]=],
}
ns "WEAPON"
returns "void"
doc [[!
]]
native "SET_PED_CHANCE_OF_FIRING_BLANKS"
hash "0x8378627201D5497D"
jhash (0xB4F44C6E)
arguments {
Ped "ped" [=[ {} ]=],
float "xBias" [=[ {} ]=],
float "yBias" [=[ {} ]=],
}
ns "WEAPON"
returns "void"
doc [[!
]]
native "SET_PED_CURRENT_WEAPON_VISIBLE"
hash "0x0725A4CCFDED9A70"
jhash (0x00BECD77)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "visible" [=[ {} ]=],
BOOL "deselectWeapon" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
BOOL "p4" [=[ {} ]=],
}
ns "WEAPON"
returns "void"
doc [[!
```
Has 5 parameters since latest patches.
```
]]
native "SET_PED_CYCLE_VEHICLE_WEAPONS_ONLY"
hash "0x50276EF8172F5F12"
jhash (0xE3DB81AC)
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0x50276EF8172F5F12"
ns "WEAPON"
returns "void"
doc [[!
Restricts weapon selection when cycling through weapons, to select only vehicle weapons.
The ped handle
]]
native "SET_PED_DROPS_INVENTORY_WEAPON"
hash "0x208A1888007FC0E6"
jhash (0x81FFB874)
arguments {
Ped "ped" [=[ {} ]=],
Hash "weaponHash" [=[ {} ]=],
float "xOffset" [=[ {} ]=],
float "yOffset" [=[ {} ]=],
float "zOffset" [=[ {} ]=],
int "ammoCount" [=[ {} ]=],
}
ns "WEAPON"
returns "void"
doc [[!
]]
native "SET_PED_DROPS_WEAPON"
hash "0x6B7513D9966FBEC0"
jhash (0x3D3329FA)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "WEAPON"
returns "void"
doc [[!
]]
native "SET_PED_DROPS_WEAPONS_WHEN_DEAD"
hash "0x476AE72C1D19D1A8"
jhash (0x8A444056)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "WEAPON"
returns "void"
doc [[!
]]
native "SET_PED_GADGET"
hash "0xD0D7B1E680ED4A1A"
jhash (0x8A256D0A)
arguments {
Ped "ped" [=[ {} ]=],
Hash "gadgetHash" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "WEAPON"
returns "void"
doc [[!
```
p1/gadgetHash was always 0xFBAB5776 ("GADGET_PARACHUTE").
p2 is always true.
```
]]
native "SET_PED_INFINITE_AMMO"
hash "0x3EDCB0505123623B"
jhash (0x9CB8D278)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
Hash "weaponHash" [=[ {} ]=],
}
ns "WEAPON"
returns "void"
doc [[!
]]
native "SET_PED_INFINITE_AMMO_CLIP"
hash "0x183DADC6AA953186"
jhash (0x5A5E3B67)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "WEAPON"
returns "void"
doc [[!
]]
native "SET_PED_SHOOT_ORDNANCE_WEAPON"
hash "0xB4C8D77C80C0421E"
jhash (0xEC2E5304)
arguments {
Ped "ped" [=[ {} ]=],
float "p1" [=[ {} ]=],
}
alias "0xB4C8D77C80C0421E"
ns "WEAPON"
returns "Object"
doc [[!
```
Returns handle of the projectile.
```
]]
native "SET_PED_WEAPON_TINT_INDEX"
hash "0x50969B9B89ED5738"
jhash (0xEB2A7B23)
arguments {
Ped "ped" [=[ {} ]=],
Hash "weaponHash" [=[ {} ]=],
int "tintIndex" [=[ {} ]=],
}
ns "WEAPON"
returns "void"
doc [[!
```
tintIndex can be the following:
0 : Default/Black
1 : Green
2 : Gold
3 : Pink
4 : Army
5 : LSPD
6 : Orange
7 : Platinum
tintIndex for MK2 weapons :
0 : Classic Black
1 : Classic Gray
2 : Classic Two-Tone
3 : Classic White
4 : Classic Beige
5 : Classic Green
6 : Classic Blue
7 : Classic Earth
8 : Classic Brown & Black
9 : Red Contrast
10 : Blue Contrast
11 : Yellow Contrast
12 : Orange Contrast
13 : Bold Pink
14 : Bold Purple & Yellow
15 : Bold Orange
16 : Bold Green & Purple
17 : Bold Red Features
18 : Bold Green Features
19 : Bold Cyan Features
20 : Bold Yellow Features
21 : Bold Red & White
22 : Bold Blue & White
23 : Metallic Gold
24 : Metallic Platinum
25 : Metallic Gray & Lilac
26 : Metallic Purple & Lime
27 : Metallic Red
28 : Metallic Green
29 : Metallic Blue
30 : Metallic White & Aqua
31 : Metallic Orange & Yellow
32 : Mettalic Red and Yellow
```
The target ped
The target weapon hash
Tint for weapon hash
]]
native "SET_PICKUP_AMMO_AMOUNT_SCALER"
hash "0xE620FD3512A04F18"
jhash (0xD6460EA2)
arguments {
float "p0" [=[ {} ]=],
}
alias "0xE620FD3512A04F18"
ns "WEAPON"
returns "void"
doc [[!
]]
native "SET_WEAPON_ANIMATION_OVERRIDE"
hash "0x1055AC3A667F09D9"
jhash (0xA5DF7484)
arguments {
Ped "ped" [=[ {} ]=],
Hash "animStyle" [=[ {} ]=],
}
ns "WEAPON"
returns "void"
doc [[!
Changes the selected ped aiming animation style, you can find the list of animations below.
These are stored in the `weaponanimations.meta` file located in `Grand Theft Auto V\update\update.rpf\common\data\ai\weaponanimations.meta`.
For Lua, it's best if you send the animation using [compile-time jenkins](https://cookbook.fivem.net/2019/06/23/lua-support-for-compile-time-jenkins-hashes/) hashes to avoid overhead. An example is shown down below.
### Animations
```cpp
enum eWeaponAnimationOverrides {
Ballistic = 0x5534A626,
Default = 0xE4DF46D5,
Franklin = 0x44C24694,
Gang = 0xBC066B98,
Michael = 0x55932F38,
MP_F_Freemode = 0xACB10C83,
Trevor = 0x2737D5AC,
Hillbilly = 0x8503D409,
Gang1H = 0x724A7AB7,
FirstPerson = 0xEE38E8E0,
FirstPersonAiming = 0xC76297A3,
FirstPersonRNG = 0xA4FDD608,
FirstPersonScope = 0x28117C22,
FirstPersonMichael = 0xEAA2550B,
FirstPersonMichaelAiming = 0x3E6FF30F,
FirstPersonMichaelRNG = 0xB7A826C1,
FirstPersonMichaelScope = 0xC554CF97,
FirstPersonFranklin = 0xC407163A,
FirstPersonFranklinAiming = 0x3D4B7B03,
FirstPersonFranklinRNG = 0xBE79B0B4,
FirstPersonFranklinScope = 0xAFEA6593,
FirstPersonTrevor = 0xA65D5351,
FirstPersonTrevorAiming = 0xF9BE8ED9,
FirstPersonTrevorRNG = 0xD181ED09,
FirstPersonTrevorScope = 0x34A67D6D,
FirstPersonMPFemale = 0x8431583F,
Fat = 0xC531A409,
SuperFat = 0x529E5780,
Female = 0x6D155A1B,
GangFemale = 0x678ADF82,
}
```
The ped handle.
The animation style to apply, passed as a hash.
]]
native "SET_WEAPON_OBJECT_TINT_INDEX"
hash "0xF827589017D4E4A9"
jhash (0x44ACC1DA)
arguments {
Object "weapon" [=[ {} ]=],
int "tintIndex" [=[ {} ]=],
}
ns "WEAPON"
returns "void"
doc [[!
]]
native "_ADD_AMMO_TO_PED_BY_TYPE"
hash "0x2472622CE1F2D45F"
arguments {
Ped "ped" [=[ {} ]=],
Hash "ammoType" [=[ {"cs_type":"Any"} ]=],
int "ammo" [=[ {} ]=],
}
alias "0x2472622CE1F2D45F"
alias "_ADD_PED_AMMO"
ns "WEAPON"
returns "void"
doc [[!
]]
native "_DOES_AIR_DEFENSE_ZONE_EXIST"
hash "0xCD79A550999D7D4F"
arguments {
int "zoneId" [=[ {} ]=],
}
alias "0xCD79A550999D7D4F"
ns "WEAPON"
returns "BOOL"
doc [[!
]]
native "_FIRE_AIR_DEFENSE_WEAPON"
hash "0x44F1012B69313374"
arguments {
int "zoneId" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
alias "0x44F1012B69313374"
ns "WEAPON"
returns "void"
doc [[!
]]
native "_GET_AMMO_IN_VEHICLE_WEAPON_CLIP"
hash "0x2857938C5D407AFA"
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "seat" [=[ {} ]=],
int "ammo" [=[ {} ]=],
}
ns "WEAPON"
returns "BOOL"
doc [[!
```
NativeDB Introduced: v3407
```
]]
native "_GET_MAX_AMMO_BY_TYPE"
hash "0x585847C5E4E11709"
arguments {
Ped "ped" [=[ {} ]=],
Hash "ammoType" [=[ {"cs_type":"Any"} ]=],
intPtr "ammo" [=[ {} ]=],
}
alias "0x585847C5E4E11709"
alias "_GET_MAX_AMMO_2"
ns "WEAPON"
returns "BOOL"
doc [[!
]]
native "_GET_PED_AMMO_TYPE_FROM_WEAPON_2"
hash "0xF489B44DD5AF4BD9"
arguments {
Ped "ped" [=[ {} ]=],
Hash "weaponHash" [=[ {} ]=],
}
ns "WEAPON"
returns "Hash"
doc [[!
```
Returns the base/default ammo type of the specified ped's specified weapon.
Use GET_PED_AMMO_TYPE_FROM_WEAPON if you want current ammo type (like AMMO_MG_INCENDIARY/AMMO_MG_TRACER while using MkII magazines) and use this if you want base ammo type. (AMMO_MG)
```
]]
native "_GET_PED_WEAPON_LIVERY_COLOR"
hash "0xF0A60040BE558F2D"
arguments {
Ped "ped" [=[ {} ]=],
Hash "weaponHash" [=[ {"cs_type":"Any"} ]=],
Hash "camoComponentHash" [=[ {"cs_type":"Any"} ]=],
}
alias "0xF0A60040BE558F2D"
ns "WEAPON"
returns "int"
doc [[!
]]
native "_GET_TIME_BEFORE_VEHICLE_WEAPON_RELOAD_FINISHES"
hash "0xC8C6F4B1CDEB40EF"
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "seat" [=[ {} ]=],
}
ns "WEAPON"
returns "int"
doc [[!
```
NativeDB Introduced: v3407
```
]]
native "_GET_VEHICLE_WEAPON_RELOAD_TIME"
hash "0xD0AD348FFD7A6868"
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "seat" [=[ {} ]=],
}
ns "WEAPON"
returns "float"
doc [[!
```
NativeDB Introduced: v3407
```
]]
native "_GET_WEAPON_COMPONENT_VARIANT_EXTRA_COMPONENT_COUNT"
hash "0x6558AC7C17BFEF58"
arguments {
Hash "componentHash" [=[ {"cs_type":"Any"} ]=],
}
alias "0x6558AC7C17BFEF58"
ns "WEAPON"
returns "int"
doc [[!
]]
native "_GET_WEAPON_COMPONENT_VARIANT_EXTRA_COMPONENT_MODEL"
hash "0x4D1CB8DC40208A17"
arguments {
Hash "componentHash" [=[ {"cs_type":"Any"} ]=],
int "extraComponentIndex" [=[ {} ]=],
}
alias "0x4D1CB8DC40208A17"
ns "WEAPON"
annotations [=[ {"cs_type":"Any"} ]=]
returns "Hash"
doc [[!
]]
native "_GET_WEAPON_OBJECT_LIVERY_COLOR"
hash "0xB3EA4FEABF41464B"
arguments {
Object "weaponObject" [=[ {} ]=],
Hash "camoComponentHash" [=[ {"cs_type":"Any"} ]=],
}
alias "0xB3EA4FEABF41464B"
ns "WEAPON"
returns "int"
doc [[!
]]
native "_GET_WEAPON_TIME_BETWEEN_SHOTS"
hash "0x065D2AACAD8CF7A4"
arguments {
Hash "weaponHash" [=[ {} ]=],
}
alias "0x065D2AACAD8CF7A4"
ns "WEAPON"
annotations [=[ {"cs_type":"Any"} ]=]
returns "float"
doc [[!
]]
native "_GIVE_LOADOUT_TO_PED"
hash "0x68F8BE6AF5CDF8A6"
arguments {
Ped "ped" [=[ {} ]=],
Hash "loadoutHash" [=[ {"cs_type":"Any"} ]=],
}
alias "0x68F8BE6AF5CDF8A6"
ns "WEAPON"
returns "void"
doc [[!
List of all available loadouts:
```
LOADOUT_DEFAULT
LOADOUT_ANIMAL
LOADOUT_COUGAR
LOADOUT_HILLBILLY
LOADOUT_CULT
LOADOUT_CHEAT_0
LOADOUT_CHEAT_1
LOADOUT_GUARD
LOADOUT_NETWORK_BOT
LOADOUT_LOST
LOADOUT_LOST_L1
LOADOUT_LOST_L2
LOADOUT_LOST_L3
LOADOUT_MEXICAN
LOADOUT_MEXICAN_L1
LOADOUT_MEXICAN_L2
LOADOUT_MEXICAN_L3
LOADOUT_FAMILY
LOADOUT_ASIAN
LOADOUT_SECUR
LOADOUT_POLICE_GUARD
LOADOUT_COP
LOADOUT_COP_L1
LOADOUT_COP_L2
LOADOUT_COP_L3
LOADOUT_SWAT
LOADOUT_SWAT_NO_LASER
LOADOUT_COP_SHOTGUN
LOADOUT_FIREMAN
LOADOUT_COP_HELI
LOADOUT_COP_BOAT
LOADOUT_ARMY
LOADOUT_ANIMAL_RETRIEVER
LOADOUT_SMALL_DOG
LOADOUT_TIGER_SHARK
LOADOUT_HAMMERHEAD_SHARK
LOADOUT_KILLER_WHALE
LOADOUT_BOAR
LOADOUT_PIG
LOADOUT_COYOTE
LOADOUT_DEER
LOADOUT_HEN
LOADOUT_RABBIT
LOADOUT_CAT
LOADOUT_COW
```
The ped handle to apply this to.
The loadout to use (needs to be a hash).
]]
native "_HAS_WEAPON_RELOADING_IN_VEHICLE"
hash "0x8062F07153F4446F"
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "seat" [=[ {} ]=],
}
ns "WEAPON"
returns "BOOL"
doc [[!
```
NativeDB Introduced: v3407
```
]]
native "_IS_ANY_AIR_DEFENSE_ZONE_INSIDE_SPHERE"
hash "0xDAB963831DBFD3F4"
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "radius" [=[ {} ]=],
intPtr "SphereIndex" [=[ {} ]=],
}
alias "0xDAB963831DBFD3F4"
alias "_IS_AIR_DEFENSE_ZONE_INSIDE_SPHERE"
ns "WEAPON"
returns "BOOL"
doc [[!
]]
native "_REMOVE_AIR_DEFENSE_ZONE"
hash "0x0ABF535877897560"
arguments {
int "zoneId" [=[ {} ]=],
}
alias "0x0ABF535877897560"
ns "WEAPON"
returns "BOOL"
doc [[!
]]
native "_REMOVE_ALL_AIR_DEFENSE_ZONES"
hash "0x1E45B34ADEBEE48E"
alias "0x1E45B34ADEBEE48E"
ns "WEAPON"
returns "void"
doc [[!
]]
native "_SET_AMMO_IN_VEHICLE_WEAPON_CLIP"
hash "0x873906720EE842C3"
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "seat" [=[ {} ]=],
int "ammo" [=[ {} ]=],
}
ns "WEAPON"
returns "BOOL"
doc [[!
```
NativeDB Introduced: v3407
```
]]
native "_SET_CAN_PED_EQUIP_ALL_WEAPONS"
hash "0xEFF296097FF1E509"
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0xEFF296097FF1E509"
ns "WEAPON"
returns "void"
doc [[!
Does the same as [`_SET_CAN_PED_SELECT_WEAPON`](#\_0xB4771B9AAF4E68E4) except for all weapons.
]]
native "_SET_CAN_PED_EQUIP_WEAPON"
hash "0xB4771B9AAF4E68E4"
arguments {
Ped "ped" [=[ {} ]=],
Hash "weaponHash" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0xB4771B9AAF4E68E4"
alias "_SET_CAN_PED_SELECT_WEAPON"
ns "WEAPON"
returns "void"
doc [[!
Disables selecting the given weapon. Ped isn't forced to put the gun away. However you can't reselect the weapon if you holster then unholster. Weapon is also grayed out on the weapon wheel.
]]
native "_SET_FLASH_LIGHT_ENABLED"
hash "0x988DB6FE9B3AC000"
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "WEAPON"
returns "void"
doc [[!
Enables/disables flashlight on ped's weapon.
```
NativeDB Introduced: v2060
```
]]
native "_SET_PED_WEAPON_LIVERY_COLOR"
hash "0x9FE5633880ECD8ED"
arguments {
Ped "ped" [=[ {} ]=],
Hash "weaponHash" [=[ {"cs_type":"Any"} ]=],
Hash "camoComponentHash" [=[ {"cs_type":"Any"} ]=],
int "colorIndex" [=[ {} ]=],
}
alias "0x9FE5633880ECD8ED"
ns "WEAPON"
returns "void"
doc [[!
]]
native "_SET_PLAYER_AIR_DEFENSE_ZONE_FLAG"
hash "0xECDC202B25E5CF48"
arguments {
Player "player" [=[ {} ]=],
int "zoneId" [=[ {} ]=],
BOOL "enable" [=[ {} ]=],
}
alias "0xECDC202B25E5CF48"
ns "WEAPON"
returns "void"
doc [[!
]]
native "_SET_WEAPON_DAMAGE_MODIFIER"
hash "0x4757F00BC6323CFE"
arguments {
Hash "weaponHash" [=[ {} ]=],
float "damageMultiplier" [=[ {} ]=],
}
alias "0x4757F00BC6323CFE"
alias "_SET_WEAPON_DAMAGE_MODIFIER_THIS_FRAME"
ns "WEAPON"
returns "void"
doc [[!
Changes the weapon damage output by the given multiplier value.
Does NOT need to be called every frame.
Hash of the weapon
Damage Multiplier
]]
native "_SET_WEAPON_EXPLOSION_RADIUS_MULTIPLIER"
hash "0x4AE5AC8B852D642C"
arguments {
Hash "weaponHash" [=[ {} ]=],
float "multiplier" [=[ {} ]=],
}
ns "WEAPON"
returns "void"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "_SET_WEAPON_OBJECT_LIVERY_COLOR"
hash "0x5DA825A85D0EA6E6"
arguments {
Object "weaponObject" [=[ {} ]=],
Hash "camoComponentHash" [=[ {"cs_type":"Any"} ]=],
int "colorIndex" [=[ {} ]=],
}
alias "0x5DA825A85D0EA6E6"
ns "WEAPON"
returns "void"
doc [[!
]]
native "_TRIGGER_VEHICLE_WEAPON_RELOAD"
hash "0x5B1513F27F279A44"
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "seat" [=[ {} ]=],
Ped "ped" [=[ {} ]=],
}
ns "WEAPON"
returns "BOOL"
doc [[!
Start a reload for a vehicle's weapon.
```
NativeDB Introduced: v3407
```
The vehicle containing the weapon to reload.
The seat/weapon index.
The ped initiating the reload (the one using the weapon).
Return `true` if reload was triggered successfully, `false` otherwise.
]]
native "0x24C024BA8379A70A"
hash "0x24C024BA8379A70A"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "WEAPON"
returns "void"
doc [[!
```
NativeDB Introduced: v1868
```
]]
native "0x977CA98939E82E4B"
hash "0x977CA98939E82E4B"
arguments {
Object "weaponObject" [=[ {} ]=],
int "p1" [=[ {} ]=],
}
ns "WEAPON"
returns "void"
doc [[!
```
SET_WEAPON_OBJECT_*
```
]]
native "0xA2C9AC24B4061285"
hash "0xA2C9AC24B4061285"
arguments {
Ped "ped" [=[ {} ]=],
Hash "weaponHash" [=[ {"cs_type":"Any"} ]=],
}
ns "WEAPON"
returns "int"
doc [[!
]]
native "0xE4DCEC7FD5B739A5"
hash "0xE4DCEC7FD5B739A5"
jhash (0x64646F1D)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "WEAPON"
returns "void"
doc [[!
]]
native "0xE6D2CEDD370FF98E"
hash "0xE6D2CEDD370FF98E"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "WEAPON"
returns "void"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "CLEAR_POPSCHEDULE_OVERRIDE_VEHICLE_MODEL"
hash "0x5C0DE367AA0D911C"
jhash (0x7A72A24E)
arguments {
int "scheduleId" [=[ {} ]=],
}
ns "ZONE"
returns "void"
doc [[!
```
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]);
```
]]
native "GET_HASH_OF_MAP_AREA_AT_COORDS"
hash "0x7EE64D51E8498728"
jhash (0xB5C5C99B)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
ns "ZONE"
returns "Hash"
doc [[!
```
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);
```
]]
native "GET_NAME_OF_ZONE"
hash "0xCD90657D4C30E1CA"
jhash (0x7875CE91)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
ns "ZONE"
returns "charPtr"
doc [[!
```
AIRP = Los Santos International Airport
ALAMO = Alamo Sea
ALTA = Alta
ARMYB = Fort Zancudo
BANHAMC = Banham Canyon Dr
BANNING = Banning
BAYTRE = Baytree Canyon
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
GALLI = Galileo Park
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
OBSERV = Galileo Observatory
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
PROL = Prologue / North Yankton
ISHeist = Cayo Perico Island
```
]]
native "GET_ZONE_AT_COORDS"
hash "0x27040C25DE6CB2F4"
jhash (0xC9018181)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
ns "ZONE"
returns "int"
doc [[!
]]
native "GET_ZONE_FROM_NAME_ID"
hash "0x98CD1D2934B76CC1"
jhash (0x8EC68304)
arguments {
charPtr "zoneName" [=[ {} ]=],
}
ns "ZONE"
returns "int"
doc [[!
Refer to https://docs.fivem.net/docs/game-references/zones/ for a list of all zones including their integer ID, string ID, short name and full name
The zone name like "Z_RMAN2", most-left column of popzone.ipl
The zone ID, index in the popzone.ipl file starting with 1
]]
native "GET_ZONE_POPSCHEDULE"
hash "0x4334BC40AA0CB4BB"
jhash (0x20AB2FC9)
arguments {
int "zoneId" [=[ {} ]=],
}
ns "ZONE"
returns "int"
doc [[!
]]
native "GET_ZONE_SCUMMINESS"
hash "0x5F7B268D15BA0739"
jhash (0xB2FB5C4C)
arguments {
int "zoneId" [=[ {} ]=],
}
ns "ZONE"
returns "int"
doc [[!
Gets the zone scumminess level, used to calculate the cellphone signal strength.
```cpp
enum eZoneScumminess
{
SCUMMINESS_POSH = 0,
SCUMMINESS_NICE = 1,
SCUMMINESS_ABOVE_AVERAGE = 2,
SCUMMINESS_BELOW_AVERAGE = 3,
SCUMMINESS_CRAP = 4,
SCUMMINESS_SCUM = 5
}
```
The zone id
The zone scumminess level
]]
native "OVERRIDE_POPSCHEDULE_VEHICLE_MODEL"
hash "0x5F7D596BAC2E7777"
jhash (0x3F0A3680)
arguments {
int "scheduleId" [=[ {} ]=],
Hash "vehicleHash" [=[ {} ]=],
}
ns "ZONE"
returns "void"
doc [[!
```
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);
```
]]
native "SET_ZONE_ENABLED"
hash "0xBA5ECEEA120E5611"
jhash (0x04E21B03)
arguments {
int "zoneId" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "ZONE"
returns "void"
doc [[!
]]
native "ADD_COVER_BLOCKING_AREA"
hash "0x45C597097DD7CB81"
jhash (0x3536946F)
arguments {
float "playerX" [=[ {} ]=],
float "playerY" [=[ {} ]=],
float "playerZ" [=[ {} ]=],
float "radiusX" [=[ {} ]=],
float "radiusY" [=[ {} ]=],
float "radiusZ" [=[ {} ]=],
BOOL "p6" [=[ {} ]=],
BOOL "p7" [=[ {} ]=],
BOOL "p8" [=[ {} ]=],
BOOL "p9" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "ADD_COVER_POINT"
hash "0xD5C12A75C7B9497F"
jhash (0xA0AF0B98)
arguments {
float "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
Any "p6" [=[ {} ]=],
BOOL "p7" [=[ {} ]=],
}
ns "TASK"
returns "ScrHandle"
doc [[!
]]
native "ADD_PATROL_ROUTE_LINK"
hash "0x23083260DEC3A551"
jhash (0xD8761BB3)
arguments {
int "id1" [=[ {} ]=],
int "id2" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
connects/links 2 [route nodes](#\_0x8EDF950167586B7C)\
image representing the cyclic example below:\

the id representing the first route node
the id representing the second route node
]]
native "ADD_PATROL_ROUTE_NODE"
hash "0x8EDF950167586B7C"
jhash (0x21B48F10)
arguments {
int "id" [=[ {} ]=],
charPtr "guardScenario" [=[ {} ]=],
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
int "waitTime" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
x2,y2 and z2 are the coordinates to which the ped should look at
is an integer that "identifies" the route node for linking to the route with ADD_PATROL_ROUTE_LINK.
can be "WORLD_HUMAN_GUARD_STAND" or "StandGuard"
destination
destination
destination
coordinates to which the ped should look
coordinates to which the ped should look
coordinates to which the ped should look
written in ms
]]
native "ADD_VEHICLE_SUBTASK_ATTACK_COORD"
hash "0x5CF0D8F9BBA0DD75"
jhash (0x50779A2C)
arguments {
Ped "ped" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
x, y, z: offset in world coords from some entity.
```
]]
native "ADD_VEHICLE_SUBTASK_ATTACK_PED"
hash "0x85F462BADC7DA47F"
jhash (0x80461113)
arguments {
Ped "ped" [=[ {} ]=],
Ped "ped2" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "ASSISTED_MOVEMENT_IS_ROUTE_LOADED"
hash "0x60F9A4393A21F741"
jhash (0x79B067AF)
arguments {
charPtr "route" [=[ {} ]=],
}
ns "TASK"
returns "BOOL"
doc [[!
]]
native "ASSISTED_MOVEMENT_OVERRIDE_LOAD_DISTANCE_THIS_FRAME"
hash "0x13945951E16EF912"
jhash (0x8FB923EC)
arguments {
float "dist" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "ASSISTED_MOVEMENT_REMOVE_ROUTE"
hash "0x3548536485DD792B"
jhash (0xB3CEC06F)
arguments {
charPtr "route" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "ASSISTED_MOVEMENT_REQUEST_ROUTE"
hash "0x817268968605947A"
jhash (0x48262EDA)
arguments {
charPtr "route" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
Routes: "1_FIBStairs", "2_FIBStairs", "3_FIBStairs", "4_FIBStairs", "5_FIBStairs", "5_TowardsFire", "6a_FIBStairs", "7_FIBStairs", "8_FIBStairs", "Aprtmnt_1", "AssAfterLift", "ATM_1", "coroner2", "coroner_stairs", "f5_jimmy1", "fame1", "family5b", "family5c", "Family5d", "family5d", "FIB_Glass1", "FIB_Glass2", "FIB_Glass3", "finaBroute1A", "finalb1st", "finalB1sta", "finalbround", "finalbroute2", "Hairdresser1", "jan_foyet_ft_door", "Jo_3", "Lemar1", "Lemar2", "mansion_1", "Mansion_1", "pols_1", "pols_2", "pols_3", "pols_4", "pols_5", "pols_6", "pols_7", "pols_8", "Pro_S1", "Pro_S1a", "Pro_S2", "Towards_case", "trev_steps", "tunrs1", "tunrs2", "tunrs3", "Wave01457s"
```
]]
native "ASSISTED_MOVEMENT_SET_ROUTE_PROPERTIES"
hash "0xD5002D78B7162E1B"
jhash (0x01CAAFCC)
arguments {
charPtr "route" [=[ {} ]=],
int "props" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "CLEAR_DRIVEBY_TASK_UNDERNEATH_DRIVING_TASK"
hash "0xC35B5CDB2824CF69"
jhash (0x9B76F7E6)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "CLEAR_PED_SCRIPT_TASK_IF_RUNNING_THREAT_RESPONSE_NON_TEMP_TASK"
hash "0xF6DC48E56BE1243A"
arguments {
Ped "ped" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
NativeDB Introduced: v3407
```
]]
native "CLEAR_PED_SECONDARY_TASK"
hash "0x176CECF6F920D707"
jhash (0xA635F451)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "CLEAR_PED_TASKS"
hash "0xE1EF3C1216AFF2CD"
jhash (0xDE3316AB)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
Clear a ped's tasks. Stop animations and other tasks created by scripts.
Ped id. Use PlayerPedId() for your own character.
]]
native "CLEAR_PED_TASKS_IMMEDIATELY"
hash "0xAAA34F8A7CB32098"
jhash (0xBC045625)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
Immediately stops the pedestrian from whatever it's doing. The difference between this and [CLEAR_PED_TASKS](#\_0xE1EF3C1216AFF2CD) is that this one teleports the ped but does not change the position of the ped.
Ped id.
]]
native "CLEAR_SEQUENCE_TASK"
hash "0x3841422E9C488D8C"
jhash (0x47ED03CE)
arguments {
intPtr "taskSequenceId" [=[ {} ]=],
}
ns "TASK"
annotations [=[ {"cs_type":"Any"} ]=]
returns "void"
doc [[!
For an example on how to use this please refer to [OPEN_SEQUENCE_TASK](#\_0xE8854A4326B9E12B)
#### NOTE
If you fail to call [`CLOSE_SEQUENCE_TASK`](#\_0x39E72BC99E6360CB) and `CLEAR_SEQUENCE_TASK` the sequence system can get stuck in a broken state until you restart your client.
The task sequence to clear
]]
native "CLOSE_PATROL_ROUTE"
hash "0xB043ECA801B8CBC1"
jhash (0x67305E59)
ns "TASK"
returns "void"
doc [[!
]]
native "CLOSE_SEQUENCE_TASK"
hash "0x39E72BC99E6360CB"
jhash (0x1A7CEBD0)
arguments {
int "taskSequenceId" [=[ {} ]=],
}
ns "TASK"
annotations [=[ {"cs_type":"Any"} ]=]
returns "void"
doc [[!
For an example on how to use this please refer to [OPEN_SEQUENCE_TASK](#\_0xE8854A4326B9E12B)
#### NOTE
If you fail to call `CLOSE_SEQUENCE_TASK` and [`CLEAR_SEQUENCE_TASK`](#\_0x3841422E9C488D8C) this can get stuck in a broken state until you restart your client.
The task sequence to close
]]
native "CONTROL_MOUNTED_WEAPON"
hash "0xDCFE42068FE0135A"
jhash (0x500D9244)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "TASK"
returns "BOOL"
doc [[!
```
Forces the ped to use the mounted weapon.
Returns false if task is not possible.
```
]]
native "CREATE_PATROL_ROUTE"
hash "0xAF8A443CCC8018DC"
jhash (0x0A6C7864)
ns "TASK"
returns "void"
doc [[!
]]
native "DELETE_PATROL_ROUTE"
hash "0x7767DD9D65E91319"
jhash (0x2A4E6706)
arguments {
charPtr "patrolRoute" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
From the b617d scripts:
TASK::DELETE_PATROL_ROUTE("miss_merc0");
TASK::DELETE_PATROL_ROUTE("miss_merc1");
TASK::DELETE_PATROL_ROUTE("miss_merc2");
TASK::DELETE_PATROL_ROUTE("miss_dock");
```
]]
native "DOES_SCENARIO_EXIST_IN_AREA"
hash "0x5A59271FFADD33C1"
jhash (0xFA7F5047)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "radius" [=[ {} ]=],
BOOL "b" [=[ {} ]=],
}
ns "TASK"
returns "BOOL"
doc [[!
]]
native "DOES_SCENARIO_GROUP_EXIST"
hash "0xF9034C136C9E00D3"
jhash (0x5F072EB9)
arguments {
charPtr "scenarioGroup" [=[ {} ]=],
}
ns "TASK"
returns "BOOL"
doc [[!
```
Occurrences in the b617d scripts:
"ARMY_GUARD",
"ARMY_HELI",
"Cinema_Downtown",
"Cinema_Morningwood",
"Cinema_Textile",
"City_Banks",
"Countryside_Banks",
"DEALERSHIP",
"GRAPESEED_PLANES",
"KORTZ_SECURITY",
"LOST_BIKERS",
"LSA_Planes",
"LSA_Planes",
"MP_POLICE",
"Observatory_Bikers",
"POLICE_POUND1",
"POLICE_POUND2",
"POLICE_POUND3",
"POLICE_POUND4",
"POLICE_POUND5"
"QUARRY",
"SANDY_PLANES",
"SCRAP_SECURITY",
"SEW_MACHINE",
"SOLOMON_GATE",
"Triathlon_1_Start",
"Triathlon_2_Start",
"Triathlon_3_Start"
Sometimes used with IS_SCENARIO_GROUP_ENABLED:
if (TASK::DOES_SCENARIO_GROUP_EXIST("Observatory_Bikers") && (!TASK::IS_SCENARIO_GROUP_ENABLED("Observatory_Bikers"))) {
else if (TASK::IS_SCENARIO_GROUP_ENABLED("BLIMP")) {
```
]]
native "DOES_SCENARIO_OF_TYPE_EXIST_IN_AREA"
hash "0x0A9D0C2A3BBC86C1"
jhash (0x0FB138A5)
arguments {
float "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
charPtr "p3" [=[ {} ]=],
float "p4" [=[ {} ]=],
BOOL "p5" [=[ {} ]=],
}
ns "TASK"
returns "BOOL"
doc [[!
]]
native "DOES_SCRIPTED_COVER_POINT_EXIST_AT_COORDS"
hash "0xA98B8E3C088E5A31"
jhash (0x29F97A71)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
ns "TASK"
returns "BOOL"
doc [[!
```
Checks if there is a cover point at position
```
]]
native "GET_ACTIVE_VEHICLE_MISSION_TYPE"
hash "0x534AEBA6E5ED4CAB"
jhash (0xAFA914EF)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "TASK"
returns "int"
doc [[!
```
https://alloc8or.re/gta5/doc/enums/eVehicleMissionType.txt
```
]]
native "GET_CLIP_SET_FOR_SCRIPTED_GUN_TASK"
hash "0x3A8CADC7D37AACC5"
jhash (0x249EB4EB)
arguments {
int "p0" [=[ {} ]=],
}
ns "TASK"
returns "charPtr"
doc [[!
]]
native "GET_IS_TASK_ACTIVE"
hash "0xB0760331C7AA4155"
jhash (0x86FDDF55)
arguments {
Ped "ped" [=[ {} ]=],
int "taskIndex" [=[ {} ]=],
}
ns "TASK"
returns "BOOL"
doc [[!
```
Task index enum: https://alloc8or.re/gta5/doc/enums/eTaskTypeIndex.txt
```
]]
native "GET_IS_WAYPOINT_RECORDING_LOADED"
hash "0xCB4E8BE8A0063C5D"
jhash (0x87125F5D)
arguments {
charPtr "name" [=[ {} ]=],
}
ns "TASK"
returns "BOOL"
doc [[!
]]
native "GET_NAVMESH_ROUTE_DISTANCE_REMAINING"
hash "0xC6F5C0BCDC74D62D"
jhash (0xD9281778)
arguments {
Ped "ped" [=[ {} ]=],
floatPtr "distanceRemaining" [=[ {} ]=],
BOOLPtr "isPathReady" [=[ {} ]=],
}
ns "TASK"
returns "int"
doc [[!
```
Looks like the last parameter returns true if the path has been calculated, while the first returns the remaining distance to the end of the path.
Return value of native is the same as GET_NAVMESH_ROUTE_RESULT
Looks like the native returns an int for the path's state:
1 - ???
2 - ???
3 - Finished Generating
```
]]
native "GET_NAVMESH_ROUTE_RESULT"
hash "0x632E831F382A0FA8"
jhash (0x96491602)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "TASK"
returns "int"
doc [[!
See [`GET_NAVMESH_ROUTE_DISTANCE_REMAINING`](#\_0xC6F5C0BCDC74D62D) for more details.
]]
native "GET_PED_DESIRED_MOVE_BLEND_RATIO"
hash "0x8517D4A6CA8513ED"
jhash (0x5FEFAB72)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "TASK"
returns "float"
doc [[!
]]
native "GET_PED_WAYPOINT_DISTANCE"
hash "0xE6A877C64CAF1BC5"
jhash (0x084B35B0)
arguments {
Any "p0" [=[ {} ]=],
}
ns "TASK"
returns "float"
doc [[!
]]
native "GET_PED_WAYPOINT_PROGRESS"
hash "0x2720AAA75001E094"
jhash (0x3595B104)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "TASK"
returns "int"
doc [[!
]]
native "GET_PHONE_GESTURE_ANIM_CURRENT_TIME"
hash "0x47619ABE8B268C60"
jhash (0x7B72AFD1)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "TASK"
returns "float"
doc [[!
]]
native "GET_PHONE_GESTURE_ANIM_TOTAL_TIME"
hash "0x1EE0F68A7C25DEC6"
jhash (0xEF8C3959)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "TASK"
returns "float"
doc [[!
]]
native "GET_SCRIPT_TASK_STATUS"
hash "0x77F1BEB8863288D5"
jhash (0xB2477B23)
arguments {
Ped "ped" [=[ {} ]=],
Hash "taskHash" [=[ {} ]=],
}
ns "TASK"
returns "int"
doc [[!
Gets the status of a spesifed script-assigned task on the given ped. The return value is always an int between 0-7.
You can set taskHash to `SCRIPT_TASK_ANY` to check if any task is active, it will return 1 for active, 3 for no active.
`SCRIPT_TASK_INVALID` can be similarly used, it returns 7 if there are any active task, and 3 if there are no active tasks.
taskHash list: https://alloc8or.re/gta5/doc/enums/eScriptTaskHash.txt
Returns:
```
0 = WAITING_TO_START_TASK
1 = PERFORMING_TASK
2 = DORMANT_TASK
3 = VACANT_STAGE
7 = TASK_FINISHED_OR_NOT_FOUND
```
The ped the task is running on
The hash of the task
The status of the script-assigned task.
]]
native "GET_SCRIPTED_COVER_POINT_COORDS"
hash "0x594A1028FC2A3E85"
jhash (0xC6B6CCC1)
arguments {
ScrHandle "coverpoint" [=[ {} ]=],
}
ns "TASK"
returns "Vector3"
doc [[!
]]
native "GET_SEQUENCE_PROGRESS"
hash "0x00A9010CFE1E3533"
jhash (0xA3419909)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "TASK"
returns "int"
doc [[!
```
returned values:
0 to 7 = task that's currently in progress, 0 meaning the first one.
-1 no task sequence in progress.
```
]]
native "GET_TASK_MOVE_NETWORK_EVENT"
hash "0xB4F47213DF45A64C"
jhash (0x72FA5EF2)
arguments {
Ped "ped" [=[ {} ]=],
charPtr "eventName" [=[ {} ]=],
}
alias "0xB4F47213DF45A64C"
ns "TASK"
returns "BOOL"
doc [[!
]]
native "GET_TASK_MOVE_NETWORK_SIGNAL_BOOL"
hash "0xA7FFBA498E4AAF67"
jhash (0x1EBB6F3D)
arguments {
Ped "ped" [=[ {} ]=],
charPtr "signalName" [=[ {} ]=],
}
alias "0xA7FFBA498E4AAF67"
ns "TASK"
returns "BOOL"
doc [[!
]]
native "GET_TASK_MOVE_NETWORK_STATE"
hash "0x717E4D1F2048376D"
jhash (0x96C0277B)
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0x717E4D1F2048376D"
ns "TASK"
returns "charPtr"
doc [[!
]]
native "GET_VEHICLE_WAYPOINT_PROGRESS"
hash "0x9824CFF8FC66E159"
jhash (0xD3CCF64E)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "TASK"
returns "int"
doc [[!
]]
native "GET_VEHICLE_WAYPOINT_TARGET_POINT"
hash "0x416B62AC8B9E5BBD"
jhash (0x81049608)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "TASK"
returns "int"
doc [[!
]]
native "GET_WAYPOINT_DISTANCE_ALONG_ROUTE"
hash "0xA5B769058763E497"
jhash (0xE8422AC4)
arguments {
charPtr "p0" [=[ {} ]=],
int "p1" [=[ {} ]=],
}
ns "TASK"
returns "float"
doc [[!
]]
native "IS_DRIVEBY_TASK_UNDERNEATH_DRIVING_TASK"
hash "0x8785E6E40C7A8818"
jhash (0xB23F46E6)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "TASK"
returns "BOOL"
doc [[!
]]
native "IS_MOUNTED_WEAPON_TASK_UNDERNEATH_DRIVING_TASK"
hash "0xA320EF046186FA3B"
jhash (0x291E938C)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "TASK"
returns "BOOL"
doc [[!
]]
native "IS_MOVE_BLEND_RATIO_RUNNING"
hash "0xD4D8636C0199A939"
jhash (0xE76A2353)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "TASK"
returns "BOOL"
doc [[!
]]
native "IS_MOVE_BLEND_RATIO_SPRINTING"
hash "0x24A2AD74FA9814E2"
jhash (0xDD616893)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "TASK"
returns "BOOL"
doc [[!
]]
native "IS_MOVE_BLEND_RATIO_STILL"
hash "0x349CE7B56DAFD95C"
jhash (0xE9DAF877)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "TASK"
returns "BOOL"
doc [[!
]]
native "IS_MOVE_BLEND_RATIO_WALKING"
hash "0xF133BBBE91E1691F"
jhash (0xD21639A8)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "TASK"
returns "BOOL"
doc [[!
]]
native "IS_PED_ACTIVE_IN_SCENARIO"
hash "0xAA135F9482C82CC3"
jhash (0x05038F1A)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "TASK"
returns "BOOL"
doc [[!
This is a stricter version of [`IS_PED_USING_ANY_SCENARIO`](#\_0x57AB4A3080F85143). It only returns true if the ped is playing the ambient animations associated with the scenario.
The ped handle.
Returns true if the ped is in a using a scenario and is doing the ambient animations.
]]
native "IS_PED_BEING_ARRESTED"
hash "0x90A09F3A45FED688"
jhash (0x5FF6C2ED)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "TASK"
returns "BOOL"
doc [[!
```
This function is hard-coded to always return 0.
```
]]
native "IS_PED_CUFFED"
hash "0x74E559B3BC910685"
jhash (0x511CE741)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "TASK"
returns "BOOL"
doc [[!
]]
native "IS_PED_GETTING_UP"
hash "0x2A74E1D5F2F00EEC"
jhash (0x320813E6)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "TASK"
returns "BOOL"
doc [[!
]]
native "IS_PED_IN_WRITHE"
hash "0xDEB6D52126E7D640"
jhash (0x09E61921)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "TASK"
returns "BOOL"
doc [[!
This native checks if a ped is on the ground, in pain from a (gunshot) wound.
Returns `true` if the ped is in [writhe](https://dictionary.cambridge.org/dictionary/english/writhe), `false` otherwise.
]]
native "IS_PED_PLAYING_BASE_CLIP_IN_SCENARIO"
hash "0x621C6E4729388E41"
jhash (0xA0DA6B1D)
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0x621C6E4729388E41"
ns "TASK"
returns "BOOL"
doc [[!
]]
native "IS_PED_RUNNING"
hash "0xC5286FFC176F28A2"
jhash (0xE9A5578F)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "TASK"
returns "BOOL"
doc [[!
]]
native "IS_PED_RUNNING_ARREST_TASK"
hash "0x3DC52677769B4AE0"
jhash (0x6942DB7A)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "TASK"
returns "BOOL"
doc [[!
]]
native "IS_PED_SPRINTING"
hash "0x57E457CD2C0FC168"
jhash (0x4F3E0633)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "TASK"
returns "BOOL"
doc [[!
]]
native "IS_PED_STILL"
hash "0xAC29253EEF8F0180"
jhash (0x09E3418D)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "TASK"
returns "BOOL"
doc [[!
]]
native "IS_PED_STRAFING"
hash "0xE45B7F222DE47E09"
jhash (0xEFEED13C)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "TASK"
returns "BOOL"
doc [[!
```
What's strafing?
```
]]
native "IS_PED_WALKING"
hash "0xDE4C184B2B9B071A"
jhash (0x4B865C4A)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "TASK"
returns "BOOL"
doc [[!
]]
native "IS_PLAYING_PHONE_GESTURE_ANIM"
hash "0xB8EBB1E9D3588C10"
jhash (0x500B6805)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "TASK"
returns "BOOL"
doc [[!
]]
native "IS_SCENARIO_GROUP_ENABLED"
hash "0x367A09DED4E05B99"
jhash (0x90991122)
arguments {
charPtr "scenarioGroup" [=[ {} ]=],
}
ns "TASK"
returns "BOOL"
doc [[!
```
Occurrences in the b617d scripts:
"ARMY_GUARD",
"ARMY_HELI",
"BLIMP",
"Cinema_Downtown",
"Cinema_Morningwood",
"Cinema_Textile",
"City_Banks",
"Countryside_Banks",
"DEALERSHIP",
"KORTZ_SECURITY",
"LSA_Planes",
"MP_POLICE",
"Observatory_Bikers",
"POLICE_POUND1",
"POLICE_POUND2",
"POLICE_POUND3",
"POLICE_POUND4",
"POLICE_POUND5",
"Rampage1",
"SANDY_PLANES",
"SCRAP_SECURITY",
"SEW_MACHINE",
"SOLOMON_GATE"
Sometimes used with DOES_SCENARIO_GROUP_EXIST:
if (TASK::DOES_SCENARIO_GROUP_EXIST("Observatory_Bikers") && (!TASK::IS_SCENARIO_GROUP_ENABLED("Observatory_Bikers"))) {
else if (TASK::IS_SCENARIO_GROUP_ENABLED("BLIMP")) {
```
]]
native "IS_SCENARIO_OCCUPIED"
hash "0x788756D73AC2E07C"
jhash (0x697FC008)
arguments {
float "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
BOOL "p4" [=[ {} ]=],
}
ns "TASK"
returns "BOOL"
doc [[!
]]
native "IS_SCENARIO_TYPE_ENABLED"
hash "0x3A815DB3EA088722"
jhash (0xAE37E969)
arguments {
charPtr "scenarioType" [=[ {} ]=],
}
ns "TASK"
returns "BOOL"
doc [[!
```
Occurrences in the b617d scripts:
"PROP_HUMAN_SEAT_CHAIR",
"WORLD_HUMAN_DRINKING",
"WORLD_HUMAN_HANG_OUT_STREET",
"WORLD_HUMAN_SMOKING",
"WORLD_MOUNTAIN_LION_WANDER",
"WORLD_HUMAN_DRINKING"
Sometimes used together with MISC::IS_STRING_NULL_OR_EMPTY in the scripts.
scenarioType could be the same as scenarioName, used in for example TASK::TASK_START_SCENARIO_AT_POSITION.
```
]]
native "IS_TASK_MOVE_NETWORK_ACTIVE"
hash "0x921CE12C489C4C41"
jhash (0x902656EB)
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0x921CE12C489C4C41"
ns "TASK"
returns "BOOL"
doc [[!
]]
native "IS_TASK_MOVE_NETWORK_READY_FOR_TRANSITION"
hash "0x30ED88D5E0C56A37"
jhash (0x92FDBAE6)
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0x30ED88D5E0C56A37"
ns "TASK"
returns "BOOL"
doc [[!
]]
native "IS_WAYPOINT_PLAYBACK_GOING_ON_FOR_PED"
hash "0xE03B3F2D3DC59B64"
jhash (0x85B7725F)
arguments {
Any "p0" [=[ {} ]=],
}
ns "TASK"
returns "BOOL"
doc [[!
]]
native "IS_WAYPOINT_PLAYBACK_GOING_ON_FOR_VEHICLE"
hash "0xF5134943EA29868C"
jhash (0x80DD15DB)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "TASK"
returns "BOOL"
doc [[!
]]
native "OPEN_PATROL_ROUTE"
hash "0xA36BFB5EE89F3D82"
jhash (0xF33F83CA)
arguments {
charPtr "patrolRoute" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
The patrol route name must starts with "miss_" to be properly created.
patrolRoutes found in the b617d scripts:
"miss_Ass0",
"miss_Ass1",
"miss_Ass2",
"miss_Ass3",
"miss_Ass4",
"miss_Ass5",
"miss_Ass6",
"MISS_PATROL_6",
"MISS_PATROL_7",
"MISS_PATROL_8",
"MISS_PATROL_9",
"miss_Tower_01",
"miss_Tower_02",
"miss_Tower_03",
"miss_Tower_04",
"miss_Tower_05",
"miss_Tower_06",
"miss_Tower_07",
"miss_Tower_08",
"miss_Tower_10"
```
]]
native "OPEN_SEQUENCE_TASK"
hash "0xE8854A4326B9E12B"
jhash (0xABA6923E)
arguments {
intPtr "taskSequenceId" [=[ {} ]=],
}
ns "TASK"
annotations [=[ {"cs_type":"Any"} ]=]
returns "void"
doc [[!
### NOTE
If this returns 0 that means it failed to get a sequence id.
If you fail to call [`CLOSE_SEQUENCE_TASK`](#\_0x39E72BC99E6360CB) and [`CLEAR_SEQUENCE_TASK`](#\_0x3841422E9C488D8C) the sequence system can get stuck in a broken state until you restart your client.
The reference to bind to, in Lua/JS this will be returned as a value
]]
native "PED_HAS_USE_SCENARIO_TASK"
hash "0x295E3CCEC879CCD7"
jhash (0x9BE9C691)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "TASK"
returns "BOOL"
doc [[!
]]
native "PLAY_ANIM_ON_RUNNING_SCENARIO"
hash "0x748040460F8DF5DC"
jhash (0x1984A5D1)
arguments {
Ped "ped" [=[ {} ]=],
charPtr "animDict" [=[ {} ]=],
charPtr "animName" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
[Animations list](https://alexguirre.github.io/animations-list/)
]]
native "PLAY_ENTITY_SCRIPTED_ANIM"
hash "0x77A1EEC547E7FCF1"
jhash (0x02F72AE5)
arguments {
Any "p0" [=[ {} ]=],
AnyPtr "p1" [=[ {} ]=],
AnyPtr "p2" [=[ {} ]=],
AnyPtr "p3" [=[ {} ]=],
float "p4" [=[ {} ]=],
float "p5" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "REMOVE_ALL_COVER_BLOCKING_AREAS"
hash "0xDB6708C0B46F56D8"
jhash (0xCF9221A7)
ns "TASK"
returns "void"
doc [[!
]]
native "REMOVE_COVER_POINT"
hash "0xAE287C923D891715"
jhash (0x0776888B)
arguments {
ScrHandle "coverpoint" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "REMOVE_WAYPOINT_RECORDING"
hash "0xFF1B8B4AA1C25DC8"
jhash (0x624530B0)
arguments {
charPtr "name" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "REQUEST_TASK_MOVE_NETWORK_STATE_TRANSITION"
hash "0xD01015C7316AE176"
jhash (0x885724DE)
arguments {
Ped "ped" [=[ {} ]=],
charPtr "name" [=[ {} ]=],
}
alias "0xD01015C7316AE176"
ns "TASK"
returns "BOOL"
doc [[!
A ped handle.
The name of the target request state in the move network file.
Technically a `void`. Scripts treat this as a boolean, but the game never sets the result, so it will return the ped handle instead.
]]
native "REQUEST_WAYPOINT_RECORDING"
hash "0x9EEFB62EB27B5792"
jhash (0xAFABFB5D)
arguments {
charPtr "name" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
For a full list of the points, see here: goo.gl/wIH0vn
Max number of loaded recordings is 32.
```
]]
native "RESET_EXCLUSIVE_SCENARIO_GROUP"
hash "0x4202BBCB8684563D"
jhash (0x17F9DFE8)
ns "TASK"
returns "void"
doc [[!
]]
native "RESET_SCENARIO_GROUPS_ENABLED"
hash "0xDD902D0349AFAD3A"
jhash (0xBF55025D)
ns "TASK"
returns "void"
doc [[!
]]
native "RESET_SCENARIO_TYPES_ENABLED"
hash "0x0D40EE2A7F2B2D6D"
jhash (0xF58FDEB4)
ns "TASK"
returns "void"
doc [[!
]]
native "SET_ANIM_LOOPED"
hash "0x70033C3CC29A1FF4"
jhash (0x095D61A4)
arguments {
Any "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "SET_ANIM_PHASE"
hash "0xDDF3CB5A0A4C0B49"
jhash (0xB621E7E4)
arguments {
Entity "entity" [=[ {} ]=],
float "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
}
alias "0xDDF3CB5A0A4C0B49"
alias "_SET_ANIM_PLAYBACK_TIME"
ns "TASK"
returns "void"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "SET_ANIM_RATE"
hash "0x032D49C5E359C847"
jhash (0x6DB46584)
arguments {
Any "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "SET_ANIM_WEIGHT"
hash "0x207F1A47C0342F48"
jhash (0x17229D98)
arguments {
Any "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
BOOL "p4" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "SET_DRIVE_TASK_CRUISE_SPEED"
hash "0x5C9B84BD7D31D908"
jhash (0x3CEC07B1)
arguments {
Ped "driver" [=[ {} ]=],
float "cruiseSpeed" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "SET_DRIVE_TASK_DRIVING_STYLE"
hash "0xDACE1BE37D88AF67"
jhash (0x59C5FAD7)
arguments {
Ped "ped" [=[ {} ]=],
int "drivingStyle" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
Sets the driving style for a ped currently performing a driving task.
Each flag in the `eVehicleDrivingFlags` enum can be combined to create a driving style, with each enabling or disabling a specific driving behavior. The driving style can be set to one of the predefined driving styles, or a custom driving style can be created by combining the flags. This can be done by using the bitwise OR operator (`|`) to combine the flags or by adding the decimal values of the flags together.
```cpp
enum eVehicleDrivingFlags
{
None = 0,
StopForVehicles = 1,
StopForPeds = 2,
SwerveAroundAllVehicles = 4,
SteerAroundStationaryVehicles = 8,
SteerAroundPeds = 16,
SteerAroundObjects = 32,
DontSteerAroundPlayerPed = 64,
StopAtTrafficLights = 128,
GoOffRoadWhenAvoiding = 256,
AllowGoingWrongWay = 512,
Reverse = 1024,
UseWanderFallbackInsteadOfStraightLine = 2048,
AvoidRestrictedAreas = 4096,
PreventBackgroundPathfinding = 8192,
AdjustCruiseSpeedBasedOnRoadSpeed = 16384,
UseShortCutLinks = 262144,
ChangeLanesAroundObstructions = 524288,
UseSwitchedOffNodes = 2097152,
PreferNavmeshRoute = 4194304,
PlaneTaxiMode = 8388608,
ForceStraightLine = 16777216,
UseStringPullingAtJunctions = 33554432,
TryToAvoidHighways = 536870912,
ForceJoinInRoadDirection = 1073741824,
StopAtDestination = 2147483648,
// StopForVehicles | StopForPeds | SteerAroundObjects | SteerAroundStationaryVehicles | StopAtTrafficLights | UseShortCutLinks | ChangeLanesAroundObstructions
DrivingModeStopForVehicles = 786603,
// StopForVehicles | StopForPeds | StopAtTrafficLights | UseShortCutLinks
DrivingModeStopForVehiclesStrict = 262275,
// SwerveAroundAllVehicles | SteerAroundObjects | UseShortCutLinks | ChangeLanesAroundObstructions | StopForVehicles
DrivingModeAvoidVehicles = 786469,
// SwerveAroundAllVehicles | SteerAroundObjects | UseShortCutLinks | ChangeLanesAroundObstructions
DrivingModeAvoidVehiclesReckless = 786468,
// StopForVehicles | SteerAroundStationaryVehicles | StopForPeds | SteerAroundObjects | UseShortCutLinks | ChangeLanesAroundObstructions
DrivingModeStopForVehiclesIgnoreLights = 786475,
// SwerveAroundAllVehicles | StopAtTrafficLights | SteerAroundObjects | UseShortCutLinks | ChangeLanesAroundObstructions | StopForVehicles
DrivingModeAvoidVehiclesObeyLights = 786597,
// SwerveAroundAllVehicles | StopAtTrafficLights | StopForPeds | SteerAroundObjects | UseShortCutLinks | ChangeLanesAroundObstructions | StopForVehicles
DrivingModeAvoidVehiclesStopForPedsObeyLights = 786599,
}
```
The ped to have their driving style set.
The driving style (see `eVehicleDrivingFlags`).
]]
native "SET_DRIVE_TASK_MAX_CRUISE_SPEED"
hash "0x404A5AA9B9F0B746"
jhash (0x7FDF6131)
arguments {
Any "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "SET_DRIVEBY_TASK_TARGET"
hash "0xE5B302114D8162EE"
jhash (0xDA6A6FC1)
arguments {
Ped "shootingPed" [=[ {} ]=],
Ped "targetPed" [=[ {} ]=],
Vehicle "targetVehicle" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
For p1 & p2 (Ped, Vehicle). I could be wrong, as the only time this native is called in scripts is once and both are 0, but I assume this native will work like SET_MOUNTED_WEAPON_TARGET in which has the same exact amount of parameters and the 1st and last 3 parameters are right and the same for both natives.
```
]]
native "SET_EXCLUSIVE_SCENARIO_GROUP"
hash "0x535E97E1F7FC0C6A"
jhash (0x59DB8F26)
arguments {
charPtr "scenarioGroup" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
Groups found in the scripts used with this native:
"AMMUNATION",
"QUARRY",
"Triathlon_1",
"Triathlon_2",
"Triathlon_3"
```
]]
native "SET_GLOBAL_MIN_BIRD_FLIGHT_HEIGHT"
hash "0x6C6B148586F934F7"
jhash (0x2AFB14B8)
arguments {
float "height" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
Birds will try to reach the given height.
```
]]
native "SET_HIGH_FALL_TASK"
hash "0x8C825BDC7741D37C"
jhash (0xBBB26172)
arguments {
Ped "ped" [=[ {} ]=],
Any "duration" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "SET_MOUNTED_WEAPON_TARGET"
hash "0xCCD892192C6D2BB9"
jhash (0x98713C68)
arguments {
Ped "shootingPed" [=[ {} ]=],
Ped "targetPed" [=[ {} ]=],
Vehicle "targetVehicle" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
Note: Look in decompiled scripts and the times that p1 and p2 aren't 0. They are filled with vars. If you look through out that script what other natives those vars are used in, you can tell p1 is a ped and p2 is a vehicle. Which most likely means if you want the mounted weapon to target a ped set targetVehicle to 0 or vice-versa.
```
```
NativeDB Added Parameter 7: Any p6
NativeDB Added Parameter 8: Any p7
```
]]
native "SET_NEXT_DESIRED_MOVE_STATE"
hash "0xF1B9F16E89E2C93A"
jhash (0x4E937D57)
arguments {
float "p0" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
**This native does absolutely nothing, just a nullsub**
]]
native "SET_PARACHUTE_TASK_TARGET"
hash "0xC313379AF0FCEDA7"
jhash (0x6ED3AD81)
arguments {
Ped "ped" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "SET_PARACHUTE_TASK_THRUST"
hash "0x0729BAC1B8C64317"
jhash (0xD07C8AAA)
arguments {
Ped "ped" [=[ {} ]=],
float "thrust" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "SET_PED_CAN_PLAY_AMBIENT_IDLES"
hash "0x8FD89A6240813FD0"
jhash (0xB5AD044E)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "bBlockIdleClips" [=[ {} ]=],
BOOL "bRemoveIdleClipIfPlaying" [=[ {} ]=],
}
alias "0x8FD89A6240813FD0"
ns "TASK"
returns "void"
doc [[!
Prevents a ped from playing ambient idle animations.
**Note:** This native must be called every frame.
Ped index.
If true, prevents a ped from playing an idle animation this frame.
If true and the ped is playing an idle animation, the clip is stopped.
]]
native "SET_PED_DESIRED_MOVE_BLEND_RATIO"
hash "0x1E982AC8716912C5"
jhash (0xC65FC712)
arguments {
Ped "ped" [=[ {} ]=],
float "p1" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "SET_PED_PATH_AVOID_FIRE"
hash "0x4455517B28441E60"
jhash (0xDCC5B934)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "avoidFire" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "SET_PED_PATH_CAN_DROP_FROM_HEIGHT"
hash "0xE361C5C71C431A4F"
jhash (0x394B7AC9)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "Toggle" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "SET_PED_PATH_CAN_USE_CLIMBOVERS"
hash "0x8E06A6FE76C9EFF4"
jhash (0xB7B7D442)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "Toggle" [=[ {} ]=],
}
ns "TASK"
annotations [=[ {"cs_type":"Any"} ]=]
returns "void"
doc [[!
]]
native "SET_PED_PATH_CAN_USE_LADDERS"
hash "0x77A5B103C87F476E"
jhash (0x53A879EE)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "Toggle" [=[ {} ]=],
}
ns "TASK"
annotations [=[ {"cs_type":"Any"} ]=]
returns "void"
doc [[!
]]
native "SET_PED_PATH_CLIMB_COST_MODIFIER"
hash "0x88E32DB8C1A4AA4B"
jhash (0x55E06443)
arguments {
Ped "ped" [=[ {} ]=],
float "modifier" [=[ {} ]=],
}
alias "0x88E32DB8C1A4AA4B"
ns "TASK"
returns "void"
doc [[!
```
Default modifier is 1.0, minimum is 0.0 and maximum is 10.0.
```
]]
native "SET_PED_PATH_MAY_ENTER_WATER"
hash "0xF35425A4204367EC"
jhash (0x9C606EE3)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "mayEnterWater" [=[ {} ]=],
}
alias "SET_PED_PATHS_WIDTH_PLANT"
ns "TASK"
returns "void"
doc [[!
]]
native "SET_PED_PATH_PREFER_TO_AVOID_WATER"
hash "0x38FE1EC73743793C"
jhash (0x0EA39A29)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "avoidWater" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "SET_PED_WAYPOINT_ROUTE_OFFSET"
hash "0xED98E10B0AFCE4B4"
jhash (0xF867F747)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "TASK"
returns "Any"
doc [[!
]]
native "SET_SCENARIO_GROUP_ENABLED"
hash "0x02C8E5B49848664E"
jhash (0x116997B1)
arguments {
charPtr "scenarioGroup" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
Occurrences in the b617d scripts: pastebin.com/Tvg2PRHU
```
]]
native "SET_SCENARIO_TYPE_ENABLED"
hash "0xEB47EC4E34FB7EE1"
jhash (0xDB18E5DE)
arguments {
charPtr "scenarioType" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
seems to enable/disable specific scenario-types from happening in the game world.
Here are some scenario types from the scripts:
"WORLD_MOUNTAIN_LION_REST"
"WORLD_MOUNTAIN_LION_WANDER"
"DRIVE"
"WORLD_VEHICLE_POLICE_BIKE"
"WORLD_VEHICLE_POLICE_CAR"
"WORLD_VEHICLE_POLICE_NEXT_TO_CAR"
"WORLD_VEHICLE_DRIVE_SOLO"
"WORLD_VEHICLE_BIKER"
"WORLD_VEHICLE_DRIVE_PASSENGERS"
"WORLD_VEHICLE_SALTON_DIRT_BIKE"
"WORLD_VEHICLE_BICYCLE_MOUNTAIN"
"PROP_HUMAN_SEAT_CHAIR"
"WORLD_VEHICLE_ATTRACTOR"
"WORLD_HUMAN_LEANING"
"WORLD_HUMAN_HANG_OUT_STREET"
"WORLD_HUMAN_DRINKING"
"WORLD_HUMAN_SMOKING"
"WORLD_HUMAN_GUARD_STAND"
"WORLD_HUMAN_CLIPBOARD"
"WORLD_HUMAN_HIKER"
"WORLD_VEHICLE_EMPTY"
"WORLD_VEHICLE_BIKE_OFF_ROAD_RACE"
"WORLD_HUMAN_PAPARAZZI"
"WORLD_VEHICLE_PARK_PERPENDICULAR_NOSE_IN"
"WORLD_VEHICLE_PARK_PARALLEL"
"WORLD_VEHICLE_CONSTRUCTION_SOLO"
"WORLD_VEHICLE_CONSTRUCTION_PASSENGERS"
"WORLD_VEHICLE_TRUCK_LOGS"
scenarioType could be the same as scenarioName, used in for example TASK::TASK_START_SCENARIO_AT_POSITION.
```
]]
native "SET_SEQUENCE_TO_REPEAT"
hash "0x58C70CF3A41E4AE7"
jhash (0xCDDF1508)
arguments {
int "taskSequenceId" [=[ {} ]=],
BOOL "repeat" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "SET_TASK_MOVE_NETWORK_SIGNAL_BOOL"
hash "0xB0A6CFD2C69C1088"
jhash (0xF3538041)
arguments {
Ped "ped" [=[ {} ]=],
charPtr "signalName" [=[ {} ]=],
BOOL "value" [=[ {} ]=],
}
alias "0xB0A6CFD2C69C1088"
alias "_SET_TASK_PROPERTY_BOOL"
ns "TASK"
returns "void"
doc [[!
The ped that's performing the task.
The property name.
The property value to set.
]]
native "SET_TASK_MOVE_NETWORK_SIGNAL_FLOAT"
hash "0xD5BB4025AE449A4E"
jhash (0xA79BE783)
arguments {
Ped "ped" [=[ {} ]=],
charPtr "signalName" [=[ {} ]=],
float "value" [=[ {} ]=],
}
alias "0xD5BB4025AE449A4E"
alias "_SET_TASK_PROPERTY_FLOAT"
ns "TASK"
returns "void"
doc [[!
```
p0 - PLAYER::PLAYER_PED_ID();
p1 - "Phase", "Wobble", "x_axis","y_axis","introphase","speed".
p2 - From what i can see it goes up to 1f (maybe).
-LcGamingHD
Example: TASK::_D5BB4025AE449A4E(PLAYER::PLAYER_PED_ID(), "Phase", 0.5);
```
The ped on which the task is playing.
The property name.
The property value to set.
]]
native "SET_TASK_VEHICLE_CHASE_BEHAVIOR_FLAG"
hash "0xCC665AAC360D31E7"
jhash (0x2A83083F)
arguments {
Ped "ped" [=[ {} ]=],
int "flag" [=[ {} ]=],
BOOL "set" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
* Flag 1: Aggressive ramming of suspect
* Flag 2: Ram attempts
* Flag 8: Medium-aggressive boxing tactic with a bit of PIT
* Flag 16: Ramming, seems to be slightly less aggressive than 1-2.
* Flag 32: Stay back from suspect, no tactical contact. Convoy-like.
```
]]
native "SET_TASK_VEHICLE_CHASE_IDEAL_PURSUIT_DISTANCE"
hash "0x639B642FACBE4EDD"
jhash (0x04FD3EE7)
arguments {
Ped "ped" [=[ {} ]=],
float "distance" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "STOP_ANIM_PLAYBACK"
hash "0xEE08C992D238C5D1"
jhash (0xE5F16398)
arguments {
Ped "ped" [=[ {} ]=],
int "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
Looks like p1 may be a flag, still need to do some research, though.
```
]]
native "STOP_ANIM_TASK"
hash "0x97FF36A1D40EA00A"
jhash (0x2B520A57)
arguments {
Ped "ped" [=[ {} ]=],
charPtr "animDictionary" [=[ {} ]=],
charPtr "animationName" [=[ {} ]=],
float "animExitSpeed" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
[Animations list](https://alexguirre.github.io/animations-list/)
Greater than `0.0`, higher is faster. Setting to `0.0` or using an integer, will cause animation lockout - requiring the animation to be played again or the player be killed.
]]
native "TASK_ACHIEVE_HEADING"
hash "0x93B93A37987F1F3D"
jhash (0x0A0E9B42)
arguments {
Ped "ped" [=[ {} ]=],
float "heading" [=[ {} ]=],
int "timeout" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
Makes the specified ped achieve the specified heading.
pedHandle: The handle of the ped to assign the task to.
heading: The desired heading.
timeout: The time, in milliseconds, to allow the task to complete. If the task times out, it is cancelled, and the ped will stay at the heading it managed to reach in the time.
```
]]
native "TASK_AIM_GUN_AT_COORD"
hash "0x6671F3EEC681BDA1"
jhash (0xFBF44AD3)
arguments {
Ped "ped" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
int "time" [=[ {} ]=],
BOOL "bInstantBlendToAim" [=[ {} ]=],
BOOL "bPlayAimIntro" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "TASK_AIM_GUN_AT_ENTITY"
hash "0x9B53BB6E8943AF53"
jhash (0xBE32B3B6)
arguments {
Ped "ped" [=[ {} ]=],
Entity "entity" [=[ {} ]=],
int "duration" [=[ {} ]=],
BOOL "bInstantBlendToAim" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
duration: the amount of time in milliseconds to do the task. -1 will keep the task going until either another task is applied, or CLEAR_ALL_TASKS() is called with the ped
```
]]
native "TASK_AIM_GUN_SCRIPTED"
hash "0x7A192BE16D373D00"
jhash (0x9D296BCD)
arguments {
Ped "ped" [=[ {} ]=],
Hash "scriptTask" [=[ {} ]=],
BOOL "bDisableBlockingClip" [=[ {} ]=],
BOOL "bInstantBlendToAim" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "TASK_AIM_GUN_SCRIPTED_WITH_TARGET"
hash "0x8605AF0DE8B3A5AC"
jhash (0xFD517CE3)
arguments {
Ped "ped" [=[ {} ]=],
Ped "targetPed" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
Hash "iGunTaskType" [=[ {"cs_type":"Any"} ]=],
BOOL "bDisableBlockingClip" [=[ {} ]=],
BOOL "bForceAim" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "TASK_ARREST_PED"
hash "0xF3B9A78A178572B1"
jhash (0xBC0F153D)
arguments {
Ped "ped" [=[ {} ]=],
Ped "target" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
Example from "me_amanda1.ysc.c4":
TASK::TASK_ARREST_PED(l_19F /* This is a Ped */ , PLAYER::PLAYER_PED_ID());
Example from "armenian1.ysc.c4":
if (!PED::IS_PED_INJURED(l_B18[0/*1*/])) {
TASK::TASK_ARREST_PED(l_B18[0/*1*/], PLAYER::PLAYER_PED_ID());
}
I would love to have time to experiment to see if a player Ped can arrest another Ped. Might make for a good cop mod.
Looks like only the player can be arrested this way. Peds react and try to arrest you if you task them, but the player charater doesn't do anything if tasked to arrest another ped.
```
]]
native "TASK_BOAT_MISSION"
hash "0x15C86013127CE63F"
jhash (0x5865B031)
arguments {
Ped "ped" [=[ {} ]=],
Vehicle "boat" [=[ {} ]=],
Vehicle "vehicleTarget" [=[ {} ]=],
Ped "pedTarget" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
int "missionType" [=[ {} ]=],
float "speed" [=[ {} ]=],
int "drivingStyle" [=[ {} ]=],
float "radius" [=[ {} ]=],
int "missionFlags" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
All parameters except ped and boat are optional, with `pedTarget`, `vehicleTarget`, `x`, `y`, `z` being dependent on `missionType` (ie. Attack/Flee mission types require a target ped/vehicle, whereas GoTo mission types require either `x`, `y`, `z` or a target ped/vehicle).
If you don't want to use a parameter; pass `0.0f` for `x`, `y` and `z`, `0` for `pedTarget`, `vehicleTarget` and other int parameters, and `-1.0f` for the remaining float parameters.
```cpp
enum eBoatMissionFlags
{
None = 0,
StopAtEnd = 1,
StopAtShore = 2,
AvoidShore = 4,
PreferForward = 8,
NeverStop = 16,
NeverNavMesh = 32,
NeverRoute = 64,
ForceBeached = 128,
UseWanderRoute = 256,
UseFleeRoute = 512,
NeverPause = 1024,
// StopAtEnd | StopAtShore | AvoidShore
DefaultSettings = 7,
// StopAtEnd | StopAtShore | AvoidShore | PreferForward | NeverNavMesh | NeverRoute
OpenOceanSettings = 111,
// StopAtEnd | StopAtShore | AvoidShore | PreferForward | NeverNavMesh | NeverPause
BoatTaxiSettings = 1071,
}
```
The ped to be tasked.
The boats' entity handle.
The target vehicle (default is 0).
The target ped (default is 0).
The x coordinate of the target (default is 0.0f).
The y coordinate of the target (default is 0.0f).
The z coordinate of the target (default is 0.0f).
The mission type (default is 0) (see [TaskVehicleMission](#\_0x659427E0EF36BCDE)).
The speed in m/s (default is -1.0f).
The driving style (default is 0) (see [SetDriveTaskDrivingStyle](#\_0xDACE1BE37D88AF67)).
The radius of when the task will be completed (default is -1.0f).
The mission flags (default is 0) (see `eBoatMissionFlags`).
]]
native "TASK_CHAT_TO_PED"
hash "0x8C338E0263E4FD19"
jhash (0xA2BE1821)
arguments {
Ped "ped" [=[ {} ]=],
Ped "target" [=[ {} ]=],
Any "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
float "p4" [=[ {} ]=],
float "p5" [=[ {} ]=],
float "p6" [=[ {} ]=],
float "p7" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
p2 tend to be 16, 17 or 1
p3 to p7 tend to be 0.0
```
]]
native "TASK_CLEAR_DEFENSIVE_AREA"
hash "0x95A6C46A31D1917D"
jhash (0x7A05BF0D)
arguments {
Any "p0" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "TASK_CLEAR_LOOK_AT"
hash "0x0F804F1DB19B9689"
jhash (0x60EB4054)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
Not clear what it actually does, but here's how script uses it -
if (OBJECT::HAS_PICKUP_BEEN_COLLECTED(...)
{
if(ENTITY::DOES_ENTITY_EXIST(PLAYER::PLAYER_PED_ID()))
{
TASK::TASK_CLEAR_LOOK_AT(PLAYER::PLAYER_PED_ID());
}
...
}
Another one where it doesn't "look" at current player -
TASK::TASK_PLAY_ANIM(l_3ED, "missheist_agency2aig_2", "look_at_phone_a", 1000.0, -2.0, -1, 48, v_2, 0, 0, 0);
PED::_2208438012482A1A(l_3ED, 0, 0);
TASK::TASK_CLEAR_LOOK_AT(l_3ED);
```
]]
native "TASK_CLIMB"
hash "0x89D9FCC2435112F1"
jhash (0x90847790)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "unused" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
Climbs or vaults the nearest thing.
```
]]
native "TASK_CLIMB_LADDER"
hash "0xB6C987F9285A3814"
jhash (0x35BB4EE0)
arguments {
Ped "ped" [=[ {} ]=],
int "p1" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "TASK_COMBAT_HATED_TARGETS_AROUND_PED"
hash "0x7BF835BB9E2698C8"
jhash (0x2E7064E4)
arguments {
Ped "ped" [=[ {} ]=],
float "radius" [=[ {} ]=],
int "p2" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
Despite its name, it only attacks ONE hated target. The one closest hated target.
p2 seems to be always 0
```
]]
native "TASK_COMBAT_HATED_TARGETS_AROUND_PED_TIMED"
hash "0x2BBA30B854534A0C"
jhash (0xF127AD6A)
arguments {
Any "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "TASK_COMBAT_HATED_TARGETS_IN_AREA"
hash "0x4CF5F55DAC3280A0"
jhash (0xDF099E18)
arguments {
Ped "ped" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "radius" [=[ {} ]=],
Any "p5" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
Despite its name, it only attacks ONE hated target. The one closest to the specified position.
```
]]
native "TASK_COMBAT_PED"
hash "0xF166E48407BAC484"
jhash (0xCB0D8932)
arguments {
Ped "ped" [=[ {} ]=],
Ped "targetPed" [=[ {} ]=],
int "p2" [=[ {} ]=],
int "p3" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
Makes the specified ped attack the target ped.
p2 should be 0
p3 should be 16
```
]]
native "TASK_COMBAT_PED_TIMED"
hash "0x944F30DCB7096BDE"
jhash (0xF5CA2A45)
arguments {
Any "p0" [=[ {} ]=],
Ped "ped" [=[ {} ]=],
int "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "TASK_COWER"
hash "0x3EB1FE9E8E908E15"
jhash (0x9CF1C19B)
arguments {
Ped "ped" [=[ {} ]=],
int "duration" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
The ped will act like NPC's involved in a gunfight. The ped will squat down with their heads held in place and look around.
Ped id.
Duration of the animation in ms. Set to -1 if you do not want a duration.
]]
native "TASK_DRIVE_BY"
hash "0x2F8AF0E82773A171"
jhash (0x2B84D1C4)
arguments {
Ped "driverPed" [=[ {} ]=],
Ped "targetPed" [=[ {} ]=],
Vehicle "targetVehicle" [=[ {} ]=],
float "targetX" [=[ {} ]=],
float "targetY" [=[ {} ]=],
float "targetZ" [=[ {} ]=],
float "distanceToShoot" [=[ {} ]=],
int "pedAccuracy" [=[ {} ]=],
BOOL "p8" [=[ {} ]=],
Hash "firingPattern" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
Example:
TASK::TASK_DRIVE_BY(l_467[1/*22*/], PLAYER::PLAYER_PED_ID(), 0, 0.0, 0.0, 2.0, 300.0, 100, 0, ${firing_pattern_burst_fire_driveby});
Needs working example. Doesn't seem to do anything.
I marked p2 as targetVehicle as all these shooting related tasks seem to have that in common.
I marked p6 as distanceToShoot as if you think of GTA's Logic with the native SET_VEHICLE_SHOOT natives, it won't shoot till it gets within a certain distance of the target.
I marked p7 as pedAccuracy as it seems it's mostly 100 (Completely Accurate), 75, 90, etc. Although this could be the ammo count within the gun, but I highly doubt it. I will change this comment once I find out if it's ammo count or not.
```
]]
native "TASK_ENTER_VEHICLE"
hash "0xC20E50AA46D09CA8"
jhash (0xB8689B4E)
arguments {
Ped "ped" [=[ {} ]=],
Vehicle "vehicle" [=[ {} ]=],
int "timeout" [=[ {} ]=],
int "seatIndex" [=[ {} ]=],
float "speed" [=[ {} ]=],
int "flag" [=[ {} ]=],
Any "p6" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
speed 1.0 = walk, 2.0 = run
p5 1 = normal, 3 = teleport to vehicle, 8 = normal/carjack ped from seat, 16 = teleport directly into vehicle
p6 is always 0
```
See eSeatPosition declared in [`IS_VEHICLE_SEAT_FREE`](#\_0x22AC59A870E6A669).
]]
native "TASK_EVERYONE_LEAVE_VEHICLE"
hash "0x7F93691AB4B92272"
jhash (0xC1971F30)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "TASK_EXIT_COVER"
hash "0x79B258E397854D29"
jhash (0xC829FAC9)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
float "p4" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "TASK_EXTEND_ROUTE"
hash "0x1E7889778264843A"
jhash (0x43271F69)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
Adds a new point to the current point route; a maximum of 8 points can be added.
Call [TASK_FLUSH_ROUTE](#\_0x841142A1376E9006) before the first call to this. Call [TASK_FOLLOW_POINT_ROUTE](#\_0x595583281858626E) to make the Ped go the route.
]]
native "TASK_FLUSH_ROUTE"
hash "0x841142A1376E9006"
jhash (0x34219154)
ns "TASK"
returns "void"
doc [[!
Clears the current point route. Call this before [TASK_EXTEND_ROUTE](#\_0x1E7889778264843A) and [TASK_FOLLOW_POINT_ROUTE](#\_0x595583281858626E).
]]
native "TASK_FOLLOW_NAV_MESH_TO_COORD"
hash "0x15D3A79D4E44B913"
jhash (0xFE4A10D9)
arguments {
Ped "ped" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "moveBlendRatio" [=[ {} ]=],
int "time" [=[ {} ]=],
float "radius" [=[ {} ]=],
int "flags" [=[ {"cs_type":"BOOL"} ]=],
float "finalHeading" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
Sometimes a path may not be able to be found. This could happen because there simply isn't any way to get there, or maybe a bunch of dynamic objects have blocked the way,
or maybe the destination is too far away. In this case the ped will simply stand still.
To identify when this has happened, you can use GET_NAVMESH_ROUTE_RESULT. This will help you find situations where peds cannot get to their target.
```cpp
enum eNavScriptFlags {
// Default flag
ENAV_DEFAULT = 0,
// Will ensure the ped continues to move whilst waiting for the path
// to be found, and will not slow down at the end of their route.
ENAV_NO_STOPPING = 1,
// Performs a slide-to-coord at the end of the task. This requires that the
// accompanying NAVDATA structure has the 'SlideToCoordHeading' member set correctly.
ENAV_ADV_SLIDE_TO_COORD_AND_ACHIEVE_HEADING_AT_END = 2,
// If the navmesh is not loaded in under the target position, then this will
// cause the ped to get as close as is possible on whatever navmesh is loaded.
// The navmesh must still be loaded at the path start.
ENAV_GO_FAR_AS_POSSIBLE_IF_TARGET_NAVMESH_NOT_LOADED = 4,
// Will allow navigation underwater - by default this is not allowed.
ENAV_ALLOW_SWIMMING_UNDERWATER = 8,
// Will only allow navigation on pavements. If the path starts or ends off
// the pavement, the command will fail. Likewise if no pavement-only route
// can be found even although the start and end are on pavement.
ENAV_KEEP_TO_PAVEMENTS = 16,
// Prevents the path from entering water at all.
ENAV_NEVER_ENTER_WATER = 32,
// Disables object-avoidance for this path. The ped may still make minor
// steering adjustments to avoid objects, but will not pathfind around them.
ENAV_DONT_AVOID_OBJECTS = 64,
// Specifies that the navmesh route will only be able to traverse up slopes
// which are under the angle specified, in the MaxSlopeNavigable member of the accompanying NAVDATA structure.
ENAV_ADVANCED_USE_MAX_SLOPE_NAVIGABLE = 128,
// Unused.
ENAV_STOP_EXACTLY = 512,
// The entity will look ahead in its path for a longer distance to make the
// walk/run start go more in the right direction.
ENAV_ACCURATE_WALKRUN_START = 1024,
// Disables ped-avoidance for this path while we move.
ENAV_DONT_AVOID_PEDS = 2048,
// If target pos is inside the boundingbox of an object it will otherwise be pushed out.
ENAV_DONT_ADJUST_TARGET_POSITION = 4096,
// Turns off the default behaviour, which is to stop exactly at the target position.
// Occasionally this can cause footsliding/skating problems.
ENAV_SUPPRESS_EXACT_STOP = 8192,
// Prevents the path-search from finding paths outside of this search distance.
// This can be used to prevent peds from finding long undesired routes.
ENAV_ADVANCED_USE_CLAMP_MAX_SEARCH_DISTANCE = 16384,
// Pulls out the paths from edges at corners for a longer distance, to prevent peds walking into stuff.
ENAV_PULL_FROM_EDGE_EXTRA = 32768
};
```
Ped Index.
X Position Coordinate.
Y Position Coordinate.
Z Position Coordinate
Ratio for ped movement (0 to 3.0 in the following order: still, walk, run and sprint)
INT value in milliseconds.
distance from the final coordinates that the pedestrian should be to consider itself at the target.
Navigation Flags for the ped (see `eNavScriptFlags`).
Peds heading when finished.
]]
native "TASK_FOLLOW_NAV_MESH_TO_COORD_ADVANCED"
hash "0x17F58B88D085DBAC"
jhash (0x6BF6E296)
arguments {
Ped "ped" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "speed" [=[ {} ]=],
int "timeout" [=[ {} ]=],
float "unkFloat" [=[ {} ]=],
int "unkInt" [=[ {} ]=],
float "unkX" [=[ {} ]=],
float "unkY" [=[ {} ]=],
float "unkZ" [=[ {} ]=],
float "unk_40000f" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "TASK_FOLLOW_POINT_ROUTE"
hash "0x595583281858626E"
jhash (0xB837C816)
arguments {
Ped "ped" [=[ {} ]=],
float "speed" [=[ {} ]=],
int "routeMode" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
Makes the ped go on a point route.
```cpp
enum eFollowPointRouteMode {
TICKET_SINGLE = 0,
TICKET_RETURN = 1,
TICKET_SEASON = 2,
TICKET_LOOP = 3
}
```
This native is often times used with [`TASK_FLUSH_ROUTE`](#\_0x841142A1376E9006) and [`TASK_EXTEND_ROUTE`](#\_0x1E7889778264843A)
The ped to give the task to.
The speed to move at in m/s.
The route mode to use, refer to `eFollowPointRouteMode`
]]
native "TASK_FOLLOW_TO_OFFSET_OF_ENTITY"
hash "0x304AE42E357B8C7E"
jhash (0x2DF5A6AC)
arguments {
Ped "ped" [=[ {} ]=],
Entity "entity" [=[ {} ]=],
float "offsetX" [=[ {} ]=],
float "offsetY" [=[ {} ]=],
float "offsetZ" [=[ {} ]=],
float "movementSpeed" [=[ {} ]=],
int "timeout" [=[ {} ]=],
float "stoppingRange" [=[ {} ]=],
BOOL "persistFollowing" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
p6 always -1
p7 always 10.0
p8 always 1
```
]]
native "TASK_FOLLOW_WAYPOINT_RECORDING"
hash "0x0759591819534F7B"
jhash (0xADF9904D)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "TASK_FORCE_MOTION_STATE"
hash "0x4F056E1AFFEF17AB"
jhash (0xCAD2EF77)
arguments {
Ped "ped" [=[ {} ]=],
Hash "state" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
See [`FORCE_PED_MOTION_STATE`](#\_0xF28965D04F570DCA)
]]
native "TASK_GET_OFF_BOAT"
hash "0x9C00E77AF14B2DFF"
jhash (0x4293601F)
arguments {
Ped "ped" [=[ {} ]=],
Vehicle "boat" [=[ {} ]=],
}
alias "_TASK_GET_OFF_BOAT"
ns "TASK"
returns "void"
doc [[!
]]
native "TASK_GO_STRAIGHT_TO_COORD"
hash "0xD76B57B44F1E6F8B"
jhash (0x80A9E7A7)
arguments {
Ped "ped" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "speed" [=[ {} ]=],
int "timeout" [=[ {} ]=],
float "targetHeading" [=[ {} ]=],
float "distanceToSlide" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
The ped handle.
The x coordinate.
The y coordinate.
The z coordinate.
The ped movement speed.
\-1 , other values appear to break the ped movement.
The heading you want the ped to be on x,y,z coord.
The distance from x,y,z where the ped will start sliding.
]]
native "TASK_GO_STRAIGHT_TO_COORD_RELATIVE_TO_ENTITY"
hash "0x61E360B7E040D12E"
jhash (0xD26CAC68)
arguments {
Entity "entity1" [=[ {} ]=],
Entity "entity2" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
float "p4" [=[ {} ]=],
float "p5" [=[ {} ]=],
Any "p6" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "TASK_GO_TO_COORD_AND_AIM_AT_HATED_ENTITIES_NEAR_COORD"
hash "0xA55547801EB331FC"
jhash (0x3F91358E)
arguments {
Ped "pedHandle" [=[ {} ]=],
float "goToLocationX" [=[ {} ]=],
float "goToLocationY" [=[ {} ]=],
float "goToLocationZ" [=[ {} ]=],
float "focusLocationX" [=[ {} ]=],
float "focusLocationY" [=[ {} ]=],
float "focusLocationZ" [=[ {} ]=],
float "speed" [=[ {} ]=],
BOOL "shootAtEnemies" [=[ {} ]=],
float "distanceToStopAt" [=[ {} ]=],
float "noRoadsDistance" [=[ {} ]=],
BOOL "unkTrue" [=[ {} ]=],
int "unkFlag" [=[ {} ]=],
int "aimingFlag" [=[ {} ]=],
Hash "firingPattern" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
The ped will walk or run towards goToLocation, aiming towards goToLocation or focusLocation (depending on the aimingFlag) and shooting if shootAtEnemies = true to any enemy in his path.
If the ped is closer than noRoadsDistance, the ped will ignore pathing/navmesh and go towards goToLocation directly. This could cause the ped to get stuck behind tall walls if the goToLocation is on the other side. To avoid this, use 0.0f and the ped will always use pathing/navmesh to reach his destination.
If the speed is set to 0.0f, the ped will just stand there while aiming, if set to 1.0f he will walk while aiming, 2.0f will run while aiming.
The ped will stop aiming when he is closer than distanceToStopAt to goToLocation.
I still can't figure out what unkTrue is used for. I don't notice any difference if I set it to false but in the decompiled scripts is always true.
I think that unkFlag, like the driving styles, could be a flag that "work as a list of 32 bits converted to a decimal integer. Each bit acts as a flag, and enables or disables a function". What leads me to this conclusion is the fact that in the decompiled scripts, unkFlag takes values like: 0, 1, 5 (101 in binary) and 4097 (4096 + 1 or 1000000000001 in binary). For now, I don't know what behavior enable or disable this possible flag so I leave it at 0.
Note: After some testing, using unkFlag = 16 (0x10) enables the use of sidewalks while moving towards goToLocation.
The aimingFlag takes 2 values: 0 to aim at the focusLocation, 1 to aim at where the ped is heading (goToLocation).
Example:
enum AimFlag
{
AimAtFocusLocation,
AimAtGoToLocation
};
Vector3 goToLocation1 = { 996.2867f, 0, -2143.044f, 0, 28.4763f, 0 }; // remember the padding.
Vector3 goToLocation2 = { 990.2867f, 0, -2140.044f, 0, 28.4763f, 0 }; // remember the padding.
Vector3 focusLocation = { 994.3478f, 0, -2136.118f, 0, 29.2463f, 0 }; // the coord z should be a little higher, around +1.0f to avoid aiming at the ground
// 1st example
TASK::TASK_GO_TO_COORD_AND_AIM_AT_HATED_ENTITIES_NEAR_COORD(pedHandle, goToLocation1.x, goToLocation1.y, goToLocation1.z, focusLocation.x, focusLocation.y, focusLocation.z, 2.0f /*run*/, true /*shoot*/, 3.0f /*stop at*/, 0.0f /*noRoadsDistance*/, true /*always true*/, 0 /*possible flag*/, AimFlag::AimAtGoToLocation, -957453492 /*FullAuto pattern*/);
// 2nd example
TASK::TASK_GO_TO_COORD_AND_AIM_AT_HATED_ENTITIES_NEAR_COORD(pedHandle, goToLocation2.x, goToLocation2.y, goToLocation2.z, focusLocation.x, focusLocation.y, focusLocation.z, 1.0f /*walk*/, false /*don't shoot*/, 3.0f /*stop at*/, 0.0f /*noRoadsDistance*/, true /*always true*/, 0 /*possible flag*/, AimFlag::AimAtFocusLocation, -957453492 /*FullAuto pattern*/);
1st example: The ped (pedhandle) will run towards goToLocation1. While running and aiming towards goToLocation1, the ped will shoot on sight to any enemy in his path, using "FullAuto" firing pattern. The ped will stop once he is closer than distanceToStopAt to goToLocation1.
2nd example: The ped will walk towards goToLocation2. This time, while walking towards goToLocation2 and aiming at focusLocation, the ped will point his weapon on sight to any enemy in his path without shooting. The ped will stop once he is closer than distanceToStopAt to goToLocation2.
```
]]
native "TASK_GO_TO_COORD_ANY_MEANS"
hash "0x5BC448CB78FA3E88"
jhash (0xF91DF93B)
arguments {
Ped "ped" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "fMoveBlendRatio" [=[ {} ]=],
Vehicle "vehicle" [=[ {"cs_type":"Any"} ]=],
BOOL "bUseLongRangeVehiclePathing" [=[ {} ]=],
int "drivingFlags" [=[ {} ]=],
float "fMaxRangeToShootTargets" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
Tells a ped to go to a coord by any means.
```cpp
enum eDrivingMode {
DF_StopForCars = 1,
DF_StopForPeds = 2,
DF_SwerveAroundAllCars = 4,
DF_SteerAroundStationaryCars = 8,
DF_SteerAroundPeds = 16,
DF_SteerAroundObjects = 32,
DF_DontSteerAroundPlayerPed = 64,
DF_StopAtLights = 128,
DF_GoOffRoadWhenAvoiding = 256,
DF_DriveIntoOncomingTraffic = 512,
DF_DriveInReverse = 1024,
// If pathfinding fails, cruise randomly instead of going on a straight line
DF_UseWanderFallbackInsteadOfStraightLine = 2048,
DF_AvoidRestrictedAreas = 4096,
// These only work on MISSION_CRUISE
DF_PreventBackgroundPathfinding = 8192,
DF_AdjustCruiseSpeedBasedOnRoadSpeed = 16384,
DF_UseShortCutLinks = 262144,
DF_ChangeLanesAroundObstructions = 524288,
// cruise tasks ignore this anyway--only used for goto's
DF_UseSwitchedOffNodes = 2097152,
// if you're going to be primarily driving off road
DF_PreferNavmeshRoute = 4194304,
// Only works for planes using MISSION_GOTO, will cause them to drive along the ground instead of fly
DF_PlaneTaxiMode = 8388608,
DF_ForceStraightLine = 16777216,
DF_UseStringPullingAtJunctions = 33554432,
DF_AvoidHighways = 536870912,
DF_ForceJoinInRoadDirection = 1073741824,
// Standard driving mode. stops for cars, peds, and lights, goes around stationary obstructions
DRIVINGMODE_STOPFORCARS = 786603, // DF_StopForCars|DF_StopForPeds|DF_SteerAroundObjects|DF_SteerAroundStationaryCars|DF_StopAtLights|DF_UseShortCutLinks|DF_ChangeLanesAroundObstructions, // Obey lights too
// Like the above, but doesn't steer around anything in its way - will only wait instead.
DRIVINGMODE_STOPFORCARS_STRICT = 262275, // DF_StopForCars|DF_StopForPeds|DF_StopAtLights|DF_UseShortCutLinks, // Doesn't deviate an inch.
// Default "alerted" driving mode. drives around everything, doesn't obey lights
DRIVINGMODE_AVOIDCARS = 786469, // DF_SwerveAroundAllCars|DF_SteerAroundObjects|DF_UseShortCutLinks|DF_ChangeLanesAroundObstructions|DF_StopForCars,
// Very erratic driving. difference between this and AvoidCars is that it doesn't use the brakes at ALL to help with steering
DRIVINGMODE_AVOIDCARS_RECKLESS = 786468, // DF_SwerveAroundAllCars|DF_SteerAroundObjects|DF_UseShortCutLinks|DF_ChangeLanesAroundObstructions,
// Smashes through everything
DRIVINGMODE_PLOUGHTHROUGH = 262144, // DF_UseShortCutLinks
// Drives normally except for the fact that it ignores lights
DRIVINGMODE_STOPFORCARS_IGNORELIGHTS = 786475, // DF_StopForCars|DF_SteerAroundStationaryCars|DF_StopForPeds|DF_SteerAroundObjects|DF_UseShortCutLinks|DF_ChangeLanesAroundObstructions
// Try to swerve around everything, but stop for lights if necessary
DRIVINGMODE_AVOIDCARS_OBEYLIGHTS = 786597, // DF_SwerveAroundAllCars|DF_StopAtLights|DF_SteerAroundObjects|DF_UseShortCutLinks|DF_ChangeLanesAroundObstructions|DF_StopForCars
// Swerve around cars, be careful around peds, and stop for lights
DRIVINGMODE_AVOIDCARS_STOPFORPEDS_OBEYLIGHTS = 786599 // DF_SwerveAroundAllCars|DF_StopAtLights|DF_StopForPeds|DF_SteerAroundObjects|DF_UseShortCutLinks|DF_ChangeLanesAroundObstructions|DF_StopForCars
};
```
The `Ped` Handle.
The goto target coordinate.
The goto target coordinate.
The goto target coordinate.
0.0 = still, 1.0 = walk, 2.0 = run, 3.0 = sprint.
If defined, the pedestrian will only move if said vehicle exists. If you don't want any sort of association, just set it to `0`.
Setting to `true` tells the vehicle to use longrange vehicle pathing.
See `eDrivingMode` enum.
Determines the maximum distance at which the `Ped` will engage in combat with threatening targets.
]]
native "TASK_GO_TO_COORD_ANY_MEANS_EXTRA_PARAMS"
hash "0x1DD45F9ECFDB1BC9"
jhash (0x094B75EF)
arguments {
Ped "ped" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "speed" [=[ {} ]=],
Any "p5" [=[ {} ]=],
BOOL "p6" [=[ {} ]=],
int "walkingStyle" [=[ {} ]=],
float "p8" [=[ {} ]=],
Any "p9" [=[ {} ]=],
Any "p10" [=[ {} ]=],
Any "p11" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
NativeDB Added Parameter 13: Any p12
```
]]
native "TASK_GO_TO_COORD_ANY_MEANS_EXTRA_PARAMS_WITH_CRUISE_SPEED"
hash "0xB8ECD61F531A7B02"
jhash (0x86DC03F9)
arguments {
Ped "ped" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "speed" [=[ {} ]=],
Any "p5" [=[ {} ]=],
BOOL "p6" [=[ {} ]=],
int "walkingStyle" [=[ {} ]=],
float "p8" [=[ {} ]=],
Any "p9" [=[ {} ]=],
Any "p10" [=[ {} ]=],
Any "p11" [=[ {} ]=],
Any "p12" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
NativeDB Added Parameter 14: Any p13
```
]]
native "TASK_GO_TO_COORD_WHILE_AIMING_AT_COORD"
hash "0x11315AB3385B8AC0"
jhash (0x1552DC91)
arguments {
Ped "ped" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "aimAtX" [=[ {} ]=],
float "aimAtY" [=[ {} ]=],
float "aimAtZ" [=[ {} ]=],
float "moveSpeed" [=[ {} ]=],
BOOL "shoot" [=[ {} ]=],
float "p9" [=[ {} ]=],
float "p10" [=[ {} ]=],
BOOL "p11" [=[ {} ]=],
Any "flags" [=[ {} ]=],
BOOL "p13" [=[ {} ]=],
Hash "firingPattern" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
Will make the ped move to a coordinate while aiming (and optionally shooting) at given coordinates.
Ped to task
Destination X position
Destination Y position
Destination Z position
Aim at target x position
Aim at target Y position
Aim at target Z position
mostly 2f, but also 1/1.2f, etc.
If true ped will shoot; false - will not
Usually 2.0f
Usually 0.5f
If true ped will stay still; false - will not
0 / 512 / 513, etc
${firing_pattern_full_auto}, 0xC6EE6B4C
]]
native "TASK_GO_TO_COORD_WHILE_AIMING_AT_ENTITY"
hash "0xB2A16444EAD9AE47"
jhash (0x9BD52ABD)
arguments {
Ped "ped" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
Entity "entityToAimAt" [=[ {} ]=],
float "moveSpeed" [=[ {} ]=],
BOOL "shoot" [=[ {} ]=],
float "targetRadius" [=[ {} ]=],
float "slowDistance" [=[ {} ]=],
BOOL "useNavMesh" [=[ {} ]=],
int "navFlags" [=[ {} ]=],
BOOL "instantBlendAtAim" [=[ {} ]=],
Hash "firingPattern" [=[ {"cs_type":"Any"} ]=],
int "time" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
Will make the ped move to a coordinate while aiming (and optionally shooting) at the given entity.
```cpp
enum eFiringPatternHashes {
FIRING_PATTERN_DEFAULT = 0,
FIRING_PATTERN_BURST_FIRE = -687903391,
FIRING_PATTERN_BURST_FIRE_DRIVEBY = -753768974,
FIRING_PATTERN_FULL_AUTO = -957453492,
FIRING_PATTERN_SINGLE_SHOT = 1566631136,
FIRING_PATTERN_DELAY_FIRE_BY_ONE_SEC = 2055493265,
FIRING_PATTERN_BURST_FIRE_HELI = -1857128337,
FIRING_PATTERN_SHORT_BURSTS = 445831135,
FIRING_PATTERN_BURST_FIRE_MICRO = 1122960381,
FIRING_PATTERN_SLOW_FIRE_TANK = -490063247,
FIRING_PATTERN_TAMPA_MORTAR = -1842093953
}
```
Ped to task
Destination X position
Destination Y position
Destination Z position
Entity that the ped will aim at.
Mostly 2f, but also 1/1.2f, etc.
If true ped will shoot; false - will not
Usually 0.5f
Usually 4f
Usually 0 or 64
The firing pattern to use, refer to `eFiringPatternHashes`
Usually 20000 (ms)
]]
native "TASK_GO_TO_ENTITY"
hash "0x6A071245EB0D1882"
jhash (0x374827C2)
arguments {
Entity "entity" [=[ {} ]=],
Entity "target" [=[ {} ]=],
int "duration" [=[ {} ]=],
float "distance" [=[ {} ]=],
float "speed" [=[ {} ]=],
float "p5" [=[ {} ]=],
int "p6" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
The entity will move towards the target until time is over (duration) or get in target's range (distance). p5 and p6 are unknown, but you could leave p5 = 1073741824 or 100 or even 0 (didn't see any difference but on the decompiled scripts, they use 1073741824 mostly) and p6 = 0
Note: I've only tested it on entity -> ped and target -> vehicle. It could work differently on other entities, didn't try it yet.
Example: TASK::TASK_GO_TO_ENTITY(pedHandle, vehicleHandle, 5000, 4.0, 100, 1073741824, 0)
Ped will run towards the vehicle for 5 seconds and stop when time is over or when he gets 4 meters(?) around the vehicle (with duration = -1, the task duration will be ignored).
```
]]
native "TASK_GO_TO_ENTITY_WHILE_AIMING_AT_COORD"
hash "0x04701832B739DCE5"
jhash (0xD896CD82)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
float "p4" [=[ {} ]=],
float "p5" [=[ {} ]=],
BOOL "p6" [=[ {} ]=],
float "p7" [=[ {} ]=],
float "p8" [=[ {} ]=],
BOOL "p9" [=[ {} ]=],
BOOL "p10" [=[ {} ]=],
Any "p11" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "TASK_GO_TO_ENTITY_WHILE_AIMING_AT_ENTITY"
hash "0x97465886D35210E9"
jhash (0x68E36B7A)
arguments {
Ped "ped" [=[ {} ]=],
Entity "entityToWalkTo" [=[ {} ]=],
Entity "entityToAimAt" [=[ {} ]=],
float "speed" [=[ {} ]=],
BOOL "shootatEntity" [=[ {} ]=],
float "p5" [=[ {} ]=],
float "p6" [=[ {} ]=],
BOOL "p7" [=[ {} ]=],
BOOL "p8" [=[ {} ]=],
Hash "firingPattern" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
shootatEntity:
If true, peds will shoot at Entity till it is dead.
If false, peds will just walk till they reach the entity and will cease shooting.
```
]]
native "TASK_GOTO_ENTITY_AIMING"
hash "0xA9DA48FAB8A76C12"
jhash (0xF1C493CF)
arguments {
Ped "ped" [=[ {} ]=],
Entity "target" [=[ {} ]=],
float "distanceToStopAt" [=[ {} ]=],
float "StartAimingDist" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
eg
TASK::TASK_GOTO_ENTITY_AIMING(v_2, PLAYER::PLAYER_PED_ID(), 5.0, 25.0);
ped = Ped you want to perform this task.
target = the Entity they should aim at.
distanceToStopAt = distance from the target, where the ped should stop to aim.
StartAimingDist = distance where the ped should start to aim.
```
]]
native "TASK_GOTO_ENTITY_OFFSET"
hash "0xE39B4FF4FDEBDE27"
jhash (0x1A17A85E)
arguments {
Ped "ped" [=[ {} ]=],
Entity "entity" [=[ {} ]=],
int "duration" [=[ {} ]=],
float "seekRadius" [=[ {} ]=],
float "seekAngleDeg" [=[ {} ]=],
float "moveBlendRatio" [=[ {} ]=],
int "gotoEntityOffsetFlags" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
Instructs the ped to go to the entity with the given offset.
```cpp
enum eSeekEntityOffsetFlags {
ESEEK_OFFSET_ORIENTATES_WITH_ENTITY = 1,
ESEEK_KEEP_TO_PAVEMENTS = 2
};
```
The ped handle
The target entity handle
The duration in seconds or -1 for forever
How many meters the destination is from the entity
The angle the destination is from the entity
The move blend ratio (speed)
The goto entity offset flags
]]
native "TASK_GOTO_ENTITY_OFFSET_XY"
hash "0x338E7EF52B6095A9"
jhash (0xBC1E3D0A)
arguments {
Ped "ped" [=[ {} ]=],
Entity "entity" [=[ {} ]=],
int "duration" [=[ {} ]=],
float "targetRadius" [=[ {} ]=],
float "offsetX" [=[ {} ]=],
float "offsetY" [=[ {} ]=],
float "moveBlendRatio" [=[ {} ]=],
int "gotoEntityOffsetFlags" [=[ {"cs_type":"BOOL"} ]=],
}
ns "TASK"
returns "void"
doc [[!
Instructs the ped to go to the entity with the given offset.
The ped handle
The target entity handle
The duration in seconds or -1 for forever
How far away the ped needs to be from the target entity before it starts moving
The X offset
The Y offset
The move blend ratio (speed)
The goto entity offset flags (see [`TASK_GOTO_ENTITY_OFFSET`](#\_0xE39B4FF4FDEBDE27))
]]
native "TASK_GUARD_ASSIGNED_DEFENSIVE_AREA"
hash "0xD2A207EEBDF9889B"
jhash (0x7AF0133D)
arguments {
Any "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
float "p4" [=[ {} ]=],
float "p5" [=[ {} ]=],
Any "p6" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "TASK_GUARD_CURRENT_POSITION"
hash "0x4A58A47A72E3FCB4"
jhash (0x2FB099E9)
arguments {
Ped "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
From re_prisonvanbreak:
TASK::TASK_GUARD_CURRENT_POSITION(l_DD, 35.0, 35.0, 1);
```
]]
native "TASK_GUARD_SPHERE_DEFENSIVE_AREA"
hash "0xC946FE14BE0EB5E2"
jhash (0x86B76CB7)
arguments {
Ped "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
float "p4" [=[ {} ]=],
float "p5" [=[ {} ]=],
Any "p6" [=[ {} ]=],
float "p7" [=[ {} ]=],
float "p8" [=[ {} ]=],
float "p9" [=[ {} ]=],
float "p10" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
p0 - Guessing PedID
p1, p2, p3 - XYZ?
p4 - ???
p5 - Maybe the size of sphere from XYZ?
p6 - ???
p7, p8, p9 - XYZ again?
p10 - Maybe the size of sphere from second XYZ?
```
]]
native "TASK_HANDS_UP"
hash "0xF2EAB31979A7F910"
jhash (0x8DCC19C5)
arguments {
Ped "ped" [=[ {} ]=],
int "duration" [=[ {} ]=],
Ped "facingPed" [=[ {} ]=],
int "p3" [=[ {} ]=],
BOOL "p4" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
In the scripts, p3 was always -1.
p3 seems to be duration or timeout of turn animation.
Also facingPed can be 0 or -1 so ped will just raise hands up.
```
]]
native "TASK_HELI_CHASE"
hash "0xAC83B1DB38D0ADA0"
jhash (0xAC290A21)
arguments {
Ped "pilot" [=[ {} ]=],
Entity "entityToFollow" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
Ped pilot should be in a heli.
EntityToFollow can be a vehicle or Ped.
x,y,z appear to be how close to the EntityToFollow the heli should be. Scripts use 0.0, 0.0, 80.0. Then the heli tries to position itself 80 units above the EntityToFollow. If you reduce it to -5.0, it tries to go below (if the EntityToFollow is a heli or plane)
NOTE: If the pilot finds enemies, it will engage them, then remain there idle, not continuing to chase the Entity given.
```
]]
native "TASK_HELI_MISSION"
hash "0xDAD029E187A2BEB4"
jhash (0x0C143E97)
arguments {
Ped "ped" [=[ {} ]=],
Vehicle "heli" [=[ {} ]=],
Vehicle "vehicleTarget" [=[ {} ]=],
Ped "pedTarget" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
int "missionType" [=[ {} ]=],
float "speed" [=[ {} ]=],
float "radius" [=[ {} ]=],
float "heading" [=[ {} ]=],
float "height" [=[ {"cs_type":"int"} ]=],
float "minHeight" [=[ {} ]=],
float "slowDist" [=[ {"cs_type":"Hash"} ]=],
int "missionFlags" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
All parameters except ped, heli and speed are optional, with `pedTarget`, `vehicleTarget`, `x`, `y`, `z` being dependent on `missionType` (ie. Attack/Flee mission types require a target ped/vehicle, whereas GoTo mission types require either `x`, `y`, `z` or a target ped/vehicle).
If you don't want to use a parameter; pass `0.0f` for `x`, `y` and `z`, `0` for `pedTarget`, `vehicleTarget`, `0` for other int parameters, and `-1.0f` for the remaining float parameters.
```cpp
enum eHeliMissionFlags
{
None = 0,
AttainRequestedOrientation = 1,
DontModifyOrientation = 2,
DontModifyPitch = 4,
DontModifyThrottle = 8,
DontModifyRoll = 16,
LandOnArrival = 32,
DontDoAvoidance = 64,
StartEngineImmediately = 128,
ForceHeightMapAvoidance = 256,
DontClampProbesToDestination = 512,
EnableTimeslicingWhenPossible = 1024,
CircleOppositeDirection = 2048,
MaintainHeightAboveTerrain = 4096,
IgnoreHiddenEntitiesDuringLand = 8192,
DisableAllHeightMapAvoidance = 16384,
// ForceHeightMapAvoidance | DontDoAvoidance
HeightMapOnlyAvoidance = 320,
}
```
The ped to be tasked.
The helicopters' entity handle.
The target vehicle (default is 0).
The target ped (default is 0).
The x coordinate of the target (default is 0.0f).
The y coordinate of the target (default is 0.0f).
The z coordinate of the target (default is 0.0f).
The mission type (default is 0) (see [TaskVehicleMission](#\_0x659427E0EF36BCDE)).
The speed in m/s.
The radius of when the task will be completed (default is -1.0f).
The heading the helicopter will face at task completion (default is -1.0f).
The height the helicopter will fly at (default is -1.0f).
The height the helicopter will not fly below (default is -1.0f).
The distance to the target at which the helicopter will slow down (default is -1.0f).
The mission flags (default is 0) (see `eHeliMissionFlags`).
]]
native "TASK_JUMP"
hash "0x0AE4086104E067B1"
jhash (0x0356E3CE)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "unused" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
Definition is wrong. This has 4 parameters (Not sure when they were added. v350 has 2, v678 has 4).
v350: Ped ped, bool unused
v678: Ped ped, bool unused, bool flag1, bool flag2
flag1 = super jump, flag2 = do nothing if flag1 is false and doubles super jump height if flag1 is true.
```
```
NativeDB Added Parameter 3: Any p2
NativeDB Added Parameter 4: Any p3
```
]]
native "TASK_LEAVE_ANY_VEHICLE"
hash "0x504D54DF3F6F2247"
jhash (0xDBDD79FA)
arguments {
Ped "ped" [=[ {} ]=],
int "p1" [=[ {} ]=],
int "flags" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
Flags are the same flags used in [`TASK_LEAVE_VEHICLE`](#\_0xD3DBCE61A490BE02)
]]
native "TASK_LEAVE_VEHICLE"
hash "0xD3DBCE61A490BE02"
jhash (0x7B1141C6)
arguments {
Ped "ped" [=[ {} ]=],
Vehicle "vehicle" [=[ {} ]=],
int "flags" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
Flags from decompiled scripts:
0 = normal exit and closes door.
1 = normal exit and closes door.
16 = teleports outside, door kept closed. (This flag does not seem to work for the front seats in buses, NPCs continue to exit normally)
64 = normal exit and closes door, maybe a bit slower animation than 0.
256 = normal exit but does not close the door.
4160 = ped is throwing himself out, even when the vehicle is still.
262144 = ped moves to passenger seat first, then exits normally
Others to be tried out: 320, 512, 131072.
```
]]
native "TASK_LOOK_AT_COORD"
hash "0x6FA46612594F7973"
jhash (0x7B784DD8)
arguments {
Entity "entity" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
int "duration" [=[ {"cs_type":"float"} ]=],
Any "p5" [=[ {} ]=],
Any "p6" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "TASK_LOOK_AT_ENTITY"
hash "0x69F4BE8C8CC4796C"
jhash (0x991D6619)
arguments {
Ped "ped" [=[ {} ]=],
Entity "lookAt" [=[ {} ]=],
int "duration" [=[ {} ]=],
int "unknown1" [=[ {} ]=],
int "unknown2" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
param3: duration in ms, use -1 to look forever
param4: using 2048 is fine
param5: using 3 is fine
```
]]
native "TASK_MOVE_NETWORK_ADVANCED_BY_NAME"
hash "0xD5B35BEA41919ACB"
jhash (0x71A5C5DB)
arguments {
Ped "ped" [=[ {} ]=],
charPtr "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
float "p4" [=[ {} ]=],
float "p5" [=[ {} ]=],
float "p6" [=[ {} ]=],
float "p7" [=[ {} ]=],
Any "p8" [=[ {} ]=],
float "p9" [=[ {} ]=],
BOOL "p10" [=[ {} ]=],
charPtr "animDict" [=[ {} ]=],
int "flags" [=[ {} ]=],
}
alias "0xD5B35BEA41919ACB"
alias "_TASK_MOVE_NETWORK_ADVANCED"
ns "TASK"
returns "void"
doc [[!
```
Example:
TASK::TASK_MOVE_NETWORK_ADVANCED_BY_NAME(PLAYER::PLAYER_PED_ID(), "minigame_tattoo_michael_parts", 324.13f, 181.29f, 102.6f, 0.0f, 0.0f, 22.32f, 2, 0, false, 0, 0);
```
]]
native "TASK_MOVE_NETWORK_BY_NAME"
hash "0x2D537BA194896636"
jhash (0x6F5D215F)
arguments {
Ped "ped" [=[ {} ]=],
charPtr "task" [=[ {} ]=],
float "multiplier" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
charPtr "animDict" [=[ {} ]=],
int "flags" [=[ {} ]=],
}
alias "0x2D537BA194896636"
alias "_TASK_MOVE_NETWORK"
ns "TASK"
returns "void"
doc [[!
```
Example:
TASK::TASK_MOVE_NETWORK_BY_NAME(PLAYER::PLAYER_PED_ID(), "arm_wrestling_sweep_paired_a_rev3", 0.0f, true, "mini@arm_wrestling", 0);
```
]]
native "TASK_OPEN_VEHICLE_DOOR"
hash "0x965791A9A488A062"
jhash (0x8EE06BF4)
arguments {
Ped "ped" [=[ {} ]=],
Vehicle "vehicle" [=[ {} ]=],
int "timeOut" [=[ {} ]=],
int "seat" [=[ {} ]=],
float "speed" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
The given ped will try to open the nearest door to 'seat'.
Example: telling the ped to open the door for the driver seat does not necessarily mean it will open the driver door, it may choose to open the passenger door instead if that one is closer.
The ped to do the task
The vehicle whose doors the ped shoud open
Sets a timeout to the task; doesn't work for 0
The seat index - the ped will attempt to open doors to get to the specified seat
]]
native "TASK_PARACHUTE"
hash "0xD2F1C53C97EE81AB"
jhash (0xEC3060A2)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
This function has a third parameter as well (bool).
Second parameter is unused.
seconds parameter was for jetpack in the early stages of gta and the hard coded code is now removed
```
```
NativeDB Added Parameter 3: BOOL p2
```
]]
native "TASK_PARACHUTE_TO_TARGET"
hash "0xB33E291AFA6BD03A"
jhash (0xE0104D6C)
arguments {
Ped "ped" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
makes ped parachute to coords x y z. Works well with PATHFIND::GET_SAFE_COORD_FOR_PED
```
]]
native "TASK_PATROL"
hash "0xBDA5DF49D080FE4E"
jhash (0xB92E5AF6)
arguments {
Ped "ped" [=[ {} ]=],
charPtr "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
BOOL "p4" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
After looking at some scripts the second parameter seems to be an id of some kind. Here are some I found from some R* scripts:
"miss_Tower_01" (this went from 01 - 10)
"miss_Ass0" (0, 4, 6, 3)
"MISS_PATROL_8"
I think they're patrol routes, but I'm not sure. And I believe the 3rd parameter is a BOOL, but I can't confirm other than only seeing 0 and 1 being passed.
As far as I can see the patrol routes names such as "miss_Ass0" have been defined earlier in the scripts. This leads me to believe we can defined our own new patrol routes by following the same approach.
From the scripts
TASK::OPEN_PATROL_ROUTE("miss_Ass0");
TASK::ADD_PATROL_ROUTE_NODE(0, "WORLD_HUMAN_GUARD_STAND", l_738[0/*3*/], -139.4076690673828, -993.4732055664062, 26.2754, MISC::GET_RANDOM_INT_IN_RANGE(5000, 10000));
TASK::ADD_PATROL_ROUTE_NODE(1, "WORLD_HUMAN_GUARD_STAND", l_738[1/*3*/], -116.1391830444336, -987.4984130859375, 26.38541030883789, MISC::GET_RANDOM_INT_IN_RANGE(5000, 10000));
TASK::ADD_PATROL_ROUTE_NODE(2, "WORLD_HUMAN_GUARD_STAND", l_738[2/*3*/], -128.46847534179688, -979.0340576171875, 26.2754, MISC::GET_RANDOM_INT_IN_RANGE(5000, 10000));
TASK::ADD_PATROL_ROUTE_LINK(0, 1);
TASK::ADD_PATROL_ROUTE_LINK(1, 2);
TASK::ADD_PATROL_ROUTE_LINK(2, 0);
TASK::CLOSE_PATROL_ROUTE();
TASK::CREATE_PATROL_ROUTE();
```
]]
native "TASK_PAUSE"
hash "0xE73A266DB0CA9042"
jhash (0x17A64668)
arguments {
Ped "ped" [=[ {} ]=],
int "ms" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
This tasks the ped to do nothing for the specified amount of miliseconds.
This is useful if you want to add a delay between tasks when using a sequence task.
The ped to pause. Set to this 0 when using task sequences.
The amount of miliseconds to wait.
]]
native "TASK_PED_SLIDE_TO_COORD"
hash "0xD04FE6765D990A06"
jhash (0x225380EF)
arguments {
Ped "ped" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "heading" [=[ {} ]=],
float "duration" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "TASK_PED_SLIDE_TO_COORD_HDG_RATE"
hash "0x5A4A6A6D3DC64F52"
jhash (0x38A995C1)
arguments {
Ped "ped" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "heading" [=[ {} ]=],
float "p5" [=[ {} ]=],
float "p6" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "TASK_PERFORM_SEQUENCE"
hash "0x5ABA3986D90D8A3B"
jhash (0x4D9FBD11)
arguments {
Ped "ped" [=[ {} ]=],
int "taskSequenceId" [=[ {} ]=],
}
ns "TASK"
annotations [=[ {"cs_type":"Any"} ]=]
returns "void"
doc [[!
For an example on how to use this please refer to [OPEN_SEQUENCE_TASK](#\_0xE8854A4326B9E12B)
The ped to perform the sequence on
The sequenceId to perform
]]
native "TASK_PERFORM_SEQUENCE_FROM_PROGRESS"
hash "0x89221B16730234F0"
jhash (0xFA60601B)
arguments {
Ped "ped" [=[ {} ]=],
int "taskIndex" [=[ {} ]=],
int "progress1" [=[ {} ]=],
int "progress2" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
The ped to perform the task on
The progress to start from
Unknown what it does, it has to be set higher than 0 to not break the sequence
]]
native "TASK_PERFORM_SEQUENCE_LOCALLY"
hash "0x8C33220C8D78CA0D"
arguments {
Ped "ped" [=[ {} ]=],
int "taskSequenceId" [=[ {} ]=],
}
alias "0x8C33220C8D78CA0D"
alias "_TASK_PERFORM_SEQUENCE_LOCALLY"
ns "TASK"
returns "void"
doc [[!
For an example on how to use this please refer to \[OPEN_SEQUENCE_TASK]\(#\_0xE8854A4326B9E12B
The ped to perform the sequence on
The sequence to perform
]]
native "TASK_PLANE_CHASE"
hash "0x2D2386F273FF7A25"
jhash (0x12FA1C28)
arguments {
Ped "pilot" [=[ {} ]=],
Entity "entityToFollow" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "TASK_PLANE_LAND"
hash "0xBF19721FA34D32C0"
jhash (0x5F7E23EA)
arguments {
Ped "pilot" [=[ {} ]=],
Vehicle "plane" [=[ {} ]=],
float "runwayStartX" [=[ {} ]=],
float "runwayStartY" [=[ {} ]=],
float "runwayStartZ" [=[ {} ]=],
float "runwayEndX" [=[ {} ]=],
float "runwayEndY" [=[ {} ]=],
float "runwayEndZ" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "TASK_PLANE_MISSION"
hash "0x23703CD154E83B88"
jhash (0x1D007E65)
arguments {
Ped "ped" [=[ {} ]=],
Vehicle "vehicle" [=[ {} ]=],
Vehicle "targetVehicle" [=[ {} ]=],
Ped "targetPed" [=[ {} ]=],
float "fTargetCoordX" [=[ {} ]=],
float "fTargetCoordY" [=[ {} ]=],
float "fTargetCoordZ" [=[ {} ]=],
int "iMissionIndex" [=[ {} ]=],
float "fCruiseSpeed" [=[ {} ]=],
float "fTargetReachedDist" [=[ {} ]=],
float "fOrientation" [=[ {} ]=],
int "iFlightHeight" [=[ {"cs_type":"float"} ]=],
int "iMinHeightAboveTerrain" [=[ {"cs_type":"float"} ]=],
BOOL "bPrecise" [=[ {"cs_split":true} ]=],
}
ns "TASK"
returns "void"
doc [[!
Gives the plane a mission (purpose or objective), the mission is passed onto the `iMissionIndex` parameter.
```cpp
enum eVehicleMission {
MISSION_NONE = 0,
MISSION_CRUISE, // 1
MISSION_RAM, // 2
MISSION_BLOCK, // 3
MISSION_GOTO, // 4
MISSION_STOP, // 5
MISSION_ATTACK, // 6
MISSION_FOLLOW, // 7
MISSION_FLEE, // 8
MISSION_CIRCLE, // 9
MISSION_ESCORT_LEFT, // 10
MISSION_ESCORT_RIGHT, // 11
MISSION_ESCORT_REAR, // 12
MISSION_ESCORT_FRONT, // 13
MISSION_GOTO_RACING, // 14
MISSION_FOLLOW_RECORDING, // 15
MISSION_POLICE_BEHAVIOUR, // 16
MISSION_PARK_PERPENDICULAR, // 17
MISSION_PARK_PARALLEL, // 18
MISSION_LAND, // 19
MISSION_LAND_AND_WAIT, // 20
MISSION_CRASH, // 21
MISSION_PULL_OVER, // 22
MISSION_PROTECT // 23
};
```
The `Ped` handle.
The `Vehicle` handle for the actual plane that will be flown.
The target `Vehicle` handle (in case `eVehicleMission` requires one).
The target `Ped` (in case `eVehicleMission` requires one).
The mission to be executed. See `eVehicleMission`.
The cruise speed (in m/s).
Distance (in meters) (at which the plane thinks it has arrived), this is also used as the hover distance for `MISSION_ATTACK` and `MISSION_CIRCLE`.
Used to specify the desired orientation of the plane in degrees (`0` to `360`). Use `-1` if no specific orientation is required.
The height above sea level the plane tries to maintain, i.e. `50` meters.
The minimum height above terrain, i.e. `30` meters.
A boolean value, defaults to `true`.
]]
native "TASK_PLANE_TAXI"
hash "0x92C360B5F15D2302"
arguments {
Ped "pilot" [=[ {} ]=],
Vehicle "aircraft" [=[ {} ]=],
float "xPos" [=[ {"cs_type":"Any"} ]=],
float "yPos" [=[ {"cs_type":"Any"} ]=],
float "zPos" [=[ {"cs_type":"Any"} ]=],
float "fCruiseSpeed" [=[ {"cs_type":"Any"} ]=],
float "fTargetReachedDist" [=[ {"cs_type":"Any"} ]=],
}
alias "0x92C360B5F15D2302"
alias "_TASK_PLANE_TAXI"
ns "TASK"
returns "void"
doc [[!
The given ped will try to drive the plane to the given coordinates and will then drive around the given coords (the plane will form 8s on the ground)
The ped driving the plane.
The plane used.
The X coordinate.
The Y coordinate.
The Z coordinate.
The speed of the plane (in m/s).
Distance (in meters) at which the plane thinks it has arrived to the given coordinates.
]]
native "TASK_PLANT_BOMB"
hash "0x965FEC691D55E9BF"
jhash (0x33457535)
arguments {
Ped "ped" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "heading" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "TASK_PLAY_ANIM"
hash "0xEA47FE3719165B94"
jhash (0x5AB552C6)
arguments {
Ped "ped" [=[ {} ]=],
charPtr "animDictionary" [=[ {} ]=],
charPtr "animationName" [=[ {} ]=],
float "blendInSpeed" [=[ {} ]=],
float "blendOutSpeed" [=[ {} ]=],
int "duration" [=[ {} ]=],
int "flag" [=[ {} ]=],
float "playbackRate" [=[ {} ]=],
BOOL "lockX" [=[ {} ]=],
BOOL "lockY" [=[ {} ]=],
BOOL "lockZ" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
[Animations list](https://alexguirre.github.io/animations-list/)
```cpp
enum eScriptedAnimFlags
{
AF_LOOPING = 1,
AF_HOLD_LAST_FRAME = 2,
AF_REPOSITION_WHEN_FINISHED = 4,
AF_NOT_INTERRUPTABLE = 8,
AF_UPPERBODY = 16,
AF_SECONDARY = 32,
AF_REORIENT_WHEN_FINISHED = 64,
AF_ABORT_ON_PED_MOVEMENT = 128,
AF_ADDITIVE = 256,
AF_TURN_OFF_COLLISION = 512,
AF_OVERRIDE_PHYSICS = 1024,
AF_IGNORE_GRAVITY = 2048,
AF_EXTRACT_INITIAL_OFFSET = 4096,
AF_EXIT_AFTER_INTERRUPTED = 8192,
AF_TAG_SYNC_IN = 16384,
AF_TAG_SYNC_OUT = 32768,
AF_TAG_SYNC_CONTINUOUS = 65536,
AF_FORCE_START = 131072,
AF_USE_KINEMATIC_PHYSICS = 262144,
AF_USE_MOVER_EXTRACTION = 524288,
AF_HIDE_WEAPON = 1048576,
AF_ENDS_IN_DEAD_POSE = 2097152,
AF_ACTIVATE_RAGDOLL_ON_COLLISION = 4194304,
AF_DONT_EXIT_ON_DEATH = 8388608,
AF_ABORT_ON_WEAPON_DAMAGE = 16777216,
AF_DISABLE_FORCED_PHYSICS_UPDATE = 33554432,
AF_PROCESS_ATTACHMENTS_ON_START = 67108864,
AF_EXPAND_PED_CAPSULE_FROM_SKELETON = 134217728,
AF_USE_ALTERNATIVE_FP_ANIM = 268435456,
AF_BLENDOUT_WRT_LAST_FRAME = 536870912,
AF_USE_FULL_BLENDING = 1073741824
}
```
The ped you want to play the animation
The animation dictionary
The animation name
The speed at which the animation blends in. Lower is slower and higher is faster, 1.0 is normal, 8.0 is basically instant
The speed at which the animation blends out. Lower is slower and higher is faster, 1.0 is normal, 8.0 is basically instant
The duration of the animation in milliseconds. -1 will play the animation until canceled
The animation flags (see enum)
The playback rate (between 0.0 and 1.0)
]]
native "TASK_PLAY_ANIM_ADVANCED"
hash "0x83CDB10EA29B370B"
jhash (0x3DDEB0E6)
arguments {
Ped "ped" [=[ {} ]=],
charPtr "animDictionary" [=[ {} ]=],
charPtr "animationName" [=[ {} ]=],
float "posX" [=[ {} ]=],
float "posY" [=[ {} ]=],
float "posZ" [=[ {} ]=],
float "rotX" [=[ {} ]=],
float "rotY" [=[ {} ]=],
float "rotZ" [=[ {} ]=],
float "blendInSpeed" [=[ {} ]=],
float "blendOutSpeed" [=[ {} ]=],
int "duration" [=[ {} ]=],
Any "flag" [=[ {} ]=],
float "animTime" [=[ {} ]=],
Any "p14" [=[ {} ]=],
Any "p15" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
Similar in functionality to [`TASK_PLAY_ANIM`](#\_0xEA47FE3719165B94), except the position and rotation parameters let you specify the initial position and rotation of the task. The ped is teleported to the position specified.
[Animations list](https://alexguirre.github.io/animations-list/)
The ped you want to play the animation
The animation dictionary
The animation name
Initial X position of the task
Initial Y position of the task
Initial Z position of the task
Initial X rotation of the task
Initial Y rotation of the task
Initial Z rotation of the task
The speed at which the animation blends in. Lower is slower and higher is faster, 1.0 is normal, 8.0 is basically instant
The speed at which the animation blends out. Lower is slower and higher is faster, 1.0 is normal, 8.0 is basically instant
The duration of the animation in milliseconds. -1 will play the animation until canceled
See [`TASK_PLAY_ANIM`](#\_0xEA47FE3719165B94)
Value between 0.0 and 1.0, lets you start an animation from the given point
]]
native "TASK_PLAY_PHONE_GESTURE_ANIMATION"
hash "0x8FBB6758B3B3E9EC"
jhash (0x1582162C)
arguments {
Ped "ped" [=[ {} ]=],
charPtr "animDict" [=[ {} ]=],
charPtr "animation" [=[ {} ]=],
charPtr "boneMaskType" [=[ {} ]=],
float "p4" [=[ {} ]=],
float "p5" [=[ {} ]=],
BOOL "p6" [=[ {} ]=],
BOOL "p7" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
Example from the scripts:
TASK::TASK_PLAY_PHONE_GESTURE_ANIMATION(PLAYER::PLAYER_PED_ID(), v_3, v_2, v_4, 0.25, 0.25, 0, 0);
=========================================================
^^ No offense, but Idk how that would really help anyone.
As for the animDict & animation, they're both store in a global in all 5 scripts. So if anyone would be so kind as to read that global and comment what strings they use. Thanks.
Known boneMaskTypes'
"BONEMASK_HEADONLY"
"BONEMASK_HEAD_NECK_AND_ARMS"
"BONEMASK_HEAD_NECK_AND_L_ARM"
"BONEMASK_HEAD_NECK_AND_R_ARM"
p4 known args - 0.0f, 0.5f, 0.25f
p5 known args - 0.0f, 0.25f
p6 known args - 1 if a global if check is passed.
p7 known args - 1 if a global if check is passed.
The values found above, I found within the 5 scripts this is ever called in. (fmmc_launcher, fm_deathmatch_controller, fm_impromptu_dm_controller, fm_mission_controller, and freemode).
=========================================================
```
]]
native "TASK_PUT_PED_DIRECTLY_INTO_COVER"
hash "0x4172393E6BE1FECE"
jhash (0xC9F00E68)
arguments {
Ped "ped" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
Any "timeout" [=[ {} ]=],
BOOL "p5" [=[ {} ]=],
float "p6" [=[ {} ]=],
BOOL "p7" [=[ {} ]=],
BOOL "p8" [=[ {} ]=],
Any "p9" [=[ {} ]=],
BOOL "p10" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "TASK_PUT_PED_DIRECTLY_INTO_MELEE"
hash "0x1C6CD14A876FFE39"
jhash (0x79E1D27D)
arguments {
Ped "ped" [=[ {} ]=],
Ped "meleeTarget" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
float "p4" [=[ {} ]=],
BOOL "p5" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
from armenian3.c4
TASK::TASK_PUT_PED_DIRECTLY_INTO_MELEE(PlayerPed, armenianPed, 0.0, -1.0, 0.0, 0);
```
]]
native "TASK_RAPPEL_FROM_HELI"
hash "0x09693B0312F91649"
jhash (0x2C7ADB93)
arguments {
Ped "ped" [=[ {} ]=],
float "unused" [=[ {"cs_type":"int"} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
Only appears twice in the scripts.
TASK::TASK_RAPPEL_FROM_HELI(PLAYER::PLAYER_PED_ID(), 0x41200000);
TASK::TASK_RAPPEL_FROM_HELI(a_0, 0x41200000);
```
]]
native "TASK_REACT_AND_FLEE_PED"
hash "0x72C896464915D1B1"
jhash (0x8A632BD8)
arguments {
Ped "ped" [=[ {} ]=],
Ped "fleeTarget" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "TASK_RELOAD_WEAPON"
hash "0x62D2916F56B9CD2D"
jhash (0xCA6E91FD)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "unused" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
The 2nd param (unused) is not implemented.
-----------------------------------------------------------------------
The only occurrence I found in a R* script ("assassin_construction.ysc.c4"):
if (((v_3 < v_4) && (TASK::GET_SCRIPT_TASK_STATUS(PLAYER::PLAYER_PED_ID(), 0x6a67a5cc) != 1)) && (v_5 > v_3)) {
TASK::TASK_RELOAD_WEAPON(PLAYER::PLAYER_PED_ID(), 1);
}
```
]]
native "TASK_SCRIPTED_ANIMATION"
hash "0x126EF75F1E17ABE5"
jhash (0xFC2DCF47)
arguments {
Ped "ped" [=[ {} ]=],
AnyPtr "p1" [=[ {} ]=],
AnyPtr "p2" [=[ {} ]=],
AnyPtr "p3" [=[ {} ]=],
float "p4" [=[ {} ]=],
float "p5" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
From fm_mission_controller.c:
reserve_network_mission_objects(get_num_reserved_mission_objects(0) + 1);
vVar28 = {0.094f, 0.02f, -0.005f};
vVar29 = {-92.24f, 63.64f, 150.24f};
func_253(&uVar30, joaat("prop_ld_case_01"), Global_1592429.imm_34757[iParam1 <268>], 1, 1, 0, 1);
set_entity_lod_dist(net_to_ent(uVar30), 500);
attach_entity_to_entity(net_to_ent(uVar30), iParam0, get_ped_bone_index(iParam0, 28422), vVar28, vVar29, 1, 0, 0, 0, 2, 1);
Var31.imm_4 = 1065353216;
Var31.imm_5 = 1065353216;
Var31.imm_9 = 1065353216;
Var31.imm_10 = 1065353216;
Var31.imm_14 = 1065353216;
Var31.imm_15 = 1065353216;
Var31.imm_17 = 1040187392;
Var31.imm_18 = 1040187392;
Var31.imm_19 = -1;
Var32.imm_4 = 1065353216;
Var32.imm_5 = 1065353216;
Var32.imm_9 = 1065353216;
Var32.imm_10 = 1065353216;
Var32.imm_14 = 1065353216;
Var32.imm_15 = 1065353216;
Var32.imm_17 = 1040187392;
Var32.imm_18 = 1040187392;
Var32.imm_19 = -1;
Var31 = 1;
Var31.imm_1 = "weapons@misc@jerrycan@mp_male";
Var31.imm_2 = "idle";
Var31.imm_20 = 1048633;
Var31.imm_4 = 0.5f;
Var31.imm_16 = get_hash_key("BONEMASK_ARMONLY_R");
task_scripted_animation(iParam0, &Var31, &Var32, &Var32, 0f, 0.25f);
set_model_as_no_longer_needed(joaat("prop_ld_case_01"));
remove_anim_dict("anim@heists@biolab@");
```
]]
native "TASK_SEEK_COVER_FROM_PED"
hash "0x84D32B3BEC531324"
jhash (0xC1EC907E)
arguments {
Ped "ped" [=[ {} ]=],
Ped "target" [=[ {} ]=],
int "duration" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "TASK_SEEK_COVER_FROM_POS"
hash "0x75AC2B60386D89F2"
jhash (0x83F18EE9)
arguments {
Ped "ped" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
int "duration" [=[ {} ]=],
BOOL "p5" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "TASK_SEEK_COVER_TO_COORDS"
hash "0x39246A6958EF072C"
jhash (0xFFFE754E)
arguments {
Ped "ped" [=[ {} ]=],
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
Any "p7" [=[ {} ]=],
BOOL "p8" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
from michael2:
TASK::TASK_SEEK_COVER_TO_COORDS(ped, 967.5164794921875, -2121.603515625, 30.479299545288086, 978.94677734375, -2125.84130859375, 29.4752, -1, 1);
appears to be shorter variation
from michael3:
TASK::TASK_SEEK_COVER_TO_COORDS(ped, -2231.011474609375, 263.6326599121094, 173.60195922851562, -1, 0);
```
]]
native "TASK_SEEK_COVER_TO_COVER_POINT"
hash "0xD43D95C7A869447F"
jhash (0x3D026B29)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
float "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
BOOL "p6" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "TASK_SET_BLOCKING_OF_NON_TEMPORARY_EVENTS"
hash "0x90D2156198831D69"
jhash (0x1B54FB6B)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
I cant believe I have to define this, this is one of the best natives.
It makes the ped ignore basically all shocking events around it. Occasionally the ped may comment or gesture, but other than that they just continue their daily activities. This includes shooting and wounding the ped. And - most importantly - they do not flee.
Since it is a task, every time the native is called the ped will stop for a moment.
```
]]
native "TASK_SET_DECISION_MAKER"
hash "0xEB8517DDA73720DA"
jhash (0x830AD50C)
arguments {
Ped "ped" [=[ {} ]=],
Hash "p1" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
p1 is always GET_HASH_KEY("empty") in scripts, for the rare times this is used
```
]]
native "TASK_SET_SPHERE_DEFENSIVE_AREA"
hash "0x933C06518B52A9A4"
jhash (0x9F3C5D6A)
arguments {
Any "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
float "p4" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "TASK_SHARK_CIRCLE_COORD"
hash "0x60A19CF85FF4CEFA"
arguments {
Ped "ped" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "moveBlendRatio" [=[ {} ]=],
float "radius" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
Makes a shark ped circle around specified coordinates.
```
NativeDB Introduced: v3407
```
The shark ped.
X coordinate to circle around
Y coordinate to circle around
Z coordinate to circle around
Animation blend ratio from 0.0 to 1.0
Radius of the circular path in meters
]]
native "TASK_SHOCKING_EVENT_REACT"
hash "0x452419CBD838065B"
jhash (0x9BD00ACF)
arguments {
Ped "ped" [=[ {} ]=],
int "eventHandle" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "TASK_SHOOT_AT_COORD"
hash "0x46A6CC01E0826106"
jhash (0x601C22E3)
arguments {
Ped "ped" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
int "duration" [=[ {} ]=],
Hash "firingPattern" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
Firing Pattern Hash Information: https://pastebin.com/Px036isB
```
]]
native "TASK_SHOOT_AT_ENTITY"
hash "0x08DA95E8298AE772"
jhash (0xAC0631C9)
arguments {
Entity "entity" [=[ {} ]=],
Entity "target" [=[ {} ]=],
int "duration" [=[ {} ]=],
Hash "firingPattern" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
//this part of the code is to determine at which entity the player is aiming, for example if you want to create a mod where you give orders to peds
Entity aimedentity;
Player player = PLAYER::PLAYER_ID();
PLAYER::_GET_AIMED_ENTITY(player, &aimedentity);
//bg is an array of peds
TASK::TASK_SHOOT_AT_ENTITY(bg[i], aimedentity, 5000, MISC::GET_HASH_KEY("FIRING_PATTERN_FULL_AUTO"));
in practical usage, getting the entity the player is aiming at and then task the peds to shoot at the entity, at a button press event would be better.
Firing Pattern Hash Information: https://pastebin.com/Px036isB
```
]]
native "TASK_SHUFFLE_TO_NEXT_VEHICLE_SEAT"
hash "0x7AA80209BDA643EB"
jhash (0xBEAF8F67)
arguments {
Ped "ped" [=[ {} ]=],
Vehicle "vehicle" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
Makes the specified ped shuffle to the next vehicle seat.
The ped MUST be in a vehicle and the vehicle parameter MUST be the ped's current vehicle.
```
```
NativeDB Added Parameter 3: Any p2
```
]]
native "TASK_SKY_DIVE"
hash "0x601736CFE536B0A0"
jhash (0xD3874AFA)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
NativeDB Added Parameter 2: BOOL p1
```
]]
native "TASK_SMART_FLEE_COORD"
hash "0x94587F17E9C365D5"
jhash (0xB2E686FC)
arguments {
Ped "ped" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "distance" [=[ {} ]=],
int "time" [=[ {} ]=],
BOOL "p6" [=[ {} ]=],
BOOL "p7" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
Makes the specified ped flee the specified distance from the specified position.
```
]]
native "TASK_SMART_FLEE_PED"
hash "0x22B0D0E37CCB840D"
jhash (0xE52EB560)
arguments {
Ped "ped" [=[ {} ]=],
Ped "fleeTarget" [=[ {} ]=],
float "distance" [=[ {} ]=],
Any "fleeTime" [=[ {} ]=],
BOOL "p4" [=[ {} ]=],
BOOL "p5" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
Makes a ped run away from another ped (fleeTarget).
distance = ped will flee this distance.
fleeTime = ped will flee for this amount of time, set to "-1" to flee forever
```
]]
native "TASK_STAND_GUARD"
hash "0xAE032F8BBA959E90"
jhash (0xD130F636)
arguments {
Ped "ped" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "heading" [=[ {} ]=],
charPtr "scenarioName" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
scenarioName example: "WORLD_HUMAN_GUARD_STAND"
```
]]
native "TASK_STAND_STILL"
hash "0x919BE13EED931959"
jhash (0x6F80965D)
arguments {
Ped "ped" [=[ {} ]=],
int "time" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
Makes the specified ped stand still for (time) milliseconds.
```
]]
native "TASK_START_SCENARIO_AT_POSITION"
hash "0xFA4EFC79F69D4F07"
jhash (0xAA2C4AC2)
arguments {
Ped "ped" [=[ {} ]=],
charPtr "scenarioName" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "heading" [=[ {} ]=],
int "timeToLeave" [=[ {} ]=],
BOOL "playIntro" [=[ {} ]=],
BOOL "warp" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
The ped will move or warp to the position and heading given, then start the scenario passed. See [`TASK_START_SCENARIO_IN_PLACE`](#\_0x142A02425FF02BD9) for a list of scenarios.
The ped handle.
The name of the scenario to start.
The x coordinate to start at.
The y coordinate to start at.
The z coordinate to start at. Should be the ground position plus the ped's ground to root offset.
The heading to start at.
Sets the timeout on the scenario point to the specified time in milliseconds. If less than 0, sets the `IdleForever` flag.
If the ped should play the scenarios enter animation. Sets the `SkipEnterClip` flag.
If the ped should be warped to the position. Sets the `Warp` flag.
]]
native "TASK_START_SCENARIO_IN_PLACE"
hash "0x142A02425FF02BD9"
jhash (0xE50D6DDE)
arguments {
Ped "ped" [=[ {} ]=],
charPtr "scenarioName" [=[ {} ]=],
int "timeToLeave" [=[ {} ]=],
BOOL "playIntroClip" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
Puts the ped into the given scenario immediately at their current location. [List of scenario names](https://pastebin.com/6mrYTdQv) or in `update/update.rpf/common/data/ai/scenarios.meta`.
The ped handle.
The name of the scenario to start.
Sets the timeout on the scenario point to the specified time in milliseconds. If less than 0, sets the `IdleForever` flag.
If the ped should play the scenarios enter animation. Sets the `SkipEnterClip` flag.
]]
native "TASK_STAY_IN_COVER"
hash "0xE5DA8615A6180789"
jhash (0xA27A9413)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
Makes the ped run to take cover
```
]]
native "TASK_STEALTH_KILL"
hash "0xAA5DC05579D60BD9"
jhash (0x0D64C2FA)
arguments {
Ped "killer" [=[ {} ]=],
Ped "target" [=[ {} ]=],
Hash "actionType" [=[ {} ]=],
float "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
Stealth kill action name hashes:
stealth kills can be found here: Grand Theft Auto V\common.rpf\data\action\stealth_kills.meta
...
{
"ACT_stealth_kill_a",
"ACT_stealth_kill_weapon",
"ACT_stealth_kill_b",
"ACT_stealth_kill_c",
"ACT_stealth_kill_d",
"ACT_stealth_kill_a_gardener"
}
Only known script using this native: fbi4_prep2
EXAMPLE:
ai::task_stealth_kill(iParam1, Local_252, gameplay::get_hash_key("AR_stealth_kill_a"), 1f, 0);ai::task_stealth_kill(iParam1, Local_252, gameplay::get_hash_key("AR_stealth_kill_knife"), 1f, 0);
Also it may be important to note, that each time this task is called, it's followed by AI::CLEAR_PED_TASKS on the target
```
]]
native "TASK_STOP_PHONE_GESTURE_ANIMATION"
hash "0x3FA00D4F4641BFAE"
jhash (0x5A32D4B4)
arguments {
Ped "ped" [=[ {} ]=],
}
alias "_TASK_STOP_PHONE_GESTURE_ANIMATION"
ns "TASK"
returns "void"
doc [[!
```
NativeDB Added Parameter 2: Any p1
```
]]
native "TASK_SWAP_WEAPON"
hash "0xA21C51255B205245"
jhash (0xDAF4F8FC)
arguments {
Ped "ped" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "TASK_SWEEP_AIM_ENTITY"
hash "0x2047C02158D6405A"
jhash (0x4D210467)
arguments {
Ped "ped" [=[ {} ]=],
charPtr "anim" [=[ {} ]=],
charPtr "p2" [=[ {} ]=],
charPtr "p3" [=[ {} ]=],
charPtr "p4" [=[ {} ]=],
int "p5" [=[ {} ]=],
Vehicle "vehicle" [=[ {} ]=],
float "p7" [=[ {} ]=],
float "p8" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
This function is called on peds in vehicles.
anim: animation name
p2, p3, p4: "sweep_low", "sweep_med" or "sweep_high"
p5: no idea what it does but is usually -1
```
]]
native "TASK_SWEEP_AIM_POSITION"
hash "0x7AFE8FDC10BC07D2"
jhash (0x1683FE66)
arguments {
Any "p0" [=[ {} ]=],
AnyPtr "p1" [=[ {} ]=],
AnyPtr "p2" [=[ {} ]=],
AnyPtr "p3" [=[ {} ]=],
AnyPtr "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
float "p6" [=[ {} ]=],
float "p7" [=[ {} ]=],
float "p8" [=[ {} ]=],
float "p9" [=[ {} ]=],
float "p10" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "TASK_SYNCHRONIZED_SCENE"
hash "0xEEA929141F699854"
jhash (0x4F217E7B)
arguments {
Ped "ped" [=[ {} ]=],
int "scene" [=[ {} ]=],
charPtr "animDictionary" [=[ {} ]=],
charPtr "animationName" [=[ {} ]=],
float "speed" [=[ {} ]=],
float "speedMultiplier" [=[ {} ]=],
int "duration" [=[ {} ]=],
int "flag" [=[ {} ]=],
float "playbackRate" [=[ {} ]=],
Any "p9" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
TASK::TASK_SYNCHRONIZED_SCENE(ped, scene, "creatures@rottweiler@in_vehicle@std_car", "get_in", 1000.0, -8.0, 4, 0, 0x447a0000, 0);
```
]]
native "TASK_THROW_PROJECTILE"
hash "0x7285951DBF6B5A51"
jhash (0xF65C20A7)
arguments {
Ped "ped" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
In every case of this native, I've only seen the first parameter passed as 0, although I believe it's a Ped after seeing tasks around it using 0. That's because it's used in a Sequence Task.
The last 3 parameters are definitely coordinates after seeing them passed in other scripts, and even being used straight from the player's coordinates.
---
It seems that - in the decompiled scripts - this native was used on a ped who was in a vehicle to throw a projectile out the window at the player. This is something any ped will naturally do if they have a throwable and they are doing driveby-combat (although not very accurately).
It is possible, however, that this is how SWAT throws smoke grenades at the player when in cover.
----------------------------------------------------
The first comment is right it definately is the ped as if you look in script finale_heist2b.c line 59628 in Xbox Scripts atleast you will see task_throw_projectile and the first param is Local_559[2 <14>] if you look above it a little bit line 59622 give_weapon_to_ped uses the same exact param Local_559[2 <14>] and we all know the first param of that native is ped. So it guaranteed has to be ped. 0 just may mean to use your ped by default for some reason.
```
```
NativeDB Added Parameter 5: Any p4
NativeDB Added Parameter 6: Any p5
```
]]
native "TASK_TOGGLE_DUCK"
hash "0xAC96609B9995EDF8"
jhash (0x61CFBCBF)
arguments {
BOOL "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
used in sequence task
both parameters seems to be always 0
```
]]
native "TASK_TURN_PED_TO_FACE_COORD"
hash "0x1DDA930A0AC38571"
jhash (0x30463D73)
arguments {
Ped "ped" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
int "duration" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
duration in milliseconds
```
]]
native "TASK_TURN_PED_TO_FACE_ENTITY"
hash "0x5AD23D40115353AC"
jhash (0x3C37C767)
arguments {
Ped "ped" [=[ {} ]=],
Entity "entity" [=[ {} ]=],
int "duration" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
duration: the amount of time in milliseconds to do the task. -1 will keep the task going until either another task is applied, or CLEAR_ALL_TASKS() is called with the ped
```
]]
native "TASK_USE_MOBILE_PHONE"
hash "0xBD2A8EC3AF4DE7DB"
jhash (0x225A38C8)
arguments {
Ped "ped" [=[ {} ]=],
int "p1" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
Actually has 3 params, not 2.
p0: Ped
p1: int (or bool?)
p2: int
```
```
NativeDB Added Parameter 3: Any p2
```
]]
native "TASK_USE_MOBILE_PHONE_TIMED"
hash "0x5EE02954A14C69DB"
jhash (0xC99C19F5)
arguments {
Ped "ped" [=[ {} ]=],
int "duration" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "TASK_USE_NEAREST_SCENARIO_CHAIN_TO_COORD"
hash "0x9FDA1B3D7E7028B3"
jhash (0xE32FFB22)
arguments {
Any "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
float "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "TASK_USE_NEAREST_SCENARIO_CHAIN_TO_COORD_WARP"
hash "0x97A28E63F0BA5631"
jhash (0xBAB4C0AE)
arguments {
Any "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
float "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "TASK_USE_NEAREST_SCENARIO_TO_COORD"
hash "0x277F471BA9DB000B"
jhash (0x9C50FBF0)
arguments {
Ped "ped" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "distance" [=[ {} ]=],
int "duration" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
Updated variables
An alternative to TASK::TASK_USE_NEAREST_SCENARIO_TO_COORD_WARP. Makes the ped walk to the scenario instead.
```
]]
native "TASK_USE_NEAREST_SCENARIO_TO_COORD_WARP"
hash "0x58E2E0F23F6B76C3"
jhash (0x1BE9D65C)
arguments {
Ped "ped" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "radius" [=[ {} ]=],
Any "p5" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "TASK_VEHICLE_AIM_AT_COORD"
hash "0x447C1E9EF844BC0F"
jhash (0x010F47CE)
arguments {
Ped "ped" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "TASK_VEHICLE_AIM_AT_PED"
hash "0xE41885592B08B097"
jhash (0x920AE6DB)
arguments {
Ped "ped" [=[ {} ]=],
Ped "target" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "TASK_VEHICLE_CHASE"
hash "0x3C08A8E30363B353"
jhash (0x55634798)
arguments {
Ped "driver" [=[ {} ]=],
Entity "targetEnt" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
chases targetEnt fast and aggressively
--
Makes ped (needs to be in vehicle) chase targetEnt.
```
]]
native "TASK_VEHICLE_DRIVE_TO_COORD"
hash "0xE2A2AA2F659D77A7"
jhash (0xE4AC0387)
arguments {
Ped "ped" [=[ {} ]=],
Vehicle "vehicle" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "speed" [=[ {} ]=],
Any "p6" [=[ {} ]=],
Hash "vehicleModel" [=[ {} ]=],
int "drivingMode" [=[ {} ]=],
float "stopRange" [=[ {} ]=],
float "p10" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
info about driving modes: HTTP://gtaforums.com/topic/822314-guide-driving-styles/
---------------------------------------------------------------
Passing P6 value as floating value didn't throw any errors, though unsure what is it exactly, looks like radius or something.
P10 though, it is mentioned as float, however, I used bool and set it to true, that too worked.
Here the e.g. code I used
Function.Call(Hash.TASK_VEHICLE_DRIVE_TO_COORD, Ped, Vehicle, Cor X, Cor Y, Cor Z, 30f, 1f, Vehicle.GetHashCode(), 16777216, 1f, true);
```
]]
native "TASK_VEHICLE_DRIVE_TO_COORD_LONGRANGE"
hash "0x158BB33F920D360C"
jhash (0x1490182A)
arguments {
Ped "ped" [=[ {} ]=],
Vehicle "vehicle" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "speed" [=[ {} ]=],
int "drivingStyle" [=[ {} ]=],
float "stopRange" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
You can let your character drive to the destination at the speed and driving style you set. You can use map marks to set the destination.
```cpp
enum eDriveBehaviorFlags {
DF_StopForCars = 1,
DF_StopForPeds = 2,
DF_SwerveAroundAllCars = 4,
DF_SteerAroundStationaryCars = 8,
DF_SteerAroundPeds = 16,
DF_SteerAroundObjects = 32,
DF_DontSteerAroundPlayerPed = 64,
DF_StopAtLights = 128,
DF_GoOffRoadWhenAvoiding = 256,
DF_DriveIntoOncomingTraffic = 512,
DF_DriveInReverse = 1024,
DF_UseWanderFallbackInsteadOfStraightLine = 2048,
DF_AvoidRestrictedAreas = 4096,
DF_PreventBackgroundPathfinding = 8192, // **These only work on MISSION_CRUISE**
DF_AdjustCruiseSpeedBasedOnRoadSpeed = 16384,
DF_UseShortCutLinks = 262144,
DF_ChangeLanesAroundObstructions = 524288,
DF_UseSwitchedOffNodes = 2097152, //cruise tasks ignore this anyway--only used for goto's
DF_PreferNavmeshRoute = 4194304, //if you're going to be primarily driving off road
DF_PlaneTaxiMode = 8388608, // Only works for planes using MISSION_GOTO, will cause them to drive along the ground instead of fly
DF_ForceStraightLine = 16777216,
DF_UseStringPullingAtJunctions = 33554432,
DF_AvoidHighways = 536870912,
DF_ForceJoinInRoadDirection = 1073741824
}
```
Ped id for the task.
Vehicle entity id for the task.
Destination X coordinate.
Destination Y coordinate.
Destination Z coordinate.
Speed of driving.
The driving style (default is 0) (see [SetDriveTaskDrivingStyle](#\_0xDACE1BE37D88AF67)).
Stops in the specific range near the destination. 20.0 works fine.
]]
native "TASK_VEHICLE_DRIVE_WANDER"
hash "0x480142959D337D00"
jhash (0x36EC0EB0)
arguments {
Ped "ped" [=[ {} ]=],
Vehicle "vehicle" [=[ {} ]=],
float "speed" [=[ {} ]=],
int "drivingStyle" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
Drive randomly with no destination set.
Ped id for the task.
Vehicle entity id for the task.
Speed of driving.
The driving style (default is 0) (see [SetDriveTaskDrivingStyle](#\_0xDACE1BE37D88AF67)).
]]
native "TASK_VEHICLE_ESCORT"
hash "0x0FA6E4B75F302400"
jhash (0x9FDCB250)
arguments {
Ped "ped" [=[ {} ]=],
Vehicle "vehicle" [=[ {} ]=],
Vehicle "targetVehicle" [=[ {} ]=],
int "mode" [=[ {} ]=],
float "speed" [=[ {} ]=],
int "drivingStyle" [=[ {} ]=],
float "minDistance" [=[ {} ]=],
int "p7" [=[ {} ]=],
float "noRoadsDistance" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
Makes a ped follow the targetVehicle with in between.
note: minDistance is ignored if drivingstyle is avoiding traffic, but Rushed is fine.
Mode: The mode defines the relative position to the targetVehicle. The ped will try to position its vehicle there.
-1 = behind
0 = ahead
1 = left
2 = right
3 = back left
4 = back right
if the target is closer than noRoadsDistance, the driver will ignore pathing/roads and follow you directly.
Driving Styles guide: gtaforums.com/topic/822314-guide-driving-styles/
```
The driving style (default is 0) (see [SetDriveTaskDrivingStyle](#\_0xDACE1BE37D88AF67)).
]]
native "TASK_VEHICLE_FOLLOW"
hash "0xFC545A9F0626E3B6"
jhash (0xA8B917D7)
arguments {
Ped "driver" [=[ {} ]=],
Vehicle "vehicle" [=[ {} ]=],
Entity "targetEntity" [=[ {} ]=],
float "speed" [=[ {} ]=],
int "drivingStyle" [=[ {} ]=],
int "minDistance" [=[ {} ]=],
}
alias "_TASK_VEHICLE_FOLLOW"
ns "TASK"
returns "void"
doc [[!
```
Makes a ped in a vehicle follow an entity (ped, vehicle, etc.)
drivingStyle: http://gtaforums.com/topic/822314-guide-driving-styles/
```
The driving style (default is 0) (see [SetDriveTaskDrivingStyle](#\_0xDACE1BE37D88AF67)).
]]
native "TASK_VEHICLE_FOLLOW_WAYPOINT_RECORDING"
hash "0x3123FAA6DB1CF7ED"
jhash (0x959818B6)
arguments {
Ped "ped" [=[ {} ]=],
Vehicle "vehicle" [=[ {} ]=],
charPtr "WPRecording" [=[ {} ]=],
int "p3" [=[ {} ]=],
int "p4" [=[ {} ]=],
int "p5" [=[ {} ]=],
int "p6" [=[ {} ]=],
float "p7" [=[ {} ]=],
BOOL "p8" [=[ {} ]=],
float "p9" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
task_vehicle_follow_waypoint_recording(Ped p0, Vehicle p1, string p2, int p3, int p4, int p5, int p6, float.x p7, float.Y p8, float.Z p9, bool p10, int p11)
p2 = Waypoint recording string (found in update\update.rpf\x64\levels\gta5\waypointrec.rpf
p3 = 786468
p4 = 0
p5 = 16
p6 = -1 (angle?)
p7/8/9 = usually v3.zero
p10 = bool (repeat?)
p11 = 1073741824
-khorio
```
]]
native "TASK_VEHICLE_GOTO_NAVMESH"
hash "0x195AEEB13CEFE2EE"
jhash (0x55CF3BCD)
arguments {
Ped "ped" [=[ {} ]=],
Vehicle "vehicle" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "speed" [=[ {} ]=],
int "behaviorFlag" [=[ {} ]=],
float "stoppingRange" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
Differs from TASK_VEHICLE_DRIVE_TO_COORDS in that it will pick the shortest possible road route without taking one-way streets and other "road laws" into consideration.
WARNING:
A behaviorFlag value of 0 will result in a clunky, stupid driver!
Recommended settings:
speed = 30.0f,
behaviorFlag = 156,
stoppingRange = 5.0f;
If you simply want to have your driver move to a fixed location, call it only once, or, when necessary in the event of interruption.
If using this to continually follow a Ped who is on foot: You will need to run this in a tick loop. Call it in with the Ped's updated coordinates every 20 ticks or so and you will have one hell of a smart, fast-reacting NPC driver -- provided he doesn't get stuck. If your update frequency is too fast, the Ped may not have enough time to figure his way out of being stuck, and thus, remain stuck. One way around this would be to implement an "anti-stuck" mechanism, which allows the driver to realize he's stuck, temporarily pause the tick, unstuck, then resume the tick.
EDIT: This is being discussed in more detail at http://gtaforums.com/topic/818504-any-idea-on-how-to-make-peds-clever-and-insanely-fast-c/
```
]]
native "TASK_VEHICLE_HELI_PROTECT"
hash "0x1E09C32048FEFD1C"
jhash (0x0CB415EE)
arguments {
Ped "pilot" [=[ {} ]=],
Vehicle "vehicle" [=[ {} ]=],
Entity "entityToFollow" [=[ {} ]=],
float "targetSpeed" [=[ {} ]=],
int "p4" [=[ {} ]=],
float "radius" [=[ {} ]=],
int "altitude" [=[ {} ]=],
int "p7" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
pilot, vehicle and altitude are rather self-explanatory.
p4: is unused variable in the function.
entityToFollow: you can provide a Vehicle entity or a Ped entity, the heli will protect them.
'targetSpeed': The pilot will dip the nose AS MUCH AS POSSIBLE so as to reach this value AS FAST AS POSSIBLE. As such, you'll want to modulate it as opposed to calling it via a hard-wired, constant #.
'radius' isn't just "stop within radius of X of target" like with ground vehicles. In this case, the pilot will fly an entire circle around 'radius' and continue to do so.
NOT CONFIRMED: p7 appears to be a FlyingStyle enum. Still investigating it as of this writing, but playing around with values here appears to result in different -behavior- as opposed to offsetting coordinates, altitude, target speed, etc.
NOTE: If the pilot finds enemies, it will engage them until it kills them, but will return to protect the ped/vehicle given shortly thereafter.
```
]]
native "TASK_VEHICLE_MISSION"
hash "0x659427E0EF36BCDE"
jhash (0x20609E56)
arguments {
Ped "ped" [=[ {} ]=],
Vehicle "vehicle" [=[ {} ]=],
Vehicle "vehicleTarget" [=[ {} ]=],
int "missionType" [=[ {} ]=],
float "speed" [=[ {} ]=],
int "drivingStyle" [=[ {} ]=],
float "radius" [=[ {} ]=],
float "straightLineDist" [=[ {} ]=],
BOOL "DriveAgainstTraffic" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
All parameters except ped, vehicle, vehicleTarget and speed are optional; with `missionType` being only those that require a target entity.
If you don't want to use a parameter; pass `0` for int parameters, and `-1.0f` for the remaining float parameters.
```cpp
enum eVehicleMissionType
{
None = 0,
Cruise = 1,
Ram = 2,
Block = 3,
GoTo = 4,
Stop = 5,
Attack = 6,
Follow = 7,
Flee = 8,
Circle = 9,
Escort = 12,
GoToRacing = 14,
FollowRecording = 15,
PoliceBehaviour = 16,
Land = 19,
LandAndWait = 20,
Crash = 21,
PullOver = 22,
HeliProtect = 23
}
```
The ped to be tasked.
The vehicles' entity handle.
The target vehicle.
The mission type (default is 0) (see `eVehicleMissionType`).
The speed in m/s.
The driving style (default is 0) (see [SetDriveTaskDrivingStyle](#\_0xDACE1BE37D88AF67)).
The radius of when the task will be completed (default is -1.0f).
The distance before the vehicle will drive straight to the target (default is -1.0f).
Whether the vehicle should drive against traffic (default is false).
]]
native "TASK_VEHICLE_MISSION_COORS_TARGET"
hash "0xF0AF20AA7731F8C3"
jhash (0x6719C109)
arguments {
Ped "ped" [=[ {} ]=],
Vehicle "vehicle" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
int "missionType" [=[ {} ]=],
float "speed" [=[ {} ]=],
int "drivingStyle" [=[ {} ]=],
float "radius" [=[ {} ]=],
float "straightLineDist" [=[ {} ]=],
BOOL "DriveAgainstTraffic" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
All parameters except ped, vehicle, x, y, z and speed are optional; with `missionType` being only those that don't require a target entity.
If you don't want to use a parameter; pass `0` for int parameters, and `-1.0f` for the remaining float parameters.
The ped to be tasked.
The vehicles' entity handle.
The x coordinate.
The y coordinate.
The z coordinate.
The mission type (default is 0) (see [TaskVehicleMission](#\_0x659427E0EF36BCDE)).
The speed in m/s.
The driving style (default is 0) (see [SetDriveTaskDrivingStyle](#\_0xDACE1BE37D88AF67)).
The radius of when the task will be completed (default is -1.0f).
The distance before the vehicle will drive straight to the target (default is -1.0f).
Whether the vehicle should drive against traffic (default is false).
]]
native "TASK_VEHICLE_MISSION_PED_TARGET"
hash "0x9454528DF15D657A"
jhash (0xC81C4677)
arguments {
Ped "ped" [=[ {} ]=],
Vehicle "vehicle" [=[ {} ]=],
Ped "pedTarget" [=[ {} ]=],
int "missionType" [=[ {} ]=],
float "speed" [=[ {} ]=],
int "drivingStyle" [=[ {} ]=],
float "radius" [=[ {} ]=],
float "straightLineDist" [=[ {} ]=],
BOOL "DriveAgainstTraffic" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
All parameters except ped, vehicle, pedTarget and speed are optional; with `missionType` being only those that require a target entity.
If you don't want to use a parameter; pass `0` for int parameters, and `-1.0f` for the remaining float parameters.
The ped to be tasked.
The vehicles' entity handle.
The target ped.
The mission type (default is 0) (see [TaskVehicleMission](#\_0x659427E0EF36BCDE)).
The speed in m/s.
The driving style (default is 0) (see [SetDriveTaskDrivingStyle](#\_0xDACE1BE37D88AF67)).
The radius of when the task will be completed (default is -1.0f).
The distance before the vehicle will drive straight to the target (default is -1.0f).
Whether the vehicle should drive against traffic (default is false).
]]
native "TASK_VEHICLE_PARK"
hash "0x0F3E34E968EA374E"
jhash (0x5C85FF90)
arguments {
Ped "ped" [=[ {} ]=],
Vehicle "vehicle" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "heading" [=[ {} ]=],
int "mode" [=[ {} ]=],
float "radius" [=[ {} ]=],
BOOL "keepEngineOn" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
Modes:
0 - ignore heading
1 - park forward
2 - park backwards
Depending on the angle of approach, the vehicle can park at the specified heading or at its exact opposite (-180) angle.
Radius seems to define how close the vehicle has to be -after parking- to the position for this task considered completed. If the value is too small, the vehicle will try to park again until it's exactly where it should be. 20.0 Works well but lower values don't, like the radius is measured in centimeters or something.
```
]]
native "TASK_VEHICLE_PLAY_ANIM"
hash "0x69F5C3BD0F3EBD89"
jhash (0x2B28F598)
arguments {
Vehicle "vehicle" [=[ {} ]=],
charPtr "animationSet" [=[ {} ]=],
charPtr "animationName" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
Most probably plays a specific animation on vehicle. For example getting chop out of van etc...
Here's how its used -
TASK::TASK_VEHICLE_PLAY_ANIM(l_325, "rcmnigel1b", "idle_speedo");
TASK::TASK_VEHICLE_PLAY_ANIM(l_556[0/*1*/], "missfra0_chop_drhome", "InCar_GetOutofBack_Speedo");
FYI : Speedo is the name of van in which chop was put in the mission.
```
]]
native "TASK_VEHICLE_SHOOT_AT_COORD"
hash "0x5190796ED39C9B6D"
jhash (0xA7AAA4D6)
arguments {
Ped "ped" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "p4" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "TASK_VEHICLE_SHOOT_AT_PED"
hash "0x10AB107B887214D8"
jhash (0x59677BA0)
arguments {
Ped "ped" [=[ {} ]=],
Ped "target" [=[ {} ]=],
float "p2" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "TASK_VEHICLE_TEMP_ACTION"
hash "0xC429DCEEB339E129"
jhash (0x0679DFB8)
arguments {
Ped "driver" [=[ {} ]=],
Vehicle "vehicle" [=[ {} ]=],
int "action" [=[ {} ]=],
int "time" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
Gives the vehicle a temporary action.
**Note**: For migrating objects, a `CScriptEntityStateChangeEvent` will be sent over the network to let other clients know that this object is being given a temporary action. At the same time, temporary actions cannot be applied to clones/remote objects.
```cpp
enum eTempAction {
TA_NONE = 0,
TA_WAIT = 1,
TA_UNUSED = 2,
TA_BRAKE_REVERSE = 3,
TA_HANDBRAKE_TURN_LEFT = 4,
TA_HANDBRAKE_TURN_RIGHT = 5,
TA_HANDBRAKE_UNTIL_TIME_ENDS = 6,
TA_TURN_LEFT = 7,
TA_TURN_RIGHT = 8,
TA_ACCELERATE = 9,
TA_TURN_LEFT = 10,
TA_TURN_RIGHT = 11,
TA_UNUSED_12 = 12,
TA_TURN_LEFT_GO_REVERSE = 13,
TA_TURN_RIGHT_GO_REVERSE = 14,
TA_PLANE_FLY_UP = 15, // (crashes game if not in plane)
TA_PLANE_FLY_STRAIGHT = 16, // (crashes game if not in plane)
TA_PLANE_SHARP_LEFT = 17, // (crashes game if not in plane)
TA_PLANE_SHARP_RIGHT = 18, // (crashes game if not in plane)
TA_STRONG_BRAKE = 19,
TA_TURN_LEFT_AND_STOP = 20,
TA_TURN_RIGHT_AND_STOP = 21,
TA_GO_IN_REVERSE = 22,
TA_ACCELERATE_FAST = 23,
TA_BRAKE_ACTION = 24,
TA_HANDBRAKE_TURN_LEFT_MORE = 25,
TA_HANDBRAKE_TURN_RIGHT_MORE = 26,
TA_HANDBRAKE_BRAKE_STRAIGHT = 27,
TA_BRAKE_STRONG_REVERSE_ACCELERATION = 28,
TA_UNUSED_29 = 29,
TA_PERFORMS_BURNOUT = 30,
TA_REV_ENGINE = 31,
TA_ACCELERATE_VERY_STRONG = 32,
TA_SURFACE_IN_SUBMARINE = 33
};
```
The vehicle driver (`Ped`).
The vehicle handle.
The temporary action, see `eTempAction`.
The time to run this temp action for, use `-1` for infinite. Time is in milliseconds.
]]
native "TASK_WANDER_IN_AREA"
hash "0xE054346CA3A0F315"
jhash (0xC6981FB9)
arguments {
Ped "ped" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "radius" [=[ {} ]=],
int "minimalLength" [=[ {"cs_type":"float"} ]=],
float "timeBetweenWalks" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
Makes a ped wander/patrol around the specified area.
The ped will continue to wander after getting distracted, but only if this additional task is temporary, ie. killing a target, after killing the target it will continue to wander around.
Use `GetIsTaskActive(ped, 222)` to check if the ped is still wandering the area.
The ped which will wander the area.
The X coordinate.
The Y coordinate
The Z coordinate
The radius of the area to wander around in
The minimal length it will wander before waiting timeBetweenWalks seconds before continuing
The length of time the ped will stand still/rest between walks
]]
native "TASK_WANDER_STANDARD"
hash "0xBB9CE077274F6A1B"
jhash (0xAF59151A)
arguments {
Ped "ped" [=[ {} ]=],
float "p1" [=[ {} ]=],
int "p2" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
Makes ped walk around the area.
set p1 to 10.0f and p2 to 10 if you want the ped to walk anywhere without a duration.
```
]]
native "TASK_WARP_PED_DIRECTLY_INTO_COVER"
hash "0x6E01E9E8D89F8276"
arguments {
Ped "ped" [=[ {} ]=],
int "time" [=[ {} ]=],
BOOL "canPeekAndAim" [=[ {} ]=],
BOOL "forceInitialFacingDirection" [=[ {} ]=],
BOOL "forceFaceLeft" [=[ {} ]=],
int "coverIndex" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
This task warps a ped directly into a cover position closest to the specified point. This can be used to quickly place peds in strategic positions during gameplay.
```
NativeDB Introduced: 2545
```
The ped to warp into cover.
Duration in milliseconds the ped should take to enter the cover.
If `true`, allows the ped to peek and aim while in cover.
If `true`, forces the ped to face the initial direction when entering cover.
If `true`, forces the ped to face left relative to the cover position.
The index of the cover point to warp the ped to. If `null`, the game will choose the nearest cover point.
]]
native "TASK_WARP_PED_INTO_VEHICLE"
hash "0x9A7D091411C5F684"
jhash (0x65D4A35D)
arguments {
Ped "ped" [=[ {} ]=],
Vehicle "vehicle" [=[ {} ]=],
int "seatIndex" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
NativeDB Introduced: v323
```
Warp a ped into a vehicle.
**Note**: It's better to use [`TASK_ENTER_VEHICLE`](#\_0xC20E50AA46D09CA8) with the flag "warp" flag instead of this native.
The Ped to be warped into the vehicle.
The target vehicle into which the ped will be warped.
See eSeatPosition declared in [`IS_VEHICLE_SEAT_FREE`](#\_0x22AC59A870E6A669).
]]
native "TASK_WRITHE"
hash "0xCDDC2B77CE54AC6E"
jhash (0x0FDC54FC)
arguments {
Ped "ped" [=[ {} ]=],
Ped "target" [=[ {} ]=],
int "time" [=[ {} ]=],
int "p3" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
NativeDB Added Parameter 5: Any p4
NativeDB Added Parameter 6: Any p5
```
]]
native "UNCUFF_PED"
hash "0x67406F2C8F87FC4F"
jhash (0xA23A1D61)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "UPDATE_TASK_AIM_GUN_SCRIPTED_TARGET"
hash "0x9724FB59A3E72AD0"
jhash (0x67E73525)
arguments {
Ped "p0" [=[ {} ]=],
Ped "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
float "p4" [=[ {} ]=],
BOOL "p5" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "UPDATE_TASK_HANDS_UP_DURATION"
hash "0xA98FCAFD7893C834"
jhash (0x3AA39BE9)
arguments {
Ped "ped" [=[ {} ]=],
int "duration" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "UPDATE_TASK_SWEEP_AIM_ENTITY"
hash "0xE4973DBDBE6E44B3"
jhash (0xF65F0F4F)
arguments {
Ped "ped" [=[ {} ]=],
Entity "entity" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "UPDATE_TASK_SWEEP_AIM_POSITION"
hash "0xBB106883F5201FC4"
jhash (0x6345EC80)
arguments {
Any "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "USE_WAYPOINT_RECORDING_AS_ASSISTED_MOVEMENT_ROUTE"
hash "0x5A353B8E6B1095B5"
jhash (0x4DFD5FEC)
arguments {
charPtr "name" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
Waypoint recording name.
]]
native "VEHICLE_WAYPOINT_PLAYBACK_OVERRIDE_SPEED"
hash "0x121F0593E0A431D7"
jhash (0xBE1E7BB4)
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "speed" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "VEHICLE_WAYPOINT_PLAYBACK_PAUSE"
hash "0x8A4E6AC373666BC5"
jhash (0x7C00B415)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "VEHICLE_WAYPOINT_PLAYBACK_RESUME"
hash "0xDC04FCAA7839D492"
jhash (0xBEB14C82)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "VEHICLE_WAYPOINT_PLAYBACK_USE_DEFAULT_SPEED"
hash "0x5CEB25A7D2848963"
jhash (0x923C3AA4)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "WAYPOINT_PLAYBACK_GET_IS_PAUSED"
hash "0x701375A7D43F01CB"
jhash (0xA6BB5717)
arguments {
Any "p0" [=[ {} ]=],
}
ns "TASK"
returns "BOOL"
doc [[!
]]
native "WAYPOINT_PLAYBACK_OVERRIDE_SPEED"
hash "0x7D7D2B47FA788E85"
jhash (0x23E6BA96)
arguments {
Any "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "WAYPOINT_PLAYBACK_PAUSE"
hash "0x0F342546AA06FED5"
jhash (0xFE39ECF8)
arguments {
Any "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "WAYPOINT_PLAYBACK_RESUME"
hash "0x244F70C84C547D2D"
jhash (0x50F392EF)
arguments {
Any "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "WAYPOINT_PLAYBACK_START_AIMING_AT_COORD"
hash "0x8968400D900ED8B3"
jhash (0xF120A34E)
arguments {
Any "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
BOOL "p4" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "WAYPOINT_PLAYBACK_START_AIMING_AT_PED"
hash "0x20E330937C399D29"
jhash (0x75E60CF6)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "WAYPOINT_PLAYBACK_START_SHOOTING_AT_COORD"
hash "0x057A25CFCC9DB671"
jhash (0xCDDB44D5)
arguments {
Any "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
BOOL "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "WAYPOINT_PLAYBACK_START_SHOOTING_AT_PED"
hash "0xE70BA7B90F8390DC"
jhash (0xBD5F0EB8)
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
alias "0xE70BA7B90F8390DC"
ns "TASK"
returns "void"
doc [[!
]]
native "WAYPOINT_PLAYBACK_STOP_AIMING_OR_SHOOTING"
hash "0x47EFA040EBB8E2EA"
jhash (0x6D7CF40C)
arguments {
Any "p0" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "WAYPOINT_PLAYBACK_USE_DEFAULT_SPEED"
hash "0x6599D834B12D0800"
jhash (0x1BBB2CAC)
arguments {
Any "p0" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "WAYPOINT_RECORDING_GET_CLOSEST_WAYPOINT"
hash "0xB629A298081F876F"
jhash (0xC4CD35AF)
arguments {
charPtr "name" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
intPtr "point" [=[ {} ]=],
}
ns "TASK"
returns "BOOL"
doc [[!
```
For a full list of the points, see here: goo.gl/wIH0vn
```
]]
native "WAYPOINT_RECORDING_GET_COORD"
hash "0x2FB897405C90B361"
jhash (0x19266913)
arguments {
charPtr "name" [=[ {} ]=],
int "point" [=[ {} ]=],
Vector3Ptr "coord" [=[ {} ]=],
}
ns "TASK"
returns "BOOL"
doc [[!
```
For a full list of the points, see here: goo.gl/wIH0vn
```
]]
native "WAYPOINT_RECORDING_GET_NUM_POINTS"
hash "0x5343532C01A07234"
jhash (0xF5F9B71E)
arguments {
charPtr "name" [=[ {} ]=],
intPtr "points" [=[ {} ]=],
}
ns "TASK"
returns "BOOL"
doc [[!
```
For a full list of the points, see here: goo.gl/wIH0vn
```
]]
native "WAYPOINT_RECORDING_GET_SPEED_AT_POINT"
hash "0x005622AEBC33ACA9"
jhash (0xC765633A)
arguments {
charPtr "name" [=[ {} ]=],
int "point" [=[ {} ]=],
}
ns "TASK"
returns "float"
doc [[!
]]
native "_CLEAR_VEHICLE_TASKS"
hash "0xDBBC7A2432524127"
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0xDBBC7A2432524127"
ns "TASK"
returns "void"
doc [[!
```
CLEAR_*
NativeDB Introduced: v1290
```
The vehicle to have tasks cleared
]]
native "_GET_TASK_MOVE_NETWORK_SIGNAL_FLOAT"
hash "0x44AB0B3AFECCE242"
arguments {
Ped "ped" [=[ {} ]=],
charPtr "signalName" [=[ {} ]=],
}
ns "TASK"
returns "float"
doc [[!
```
NativeDB Introduced: v1493
```
]]
native "_SET_TASK_MOVE_NETWORK_SIGNAL_FLOAT_2"
hash "0x373EF409B82697A3"
arguments {
Ped "ped" [=[ {} ]=],
charPtr "signalName" [=[ {} ]=],
float "value" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
NativeDB Introduced: v1493
```
]]
native "_TASK_AGITATED_ACTION"
hash "0x19D1B791CB3670FE"
arguments {
Ped "ped" [=[ {} ]=],
Ped "ped2" [=[ {} ]=],
}
alias "0x19D1B791CB3670FE"
ns "TASK"
returns "void"
doc [[!
]]
native "_TASK_HELI_ESCORT_HELI"
hash "0xB385523325077210"
arguments {
Ped "pilot" [=[ {} ]=],
Vehicle "heli1" [=[ {} ]=],
Vehicle "heli2" [=[ {} ]=],
float "p3" [=[ {} ]=],
float "p4" [=[ {} ]=],
float "p5" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "_TASK_MOVE_NETWORK_BY_NAME_WITH_INIT_PARAMS"
hash "0x3D45B0B355C5E0C9"
arguments {
Ped "ped" [=[ {} ]=],
charPtr "p1" [=[ {} ]=],
AnyPtr "data" [=[ {} ]=],
float "p3" [=[ {} ]=],
BOOL "p4" [=[ {} ]=],
charPtr "animDict" [=[ {} ]=],
int "flags" [=[ {} ]=],
}
alias "_TASK_MOVE_NETWORK_SCRIPTED"
ns "TASK"
returns "void"
doc [[!
```
Used only once in the scripts (am_mp_nightclub)
```
```
Used only once in the scripts (am_mp_nightclub)
NativeDB Introduced: v1493
```
]]
native "_TASK_PLANE_GOTO_PRECISE_VTOL"
hash "0xF7F9DCCA89E7505B"
arguments {
Ped "ped" [=[ {} ]=],
Vehicle "vehicle" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
Any "p6" [=[ {} ]=],
Any "p7" [=[ {} ]=],
Any "p8" [=[ {} ]=],
Any "p9" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "_TASK_RAPPEL_DOWN_WALL"
hash "0xEAF66ACDDC794793"
arguments {
Ped "ped" [=[ {} ]=],
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
float "minZ" [=[ {} ]=],
int "ropeId" [=[ {} ]=],
charPtr "clipset" [=[ {} ]=],
Any "p10" [=[ {} ]=],
}
alias "0xEAF66ACDDC794793"
ns "TASK"
returns "void"
doc [[!
Attaches a ped to a rope and allows player control to rappel down a wall.
Disables all collisions while on the rope.
NativeDB Introduced: v1868
Ped to perform the task
X coord to start the task
Y coord to start the task
Z coord to start the task
Second X coord, uses the same position as above in the scripts
Second Y coord
Second Z coord
Minimum Z that the player can descend to
Rope to attach this task to, must be created with [ADD_ROPE](#\_0xE832D760399EB220)
Clipset to use for the task
Usually 1 in the scripts
]]
native "_TASK_SUBMARINE_GOTO_AND_STOP"
hash "0xC22B40579A498CA4"
arguments {
Any "p0" [=[ {} ]=],
Vehicle "submarine" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
Any "p5" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
Used in am_vehicle_spawn.ysc and am_mp_submarine.ysc.
p0 is always 0, p5 is always 1
p1 is the vehicle handle of the submarine. Submarine must have a driver, but the ped handle is not passed to the native.
Speed can be set by calling SET_DRIVE_TASK_CRUISE_SPEED after
```
NativeDB Introduced: v2189
```
]]
native "_TASK_WANDER_SPECIFIC"
hash "0x6919A2F136426098"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
NativeDB Introduced: v1868
```
]]
native "0x0FFB3C758E8C07B9"
hash "0x0FFB3C758E8C07B9"
arguments {
Ped "ped" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "TASK"
returns "Any"
doc [[!
Doesn't actually return anything.
```
NativeDB Introduced: v2060
```
]]
native "0x1F351CF1C6475734"
hash "0x1F351CF1C6475734"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
Any "p6" [=[ {} ]=],
Any "p7" [=[ {} ]=],
Any "p8" [=[ {} ]=],
Any "p9" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
]]
native "0x29682E2CCF21E9B5"
hash "0x29682E2CCF21E9B5"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
Any "p6" [=[ {} ]=],
Any "p7" [=[ {} ]=],
Any "p8" [=[ {} ]=],
Any "p9" [=[ {} ]=],
Any "p10" [=[ {} ]=],
Any "p11" [=[ {} ]=],
Any "p12" [=[ {} ]=],
Any "p13" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
NativeDB Introduced: v1868
```
]]
native "0x3E38E28A1D80DDF6"
hash "0x3E38E28A1D80DDF6"
jhash (0x54856309)
arguments {
Ped "ped" [=[ {} ]=],
}
ns "TASK"
returns "BOOL"
doc [[!
```
IS_*
```
]]
native "0x53DDC75BC3AC0A90"
hash "0x53DDC75BC3AC0A90"
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
Related to [`_CLEAR_VEHICLE_TASKS`](#\_0xDBBC7A2432524127) and requires more research (e.g., \_CLEAR_VEHICLE_SECONDARY_TASKS).
```
CLEAR_*
NativeDB Introduced: v1290
```
The vehicle to have tasks cleared
]]
native "0x6100B3CEFD43452E"
hash "0x6100B3CEFD43452E"
arguments {
Any "p0" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
NativeDB Introduced: v2189
```
]]
native "0x8423541E8B3A1589"
hash "0x8423541E8B3A1589"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
NativeDB Introduced: v1493
```
]]
native "0x8634CEF2522D987B"
hash "0x8634CEF2522D987B"
arguments {
Ped "ped" [=[ {} ]=],
charPtr "p1" [=[ {} ]=],
float "value" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
NativeDB Introduced: v1493
```
]]
native "0x9D252648778160DF"
hash "0x9D252648778160DF"
arguments {
Any "p0" [=[ {} ]=],
}
ns "TASK"
returns "Any"
doc [[!
```
NativeDB Introduced: v1868
```
]]
native "0xAB13A5565480B6D9"
hash "0xAB13A5565480B6D9"
jhash (0x1E58A7AD)
arguments {
Ped "ped" [=[ {} ]=],
charPtr "p1" [=[ {} ]=],
}
ns "TASK"
returns "Any"
doc [[!
```
Used only once in the scripts (fm_mission_controller) like so:
TASK::_0xAB13A5565480B6D9(iLocal_3160, "Cutting");
SET_*
```
]]
native "0xFA83CA6776038F64"
hash "0xFA83CA6776038F64"
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
ns "TASK"
returns "void"
doc [[!
```
REMOVE_*
NativeDB Introduced: v1493
```
]]
native "ADD_ROAD_NODE_SPEED_ZONE"
hash "0x2CE544C68FB812A0"
jhash (0xD6685803)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "radius" [=[ {} ]=],
float "speed" [=[ {} ]=],
BOOL "p5" [=[ {} ]=],
}
alias "0x2CE544C68FB812A0"
alias "_ADD_SPEED_ZONE_FOR_COORD"
ns "VEHICLE"
returns "int"
doc [[!
]]
native "ADD_VEHICLE_COMBAT_ANGLED_AVOIDANCE_AREA"
hash "0x54B0F614960F4A5F"
jhash (0x5AB26C2B)
arguments {
float "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
float "p4" [=[ {} ]=],
float "p5" [=[ {} ]=],
float "p6" [=[ {} ]=],
}
alias "0x54B0F614960F4A5F"
alias "_ADD_VEHICLE_COMBAT_AVOIDANCE_AREA"
ns "VEHICLE"
returns "Any"
doc [[!
]]
native "ADD_VEHICLE_PHONE_EXPLOSIVE_DEVICE"
hash "0x99AD4CCCB128CBC9"
jhash (0x811373DE)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0x99AD4CCCB128CBC9"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "ADD_VEHICLE_STUCK_CHECK_WITH_WARP"
hash "0x2FA9923062DD396C"
jhash (0xC8B789AD)
arguments {
Any "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
BOOL "p4" [=[ {} ]=],
BOOL "p5" [=[ {} ]=],
Any "p6" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "ADD_VEHICLE_UPSIDEDOWN_CHECK"
hash "0xB72E26D81006005B"
jhash (0x3A13D384)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "ALLOW_AMBIENT_VEHICLES_TO_AVOID_ADVERSE_CONDITIONS"
hash "0xB264C4D2F2B0A78B"
jhash (0x45F72495)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0xB264C4D2F2B0A78B"
ns "VEHICLE"
returns "void"
doc [[!
This native it's a debug native. Won't do anything.
]]
native "ARE_ALL_VEHICLE_WINDOWS_INTACT"
hash "0x11D862A3E977A9EF"
jhash (0xBB619744)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "_ARE_ALL_VEHICLE_WINDOWS_INTACT"
ns "VEHICLE"
returns "BOOL"
doc [[!
```
Appears to return false if any window is broken.
```
]]
native "ARE_ANY_VEHICLE_SEATS_FREE"
hash "0x2D34FC3BC4ADB780"
jhash (0x648E685A)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "_IS_ANY_VEHICLE_SEAT_EMPTY"
ns "VEHICLE"
returns "BOOL"
doc [[!
```
Returns false if every seat is occupied.
```
]]
native "ARE_PLANE_CONTROL_PANELS_INTACT"
hash "0xF78F94D60248C737"
jhash (0x3B51B348)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "checkForZeroHealth" [=[ {} ]=],
}
alias "0xF78F94D60248C737"
ns "VEHICLE"
returns "BOOL"
doc [[!
Queries whether the control panels of a plane are intact. This native is used to determine the operational status of a plane's cockpit controls, which can affect the plane's flyability.
The vehicle to check. This should be a plane.
If set to `true`, the native also checks if the plane's health is zero, indicating it is completely destroyed. If `false`, only the state of the control panels is considered.
Returns `true` if the plane's control panels are intact, and, depending on the `checkForZeroHealth` parameter, the plane is not completely destroyed. Returns `false` if the control panels are damaged or the plane is destroyed (when `checkForZeroHealth` is `true`).
]]
native "ARE_PLANE_PROPELLERS_INTACT"
hash "0x755D6D5267CBBD7E"
jhash (0xABBDD5C6)
arguments {
Vehicle "plane" [=[ {} ]=],
}
alias "0x755D6D5267CBBD7E"
alias "_ARE_PROPELLERS_UNDAMAGED"
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "ATTACH_ENTITY_TO_CARGOBOB"
hash "0xA1DD82F3CCF9A01E"
jhash (0xAEB29F98)
arguments {
Vehicle "vehicle" [=[ {} ]=],
Entity "entity" [=[ {} ]=],
int "p2" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
alias "0xA1DD82F3CCF9A01E"
alias "_ATTACH_ENTITY_TO_CARGOBOB"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "ATTACH_VEHICLE_ON_TO_TRAILER"
hash "0x16B5E274BDE402F8"
jhash (0x12AC1A16)
arguments {
Vehicle "vehicle" [=[ {} ]=],
Vehicle "trailer" [=[ {} ]=],
float "offsetX" [=[ {} ]=],
float "offsetY" [=[ {} ]=],
float "offsetZ" [=[ {} ]=],
float "coordsX" [=[ {} ]=],
float "coordsY" [=[ {} ]=],
float "coordsZ" [=[ {} ]=],
float "rotationX" [=[ {} ]=],
float "rotationY" [=[ {} ]=],
float "rotationZ" [=[ {} ]=],
float "disableColls" [=[ {} ]=],
}
alias "0x16B5E274BDE402F8"
ns "VEHICLE"
returns "void"
doc [[!
The vehicle to attach to the trailer
The trailer to attach the vehicle to
The x offset of the vehicle
The y offset of the vehicle
The z offset of the vehicle
The x coords of where you want the vehicle placed (must be an offset from the trailer itself)
The y coords of where you want the vehicle placed (must be an offset from the trailer itself)
The z coords of where you want the vehicle placed (must be an offset from the trailer itself)
The x rotation of where you want the vehicle placed
The y rotation of where you want the vehicle placed
The z rotation of where you want the vehicle placed
Should actually be a boolean, this will disable the collision between the vehicle you're attaching and the trailer
]]
native "ATTACH_VEHICLE_TO_CARGOBOB"
hash "0x4127F1D84E347769"
jhash (0x607DC9D5)
arguments {
Vehicle "cargobob" [=[ {} ]=],
Vehicle "vehicle" [=[ {} ]=],
int "vehicleBoneIndex" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
The cargobob
The vehicle that will be attached
A Vehicle bone the hook/magnet should attach to or -1 for none/default [GET_ENTITY_BONE_INDEX_BY_NAME](#\_0xFB71170B7E76ACBA)
x hook/magnet Offset
y hook/magnet Offset
z hook/magnet Offset
]]
native "ATTACH_VEHICLE_TO_TOW_TRUCK"
hash "0x29A16F8D621C4508"
jhash (0x8151571A)
arguments {
Vehicle "towTruck" [=[ {} ]=],
Vehicle "vehicle" [=[ {} ]=],
BOOL "rear" [=[ {} ]=],
float "hookOffsetX" [=[ {} ]=],
float "hookOffsetY" [=[ {} ]=],
float "hookOffsetZ" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
HookOffset defines where the hook is attached. leave at 0 for default attachment.
```
]]
native "ATTACH_VEHICLE_TO_TRAILER"
hash "0x3C7D42D58F770B54"
jhash (0x2133977F)
arguments {
Vehicle "vehicle" [=[ {} ]=],
Vehicle "trailer" [=[ {} ]=],
float "radius" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "BRING_VEHICLE_TO_HALT"
hash "0x260BE8F09E326A20"
jhash (0xCBC7D3C8)
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "distance" [=[ {} ]=],
int "duration" [=[ {} ]=],
BOOL "bControlVerticalVelocity" [=[ {} ]=],
}
alias "0x260BE8F09E326A20"
alias "_SET_VEHICLE_HALT"
ns "VEHICLE"
returns "void"
doc [[!
This native makes the vehicle stop immediately, as it happens when we enter a multiplayer garage.
The vehicle to stop.
The distance from the initial coords at which the vehicle should come to rest.
The length of time in seconds to hold the car at rest after stopping.
`false` by default which allows gravity to act normally in the z direction. Enable this option to halt the vehicle's vertical velocity as well.
]]
native "CAN_ANCHOR_BOAT_HERE"
hash "0x26C10ECBDA5D043B"
jhash (0xE97A4F5E)
arguments {
Vehicle "boat" [=[ {} ]=],
}
alias "0x2467A2D807D37CA3"
alias "_GET_BOAT_ANCHOR"
alias "_CAN_BOAT_BE_ANCHORED"
ns "VEHICLE"
returns "BOOL"
doc [[!
Checks if a boat can be anchored at its present position without possibly intersecting collision later.
```
NativeDB Introduced: v323
```
The boat to check.
Returns `true` if the boat can be safely anchored at its current position, `false` otherwise.
]]
native "CAN_ANCHOR_BOAT_HERE_IGNORE_PLAYERS"
hash "0x24F4121D07579880"
arguments {
Vehicle "boat" [=[ {} ]=],
}
alias "_CAN_BOAT_BE_ANCHORED_2"
alias "_CAN_ANCHOR_BOAT_HERE_2"
ns "VEHICLE"
returns "BOOL"
doc [[!
Checks if a boat can be anchored at its present position, ignoring any players standing on the boat.
```
NativeDB Introduced: v678
```
The boat to check.
Returns `true` if the boat can be safely anchored at its current position (ignoring players on the boat), `false` otherwise.
]]
native "CAN_CARGOBOB_PICK_UP_ENTITY"
hash "0x2C1D8B3B19E517CC"
arguments {
Vehicle "cargobob" [=[ {} ]=],
Entity "entity" [=[ {} ]=],
}
alias "0x2C1D8B3B19E517CC"
ns "VEHICLE"
annotations [=[ {"cs_type":"Any"} ]=]
returns "BOOL"
doc [[!
Determines whether the specified Cargobob can pick up a given entity.
The Cargobob helicopter to be checked.
The entity to be checked for pick-up.
Returns `true` if the Cargobob can pick up the specified entity, `false` otherwise.
]]
native "CAN_SHUFFLE_SEAT"
hash "0x30785D90C956BF35"
jhash (0xB3EB01ED)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "seatIndex" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
The vehicle to check.
See eSeatPosition declared in [`IS_VEHICLE_SEAT_FREE`](#\_0x22AC59A870E6A669).
]]
native "CLEAR_LAST_DRIVEN_VEHICLE"
hash "0xE01903C47C7AC89E"
jhash (0x07186AD9)
alias "0xE01903C47C7AC89E"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "CLEAR_NITROUS"
hash "0xC889AE921400E1ED"
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
NativeDB Introduced: 3095
```
Resets or clears the nitrous system for a specified vehicle. You can check if a vehicle has nitrous with [`IS_NITROUS_ACTIVE`](#\_0x491E822B2C464FE4)
The vehicle whose nitrous system needs to be cleared.
]]
native "CLEAR_VEHICLE_CUSTOM_PRIMARY_COLOUR"
hash "0x55E1D2758F34E437"
jhash (0x51E1E33D)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
annotations [=[ {"cs_type":"Any"} ]=]
returns "void"
doc [[!
]]
native "CLEAR_VEHICLE_CUSTOM_SECONDARY_COLOUR"
hash "0x5FFBDEEC3E8E2009"
jhash (0x7CE00B29)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
annotations [=[ {"cs_type":"Any"} ]=]
returns "void"
doc [[!
]]
native "CLEAR_VEHICLE_GENERATOR_AREA_OF_INTEREST"
hash "0x0A436B8643716D14"
jhash (0x6C73E45A)
alias "0x0A436B8643716D14"
ns "VEHICLE"
returns "void"
doc [[!
Removes the cargen area of interest and resumes normal cargen spawning.
You can set the area of interest with [`SET_VEHICLE_GENERATOR_AREA_OF_INTEREST`](#\_0x9A75585FB2E54FAD)
]]
native "CLEAR_VEHICLE_ROUTE_HISTORY"
hash "0x6D6AF961B72728AE"
jhash (0x8DD9AA0C)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0x6D6AF961B72728AE"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "CLOSE_BOMB_BAY_DOORS"
hash "0x3556041742A0DC74"
jhash (0xF8EC5751)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0x3556041742A0DC74"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "CONTROL_LANDING_GEAR"
hash "0xCFC8BE9A5E1FE575"
jhash (0x24F873FB)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "state" [=[ {} ]=],
}
alias "_SET_VEHICLE_LANDING_GEAR"
ns "VEHICLE"
returns "void"
doc [[!
```
Works for vehicles with a retractable landing gear
landing gear states:
0: Deployed
1: Closing
2: Opening
3: Retracted
```
]]
native "COPY_VEHICLE_DAMAGES"
hash "0xE44A982368A4AF23"
jhash (0xBAE491C7)
arguments {
Vehicle "sourceVehicle" [=[ {} ]=],
Vehicle "targetVehicle" [=[ {} ]=],
}
alias "0xE44A982368A4AF23"
ns "VEHICLE"
returns "void"
doc [[!
Copies sourceVehicle's damage (broken bumpers, broken lights, etc.) to targetVehicle.
The source to copy the vehicle damage.
The target to paste the vehicle damage.
]]
native "CREATE_MISSION_TRAIN"
hash "0x63C6CCA8E68AE8C8"
jhash (0xD4C2EAFD)
arguments {
int "variation" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
BOOL "direction" [=[ {} ]=],
}
ns "VEHICLE"
returns "Vehicle"
doc [[!
Train models must be [requested](#\_0x963D27A58DF860AC) before use. See trains.xml (located in `Grand Theft Auto V\update\update.rpf\common\data\levels\gta5\trains.xml`) for freight and metro variations.
Model names to request can be found by searching `model_name` in the file.
The `Lua` usage example provided down below has been provided in such way so users can test each and every train variation.
### Newly added parameters (seen in 2372 build)
```
NativeDB Added Parameter 6: BOOL isNetwork
NativeDB Added Parameter 7: BOOL netMissionEntity
```
* **isNetwork**: Whether to create a network object for the train. If false, the train exists only locally.
* **netMissionEntity**: Whether to register the train as pinned to the script host in the R\* network model.
### Train Models:
* freight
### Carriage Models:
* freightcar
* freightcar2 (Added v2372)
* freightcont1
* freightcont2
* freightgrain
* metrotrain
* tankercar
### Some train variations (default from trains.xml as of build 2372)
* 17. Very long train and freight variation.
* 18. Freight train only.
* 26. Double metro train (with both models flipped opposite to each other). This used to be `25` before the 2802 build, it also used to be `24` before the 2372 build.
The variation id, these can range from 0 to 26 as of build 2802 (previously `0-25` in build 2372 and `0-24` before that).
Spawn coordinate X component.
Spawn coordinate Y component.
Spawn coordinate Z component.
The direction in which the train will go (true or false)
A script handle (fwScriptGuid index) for the train, or 0 if the train failed to be created.
]]
native "CREATE_PICK_UP_ROPE_FOR_CARGOBOB"
hash "0x7BEB0C7A235F6F3B"
jhash (0x4D3C9A99)
arguments {
Vehicle "cargobob" [=[ {} ]=],
int "state" [=[ {} ]=],
}
alias "_ENABLE_CARGOBOB_HOOK"
ns "VEHICLE"
returns "void"
doc [[!
Drops the Hook/Magnet on a cargobob
```cpp
enum eCargobobHook
{
CARGOBOB_HOOK = 0,
CARGOBOB_MAGNET = 1,
};
```
]]
native "CREATE_SCRIPT_VEHICLE_GENERATOR"
hash "0x9DEF883114668116"
jhash (0x25A9A261)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "heading" [=[ {} ]=],
float "p4" [=[ {} ]=],
float "p5" [=[ {} ]=],
Hash "modelHash" [=[ {} ]=],
int "p7" [=[ {} ]=],
int "p8" [=[ {} ]=],
int "p9" [=[ {} ]=],
int "p10" [=[ {} ]=],
BOOL "p11" [=[ {} ]=],
BOOL "p12" [=[ {} ]=],
BOOL "p13" [=[ {} ]=],
BOOL "p14" [=[ {} ]=],
BOOL "p15" [=[ {} ]=],
int "p16" [=[ {} ]=],
}
ns "VEHICLE"
returns "int"
doc [[!
```
Creates a script vehicle generator at the given coordinates. Most parameters after the model hash are unknown.
Parameters:
a/w/s - Generator position
heading - Generator heading
p4 - Unknown (always 5.0)
p5 - Unknown (always 3.0)
modelHash - Vehicle model hash
p7/8/9/10 - Unknown (always -1)
p11 - Unknown (usually TRUE, only one instance of FALSE)
p12/13 - Unknown (always FALSE)
p14 - Unknown (usally FALSE, only two instances of TRUE)
p15 - Unknown (always TRUE)
p16 - Unknown (always -1)
Vector3 coords = GET_ENTITY_COORDS(PLAYER_PED_ID(), 0); CREATE_SCRIPT_VEHICLE_GENERATOR(coords.x, coords.y, coords.z, 1.0f, 5.0f, 3.0f, GET_HASH_KEY("adder"), -1. -1, -1, -1, -1, true, false, false, false, true, -1);
```
]]
native "CREATE_VEHICLE"
hash "0xAF35D0D2583051B0"
jhash (0xDD75460A)
arguments {
Hash "modelHash" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "heading" [=[ {} ]=],
BOOL "isNetwork" [=[ {} ]=],
BOOL "netMissionEntity" [=[ {} ]=],
}
ns "VEHICLE"
returns "Vehicle"
doc [[!
Creates a vehicle with the specified model at the specified position. This vehicle will initially be owned by the creating
script as a mission entity, and the model should be loaded already (e.g. using REQUEST_MODEL).
```
NativeDB Added Parameter 8: BOOL p7
```
The model of vehicle to spawn.
Spawn coordinate X component.
Spawn coordinate Y component.
Spawn coordinate Z component.
Heading to face towards, in degrees.
Whether to create a network object for the vehicle. If false, the vehicle exists only locally.
Whether to register the vehicle as pinned to the script host in the R\* network model.
A script handle (fwScriptGuid index) for the vehicle, or `0` if the vehicle failed to be created.
]]
native "DELETE_ALL_TRAINS"
hash "0x736A718577F39C7D"
jhash (0x83DE7ABF)
ns "VEHICLE"
returns "void"
doc [[!
]]
native "DELETE_MISSION_TRAIN"
hash "0x5B76B14AE875C795"
jhash (0x86C9497D)
arguments {
VehiclePtr "train" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
Used to delete mission trains created with [`CREATE_MISSION_TRAIN`](#\_0x63C6CCA8E68AE8C8).
]]
native "DELETE_SCRIPT_VEHICLE_GENERATOR"
hash "0x22102C9ABFCF125D"
jhash (0xE4328E3F)
arguments {
int "vehicleGenerator" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
Removes a scripted vehicle generator.
]]
native "DELETE_VEHICLE"
hash "0xEA386986E786A54F"
jhash (0x9803AF60)
arguments {
VehiclePtr "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
Deletes a vehicle.
The vehicle must be a mission entity to delete, so call this before deleting: SET_ENTITY_AS_MISSION_ENTITY(vehicle, true, true);
eg how to use:
SET_ENTITY_AS_MISSION_ENTITY(vehicle, true, true);
DELETE_VEHICLE(&vehicle);
Deletes the specified vehicle, then sets the handle pointed to by the pointer to NULL.
```
]]
native "DETACH_CONTAINER_FROM_HANDLER_FRAME"
hash "0x7C0043FDFF6436BC"
jhash (0x0F11D01F)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0x7C0043FDFF6436BC"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "DETACH_ENTITY_FROM_CARGOBOB"
hash "0xAF03011701811146"
arguments {
Vehicle "vehicle" [=[ {} ]=],
Entity "entity" [=[ {} ]=],
}
alias "0xAF03011701811146"
alias "_DETACH_ENTITY_FROM_CARGOBOB"
ns "VEHICLE"
returns "Any"
doc [[!
Detaches the specified entity currently being carried by a Cargobob.
The Cargobob helicopter.
The entity to be detached.
]]
native "DETACH_VEHICLE_FROM_ANY_CARGOBOB"
hash "0xADF7BE450512C12F"
jhash (0x50E0EABE)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "DETACH_VEHICLE_FROM_ANY_TOW_TRUCK"
hash "0xD0E9CE05A1E68CD8"
jhash (0x3BF93651)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "DETACH_VEHICLE_FROM_CARGOBOB"
hash "0x0E21D3DF1051399D"
jhash (0x83D3D331)
arguments {
Vehicle "cargobob" [=[ {} ]=],
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "DETACH_VEHICLE_FROM_TOW_TRUCK"
hash "0xC2DB6B6708350ED8"
jhash (0xC666CF33)
arguments {
Vehicle "towTruck" [=[ {} ]=],
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
First two parameters swapped. Scripts verify that towTruck is the first parameter, not the second.
```
]]
native "DETACH_VEHICLE_FROM_TRAILER"
hash "0x90532EDF0D2BDD86"
jhash (0xB5DBF91D)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "DETONATE_VEHICLE_PHONE_EXPLOSIVE_DEVICE"
hash "0xEF49CF0270307CBE"
jhash (0x65255524)
alias "0xEF49CF0270307CBE"
alias "_REQUEST_VEHICLE_PHONE_EXPLOSION"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "DISABLE_INDIVIDUAL_PLANE_PROPELLER"
hash "0x500873A45724C863"
jhash (0x004926A3)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "propeller" [=[ {} ]=],
}
alias "0x500873A45724C863"
alias "_DISABLE_PLANE_PROPELLER"
ns "VEHICLE"
returns "void"
doc [[!
```
NativeDB Introduced: v323
```
The propeller plane
The propeller index to disable (starts at 0).
]]
native "DISABLE_PLANE_AILERON"
hash "0x23428FC53C60919C"
jhash (0x7E84C45C)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "DISABLE_VEHICLE_WEAPON"
hash "0xF4FC6A6F67D8D856"
jhash (0xA688B7D1)
arguments {
BOOL "disabled" [=[ {} ]=],
Hash "weaponHash" [=[ {} ]=],
Vehicle "vehicle" [=[ {} ]=],
Ped "owner" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
how does this work?
```
]]
native "DOES_CARGOBOB_HAVE_PICK_UP_ROPE"
hash "0x1821D91AD4B56108"
jhash (0xAF769B81)
arguments {
Vehicle "cargobob" [=[ {} ]=],
}
alias "_IS_CARGOBOB_HOOK_ACTIVE"
ns "VEHICLE"
returns "BOOL"
doc [[!
```
Returns true only when the hook is active, will return false if the magnet is active
```
]]
native "DOES_CARGOBOB_HAVE_PICKUP_MAGNET"
hash "0x6E08BF5B3722BAC9"
jhash (0x4778CA0A)
arguments {
Vehicle "cargobob" [=[ {} ]=],
}
alias "_IS_CARGOBOB_MAGNET_ACTIVE"
alias "_DOES_CARGOBOB_HAVE_PICKUP_MAGNET"
ns "VEHICLE"
returns "BOOL"
doc [[!
```
Returns true only when the magnet is active, will return false if the hook is active
```
]]
native "DOES_EXTRA_EXIST"
hash "0x1262D55792428154"
jhash (0x409411CC)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "extraId" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
```
Checks via CVehicleModelInfo
```
]]
native "DOES_SCRIPT_VEHICLE_GENERATOR_EXIST"
hash "0xF6086BC836400876"
jhash (0xF6BDDA30)
arguments {
int "vehicleGenerator" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "DOES_VEHICLE_EXIST_WITH_DECORATOR"
hash "0x956B409B984D9BF7"
jhash (0x39E68EDD)
arguments {
charPtr "decorator" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "DOES_VEHICLE_HAVE_ROOF"
hash "0x8AC862B0B32C5B80"
jhash (0xDB817403)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
Determines whether a specific vehicle is equipped with a roof.
```
NativeDB Introduced: v323
```
The vehicle to check for a roof presence.
Returns `true` if the vehicle has a roof, `false` otherwise.
]]
native "DOES_VEHICLE_HAVE_SEARCHLIGHT"
hash "0x99015ED7DBEA5113"
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "_DOES_VEHICLE_HAVE_SEARCHLIGHT"
ns "VEHICLE"
returns "BOOL"
doc [[!
Determines whether the specified vehicle is equipped with a searchlight.
```
NativeDB Introduced: v2189
```
The vehicle to check for the presence of a searchlight.
Returns `true` if the vehicle has a searchlight, `false` otherwise.
]]
native "DOES_VEHICLE_HAVE_STUCK_VEHICLE_CHECK"
hash "0x57E4C39DE5EE8470"
jhash (0x5D91D9AC)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
```
Maximum amount of vehicles with vehicle stuck check appears to be 16.
```
]]
native "DOES_VEHICLE_HAVE_WEAPONS"
hash "0x25ECB9F8017D98E0"
jhash (0xB2E1E1FB)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "EXPLODE_VEHICLE"
hash "0xBA71116ADF5B514C"
jhash (0xBEDEACEB)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "isAudible" [=[ {} ]=],
BOOL "isInvisible" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
Explodes a selected vehicle.
Vehicle vehicle = Vehicle you want to explode.
BOOL isAudible = If explosion makes a sound.
BOOL isInvisible = If the explosion is invisible or not.
First BOOL does not give any visual explosion, the vehicle just falls apart completely but slowly and starts to burn.
```
]]
native "EXPLODE_VEHICLE_IN_CUTSCENE"
hash "0x786A4EB67B01BF0B"
jhash (0xA85207B5)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "FIX_VEHICLE_WINDOW"
hash "0x772282EBEB95E682"
jhash (0x6B8E990D)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "windowIndex" [=[ {} ]=],
}
ns "VEHICLE"
annotations [=[ {"cs_type":"Any"} ]=]
returns "void"
doc [[!
See eWindowId declared in [`IS_VEHICLE_WINDOW_INTACT`](#\_0x46E571A0E20D01F1).
This function is coded to not work on vehicles of type: `CBike`, `Bmx`, `CBoat`, `CTrain`, and `CSubmarine`.
]]
native "FORCE_PLAYBACK_RECORDED_VEHICLE_UPDATE"
hash "0x1F2E4E06DEA8992B"
jhash (0x01B91CD0)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
alias "0x1F2E4E06DEA8992B"
ns "VEHICLE"
returns "void"
doc [[!
```
Often called after START_PLAYBACK_RECORDED_VEHICLE and SKIP_TIME_IN_PLAYBACK_RECORDED_VEHICLE; similar in use to FORCE_ENTITY_AI_AND_ANIMATION_UPDATE.
```
]]
native "FORCE_SUBMARINE_NEURTAL_BUOYANCY"
hash "0xC67DB108A9ADE3BE"
arguments {
Vehicle "submarine" [=[ {} ]=],
int "time" [=[ {} ]=],
}
alias "0xC67DB108A9ADE3BE"
ns "VEHICLE"
returns "void"
doc [[!
Forces a submarine to maintain neutral buoyancy for a specified duration, preventing it from rising when unoccupied or without a driver.
```
NativeDB Introduced: v2189
```
The submarine vehicle to apply neutral buoyancy to.
The duration in milliseconds for which to maintain neutral buoyancy.
]]
native "FORCE_SUBMARINE_SURFACE_MODE"
hash "0x33506883545AC0DF"
jhash (0x54E9EE75)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x33506883545AC0DF"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "FULLY_CHARGE_NITROUS"
hash "0x1A2BCC8C636F9226"
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
NativeDB Introduced: v3095
```
Recharges the nitrous system of the specified vehicle to its maximum capacity. This action sets the nitrous charge duration to the maximum limit defined by previous settings applied through [`SET_OVERRIDE_NITROUS_LEVEL`](#\_0xC8E9B6B71B8E660D).
The vehicle whose nitrous system is to be fully recharged.
]]
native "GET_ALL_VEHICLES"
hash "0x9B8E1BF04B51F2E8"
arguments {
intPtr "vehArray" [=[ {"cs_type":"AnyPtr"} ]=],
}
alias "_GET_ALL_VEHICLES"
ns "VEHICLE"
returns "int"
doc [[!
For FiveM, use [`GET_GAME_POOL`](#\_0x2B9D4F50).
Returns all vehicles in the vehicle game pool.
]]
native "GET_BOAT_BOOM_POSITION_RATIO"
hash "0x6636C535F6CC2725"
jhash (0x7C8D6464)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0x6636C535F6CC2725"
ns "VEHICLE"
returns "float"
doc [[!
]]
native "GET_BOAT_VEHICLE_MODEL_AGILITY"
hash "0x5AA3F878A178C4FC"
jhash (0x87C5D271)
arguments {
Hash "modelHash" [=[ {} ]=],
}
alias "0x5AA3F878A178C4FC"
alias "_GET_VEHICLE_MODEL_MOVE_RESISTANCE"
ns "VEHICLE"
returns "float"
doc [[!
Retrieves the agility for a specific boat model, including any vehicle mods. Unlike other vehicles where Rockstar Games typically assess performance based on traction, boats use agility as a measure. This static value is distinct from the traction metrics used for other vehicle types.
```
NativeDB Introduced: v323
```
The model hash of the boat.
Returns the agility value of the specified boat as a float number.
]]
native "GET_CLOSEST_VEHICLE"
hash "0xF73EB622C4F1689B"
jhash (0xD7E26B2C)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "radius" [=[ {} ]=],
Hash "modelHash" [=[ {} ]=],
int "flags" [=[ {} ]=],
}
ns "VEHICLE"
returns "Vehicle"
doc [[!
```
Example usage
VEHICLE::GET_CLOSEST_VEHICLE(x, y, z, radius, hash, unknown leave at 70)
x, y, z: Position to get closest vehicle to.
radius: Max radius to get a vehicle.
modelHash: Limit to vehicles with this model. 0 for any.
flags: The bitwise flags altering the function's behaviour.
Does not return police cars or helicopters.
It seems to return police cars for me, does not seem to return helicopters, planes or boats for some reason
Only returns non police cars and motorbikes with the flag set to 70 and modelHash to 0. ModelHash seems to always be 0 when not a modelHash in the scripts, as stated above.
These flags were found in the b617d scripts: 0,2,4,6,7,23,127,260,2146,2175,12294,16384,16386,20503,32768,67590,67711,98309,100359.
Converted to binary, each bit probably represents a flag as explained regarding another native here: gtaforums.com/topic/822314-guide-driving-styles
Conversion of found flags to binary: pastebin.com/kghNFkRi
At exactly 16384 which is 0100000000000000 in binary and 4000 in hexadecimal only planes are returned.
It's probably more convenient to use worldGetAllVehicles(int *arr, int arrSize) and check the shortest distance yourself and sort if you want by checking the vehicle type with for example VEHICLE::IS_THIS_MODEL_A_BOAT
-------------------------------------------------------------------------
Conclusion: This native is not worth trying to use. Use something like this instead: pastebin.com/xiFdXa7h
Use flag 127 to return police cars
```
]]
native "GET_CONVERTIBLE_ROOF_STATE"
hash "0xF8C397922FC03F41"
jhash (0x1B09714D)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "int"
doc [[!
Returns the convertible state of the specified vehicle.
```cpp
enum eRoofState {
RAISED = 0,
LOWERING = 1,
LOWERED = 2,
RAISING = 3,
CLOSING_BOOT = 4,
ROOF_STUCK_RAISED = 5,
ROOF_STUCK_LOWERED = 6
}
```
Vehicle to get the state of
Returns the current roof state, refer to `eRoofState`
]]
native "GET_CURRENT_PLAYBACK_FOR_VEHICLE"
hash "0x42BC05C27A946054"
jhash (0xA3F44390)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "int"
doc [[!
]]
native "GET_DISPLAY_NAME_FROM_VEHICLE_MODEL"
hash "0xB215AAC32D25D019"
jhash (0xEC86DF39)
arguments {
Hash "modelHash" [=[ {} ]=],
}
ns "VEHICLE"
returns "charPtr"
doc [[!
Returns the display name/text label (`gameName` in `vehicles.meta`) for the specified vehicle model.
A vehicle model to check.
The display name for the vehicle, or `'CARNOTFOUND'` if invalid.
]]
native "GET_ENTITY_ATTACHED_TO_TOW_TRUCK"
hash "0xEFEA18DCF10F8F75"
jhash (0x11EC7844)
arguments {
Vehicle "towTruck" [=[ {} ]=],
}
ns "VEHICLE"
returns "Entity"
doc [[!
]]
native "GET_HELI_MAIN_ROTOR_HEALTH"
hash "0xE4CB7541F413D2C5"
jhash (0xF01E2AAB)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "_GET_HELI_MAIN_ROTOR_HEALTH"
ns "VEHICLE"
returns "float"
doc [[!
```
Max 1000.
At 0 the main rotor will stall.
```
]]
native "GET_HELI_TAIL_BOOM_HEALTH"
hash "0xAC51915D27E4A5F7"
jhash (0x8A68388F)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "_GET_HELI_ENGINE_HEALTH"
ns "VEHICLE"
returns "float"
doc [[!
```
Max 1000.
At -100 both helicopter rotors will stall.
```
]]
native "GET_HELI_TAIL_ROTOR_HEALTH"
hash "0xAE8CE82A4219AC8C"
jhash (0xA41BC13D)
arguments {
Vehicle "heli" [=[ {} ]=],
}
alias "_GET_HELI_TAIL_ROTOR_HEALTH"
ns "VEHICLE"
returns "float"
doc [[!
```
NativeDB Introduced: v323
```
Helicopter for which you want to get the rotor health.
Returns the health of the rear rotor of the helicopter, not the tail rotor as the name suggests. The maximum value is 1000. At 0, the tail rotor will stall.
]]
native "GET_IS_BOAT_CAPSIZED"
hash "0xBA91D045575699AD"
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0xBA91D045575699AD"
ns "VEHICLE"
returns "BOOL"
doc [[!
Checks whether the specified boat vehicle is capsized, meaning it has overturned or is upside down in the water.
The vehicle to check. This should be a boat-type vehicle.
Returns `true` if the specified boat is capsized, `false` otherwise.
]]
native "GET_IS_LEFT_VEHICLE_HEADLIGHT_DAMAGED"
hash "0x5EF77C9ADD3B11A3"
jhash (0xA0777943)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "_IS_HEADLIGHT_L_BROKEN"
ns "VEHICLE"
returns "BOOL"
doc [[!
```
From the driver's perspective, is the left headlight broken.
```
]]
native "GET_IS_RIGHT_VEHICLE_HEADLIGHT_DAMAGED"
hash "0xA7ECB73355EB2F20"
jhash (0xF178390B)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "_IS_HEADLIGHT_R_BROKEN"
ns "VEHICLE"
returns "BOOL"
doc [[!
```
From the driver's perspective, is the right headlight broken.
```
]]
native "GET_IS_VEHICLE_ENGINE_RUNNING"
hash "0xAE31E7DF9B5B132E"
jhash (0x7DC6D022)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "_IS_VEHICLE_ENGINE_ON"
ns "VEHICLE"
returns "BOOL"
doc [[!
```
Returns true when in a vehicle, false whilst entering/exiting.
```
]]
native "GET_IS_VEHICLE_PRIMARY_COLOUR_CUSTOM"
hash "0xF095C0405307B21B"
jhash (0xD7EC8760)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "GET_IS_VEHICLE_SECONDARY_COLOUR_CUSTOM"
hash "0x910A32E7AAD2656C"
jhash (0x288AD228)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
```
Check if Vehicle Secondary is avaliable for customize
```
]]
native "GET_LANDING_GEAR_STATE"
hash "0x9B0F3DCA3DB0F4CD"
jhash (0xA6F02670)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "_GET_VEHICLE_LANDING_GEAR"
ns "VEHICLE"
returns "int"
doc [[!
```
Landing gear states:
0: Deployed
1: Closing (Retracting)
3: Opening (Deploying)
4: Retracted
5: Broken
```
Landing gear state 2 is never used.
The vehicle to check.
The current state of the vehicles landing gear.
]]
native "GET_LAST_DRIVEN_VEHICLE"
hash "0xB2D06FAEDE65B577"
jhash (0xFEB0C0C8)
alias "0xB2D06FAEDE65B577"
ns "VEHICLE"
returns "Vehicle"
doc [[!
]]
native "GET_LAST_PED_IN_VEHICLE_SEAT"
hash "0x83F969AA1EE2A664"
jhash (0xF7C6792D)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "seatIndex" [=[ {} ]=],
}
ns "VEHICLE"
returns "Ped"
doc [[!
The vehicle to get the ped for.
See eSeatPosition declared in [`IS_VEHICLE_SEAT_FREE`](#\_0x22AC59A870E6A669).
]]
native "GET_LIVERY_NAME"
hash "0xB4C7A93837C91A1F"
jhash (0xED80B5BE)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "liveryIndex" [=[ {} ]=],
}
ns "VEHICLE"
returns "charPtr"
doc [[!
```
Second Param = LiveryIndex
example
int count = VEHICLE::GET_VEHICLE_LIVERY_COUNT(veh);
for (int i = 0; i < count; i++)
{
char* LiveryName = VEHICLE::GET_LIVERY_NAME(veh, i);
}
this example will work fine to fetch all names
for example for Sanchez we get
SANC_LV1
SANC_LV2
SANC_LV3
SANC_LV4
SANC_LV5
Use _GET_LABEL_TEXT, to get the localized livery name.
```
NOTE: You may need to set the vehicle's modKit to 0 by using this function [SET_VEHICLE_MOD_KIT](#\_0x1F2AA07F00B3217A) before getting the name, otherwise this native may return NULL.
]]
native "GET_MAKE_NAME_FROM_VEHICLE_MODEL"
hash "0xF7AF4F159FF99F97"
arguments {
Hash "modelHash" [=[ {} ]=],
}
alias "_GET_MAKE_NAME_FROM_VEHICLE_MODEL"
ns "VEHICLE"
returns "charPtr"
doc [[!
Retrieves the manufacturer's name for a specified vehicle.
```
NativeDB Introduced: v1868
```
The model hash of the vehicle.
Returns the display label of the manufacturer if the vehicle model is recognized, or "CARNOTFOUND" if the hash does not correspond to any known vehicle model.
]]
native "GET_MOD_SLOT_NAME"
hash "0x51F0FEB9F6AE98C0"
jhash (0x5E113483)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "modType" [=[ {} ]=],
}
ns "VEHICLE"
returns "charPtr"
doc [[!
Refer to eVehicleModType in [`SET_VEHICLE_MOD`](#\_0x6AF0636DDEDCB6DD).
]]
native "GET_MOD_TEXT_LABEL"
hash "0x8935624F8C5592CC"
jhash (0x0BA39CA7)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "modType" [=[ {} ]=],
int "modValue" [=[ {} ]=],
}
ns "VEHICLE"
returns "charPtr"
doc [[!
```
Returns the text label of a mod type for a given vehicle
Use _GET_LABEL_TEXT to get the part name in the game's language
```
Refer to eVehicleModType in [`SET_VEHICLE_MOD`](#\_0x6AF0636DDEDCB6DD).
]]
native "GET_NUM_MOD_COLORS"
hash "0xA551BE18C11A476D"
jhash (0x73722CD9)
arguments {
int "paintType" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "VEHICLE"
returns "int"
doc [[!
```
paintType:
0: Normal
1: Metallic
2: Pearl
3: Matte
4: Metal
5: Chrome
```
]]
native "GET_NUM_MOD_KITS"
hash "0x33F2E3FE70EAAE1D"
jhash (0xE4903AA0)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "int"
doc [[!
]]
native "GET_NUM_VEHICLE_MODS"
hash "0xE38E9162A2500646"
jhash (0x8A814FF9)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "modType" [=[ {} ]=],
}
ns "VEHICLE"
returns "int"
doc [[!
```
Returns how many possible mods a vehicle has for a given mod type
```
Refer to eVehicleModType in [`SET_VEHICLE_MOD`](#\_0x6AF0636DDEDCB6DD).
]]
native "GET_NUM_VEHICLE_WINDOW_TINTS"
hash "0x9D1224004B3A6707"
jhash (0x625C7B66)
ns "VEHICLE"
returns "int"
doc [[!
]]
native "GET_NUMBER_OF_VEHICLE_COLOURS"
hash "0x3B963160CD65D41E"
jhash (0xF2442EE2)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "int"
doc [[!
```
Actually number of color combinations
```
]]
native "GET_NUMBER_OF_VEHICLE_NUMBER_PLATES"
hash "0x4C4D6B2644F458CB"
jhash (0xD24BC1AE)
ns "VEHICLE"
returns "int"
doc [[!
```
Returns the number of *types* of licence plates, enumerated below in SET_VEHICLE_NUMBER_PLATE_TEXT_INDEX.
```
]]
native "GET_PED_IN_VEHICLE_SEAT"
hash "0xBB40DD2270B65366"
jhash (0x388FDE9A)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "seatIndex" [=[ {} ]=],
}
ns "VEHICLE"
returns "Ped"
doc [[!
Gets the ped in the specified seat of the passed vehicle.
If there is no ped in the seat, and the game considers the vehicle as ambient population, this will create a random occupant ped in the seat, which may be cleaned up by the game fairly soon if not marked as script-owned mission entity.
**NativeDB Added Parameter 3**: BOOL p2 (uses a different GetOccupant function)
The vehicle to get the ped for.
See eSeatPosition declared in [`IS_VEHICLE_SEAT_FREE`](#\_0x22AC59A870E6A669).
A handle to a ped in the specified vehicle seat, or 0 if no such ped existed.
]]
native "GET_PED_USING_VEHICLE_DOOR"
hash "0x218297BF0CFD853B"
jhash (0x0630101F)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "doorIndex" [=[ {} ]=],
}
alias "0x218297BF0CFD853B"
alias "_GET_PED_USING_VEHICLE_DOOR"
ns "VEHICLE"
returns "Ped"
doc [[!
See eDoorId declared in [`SET_VEHICLE_DOOR_SHUT`](#\_0x93D9BD300D7789E5)
]]
native "GET_POSITION_IN_RECORDING"
hash "0x2DACD605FC681475"
jhash (0x7DCD644C)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "float"
doc [[!
```
Distance traveled in the vehicles current recording.
```
]]
native "GET_POSITION_OF_VEHICLE_RECORDING_AT_TIME"
hash "0xD242728AA6F0FBA2"
jhash (0x7178558D)
arguments {
int "recording" [=[ {} ]=],
float "time" [=[ {} ]=],
charPtr "script" [=[ {} ]=],
}
ns "VEHICLE"
returns "Vector3"
doc [[!
This native does no interpolation between pathpoints. The same position will be returned for all times up to the next pathpoint in the recording.
See [`REQUEST_VEHICLE_RECORDING`](#\_0xAF514CABE74CBF15).
]]
native "GET_POSITION_OF_VEHICLE_RECORDING_ID_AT_TIME"
hash "0x92523B76657A517D"
jhash (0xF31973BB)
arguments {
int "id" [=[ {} ]=],
float "time" [=[ {} ]=],
}
alias "0x92523B76657A517D"
ns "VEHICLE"
annotations [=[ {"cs_type":"int"} ]=]
returns "Vector3"
doc [[!
]]
native "GET_RANDOM_VEHICLE_BACK_BUMPER_IN_SPHERE"
hash "0xB50807EABE20A8DC"
jhash (0xD6343F6B)
arguments {
float "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
int "p4" [=[ {} ]=],
int "p5" [=[ {} ]=],
int "p6" [=[ {} ]=],
}
ns "VEHICLE"
returns "Vehicle"
doc [[!
]]
native "GET_RANDOM_VEHICLE_FRONT_BUMPER_IN_SPHERE"
hash "0xC5574E0AEB86BA68"
jhash (0xDCADEB66)
arguments {
float "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
int "p4" [=[ {} ]=],
int "p5" [=[ {} ]=],
int "p6" [=[ {} ]=],
}
ns "VEHICLE"
returns "Vehicle"
doc [[!
]]
native "GET_RANDOM_VEHICLE_IN_SPHERE"
hash "0x386F6CE5BAF6091C"
jhash (0x57216D03)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "radius" [=[ {} ]=],
Hash "modelHash" [=[ {} ]=],
int "flags" [=[ {} ]=],
}
ns "VEHICLE"
returns "Vehicle"
doc [[!
```
Gets a random vehicle in a sphere at the specified position, of the specified radius.
x: The X-component of the position of the sphere.
y: The Y-component of the position of the sphere.
z: The Z-component of the position of the sphere.
radius: The radius of the sphere. Max is 9999.9004.
modelHash: The vehicle model to limit the selection to. Pass 0 for any model.
flags: The bitwise flags that modifies the behaviour of this function.
```
]]
native "GET_RANDOM_VEHICLE_MODEL_IN_MEMORY"
hash "0x055BF0AC0C34F4FD"
jhash (0xE2C45631)
arguments {
BOOL "p0" [=[ {} ]=],
HashPtr "modelHash" [=[ {} ]=],
intPtr "successIndicator" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
Not present in the retail version! It's just a nullsub.
p0 always true (except in one case)
p1 a random vehicle hash loaded in memory
successIndicator: 0 if success, -1 if failed
```
]]
native "GET_ROTATION_OF_VEHICLE_RECORDING_AT_TIME"
hash "0x2058206FBE79A8AD"
jhash (0xD96DEC68)
arguments {
int "recording" [=[ {} ]=],
float "time" [=[ {} ]=],
charPtr "script" [=[ {"cs_type":"AnyPtr"} ]=],
}
ns "VEHICLE"
annotations [=[ {"cs_type":"int"} ]=]
returns "Vector3"
doc [[!
]]
native "GET_ROTATION_OF_VEHICLE_RECORDING_ID_AT_TIME"
hash "0xF0F2103EFAF8CBA7"
jhash (0x4D1C15C2)
arguments {
int "id" [=[ {} ]=],
float "time" [=[ {} ]=],
}
alias "0xF0F2103EFAF8CBA7"
ns "VEHICLE"
returns "Vector3"
doc [[!
]]
native "GET_SUBMARINE_IS_UNDER_DESIGN_DEPTH"
hash "0x3E71D0B300B7AA79"
arguments {
Vehicle "submarine" [=[ {} ]=],
}
alias "_GET_SUBMARINE_IS_BELOW_FIRST_CRUSH_DEPTH"
ns "VEHICLE"
returns "BOOL"
doc [[!
Determines if the submarine is operating below its designated crush depth.
```
NativeDB Introduced: v2189
```
The submarine vehicle to be evaluated for being under its crush depth threshold.
Returns `true` if the submarine is below its designated crush depth, `false` otherwise.
]]
native "GET_SUBMARINE_NUMBER_OF_AIR_LEAKS"
hash "0x093D6DDCA5B8FBAE"
arguments {
Vehicle "submarine" [=[ {} ]=],
}
alias "_GET_SUBMARINE_CRUSH_DEPTH_WARNING_STATE"
ns "VEHICLE"
returns "int"
doc [[!
Checks if a Submarine has any air leaks, when there is more than 4 the player will drown.
```
NativeDB Introduced: v2189
```
The submarine vehicle to check for air leaks.
Returns the number of air leaks on the submarine.
]]
native "GET_TIME_POSITION_IN_RECORDING"
hash "0x5746F3A7AB7FE544"
jhash (0xF8C3E4A2)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "float"
doc [[!
```
Can be used with GET_TOTAL_DURATION_OF_VEHICLE_RECORDING{_ID} to compute a percentage.
```
]]
native "GET_TOTAL_DURATION_OF_VEHICLE_RECORDING"
hash "0x0E48D1C262390950"
jhash (0x5B35EEB7)
arguments {
int "recording" [=[ {} ]=],
charPtr "script" [=[ {"cs_type":"Any"} ]=],
}
ns "VEHICLE"
annotations [=[ {"cs_type":"Any"} ]=]
returns "float"
doc [[!
]]
native "GET_TOTAL_DURATION_OF_VEHICLE_RECORDING_ID"
hash "0x102D125411A7B6E6"
jhash (0x7116785E)
arguments {
int "id" [=[ {} ]=],
}
ns "VEHICLE"
returns "float"
doc [[!
]]
native "GET_TRAIN_CARRIAGE"
hash "0x08AAFD0814722BC3"
jhash (0x2544E7A6)
arguments {
Vehicle "train" [=[ {} ]=],
int "trailerNumber" [=[ {} ]=],
}
ns "VEHICLE"
returns "Entity"
doc [[!
```
Corrected p1. it's basically the 'carriage/trailer number'. So if the train has 3 trailers you'd call the native once with a var or 3 times with 1, 2, 3.
```
]]
native "GET_VEHICLE_ACCELERATION"
hash "0x5DD35C8D074E57AE"
jhash (0x00478321)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "float"
doc [[!
Retrieves a static value representing the maximum drive force of specific a vehicle, including any vehicle mods. This value does not change dynamically during gameplay. This value provides an approximation and should be considered alongside other performance metrics like top speed for a more comprehensive understanding of the vehicle's capabilities.
```
NativeDB Introduced: v323
```
The vehicle for which to obtain the acceleration.
Returns the acceleration value of the specified vehicle as a float number.
]]
native "GET_VEHICLE_ATTACHED_TO_CARGOBOB"
hash "0x873B82D42AC2B9E5"
jhash (0x301A1D24)
arguments {
Vehicle "cargobob" [=[ {} ]=],
}
ns "VEHICLE"
returns "Vehicle"
doc [[!
```
Returns attached vehicle (Vehicle in parameter must be cargobob)
```
]]
native "GET_VEHICLE_BODY_HEALTH"
hash "0xF271147EB7B40F12"
jhash (0x2B2FCC28)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "float"
doc [[!
```
Seems related to vehicle health, like the one in IV.
Max 1000, min 0.
Vehicle does not necessarily explode or become undrivable at 0.
```
]]
native "GET_VEHICLE_CAUSE_OF_DESTRUCTION"
hash "0xE495D1EF4C91FD20"
jhash (0x7F8C20DD)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "Hash"
doc [[!
The vehicle to get the cause of destruction of.
A hash representing the destruction cause. These can be weapon hashes.
]]
native "GET_VEHICLE_CLASS"
hash "0x29439776AAA00A62"
jhash (0xC025338E)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "int"
doc [[!
```
Returns an int
Vehicle Classes:
0: Compacts
1: Sedans
2: SUVs
3: Coupes
4: Muscle
5: Sports Classics
6: Sports
7: Super
8: Motorcycles
9: Off-road
10: Industrial
11: Utility
12: Vans
13: Cycles
14: Boats
15: Helicopters
16: Planes
17: Service
18: Emergency
19: Military
20: Commercial
21: Trains
22: Open Wheel
char buffer[128];
std::sprintf(buffer, "VEH_CLASS_%i", VEHICLE::GET_VEHICLE_CLASS(vehicle));
char* className = UI::_GET_LABEL_TEXT(buffer);
```
]]
native "GET_VEHICLE_CLASS_ESTIMATED_MAX_SPEED"
hash "0x00C09F246ABEDD82"
jhash (0xCE67162C)
arguments {
int "vehicleClass" [=[ {} ]=],
}
alias "0x00C09F246ABEDD82"
alias "_GET_VEHICLE_CLASS_MAX_SPEED"
ns "VEHICLE"
returns "float"
doc [[!
]]
native "GET_VEHICLE_CLASS_FROM_NAME"
hash "0xDEDF1C8BD47C2200"
jhash (0xEA469980)
arguments {
Hash "modelHash" [=[ {} ]=],
}
ns "VEHICLE"
returns "int"
doc [[!
```
For a full enum, see here : pastebin.com/i2GGAjY0
char buffer[128];
std::sprintf(buffer, "VEH_CLASS_%i", VEHICLE::GET_VEHICLE_CLASS_FROM_NAME (hash));
const char* className = HUD::_GET_LABEL_TEXT(buffer);
```
]]
native "GET_VEHICLE_CLASS_MAX_ACCELERATION"
hash "0x2F83E7E45D9EA7AE"
jhash (0x3E220A9B)
arguments {
int "vehicleClass" [=[ {} ]=],
}
ns "VEHICLE"
returns "float"
doc [[!
]]
native "GET_VEHICLE_CLASS_MAX_AGILITY"
hash "0x4F930AD022D6DE3B"
jhash (0x45F2BD83)
arguments {
int "vehicleClass" [=[ {} ]=],
}
ns "VEHICLE"
returns "float"
doc [[!
]]
native "GET_VEHICLE_CLASS_MAX_BRAKING"
hash "0x4BF54C16EC8FEC03"
jhash (0xD08CC1A5)
arguments {
int "vehicleClass" [=[ {} ]=],
}
ns "VEHICLE"
returns "float"
doc [[!
]]
native "GET_VEHICLE_CLASS_MAX_TRACTION"
hash "0xDBC86D85C5059461"
jhash (0x5B4FDC16)
arguments {
int "vehicleClass" [=[ {} ]=],
}
ns "VEHICLE"
returns "float"
doc [[!
]]
native "GET_VEHICLE_COLOR"
hash "0xF3CC740D36221548"
jhash (0x03BC8F1B)
arguments {
Vehicle "vehicle" [=[ {} ]=],
intPtr "r" [=[ {} ]=],
intPtr "g" [=[ {} ]=],
intPtr "b" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
See [`SET_VEHICLE_CUSTOM_PRIMARY_COLOUR`](#\_0x7141766F91D15BEA) and [`SET_VEHICLE_CUSTOM_SECONDARY_COLOUR`](#\_0x36CED73BFED89754).
The target vehicle
]]
native "GET_VEHICLE_COLOUR_COMBINATION"
hash "0x6A842D197F845D56"
jhash (0x77AC1B4C)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "int"
doc [[!
]]
native "GET_VEHICLE_COLOURS"
hash "0xA19435F193E081AC"
jhash (0x40D82D88)
arguments {
Vehicle "vehicle" [=[ {} ]=],
intPtr "colorPrimary" [=[ {} ]=],
intPtr "colorSecondary" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "GET_VEHICLE_COLOURS_WHICH_CAN_BE_SET"
hash "0xEEBFC7A7EFDC35B4"
jhash (0x749DEEA2)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0xEEBFC7A7EFDC35B4"
ns "VEHICLE"
returns "int"
doc [[!
```cpp
enum eColourBitField {
HAS_BODY_COLOUR1 = 1,
HAS_BODY_COLOUR2 = 2,
HAS_BODY_COLOUR3 = 4,
HAS_BODY_COLOUR4 = 8,
HAS_BODY_COLOUR5 = 16
}
```
The vehicle handle
Returns a bitfield of the colours supported by the vehicle's shader.
]]
native "GET_VEHICLE_CUSTOM_PRIMARY_COLOUR"
hash "0xB64CF2CCA9D95F52"
jhash (0x1C2B9FEF)
arguments {
Vehicle "vehicle" [=[ {} ]=],
intPtr "r" [=[ {} ]=],
intPtr "g" [=[ {} ]=],
intPtr "b" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "GET_VEHICLE_CUSTOM_SECONDARY_COLOUR"
hash "0x8389CD56CA8072DC"
jhash (0x3FF247A2)
arguments {
Vehicle "vehicle" [=[ {} ]=],
intPtr "r" [=[ {} ]=],
intPtr "g" [=[ {} ]=],
intPtr "b" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "GET_VEHICLE_DEFORMATION_AT_POS"
hash "0x4EC6CFBC7B2E9536"
jhash (0xABF02075)
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "offsetX" [=[ {} ]=],
float "offsetY" [=[ {} ]=],
float "offsetZ" [=[ {} ]=],
}
ns "VEHICLE"
returns "Vector3"
doc [[!
```
The only example I can find of this function in the scripts, is this:
struct _s = VEHICLE::GET_VEHICLE_DEFORMATION_AT_POS(rPtr((A_0) + 4), 1.21f, 6.15f, 0.3f);
-----------------------------------------------------------------------------------------------------------------------------------------
PC scripts:
v_5/*{3}*/ = VEHICLE::GET_VEHICLE_DEFORMATION_AT_POS(a_0._f1, 1.21, 6.15, 0.3);
```
]]
native "GET_VEHICLE_DIRT_LEVEL"
hash "0x8F17BC8BA08DA62B"
jhash (0xFD15C065)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "float"
doc [[!
A getter for [`SET_VEHICLE_DIRT_LEVEL`](#\_0x79D3B596FE44EE8B).
The vehicle to check.
A number between 0.0 and 15.0 representing the vehicles dirt level.
]]
native "GET_VEHICLE_DOOR_ANGLE_RATIO"
hash "0xFE3F9C29F7B32BD5"
jhash (0x0E399C26)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "doorIndex" [=[ {} ]=],
}
ns "VEHICLE"
returns "float"
doc [[!
Checks the angle of the door mapped from 0.0 - 1.0 where 0.0 is fully closed and 1.0 is fully open.
See eDoorId declared in [`SET_VEHICLE_DOOR_SHUT`](#\_0x93D9BD300D7789E5)
Vehicle
Index of door to check
A float representing angle of door mapped from 0.0 to 1.0
]]
native "GET_VEHICLE_DOOR_LOCK_STATUS"
hash "0x25BC98A59C2EA962"
jhash (0x0D72CEF2)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "int"
doc [[!
Returns the current lock status, refer to [SET_VEHICLE_DOORS_LOCKED](#\_0xB664292EAECF7FA6)
]]
native "GET_VEHICLE_DOORS_LOCKED_FOR_PLAYER"
hash "0xF6AF6CB341349015"
jhash (0x1DC50247)
arguments {
Vehicle "vehicle" [=[ {} ]=],
Player "player" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "GET_VEHICLE_ENGINE_HEALTH"
hash "0xC45D23BAF168AAB8"
jhash (0x8880038A)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "float"
doc [[!
```
Returns 1000.0 if the function is unable to get the address of the specified vehicle or if it's not a vehicle.
Minimum: -4000
Maximum: 1000
-4000: Engine is destroyed
0 and below: Engine catches fire and health rapidly declines
300: Engine is smoking and losing functionality
1000: Engine is perfect
```
]]
native "GET_VEHICLE_ENVEFF_SCALE"
hash "0xA82819CAC9C4C403"
jhash (0xD5F1EEE1)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "_GET_VEHICLE_PAINT_FADE"
ns "VEHICLE"
returns "float"
doc [[!
```
formerly known as _GET_VEHICLE_PAINT_FADE
The result is a value from 0-1, where 0 is fresh paint.
```
]]
native "GET_VEHICLE_ESTIMATED_MAX_SPEED"
hash "0x53AF99BAA671CA47"
jhash (0x7D1A0616)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0x53AF99BAA671CA47"
alias "_GET_VEHICLE_MAX_SPEED"
ns "VEHICLE"
returns "float"
doc [[!
Retrieves a static value representing the estimated max speed of a specific vehicle, including any vehicle mods. This value does not change dynamically during gameplay.
```
NativeDB Introduced: v323
```
The vehicle for which to obtain the estimated max speed.
Returns the estimated maximum speed of the specified vehicle as a float number.
]]
native "GET_VEHICLE_EXTRA_COLOURS"
hash "0x3BC4245933A166F7"
jhash (0x80E4659B)
arguments {
Vehicle "vehicle" [=[ {} ]=],
intPtr "pearlescentColor" [=[ {} ]=],
intPtr "wheelColor" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "GET_VEHICLE_FLIGHT_NOZZLE_POSITION"
hash "0xDA62027C8BDB326E"
jhash (0xAD40AD55)
arguments {
Vehicle "aircraft" [=[ {} ]=],
}
alias "0xDA62027C8BDB326E"
alias "_GET_PLANE_HOVER_MODE_PERCENTAGE"
alias "_GET_VEHICLE_HOVER_MODE_PERCENTAGE"
alias "_GET_PLANE_VTOL_DIRECTION"
ns "VEHICLE"
returns "float"
doc [[!
The vehicle to check the hover mode on.
A float indicating the percentage of the hover mode. 1.0 = in VTOL mode, 0.0 = in normal flying mode.
]]
native "GET_VEHICLE_HAS_KERS"
hash "0x50634E348C8D44EF"
jhash (0x0761E635)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0x50634E348C8D44EF"
alias "_HAS_VEHICLE_KERS_BOOST"
ns "VEHICLE"
returns "BOOL"
doc [[!
The vehicle handle.
Returns true if the vehicle has a kers boost (for instance the lectro or the vindicator)
]]
native "GET_VEHICLE_HEALTH_PERCENTAGE"
hash "0xB8EF61207C2393A9"
jhash (0x196BA503)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "_GET_VEHICLE_BODY_HEALTH_2"
ns "VEHICLE"
returns "float"
doc [[!
```
NativeDB Added Parameter 2: float maxEngineHealth
NativeDB Added Parameter 3: float maxPetrolTankHealth
NativeDB Added Parameter 4: float maxBodyHealth
NativeDB Added Parameter 5: float maxMainRotorHealth
NativeDB Added Parameter 6: float maxTailRotorHealth
NativeDB Added Parameter 7: float maxUnkHealth
```
]]
native "GET_VEHICLE_HOMING_LOCKON_STATE"
hash "0xE6B0E8CFC3633BF0"
jhash (0xFBDE9FD8)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0xE6B0E8CFC3633BF0"
ns "VEHICLE"
returns "int"
doc [[!
```
Returns a value depending on the lock-on state of vehicle weapons.
0: not locked on
1: locking on
2: locked on
```
]]
native "GET_VEHICLE_INDIVIDUAL_DOOR_LOCK_STATUS"
hash "0xCA4AC3EAAE46EC7B"
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "doorIndex" [=[ {} ]=],
}
alias "0xCA4AC3EAAE46EC7B"
alias "_GET_VEHICLE_DOOR_DESTROY_TYPE"
ns "VEHICLE"
returns "int"
doc [[!
See eDoorId declared in [`SET_VEHICLE_DOOR_SHUT`](#\_0x93D9BD300D7789E5)
Returns vehicle door lock state previously set with [`SET_VEHICLE_INDIVIDUAL_DOORS_LOCKED`](#\_0xBE70724027F85BCD)
]]
native "GET_VEHICLE_IS_MERCENARY"
hash "0xD4C4642CB7F50B5D"
jhash (0x575504DE)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0xD4C4642CB7F50B5D"
ns "VEHICLE"
returns "BOOL"
doc [[!
Returns whether the specified vehicle is designated as a mercenary vehicle
The vehicle to check for mercenary status.
Returns `true` if the vehicle is a mercenary vehicle, `false` otherwise.
]]
native "GET_VEHICLE_LAYOUT_HASH"
hash "0x28D37D4F71AC5C58"
jhash (0xE0B35187)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "Hash"
doc [[!
]]
native "GET_VEHICLE_LIGHTS_STATE"
hash "0xB91B4C20085BD12F"
jhash (0x7C278621)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOLPtr "lightsOn" [=[ {} ]=],
BOOLPtr "highbeamsOn" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "GET_VEHICLE_LIVERY"
hash "0x2BB9230590DA5E8A"
jhash (0xEC82A51D)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "int"
doc [[!
```
-1 = no livery
```
]]
native "GET_VEHICLE_LIVERY_COUNT"
hash "0x87B63E25A529D526"
jhash (0xFB0CA947)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "int"
doc [[!
```
Returns -1 if the vehicle has no livery
```
]]
native "GET_VEHICLE_LOCK_ON_TARGET"
hash "0x8F5EBAB1F260CFCE"
jhash (0x4A557117)
arguments {
Vehicle "vehicle" [=[ {} ]=],
EntityPtr "entity" [=[ {} ]=],
}
alias "_GET_VEHICLE_OWNER"
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "GET_VEHICLE_MAX_BRAKING"
hash "0xAD7E85FC227197C4"
jhash (0x03B926F6)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "float"
doc [[!
]]
native "GET_VEHICLE_MAX_NUMBER_OF_PASSENGERS"
hash "0xA7C4F2C6E744A550"
jhash (0x0A2FC08C)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "int"
doc [[!
]]
native "GET_VEHICLE_MAX_TRACTION"
hash "0xA132FB5370554DB0"
jhash (0x7E5A1587)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "float"
doc [[!
]]
native "GET_VEHICLE_MOD"
hash "0x772960298DA26FDB"
jhash (0xDC520069)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "modType" [=[ {} ]=],
}
ns "VEHICLE"
returns "int"
doc [[!
The vehicle to get the mod of.
Refer to eVehicleModType in [`SET_VEHICLE_MOD`](#\_0x6AF0636DDEDCB6DD).
Returns the current modIndex, or `-1` if the mod is stock.
]]
native "GET_VEHICLE_MOD_COLOR_1"
hash "0xE8D65CA700C9A693"
jhash (0xE625510A)
arguments {
Vehicle "vehicle" [=[ {} ]=],
intPtr "paintType" [=[ {} ]=],
intPtr "color" [=[ {} ]=],
intPtr "pearlescentColor" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "GET_VEHICLE_MOD_COLOR_1_NAME"
hash "0xB45085B721EFD38C"
jhash (0x9A0840FD)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
alias "0xB45085B721EFD38C"
ns "VEHICLE"
returns "charPtr"
doc [[!
```
returns a string which is the codename of the vehicle's currently selected primary color
p1 is always 0
```
]]
native "GET_VEHICLE_MOD_COLOR_2"
hash "0x81592BE4E3878728"
jhash (0x9B76BB8E)
arguments {
Vehicle "vehicle" [=[ {} ]=],
intPtr "paintType" [=[ {} ]=],
intPtr "color" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "GET_VEHICLE_MOD_COLOR_2_NAME"
hash "0x4967A516ED23A5A1"
jhash (0x9BDC0B49)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0x4967A516ED23A5A1"
ns "VEHICLE"
returns "charPtr"
doc [[!
```
returns a string which is the codename of the vehicle's currently selected secondary color
```
]]
native "GET_VEHICLE_MOD_IDENTIFIER_HASH"
hash "0x4593CF82AA179706"
jhash (0x94850968)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "modType" [=[ {} ]=],
int "modIndex" [=[ {} ]=],
}
alias "0x4593CF82AA179706"
alias "_GET_VEHICLE_MOD_DATA"
ns "VEHICLE"
annotations [=[ {"cs_type":"Any"} ]=]
returns "Hash"
doc [[!
```
Can be used for IS_DLC_VEHICLE_MOD and _0xC098810437312FFF
```
Refer to eVehicleModType in [`SET_VEHICLE_MOD`](#\_0x6AF0636DDEDCB6DD).
]]
native "GET_VEHICLE_MOD_KIT"
hash "0x6325D1A044AE510D"
jhash (0x9FE60927)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "int"
doc [[!
]]
native "GET_VEHICLE_MOD_KIT_TYPE"
hash "0xFC058F5121E54C32"
jhash (0xE5F76765)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "int"
doc [[!
]]
native "GET_VEHICLE_MOD_MODIFIER_VALUE"
hash "0x90A38E9838E0A8C1"
jhash (0x73AE5505)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "modType" [=[ {} ]=],
int "modIndex" [=[ {} ]=],
}
ns "VEHICLE"
annotations [=[ {"cs_type":"float"} ]=]
returns "int"
doc [[!
Refer to eVehicleModType in [`SET_VEHICLE_MOD`](#\_0x6AF0636DDEDCB6DD).
]]
native "GET_VEHICLE_MOD_VARIATION"
hash "0xB3924ECD70E095DC"
jhash (0xC1B92003)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "modType" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
```
Only used for wheels(ModType = 23/24) Returns true if the wheels are custom wheels
```
Refer to eVehicleModType in [`SET_VEHICLE_MOD`](#\_0x6AF0636DDEDCB6DD).
]]
native "GET_VEHICLE_MODEL_ACCELERATION"
hash "0x8C044C5C84505B6A"
jhash (0x29CB3537)
arguments {
Hash "modelHash" [=[ {} ]=],
}
ns "VEHICLE"
returns "float"
doc [[!
Returns the acceleration of the specified model.
]]
native "GET_VEHICLE_MODEL_ESTIMATED_MAX_SPEED"
hash "0xF417C2502FFFED43"
jhash (0x8F291C4A)
arguments {
Hash "modelHash" [=[ {} ]=],
}
alias "_GET_VEHICLE_MODEL_MAX_SPEED"
ns "VEHICLE"
returns "float"
doc [[!
```
Returns max speed (without mods) of the specified vehicle model in m/s.
```
]]
native "GET_VEHICLE_MODEL_MAX_BRAKING"
hash "0xDC53FD41B4ED944C"
jhash (0x7EF02883)
arguments {
Hash "modelHash" [=[ {} ]=],
}
ns "VEHICLE"
returns "float"
doc [[!
```
Returns max braking of the specified vehicle model.
```
]]
native "GET_VEHICLE_MODEL_MAX_BRAKING_MAX_MODS"
hash "0xBFBA3BA79CFF7EBF"
jhash (0xF3A7293F)
arguments {
Hash "modelHash" [=[ {} ]=],
}
alias "0xBFBA3BA79CFF7EBF"
alias "_GET_VEHICLE_MODEL_HAND_BRAKE"
ns "VEHICLE"
returns "float"
doc [[!
]]
native "GET_VEHICLE_MODEL_MAX_TRACTION"
hash "0x539DE94D44FDFD0D"
jhash (0x7F985597)
arguments {
Hash "modelHash" [=[ {} ]=],
}
ns "VEHICLE"
returns "float"
doc [[!
```
Returns max traction of the specified vehicle model.
```
]]
native "GET_VEHICLE_MODEL_NUMBER_OF_SEATS"
hash "0x2AD93716F184EDA4"
jhash (0x838F7BF7)
arguments {
Hash "modelHash" [=[ {} ]=],
}
alias "_GET_VEHICLE_MODEL_MAX_NUMBER_OF_PASSENGERS"
ns "VEHICLE"
returns "int"
doc [[!
```
Returns max number of passengers (including the driver) for the specified vehicle model.
```
]]
native "GET_VEHICLE_MODEL_VALUE"
hash "0x5873C14A52D74236"
jhash (0x58FEFC3D)
arguments {
Hash "vehicleModel" [=[ {"cs_type":"Any"} ]=],
}
alias "0x5873C14A52D74236"
alias "_GET_VEHICLE_MODEL_MONETARY_VALUE"
ns "VEHICLE"
returns "int"
doc [[!
```
Returns `nMonetaryValue` from handling.meta for specific model, which is the vehicle's monetary value.
```
]]
native "GET_VEHICLE_NUMBER_OF_PASSENGERS"
hash "0x24CB2137731FFE89"
jhash (0x1EF20849)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "int"
doc [[!
```
Gets the number of passengers, NOT including the driver. Use IS_VEHICLE_SEAT_FREE(Vehicle, -1) to also check for the driver
```
]]
native "GET_VEHICLE_NUMBER_PLATE_TEXT"
hash "0x7CE1CCB9B293020E"
jhash (0xE8522D58)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "charPtr"
doc [[!
```
Returns the license plate text from a vehicle. 8 chars maximum.
```
]]
native "GET_VEHICLE_NUMBER_PLATE_TEXT_INDEX"
hash "0xF11BC2DD9A3E7195"
jhash (0x499747B6)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "int"
doc [[!
```cpp
enum eVehiclePlateIndicies {
SanAndreasCursive = 0,
SanAndreasBlack = 1,
SanAndreasBlue = 2,
SanAndreasPlain = 3,
SRExcept = 4,
NorthYankton = 5,
// All indicies below this require b3095
ECola = 6,
LasVenturas = 7,
LiberyCity = 8,
LSCarMeet = 9,
LSPanic = 10,
LSPounders = 11,
Sprunk = 12,
}
```
The vehicle to get the plate index of
Returns the plate index, reference `eVehiclePlateIndicies`
]]
native "GET_VEHICLE_PETROL_TANK_HEALTH"
hash "0x7D5DABE888D2D074"
jhash (0xE41595CE)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "float"
doc [[!
```
1000 is max health
Begins leaking gas at around 650 health
```
]]
native "GET_VEHICLE_PLATE_TYPE"
hash "0x9CCC9525BF2408E0"
jhash (0x65CA9286)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "int"
doc [[!
Returns the plates a vehicle has.
```cpp
enum eVehiclePlateType
{
VPT_FRONT_AND_BACK_PLATES = 0,
VPT_FRONT_PLATES = 1,
VPT_BACK_PLATES = 2,
VPT_NONE = 3,
};
```
Motorcycles with no visible plates will sometimes return a 2 for unknown reasons.
Returns the vehicle plate type, refer to `eVehiclePlateType`
]]
native "GET_VEHICLE_RECORDING_ID"
hash "0x21543C612379DB3C"
jhash (0x328D601D)
arguments {
int "recording" [=[ {} ]=],
charPtr "script" [=[ {} ]=],
}
ns "VEHICLE"
returns "int"
doc [[!
See [`REQUEST_VEHICLE_RECORDING`](#\_0xAF514CABE74CBF15).
]]
native "GET_VEHICLE_TRAILER_VEHICLE"
hash "0x1CDD6BADC297830D"
jhash (0xAE84D758)
arguments {
Vehicle "vehicle" [=[ {} ]=],
VehiclePtr "trailer" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
```
Gets the trailer of a vehicle and puts it into the trailer parameter.
```
]]
native "GET_VEHICLE_TYRE_SMOKE_COLOR"
hash "0xB635392A4938B3C3"
jhash (0x75280015)
arguments {
Vehicle "vehicle" [=[ {} ]=],
intPtr "r" [=[ {} ]=],
intPtr "g" [=[ {} ]=],
intPtr "b" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "GET_VEHICLE_TYRES_CAN_BURST"
hash "0x678B9BB8C3F58FEB"
jhash (0x4D76CD2F)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "GET_VEHICLE_WEAPON_RESTRICTED_AMMO"
hash "0x8181CE2F25CB9BB7"
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "weaponIndex" [=[ {} ]=],
}
alias "0x8181CE2F25CB9BB7"
alias "_GET_VEHICLE_WEAPON_CAPACITY"
ns "VEHICLE"
returns "int"
doc [[!
The vehicle handle
The weapon index we're getting ammo for (see [SET_VEHICLE_WEAPON_RESTRICTED_AMMO](#\_0x44CD1F493DB2A0A6) for information on how to access these slots).
Gets the current restricted ammo count for a particular vehicle weapon index on a vehicle.
]]
native "GET_VEHICLE_WHEEL_TYPE"
hash "0xB3ED1BFB4BE636DC"
jhash (0xDA58D7AE)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "int"
doc [[!
```cpp
enum eVehicleWheelType
{
VWT_SPORT = 0,
VWT_MUSCLE = 1,
VWT_LOWRIDER = 2,
VWT_SUV = 3,
VWT_OFFROAD = 4,
VWT_TUNER = 5,
VWT_BIKE = 6,
VWT_HIEND = 7,
// Benny's Original
VWT_SUPERMOD1 = 8,
// Benny's Bespoke
VWT_SUPERMOD2 = 9,
// Open Wheel
VWT_SUPERMOD3 = 10,
// Street
VWT_SUPERMOD4 = 11,
// Track
VWT_SUPERMOD5 = 12,
};
```
Returns an eVehicleWheelType integer value.
]]
native "GET_VEHICLE_WINDOW_TINT"
hash "0x0EE21293DAD47C95"
jhash (0x13D53892)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "int"
doc [[!
]]
native "HAS_PRELOAD_MODS_FINISHED"
hash "0x06F43E5175EB6D96"
jhash (0xA8A0D246)
arguments {
Any "p0" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "HAS_VEHICLE_ASSET_LOADED"
hash "0x1BBE0523B8DB9A21"
jhash (0x8DAAC3CB)
arguments {
int "vehicleAsset" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "HAS_VEHICLE_PHONE_EXPLOSIVE_DEVICE"
hash "0x6ADAABD3068C5235"
jhash (0xA4E69134)
alias "0x6ADAABD3068C5235"
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "HAS_VEHICLE_RECORDING_BEEN_LOADED"
hash "0x300D614A4C785FC4"
jhash (0xF52CD7F5)
arguments {
int "recording" [=[ {} ]=],
charPtr "script" [=[ {"cs_type":"AnyPtr"} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "HAVE_VEHICLE_MODS_STREAMED_IN"
hash "0x9A83F5F9963775EF"
jhash (0x112D637A)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0x9A83F5F9963775EF"
alias "_IS_VEHICLE_MOD_LOAD_DONE"
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "INSTANTLY_FILL_VEHICLE_POPULATION"
hash "0x48ADC8A773564670"
jhash (0x37BC6ACB)
alias "0x48ADC8A773564670"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "IS_ANY_ENTITY_ATTACHED_TO_HANDLER_FRAME"
hash "0x62CA17B74C435651"
jhash (0x593143B9)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0x62CA17B74C435651"
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "IS_ANY_PED_RAPPELLING_FROM_HELI"
hash "0x291E373D483E7EE7"
jhash (0xD656E7E5)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0x291E373D483E7EE7"
alias "_ANY_PASSENGERS_RAPPELING"
alias "_IS_ANY_PASSENGER_RAPPELING_FROM_VEHICLE"
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "IS_ANY_VEHICLE_NEAR_POINT"
hash "0x61E1DD6125A3EEE6"
jhash (0x2867A834)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "radius" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "IS_BIG_VEHICLE"
hash "0x9F243D3919F442FE"
jhash (0x9CDBA8DE)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "IS_BOAT_ANCHORED"
hash "0xB0AD1238A709B1A2"
arguments {
Vehicle "boat" [=[ {} ]=],
}
alias "0xB0AD1238A709B1A2"
alias "_IS_BOAT_ANCHORED_AND_FROZEN"
ns "VEHICLE"
returns "BOOL"
doc [[!
Checks if a boat is currently anchored.
This native is a getter for [SET_BOAT_ANCHOR](#\_0x75DBEC174AEEAD10).
```
NativeDB Introduced: v573
```
The boat to check.
Returns `true` if the boat is currently anchored, `false` otherwise.
]]
native "IS_COP_VEHICLE_IN_AREA_3D"
hash "0x7EEF65D5F153E26A"
jhash (0xFB16C6D1)
arguments {
float "x1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "z2" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
```
Usage:
public bool isCopInRange(Vector3 Location, float Range)
{
return Function.Call(Hash.IS_COP_PED_IN_AREA_3D, Location.X - Range, Location.Y - Range, Location.Z - Range, Location.X + Range, Location.Y + Range, Location.Z + Range);
}
```
]]
native "IS_ENTITY_ATTACHED_TO_HANDLER_FRAME"
hash "0x57715966069157AD"
jhash (0x7FB25568)
arguments {
Vehicle "vehicle" [=[ {} ]=],
Entity "entity" [=[ {} ]=],
}
alias "SET_PED_ENABLED_BIKE_RINGTONE"
alias "_IS_VEHICLE_NEAR_ENTITY"
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "IS_ENTRY_POINT_FOR_SEAT_CLEAR"
hash "0x639431E895B9AA57"
jhash (0xAB0E79EB)
arguments {
Ped "ped" [=[ {} ]=],
Vehicle "vehicle" [=[ {} ]=],
int "seatIndex" [=[ {"cs_type":"BOOL"} ]=],
BOOL "checkSide" [=[ {} ]=],
BOOL "leftSide" [=[ {} ]=],
}
alias "0x639431E895B9AA57"
alias "_IS_VEHICLE_SEAT_ACCESSIBLE"
ns "VEHICLE"
returns "BOOL"
doc [[!
Check if a entry point for a certain seat is clear, useful for checking if a vehicle seat is accesible.
If you park your vehicle near a wall and the ped cannot enter/exit this side, the return value toggles from true (not blocked) to false (blocked).
Keep in mind, with checkSide set to true, that only certain vehicles have entry points on both sides for the same seat, like motorcycles, most normal vehicles don't have this and if the native doesn't find a entry point with the given parameters it will always return false. So for most normal usecases leaving checkSide set to false would result in the expected behavior.
The ped to check.
The vehicle to check.
See eSeatPosition declared in [`IS_VEHICLE_SEAT_FREE`](#\_0x22AC59A870E6A669).
True to check the side of the entry point relative to the vehicle
When checkSide is true together with this it only checks if entrypoints on the left side of the vehicle are clear, and for the right side when given false
True if the entry point is accesible and the area is clear for the given ped.
]]
native "IS_HELI_LANDING_AREA_BLOCKED"
hash "0x634148744F385576"
jhash (0x6346B7CC)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0x634148744F385576"
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "IS_HELI_PART_BROKEN"
hash "0xBC74B4BE25EB6C8A"
jhash (0xF4E4C439)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "IS_NITROUS_ACTIVE"
hash "0x491E822B2C464FE4"
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
```
NativeDB Introduced: 3095
```
Determines if the nitrous is currently activated in the specified vehicle.
The vehicle to check.
Returns `true` if nitrous is active, otherwise `false`.
]]
native "IS_PLANE_LANDING_GEAR_INTACT"
hash "0x4198AB0022B15F87"
jhash (0xBD085DCA)
arguments {
Vehicle "plane" [=[ {} ]=],
}
alias "0x4198AB0022B15F87"
alias "_VEHICLE_HAS_LANDING_GEAR"
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "IS_PLAYBACK_GOING_ON_FOR_VEHICLE"
hash "0x1C8A4C2C19E68EEC"
jhash (0x61F7650D)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "IS_PLAYBACK_USING_AI_GOING_ON_FOR_VEHICLE"
hash "0xAEA8FD591FAD4106"
jhash (0x63022C58)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "IS_SEAT_WARP_ONLY"
hash "0xF7F203E31F96F6A1"
jhash (0x769E5CF2)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "seatIndex" [=[ {"cs_type":"BOOL"} ]=],
}
alias "0xF7F203E31F96F6A1"
ns "VEHICLE"
returns "BOOL"
doc [[!
The vehicle to check.
See eSeatPosition declared in [`IS_VEHICLE_SEAT_FREE`](#\_0x22AC59A870E6A669).
]]
native "IS_TAXI_LIGHT_ON"
hash "0x7504C0F113AB50FC"
jhash (0x6FC4924A)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "IS_THIS_MODEL_A_BICYCLE"
hash "0xBF94DD42F63BDED2"
jhash (0x328E6FF5)
arguments {
Hash "model" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "IS_THIS_MODEL_A_BIKE"
hash "0xB50C0B0CEDC6CE84"
jhash (0x7E702CDD)
arguments {
Hash "model" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "IS_THIS_MODEL_A_BOAT"
hash "0x45A9187928F4B9E3"
jhash (0x10F6085C)
arguments {
Hash "model" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "IS_THIS_MODEL_A_CAR"
hash "0x7F6DB52EEFC96DF8"
jhash (0x60E4C22F)
arguments {
Hash "model" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
```
To check if the model is an amphibious car, see gtaforums.com/topic/717612-v-scriptnative-documentation-and-research/page-33#entry1069317363 (for build 944 and above only!)
```
]]
native "IS_THIS_MODEL_A_HELI"
hash "0xDCE4334788AF94EA"
jhash (0x8AF7F568)
arguments {
Hash "model" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "IS_THIS_MODEL_A_PLANE"
hash "0xA0948AB42D7BA0DE"
jhash (0x3B3907BB)
arguments {
Hash "model" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "IS_THIS_MODEL_A_QUADBIKE"
hash "0x39DAC362EE65FA28"
jhash (0xC1625277)
arguments {
Hash "model" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "IS_THIS_MODEL_A_TRAIN"
hash "0xAB935175B22E822B"
jhash (0xF87DCFFD)
arguments {
Hash "model" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "IS_TOGGLE_MOD_ON"
hash "0x84B233A8C8FC8AE7"
jhash (0xF0E1689F)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "modType" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
Refer to eVehicleModType in [`SET_VEHICLE_MOD`](#\_0x6AF0636DDEDCB6DD).
]]
native "IS_TURRET_SEAT"
hash "0xE33FFA906CE74880"
jhash (0x7C43D32A)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "seatIndex" [=[ {} ]=],
}
alias "0xE33FFA906CE74880"
ns "VEHICLE"
returns "BOOL"
doc [[!
The vehicle to check.
See eSeatPosition declared in [`IS_VEHICLE_SEAT_FREE`](#\_0x22AC59A870E6A669).
]]
native "IS_VEHICLE_A_CONVERTIBLE"
hash "0x52F357A30698BCCE"
jhash (0x6EF54490)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "checkRoofExtras" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
Determines if a vehicle is a convertible with an animatable roof. This native checks if the specified vehicle model features a convertible roof that can be lowered or raised through an animation.
```
NativeDB Introduced: v323
```
The vehicle to check.
When set to `false`, the native checks only for vehicles with an animatable convertible roof. Set to `true` to include additional checks for vehicles that might have a non-animatable roof (i.e., using vehicle extras)
Returns `true` if the vehicle is a convertible with an animatable roof or if `checkRoofExtras` is `true` and the vehicle has a roof (animatable or not). Returns `false` if the vehicle does not meet the criteria.
]]
native "IS_VEHICLE_ALARM_ACTIVATED"
hash "0x4319E335B71FFF34"
jhash (0xF2630A4C)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "IS_VEHICLE_ATTACHED_TO_CARGOBOB"
hash "0xD40148F22E81A1D9"
jhash (0x5DEEC76C)
arguments {
Vehicle "cargobob" [=[ {} ]=],
Vehicle "vehicleAttached" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "IS_VEHICLE_ATTACHED_TO_TOW_TRUCK"
hash "0x146DF9EC4C4B9FD4"
jhash (0x9699CFDC)
arguments {
Vehicle "towTruck" [=[ {} ]=],
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
```
Scripts verify that towTruck is the first parameter, not the second.
```
]]
native "IS_VEHICLE_ATTACHED_TO_TRAILER"
hash "0xE7CF3C4F9F489F0C"
jhash (0xE142BBCC)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "IS_VEHICLE_BUMPER_BOUNCING"
hash "0x27B926779DEB502D"
jhash (0xB3A2CC4F)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "frontBumper" [=[ {} ]=],
}
alias "0x27B926779DEB502D"
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "IS_VEHICLE_BUMPER_BROKEN_OFF"
hash "0x468056A6BB6F3846"
jhash (0xAF25C027)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "front" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "IS_VEHICLE_DOOR_DAMAGED"
hash "0xB8E181E559464527"
jhash (0x4999E3C3)
arguments {
Vehicle "veh" [=[ {} ]=],
int "doorID" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
See eDoorId declared in [`SET_VEHICLE_DOOR_SHUT`](#\_0x93D9BD300D7789E5)
]]
native "IS_VEHICLE_DOOR_FULLY_OPEN"
hash "0x3E933CFF7B111C22"
jhash (0xC2385B6F)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "doorIndex" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
See eDoorId declared in [`SET_VEHICLE_DOOR_SHUT`](#\_0x93D9BD300D7789E5)
The vehicle to check.
The index of the door to check.
A bool indiciating if the specified door is fully open on the specified vehicle.
]]
native "IS_VEHICLE_DRIVEABLE"
hash "0x4C241E39B23DF959"
jhash (0x41A7267A)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "isOnFireCheck" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
```
p1 is always 0 in the scripts.
p1 = check if vehicle is on fire
```
]]
native "IS_VEHICLE_EXTRA_TURNED_ON"
hash "0xD2E6822DBFD6C8BD"
jhash (0x042098B5)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "extraId" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "IS_VEHICLE_HIGH_DETAIL"
hash "0x1F25887F3C104278"
jhash (0x55D41928)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "IS_VEHICLE_IN_BURNOUT"
hash "0x1297A88E081430EB"
jhash (0x6632BC12)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
```
Returns whether the specified vehicle is currently in a burnout.
vb.net
Public Function isVehicleInBurnout(vh As Vehicle) As Boolean
Return Native.Function.Call(Of Boolean)(Hash.IS_VEHICLE_IN_BURNOUT, vh)
End Function
```
]]
native "IS_VEHICLE_IN_GARAGE_AREA"
hash "0xCEE4490CD57BB3C2"
jhash (0xA90EC257)
arguments {
charPtr "garageName" [=[ {} ]=],
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
```
garageName example "Michael - Beverly Hills"
```
]]
native "IS_VEHICLE_IN_SUBMARINE_MODE"
hash "0xA77DC70BD689A1E5"
jhash (0xE2FF06DB)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "_GET_IS_SUBMARINE_VEHICLE_TRANSFORMED"
ns "VEHICLE"
returns "BOOL"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "IS_VEHICLE_MOD_GEN9_EXCLUSIVE"
hash "0x00834EAC4A96E010"
jhash (0xEF66663B)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "modType" [=[ {} ]=],
int "modIndex" [=[ {} ]=],
}
alias "0x00834EAC4A96E010"
alias "_IS_VEHICLE_MOD_HSW_EXCLUSIVE"
ns "VEHICLE"
returns "BOOL"
doc [[!
The vehicle handle
The mod type (see [`SET_VEHICLE_MOD`](#\_0x6AF0636DDEDCB6DD))
The mod index
Returns whether the specified mod is exclusive to gen9 or not.
]]
native "IS_VEHICLE_MODEL"
hash "0x423E8DE37D934D89"
jhash (0x013B10B6)
arguments {
Vehicle "vehicle" [=[ {} ]=],
Hash "model" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "IS_VEHICLE_ON_ALL_WHEELS"
hash "0xB104CD1BABF302E2"
jhash (0x10089F8E)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
```
Public Function isVehicleOnAllWheels(vh As Vehicle) As Boolean
Return Native.Function.Call(Of Boolean)(Hash.IS_VEHICLE_ON_ALL_WHEELS, vh)
End Function
```
]]
native "IS_VEHICLE_SEARCHLIGHT_ON"
hash "0xC0F97FCE55094987"
jhash (0xADAF3513)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
```
Possibly: Returns whether the searchlight (found on police vehicles) is toggled on.
```
]]
native "IS_VEHICLE_SEAT_FREE"
hash "0x22AC59A870E6A669"
jhash (0xDAF42B02)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "seatIndex" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
Seat indices range from -1 to [`GET_VEHICLE_MAX_NUMBER_OF_PASSENGERS`](#\_0xA7C4F2C6E744A550) minus one.
```cpp
// CTaskExitVehicleSeat::eSeatPosition - 1
enum eSeatPosition
{
SF_FrontDriverSide = -1,
SF_FrontPassengerSide = 0,
SF_BackDriverSide = 1,
SF_BackPassengerSide = 2,
SF_AltFrontDriverSide = 3,
SF_AltFrontPassengerSide = 4,
SF_AltBackDriverSide = 5,
SF_AltBackPassengerSide = 6,
};
```
```
NativeDB Added Parameter 3: BOOL isTaskRunning
isTaskRunning = on true the function returns already false while a task on the target seat is running (TASK_ENTER_VEHICLE/TASK_SHUFFLE_TO_NEXT_VEHICLE_SEAT) - on false only when a ped is finally sitting in the seat.
```
The vehicle to check.
The eSeatPosition or -2 for **any** vehicle seat.
]]
native "IS_VEHICLE_SIREN_AUDIO_ON"
hash "0xB5CC40FBCB586380"
jhash (0xC9458688)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0xB5CC40FBCB586380"
alias "_IS_VEHICLE_SIREN_SOUND_ON"
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "IS_VEHICLE_SIREN_ON"
hash "0x4C9BF537BE2634B2"
jhash (0x25EB5873)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
Returns whether the vehicle's lights and sirens are on.
Returns false if siren and lights are disabled or true if they are enabled.
]]
native "IS_VEHICLE_SPRAYABLE"
hash "0x8D474C8FAEFF6CDE"
jhash (0x5EB00A6A)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0x8D474C8FAEFF6CDE"
alias "_IS_VEHICLE_SHOP_RESPRAY_ALLOWED"
ns "VEHICLE"
returns "BOOL"
doc [[!
```
Returns false if the vehicle has the FLAG_NO_RESPRAY flag set.
```
]]
native "IS_VEHICLE_STOLEN"
hash "0x4AF9BD80EEBEB453"
jhash (0x20B61DDE)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "IS_VEHICLE_STOPPED"
hash "0x5721B434AD84D57A"
jhash (0x655F072C)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
```
Returns true if the vehicle's current speed is less than, or equal to 0.0025f.
For some vehicles it returns true if the current speed is <= 0.00039999999.
```
True if the vehicle's speed is equal to, or less than 0.02 meters per second, or 0.05 meters per second, if the vehicle's handbrake is engaged.
]]
native "IS_VEHICLE_STOPPED_AT_TRAFFIC_LIGHTS"
hash "0x2959F696AE390A99"
jhash (0x69200FA4)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
This native checks if the given vehicle is stopped at a red or amber traffic light junction, provided the driver's personality is set to not run amber lights.
The vehicle handle.
Will return `true` if the vehicle is at an amber light junction and the vehicle driver's personality is set to not run amber lights, or if the vehicle is at a red light, regardless of the driver's personality.
Will return `false` if the vehicle is stopped behind another vehicle waiting at a traffic light.
]]
native "IS_VEHICLE_STUCK_ON_ROOF"
hash "0xB497F06B288DCFDF"
jhash (0x18D07C6C)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "IS_VEHICLE_STUCK_TIMER_UP"
hash "0x679BE1DAF71DA874"
jhash (0x2FCF58C1)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "p1" [=[ {} ]=],
int "p2" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
```
p1 can be anywhere from 0 to 3 in the scripts. p2 is generally somewhere in the 1000 to 10000 range.
```
]]
native "IS_VEHICLE_TYRE_BURST"
hash "0xBA291848A0815CA9"
jhash (0x48C80210)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "wheelID" [=[ {} ]=],
BOOL "isBurstToRim" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
```cpp
enum eVehicleWheels
{
WHEEL_LF = 0, // Vehicle Left front
WHEEL_RF = 1, // Vehicle Right front
WHEEL_LM = 2, // Vehicle Left middle
WHEEL_RM = 3, // Vehicle Right middle
WHEEL_LR = 4, // Vehicle Left rear
WHEEL_RR = 5, // Vehicle Right rear
WHEEL_BF = 6, // Bike front
WHEEL_BR = 7, // Bike rear
MAX_WHEELS = 8
};
```
The vehicle to check the tire status of
The wheel id to check, see `eVehicleWheels`
Whether it should only return `true` if the tire is bursted to its rims
Returns `true` if the vehicle tire is poped, `false` otherwise.
]]
native "IS_VEHICLE_VISIBLE"
hash "0xAA0A52D24FB98293"
jhash (0x7E0D6056)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "IS_VEHICLE_WINDOW_INTACT"
hash "0x46E571A0E20D01F1"
jhash (0xAC4EF23D)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "windowIndex" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
```cpp
enum eWindowId {
VEH_EXT_WINDOW_LF = 0,
VEH_EXT_WINDOW_RF = 1,
VEH_EXT_WINDOW_LR = 2,
VEH_EXT_WINDOW_RR = 3,
VEH_EXT_WINDOW_LM = 4,
VEH_EXT_WINDOW_RM = 5,
VEH_EXT_WINDSCREEN = 6,
VEH_EXT_WINDSCREEN_R = 7,
}
```
The vehicle handle
The index of the window
]]
native "LOWER_CONVERTIBLE_ROOF"
hash "0xDED51F703D0FA83D"
jhash (0xC5F72EAE)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "instantlyLower" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
Lowers the roof on a convertible vehicle, utilizing any available animations for the action. This native is particularly useful for creating a realistic interaction with convertible vehicles by animating the process of lowering the roof.
You can check if the vehicle has an convertible roof using [`IS_VEHICLE_A_CONVERTIBLE`](#\_0x52F357A30698BCCE).
```
NativeDB Introduced: v323
```
The convertible vehicle whose roof you want to lower.
A boolean value indicating whether the roof should be lowered instantly without transitioning through the animation. Set to `false` to lower the roof with the animation or `true` to lower it instantly.
]]
native "MODIFY_VEHICLE_TOP_SPEED"
hash "0x93A3996368C94158"
jhash (0xE943B09C)
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "value" [=[ {} ]=],
}
alias "_SET_VEHICLE_ENGINE_POWER_MULTIPLIER"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "OPEN_BOMB_BAY_DOORS"
hash "0x87E7F24270732CB1"
jhash (0x6574041D)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "_OPEN_VEHICLE_BOMB_BAY"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "PAUSE_PLAYBACK_RECORDED_VEHICLE"
hash "0x632A689BF42301B1"
jhash (0xCCF54912)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "POP_OUT_VEHICLE_WINDSCREEN"
hash "0x6D645D59FB5F5AD3"
jhash (0xCC95C96B)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "_DETACH_VEHICLE_WINDSCREEN"
ns "VEHICLE"
returns "void"
doc [[!
Detaches the vehicle's windscreen.
]]
native "PRELOAD_VEHICLE_MOD"
hash "0x758F49C24925568A"
jhash (0x6EA5F4A8)
arguments {
Any "p0" [=[ {} ]=],
int "modType" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
Refer to eVehicleModType in [`SET_VEHICLE_MOD`](#\_0x6AF0636DDEDCB6DD).
]]
native "RAISE_CONVERTIBLE_ROOF"
hash "0x8F5FB35D7E88FC70"
jhash (0xA4E4CBA3)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "instantlyRaise" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
Raises the roof on a convertible vehicle, utilizing any available animations for the action. This native is particularly useful for creating a realistic interaction with convertible vehicles by animating the process of raising the roof.
You can check if the vehicle has an convertible roof using [`IS_VEHICLE_A_CONVERTIBLE`](#\_0x52F357A30698BCCE).
To lower the convertible roof, you can use [`LOWER_CONVERTIBLE_ROOF`](#\_0xDED51F703D0FA83D).
```
NativeDB Introduced: v323
```
The convertible vehicle whose roof you wish to raise.
A boolean indicating whether the roof should be raised instantly without the animation transition. Set `false` to raise the roof with the animation, or `true` to raise it immediately.
]]
native "RELEASE_PRELOAD_MODS"
hash "0x445D79F995508307"
jhash (0xD442521F)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "REMOVE_PICK_UP_ROPE_FOR_CARGOBOB"
hash "0x9768CF648F54C804"
jhash (0xA8211EE9)
arguments {
Vehicle "cargobob" [=[ {} ]=],
}
alias "_RETRACT_CARGOBOB_HOOK"
ns "VEHICLE"
returns "void"
doc [[!
```
Retracts the hook on the cargobob.
Note: after you retract it the natives for dropping the hook no longer work
```
]]
native "REMOVE_ROAD_NODE_SPEED_ZONE"
hash "0x1033371FC8E842A7"
jhash (0x0C0332A6)
arguments {
int "speedzone" [=[ {} ]=],
}
alias "0x1033371FC8E842A7"
alias "_REMOVE_SPEED_ZONE"
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "REMOVE_VEHICLE_ASSET"
hash "0xACE699C71AB9DEB5"
jhash (0x9620E9C6)
arguments {
int "vehicleAsset" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "REMOVE_VEHICLE_COMBAT_AVOIDANCE_AREA"
hash "0xE30524E1871F481D"
jhash (0xEF05F807)
arguments {
Any "p0" [=[ {} ]=],
}
alias "0xE30524E1871F481D"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "REMOVE_VEHICLE_HIGH_DETAIL_MODEL"
hash "0x00689CDE5F7C6787"
jhash (0x382BE070)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "REMOVE_VEHICLE_MOD"
hash "0x92D619E420858204"
jhash (0x9CC80A43)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "modType" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
Refer to eVehicleModType in [`SET_VEHICLE_MOD`](#\_0x6AF0636DDEDCB6DD).
]]
native "REMOVE_VEHICLE_RECORDING"
hash "0xF1160ACCF98A3FC8"
jhash (0xD3C05B00)
arguments {
int "recording" [=[ {} ]=],
charPtr "script" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
See [REQUEST_VEHICLE_RECORDING](#\_0xAF514CABE74CBF15)
]]
native "REMOVE_VEHICLE_STUCK_CHECK"
hash "0x8386BFB614D06749"
jhash (0x81594917)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "REMOVE_VEHICLE_UPSIDEDOWN_CHECK"
hash "0xC53EB42A499A7E90"
jhash (0xF390BA1B)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "REMOVE_VEHICLE_WINDOW"
hash "0xA711568EEDB43069"
jhash (0xBB8104A3)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "windowIndex" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
See eWindowId declared in [`IS_VEHICLE_WINDOW_INTACT`](#\_0x46E571A0E20D01F1).
]]
native "REMOVE_VEHICLES_FROM_GENERATORS_IN_AREA"
hash "0x46A1E1A299EC4BBA"
jhash (0x42CC15E0)
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
Any "unk" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "REQUEST_VEHICLE_ASSET"
hash "0x81A15811460FAB3A"
jhash (0x902B4F06)
arguments {
Hash "vehicleHash" [=[ {} ]=],
int "vehicleAsset" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
REQUEST_VEHICLE_ASSET(GET_HASH_KEY(cargobob3), 3);
vehicle found that have asset's:
cargobob3
submersible
blazer
```
]]
native "REQUEST_VEHICLE_HIGH_DETAIL_MODEL"
hash "0xA6E9FDCB2C76785E"
jhash (0x9DA21956)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "REQUEST_VEHICLE_RECORDING"
hash "0xAF514CABE74CBF15"
jhash (0x91AFEFD9)
arguments {
int "recording" [=[ {} ]=],
charPtr "script" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
Request the vehicle recording defined by the lowercase format string "%s%03d.yvr". For example, REQUEST_VEHICLE_RECORDING(1, "FBIs1UBER") corresponds to fbis1uber001.yvr.
For all vehicle recording/playback natives, "script" is a common prefix that usually corresponds to the script/mission the recording is used in, "recording" is its int suffix, and "id" (e.g., in native GET_TOTAL_DURATION_OF_VEHICLE_RECORDING_ID) corresponds to a unique identifier within the recording streaming module.
Note that only 24 recordings (hardcoded in multiple places) can ever active at a given time before clobbering begins.
```
]]
native "RESET_VEHICLE_STUCK_TIMER"
hash "0xD7591B0065AFAA7A"
jhash (0xEF2A6016)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "nullAttributes" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
The inner function has a switch on the second parameter. It's the stuck timer index.
Here's some pseudo code I wrote for the inner function:
void __fastcall NATIVE_RESET_VEHICLE_STUCK_TIMER_INNER(CUnknown* unknownClassInVehicle, int timerIndex)
{
switch (timerIndex)
{
case 0:
unknownClassInVehicle->FirstStuckTimer = (WORD)0u;
case 1:
unknownClassInVehicle->SecondStuckTimer = (WORD)0u;
case 2:
unknownClassInVehicle->ThirdStuckTimer = (WORD)0u;
case 3:
unknownClassInVehicle->FourthStuckTimer = (WORD)0u;
case 4:
unknownClassInVehicle->FirstStuckTimer = (WORD)0u;
unknownClassInVehicle->SecondStuckTimer = (WORD)0u;
unknownClassInVehicle->ThirdStuckTimer = (WORD)0u;
unknownClassInVehicle->FourthStuckTimer = (WORD)0u;
break;
};
}
```
]]
native "RESET_VEHICLE_WHEELS"
hash "0x21D2E5662C1F6FED"
jhash (0xD5FFE779)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "ROLL_DOWN_WINDOW"
hash "0x7AD9E6CE657D69E3"
jhash (0xF840134C)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "windowIndex" [=[ {} ]=],
}
ns "VEHICLE"
annotations [=[ {"cs_type":"Any"} ]=]
returns "void"
doc [[!
See eWindowId declared in [`IS_VEHICLE_WINDOW_INTACT`](#\_0x46E571A0E20D01F1).
]]
native "ROLL_DOWN_WINDOWS"
hash "0x85796B0549DDE156"
jhash (0x51A16DC6)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
Roll down all the windows of the vehicle passed through the first parameter.
```
]]
native "ROLL_UP_WINDOW"
hash "0x602E548F46E24D59"
jhash (0x83B7E06A)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "windowIndex" [=[ {} ]=],
}
ns "VEHICLE"
annotations [=[ {"cs_type":"Any"} ]=]
returns "void"
doc [[!
See eWindowId declared in [`IS_VEHICLE_WINDOW_INTACT`](#\_0x46E571A0E20D01F1).
]]
native "SET_ALL_LOW_PRIORITY_VEHICLE_GENERATORS_ACTIVE"
hash "0x608207E7A8FB787C"
jhash (0x87F767F2)
arguments {
BOOL "active" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_ALL_VEHICLE_GENERATORS_ACTIVE"
hash "0x34AD89078831A4BC"
jhash (0xAB1FDD76)
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_ALL_VEHICLE_GENERATORS_ACTIVE_IN_AREA"
hash "0xC12321827687FE4D"
jhash (0xB4E0E69A)
arguments {
float "x1" [=[ {} ]=],
float "y1" [=[ {} ]=],
float "z1" [=[ {} ]=],
float "x2" [=[ {} ]=],
float "y2" [=[ {} ]=],
float "z2" [=[ {} ]=],
BOOL "p6" [=[ {} ]=],
BOOL "p7" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_AMBIENT_VEHICLE_RANGE_MULTIPLIER_THIS_FRAME"
hash "0x90B6DA738A9A25DA"
jhash (0xDAE2A2BE)
arguments {
float "range" [=[ {} ]=],
}
alias "0x90B6DA738A9A25DA"
alias "_SET_SOME_VEHICLE_DENSITY_MULTIPLIER_THIS_FRAME"
ns "VEHICLE"
returns "void"
doc [[!
Most likely a value between 0.0 and 1.0.
]]
native "SET_BIKE_ON_STAND"
hash "0x9CFA4896C3A53CBB"
jhash (0x15D40761)
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
}
alias "_SET_BIKE_LEAN_ANGLE"
ns "VEHICLE"
returns "void"
doc [[!
```
Only works on bikes, both X and Y work in the -1 - 1 range.
X forces the bike to turn left or right (-1, 1)
Y forces the bike to lean to the left or to the right (-1, 1)
Example with X -1/Y 1
http://i.imgur.com/TgIuAPJ.jpg
```
]]
native "SET_BOAT_ANCHOR"
hash "0x75DBEC174AEEAD10"
jhash (0xA3906284)
arguments {
Vehicle "boat" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
Sets the anchor state for a boat.
```
NativeDB Introduced: v323
```
**Note**: You might want to check if you can use your anchor before with [CAN_ANCHOR_BOAT_HERE](#\_0x26C10ECBDA5D043B).
The target boat.
Set the anchor state `true` deploys the anchor, false `raises` it.
]]
native "SET_BOAT_DISABLE_AVOIDANCE"
hash "0x0A6A279F3AA4FD70"
jhash (0x4C0E4031)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
alias "0x0A6A279F3AA4FD70"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_BOAT_LOW_LOD_ANCHOR_DISTANCE"
hash "0xE842A9398079BD82"
jhash (0x66FA450C)
arguments {
Vehicle "boat" [=[ {} ]=],
float "value" [=[ {} ]=],
}
alias "0xE842A9398079BD82"
alias "_SET_BOAT_ANCHOR_BUOYANCY_COEFFICIENT"
alias "_SET_BOAT_MOVEMENT_RESISTANCE"
ns "VEHICLE"
returns "void"
doc [[!
Sets the distance from the player at which anchored boats switch between high and low LOD (Level of Detail) buoyancy mode.
```
NativeDB Introduced: v323
```
The target boat.
The distance at which the LOD switch occurs. Set to `-1.0` to reset the LOD distance to the default value.
]]
native "SET_BOAT_REMAINS_ANCHORED_WHILE_PLAYER_IS_DRIVER"
hash "0xE3EBAAE484798530"
jhash (0x0ED84792)
arguments {
Vehicle "boat" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0xE3EBAAE484798530"
alias "_SET_BOAT_FROZEN_WHEN_ANCHORED"
ns "VEHICLE"
returns "void"
doc [[!
Sets whether a boat should remain anchored even when a player is driving it.
**Note**: This native is always used with [SET_BOAT_ANCHOR](#\_0x75DBEC174AEEAD10).
```
NativeDB Introduced: v323
```
The target boat.
Set the anchoring behavior. If `true`, the boat will remain anchored even when a player is driving. If `false`, normal anchoring behavior applies (anchor is raised when a player drives).
]]
native "SET_BOAT_SINKS_WHEN_WRECKED"
hash "0x8F719973E1445BA2"
jhash (0x35614622)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {"cs_type":"Vehicle"} ]=],
}
alias "0x8F719973E1445BA2"
alias "_SET_BOAT_EXPLODES_ON_WRECKED_ACTION"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_CAN_RESPRAY_VEHICLE"
hash "0x52BBA29D5EC69356"
jhash (0x37677590)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "state" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
Hardcoded to not work in multiplayer.
```
]]
native "SET_CAR_BOOT_OPEN"
hash "0xFC40CBF7B90CA77C"
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0xFC40CBF7B90CA77C"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_CARGOBOB_EXCLUDE_FROM_PICKUP_ENTITY"
hash "0x1F34B0626C594380"
arguments {
Vehicle "cargobob" [=[ {} ]=],
Entity "entity" [=[ {} ]=],
}
alias "0x1F34B0626C594380"
ns "VEHICLE"
returns "void"
doc [[!
Prevents a specified entity from being detached from a Cargobob, even in the event of collisions.
The Cargobob helicopter from which the entity is not to be detached
The entity to remain attached to the Cargobob.
]]
native "SET_CARGOBOB_FORCE_DONT_DETACH_VEHICLE"
hash "0x571FEB383F629926"
jhash (0x49949FDA)
arguments {
Vehicle "cargobob" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x571FEB383F629926"
alias "_SET_CARGOBOB_HOOK_CAN_DETACH"
ns "VEHICLE"
returns "void"
doc [[!
Stops cargobob from being able to detach the attached vehicle.
]]
native "SET_CARGOBOB_PICKUP_MAGNET_ACTIVE"
hash "0x9A665550F8DA349B"
jhash (0xF57066DA)
arguments {
Vehicle "cargobob" [=[ {} ]=],
BOOL "isActive" [=[ {} ]=],
}
alias "_CARGOBOB_MAGNET_GRAB_VEHICLE"
alias "_SET_CARGOBOB_PICKUP_MAGNET_ACTIVE"
ns "VEHICLE"
returns "void"
doc [[!
```
Won't attract or magnetize to any helicopters or planes of course, but that's common sense.
```
]]
native "SET_CARGOBOB_PICKUP_MAGNET_EFFECT_RADIUS"
hash "0xA17BAD153B51547E"
jhash (0xE5DCD62F)
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "p1" [=[ {} ]=],
}
alias "0xA17BAD153B51547E"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_CARGOBOB_PICKUP_MAGNET_FALLOFF"
hash "0x685D5561680D088B"
jhash (0x91C80401)
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "p1" [=[ {} ]=],
}
alias "0x685D5561680D088B"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_CARGOBOB_PICKUP_MAGNET_PULL_ROPE_LENGTH"
hash "0x6D8EAC07506291FB"
jhash (0x60E29B78)
arguments {
Vehicle "cargobob" [=[ {} ]=],
float "p1" [=[ {} ]=],
}
alias "0x6D8EAC07506291FB"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_CARGOBOB_PICKUP_MAGNET_PULL_STRENGTH"
hash "0xED8286F71A819BAA"
jhash (0x8191BC1A)
arguments {
Vehicle "cargobob" [=[ {} ]=],
float "p1" [=[ {} ]=],
}
alias "0xED8286F71A819BAA"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_CARGOBOB_PICKUP_MAGNET_REDUCED_FALLOFF"
hash "0x66979ACF5102FD2F"
jhash (0x1CF139C6)
arguments {
Vehicle "cargobob" [=[ {} ]=],
float "p1" [=[ {} ]=],
}
alias "0x66979ACF5102FD2F"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_CARGOBOB_PICKUP_MAGNET_REDUCED_STRENGTH"
hash "0xE301BD63E9E13CF0"
jhash (0x47D98A2E)
arguments {
Vehicle "cargobob" [=[ {} ]=],
Vehicle "vehicle" [=[ {} ]=],
}
alias "0xE301BD63E9E13CF0"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_CARGOBOB_PICKUP_MAGNET_STRENGTH"
hash "0xBCBFCD9D1DAC19E2"
jhash (0xCC3CF97D)
arguments {
Vehicle "cargobob" [=[ {} ]=],
float "strength" [=[ {} ]=],
}
alias "0xBCBFCD9D1DAC19E2"
alias "_SET_CARGOBOB_PICKUP_MAGNET_STRENGTH"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_CARGOBOB_PICKUP_ROPE_DAMPING_MULTIPLIER"
hash "0xCF1182F682F65307"
jhash (0x7D927E1B)
arguments {
Vehicle "cargobob" [=[ {} ]=],
float "p1" [=[ {"cs_type":"Player"} ]=],
}
alias "0xCF1182F682F65307"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_CARGOBOB_PICKUP_ROPE_TYPE"
hash "0x0D5F65A8F4EBDAB5"
jhash (0xF258ADA1)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "state" [=[ {} ]=],
}
alias "0x0D5F65A8F4EBDAB5"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_CONVERTIBLE_ROOF"
hash "0xF39C4F538B5124C2"
jhash (0xC87B6A51)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
Enables or disables the convertible roof on vehicles that support old-style GTA IV roofs, which are not animated. Setting `toggle` to true will apply the roof to the vehicle, and setting it to false will remove the roof, assuming the vehicle has versions with and without a roof.
If you want to lock or unlock the roof mechanism, use [`SET_CONVERTIBLE_ROOF_LATCH_STATE`](#\_0x1A78AD3D8240536F).
You can check if the vehicle has a roof with [`DOES_VEHICLE_HAVE_ROOF`](#\_0x8AC862B0B32C5B80).
```
NativeDB Introduced: v323
```
#### Vehicles with both roofed and roofless versions (others may exist; this list is compiled from decompiled scripts).
* chino
* voltic
* buccaneer
* buccaneer2
* chino2
* faction
* faction2
* mamba
The vehicle to which the roof state will be applied.
Boolean value where `true` adds the roof and `false` removes it, applicable only if the vehicle has a version with and without a roof.
]]
native "SET_CONVERTIBLE_ROOF_LATCH_STATE"
hash "0x1A78AD3D8240536F"
jhash (0x0858678C)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "bLatched" [=[ {} ]=],
}
alias "0x1A78AD3D8240536F"
ns "VEHICLE"
returns "void"
doc [[!
This native is used to latch or unlatch the convertible roof of a vehicle. It allows for direct control over the roof's mechanism without actually opening or closing the roof. This can be useful for scenarios where you need to prepare a vehicle's roof to be opened or closed by another action or to ensure it remains fixed in its current state regardless of other interactions.
```
NativeDB Introduced: v323
```
The vehicle whose convertible roof latch state is to be set.
A boolean value indicating the desired latch state of the roof. Set to `true` to latch (lock) the roof, preventing it from being opened. Set to `false` to unlatch (unlock) the roof, allowing it to be opened or closed.
]]
native "SET_DISABLE_BMX_EXTRA_TRICK_FORCES"
hash "0x26D99D5A82FD18E8"
arguments {
BOOL "disableExtraTrickForces" [=[ {"cs_type":"Any"} ]=],
}
alias "0x26D99D5A82FD18E8"
ns "VEHICLE"
returns "void"
doc [[!
Disables the additional physics forces applied to BMX bikes that enable them to perform tricks.
```
NativeDB Introduced: v463
```
Set to `true` to disable the extra forces applied for tricks on BMX bicycles, making the bike behave more like a regular bicycle without trick capabilities. Set to `false` to allow BMX bikes to perform tricks normally.
]]
native "SET_DISABLE_EXPLODE_FROM_BODY_DAMAGE_ON_COLLISION"
hash "0x26E13D440E7F6064"
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "disableExplode" [=[ {"cs_type":"float"} ]=],
}
alias "0x26E13D440E7F6064"
ns "VEHICLE"
returns "void"
doc [[!
This only works for planes.
Prevents a vehicle from exploding upon sustaining body damage from physical collisions.
For helicopters, you might want to check [`SET_DISABLE_HELI_EXPLODE_FROM_BODY_DAMAGE`](#\_0xEDBC8405B3895CC9) instead.
```
NativeDB Introduced: v1290
```
The vehicle to apply this setting to.
`true` to disable explosion from body damage on collision; `false` to allow explosions as normal.
]]
native "SET_DISABLE_HELI_EXPLODE_FROM_BODY_DAMAGE"
hash "0xEDBC8405B3895CC9"
arguments {
Vehicle "helicopter" [=[ {} ]=],
BOOL "disableExplode" [=[ {"cs_type":"Any"} ]=],
}
alias "0xEDBC8405B3895CC9"
ns "VEHICLE"
returns "void"
doc [[!
This works on helicopters and planes.
Prevents a helicopter from exploding due to relatively minor body damage.
```
NativeDB Introduced: v1103
```
The helicopter to apply this setting to.
`true` to disable explosion from body damage on collision; `false` to allow explosions as normal.
]]
native "SET_DISABLE_HOVER_MODE_FLIGHT"
hash "0x2D55FE374D5FDB91"
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "_SET_VEHICLE_HOVER_TRANSFORM_ACTIVE"
ns "VEHICLE"
returns "void"
doc [[!
Disables wings for `Deluxo` and `Oppressor MK II`. For the Deluxo, it retracts the wings immediately, preventing flight. For the Oppressor Mk II, the wings retract after landing and take-off is not possible, though it can still glide if launched into the air.
The vehicle to which the toggle will be applied.
Boolean parameter where setting `true` disables the vehicle's wings, preventing flight. Setting it to `false` allows the vehicle to fly as usual.
]]
native "SET_DISABLE_PRETEND_OCCUPANTS"
hash "0x25367DE49D64CF16"
jhash (0xCBD98BA1)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x25367DE49D64CF16"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_DISABLE_RANDOM_TRAINS_THIS_FRAME"
hash "0xD4B8E3D1917BC86B"
jhash (0x09462665)
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0xD4B8E3D1917BC86B"
alias "_SET_SOMETHING_MULTIPLIER_THIS_FRAME"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_DISABLE_VEHICLE_ENGINE_FIRES"
hash "0x91A0BD635321F145"
jhash (0x1784BA1A)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x91A0BD635321F145"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_DISABLE_VEHICLE_PETROL_TANK_DAMAGE"
hash "0x37C8252A7C92D017"
jhash (0xAD3E05F2)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_DISABLE_VEHICLE_PETROL_TANK_FIRES"
hash "0x465BF26AB9684352"
jhash (0xC40192B5)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x465BF26AB9684352"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_DISTANT_CARS_ENABLED"
hash "0xF796359A959DF65D"
jhash (0xB5CC548B)
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0xF796359A959DF65D"
alias "_DISPLAY_DISTANT_VEHICLES"
ns "VEHICLE"
returns "void"
doc [[!
```
Toggles to render distant vehicles. They may not be vehicles but images to look like vehicles.
```
]]
native "SET_ENABLE_VEHICLE_SLIPSTREAMING"
hash "0xE6C0C80B8C867537"
jhash (0xD2B8ACBD)
arguments {
BOOL "toggle" [=[ {} ]=],
}
alias "0xE6C0C80B8C867537"
ns "VEHICLE"
returns "void"
doc [[!
Enable/Disables global slipstream physics
]]
native "SET_FAR_DRAW_VEHICLES"
hash "0x26324F33423F3CC3"
jhash (0x9F019C49)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_FORCE_HD_VEHICLE"
hash "0x97CE68CB032583F0"
jhash (0xE0FC6A32)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x97CE68CB032583F0"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_FORCE_LOW_LOD_ANCHOR_MODE"
hash "0xB28B1FE5BFADD7F5"
jhash (0xA739012A)
arguments {
Vehicle "boat" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0xB28B1FE5BFADD7F5"
alias "_SET_FORCED_BOAT_LOCATION_WHEN_ANCHORED"
ns "VEHICLE"
returns "void"
doc [[!
Sets whether a boat should remain in the non-physical, low LOD anchor mode even when a player is driving it.
**Note**: This native requires [SET_BOAT_REMAINS_ANCHORED_WHILE_PLAYER_IS_DRIVER](#\_0xE3EBAAE484798530) to be set to `true` to work properly.
```
NativeDB Introduced: v323
```
The target boat.
Set the forced low LOD anchor mode. If `true`, the boat will remain in low LOD anchor mode even when a player is driving.
]]
native "SET_FORKLIFT_FORK_HEIGHT"
hash "0x37EBBF3117BD6A25"
jhash (0x943A6CFC)
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "height" [=[ {} ]=],
}
alias "0x37EBBF3117BD6A25"
ns "VEHICLE"
returns "void"
doc [[!
```
0.0 = Lowest 1.0 = Highest. This is best to be used if you wanna pick-up a car since un-realistically on GTA V forklifts can't pick up much of anything due to vehicle mass. If you put this under a car then set it above 0.0 to a 'lifted-value' it will raise the car with no issue lol
```
]]
native "SET_GARBAGE_TRUCKS"
hash "0x2AFD795EEAC8D30D"
jhash (0xD9ABB0FF)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
annotations [=[ {"cs_type":"Any"} ]=]
returns "void"
doc [[!
]]
native "SET_HELI_BLADES_FULL_SPEED"
hash "0xA178472EBB8AE60D"
jhash (0x033A9408)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
Despite its name, this works on Helicopters and Planes.
Sets the speed of the helicopter blades to full speed.
This is equivalent to calling `SetHeliBladesSpeed(vehicleHandle, 1.0);`
The helicopter or the plane
]]
native "SET_HELI_BLADES_SPEED"
hash "0xFD280B4D7F3ABC4D"
jhash (0x5C7D4EA9)
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "speed" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
Despite its name, this works on Helicopters and Planes.
Sets the speed of the helicopter blades in percentage of the full speed.
The helicopter or the plane
Desired blade rotation speed from 0.0 to 1.0
]]
native "SET_HELI_COMBAT_OFFSET"
hash "0x0A3F820A9A9A9AC5"
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
alias "0x0A3F820A9A9A9AC5"
ns "VEHICLE"
returns "void"
doc [[!
Set a specific offset for helis chasing target in combat
```
NativeDB Introduced: v1180
```
Helicopter for which the combat offset is being set.
Offset along the X-axis (left/right) relative to the helicopter's current position and orientation
Offset along the Y-axis (forward/backward) relative to the helicopter's current position and orientation
Offset along the Z-axis (up/down) relative to the helicopter's current position and orientation.
]]
native "SET_HELI_RESIST_TO_EXPLOSION"
hash "0x8074CC1886802912"
arguments {
Vehicle "helicopter" [=[ {} ]=],
BOOL "bResistToExplosion" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
Makes a helicopter resistant to multiple explosions. When enabled, helicopters can survive two or more explosions.
```
NativeDB Introduced: 2545
```
The helicopter to apply resistance to.
Set to `true` to make the helicopter resistant to explosions, or `false` to disable this resistance.
]]
native "SET_HELI_TAIL_BOOM_CAN_BREAK_OFF"
hash "0x3EC8BF18AA453FE9"
jhash (0x2916D69B)
arguments {
Vehicle "heli" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "SET_HELI_TAIL_EXPLODE_THROW_DASHBOARD"
alias "WAS_COUNTER_ACTIVATED"
alias "0x3EC8BF18AA453FE9"
ns "VEHICLE"
annotations [=[ {"cs_type":"BOOL"} ]=]
returns "void"
doc [[!
Enables or disables the ability for a helicopter's tail boom to break off.
```
NativeDB Introduced: v323
```
The helicopter for which the tail boom can break off.
Determines whether the helicopter's tail boom can break off.
]]
native "SET_HELI_TURBULENCE_SCALAR"
hash "0xE6F13851780394DA"
jhash (0xCCB41A55)
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "p1" [=[ {} ]=],
}
alias "0xE6F13851780394DA"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_HOVER_MODE_WING_RATIO"
hash "0x70A252F60A3E036B"
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "ratio" [=[ {} ]=],
}
alias "_SET_SPECIALFLIGHT_WING_RATIO"
ns "VEHICLE"
returns "void"
doc [[!
This native allows opening or closing the wings of the Deluxo/Oppressor. For the Deluxo, wing deployment depends on sufficient altitude.
The vehicle to which the ratio will be applied.
Between 0.0 and 1.0. 0.0 is wings closed, 1.0 is wings open.
]]
native "SET_LAST_DRIVEN_VEHICLE"
hash "0xACFB2463CC22BED2"
jhash (0xD1B71A25)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0xACFB2463CC22BED2"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_LIGHTS_CUTOFF_DISTANCE_TWEAK"
hash "0xBC3CCA5844452B06"
jhash (0x929801C6)
arguments {
float "distance" [=[ {} ]=],
}
alias "0xBC3CCA5844452B06"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_MISSION_TRAIN_AS_NO_LONGER_NEEDED"
hash "0xBBE7648349B49BE8"
jhash (0x19808560)
arguments {
VehiclePtr "train" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
p1 is always 0
```
]]
native "SET_MISSION_TRAIN_COORDS"
hash "0x591CA673AA6AB736"
jhash (0xD6D70803)
arguments {
Vehicle "train" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_NITROUS_IS_ACTIVE"
hash "0x465EEA70AF251045"
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "isActive" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
NativeDB Introduced: 3095
```
Activates or deactivates the nitrous system in the specified vehicle, based on the boolean value provided.
You can clear the nitrous with [`CLEAR_NITROUS`](#\_0xC889AE921400E1ED), if you want to have more control on the nitrous and those settings, use [`SET_OVERRIDE_NITROUS_LEVEL`](#\_0xC8E9B6B71B8E660D)
The vehicle whose nitrous system is to be controlled.
A boolean value where `true` activates the nitrous system and `false` deactivates it.
]]
native "SET_NUMBER_OF_PARKED_VEHICLES"
hash "0xCAA15F13EBD417FF"
jhash (0x206A58E8)
arguments {
int "value" [=[ {} ]=],
}
ns "VEHICLE"
annotations [=[ {"cs_type":"Any"} ]=]
returns "void"
doc [[!
]]
native "SET_OPEN_REAR_DOORS_ON_EXPLOSION"
hash "0x1B212B26DD3C04DF"
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x1B212B26DD3C04DF"
ns "VEHICLE"
returns "void"
doc [[!
Enables or disables the opening of a vehicle's rear doors in the event of a sticky bomb explosion. This native is effective for armored vehicles, such as the Stockade (Brinks vehicle), allowing the rear doors to be opened through controlled explosions, which might otherwise remain locked due to the vehicle nature.
The vehicle to apply this setting to.
A boolean value where `true` allows the rear doors to open upon explosion, and `false` prevents them from opening.
This native does not return any value.
]]
native "SET_OVERRIDE_NITROUS_LEVEL"
hash "0xC8E9B6B71B8E660D"
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "override" [=[ {} ]=],
}
alias "_SET_VEHICLE_NITRO_ENABLED"
ns "VEHICLE"
returns "void"
doc [[!
```
NativeDB Introduced: v1604
NativeDB Added Parameter 2 (2060): float durationMod : A multiplier applied to the default nitrous duration (default is 3 seconds).
NativeDB Added Parameter 3 (2060): float power : A multiplier applied to the default nitrous power multiplier (default is 3).
NativeDB Added Parameter 4 (2060): float rechargeTime : A multiplier applied to the default nitrous recharge rate.
NativeDB Added Parameter 5 (2060): BOOL disableSound : A boolean to disable the default nitrous sound when the nitrous is active.
```
Overrides the default settings of a vehicle's nitrous system, allowing custom control over its performance characteristics.
The vehicle whose nitrous system is to be overridden.
A boolean toggle to enable or disable the override settings.
]]
native "SET_PARKED_VEHICLE_DENSITY_MULTIPLIER_THIS_FRAME"
hash "0xEAE6DCC7EEE3DB1D"
jhash (0xDD46CEBE)
arguments {
float "multiplier" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_PICKUP_ROPE_LENGTH_FOR_CARGOBOB"
hash "0x877C1EAEAC531023"
jhash (0x3A8AB081)
arguments {
Vehicle "cargobob" [=[ {} ]=],
float "length1" [=[ {} ]=],
float "length2" [=[ {} ]=],
BOOL "state" [=[ {"cs_type":"int"} ]=],
}
alias "0x877C1EAEAC531023"
alias "_SET_CARGOBOB_HOOK_POSITION"
ns "VEHICLE"
returns "void"
doc [[!
```
min: 1.9f, max: 100.0f
```
]]
native "SET_PLANE_CONTROL_SECTIONS_SHOULD_BREAK_OFF_FROM_EXPLOSIONS"
hash "0xDD8A2D3337F04196"
arguments {
Vehicle "plane" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
NativeDB Introduced: v3407
```
]]
native "SET_PLANE_RESIST_TO_EXPLOSION"
hash "0xE16142B94664DEFD"
jhash (0xFBBA699A)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0xE16142B94664DEFD"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_PLANE_SECTION_DAMAGE_SCALE"
hash "0x0BBB9A7A8FFE931B"
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "damageSection" [=[ {} ]=],
float "damageScale" [=[ {"cs_type":"Any"} ]=],
}
alias "0x0BBB9A7A8FFE931B"
ns "VEHICLE"
returns "void"
doc [[!
Adjusts the scale of damage applied to a specified section of a plane.
In the decompiled scripts the `damageScale` is always set to `0f` (maybe to disable damages on the specified section)
```cpp
enum ePlaneDamageSection {
WING_L = 0,
WING_R = 1,
TAIL = 2,
ENGINE_L = 3,
ENGINE_R = 4,
ELEVATOR_L = 5,
ELEVATOR_R = 6,
AILERON_L = 7,
AILERON_R = 8,
RUDDER = 9,
RUDDER_2 = 10,
AIRBRAKE_L = 11,
AIRBRAKE_R = 12
}
```
```
NativeDB Introduced: v1290
```
Plane to which the damage scale adjustment will be applied.
Specific section of the plane, as defined in the `ePlaneDamageSection` enum, where the damage scale will be adjusted.
A float value representing the scale of damage to be applied to the specified section.
This native does not return any value.
]]
native "SET_PLANE_TURBULENCE_MULTIPLIER"
hash "0xAD2D28A1AFDFF131"
jhash (0xED159AE6)
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "multiplier" [=[ {} ]=],
}
alias "0xAD2D28A1AFDFF131"
ns "VEHICLE"
returns "void"
doc [[!
This native sets the turbulence multiplier. It only works for planes.
0.0 = no turbulence at all.
1.0 = heavy turbulence.
Works by just calling it once, does not need to be called every tick.
The plane to set the multiplier for
The turbulence multiplier. Value between 0.0 and 1.0
]]
native "SET_PLAYBACK_SPEED"
hash "0x6683AB880E427778"
jhash (0x684E26E4)
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "speed" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_PLAYBACK_TO_USE_AI"
hash "0xA549C3B37EA28131"
jhash (0xB536CCD7)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "drivingStyle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
Identical to SET_PLAYBACK_TO_USE_AI_TRY_TO_REVERT_BACK_LATER with 0 as arguments for p1 and p3.
The driving style (default is 0) (see [SetDriveTaskDrivingStyle](#\_0xDACE1BE37D88AF67)).
]]
native "SET_PLAYBACK_TO_USE_AI_TRY_TO_REVERT_BACK_LATER"
hash "0x6E63860BBB190730"
jhash (0x0C8ABAA4)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "time" [=[ {} ]=],
int "drivingStyle" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
Time is number of milliseconds before reverting, zero for indefinitely.
```
The driving style (default is 0) (see [SetDriveTaskDrivingStyle](#\_0xDACE1BE37D88AF67)).
]]
native "SET_PLAYERS_LAST_VEHICLE"
hash "0xBCDF8BAF56C87B6A"
jhash (0xDE86447D)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
annotations [=[ {"cs_type":"Any"} ]=]
returns "void"
doc [[!
]]
native "SET_POLICE_FOCUS_WILL_TRACK_VEHICLE"
hash "0x4E74E62E0A97E901"
jhash (0x5690F6C3)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
alias "0x4E74E62E0A97E901"
ns "VEHICLE"
returns "void"
doc [[!
Sets flag on vehicle that changes behaviour in relation to when player gets wanted level
]]
native "SET_RANDOM_BOATS"
hash "0x84436EC293B1415F"
jhash (0xB505BD89)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
annotations [=[ {"cs_type":"Any"} ]=]
returns "void"
doc [[!
]]
native "SET_RANDOM_TRAINS"
hash "0x80D9F74197EA47D9"
jhash (0xD461CA7F)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
Enables spawning random trains on the preset tracks.
Requires [`SWITCH_TRAIN_TRACK`](#\_0xFD813BB7DB977F20) and [`SET_TRAIN_TRACK_SPAWN_FREQUENCY`](#\_0x21973BBF8D17EDFA) to be set.
Whether to enable random trains.
]]
native "SET_RANDOM_VEHICLE_DENSITY_MULTIPLIER_THIS_FRAME"
hash "0xB3B3359379FE77D3"
jhash (0x543F712B)
arguments {
float "multiplier" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_RENDER_TRAIN_AS_DERAILED"
hash "0x317B11A312DF5534"
jhash (0x899D9092)
arguments {
Vehicle "train" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
makes the train all jumbled up and derailed as it moves on the tracks (though that wont stop it from its normal operations)
```
]]
native "SET_SCRIPT_VEHICLE_GENERATOR"
hash "0xD9D620E0AC6DC4B0"
jhash (0x40D73747)
arguments {
int "vehicleGenerator" [=[ {} ]=],
BOOL "enabled" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
Only called once in the decompiled scripts. Presumably activates the specified generator.
```
]]
native "SET_SPECIAL_FLIGHT_MODE_ALLOWED"
hash "0xF1211889DF15A763"
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0xF1211889DF15A763"
alias "_SET_VEHICLE_HOVER_TRANSFORM_ENABLED"
ns "VEHICLE"
returns "void"
doc [[!
Allows locking the hover/non-hover mode of a vehicle, such as the flying mode of the `Deluxo`. In the decompiled scripts, this native is used on `oppressor2` but couldn't get it to work on it.
The vehicle to which the locking state will be applied.
Boolean parameter where setting `false` locks the current state of the vehicle, preventing transitions such as the `Deluxo` or Oppressor switching between their flying and driving modes. Setting it to `true` allows changing the vehicle state as usual.
]]
native "SET_SPECIAL_FLIGHT_MODE_RATIO"
hash "0xD138FA15C9776837"
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "ratio" [=[ {} ]=],
}
alias "_SET_VEHICLE_HOVER_TRANSFORM_RATIO"
ns "VEHICLE"
returns "void"
doc [[!
Used alongside [`SET_SPECIAL_FLIGHT_MODE_TARGET_RATIO`](#\_0x438B3D7CA026FE91), this function initiates hover transformation for vehicles with a hover mode, like the `Deluxo`, based on a specified ratio (0.0 to 1.0). Incorrect values can glitch the vehicle. Without pairing, vehicles revert to car mode. Ineffective on the `oppressor2`
The vehicle to which the ratio will be applied.
A value between 0.0 and 1.0 indicating the target state for the vehicle's hover mode transition. In decompiled scripts, a common usage is 0.75 - GetFrameTime(). Exceeding the maximum can cause the `Deluxo's` wheels to glitch, delaying their return to the initial position.
]]
native "SET_SPECIAL_FLIGHT_MODE_TARGET_RATIO"
hash "0x438B3D7CA026FE91"
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "state" [=[ {} ]=],
}
alias "0x438B3D7CA026FE91"
alias "_SET_VEHICLE_TRANSFORM_STATE"
alias "_SET_VEHICLE_HOVER_TRANSFORM_PERCENTAGE"
ns "VEHICLE"
returns "void"
doc [[!
According to decompiled scripts this should work with the `deluxo` and `oppressor2` vehicles.
Does nothing when used on `oppressor2`.
For the deluxo:
* Set `state` to `0.0`: Fully transform to a 'road' vehicle (non-hover mode).
* Set `state` to `1.0`: Fully transform to a 'flying' vehicle (hover mode).
If you set it to something like 0.5, then something [weird happens](https://streamable.com/p6wmr), you end up in some 50% hover mode, 50% not hover mode.
This doesn't need to be called every tick, just once and the vehicle will transform to that state at the usual transform speed. It'll just stop transforming when it reaches the state you provided.
Once this native is used then players will just be able to hit the vehicle transform key to toggle the transformation cycle; it won't block users from using the key.
The vehicle (a deluxo or oppressor2).
The transform state (value between 0.0 and 1.0).
]]
native "SET_SUBMARINE_CRUSH_DEPTHS"
hash "0xC59872A5134879C7"
jhash (0x4A46E814)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
float "depth1" [=[ {} ]=],
float "depth2" [=[ {} ]=],
float "depth3" [=[ {} ]=],
}
alias "_JITTER_VEHICLE"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_TASK_VEHICLE_GOTO_PLANE_MIN_HEIGHT_ABOVE_TERRAIN"
hash "0xB893215D8D4C015B"
jhash (0x8C4B63E2)
arguments {
Vehicle "plane" [=[ {} ]=],
int "height" [=[ {} ]=],
}
alias "0xB893215D8D4C015B"
alias "_SET_PLANE_MIN_HEIGHT_ABOVE_GROUND"
alias "_SET_PLANE_MIN_HEIGHT_ABOVE_TERRAIN"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_TAXI_LIGHTS"
hash "0x598803E85E8448D9"
jhash (0x68639D85)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "state" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
This is not tested - it's just an assumption.
Doesn't seem to work. I'll try with an int instead. --JT
Read the scripts, im dumpass.
Doesn't work at all, wether with an bool neither an int
if (!VEHICLE::IS_TAXI_LIGHT_ON(l_115)) {
VEHICLE::SET_TAXI_LIGHTS(l_115, 1);
}
```
]]
native "SET_TRAILER_ATTACHMENT_ENABLED"
hash "0x2FA2494B47FDD009"
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "enabled" [=[ {"cs_type":"Any"} ]=],
}
alias "0x2FA2494B47FDD009"
ns "VEHICLE"
returns "void"
doc [[!
Sets whether the trailer can attach to vehicles
The trailer to set attachment state for
Enable or disable attachment
]]
native "SET_TRAILER_INVERSE_MASS_SCALE"
hash "0x2A8F319B392E7B3F"
jhash (0xE74E85CE)
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "p1" [=[ {} ]=],
}
alias "0x2A8F319B392E7B3F"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_TRAILER_LEGS_RAISED"
hash "0x95CF53B3D687F9FA"
jhash (0x06C47A6F)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0x95CF53B3D687F9FA"
ns "VEHICLE"
returns "void"
doc [[!
```
in the decompiled scripts, seems to be always called on the vehicle right after being attached to a trailer.
```
]]
native "SET_TRAIN_CRUISE_SPEED"
hash "0x16469284DB8C62B5"
jhash (0xB507F51D)
arguments {
Vehicle "train" [=[ {} ]=],
float "speed" [=[ {} ]=],
}
ns "VEHICLE"
annotations [=[ {"cs_type":"Any"} ]=]
returns "void"
doc [[!
Used to control train speed, can be used to start and stop its movement as well.
]]
native "SET_TRAIN_SPEED"
hash "0xAA0BC91BE0B796E3"
jhash (0xDFC35E4D)
arguments {
Vehicle "train" [=[ {} ]=],
float "speed" [=[ {} ]=],
}
ns "VEHICLE"
annotations [=[ {"cs_type":"Any"} ]=]
returns "void"
doc [[!
]]
native "SET_TRAIN_TRACK_SPAWN_FREQUENCY"
hash "0x21973BBF8D17EDFA"
jhash (0xD5774FB7)
arguments {
int "trackIndex" [=[ {} ]=],
int "frequency" [=[ {} ]=],
}
alias "0x21973BBF8D17EDFA"
ns "VEHICLE"
returns "void"
doc [[!
```
Only called once inside main_persitant with the parameters, 0
```
]]
native "SET_TRANSFORM_RATE_FOR_ANIMATION"
hash "0x498218259FB7C72D"
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "transformRate" [=[ {} ]=],
}
alias "0x498218259FB7C72D"
alias "_SET_UNK_FLOAT_0x104_FOR_SUBMARINE_VEHICLE_TASK"
ns "VEHICLE"
returns "void"
doc [[!
Affects the playback speed of the submarine car conversion animations. Does not affect hardcoded animations such as the wheels being retracted. In decompiled scripts the only value used for transformRate is 2.5.
The vehicle for which the submarine car conversion animation speed should be adjusted.
The rate at which the submarine car conversion animations will be played.
]]
native "SET_TRANSFORM_TO_SUBMARINE_USES_ALTERNATE_INPUT"
hash "0x41B9FB92EDED32A6"
arguments {
Vehicle "vehicle" [=[ {} ]=],
bool "useAlternateInput" [=[ {} ]=],
}
alias "0x41B9FB92EDED32A6"
alias "_SET_UNK_BOOL_0x102_FOR_SUBMARINE_VEHICLE_TASK"
ns "VEHICLE"
returns "void"
doc [[!
Changes the key used to transform a vehicle into submarine mode. When set to true, the transformation key switches from the default raise/lower convertible roof key (usually 'H') to the special vehicle transformation key (usually 'X').
```
NativeDB Introduced: v1365
```
The vehicle for which the submarine mode should be configured.
A boolean switch to enable/disable the use of alternate input.
]]
native "SET_VEHICLE_ACT_AS_IF_HIGH_SPEED_FOR_FRAG_SMASHING"
hash "0x1F9FB66F3A3842D2"
jhash (0x4D840FC4)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "actHighSpeed" [=[ {} ]=],
}
alias "0x1F9FB66F3A3842D2"
ns "VEHICLE"
returns "void"
doc [[!
This native is used to simulate a high-speed impact for a vehicle when it collides with a breakable object (frag). It's particularly useful in scripted sequences where a vehicle is required to break through a barrier but might not actually be moving at a sufficient speed to do so realistically. Note that this setting is temporary and will reset after one frame, so it needs to be called every frame for a lasting effect.
The vehicle to be affected by this setting.
A boolean flag. Set to `true` to make the vehicle act as if it's at high speed for the current frame
]]
native "SET_VEHICLE_ACTIVE_DURING_PLAYBACK"
hash "0xDFFCEF48E511DB48"
jhash (0xEB7D7C27)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0xDFFCEF48E511DB48"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_VEHICLE_ACTIVE_FOR_PED_NAVIGATION"
hash "0x21115BCD6E44656A"
jhash (0xEBC225C1)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x21115BCD6E44656A"
alias "_SET_VEHICLE_CLOSE_DOOR_DEFERED_ACTION"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_VEHICLE_ALARM"
hash "0xCDE5E70C1DDB954C"
jhash (0x24877D84)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "state" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_VEHICLE_ALLOW_NO_PASSENGERS_LOCKON"
hash "0x5D14D4154BFE7B2C"
jhash (0x8BAAC437)
arguments {
Vehicle "veh" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
Makes the vehicle accept no passengers.
```
]]
native "SET_VEHICLE_AUTOMATICALLY_ATTACHES"
hash "0x8BA6F76BC53A1493"
jhash (0x4273A8D3)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
ns "VEHICLE"
returns "Any"
doc [[!
]]
native "SET_VEHICLE_BODY_HEALTH"
hash "0xB77D05AC8C78AADB"
jhash (0x920C2517)
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "value" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
p2 often set to 1000.0 in the decompiled scripts.
```
]]
native "SET_VEHICLE_BRAKE"
hash "0xE4E2FD323574965C"
jhash (0x5A36BC37)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0xE4E2FD323574965C"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_VEHICLE_BRAKE_LIGHTS"
hash "0x92B35082E0B42F66"
jhash (0x6D9BA11E)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_VEHICLE_BULLDOZER_ARM_POSITION"
hash "0xF8EBCCC96ADB9FB7"
jhash (0xED23C8A3)
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "position" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
alias "0xF8EBCCC96ADB9FB7"
ns "VEHICLE"
returns "void"
doc [[!
Sets the arm position of a bulldozer. Position must be a value between 0.0 and 1.0. Ignored when `p2` is set to false, instead incrementing arm position by 0.1 (or 10%).
]]
native "SET_VEHICLE_BURNOUT"
hash "0xFB8794444A7D60FB"
jhash (0x9B6EF0EA)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
On accelerating, spins the driven wheels with the others braked, so you don't go anywhere.
```
]]
native "SET_VEHICLE_CAN_BE_TARGETTED"
hash "0x3750146A28097A82"
jhash (0x64B70B1D)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "state" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
This has not yet been tested - it's just an assumption of what the types could be.
```
]]
native "SET_VEHICLE_CAN_BE_USED_BY_FLEEING_PEDS"
hash "0x300504B23BD3B711"
jhash (0x5130DB1E)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x300504B23BD3B711"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_VEHICLE_CAN_BE_VISIBLY_DAMAGED"
hash "0x4C7028F78FFD3681"
jhash (0xC5D94017)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "state" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_VEHICLE_CAN_BREAK"
hash "0x59BF8C3D52C92F66"
jhash (0x90A810D1)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_VEHICLE_CAN_DEFORM_WHEELS"
hash "0x0CDDA42F9E360CA6"
jhash (0x9B581DE7)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x0CDDA42F9E360CA6"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_VEHICLE_CAN_LEAK_OIL"
hash "0x51BB2D88D31A914B"
jhash (0x88F0F7E7)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x51BB2D88D31A914B"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_VEHICLE_CAN_LEAK_PETROL"
hash "0x192547247864DFDD"
jhash (0x90D6EE57)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x192547247864DFDD"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_VEHICLE_CAN_SAVE_IN_GARAGE"
hash "0x428BACCDF5E26EAD"
jhash (0x1604C2F5)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x428BACCDF5E26EAD"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_VEHICLE_CEILING_HEIGHT"
hash "0xA46413066687A328"
jhash (0x98A10A86)
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "height" [=[ {} ]=],
}
alias "GET_VEHICLE_DEFORMATION_GET_TREE"
ns "VEHICLE"
returns "void"
doc [[!
```
Previously named GET_VEHICLE_DEFORMATION_GET_TREE (hash collision)
from Decrypted Scripts I found
VEHICLE::SET_VEHICLE_CEILING_HEIGHT(l_BD9[2/*2*/], 420.0);
```
]]
native "SET_VEHICLE_CHEAT_POWER_INCREASE"
hash "0xB59E4BD37AE292DB"
jhash (0x642DA5AA)
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "value" [=[ {} ]=],
}
alias "_SET_VEHICLE_ENGINE_TORQUE_MULTIPLIER"
ns "VEHICLE"
returns "void"
doc [[!
```
<1.0 - Decreased torque
=1.0 - Default torque
>1.0 - Increased torque
Negative values will cause the vehicle to go backwards instead of forwards while accelerating.
value - is between 0.2 and 1.8 in the decompiled scripts.
This needs to be called every frame to take effect.
```
]]
native "SET_VEHICLE_COLOUR_COMBINATION"
hash "0x33E8CD3322E2FE31"
jhash (0xA557AEAD)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "colorCombination" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
Sets the selected vehicle's colors to their default value (specific variant specified using the colorCombination parameter).
Range of possible values for colorCombination is currently unknown, I couldn't find where these values are stored either (Disquse's guess was vehicles.meta but I haven't seen it in there.)
The vehicle to modify.
One of the default color values of the vehicle.
]]
native "SET_VEHICLE_COLOURS"
hash "0x4F1D4BE3A7F24601"
jhash (0x57F24253)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "colorPrimary" [=[ {} ]=],
int "colorSecondary" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
colorPrimary & colorSecondary are the paint indexes for the vehicle.
For a list of valid paint indexes, view: pastebin.com/pwHci0xK
]]
native "SET_VEHICLE_CUSTOM_PRIMARY_COLOUR"
hash "0x7141766F91D15BEA"
jhash (0x8DF9F9BC)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "r" [=[ {} ]=],
int "g" [=[ {} ]=],
int "b" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
p1, p2, p3 are RGB values for color (255,0,0 for Red, ect)
```
]]
native "SET_VEHICLE_CUSTOM_SECONDARY_COLOUR"
hash "0x36CED73BFED89754"
jhash (0x9D77259E)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "r" [=[ {} ]=],
int "g" [=[ {} ]=],
int "b" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
p1, p2, p3 are RGB values for color (255,0,0 for Red, ect)
```
]]
native "SET_VEHICLE_DAMAGE"
hash "0xA1DD317EA8FD4F29"
jhash (0x21B458B2)
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "xOffset" [=[ {} ]=],
float "yOffset" [=[ {} ]=],
float "zOffset" [=[ {} ]=],
float "damage" [=[ {} ]=],
float "radius" [=[ {} ]=],
BOOL "focusOnModel" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
Apply damage to vehicle at a location. Location is relative to vehicle model (not world).
Radius of effect damage applied in a sphere at impact location
When `focusOnModel` set to `true`, the damage sphere will travel towards the vehicle from the given point, thus guaranteeing an impact
the size of the damage sphere to apply
when set to `true`, the damage sphere will travel towards the vehicle from the given point, thus guaranteeing an impact
]]
native "SET_VEHICLE_DEFORMATION_FIXED"
hash "0x953DA1E1B12C0491"
jhash (0xDD2920C8)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
This fixes the deformation of a vehicle but the vehicle health doesn't improve
```
]]
native "SET_VEHICLE_DENSITY_MULTIPLIER_THIS_FRAME"
hash "0x245A6883D966D537"
jhash (0xF4187E51)
arguments {
float "multiplier" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
**Usage:**
* Use this native inside a looped function.
* Values:
* `0.0` = no vehicles on streets
* `1.0` = normal vehicles on streets
`1.0` Seems to be the maximum.
]]
native "SET_VEHICLE_DIRT_LEVEL"
hash "0x79D3B596FE44EE8B"
jhash (0x2B39128B)
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "dirtLevel" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
Sets the dirt level of the passed vehicle.
The vehicle to set.
A number between 0.0 and 15.0 representing the vehicles dirt level.
]]
native "SET_VEHICLE_DISABLE_TOWING"
hash "0x2B6747FAA9DB9D6B"
jhash (0x95A9ACCB)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x2B6747FAA9DB9D6B"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_VEHICLE_DOOR_BROKEN"
hash "0xD4D4F6A4AB575A33"
jhash (0x8147FEA7)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "doorIndex" [=[ {} ]=],
BOOL "deleteDoor" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
See eDoorId declared in [`SET_VEHICLE_DOOR_SHUT`](#\_0x93D9BD300D7789E5)
]]
native "SET_VEHICLE_DOOR_CONTROL"
hash "0xF2BFA0430F0A0FCB"
jhash (0x572DD360)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "doorIndex" [=[ {} ]=],
int "speed" [=[ {} ]=],
float "angle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
See eDoorId declared in [`SET_VEHICLE_DOOR_SHUT`](#\_0x93D9BD300D7789E5)
5 is fast, 1 is slow 3 is medium
]]
native "SET_VEHICLE_DOOR_LATCHED"
hash "0xA5A9653A8D2CAF48"
jhash (0x4EB7BBFC)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "doorIndex" [=[ {} ]=],
BOOL "forceClose" [=[ {} ]=],
BOOL "lock" [=[ {} ]=],
BOOL "p4" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
See eDoorId declared in [`SET_VEHICLE_DOOR_SHUT`](#\_0x93D9BD300D7789E5)
]]
native "SET_VEHICLE_DOOR_OPEN"
hash "0x7C65DAC73C35C862"
jhash (0xBB75D38B)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "doorIndex" [=[ {} ]=],
BOOL "loose" [=[ {} ]=],
BOOL "openInstantly" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
Sets the specified door index open on the passed vehicle. See [`IS_VEHICLE_DOOR_FULLY_OPEN`](#\_0x3E933CFF7B111C22).
Vehicle.
Index of the door you want to open (0-7)
Whether the door is "loose" (if true the doors have no "spring" and can be closed easily.)
Whether the doors open instantly (if true this native seems to ignore loose)
]]
native "SET_VEHICLE_DOOR_SHUT"
hash "0x93D9BD300D7789E5"
jhash (0x142606BD)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "doorIndex" [=[ {} ]=],
BOOL "closeInstantly" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
Sets the specified door index shut on the passed vehicle.
```cpp
enum eDoorId
{
VEH_EXT_DOOR_DSIDE_F = 0,
VEH_EXT_DOOR_DSIDE_R = 1,
VEH_EXT_DOOR_PSIDE_F = 2,
VEH_EXT_DOOR_PSIDE_R = 3,
VEH_EXT_BONNET = 4,
VEH_EXT_BOOT = 5,
// 0x872E72B8 = 0xFFFFFFFF,
}
```
Vehicle.
Index of the door you want to close.
Whether the doors close instantly.
]]
native "SET_VEHICLE_DOORS_LOCKED"
hash "0xB664292EAECF7FA6"
jhash (0x4CDD35D0)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "doorLockStatus" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
Locks the doors of a specified vehicle to a defined lock state, affecting how players and NPCs can interact with the vehicle.
```
NativeDB Introduced: v323
```
```cpp
enum eVehicleLockState {
// No specific lock state, vehicle behaves according to the game's default settings.
VEHICLELOCK_NONE = 0,
// Vehicle is fully unlocked, allowing free entry by players and NPCs.
VEHICLELOCK_UNLOCKED = 1,
// Vehicle is locked, preventing entry by players and NPCs.
VEHICLELOCK_LOCKED = 2,
// Vehicle locks out only players, allowing NPCs to enter.
VEHICLELOCK_LOCKOUT_PLAYER_ONLY = 3,
// Vehicle is locked once a player enters, preventing others from entering.
VEHICLELOCK_LOCKED_PLAYER_INSIDE = 4,
// Vehicle starts in a locked state, but may be unlocked through game events.
VEHICLELOCK_LOCKED_INITIALLY = 5,
// Forces the vehicle's doors to shut and lock.
VEHICLELOCK_FORCE_SHUT_DOORS = 6,
// Vehicle is locked but can still be damaged.
VEHICLELOCK_LOCKED_BUT_CAN_BE_DAMAGED = 7,
// Vehicle is locked, but its trunk/boot remains unlocked.
VEHICLELOCK_LOCKED_BUT_BOOT_UNLOCKED = 8,
// Vehicle is locked and does not allow passengers, except for the driver.
VEHICLELOCK_LOCKED_NO_PASSENGERS = 9,
// Vehicle is completely locked, preventing entry entirely, even if previously inside.
VEHICLELOCK_CANNOT_ENTER = 10
};
```
The vehicle whose doors are to be locked.
The lock state to apply to the vehicle's doors, see `eVehicleLockState`.
]]
native "SET_VEHICLE_DOORS_LOCKED_FOR_ALL_PLAYERS"
hash "0xA2F80B8D040727CC"
jhash (0x891BA8A4)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_VEHICLE_DOORS_LOCKED_FOR_NON_SCRIPT_PLAYERS"
hash "0x9737A37136F07E75"
jhash (0xE4EF6514)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x9737A37136F07E75"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_VEHICLE_DOORS_LOCKED_FOR_PLAYER"
hash "0x517AAF684BB50CD1"
jhash (0x49829236)
arguments {
Vehicle "vehicle" [=[ {} ]=],
Player "player" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_VEHICLE_DOORS_LOCKED_FOR_TEAM"
hash "0xB81F6D4A8F5EEBA8"
jhash (0x4F85E783)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "team" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_VEHICLE_DOORS_SHUT"
hash "0x781B3D62BB013EF5"
jhash (0xBB1FF6E7)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "closeInstantly" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
Closes all doors of a vehicle:
```
]]
native "SET_VEHICLE_DROPS_MONEY_WHEN_BLOWN_UP"
hash "0x068F64F2470F9656"
jhash (0x4BB5605D)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x068F64F2470F9656"
alias "_SET_VEHICLE_CREATES_MONEY_PICKUPS_WHEN_EXPLODED"
ns "VEHICLE"
returns "void"
doc [[!
```
Money pickups are created around cars when they explode. Only works when the vehicle model is a car. A single pickup is between 1 and 18 dollars in size. All car models seem to give the same amount of money.
youtu.be/3arlUxzHl5Y
i.imgur.com/WrNpYFs.jpg
```
]]
native "SET_VEHICLE_ENGINE_CAN_DEGRADE"
hash "0x983765856F2564F9"
jhash (0x081DAC12)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_VEHICLE_ENGINE_HEALTH"
hash "0x45F6D8EEF34ABEF1"
jhash (0x1B760FB5)
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "health" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
1000 is max health
Begins leaking gas at around 650 health
-999.90002441406 appears to be minimum health, although nothing special occurs <- false statement
-------------------------
Minimum: -4000
Maximum: 1000
-4000: Engine is destroyed
0 and below: Engine catches fire and health rapidly declines
300: Engine is smoking and losing functionality
1000: Engine is perfect
```
]]
native "SET_VEHICLE_ENGINE_ON"
hash "0x2497C4717C8B881E"
jhash (0x7FBC86F1)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "value" [=[ {} ]=],
BOOL "instantly" [=[ {} ]=],
BOOL "disableAutoStart" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
Starts or stops the engine on the specified vehicle.
From what I've tested when I do this to a helicopter the propellers turn off after the engine has started.
The vehicle to start or stop the engine on.
true to turn the vehicle on; false to turn it off.
if true, the vehicle will be set to the state immediately; otherwise, the current driver will physically turn on or off the engine.
If true, the system will prevent the engine from starting when the player got into it.
]]
native "SET_VEHICLE_ENVEFF_SCALE"
hash "0x3AFDC536C3D01674"
jhash (0x8332730C)
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "fade" [=[ {} ]=],
}
alias "_SET_VEHICLE_PAINT_FADE"
ns "VEHICLE"
returns "void"
doc [[!
Examples with a besra:
* [fade value `0.0`](https://i.imgur.com/DXNk63e.jpg)
* [fade value `0.5`](https://i.imgur.com/2Vb35fq.jpg)
* [fade value `1.0`](https://i.imgur.com/aa8cxaD.jpg)
The parameter fade is a value from 0-1, where 0 is fresh paint.
Target vehicle
The paint fade effect strength
]]
native "SET_VEHICLE_EXCLUSIVE_DRIVER"
hash "0x41062318F23ED854"
jhash (0xFF62D324)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {"cs_type":"Ped"} ]=],
}
alias "0x41062318F23ED854"
ns "VEHICLE"
returns "void"
doc [[!
Incorrectly named `SET_VEHICLE_EXCLUSIVE_DRIVER`; likely `SET_VEHICLE_ALLOW_*`.
Toggles a flag related to `SET_VEHICLE_EXCLUSIVE_DRIVER`, however, doesn't enable that feature (or trigger script events related to it).
See [`_SET_VEHICLE_EXCLUSIVE_DRIVER_2`](#\_0xB5C51B5502E85E83).
```
NativeDB Removed Parameter 2: int index
```
]]
native "SET_VEHICLE_EXPLODES_ON_HIGH_EXPLOSION_DAMAGE"
hash "0x71B0892EC081D60A"
jhash (0x38CC692B)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
Sets a vehicle to be strongly resistant to explosions. p0 is the vehicle; set p1 to false to toggle the effect on/off.
```
]]
native "SET_VEHICLE_EXTENDED_REMOVAL_RANGE"
hash "0x79DF7E806202CE01"
jhash (0xAEF9611C)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "range" [=[ {} ]=],
}
alias "0x79DF7E806202CE01"
ns "VEHICLE"
returns "void"
doc [[!
```
Max value is 32767
```
]]
native "SET_VEHICLE_EXTRA"
hash "0x7EE3A3C5E4A40CC9"
jhash (0x642D065C)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "extraId" [=[ {} ]=],
BOOL "disable" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
Note: only some vehicle have extras
extra ids are from 1 - 9 depending on the vehicle
-------------------------------------------------
^ not sure if outdated or simply wrong. Max extra ID for b944 is 14
-------------------------------------------------
p2 is not a on/off toggle. mostly 0 means on and 1 means off.
not sure if it really should be a BOOL.
-------------------------------------------------
Confirmed p2 does not work as a bool. Changed to int. [0=on, 1=off]
```
]]
native "SET_VEHICLE_EXTRA_COLOURS"
hash "0x2036F561ADD12E33"
jhash (0x515DB2A0)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "pearlescentColor" [=[ {} ]=],
int "wheelColor" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
They use the same color indexs as SET_VEHICLE_COLOURS.
```
]]
native "SET_VEHICLE_FIXED"
hash "0x115722B1B9C14C1C"
jhash (0x17469AA1)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
Fix a given vehicle.
If the vehicle's engine's broken then you cannot fix it with this native.
The vehicle that will be fixed
]]
native "SET_VEHICLE_FLIGHT_NOZZLE_POSITION"
hash "0x30D779DE7C4F6DD3"
jhash (0xA7DF64D7)
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "angleRatio" [=[ {} ]=],
}
alias "0x30D779DE7C4F6DD3"
alias "_SET_DESIRED_VERTICAL_FLIGHT_PHASE"
alias "_SET_PLANE_VTOL_DESIRED_DIRECTION"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_VEHICLE_FLIGHT_NOZZLE_POSITION_IMMEDIATE"
hash "0x9AA47FFF660CB932"
jhash (0xDD7936F5)
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "angle" [=[ {} ]=],
}
alias "0x9AA47FFF660CB932"
alias "_SET_VERTICAL_FLIGHT_PHASE"
alias "_SET_PLANE_VTOL_DIRECTION"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_VEHICLE_FORCE_AFTERBURNER"
hash "0xB055A34527CB8FD7"
jhash (0xC195803B)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0xB055A34527CB8FD7"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_VEHICLE_FORWARD_SPEED"
hash "0xAB54A438726D25D5"
jhash (0x69880D14)
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "speed" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
SCALE: Setting the speed to 30 would result in a speed of roughly 60mph, according to speedometer.
Speed is in meters per second
You can convert meters/s to mph here:
http://www.calculateme.com/Speed/MetersperSecond/ToMilesperHour.htm
```
]]
native "SET_VEHICLE_FRICTION_OVERRIDE"
hash "0x1837AF7C627009BA"
jhash (0x32AFD42E)
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "friction" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
Seems to be related to the metal parts, not tyres (like i was expecting lol)
Must be called every tick.
```
]]
native "SET_VEHICLE_FULLBEAM"
hash "0x8B7FD87F0DDB421E"
jhash (0x9C49CC15)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
It switch to highbeam when p1 is set to true.
```
]]
native "SET_VEHICLE_GENERATES_ENGINE_SHOCKING_EVENTS"
hash "0x279D50DE5652D935"
jhash (0xB3200F72)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x279D50DE5652D935"
ns "VEHICLE"
returns "void"
doc [[!
```
Allows creation of CEventShockingPlaneFlyby, CEventShockingHelicopterOverhead, and other(?) Shocking events
```
]]
native "SET_VEHICLE_GENERATOR_AREA_OF_INTEREST"
hash "0x9A75585FB2E54FAD"
jhash (0x935A95DA)
arguments {
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "radius" [=[ {} ]=],
}
alias "0x9A75585FB2E54FAD"
ns "VEHICLE"
returns "void"
doc [[!
Specifies an area of interest where cargens will focus on spawning vehicles
You can clear the area of interest with [`CLEAR_VEHICLE_GENERATOR_AREA_OF_INTEREST`](#\_0x0A436B8643716D14)
The X coordinate of the central point of the area of interest.
The Y coordinate of the central point of the area of interest.
The Z coordinate of the central point of the area of interest.
The radius around the central point, defining the size of the area of interest
]]
native "SET_VEHICLE_GRAVITY"
hash "0x89F149B6131E57DA"
jhash (0x07B2A6DC)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_VEHICLE_HANDBRAKE"
hash "0x684785568EF26A22"
jhash (0xBA729A25)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_VEHICLE_HAS_BEEN_DRIVEN_FLAG"
hash "0x02398B627547189C"
jhash (0x08CD58F9)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x02398B627547189C"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_VEHICLE_HAS_BEEN_OWNED_BY_PLAYER"
hash "0x2B5F9D2AF1F1722D"
jhash (0xB4D3DBFB)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "owned" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_VEHICLE_HAS_MUTED_SIRENS"
hash "0xD8050E0EB60CF274"
jhash (0xC54156A9)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "DISABLE_VEHICLE_IMPACT_EXPLOSION_ACTIVATION"
alias "_SET_DISABLE_VEHICLE_SIREN_SOUND"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_VEHICLE_HAS_STRONG_AXLES"
hash "0x92F0CF722BC4202F"
jhash (0x0D1CBC65)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
if true, axles won't bend.
```
]]
native "SET_VEHICLE_HAS_UNBREAKABLE_LIGHTS"
hash "0x1AA8A837D2169D94"
jhash (0x009AB49E)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x1AA8A837D2169D94"
alias "_SET_VEHICLE_LIGHTS_CAN_BE_VISIBLY_DAMAGED"
ns "VEHICLE"
returns "void"
doc [[!
Sets whether the vehicle's lights can be broken.
```
NativeDB Introduced: v323
```
The target vehicle.
Set the lights' breakability `true` makes lights unbreakable, `false` allows them to break.
]]
native "SET_VEHICLE_HEADLIGHT_SHADOWS"
hash "0x1FD09E7390A74D54"
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "flag" [=[ {} ]=],
}
alias "0x1FD09E7390A74D54"
alias "_SET_VEHICLE_LIGHTS_MODE"
ns "VEHICLE"
returns "void"
doc [[!
Sets the vehicle headlight shadow flags.
```
NativeDB Introduced: v323
```
```cpp
enum eVehicleHeadlightShadowFlags {
// Default (Lights can be toggled between off, normal and high beams)
NO_HEADLIGHT_SHADOWS = 0,
// Lights Disabled (Lights are fully disabled, cannot be toggled)
HEADLIGHTS_CAST_DYNAMIC_SHADOWS = 1,
// Always On (Lights can be toggled between normal and high beams)
HEADLIGHTS_CAST_STATIC_SHADOWS = 2,
HEADLIGHTS_CAST_FULL_SHADOWS = 3
};
```
The target vehicle.
A value from `eVehicleHeadlightShadowFlags` representing the desired headlight shadow flag.
]]
native "SET_VEHICLE_INACTIVE_DURING_PLAYBACK"
hash "0x06582AFF74894C75"
jhash (0x50F89338)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x06582AFF74894C75"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_VEHICLE_INDICATOR_LIGHTS"
hash "0xB5D45264751B7DF0"
jhash (0xA6073B5D)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "turnSignal" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
Sets the turn signal enabled for a vehicle.
Set turnSignal to 1 for left light, 0 for right light.
```
]]
native "SET_VEHICLE_INDIVIDUAL_DOORS_LOCKED"
hash "0xBE70724027F85BCD"
jhash (0xD61D182D)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "doorIndex" [=[ {} ]=],
int "doorLockStatus" [=[ {} ]=],
}
alias "SET_PED_TARGETTABLE_VEHICLE_DESTROY"
alias "_SET_VEHICLE_DOOR_DESTROY_TYPE"
ns "VEHICLE"
returns "void"
doc [[!
See eDoorId declared in [`SET_VEHICLE_DOOR_SHUT`](#\_0x93D9BD300D7789E5)
See eCarLock declared in [`SET_VEHICLE_DOORS_LOCKED`](#\_0xB664292EAECF7FA6)
]]
native "SET_VEHICLE_INFLUENCES_WANTED_LEVEL"
hash "0x0AD9E8F87FF7C16F"
jhash (0x04F5546C)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "influenceWantedLevel" [=[ {} ]=],
}
alias "0x0AD9E8F87FF7C16F"
ns "VEHICLE"
returns "void"
doc [[!
This native sets whether a specific vehicle influences the player's wanted level when it is involved in an incident that typically triggers a wanted response, such as being marked as a "victim" vehicle.
This is particularly useful when utilizing the wanted system from GTA, and you want to prevent a vehicle from affecting the wanted level when it is stolen. In the decompiled scripts this native is only used to disable the influence of the vehicle on the wanted level.
The specific vehicle to be set for influencing the wanted level.
A boolean value. Set to `true` to make the vehicle influence the wanted level; `false` to prevent it from doing so.
]]
native "SET_VEHICLE_INTERIORLIGHT"
hash "0xBC2042F090AF6AD3"
jhash (0x9AD1FE1E)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_VEHICLE_IS_CONSIDERED_BY_PLAYER"
hash "0x31B927BBC44156CD"
jhash (0x14413319)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
Setting this to false, makes the specified vehicle to where if you press Y your character doesn't even attempt the animation to enter the vehicle. Hence it's not considered aka ignored.
```
]]
native "SET_VEHICLE_IS_RACING"
hash "0x07116E24E9D1929D"
jhash (0xA59E3DCD)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "STEER_UNLOCK_BIAS"
ns "VEHICLE"
returns "void"
doc [[!
```
p1 (toggle) was always 1 (true) except in one case in the b678 scripts.
```
]]
native "SET_VEHICLE_IS_STOLEN"
hash "0x67B2C79AA7FF5738"
jhash (0x70912E42)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "isStolen" [=[ {} ]=],
}
ns "VEHICLE"
annotations [=[ {"cs_type":"Any"} ]=]
returns "void"
doc [[!
]]
native "SET_VEHICLE_IS_WANTED"
hash "0xF7EC25A3EBEEC726"
jhash (0xDAA388E8)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "state" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
Sets the wanted state of this vehicle.
```
]]
native "SET_VEHICLE_KEEP_ENGINE_ON_WHEN_ABANDONED"
hash "0xB8FBC8B1330CA9B4"
jhash (0x51E0064F)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0xB8FBC8B1330CA9B4"
alias "_SET_VEHICLE_JET_ENGINE_ON"
ns "VEHICLE"
returns "void"
doc [[!
Calling this native will keep a vehicle's engine running after exiting.
The vehicle handle.
`true` to keep the engine on, otherwise `false`.
]]
native "SET_VEHICLE_KERS_ALLOWED"
hash "0x99C82F8A139F3E4E"
jhash (0x71CDD52F)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x99C82F8A139F3E4E"
alias "_SET_VEHICLE_HUD_SPECIAL_ABILITY_BAR_ACTIVE"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_VEHICLE_LIGHT_MULTIPLIER"
hash "0xB385454F8791F57C"
jhash (0x48039D6A)
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "multiplier" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
This multiplier has no limit, by default the game has this set to `1.0`.
The vehicle handle.
The multiplier applied to the vehicle's headlights.
]]
native "SET_VEHICLE_LIGHTS"
hash "0x34E710FF01247C5A"
jhash (0xE8930226)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "state" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
Sets the vehicle lights state. Allowing for different lighting modes.
```
NativeDB Introduced: v323
```
```cpp
enum eVehicleLightSetting {
// Normal light behavior. Lights cycle through off, then low beams, then high beams.
// Note: It's affected by day or night; high beams don't exist in daytime.
NO_VEHICLE_LIGHT_OVERRIDE = 0,
// Vehicle doesn't have lights, always off.
FORCE_VEHICLE_LIGHTS_OFF = 1,
// Vehicle has always-on lights.
// During day: Cycles between low beams and high beams.
// At night: Cycles between low beams, low beams, and high beams.
FORCE_VEHICLE_LIGHTS_ON = 2,
// Sets vehicle lights on. Behaves like normal lights (same as 0).
SET_VEHICLE_LIGHTS_ON = 3,
// Sets vehicle lights off. Behaves like normal lights (same as 0).
SET_VEHICLE_LIGHTS_OFF = 4
};
```
The target vehicle.
A value from `eVehicleLightSetting` representing the desired light setting.
]]
native "SET_VEHICLE_LIVERY"
hash "0x60BF608F1B8CD1B6"
jhash (0x7AD87059)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "livery" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_VEHICLE_LOD_MULTIPLIER"
hash "0x93AE6A61BE015BF1"
jhash (0x569E5AE3)
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "multiplier" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_VEHICLE_MOD"
hash "0x6AF0636DDEDCB6DD"
jhash (0xB52E5ED5)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "modType" [=[ {} ]=],
int "modIndex" [=[ {} ]=],
BOOL "customTires" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```cpp
// eVehicleModType values modified to conform to script native reorganization (see 0x140D25327 in 1604).
enum eVehicleModType
{
VMT_SPOILER = 0,
VMT_BUMPER_F = 1,
VMT_BUMPER_R = 2,
VMT_SKIRT = 3,
VMT_EXHAUST = 4,
VMT_CHASSIS = 5,
VMT_GRILL = 6,
VMT_BONNET = 7,
VMT_WING_L = 8,
VMT_WING_R = 9,
VMT_ROOF = 10,
VMT_ENGINE = 11,
VMT_BRAKES = 12,
VMT_GEARBOX = 13,
VMT_HORN = 14,
VMT_SUSPENSION = 15,
VMT_ARMOUR = 16,
VMT_NITROUS = 17,
VMT_TURBO = 18,
VMT_SUBWOOFER = 19,
VMT_TYRE_SMOKE = 20,
VMT_HYDRAULICS = 21,
VMT_XENON_LIGHTS = 22,
VMT_WHEELS = 23,
VMT_WHEELS_REAR_OR_HYDRAULICS = 24,
VMT_PLTHOLDER = 25,
VMT_PLTVANITY = 26,
VMT_INTERIOR1 = 27,
VMT_INTERIOR2 = 28,
VMT_INTERIOR3 = 29,
VMT_INTERIOR4 = 30,
VMT_INTERIOR5 = 31,
VMT_SEATS = 32,
VMT_STEERING = 33,
VMT_KNOB = 34,
VMT_PLAQUE = 35,
VMT_ICE = 36,
VMT_TRUNK = 37,
VMT_HYDRO = 38,
VMT_ENGINEBAY1 = 39,
VMT_ENGINEBAY2 = 40,
VMT_ENGINEBAY3 = 41,
VMT_CHASSIS2 = 42,
VMT_CHASSIS3 = 43,
VMT_CHASSIS4 = 44,
VMT_CHASSIS5 = 45,
VMT_DOOR_L = 46,
VMT_DOOR_R = 47,
VMT_LIVERY_MOD = 48,
VMT_LIGHTBAR = 49,
};
```
]]
native "SET_VEHICLE_MOD_COLOR_1"
hash "0x43FEB945EE7F85B8"
jhash (0xCBE9A54D)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "paintType" [=[ {} ]=],
int "color" [=[ {} ]=],
int "pearlescentColor" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
paintType:
0: Normal
1: Metallic
2: Pearl
3: Matte
4: Metal
5: Chrome
color: number of the color.
p3 seems to always be 0.
```
]]
native "SET_VEHICLE_MOD_COLOR_2"
hash "0x816562BADFDEC83E"
jhash (0xC32613C2)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "paintType" [=[ {} ]=],
int "color" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
Changes the secondary paint type and color
paintType:
0: Normal
1: Metallic
2: Pearl
3: Matte
4: Metal
5: Chrome
color: number of the color
```
]]
native "SET_VEHICLE_MOD_KIT"
hash "0x1F2AA07F00B3217A"
jhash (0xB8132158)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "modKit" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
Set modKit to 0 if you plan to call SET_VEHICLE_MOD. That's what the game does. Most body modifications through SET_VEHICLE_MOD will not take effect until this is set to 0.
```
]]
native "SET_VEHICLE_MODEL_IS_SUPPRESSED"
hash "0x0FC2D89AC25A5814"
jhash (0x42A08C9B)
arguments {
Hash "model" [=[ {} ]=],
BOOL "suppressed" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
seems to make the vehicle stop spawning naturally in traffic. Here's an essential example:
VEHICLE::SET_VEHICLE_MODEL_IS_SUPPRESSED(GAMEPLAY::GET_HASH_KEY("taco"), true);
```
]]
native "SET_VEHICLE_NAME_DEBUG"
hash "0xBFDF984E2C22B94F"
jhash (0xA712FF5C)
arguments {
Vehicle "vehicle" [=[ {} ]=],
charPtr "name" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
This method is utilized solely for debugging purposes and is functional only in debug builds of the game. Please note that its functionality may not be available in the retail version.
The vehicle id.
Debug name.
]]
native "SET_VEHICLE_NEEDS_TO_BE_HOTWIRED"
hash "0xFBA550EA44404EE6"
jhash (0xD8260751)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_VEHICLE_NUMBER_PLATE_TEXT"
hash "0x95A88F0B409CDA47"
jhash (0x400F9556)
arguments {
Vehicle "vehicle" [=[ {} ]=],
charPtr "plateText" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
The vehicle to set the plate for
The text to set the plate to, 8 chars maximum
]]
native "SET_VEHICLE_NUMBER_PLATE_TEXT_INDEX"
hash "0x9088EB5A43FFB0A1"
jhash (0xA1A1890E)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "plateIndex" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
Please refer to [`GET_VEHICLE_NUMBER_PLATE_TEXT_INDEX`](#\_0xF11BC2DD9A3E7195) for plate indicies.
The vehicle handle.
The style to use for the plate, see plate styles.
]]
native "SET_VEHICLE_ON_GROUND_PROPERLY"
hash "0x49733E92263139D1"
jhash (0xE14FDBA6)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
```
Sets a vehicle on the ground on all wheels. Returns whether or not the operation was successful.
```
```
NativeDB Added Parameter 2: float p1
```
]]
native "SET_VEHICLE_OUT_OF_CONTROL"
hash "0xF19D095E42D430CC"
jhash (0x3764D734)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "killDriver" [=[ {} ]=],
BOOL "explodeOnImpact" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
Tested on the player's current vehicle. Unless you kill the driver, the vehicle doesn't loose control, however, if enabled, explodeOnImpact is still active. The moment you crash, boom.
```
]]
native "SET_VEHICLE_PETROL_TANK_HEALTH"
hash "0x70DB57649FA8D0D8"
jhash (0x660A3692)
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "health" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
1000 is max health
Begins leaking gas at around 650 health
```
]]
native "SET_VEHICLE_PROVIDES_COVER"
hash "0x5AFEEDD9BB2899D7"
jhash (0xEFC01CA9)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_VEHICLE_REDUCE_GRIP"
hash "0x222FF6A823D122E2"
jhash (0x90D3A0D9)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
Reduces grip significantly so it's hard to go anywhere.
```
]]
native "SET_VEHICLE_RUDDER_BROKEN"
hash "0x09606148B6C71DEF"
jhash (0x3FAC3CD4)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_VEHICLE_SEARCHLIGHT"
hash "0x14E85C5EE7A4D542"
jhash (0xE2C0DD8A)
arguments {
Vehicle "heli" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
BOOL "canBeUsedByAI" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
Only works during nighttime.
```
]]
native "SET_VEHICLE_SHOOT_AT_TARGET"
hash "0x74CD9A9327A282EA"
jhash (0x2343FFDF)
arguments {
Ped "driver" [=[ {} ]=],
Entity "entity" [=[ {} ]=],
float "xTarget" [=[ {} ]=],
float "yTarget" [=[ {} ]=],
float "zTarget" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
Commands the driver of an armed vehicle (p0) to shoot its weapon at a target (p1). p3, p4 and p5 are the coordinates of the target. Example:
WEAPON::SET_CURRENT_PED_VEHICLE_WEAPON(pilot,GAMEPLAY::GET_HASH_KEY("VEHICLE_WEAPON_PLANE_ROCKET"));VEHICLE::SET_VEHICLE_SHOOT_AT_TARGET(pilot, target, targPos.x, targPos.y, targPos.z);
```
]]
native "SET_VEHICLE_SIREN"
hash "0xF4924635A19EB37D"
jhash (0x4AC1EFC7)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
Activate siren on vehicle (Only works if the vehicle has a siren).
```
]]
native "SET_VEHICLE_STEER_BIAS"
hash "0x42A8EC77D5150CBE"
jhash (0x7357C1EB)
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "value" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
Locks the vehicle's steering to the desired angle, explained below.
Requires to be called onTick. Steering is unlocked the moment the function stops being called on the vehicle.
Steer bias:
-1.0 = full right
0.0 = centered steering
1.0 = full left
```
]]
native "SET_VEHICLE_STEERING_BIAS_SCALAR"
hash "0x9007A2F21DC108D4"
jhash (0x585E49B6)
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "scalar" [=[ {} ]=],
}
alias "0x9007A2F21DC108D4"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_VEHICLE_STRONG"
hash "0x3E8C8727991A8A0B"
jhash (0xC758D19F)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
If set to true, vehicle will not take crash damage, but is still susceptible to damage from bullets and explosives
```
]]
native "SET_VEHICLE_TANK_TURRET_POSITION"
hash "0x56B94C6D7127DFBA"
jhash (0xB1A52EF7)
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "position" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
alias "0x56B94C6D7127DFBA"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_VEHICLE_TIMED_EXPLOSION"
hash "0x2E0A74E1002380B1"
jhash (0xDB8CB8E2)
arguments {
Vehicle "vehicle" [=[ {} ]=],
Ped "ped" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_VEHICLE_TOW_TRUCK_ARM_POSITION"
hash "0xFE54B92A344583CA"
jhash (0x88236E22)
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "position" [=[ {} ]=],
}
alias "_SET_TOW_TRUCK_CRANE_RAISED"
alias "_SET_TOW_TRUCK_CRANE_HEIGHT"
ns "VEHICLE"
returns "void"
doc [[!
```
Sets how much the crane on the tow truck is raised, where 0.0 is fully lowered and 1.0 is fully raised.
```
]]
native "SET_VEHICLE_TURRET_SPEED_THIS_FRAME"
hash "0x1093408B4B9D1146"
jhash (0xF30C566F)
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "speed" [=[ {} ]=],
}
alias "0x1093408B4B9D1146"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_VEHICLE_TYRE_BURST"
hash "0xEC6A202EE4960385"
jhash (0x89D28068)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "index" [=[ {} ]=],
BOOL "onRim" [=[ {} ]=],
float "p3" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
"To burst tyres VEHICLE::SET_VEHICLE_TYRE_BURST(vehicle, 0, true, 1000.0)
to burst all tyres type it 8 times where p1 = 0 to 7.
p3 seems to be how much damage it has taken. 0 doesn't deflate them, 1000 completely deflates them.
'0 = wheel_lf / bike, plane or jet front
'1 = wheel_rf
'2 = wheel_lm / in 6 wheels trailer, plane or jet is first one on left
'3 = wheel_rm / in 6 wheels trailer, plane or jet is first one on right
'4 = wheel_lr / bike rear / in 6 wheels trailer, plane or jet is last one on left
'5 = wheel_rr / in 6 wheels trailer, plane or jet is last one on right
'45 = 6 wheels trailer mid wheel left
'47 = 6 wheels trailer mid wheel right
```
]]
native "SET_VEHICLE_TYRE_FIXED"
hash "0x6E13FC662B882D1D"
jhash (0xA42EFA6B)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "tyreIndex" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
tyreIndex = 0 to 4 on normal vehicles
'0 = wheel_lf / bike, plane or jet front
'1 = wheel_rf
'2 = wheel_lm / in 6 wheels trailer, plane or jet is first one on left
'3 = wheel_rm / in 6 wheels trailer, plane or jet is first one on right
'4 = wheel_lr / bike rear / in 6 wheels trailer, plane or jet is last one on left
'5 = wheel_rr / in 6 wheels trailer, plane or jet is last one on right
'45 = 6 wheels trailer mid wheel left
'47 = 6 wheels trailer mid wheel right
```
]]
native "SET_VEHICLE_TYRE_SMOKE_COLOR"
hash "0xB5BA80F839791C0F"
jhash (0x3EDEC0DB)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "r" [=[ {} ]=],
int "g" [=[ {} ]=],
int "b" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
Sets the tire smoke's color of this vehicle.
vehicle: The vehicle that is the target of this method.
r: The red level in the RGB color code.
g: The green level in the RGB color code.
b: The blue level in the RGB color code.
Note:
setting r,g,b to 0 will give the car independance day tyre smoke
```
]]
native "SET_VEHICLE_TYRES_CAN_BURST"
hash "0xEB9DC3C7D8596C46"
jhash (0xA198DB54)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
Allows you to toggle bulletproof tires.
```
]]
native "SET_VEHICLE_UNDRIVEABLE"
hash "0x8ABA6AF54B942B95"
jhash (0x48D02A4E)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_VEHICLE_USE_ALTERNATE_HANDLING"
hash "0x1D97D1E3A70A649F"
jhash (0xA03E42DF)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x1D97D1E3A70A649F"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_VEHICLE_USE_CUTSCENE_WHEEL_COMPRESSION"
hash "0xE023E8AC4EF7C117"
jhash (0xA0909ADB)
arguments {
Vehicle "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
}
alias "SET_ALL_VEHICLES_SPAWN"
alias "0xE023E8AC4EF7C117"
ns "VEHICLE"
returns "Any"
doc [[!
]]
native "SET_VEHICLE_USE_PLAYER_LIGHT_SETTINGS"
hash "0xC45C27EF50F36ADC"
jhash (0x4221E435)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0xC45C27EF50F36ADC"
alias "_SET_VEHICLE_USE_PLAYER_LIGHT_SETTINGS"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_VEHICLE_USES_LARGE_REAR_RAMP"
hash "0xCAC66558B944DA67"
jhash (0x0B200CE2)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0xCAC66558B944DA67"
ns "VEHICLE"
returns "void"
doc [[!
```
vehicle must be a plane
```
]]
native "SET_VEHICLE_WEAPON_RESTRICTED_AMMO"
hash "0x44CD1F493DB2A0A6"
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "weaponIndex" [=[ {} ]=],
int "ammoCount" [=[ {} ]=],
}
alias "0x44CD1F493DB2A0A6"
alias "_SET_VEHICLE_WEAPON_CAPACITY"
ns "VEHICLE"
returns "void"
doc [[!
Sets a limited number of ammo for a particular vehicle weapon index on a vehicle.
Information about weapon indexes can be found in `handling.meta`.
In the example given below, `uWeaponHash` defines weapon hashes for the vehicle. Each `- ` corresponds to an index starting from `0`.
```
- VEHICLE_WEAPON_PLAYER_BUZZARD
- VEHICLE_WEAPON_SPACE_ROCKET
- VEHICLE_WEAPON_SEARCHLIGHT
```
The vehicle handle
The weapon index we're setting ammo for (between `0` and `3`), see description for more.
When set positive, will count down with every fire and prevent firing at `0`. Set `-1` to disable restricted ammo.
]]
native "SET_VEHICLE_WHEEL_TYPE"
hash "0x487EB21CC7295BA1"
jhash (0x64BDAAAD)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "wheelType" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
Refer to [GET_VEHICLE_WHEEL_TYPE](#\_0xB3ED1BFB4BE636DC) for wheel types.
]]
native "SET_VEHICLE_WHEELS_CAN_BREAK"
hash "0x29B18B4FD460CA8F"
jhash (0x829ED654)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "enabled" [=[ {} ]=],
}
ns "VEHICLE"
annotations [=[ {"cs_type":"Any"} ]=]
returns "void"
doc [[!
]]
native "SET_VEHICLE_WHEELS_CAN_BREAK_OFF_WHEN_BLOW_UP"
hash "0xA37B9A517B133349"
jhash (0x670913A4)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "SET_VEHICLE_MAX_STR_TRAP"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SET_VEHICLE_WINDOW_TINT"
hash "0x57C51E6BAD752696"
jhash (0x497C8787)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "tint" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```cpp
enum WindowTints
{
WINDOWTINT_NONE = 0,
WINDOWTINT_PURE_BLACK = 1,
WINDOWTINT_DARKSMOKE = 2,
WINDOWTINT_LIGHTSMOKE = 3,
WINDOWTINT_STOCK = 4,
WINDOWTINT_LIMO = 5,
WINDOWTINT_GREEN = 6
};
```
]]
native "SKIP_TIME_IN_PLAYBACK_RECORDED_VEHICLE"
hash "0x9438F7AD68771A20"
jhash (0xCF3EFA4B)
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "time" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
SET_TIME_POSITION_IN_RECORDING can be emulated by: desired_time - GET_TIME_POSITION_IN_RECORDING(vehicle)
```
]]
native "SKIP_TO_END_AND_STOP_PLAYBACK_RECORDED_VEHICLE"
hash "0xAB8E2EDA0C0A5883"
jhash (0x8DEA18C8)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SMASH_VEHICLE_WINDOW"
hash "0x9E5B5E4D2CCD2259"
jhash (0xDDD9A8C2)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "windowIndex" [=[ {} ]=],
}
ns "VEHICLE"
annotations [=[ {"cs_type":"Any"} ]=]
returns "void"
doc [[!
Smashes a vehicles window. See eWindowId declared in [`IS_VEHICLE_WINDOW_INTACT`](#\_0x46E571A0E20D01F1).
The vehicle id.
Windows to smash index.
]]
native "STABILISE_ENTITY_ATTACHED_TO_HELI"
hash "0x374706271354CB18"
jhash (0x40C4763F)
arguments {
Vehicle "vehicle" [=[ {} ]=],
Entity "entity" [=[ {} ]=],
float "p2" [=[ {} ]=],
}
alias "0x374706271354CB18"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "START_PLAYBACK_RECORDED_VEHICLE"
hash "0x3F878F92B3A7A071"
jhash (0xCF614CA8)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "recording" [=[ {} ]=],
charPtr "script" [=[ {} ]=],
BOOL "p3" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
p3 is some flag related to 'trailers' (invokes CVehicle::GetTrailer).
See [`REQUEST_VEHICLE_RECORDING`](#\_0xAF514CABE74CBF15).
]]
native "START_PLAYBACK_RECORDED_VEHICLE_USING_AI"
hash "0x29DE5FA52D00428C"
jhash (0x8DE8E24E)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "recording" [=[ {} ]=],
charPtr "script" [=[ {"cs_type":"AnyPtr"} ]=],
float "speed" [=[ {} ]=],
int "drivingStyle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
AI abides by the provided driving style (e.g., stopping at red lights or waiting behind traffic) while executing the specificed vehicle recording.
0x1F2E4E06DEA8992B is a related native that deals with the AI physics for such recordings.
```
The driving style (default is 0) (see [SetDriveTaskDrivingStyle](#\_0xDACE1BE37D88AF67)).
]]
native "START_PLAYBACK_RECORDED_VEHICLE_WITH_FLAGS"
hash "0x7D80FD645D4DA346"
jhash (0x4E721AD2)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "recording" [=[ {} ]=],
charPtr "script" [=[ {} ]=],
int "flags" [=[ {} ]=],
int "time" [=[ {} ]=],
int "drivingStyle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
flags requires further research, e.g., 0x4/0x8 are related to the AI driving task and 0x20 is internally set and interacts with dynamic entity components.
time, often zero and capped at 500, is related to SET_PLAYBACK_TO_USE_AI_TRY_TO_REVERT_BACK_LATER
```
The driving style (default is 0) (see [SetDriveTaskDrivingStyle](#\_0xDACE1BE37D88AF67)).
]]
native "START_VEHICLE_ALARM"
hash "0xB8FF7AB45305C345"
jhash (0x5B451FF7)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
annotations [=[ {"cs_type":"Any"} ]=]
returns "void"
doc [[!
]]
native "START_VEHICLE_HORN"
hash "0x9C8C6504B5B63D2C"
jhash (0x0DF5ADB3)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "duration" [=[ {} ]=],
Hash "mode" [=[ {} ]=],
BOOL "forever" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
Sounds the horn for the specified vehicle. Note that if a player is in the vehicle, it will only sound briefly.
Vehicle id
The duration to sound the horn, in milliseconds.
The hash of "NORMAL" or "HELDDOWN". Can be 0.
]]
native "STOP_ALL_GARAGE_ACTIVITY"
hash "0x0F87E938BDF29D66"
jhash (0x17A0BCE5)
ns "VEHICLE"
returns "void"
doc [[!
]]
native "STOP_PLAYBACK_RECORDED_VEHICLE"
hash "0x54833611C17ABDEA"
jhash (0xAE99C57C)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "SWITCH_TRAIN_TRACK"
hash "0xFD813BB7DB977F20"
jhash (0x68BFDD61)
arguments {
int "trackId" [=[ {} ]=],
BOOL "state" [=[ {} ]=],
}
ns "VEHICLE"
annotations [=[ {"cs_type":"Any"} ]=]
returns "void"
doc [[!
Toggles whether ambient trains can spawn on the specified track or not.
| trackId | File | Description |
| --- | --- | --- |
| 0 | `trains1.dat` | Main track around SA |
| 1 | `trains2.dat` | Davis Quartz Quarry branch |
| 2 | `trains3.dat` | Second track alongside live track along Roy Lewenstein Blv. |
| 3 | `trains4.dat` | Metro track circuit |
| 4 | `trains5.dat` | Branch in Mirror Park Railyard |
| 5 | `trains6.dat` | Branch in Mirror Park Railyard |
| 6 | `trains7.dat` | LS branch to Mirror Park Railyard |
| 7 | `trains8.dat` | Overground part of metro track along Forum Dr. |
| 8 | `trains9.dat` | Branch to Mirror Park Railyard |
| 9 | `trains10.dat` | Yankton train |
| 10 | `trains11.dat` | Part of metro track near mission row |
| 11 | `trains12.dat` | Yankton prologue mission train |
Tracks IDs `0` and `3` are the main tracks you find trains on during normal gameplay, all the others are used during missions and are not complete tracks.
The internal id of the train track to switch
Whether ambient trains can spawn or not
None. The original return type is `void`, but ABI compatibility makes this impossible.
]]
native "TOGGLE_VEHICLE_MOD"
hash "0x2A1F4F37F95BAD08"
jhash (0xD095F811)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "modType" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
Enables or disables a vehicle mod by index (`modType`) for a given vehicle.
`eVehicleModType` enum, used for `modType` index can be found under [`SET_VEHICLE_MOD`](#\_0x6AF0636DDEDCB6DD).
The vehicle handle
Refer to eVehicleModType in [`SET_VEHICLE_MOD`](#\_0x6AF0636DDEDCB6DD).
A bool indicating whether the mod should be enabled/disabled (true/false)
]]
native "TRACK_VEHICLE_VISIBILITY"
hash "0x64473AEFDCF47DCA"
jhash (0x78122DC1)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
in script hook .net
Vehicle v = ...;
Function.Call(Hash.TRACK_VEHICLE_VISIBILITY, v.Handle);
```
]]
native "TRANSFORM_TO_CAR"
hash "0x2A69FFD1B42BFF9E"
jhash (0xD8B90941)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "instantly" [=[ {} ]=],
}
alias "0x2A69FFD1B42BFF9E"
alias "_TRANSFORM_STORMBERG_TO_ROAD_VEHICLE"
alias "_TRANSFORM_SUBMARINE_TO_VEHICLE"
ns "VEHICLE"
returns "void"
doc [[!
Transforms the `stormberg` to its "road vehicle" variant. If the vehicle is already in that state then the vehicle transformation audio will still play, but the vehicle won't change at all.
A vehicle handle.
If true, the vehicle will be instantly transformed, when false the transform animation plays normally.
]]
native "TRANSFORM_TO_SUBMARINE"
hash "0xBE4C854FFDB6EEBE"
jhash (0xCAFE5FE0)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "instantly" [=[ {} ]=],
}
alias "0xBE4C854FFDB6EEBE"
alias "_TRANSFORM_STORMBERG_TO_WATER_VEHICLE"
alias "_TRANSFORM_VEHICLE_TO_SUBMARINE"
ns "VEHICLE"
returns "void"
doc [[!
Transforms the `stormberg` to its "water vehicle" variant. If the vehicle is already in that state then the vehicle transformation audio will still play, but the vehicle won't change at all.
A vehicle handle.
If true, the vehicle will be instantly transformed, when false the transform animation plays normally.
]]
native "UNPAUSE_PLAYBACK_RECORDED_VEHICLE"
hash "0x8879EE09268305D5"
jhash (0x59060F75)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "_ARE_BOMB_BAY_DOORS_OPEN"
hash "0xD0917A423314BBA8"
arguments {
Vehicle "aircraft" [=[ {} ]=],
}
alias "0xD0917A423314BBA8"
alias "_GET_ARE_BOMB_BAY_DOORS_OPEN"
ns "VEHICLE"
returns "BOOL"
doc [[!
Returns true when the bomb bay doors of this plane are open. False if they're closed.
The vehicle to check the bomb bay doors on.
A bool indicating the state of the doors (true = open, false = closed).
]]
native "_ARE_HELI_STUB_WINGS_DEPLOYED"
hash "0xAEF12960FA943792"
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0xAEF12960FA943792"
ns "VEHICLE"
returns "BOOL"
doc [[!
Only used with the "akula" in the decompiled native scripts.
```
NativeDB Introduced: v1290
```
]]
native "_ARE_OUTRIGGER_LEGS_DEPLOYED"
hash "0x3A9128352EAC9E85"
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0x3A9128352EAC9E85"
ns "VEHICLE"
returns "BOOL"
doc [[!
Returns whether the outrigger legs are deployed for the vehicle.
The Chernobog is one of the few vehicles with outrigger legs.
```
NativeDB Introduced: v1290
```
The deployment state of the vehicle's outrigger legs
]]
native "_ARE_PLANE_WINGS_INTACT"
hash "0x5991A01434CE9677"
jhash (0xAF8CB3DF)
arguments {
Vehicle "plane" [=[ {} ]=],
}
alias "0x5991A01434CE9677"
alias "ADD_A_MARKER_OVER_VEHICLE"
alias "_ARE_VEHICLE_WINGS_INTACT"
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "_ATTACH_CONTAINER_TO_HANDLER_FRAME"
hash "0x6A98C2ECF57FA5D4"
jhash (0x20AB5783)
arguments {
Vehicle "handler" [=[ {} ]=],
Entity "container" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "_CLEAR_VEHICLE_PHONE_EXPLOSIVE_DEVICE"
hash "0xAA3F739ABDDCF21F"
alias "0xAA3F739ABDDCF21F"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "_DISABLE_VEHICLE_NEON_LIGHTS"
hash "0x83F813570FF519DE"
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x83F813570FF519DE"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "_DISABLE_VEHICLE_TURRET_MOVEMENT_THIS_FRAME"
hash "0x32CAEDF24A583345"
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0x32CAEDF24A583345"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "_DISABLE_VEHICLE_WORLD_COLLISION"
hash "0x75627043C6AA90AD"
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0x75627043C6AA90AD"
ns "VEHICLE"
returns "void"
doc [[!
Disables collision for this vehicle (maybe it also supports other entities, not sure).
Only world/building/fixed world objects will have their collisions disabled, props, peds, or any other entity still collides with the vehicle.
[Example video](https://streamable.com/6n45d5)
Not sure if there is a native (and if so, which one) that resets the collisions.
the vehicle to disable world collisions for
]]
native "_DOES_VEHICLE_ALLOW_RAPPEL"
hash "0x4E417C547182C84D"
jhash (0x0E28D3A6)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0x4E417C547182C84D"
ns "VEHICLE"
returns "BOOL"
doc [[!
```
Returns true if the vehicle has the FLAG_ALLOWS_RAPPEL flag set.
```
]]
native "_DOES_VEHICLE_HAVE_LANDING_GEAR"
hash "0xE43701C36CAFF1A4"
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0xE43701C36CAFF1A4"
alias "_GET_VEHICLE_HAS_LANDING_GEAR"
ns "VEHICLE"
annotations [=[ {"cs_type":"Any"} ]=]
returns "BOOL"
doc [[!
```
NativeDB Introduced: v1180
```
]]
native "_DOES_VEHICLE_TYRE_EXIST"
hash "0x534E36D4DB9ECC5D"
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "tyreIndex" [=[ {} ]=],
}
alias "0x534E36D4DB9ECC5D"
ns "VEHICLE"
returns "BOOL"
doc [[!
```
Checks if vehicle tyre at index exists. Also returns false if tyre was removed.
```
```
NativeDB Introduced: v1493
```
]]
native "_EJECT_JB700_ROOF"
hash "0xE38CB9D7D39FDBCC"
jhash (0xFDA7B6CA)
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
}
alias "0xE38CB9D7D39FDBCC"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "_ENABLE_AIRCRAFT_OBSTACLE_AVOIDANCE"
hash "0x8AA9180DE2FEDD45"
jhash (0xAE040377)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "avoidObstacles" [=[ {} ]=],
}
alias "_0x8AA9180DE2FEDD45"
ns "VEHICLE"
returns "void"
doc [[!
Will disable a plane or a helicopter's need to swerve around object in its heightmap when using TASK_PLANE_MISSION or other AI / Pilot behavior. Will ensure plane flys directly to it's destination or die trying! This native does NOT need to be called every frame, but instead, just called once on the vehicle (NOT THE PED) you're trying to disable avoidance for!
The vehicle handle to toggle obstacle avoidance for.
`true` / `false` to enable/disable heightmap obstacle avoidance respectively!
]]
native "_ENABLE_INDIVIDUAL_PLANE_PROPELLER"
hash "0xDC05D2777F855F44"
arguments {
Vehicle "plane" [=[ {} ]=],
int "propeller" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
Enables individual propeller on a propeller plane. This native is the inverse of [`DISABLE_INDIVIDUAL_PLANE_PROPELLER`](#\_0x500873A45724C863).
```
NativeDB Introduced: v3407
```
The propeller plane.
The propeller index to enable (starts at 0).
]]
native "_FIND_RANDOM_POINT_IN_SPACE"
hash "0x8DC9675797123522"
arguments {
Ped "ped" [=[ {} ]=],
}
alias "0x8DC9675797123522"
ns "VEHICLE"
returns "Vector3"
doc [[!
Native is significantly more complicated than simply generating a random vector & length.
The 'point' is either 400.0 or 250.0 units away from the Ped's current coordinates; and paths into functions like rage::grcViewport\_\__IsSphereVisible.
```
NativeDB Introduced: v1290
```
]]
native "_FIND_VEHICLE_CARRYING_THIS_ENTITY"
hash "0x375E7FC44F21C8AB"
jhash (0x70DD5E25)
arguments {
Entity "entity" [=[ {} ]=],
}
alias "0x375E7FC44F21C8AB"
alias "_GET_VEHICLE_ATTACHED_TO_ENTITY"
ns "VEHICLE"
returns "Vehicle"
doc [[!
```
Finds the vehicle that is carrying this entity with a handler frame.
The model of the entity must be prop_contr_03b_ld or the function will return 0.
```
]]
native "_GET_BOAT_BOOM_POSITION_RATIO_2"
hash "0xC1F981A6F74F0C23"
jhash (0x00966934)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
alias "0xC1F981A6F74F0C23"
ns "VEHICLE"
returns "void"
doc [[!
```
Same call as VEHICLE::_0x0F3B4D4E43177236
```
]]
native "_GET_BOAT_BOOM_POSITION_RATIO_3"
hash "0x0F3B4D4E43177236"
jhash (0x113DF5FD)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
alias "0x0F3B4D4E43177236"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "_GET_CAN_VEHICLE_JUMP"
hash "0x9078C0C5EF8C19E9"
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "_HAS_VEHICLE_JUMPING_ABILITY"
alias "_DOES_VEHICLE_HAVE_JUMPING_ABILITY"
ns "VEHICLE"
returns "BOOL"
doc [[!
```
Returns true if the vehicle has the FLAG_JUMPING_CAR flag set.
```
]]
native "_GET_CARGOBOB_HOOK_POSITION"
hash "0xCBDB9B923CACC92D"
jhash (0xE6633DCF)
arguments {
Vehicle "cargobob" [=[ {} ]=],
}
alias "0xCBDB9B923CACC92D"
ns "VEHICLE"
returns "Vector3"
doc [[!
Gets the position of the cargobob hook, in world coords.
]]
native "_GET_DOES_VEHICLE_HAVE_TOMBSTONE"
hash "0x71AFB258CCED3A27"
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
```
NativeDB Introduced: v1604
```
]]
native "_GET_DRIFT_TYRES_ENABLED"
hash "0x2F5A72430E78C8D3"
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "_GET_ENTITY_ATTACHED_TO_CARGOBOB"
hash "0x99093F60746708CA"
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0x99093F60746708CA"
ns "VEHICLE"
returns "Entity"
doc [[!
]]
native "_GET_ENTRY_POSITION_OF_DOOR"
hash "0xC0572928C0ABFDA3"
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "doorIndex" [=[ {} ]=],
}
ns "VEHICLE"
returns "Vector3"
doc [[!
See eDoorId declared in [`SET_VEHICLE_DOOR_SHUT`](#\_0x93D9BD300D7789E5)
]]
native "_GET_HAS_RETRACTABLE_WHEELS"
hash "0xDCA174A42133F08C"
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "_GET_HAS_LOWERABLE_WHEELS"
alias "_DOES_VEHICLE_HAVE_RETRACTABLE_WHEELS"
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "_GET_HAS_ROCKET_BOOST"
hash "0x36D782F68B309BDA"
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "_HAS_VEHICLE_ROCKET_BOOST"
alias "_DOES_VEHICLE_HAVE_ROCKET_BOOST"
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "_GET_HYDRAULIC_WHEEL_VALUE"
hash "0x0BB5CBDDD0F25AE3"
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "wheelId" [=[ {} ]=],
}
ns "VEHICLE"
returns "float"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "_GET_IS_DOOR_VALID"
hash "0x645F4B6E8499F632"
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "doorIndex" [=[ {} ]=],
}
alias "_DOES_VEHICLE_HAVE_DOOR"
ns "VEHICLE"
returns "BOOL"
doc [[!
See eDoorId declared in [`SET_VEHICLE_DOOR_SHUT`](#\_0x93D9BD300D7789E5)
]]
native "_GET_IS_VEHICLE_ELECTRIC"
hash "0x1FCB07FE230B6639"
arguments {
Hash "vehicleModel" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
Checks if the vehicle is electric.
```
NativeDB Introduced: v3258
```
The hash of the vehicle model to check.
Returns `true` if the vehicle is electric or `false` otherwise.
]]
native "_GET_IS_VEHICLE_EMP_DISABLED"
hash "0x0506ED94363AD905"
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
```
Returns whether this vehicle is currently disabled by an EMP mine.
NativeDB Introduced: v1604
```
]]
native "_GET_IS_VEHICLE_SHUNT_BOOST_ACTIVE"
hash "0xA2459F72C14E2E8D"
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
```
NativeDB Introduced: v1604
```
]]
native "_GET_IS_WHEELS_LOWERED_STATE_ACTIVE"
hash "0x1DA0DA9CB3F0C8BF"
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0x1DA0DA9CB3F0C8BF"
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "_GET_LAST_RAMMED_VEHICLE"
hash "0x04F2FA6E234162F7"
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "Vehicle"
doc [[!
```
Returns last vehicle that was rammed by the given vehicle using the shunt boost.
NativeDB Introduced: v1604
```
]]
native "_GET_NUMBER_OF_VEHICLE_DOORS"
hash "0x92922A607497B14D"
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "int"
doc [[!
]]
native "_GET_REMAINING_NITROUS_DURATION"
hash "0xBEC4B8653462450E"
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "float"
doc [[!
```
NativeDB Introduced: 3095
```
Retrieves the remaining duration of nitrous boost available for the specified vehicle.
The vehicle for which to retrieve the remaining nitrous duration.
The amount of time that the nitrous boost can still be active for the given vehicle. If there is no nitrous system active or available, this may return `0`.```lua
CreateThread(function()
local playerPed, vehicle
while true do
-- Retrieve the player ped.
playerPed = PlayerPedId()
-- Retrieve the vehicle the player is currently in.
vehicle = GetVehiclePedIsIn(playerPed, false)
-- Retrieve if the nitrous of the vehicle is active.
if IsNitrousActive(vehicle) then
print(GetRemainingNitrousDuration(vehicle))
end
Wait(0)
end
end)
``````js
setTick(async () => {
// Retrieve the player ped.
let playerPed = PlayerPedId();
// Retrieve the vehicle the player is currently in.
let vehicle = GetVehiclePedIsIn(playerPed, false);
// Retrieve if the nitrous of the vehicle is active.
if (IsNitrousActive(vehicle)) {
console.log(GetRemainingNitrousDuration(vehicle));
}
});
```
]]
native "_GET_TYRE_HEALTH"
hash "0x55EAB010FAEE9380"
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "wheelIndex" [=[ {} ]=],
}
ns "VEHICLE"
returns "float"
doc [[!
```
NativeDB Introduced: v1868
```
]]
native "_GET_TYRE_WEAR_MULTIPLIER"
hash "0x6E387895952F4F71"
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "wheelIndex" [=[ {} ]=],
}
ns "VEHICLE"
returns "float"
doc [[!
```
NativeDB Introduced: v2060
```
]]
native "_GET_VEHICLE_BOMB_COUNT"
hash "0xEA12BD130D7569A1"
arguments {
Vehicle "aircraft" [=[ {} ]=],
}
alias "0xEA12BD130D7569A1"
alias "_GET_AIRCRAFT_BOMB_COUNT"
ns "VEHICLE"
returns "int"
doc [[!
Gets the amount of bombs that this vehicle has. As far as I know, this does *not* impact vehicle weapons or the ammo of those weapons in any way, it is just a way to keep track of the amount of bombs in a specific plane.
In decompiled scripts this is used to check if the vehicle has enough bombs before a bomb can be dropped (bombs are dropped by using [`_SHOOT_SINGLE_BULLET_BETWEEN_COORDS_WITH_EXTRA_PARAMS`](#\_0xBFE5756E7407064A)).
Use [`_SET_AIRCRAFT_BOMB_COUNT`](#\_0xF4B2ED59DEB5D774) to set the amount of bombs on that vehicle.
The vehicle to get the amount of bombs from.
An int indicating the amount of bombs remaining on that plane.
]]
native "_GET_VEHICLE_CAN_ACTIVATE_PARACHUTE"
hash "0xA916396DF4154EE3"
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "_CAN_VEHICLE_PARACHUTE_BE_ACTIVATED"
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "_GET_VEHICLE_COUNTERMEASURE_COUNT"
hash "0xF846AA63DF56B804"
arguments {
Vehicle "aircraft" [=[ {} ]=],
}
alias "0xF846AA63DF56B804"
alias "_GET_AIRCRAFT_COUNTERMEASURE_COUNT"
ns "VEHICLE"
returns "int"
doc [[!
Similar to [`_GET_AIRCRAFT_BOMB_COUNT`](#\_0xEA12BD130D7569A1), this gets the amount of countermeasures that are present on this vehicle.
Use [`_SET_AIRCRAFT_COUNTERMEASURE_COUNT`](#\_0x9BDA23BF666F0855) to set the current amount.
The vehicle to get the amount of countermeasures from.
An int indicating the amount of countermeasures remaining on that plane.
]]
native "_GET_VEHICLE_CURRENT_SLIPSTREAM_DRAFT"
hash "0x36492C2F0D134C56"
jhash (0xA4A75FCF)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0x36492C2F0D134C56"
ns "VEHICLE"
returns "float"
doc [[!
```
Returns a float value between 0.0 and 3.0 related to its slipstream draft (boost/speedup).
GET_VEHICLE_*
```
]]
native "_GET_VEHICLE_DASHBOARD_COLOR"
hash "0xB7635E80A5C31BFF"
arguments {
Vehicle "vehicle" [=[ {} ]=],
intPtr "color" [=[ {} ]=],
}
alias "_GET_VEHICLE_DASHBOARD_COLOUR"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "_GET_VEHICLE_DRIVETRAIN_TYPE"
hash "0x1423725069EE1D14"
arguments {
Hash "vehicleModel" [=[ {} ]=],
}
ns "VEHICLE"
returns "int"
doc [[!
```
NativeDB Introduced: v3258
```
**Note**: When using this native, the hash of the vehicle needs to be loaded into the client's memory. This can be done by requesting the model with [`REQUEST_MODEL`](#\_0x963D27A58DF860AC) or by simply having the vehicle spawned.
```cpp
enum eVehicleDrivetrainType
{
INVALID = 0,
FWD = 1,
RWD = 2,
AWD = 3
};
```
```
NativeDB Introduced: v3258
```
The hash of the vehicle model to check.
Returns the vehicle's drivetrain type.
]]
native "_GET_VEHICLE_HAS_PARACHUTE"
hash "0xBC9CFF381338CB4F"
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "_HAS_VEHICLE_PARACHUTE"
alias "_DOES_VEHICLE_HAVE_PARACHUTE"
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "_GET_VEHICLE_INTERIOR_COLOR"
hash "0x7D1464D472D32136"
arguments {
Vehicle "vehicle" [=[ {} ]=],
intPtr "color" [=[ {} ]=],
}
alias "_GET_VEHICLE_INTERIOR_COLOUR"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "_GET_VEHICLE_MODEL_ESTIMATED_AGILITY"
hash "0x53409B5163D5B846"
jhash (0x37FBA7BC)
arguments {
Hash "modelHash" [=[ {} ]=],
}
alias "0x53409B5163D5B846"
alias "_GET_VEHICLE_MODEL_DOWN_FORCE"
ns "VEHICLE"
returns "float"
doc [[!
```
GET_VEHICLE_MODEL_*
9.8 * thrust if air vehicle, else 0.38 + drive force?
```
]]
native "_GET_VEHICLE_MODEL_MAX_KNOTS"
hash "0xC6AD107DDC9054CC"
jhash (0x95BB67EB)
arguments {
Hash "modelHash" [=[ {} ]=],
}
alias "0xC6AD107DDC9054CC"
ns "VEHICLE"
returns "float"
doc [[!
```
GET_VEHICLE_MODEL_*
Function pertains only to aviation vehicles.
```
]]
native "_GET_VEHICLE_NEON_LIGHTS_COLOUR"
hash "0x7619EEE8C886757F"
arguments {
Vehicle "vehicle" [=[ {} ]=],
intPtr "r" [=[ {} ]=],
intPtr "g" [=[ {} ]=],
intPtr "b" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
Gets the color of the neon lights of the specified vehicle.
See [`_SET_VEHICLE_NEON_LIGHTS_COLOUR`](#\_0x8E0A582209A62695) for more information
]]
native "_GET_VEHICLE_NUMBER_OF_BROKEN_BONES"
hash "0x2C8CBFE1EA5FC631"
jhash (0xABC99E21)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0x2C8CBFE1EA5FC631"
ns "VEHICLE"
returns "int"
doc [[!
]]
native "_GET_VEHICLE_NUMBER_OF_BROKEN_OFF_BONES"
hash "0x42A4BEB35D372407"
jhash (0x8CDB0C09)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0x42A4BEB35D372407"
ns "VEHICLE"
returns "int"
doc [[!
```
Also includes some "turnOffBones" when vehicle mods are installed.
```
]]
native "_GET_VEHICLE_ROOF_LIVERY"
hash "0x60190048C0764A26"
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0x60190048C0764A26"
ns "VEHICLE"
returns "int"
doc [[!
Returns index of the current vehicle's rooftop livery.
A getter for [\_SET_VEHICLE_ROOF_LIVERY](#\_0xA6D3A8750DC73270).
The vehicle handle.
An index of the current vehicle's rooftop livery.
]]
native "_GET_VEHICLE_ROOF_LIVERY_COUNT"
hash "0x5ECB40269053C0D4"
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0x5ECB40269053C0D4"
ns "VEHICLE"
returns "int"
doc [[!
Returns a number of available rooftop liveries, or -1 if vehicle has no rooftop liveries available.
The vehicle handle.
A number of available rooftop liveries for vehicle.
]]
native "_GET_VEHICLE_SUSPENSION_BOUNDS"
hash "0xDF7E3EEB29642C38"
arguments {
Vehicle "vehicle" [=[ {} ]=],
Vector3Ptr "out1" [=[ {} ]=],
Vector3Ptr "out2" [=[ {} ]=],
}
alias "0xDF7E3EEB29642C38"
ns "VEHICLE"
returns "void"
doc [[!
```
Outputs 2 Vector3's.
Scripts check if out2.x - out1.x > something.x
Could be suspension related, as in max suspension height and min suspension height, considering the natives location.
```
]]
native "_GET_VEHICLE_SUSPENSION_HEIGHT"
hash "0x53952FD2BAA19F17"
jhash (0xB73A1486)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "float"
doc [[!
```
Gets the height of the vehicle's suspension.
The higher the value the lower the suspension. Each 0.002 corresponds with one more level lowered.
0.000 is the stock suspension.
0.008 is Ultra Suspension.
```
]]
native "_GET_VEHICLE_XENON_LIGHTS_COLOR"
hash "0x3DFF319A831E0CDB"
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0x3DFF319A831E0CDB"
alias "_GET_VEHICLE_HEADLIGHTS_COLOUR"
alias "_GET_VEHICLE_XENON_LIGHTS_COLOUR"
ns "VEHICLE"
returns "int"
doc [[!
Use [\_SET_VEHICLE_HEADLIGHTS_COLOUR](#\_0xE41033B25D003A07) to set the headlights color for the vehicle.
You must enable xenon headlights for this native to work properly.
```cpp
enum eHeadlightColors {
Default = 255,
White = 0,
Blue = 1,
ElectricBlue = 2,
MintGreen = 3,
LimeGreen = 4,
Yellow = 5,
GoldenShower = 6,
Orange = 7,
Red = 8,
PonyPink = 9,
HotPink = 10,
Purple = 11,
Blacklight = 12
}
```
The vehicle to get the headlight color from.
Returns the xenons light color, refer to `eHeadlightColors`
]]
native "_HAS_FILLED_VEHICLE_POPULATION"
hash "0x91D6DD290888CBAB"
jhash (0x71D898EF)
alias "0x91D6DD290888CBAB"
ns "VEHICLE"
returns "BOOL"
doc [[!
```
HAS_*
```
]]
native "_HIDE_VEHICLE_TOMBSTONE"
hash "0xAE71FB656C600587"
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
NativeDB Introduced: v1604
```
]]
native "_IS_HANDLER_FRAME_ABOVE_CONTAINER"
hash "0x89D630CF5EA96D23"
jhash (0xFBF5536A)
arguments {
Vehicle "handler" [=[ {} ]=],
Entity "container" [=[ {} ]=],
}
alias "0x89D630CF5EA96D23"
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "_IS_MISSION_TRAIN"
hash "0xAD464F2E18836BFC"
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "_IS_PED_EXCLUSIVE_DRIVER_OF_VEHICLE"
hash "0xB09D25E77C33EB3F"
arguments {
Ped "ped" [=[ {} ]=],
Vehicle "vehicle" [=[ {} ]=],
intPtr "outIndex" [=[ {} ]=],
}
alias "0xB09D25E77C33EB3F"
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "_IS_THIS_MODEL_A_JETSKI"
hash "0x9537097412CF75FE"
arguments {
Hash "model" [=[ {} ]=],
}
alias "_IS_THIS_MODEL_A_SUBMERSIBLE"
alias "_IS_THIS_MODEL_AN_EMERGENCY_BOAT"
ns "VEHICLE"
returns "BOOL"
doc [[!
```
Checks if model is a boat, then checks for FLAG_IS_JETSKI.
```
]]
native "_IS_THIS_MODEL_AN_AMPHIBIOUS_CAR"
hash "0x633F6F44A537EBB6"
arguments {
Hash "model" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "_IS_THIS_MODEL_AN_AMPHIBIOUS_QUADBIKE"
hash "0xA1A9FC1C76A6730D"
arguments {
Hash "model" [=[ {"cs_type":"Any"} ]=],
}
alias "0xA1A9FC1C76A6730D"
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "_IS_VEHICLE_BEING_HALTED"
hash "0xC69BB1D832A710EF"
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0xC69BB1D832A710EF"
ns "VEHICLE"
returns "BOOL"
doc [[!
```
Returns true if vehicle is halted by BRING_VEHICLE_TO_HALT
_IS_VEHICLE_*
```
```
NativeDB Introduced: v1493
```
]]
native "_IS_VEHICLE_DAMAGED"
hash "0xBCDC5017D3CE1E9E"
jhash (0xDAC523BC)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
```
Appears to return true if the vehicle has any damage, including cosmetically.
GET_*
```
]]
native "_IS_VEHICLE_ENGINE_ON_FIRE"
hash "0xEC69ADF931AAE0C3"
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0xEC69ADF931AAE0C3"
ns "VEHICLE"
returns "BOOL"
doc [[!
Only ever used once in decompiled scripts: **am_pi_menu**:
Returns true if the engine is on fire, or if the vehicle engine health is < 0 and it **has been** on fire.
It sometimes doesn't return true when the vehicle engine has been on fire, and has since been fixed. I'm not really sure what the exact conditions are.
This usually returns true even if there are no visible flames yet (engine health > 0). However if you monitor engine health you'll see that it starts decreasing as soon as this returns true.
The vehicle to check.
Returns true when the engine of your vehicle is on fire. Returns false if it's not on fire.
]]
native "_IS_VEHICLE_NEON_LIGHT_ENABLED"
hash "0x8C4B92553E4766A5"
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "index" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
```
indices:
0 = Left
1 = Right
2 = Front
3 = Back
```
]]
native "_IS_VEHICLE_PARACHUTE_ACTIVE"
hash "0x3DE51E9C80B116CF"
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0x3DE51E9C80B116CF"
ns "VEHICLE"
returns "BOOL"
doc [[!
Does not work for vehicle of type: CBike, CBmx, CBoat, CTrain, CSubmarine.
]]
native "_IS_VEHICLE_ROCKET_BOOST_ACTIVE"
hash "0x3D34E80EED4AE3BE"
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "_IS_VEHICLE_SLIPSTREAM_LEADER"
hash "0x48C633E94A8142A7"
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0x48C633E94A8142A7"
ns "VEHICLE"
returns "BOOL"
doc [[!
True if the vehicle is being slipstreamed by another vehicle
]]
native "_IS_VEHICLE_WEAPON_DISABLED"
hash "0x563B65A643ED072E"
arguments {
Hash "weaponHash" [=[ {"cs_type":"Any"} ]=],
Vehicle "vehicle" [=[ {} ]=],
Ped "owner" [=[ {} ]=],
}
alias "0x563B65A643ED072E"
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "_LOWER_RETRACTABLE_WHEELS"
hash "0x5335BE58C083E74E"
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0x5335BE58C083E74E"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "_NETWORK_USE_HIGH_PRECISION_VEHICLE_BLENDING"
hash "0xEC0C1D4922AF9754"
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0xEC0C1D4922AF9754"
ns "VEHICLE"
returns "void"
doc [[!
```
Implemented only for Trains.
```
```
NativeDB Introduced: v2372
```
]]
native "_RAISE_RETRACTABLE_WHEELS"
hash "0xF660602546D27BA8"
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "_RAISE_LOWERABLE_WHEELS"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "_REMOVE_VEHICLE_SHADOW_EFFECT"
hash "0xF87D9F2301F7D206"
jhash (0x450AD03A)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0xF87D9F2301F7D206"
ns "VEHICLE"
returns "void"
doc [[!
Remove the weird shadow applied by [\_SET_VEHICLE_SHADOW_EFFECT](#\_0x2A70BAE8883E4C81)
]]
native "_REQUEST_VEHICLE_DASHBOARD_SCALEFORM_MOVIE"
hash "0xDBA3C090E3D74690"
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0xDBA3C090E3D74690"
ns "VEHICLE"
returns "void"
doc [[!
```
REQUEST_VEHICLE_*
```
]]
native "_SET_BOAT_BOOM_POSITION_RATIO"
hash "0xF488C566413B4232"
jhash (0xA25CCB8C)
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "ratio" [=[ {} ]=],
}
alias "0xF488C566413B4232"
ns "VEHICLE"
returns "void"
doc [[!
Sets the boat boom position for the `TR3` trailer.
Ratio value is between `0.0` and `1.0`, where `0.0` is 90 degrees to the left of the boat, and `1.0` is just slightly to the right/back of the boat.
To get the current boom position ratio, use [GET_BOAT_BOOM_POSITION_RATIO](#\_0x6636C535F6CC2725).
The TR3 vehicle.
A value between 0.0 (left) and 1.0 (back)
]]
native "_SET_BOAT_IS_SINKING"
hash "0xBD32E46AA95C1DD2"
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0xBD32E46AA95C1DD2"
alias "_SET_BOAT_SINKING"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "_SET_CAMBERED_WHEELS_DISABLED"
hash "0x1201E8A3290A3B98"
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x1201E8A3290A3B98"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "_SET_CAR_HIGH_SPEED_BUMP_SEVERITY_MULTIPLIER"
hash "0x84FD40F56075E816"
arguments {
float "multiplier" [=[ {} ]=],
}
alias "0x84FD40F56075E816"
ns "VEHICLE"
returns "void"
doc [[!
```
Something to do with "high speed bump severity"?
if (!sub_87a46("SET_CAR_HIGH_SPEED_BUMP_SEVERITY_MULTIPLIER")) {
VEHICLE::_84FD40F56075E816(0.0);
sub_8795b("SET_CAR_HIGH_SPEED_BUMP_SEVERITY_MULTIPLIER", 1);
}
```
]]
native "_SET_CARGOBOB_HOOK_CAN_ATTACH"
hash "0x94A68DA412C4007D"
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x94A68DA412C4007D"
ns "VEHICLE"
returns "void"
doc [[!
```
Stops the cargobob from being able to attach any vehicle
```
```
NativeDB Introduced: v1180
```
]]
native "_SET_DEPLOY_HELI_STUB_WINGS"
hash "0xB251E0B33E58B424"
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "deploy" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
alias "0xB251E0B33E58B424"
ns "VEHICLE"
returns "void"
doc [[!
Only used with the "akula" and "annihilator2" in the decompiled native scripts.
```
NativeDB Introduced: v1290
```
]]
native "_SET_DISABLE_EXPLODE_FROM_BODY_DAMAGE_RECEIVED_BY_AI_VEHICLE"
hash "0xB0B7DF5CB876FF5E"
arguments {
Vehicle "plane" [=[ {} ]=],
BOOL "disable" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
NativeDB Introduced: v3407
```
Prevents the plane from exploding when taking body damage if the inflictor is an AI-controlled vehicle. Only works for planes.
]]
native "_SET_DISABLE_SUPERDUMMY_MODE"
hash "0xB088E9A47AE6EDD5"
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
alias "0xB088E9A47AE6EDD5"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "_SET_DISABLE_TURRET_MOVEMENT_THIS_FRAME"
hash "0xE615BB7A7752C76A"
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "turretIdx" [=[ {} ]=],
}
alias "0xE615BB7A7752C76A"
alias "_SET_DISABLE_TURRET_MOVEMENT"
ns "VEHICLE"
returns "void"
doc [[!
Disables turret movement when called in a loop. You can still fire and aim. You cannot shoot backwards though.
```
NativeDB Introduced: v1365
```
]]
native "_SET_DISABLE_VEHICLE_FLIGHT_NOZZLE_POSITION"
hash "0xCE2B43770B655F8F"
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "direction" [=[ {"cs_type":"float"} ]=],
}
alias "_SET_PLANE_VTOL_ANIMATION_DISABLED"
ns "VEHICLE"
returns "void"
doc [[!
```
True stops vtols from switching modes. Doesn't stop the sound though.
```
```
NativeDB Introduced: v1290
```
]]
native "_SET_DISABLE_VEHICLE_UNK"
hash "0x143921E45EC44D62"
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
NativeDB Introduced: v1604
```
]]
native "_SET_DISABLE_VEHICLE_UNK_2"
hash "0x211E95CE9903940C"
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
NativeDB Introduced: v1604
```
]]
native "_SET_DISABLE_VEHICLE_WINDOW_COLLISIONS"
hash "0x1087BC8EC540DAEB"
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x1087BC8EC540DAEB"
ns "VEHICLE"
returns "void"
doc [[!
R\* used it to "remove" vehicle windows when "nightshark" had some mod, which adding some kind of armored windows. When enabled, you can't break vehicles glass. All your bullets wiil shoot through glass. You also will not able to break the glass with any other way (hitting and etc)
The vehicle to toggle this for.
True disables the collision, false enables the collision
]]
native "_SET_DRIFT_TYRES_ENABLED"
hash "0x5AC79C98C5C17F05"
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "_SET_HELI_MAIN_ROTOR_HEALTH"
hash "0x4056EA1105F5ABD7"
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "health" [=[ {} ]=],
}
alias "0x4056EA1105F5ABD7"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "_SET_HELI_TAIL_ROTOR_HEALTH"
hash "0xFE205F38AAA58E5B"
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "health" [=[ {} ]=],
}
alias "0xFE205F38AAA58E5B"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "_SET_HELICOPTER_ROLL_PITCH_YAW_MULT"
hash "0x6E0859B530A365CC"
jhash (0x6E67FD35)
arguments {
Vehicle "helicopter" [=[ {} ]=],
float "multiplier" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
value between 0.0 and 1.0
```
]]
native "_SET_HYDRAULIC_RAISED"
hash "0x28B18377EB6E25F6"
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x28B18377EB6E25F6"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "_SET_HYDRAULIC_WHEEL_STATE"
hash "0x8EA86DF356801C7D"
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "state" [=[ {} ]=],
}
alias "0x8EA86DF356801C7D"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "_SET_HYDRAULIC_WHEEL_STATE_TRANSITION"
hash "0xC24075310A8B9CD1"
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "wheelId" [=[ {} ]=],
int "state" [=[ {} ]=],
float "value" [=[ {} ]=],
float "p4" [=[ {} ]=],
}
alias "0xC24075310A8B9CD1"
ns "VEHICLE"
returns "void"
doc [[!
```
Sets vehicle wheel hydraulic states transition. Known states:
0 - reset
1 - raise wheel (uses value arg, works just like _SET_VEHICLE_HYDRAULIC_WHEEL_VALUE)
2 - jump using wheel
```
]]
native "_SET_HYDRAULIC_WHEEL_VALUE"
hash "0x84EA99C62CB3EF0C"
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "wheelId" [=[ {} ]=],
float "value" [=[ {} ]=],
}
alias "0x84EA99C62CB3EF0C"
alias "_SET_HYDRAULIC_STATE"
ns "VEHICLE"
returns "void"
doc [[!
```
Works only on vehicles that support hydraulic.
```
]]
native "_SET_OPPRESSOR_TRANSFORM_STATE"
hash "0x544996C0081ABDEB"
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "extend" [=[ {} ]=],
}
alias "0x544996C0081ABDEB"
ns "VEHICLE"
returns "void"
doc [[!
Set state to true to extend the wings, false to retract them.
The vehicle (tested with oppressor only)
Set to true to extend the wings, false to retract them.
]]
native "_SET_PLANE_AVOIDS_OTHERS"
hash "0xBAFB99B304BC52A7"
arguments {
Vehicle "plane" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
NativeDB Introduced: v3407
```
]]
native "_SET_PLANE_ENGINE_HEALTH"
hash "0x2A86A0475B6A1434"
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "health" [=[ {} ]=],
}
alias "0x2A86A0475B6A1434"
ns "VEHICLE"
returns "void"
doc [[!
```
Works just like SET_VEHICLE_ENGINE_HEALTH, didn't saw any difference. But this native works only for planes.
```
]]
native "_SET_PLANE_PROPELLERS_HEALTH"
hash "0x4C815EB175086F84"
arguments {
Vehicle "plane" [=[ {} ]=],
float "health" [=[ {} ]=],
}
alias "0x4C815EB175086F84"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "_SET_RANDOM_BOATS_IN_MP"
hash "0xDA5E12F728DB30CA"
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "_SET_REDUCE_DRIFT_VEHICLE_SUSPENSION"
hash "0x3A375167F5782A65"
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "enable" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
Lowers the vehicle's stance. Only works for vehicles that support this feature.
```
NativeDB Introduced: v2372
```
]]
native "_SET_TRAILER_LEGS_LOWERED"
hash "0x878C75C09FBDB942"
alias "0x878C75C09FBDB942"
ns "VEHICLE"
returns "void"
doc [[!
```
Inverse of 0x95CF53B3D687F9FA
```
```
NativeDB Added Parameter 1: Vehicle vehicle
```
]]
native "_SET_TYRE_HEALTH"
hash "0x74C68EF97645E79D"
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "wheelIndex" [=[ {} ]=],
float "health" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
NativeDB Introduced: v1868
```
]]
native "_SET_TYRE_SOFTNESS_MULTIPLIER"
hash "0x392183BB9EA57697"
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "wheelIndex" [=[ {} ]=],
float "multiplier" [=[ {} ]=],
}
alias "0x392183BB9EA57697"
ns "VEHICLE"
returns "void"
doc [[!
```
Controls how fast the tires wear out.
Default values from Rockstar's Open Wheel Race JSON's:
"owrtss" (Soft): 2.2
"owrtsm" (Medium): 1.7
"owrtsh" (Hard): 1.2
Usable wheels:
0: wheel_lf
1: wheel_rf
2: wheel_lm1
3: wheel_rm1
4: wheel_lr
5: wheel_rr
```
```
NativeDB Introduced: v2060
```
]]
native "_SET_TYRE_TRACTION_LOSS_MULTIPLIER"
hash "0xC970D0E0FC31D768"
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "wheelIndex" [=[ {} ]=],
float "multiplier" [=[ {} ]=],
}
alias "0xC970D0E0FC31D768"
ns "VEHICLE"
returns "void"
doc [[!
```
Controls how much traction the wheel loses.
Default values from Rockstar's Open Wheel Race JSON's:
"owrtds" (Soft): 0.05
"owrtdm" (Medium): 0.45
"owrtdh" (Hard): 0.8
Usable wheels:
0: wheel_lf
1: wheel_rf
2: wheel_lm1
3: wheel_rm1
4: wheel_lr
5: wheel_rr
```
```
NativeDB Introduced: v2060
```
]]
native "_SET_TYRE_WEAR_MULTIPLIER"
hash "0x01894E2EDE923CA2"
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "wheelIndex" [=[ {} ]=],
float "multiplier" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
NativeDB Introduced: v1868
```
]]
native "_SET_USE_HIGHER_VEHICLE_JUMP_FORCE"
hash "0xF06A16CA55D138D8"
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0xF06A16CA55D138D8"
ns "VEHICLE"
returns "void"
doc [[!
Allows vehicles with the FLAG_JUMPING_CAR flag to jump higher (i.e. Ruiner 2000).
]]
native "_SET_VEHICLE_BOMB_COUNT"
hash "0xF4B2ED59DEB5D774"
arguments {
Vehicle "aircraft" [=[ {} ]=],
int "bombCount" [=[ {} ]=],
}
alias "0xF4B2ED59DEB5D774"
alias "_SET_VEHICLE_BOMBS"
alias "_SET_AIRCRAFT_BOMB_COUNT"
ns "VEHICLE"
returns "void"
doc [[!
Sets the amount of bombs that this vehicle has. As far as I know, this does *not* impact vehicle weapons or the ammo of those weapons in any way, it is just a way to keep track of the amount of bombs in a specific plane.
In decompiled scripts this is used to deduct from or add to the count whenever bombs are dropped or purchased/restocked.
Use [`_GET_AIRCRAFT_BOMB_COUNT`](#\_0xEA12BD130D7569A1) to get the amount of bombs on that vehicle.
The vehicle to set the bombCount on.
The amount of bombs to set for this vehicle.
]]
native "_SET_VEHICLE_CAN_BE_LOCKED_ON"
hash "0x1DDA078D12879EEE"
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "canBeLockedOn" [=[ {} ]=],
BOOL "unk" [=[ {} ]=],
}
alias "0x1DDA078D12879EEE"
ns "VEHICLE"
returns "void"
doc [[!
```
SET_VEHICLE_AL*
```
]]
native "_SET_VEHICLE_CAN_ENGINE_OPERATE_ON_FIRE"
hash "0x206BC5DC9D1AC70A"
jhash (0x8EACBD13)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x206BC5DC9D1AC70A"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "_SET_VEHICLE_CONTROLS_INVERTED"
hash "0x5B91B229243351A8"
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "state" [=[ {} ]=],
}
alias "0x5B91B229243351A8"
ns "VEHICLE"
returns "void"
doc [[!
```
Inverts vehicle's controls. So INPUT_VEH_ACCELERATE will be INPUT_VEH_BRAKE and vise versa (same for A/D controls)
Doesn't work for planes/helis.
```
]]
native "_SET_VEHICLE_COUNTERMEASURE_COUNT"
hash "0x9BDA23BF666F0855"
arguments {
Vehicle "aircraft" [=[ {} ]=],
int "count" [=[ {} ]=],
}
alias "0x9BDA23BF666F0855"
alias "_SET_AIRCRAFT_COUNTERMEASURE_COUNT"
ns "VEHICLE"
returns "void"
doc [[!
Similar to [`_SET_AIRCRAFT_BOMB_COUNT`](#\_0xF4B2ED59DEB5D774), this sets the amount of countermeasures that are present on this vehicle.
Use [`_GET_AIRCRAFT_COUNTERMEASURE_COUNT`](#\_0xF846AA63DF56B804) to get the current amount.
The vehicle to set the amount of countermeasures on.
The amount of countermeasures to set on this vehicle.
]]
native "_SET_VEHICLE_DAMAGE_MODIFIER"
hash "0x4E20D2A627011E8E"
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "p1" [=[ {} ]=],
}
alias "0x4E20D2A627011E8E"
ns "VEHICLE"
returns "Any"
doc [[!
```
SET_VEHICLE_D*
```
]]
native "_SET_VEHICLE_DASHBOARD_COLOR"
hash "0x6089CDF6A57F326C"
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "color" [=[ {} ]=],
}
alias "_SET_VEHICLE_DASHBOARD_COLOUR"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "_SET_VEHICLE_DOOR_CAN_BREAK"
hash "0x2FA133A4A9D37ED8"
jhash (0x065B92B3)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "doorIndex" [=[ {} ]=],
BOOL "isBreakable" [=[ {} ]=],
}
alias "_SET_VEHICLE_DOOR_BREAKABLE"
ns "VEHICLE"
returns "void"
doc [[!
See eDoorId declared in [`SET_VEHICLE_DOOR_SHUT`](#\_0x93D9BD300D7789E5)
]]
native "_SET_VEHICLE_DOORS_LOCKED_FOR_UNK"
hash "0x203B527D1B77904C"
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
NativeDB Introduced: v1365
```
]]
native "_SET_VEHICLE_EXCLUSIVE_DRIVER_2"
hash "0xB5C51B5502E85E83"
jhash (0xAA8BD440)
arguments {
Vehicle "vehicle" [=[ {} ]=],
Ped "ped" [=[ {} ]=],
int "index" [=[ {} ]=],
}
alias "0xB5C51B5502E85E83"
ns "VEHICLE"
returns "void"
doc [[!
The **actual** [`SET_VEHICLE_EXCLUSIVE_DRIVER`](#\_0x41062318F23ED854) native.
]]
native "_SET_VEHICLE_EXPLOSIVE_DAMAGE_SCALE"
hash "0x84D7FFD223CAAFFD"
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "scale" [=[ {} ]=],
}
ns "VEHICLE"
returns "Any"
doc [[!
```
NativeDB Introduced: v3407
```
Does not actually return anything.
]]
native "_SET_VEHICLE_HANDLING_HASH_FOR_AI"
hash "0x10655FAB9915623D"
arguments {
Vehicle "vehicle" [=[ {} ]=],
Hash "hash" [=[ {"cs_type":"Any"} ]=],
}
alias "0x10655FAB9915623D"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "_SET_VEHICLE_INTERIOR_COLOR"
hash "0xF40DD601A65F7F19"
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "color" [=[ {} ]=],
}
alias "_SET_VEHICLE_INTERIOR_COLOUR"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "_SET_VEHICLE_MAX_SPEED"
hash "0xBAA045B4E42F3C06"
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "speed" [=[ {} ]=],
}
alias "0xBAA045B4E42F3C06"
ns "VEHICLE"
returns "void"
doc [[!
To reset the max speed, set the `speed` value to `0.0` or lower.
The vehicle handle.
The speed limit in meters per second.
]]
native "_SET_VEHICLE_NEON_LIGHT_ENABLED"
hash "0x2AA720E4287BF269"
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "index" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
Sets the neon lights of the specified vehicle on/off.
Indices:
0 = Left
1 = Right
2 = Front
3 = Back
```
]]
native "_SET_VEHICLE_NEON_LIGHTS_COLOR_2"
hash "0xB93B2867F7B479D1"
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "color" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
NativeDB Introduced: v1493
```
]]
native "_SET_VEHICLE_NEON_LIGHTS_COLOUR"
hash "0x8E0A582209A62695"
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "r" [=[ {} ]=],
int "g" [=[ {} ]=],
int "b" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
Sets the color of the neon lights on the specified vehicle.
RGB values and colour names taken from the decompiled scripts:
| Colour | R | G | B |
|---------------|:---:|:---:|:---:|
| White | 222 | 222 | 255 |
| Blue | 2 | 21 | 255 |
| Electric Blue | 3 | 83 | 255 |
| Mint Green | 0 | 255 | 140 |
| Lime Green | 94 | 255 | 1 |
| Yellow | 255 | 255 | 0 |
| Golden Shower | 255 | 150 | 0 |
| Orange | 255 | 62 | 0 |
| Red | 255 | 1 | 1 |
| Pony Pink | 255 | 50 | 100 |
| Hot Pink | 255 | 5 | 190 |
| Purple | 35 | 1 | 255 |
| Blacklight | 15 | 3 | 255 |
]]
native "_SET_VEHICLE_PARACHUTE_ACTIVE"
hash "0x0BFFB028B3DD0A97"
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "active" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "_SET_VEHICLE_PARACHUTE_MODEL"
hash "0x4D610C6B56031351"
arguments {
Vehicle "vehicle" [=[ {} ]=],
Hash "modelHash" [=[ {} ]=],
}
alias "_VEHICLE_SET_CUSTOM_PARACHUTE_MODEL"
ns "VEHICLE"
returns "void"
doc [[!
```
parachuteModel = 230075693
```
]]
native "_SET_VEHICLE_PARACHUTE_TEXTURE_VARIATION"
hash "0xA74AD2439468C883"
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "textureVariation" [=[ {} ]=],
}
alias "_VEHICLE_SET_CUSTOM_PARACHUTE_TEXTURE"
alias "_SET_VEHICLE_PARACHUTE_TEXTURE_VARIATIION"
ns "VEHICLE"
returns "void"
doc [[!
```
colorIndex = 0 - 7
```
]]
native "_SET_VEHICLE_RAMP_LAUNCH_MODIFIER"
hash "0xEFC13B1CE30D755D"
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "p1" [=[ {} ]=],
}
alias "0xEFC13B1CE30D755D"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "_SET_VEHICLE_RAMP_SIDEWAYS_LAUNCH_MOTION"
hash "0x1BBAC99C0BC53656"
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x1BBAC99C0BC53656"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "_SET_VEHICLE_RAMP_UPWARDS_LAUNCH_MOTION"
hash "0x756AE6E962168A04"
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x756AE6E962168A04"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "_SET_VEHICLE_RECEIVES_RAMP_DAMAGE"
hash "0x28D034A93FE31BF5"
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "_SET_RAMP_VEHICLE_RECEIVES_RAMP_DAMAGE"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "_SET_VEHICLE_REDUCE_TRACTION"
hash "0x6DEE944E1EE90CFB"
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "val" [=[ {"cs_type":"BOOL"} ]=],
}
alias "0x6DEE944E1EE90CFB"
ns "VEHICLE"
returns "void"
doc [[!
Often used in conjunction with: [SET_VEHICLE_REDUCE_GRIP](#\_0x222FF6A823D122E2).
```
NativeDB Introduced: v1604
```
]]
native "_SET_VEHICLE_ROCKET_BOOST_ACTIVE"
hash "0x81E1552E35DC3839"
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "active" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "_SET_VEHICLE_ROCKET_BOOST_PERCENTAGE"
hash "0xFEB2DDED3509562E"
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "percentage" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "_SET_VEHICLE_ROCKET_BOOST_REFILL_TIME"
hash "0xE00F2AB100B76E89"
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "time" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "_SET_VEHICLE_ROOF_LIVERY"
hash "0xA6D3A8750DC73270"
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "livery" [=[ {} ]=],
}
alias "0xA6D3A8750DC73270"
ns "VEHICLE"
returns "void"
doc [[!
Used to set the tornado custom (convertible) rooftop livery.
Livery value that works for tornado custom is between 0 and 9 from what i can tell. Maybe 0-8 even.
Might work on other custom vehicles but im not sure what those might be, only confirmed it working with the tornado custom.
The vehicle handle.
Livery index.
]]
native "_SET_VEHICLE_SHADOW_EFFECT"
hash "0xF0E4BA16D1DB546C"
jhash (0x5BD8D82D)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "p1" [=[ {} ]=],
int "p2" [=[ {} ]=],
}
alias "0xF0E4BA16D1DB546C"
ns "VEHICLE"
returns "void"
doc [[!
```
Adds some kind of shadow to the vehicle.
-1 disables the effect.
DISABLE_*
```
]]
native "_SET_VEHICLE_SILENT"
hash "0x9D44FCCE98450843"
jhash (0x968E5770)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x9D44FCCE98450843"
ns "VEHICLE"
returns "void"
doc [[!
```
If set to TRUE, it seems to suppress door noises and doesn't allow the horn to be continuous.
```
]]
native "_SET_VEHICLE_ST"
hash "0x1CF38D529D7441D9"
jhash (0xDF594D8D)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x1CF38D529D7441D9"
ns "VEHICLE"
returns "void"
doc [[!
```
Has something to do with trains. Always precedes SET_MISSION_TRAIN_AS_NO_LONGER_NEEDED.
============================================
May be true that it can be used with trains not sure, but not specifically for trains. Go find Xbox360 decompiled scripts and search for 'func_1333' in freemode.c it isn't used just for trains. Thanks for the info tho.
Btw, func_1333 ends up calling this func which uses this native,
void func_1338(int iParam0)//Position
{
ENTITY::FREEZE_ENTITY_POSITION(iParam0, true);
ENTITY::SET_ENTITY_COLLISION(iParam0, false, 0);
ENTITY::SET_ENTITY_INVINCIBLE(iParam0, true);
VEHICLE::_0xDF594D8D(iParam0, true);
}
```
]]
native "_SET_VEHICLE_TURRET_UNK"
hash "0xC60060EB0D8AC7B1"
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "index" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0xC60060EB0D8AC7B1"
ns "VEHICLE"
returns "void"
doc [[!
```
Toggles specific flag on turret
```
```
NativeDB Introduced: v1290
```
]]
native "_SET_VEHICLE_UNK_DAMAGE_MULTIPLIER"
hash "0x45A561A9421AB6AD"
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "multiplier" [=[ {} ]=],
}
alias "0x45A561A9421AB6AD"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "_SET_VEHICLE_USE_HORN_BUTTON_FOR_NITROUS"
hash "0x1980F68872CC2C3D"
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "bToggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
NativeDB Introduced: v3095
```
Enables or disables the use of the vehicle's horn button for activating the nitrous system.
The vehicle where this setting will be applied.
If set to `true`, the horn button will activate the nitrous system; if `false`, it will not.
]]
native "_SET_VEHICLE_WEAPONS_DISABLED"
hash "0x86B4B6212CB8B627"
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "weaponSlot" [=[ {} ]=],
}
alias "0x86B4B6212CB8B627"
ns "VEHICLE"
returns "void"
doc [[!
]]
native "_SET_VEHICLE_WHEELS_DEAL_DAMAGE"
hash "0x2970EAA18FD5E42F"
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
alias "0x2970EAA18FD5E42F"
ns "VEHICLE"
returns "void"
doc [[!
```
Related to monster trucks in native scripts.
```
```
NativeDB Introduced: v1604
```
]]
native "_SET_VEHICLE_XENON_LIGHTS_COLOR"
hash "0xE41033B25D003A07"
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "color" [=[ {} ]=],
}
alias "0xE41033B25D003A07"
alias "_SET_VEHICLE_HEADLIGHTS_COLOUR"
alias "_SET_VEHICLE_XENON_LIGHTS_COLOUR"
ns "VEHICLE"
returns "void"
doc [[!
Paint index goes from 0 to 12.
You can find the list of colors and ids here: [\_GET_VEHICLE_HEADLIGHTS_COLOUR](#\_0x3DFF319A831E0CDB)
The vehicle handle.
The paint index.
]]
native "_STOP_BRING_VEHICLE_TO_HALT"
hash "0x7C06330BFDDA182E"
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
alias "0x7C06330BFDDA182E"
ns "VEHICLE"
returns "void"
doc [[!
```
Stops CTaskBringVehicleToHalt
```
]]
native "0x0205F5365292D2EB"
hash "0x0205F5365292D2EB"
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "p1" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "0x0419B167EE128F33"
hash "0x0419B167EE128F33"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "VEHICLE"
returns "Any"
doc [[!
]]
native "0x0581730AB9380412"
hash "0x0581730AB9380412"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "0x063AE2B2CC273588"
hash "0x063AE2B2CC273588"
jhash (0x2EF8435C)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
A vehicle recording playback flag only used in jewelry_heist
```
]]
native "0x065D03A9D6B2C6B5"
hash "0x065D03A9D6B2C6B5"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "0x107A473D7A6647A9"
hash "0x107A473D7A6647A9"
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "0x1312DDD8385AEE4E"
hash "0x1312DDD8385AEE4E"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "0x182F266C2D9E2BEB"
hash "0x182F266C2D9E2BEB"
jhash (0x7D0DE7EA)
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "p1" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "0x2310A8F9421EBF43"
hash "0x2310A8F9421EBF43"
arguments {
Any "p0" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
NativeDB Introduced: v2372
```
]]
native "0x2311DD7159F00582"
hash "0x2311DD7159F00582"
jhash (0x758C5E2E)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "0x2C4A1590ABF43E8B"
hash "0x2C4A1590ABF43E8B"
jhash (0x2EC19A8B)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
SET_VEHICLE_W* (next character is either H or I)
```
]]
native "0x3441CAD2F2231923"
hash "0x3441CAD2F2231923"
jhash (0xC306A9A3)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "0x35BB21DE06784373"
hash "0x35BB21DE06784373"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "0x35E0654F4BAD7971"
hash "0x35E0654F4BAD7971"
arguments {
BOOL "p0" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "0x36DE109527A2C0C4"
hash "0x36DE109527A2C0C4"
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
Does nothing. It's a nullsub.
NativeDB Introduced: v1604
```
]]
native "0x3B458DDB57038F08"
hash "0x3B458DDB57038F08"
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "doorIndex" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
Usually used alongside other vehicle door natives.
```
]]
native "0x407DC5E97DB1A4D3"
hash "0x407DC5E97DB1A4D3"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
NativeDB Introduced: v1493
```
]]
native "0x41290B40FA63E6DA"
hash "0x41290B40FA63E6DA"
arguments {
Any "p0" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "0x428AD3E26C8D9EB0"
hash "0x428AD3E26C8D9EB0"
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "p4" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
SET_*
```
]]
native "0x430A7631A84C9BE7"
hash "0x430A7631A84C9BE7"
arguments {
Any "p0" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
NativeDB Introduced: v1180
```
]]
native "0x4419966C9936071A"
hash "0x4419966C9936071A"
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
CLEAR_VEHICLE_*
```
]]
native "0x4AD280EB48B2D8E6"
hash "0x4AD280EB48B2D8E6"
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "togle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
NativeDB Introduced: v1868
```
]]
native "0x4D9D109F63FEE1D4"
hash "0x4D9D109F63FEE1D4"
jhash (0x900C878C)
arguments {
Any "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "0x51DB102F4A3BA5E0"
hash "0x51DB102F4A3BA5E0"
jhash (0x0B0523B0)
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "0x51F30DB60626A20E"
hash "0x51F30DB60626A20E"
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
float "rotX" [=[ {} ]=],
float "rotY" [=[ {} ]=],
float "rotZ" [=[ {} ]=],
int "p7" [=[ {} ]=],
Any "p8" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
Usex in decompiled scripts in combination with [`_GET_VEHICLE_SUSPENSION_BOUNDS`](#\_0xDF7E3EEB29642C38).
NativeDB Introduced: v1180
```
// Example from fm_bj_race_controller.c
if (!VEHICLE::_0x51F30DB60626A20E(uParam0->f_26, uParam0->f_12.f_3, uParam0->f_12, 2, 1) && !func_282(uParam0->f_6))
{
VEHICLE::_GET_VEHICLE_SUSPENSION_BOUNDS(*uParam0, &vVar15, &uVar16);
VEHICLE::_GET_VEHICLE_SUSPENSION_BOUNDS(uParam0->f_26, &vVar17, &uVar18);
fVar19 = SYSTEM::VDIST2(0f, 0f, vVar15.z, 0f, 0f, vVar17.z);
uParam0->f_12.f_3.f_2 = (uParam0->f_12.f_3.f_2 + fVar19);
if (!VEHICLE::_0x51F30DB60626A20E(uParam0->f_26, uParam0->f_12.f_3, uParam0->f_12, 2, 1))
{
uParam0->f_12.f_3 = { uParam0->f_6 };
uParam0->f_12 = { uParam0->f_9 };
}
}
```
the target vehicle
vehicle location
vehicle location
vehicle location
some kind of vehicle rotation value
some kind of vehicle rotation value
some kind of vehicle rotation value
usually 2
usually 1
A BOOL value, purpose unknown.
]]
native "0x56EB5E94318D3FB6"
hash "0x56EB5E94318D3FB6"
jhash (0x30F43FE3)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "0x5845066D8A1EA7F7"
hash "0x5845066D8A1EA7F7"
jhash (0x943A58EB)
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "x" [=[ {} ]=],
float "y" [=[ {} ]=],
float "z" [=[ {} ]=],
Any "p4" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "0x59C3757B3B7408E8"
hash "0x59C3757B3B7408E8"
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
float "p2" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
NativeDB Introduced: v1493
```
]]
native "0x5BA68A0840D546AC"
hash "0x5BA68A0840D546AC"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "VEHICLE"
returns "Any"
doc [[!
]]
native "0x5BBCF35BF6E456F7"
hash "0x5BBCF35BF6E456F7"
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
NativeDB Introduced: v1604
```
]]
native "0x5E569EC46EC21CAE"
hash "0x5E569EC46EC21CAE"
jhash (0xBC649C49)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "0x5EE5632F47AE9695"
hash "0x5EE5632F47AE9695"
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "health" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
Sets some health value. Looks like it's used for helis.
```
]]
native "0x6501129C9E0FFA05"
hash "0x6501129C9E0FFA05"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "0x65B080555EA48149"
hash "0x65B080555EA48149"
arguments {
Any "p0" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "0x66E3AAFACE2D1EB8"
hash "0x66E3AAFACE2D1EB8"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "0x6A973569BA094650"
hash "0x6A973569BA094650"
arguments {
Vehicle "vehicle" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
NativeDB Introduced: v1604
```
]]
native "0x6EAAEFC76ACC311F"
hash "0x6EAAEFC76ACC311F"
arguments {
Any "p0" [=[ {} ]=],
}
ns "VEHICLE"
returns "Any"
doc [[!
]]
native "0x6EBFB22D646FFC18"
hash "0x6EBFB22D646FFC18"
jhash (0x847F1304)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "0x725012A415DBA050"
hash "0x725012A415DBA050"
arguments {
Any "p0" [=[ {} ]=],
AnyPtr "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
ns "VEHICLE"
returns "Any"
doc [[!
Last named native above this one is `TRACK_VEHICLE_VISIBILITY` and first named native below is `UNCUFF_PED`.
Unknown what it does, couldn't find good examples in the decompiled scripts.
]]
native "0x72BECCF4B829522E"
hash "0x72BECCF4B829522E"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "0x73561D4425A021A2"
hash "0x73561D4425A021A2"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "0x737E398138550FFF"
hash "0x737E398138550FFF"
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "0x76D26A22750E849E"
hash "0x76D26A22750E849E"
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
SET_VEHICLE_*
```
]]
native "0x78CEEE41F49F421F"
hash "0x78CEEE41F49F421F"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "0x796A877E459B99EA"
hash "0x796A877E459B99EA"
jhash (0x5C9F477C)
arguments {
Any "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "0x7BBE7FF626A591FE"
hash "0x7BBE7FF626A591FE"
arguments {
Any "p0" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "0x7D6F9A3EF26136A0"
hash "0x7D6F9A3EF26136A0"
jhash (0xBB54ECCA)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
SET_VEHICLE_AL*
```
]]
native "0x80E3357FDEF45C21"
hash "0x80E3357FDEF45C21"
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "0x8235F1BEAD557629"
hash "0x8235F1BEAD557629"
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
NativeDB Introduced: v1180
```
]]
native "0x82E0AC411E41A5B4"
hash "0x82E0AC411E41A5B4"
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
Does nothing. It's a nullsub.
NativeDB Introduced: v1604
```
]]
native "0x8533CAFDE1F0F336"
hash "0x8533CAFDE1F0F336"
arguments {
Any "p0" [=[ {} ]=],
}
ns "VEHICLE"
returns "Any"
doc [[!
]]
native "0x8664170EF165C4A6"
hash "0x8664170EF165C4A6"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
NativeDB Introduced: v2189
```
]]
native "0x870B8B7A766615C8"
hash "0x870B8B7A766615C8"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "0x8821196D91FA2DE5"
hash "0x8821196D91FA2DE5"
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "0x887FA38787DE8C72"
hash "0x887FA38787DE8C72"
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
NativeDB Introduced: v1365
```
]]
native "0x88BC673CA9E0AE99"
hash "0x88BC673CA9E0AE99"
jhash (0xF0E5C41D)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "0x8F0D5BA1C2CC91D7"
hash "0x8F0D5BA1C2CC91D7"
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
NativeDB Introduced: v1604
```
]]
native "0x9640E30A7F395E4B"
hash "0x9640E30A7F395E4B"
arguments {
Vehicle "vehicle" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "0x97841634EF7DF1D6"
hash "0x97841634EF7DF1D6"
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
NativeDB Introduced: v1180
```
]]
native "0x9849DE24FCF23CCC"
hash "0x9849DE24FCF23CCC"
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
NativeDB Introduced: v1604
```
]]
native "0x99A05839C46CE316"
hash "0x99A05839C46CE316"
arguments {
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
Does nothing. It's a nullsub.
NativeDB Introduced: v1604
```
]]
native "0x99CAD8E7AFDB60FA"
hash "0x99CAD8E7AFDB60FA"
jhash (0x1128A45B)
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "0x9BDDC73CC6A115D4"
hash "0x9BDDC73CC6A115D4"
jhash (0x50CDB295)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
BOOL "p2" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "0x9BECD4B9FEF3F8A6"
hash "0x9BECD4B9FEF3F8A6"
jhash (0xACAB8FF3)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "0x9D30687C57BAA0BB"
hash "0x9D30687C57BAA0BB"
arguments {
Any "p0" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "0x9F3F689B814F2599"
hash "0x9F3F689B814F2599"
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "0xA01BC64DD4BFBBAC"
hash "0xA01BC64DD4BFBBAC"
jhash (0x5ED1EECC)
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "seatIndex" [=[ {} ]=],
}
ns "VEHICLE"
returns "Hash"
doc [[!
Gets hash related to task happening with seat index
Native name: GET_I\*
]]
native "0xA247F9EF01D8082E"
hash "0xA247F9EF01D8082E"
arguments {
Any "p0" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "0xA4822F1CF23F4810"
hash "0xA4822F1CF23F4810"
jhash (0x34E02FCD)
arguments {
Vector3Ptr "outVec" [=[ {} ]=],
Vector3Ptr "p1" [=[ {} ]=],
Vector3Ptr "outVec1" [=[ {} ]=],
Any "p3" [=[ {} ]=],
Any "p4" [=[ {} ]=],
Any "p5" [=[ {} ]=],
Any "p6" [=[ {} ]=],
Any "p7" [=[ {} ]=],
Any "p8" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "0xA4A9A4C40E615885"
hash "0xA4A9A4C40E615885"
arguments {
Any "p0" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
NativeDB Introduced: v1604
```
]]
native "0xA7DCDF4DED40A8F4"
hash "0xA7DCDF4DED40A8F4"
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "0xAA653AE61924B0A0"
hash "0xAA653AE61924B0A0"
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "0xAB04325045427AAE"
hash "0xAB04325045427AAE"
jhash (0x1984F88D)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "0xAB31EF4DE6800CE9"
hash "0xAB31EF4DE6800CE9"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "0xAE3FEE8709B39DCB"
hash "0xAE3FEE8709B39DCB"
jhash (0xE39DAF36)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
]]
native "0xAF60E6A2936F982A"
hash "0xAF60E6A2936F982A"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "0xB2E0C0D6922D31F2"
hash "0xB2E0C0D6922D31F2"
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
SET_C*
```
]]
native "0xB68CFAF83A02768D"
hash "0xB68CFAF83A02768D"
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
NativeDB Introduced: v1290
```
]]
native "0xB9562064627FF9DB"
hash "0xB9562064627FF9DB"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "0xBB2333BB87DDD87F"
hash "0xBB2333BB87DDD87F"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "0xBE5C1255A1830FF5"
hash "0xBE5C1255A1830FF5"
jhash (0xA6D8D7A5)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "toggle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "0xC0ED6438E6D39BA8"
hash "0xC0ED6438E6D39BA8"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
Any "p2" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "0xC361AA040D6637A8"
hash "0xC361AA040D6637A8"
jhash (0x819CD954)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
Vehicle must be a plane.
Native name is between SET_VEHICLE_BRAKE_LIGHTS and SET_VEHICLE_BULLDOZER_ARM_POSITION alphabetically.
]]
native "0xC4B3347BD68BD609"
hash "0xC4B3347BD68BD609"
arguments {
Any "p0" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "0xC50CE861B55EAB8B"
hash "0xC50CE861B55EAB8B"
jhash (0x40C323AE)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
SET_VEHICLE_LI*
```
]]
native "0xCF9159024555488C"
hash "0xCF9159024555488C"
arguments {
Any "p0" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "0xCFD778E7904C255E"
hash "0xCFD778E7904C255E"
jhash (0x3FBE904F)
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
what does this do?
```
]]
native "0xD3301660A57C9272"
hash "0xD3301660A57C9272"
arguments {
Any "p0" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "0xD3E51C0AB8C26EEE"
hash "0xD3E51C0AB8C26EEE"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "VEHICLE"
returns "Any"
doc [[!
]]
native "0xD4196117AF7BB974"
hash "0xD4196117AF7BB974"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "VEHICLE"
returns "Any"
doc [[!
]]
native "0xD565F438137F0E10"
hash "0xD565F438137F0E10"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "0xDBC631F109350B8C"
hash "0xDBC631F109350B8C"
jhash (0x486C1280)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
Related to locking the vehicle or something similar.
In the decompiled scripts, its always called after
VEHICLE::_SET_EXCLUSIVE_DRIVER(a_0, 0, 0);
VEHICLE::SET_VEHICLE_DOORS_LOCKED_FOR_ALL_PLAYERS(a_0, 1);
VEHICLE::SET_VEHICLE_DOORS_LOCKED_FOR_PLAYER(a_0, PLAYER::PLAYER_ID(), 0);
```
]]
native "0xDCE97BDF8A0EABC8"
hash "0xDCE97BDF8A0EABC8"
ns "VEHICLE"
returns "void"
doc [[!
```
NativeDB Added Parameter 1: Vehicle vehicle
NativeDB Added Parameter 2: Any p1
```
]]
native "0xE05DD0E9707003A3"
hash "0xE05DD0E9707003A3"
jhash (0x123E5B90)
arguments {
Any "p0" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "0xE2F53F172B45EDE1"
hash "0xE2F53F172B45EDE1"
ns "VEHICLE"
returns "void"
doc [[!
```
RESET_*
Resets the effect of 0x428AD3E26C8D9EB0
```
]]
native "0xE5810AC70602F2F5"
hash "0xE5810AC70602F2F5"
jhash (0xB6BE07E0)
arguments {
Vehicle "vehicle" [=[ {} ]=],
float "p1" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "0xE851E480B814D4BA"
hash "0xE851E480B814D4BA"
jhash (0x2F98B4B7)
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "0xE8718FAF591FD224"
hash "0xE8718FAF591FD224"
arguments {
Vehicle "vehicle" [=[ {} ]=],
}
ns "VEHICLE"
returns "BOOL"
doc [[!
```
GET_H*
NativeDB Introduced: v1604
```
]]
native "0xED5EDE9E676643C9"
hash "0xED5EDE9E676643C9"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "0xEF9D388F8D377F44"
hash "0xEF9D388F8D377F44"
arguments {
Vehicle "vehicle" [=[ {} ]=],
BOOL "p1" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
Only used in R* Script fm_content_cargo
```
```
NativeDB Introduced: v2699
```
]]
native "0xF051D9BFB6BA39C0"
hash "0xF051D9BFB6BA39C0"
arguments {
Any "p0" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]
native "0xF25E02CB9C5818F8"
hash "0xF25E02CB9C5818F8"
jhash (0xF0E59BC1)
ns "VEHICLE"
returns "void"
doc [[!
]]
native "0xF3B0E0AED097A3F5"
hash "0xF3B0E0AED097A3F5"
arguments {
Any "p0" [=[ {} ]=],
Any "p1" [=[ {} ]=],
}
ns "VEHICLE"
returns "Any"
doc [[!
]]
native "0xF8B49F5BA7F850E7"
hash "0xF8B49F5BA7F850E7"
arguments {
Vehicle "vehicle" [=[ {} ]=],
int "p1" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
```
NativeDB Introduced: v2060
```
]]
native "0xFAF2A78061FD9EF4"
hash "0xFAF2A78061FD9EF4"
jhash (0xCD83C393)
arguments {
Any "p0" [=[ {} ]=],
float "p1" [=[ {} ]=],
float "p2" [=[ {} ]=],
float "p3" [=[ {} ]=],
}
ns "VEHICLE"
returns "void"
doc [[!
]]