Merge branch 'master' of https://github.com/freedy69/natives

HUD/DisableFrontendThisFrame.md

@@ -8,4 +8,4 @@ ns: HUD
 void DISABLE_FRONTEND_THIS_FRAME();
 ```
 
-
+Prevents pause menu from listening to controls 199, 200 every frame.

HUD/GetMenuLayoutChangedEventDetails.md

@@ -0,0 +1,34 @@
+---
+ns: HUD
+aliases: ["0x7E17BE53E1AAABAF", "_GET_PAUSE_MENU_SELECTION_DATA"]
+---
+## GET_MENU_LAYOUT_CHANGED_EVENT_DETAILS
+
+```c
+// 0x7E17BE53E1AAABAF 0x6025AA2F
+void GET_MENU_LAYOUT_CHANGED_EVENT_DETAILS(int* oldMenuState, int* currentMenuState, int* selectedItemUniqueId);
+```
+
+Returns details of the current layout changed event. Also see [`HAS_MENU_LAYOUT_CHANGE_EVENT_OCCURED`](#_0x2E22FEFA0100275E).
+Menu state values can be viewed in [PauseMenuLUT.as](https://gist.github.com/freedy69/19c4be9699e07946285f9b51799b67a9) in scaleform files.
+
+when the pausemenu is closed:
+oldMenuState = -1
+currentMenuState = -1
+selectedItemUniqueId = 0
+
+when the header gains focus:
+oldMenuState updates as normal or 0 if the pausemenu was just opened
+currentMenuState 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:
+oldMenuState becomes a unique id for the pausemenu page that focus was moved to (?)
+currentMenuState = -1
+selectedItemUniqueId updates as normal
+
+## Parameters
+* **oldMenuState**: This is the menuID of the last selected item minus 1000 (lastItem.menuID - 1000)
+* **currentMenuState**: Same as oldMenuState except for the currently selected menu item
+* **selectedItemUniqueId**: This is uniqueID of the currently selected menu item
+

HUD/GetMenuTriggerEventDetails.md

@@ -0,0 +1,18 @@
+---
+ns: HUD
+aliases: ["0x36C1451A88A09630", "_GET_PAUSE_MENU_SELECTION"]
+---
+## GET_MENU_TRIGGER_EVENT_DETAILS
+
+```c
+// 0x36C1451A88A09630 0x8543AAC8
+void GET_MENU_TRIGGER_EVENT_DETAILS(cs_type(AnyPtr) int* lastItemMenuId, cs_type(AnyPtr) int* selectedItemUniqueId);
+```
+
+Returns details of the currently occurred trigger event.
+See [`HAS_MENU_TRIGGER_EVENT_OCCURRED`](#_0xF284AC67940C6812).
+
+## Parameters
+* **lastItemMenuId**: 
+* **selectedItemUniqueId**: 
+

HUD/GetScaleformMovieCursorSelection.md → HUD/GetMouseEvent.md

@@ -1,15 +1,16 @@
 ---
 ns: HUD
-aliases: ["0x632B2940C67F4EA9"]
+aliases: ["0x632B2940C67F4EA9", "_GET_SCALEFORM_MOVIE_CURSOR_SELECTION"]
 ---
-## _GET_SCALEFORM_MOVIE_CURSOR_SELECTION
+## GET_MOUSE_EVENT
 
 ```c
 // 0x632B2940C67F4EA9
-BOOL _GET_SCALEFORM_MOVIE_CURSOR_SELECTION(int scaleformHandle, cs_type(Any*) bool* received, cs_type(Any*) int* selectionType, cs_type(Any*) int* context, int* slotIndex);
+BOOL GET_MOUSE_EVENT(int scaleformHandle, cs_type(Any*) bool* received, cs_type(Any*) int* selectionType, cs_type(Any*) int* context, int* slotIndex);
 ```
 
-Gets mouse selection data from scaleforms with mouse support. Must be checked every frame.
+Gets the current mouse event details when triggered by a scaleform.
+You must use this native every frame.
 Returns item index if using the COLOUR_SWITCHER_02 scaleform.
 Selection types, found in MOUSE_EVENTS.as:
 MOUSE_DRAG_OUT = 0;

HUD/GetPauseMenuPosition.md

@@ -0,0 +1,15 @@
+---
+ns: HUD
+aliases: ['0x5BFF36D6ED83E0AE', "_GET_PAUSE_MENU_CURSOR_POSITION"]
+---
+## GET_PAUSE_MENU_POSITION
+
+```c
+// 0x5BFF36D6ED83E0AE
+Vector3 GET_PAUSE_MENU_POSITION();
+```
+
+
+## Return value
+This is used as a vector2, so Z is always 0.
+Returns starting position coordinates of the Pause Menu's body component.

HUD/GetPauseMenuState.md

@@ -8,16 +8,11 @@ ns: HUD
 int GET_PAUSE_MENU_STATE();
 ```
 
-```
-Returns:
-0
-5
-10
-15
-20
-25
-30
-35
-```
-
 ## Return value
+0 - Pause menu isn't open
+5 - Pause menu is starting
+10 - Pause menu is switching
+15 - Pause menu is ready for control
+25 - Social club menu or online policies menu is open
+30 - Pause menu is exiting
+35 - Rockstar editor is active

HUD/HasMenuLayoutChangedEventOccurred.md

@@ -0,0 +1,14 @@
+---
+ns: HUD
+aliases: ["0x2E22FEFA0100275E"]
+---
+## HAS_MENU_LAYOUT_CHANGED_EVENT_OCCURRED
+
+```c
+// 0x2E22FEFA0100275E 0x96863460
+BOOL HAS_MENU_LAYOUT_CHANGED_EVENT_OCCURRED();
+```
+
+## Return value
+Returns true per frame when pause menu is navigated.
+Note: This can only be used by one script at a time.

HUD/HasMenuTriggerEventOccurred.md

@@ -0,0 +1,14 @@
+---
+ns: HUD
+aliases: ["0xF284AC67940C6812"]
+---
+## HAS_MENU_TRIGGER_EVENT_OCCURRED
+
+```c
+// 0xF284AC67940C6812 0x7D95AFFF
+cs_type(Any) BOOL HAS_MENU_TRIGGER_EVENT_OCCURRED();
+```
+
+## Return value
+Returns true if a pause menu Trigger Event has occured this frame.
+Trigger event becomes active whenever currently highlighted menu item in pause menu is either clicked on by the cursor or enter (control 201) is pressed.

HUD/IsMouseRolledOverInstructionalButtons.md

@@ -0,0 +1,14 @@
+---
+ns: HUD
+aliases: ["0x3D9ACB1EB139E702", "_IS_MOUSE_CURSOR_ABOVE_INSTRUCTIONAL_BUTTONS"]
+---
+## IS_MOUSE_ROLLED_OVER_INSTRUCTIONAL_BUTTONS
+
+```c
+// 0x3D9ACB1EB139E702
+cs_type(Any) BOOL IS_MOUSE_ROLLED_OVER_INSTRUCTIONAL_BUTTONS();
+```
+
+## Return value
+Returns true if the cursor is hovering above instructional buttons. 
+Note: The buttons need to support mouse (with the TOGGLE_MOUSE_SUPPORT scaleform movie method) for it to return true.

HUD/IsWarningMessageReadyForControl.md

@@ -0,0 +1,13 @@
+---
+ns: HUD
+aliases: ["0xAF42195A42C63BBA", "_IS_WARNING_MESSAGE_ACTIVE_2"]
+---
+## IS_WARNING_MESSAGE_READY_FOR_CONTROL
+
+```c
+// 0xAF42195A42C63BBA
+BOOL IS_WARNING_MESSAGE_READY_FOR_CONTROL();
+```
+
+## Return value
+Returns if the warning message scaleform (popup_warning) is loaded.

HUD/PauseMenuGetMouseHoverIndex.md

@@ -0,0 +1,13 @@
+---
+ns: HUD
+aliases: ["0x359AF31A4B52F5ED", "_PAUSE_MENU_GET_INDEX_OF_MOUSE_HOVERED_SLOT"]
+---
+## PAUSE_MENU_GET_MOUSE_HOVER_INDEX
+
+```c
+// 0x359AF31A4B52F5ED
+int PAUSE_MENU_GET_MOUSE_HOVER_INDEX();
+```
+
+## Return value
+If mouse is hovering on a slot, it returns the slot's index, else it returns -1.

HUD/PauseMenuGetMouseHoverUniqueId.md

@@ -0,0 +1,13 @@
+---
+ns: HUD
+aliases: ["0x13C4B962653A5280", "_PAUSE_MENU_GET_UNIQUE_ID_OF_MOUSE_HOVERED_SLOT"]
+---
+## PAUSE_MENU_GET_MOUSE_HOVER_UNIQUE_ID
+
+```c
+// 0x13C4B962653A5280
+int PAUSE_MENU_GET_MOUSE_HOVER_UNIQUE_ID();
+```
+
+## Return value
+If mouse is hovering on a slot, it returns uniqueid of that slot, else it returns -1.