From d14a8980e7d5631b971f52c7191c4306c7ce7db9 Mon Sep 17 00:00:00 2001 From: Freddy <33939455+freedy69@users.noreply.github.com> Date: Sat, 18 Nov 2023 00:17:38 +0400 Subject: [PATCH 1/4] Document various HUD natives Used actual names and documented what purpose they serve. --- HUD/GetMenuLayoutChangedEventDetails.md | 38 +++++++++++++++++++ HUD/GetMenuTriggerEventDetails.md | 17 +++++++++ ...vieCursorSelection.md => GetMouseEvent.md} | 8 ++-- HUD/GetPauseMenuCursorPosition.md | 17 --------- HUD/GetPauseMenuPosition.md | 15 ++++++++ HUD/GetPauseMenuSelection.md | 15 -------- HUD/GetPauseMenuSelectionData.md | 34 ----------------- HUD/GetPauseMenuState.md | 19 ++++------ HUD/HasMenuLayoutChangedEventOccurred.md | 15 ++++++++ HUD/HasMenuTriggerEventOccurred.md | 15 ++++++++ ... IsMouseRolledOverInstructionalButtons.md} | 6 +-- HUD/IsWarningMessageActive_2.md | 16 -------- HUD/IsWarningMessageReadyForControl.md | 13 +++++++ HUD/N_0x2e22fefa0100275e.md | 12 ------ HUD/N_0xf284ac67940c6812.md | 12 ------ HUD/PauseMenuGetIndexOfMouseHoveredSlot.md | 14 ------- HUD/PauseMenuGetMouseHoverIndex.md | 14 +++++++ HUD/PauseMenuGetMouseHoverUniqueId.md | 15 ++++++++ HUD/PauseMenuGetUniqueIdOfMouseHoveredSlot.md | 15 -------- 19 files changed, 157 insertions(+), 153 deletions(-) create mode 100644 HUD/GetMenuLayoutChangedEventDetails.md create mode 100644 HUD/GetMenuTriggerEventDetails.md rename HUD/{GetScaleformMovieCursorSelection.md => GetMouseEvent.md} (82%) delete mode 100644 HUD/GetPauseMenuCursorPosition.md create mode 100644 HUD/GetPauseMenuPosition.md delete mode 100644 HUD/GetPauseMenuSelection.md delete mode 100644 HUD/GetPauseMenuSelectionData.md create mode 100644 HUD/HasMenuLayoutChangedEventOccurred.md create mode 100644 HUD/HasMenuTriggerEventOccurred.md rename HUD/{IsMouseCursorAboveInstructionalButtons.md => IsMouseRolledOverInstructionalButtons.md} (57%) delete mode 100644 HUD/IsWarningMessageActive_2.md create mode 100644 HUD/IsWarningMessageReadyForControl.md delete mode 100644 HUD/N_0x2e22fefa0100275e.md delete mode 100644 HUD/N_0xf284ac67940c6812.md delete mode 100644 HUD/PauseMenuGetIndexOfMouseHoveredSlot.md create mode 100644 HUD/PauseMenuGetMouseHoverIndex.md create mode 100644 HUD/PauseMenuGetMouseHoverUniqueId.md delete mode 100644 HUD/PauseMenuGetUniqueIdOfMouseHoveredSlot.md diff --git a/HUD/GetMenuLayoutChangedEventDetails.md b/HUD/GetMenuLayoutChangedEventDetails.md new file mode 100644 index 000000000..b598afda8 --- /dev/null +++ b/HUD/GetMenuLayoutChangedEventDetails.md @@ -0,0 +1,38 @@ +--- +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 the HasMenuLayoutChangedEventOccurred native. + +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 +menu state values can be viewed here (or PauseMenuLUT.as in scaleform files): https://pastebin.com/ZiMpN3mN + +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**: +* **currentMenuState**: +* **selectedItemUniqueId**: + diff --git a/HUD/GetMenuTriggerEventDetails.md b/HUD/GetMenuTriggerEventDetails.md new file mode 100644 index 000000000..8c1e5e6c1 --- /dev/null +++ b/HUD/GetMenuTriggerEventDetails.md @@ -0,0 +1,17 @@ +--- +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); +``` + +Also see HasMenuTriggerEventOccurred native. + +## Parameters +* **lastItemMenuId**: +* **selectedItemUniqueId**: + diff --git a/HUD/GetScaleformMovieCursorSelection.md b/HUD/GetMouseEvent.md similarity index 82% rename from HUD/GetScaleformMovieCursorSelection.md rename to HUD/GetMouseEvent.md index eec158e5b..3192595ca 100644 --- a/HUD/GetScaleformMovieCursorSelection.md +++ b/HUD/GetMouseEvent.md @@ -1,15 +1,15 @@ --- 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 current mouse event details, triggered by a scaleform. Returns item index if using the COLOUR_SWITCHER_02 scaleform. Selection types, found in MOUSE_EVENTS.as: MOUSE_DRAG_OUT = 0; diff --git a/HUD/GetPauseMenuCursorPosition.md b/HUD/GetPauseMenuCursorPosition.md deleted file mode 100644 index 7372f48db..000000000 --- a/HUD/GetPauseMenuCursorPosition.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -ns: HUD -aliases: ['0x5BFF36D6ED83E0AE'] ---- -## _GET_PAUSE_MENU_CURSOR_POSITION - -```c -// 0x5BFF36D6ED83E0AE -Vector3 _GET_PAUSE_MENU_CURSOR_POSITION(); -``` - -Name between `GET_ONSCREEN_KEYBOARD_RESULT` and `GET_PAUSE_MENU_STATE`. Likely, `GET_PAUSE_MENU_*`. - - -## Return value -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 diff --git a/HUD/GetPauseMenuPosition.md b/HUD/GetPauseMenuPosition.md new file mode 100644 index 000000000..97089fe92 --- /dev/null +++ b/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 +Z is always 0. +Returns starting position coordinates of the Pause Menu's body component. diff --git a/HUD/GetPauseMenuSelection.md b/HUD/GetPauseMenuSelection.md deleted file mode 100644 index 055612e61..000000000 --- a/HUD/GetPauseMenuSelection.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -ns: HUD -aliases: ["0x36C1451A88A09630"] ---- -## _GET_PAUSE_MENU_SELECTION - -```c -// 0x36C1451A88A09630 0x8543AAC8 -void _GET_PAUSE_MENU_SELECTION(cs_type(AnyPtr) int* lastItemMenuId, cs_type(AnyPtr) int* selectedItemUniqueId); -``` - -## Parameters -* **lastItemMenuId**: -* **selectedItemUniqueId**: - diff --git a/HUD/GetPauseMenuSelectionData.md b/HUD/GetPauseMenuSelectionData.md deleted file mode 100644 index dad2bd110..000000000 --- a/HUD/GetPauseMenuSelectionData.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -ns: HUD -aliases: ["0x7E17BE53E1AAABAF"] ---- -## _GET_PAUSE_MENU_SELECTION_DATA - -```c -// 0x7E17BE53E1AAABAF 0x6025AA2F -void _GET_PAUSE_MENU_SELECTION_DATA(int* lastItemMenuId, int* selectedItemMenuId, int* selectedItemUniqueId); -``` - -``` -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 -``` - -## Parameters -* **lastItemMenuId**: -* **selectedItemMenuId**: -* **selectedItemUniqueId**: - diff --git a/HUD/GetPauseMenuState.md b/HUD/GetPauseMenuState.md index 4ca012f22..60d947d3b 100644 --- a/HUD/GetPauseMenuState.md +++ b/HUD/GetPauseMenuState.md @@ -8,16 +8,13 @@ ns: HUD int GET_PAUSE_MENU_STATE(); ``` -``` -Returns: -0 -5 -10 -15 -20 -25 -30 -35 -``` +Return values: +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 ## Return value diff --git a/HUD/HasMenuLayoutChangedEventOccurred.md b/HUD/HasMenuLayoutChangedEventOccurred.md new file mode 100644 index 000000000..96e9c3c9a --- /dev/null +++ b/HUD/HasMenuLayoutChangedEventOccurred.md @@ -0,0 +1,15 @@ +--- +ns: HUD +aliases: ["0x2E22FEFA0100275E"] +--- +## HAS_MENU_LAYOUT_CHANGED_EVENT_OCCURRED + +```c +// 0x2E22FEFA0100275E 0x96863460 +BOOL HAS_MENU_LAYOUT_CHANGED_EVENT_OCCURRED(); +``` + +Returns true per frame when pause menu is navigated. +Note: This can only be used by one script at a time. + +## Return value diff --git a/HUD/HasMenuTriggerEventOccurred.md b/HUD/HasMenuTriggerEventOccurred.md new file mode 100644 index 000000000..0e677aaf8 --- /dev/null +++ b/HUD/HasMenuTriggerEventOccurred.md @@ -0,0 +1,15 @@ +--- +ns: HUD +aliases: ["0xF284AC67940C6812"] +--- +## HAS_MENU_TRIGGER_EVENT_OCCURRED + +```c +// 0xF284AC67940C6812 0x7D95AFFF +cs_type(Any) BOOL HAS_MENU_TRIGGER_EVENT_OCCURRED(); +``` + +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. + +## Return value diff --git a/HUD/IsMouseCursorAboveInstructionalButtons.md b/HUD/IsMouseRolledOverInstructionalButtons.md similarity index 57% rename from HUD/IsMouseCursorAboveInstructionalButtons.md rename to HUD/IsMouseRolledOverInstructionalButtons.md index 99aeb25a6..52dc8a6b4 100644 --- a/HUD/IsMouseCursorAboveInstructionalButtons.md +++ b/HUD/IsMouseRolledOverInstructionalButtons.md @@ -1,12 +1,12 @@ --- ns: HUD -aliases: ["0x3D9ACB1EB139E702"] +aliases: ["0x3D9ACB1EB139E702", "_IS_MOUSE_CURSOR_ABOVE_INSTRUCTIONAL_BUTTONS"] --- -## _IS_MOUSE_CURSOR_ABOVE_INSTRUCTIONAL_BUTTONS +## IS_MOUSE_ROLLED_OVER_INSTRUCTIONAL_BUTTONS ```c // 0x3D9ACB1EB139E702 -cs_type(Any) BOOL _IS_MOUSE_CURSOR_ABOVE_INSTRUCTIONAL_BUTTONS(); +cs_type(Any) BOOL IS_MOUSE_ROLLED_OVER_INSTRUCTIONAL_BUTTONS(); ``` Returns true if the cursor is hovering above instructional buttons. diff --git a/HUD/IsWarningMessageActive_2.md b/HUD/IsWarningMessageActive_2.md deleted file mode 100644 index 21a3038e2..000000000 --- a/HUD/IsWarningMessageActive_2.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -ns: HUD -aliases: ["0xAF42195A42C63BBA"] ---- -## _IS_WARNING_MESSAGE_ACTIVE_2 - -```c -// 0xAF42195A42C63BBA -BOOL _IS_WARNING_MESSAGE_ACTIVE_2(); -``` - -``` -IS_WARNING_MESSAGE_* -``` - -## Return value diff --git a/HUD/IsWarningMessageReadyForControl.md b/HUD/IsWarningMessageReadyForControl.md new file mode 100644 index 000000000..ba0cb6790 --- /dev/null +++ b/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. diff --git a/HUD/N_0x2e22fefa0100275e.md b/HUD/N_0x2e22fefa0100275e.md deleted file mode 100644 index e0de1161a..000000000 --- a/HUD/N_0x2e22fefa0100275e.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -ns: HUD ---- -## _0x2E22FEFA0100275E - -```c -// 0x2E22FEFA0100275E 0x96863460 -BOOL _0x2E22FEFA0100275E(); -``` - - -## Return value diff --git a/HUD/N_0xf284ac67940c6812.md b/HUD/N_0xf284ac67940c6812.md deleted file mode 100644 index 9a9e025f5..000000000 --- a/HUD/N_0xf284ac67940c6812.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -ns: HUD ---- -## _0xF284AC67940C6812 - -```c -// 0xF284AC67940C6812 0x7D95AFFF -Any _0xF284AC67940C6812(); -``` - - -## Return value diff --git a/HUD/PauseMenuGetIndexOfMouseHoveredSlot.md b/HUD/PauseMenuGetIndexOfMouseHoveredSlot.md deleted file mode 100644 index 8357124ce..000000000 --- a/HUD/PauseMenuGetIndexOfMouseHoveredSlot.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -ns: HUD -aliases: ["0x359AF31A4B52F5ED"] ---- -## _PAUSE_MENU_GET_INDEX_OF_MOUSE_HOVERED_SLOT - -```c -// 0x359AF31A4B52F5ED -int _PAUSE_MENU_GET_INDEX_OF_MOUSE_HOVERED_SLOT(); -``` - -If mouse is hovering on a slot, it returns the slot's index, else it returns -1. - -## Return value diff --git a/HUD/PauseMenuGetMouseHoverIndex.md b/HUD/PauseMenuGetMouseHoverIndex.md new file mode 100644 index 000000000..daf20c4f4 --- /dev/null +++ b/HUD/PauseMenuGetMouseHoverIndex.md @@ -0,0 +1,14 @@ +--- +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(); +``` + +If mouse is hovering on a slot, it returns the slot's index, else it returns -1. + +## Return value diff --git a/HUD/PauseMenuGetMouseHoverUniqueId.md b/HUD/PauseMenuGetMouseHoverUniqueId.md new file mode 100644 index 000000000..4b8cbe1a7 --- /dev/null +++ b/HUD/PauseMenuGetMouseHoverUniqueId.md @@ -0,0 +1,15 @@ +--- +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(); +``` + +If mouse is hovering on a slot, it returns uniqueid of that slot, else it returns -1. + +## Return value + diff --git a/HUD/PauseMenuGetUniqueIdOfMouseHoveredSlot.md b/HUD/PauseMenuGetUniqueIdOfMouseHoveredSlot.md deleted file mode 100644 index cf88bb52a..000000000 --- a/HUD/PauseMenuGetUniqueIdOfMouseHoveredSlot.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -ns: HUD -aliases: ["0x13C4B962653A5280"] ---- -## _PAUSE_MENU_GET_UNIQUE_ID_OF_MOUSE_HOVERED_SLOT - -```c -// 0x13C4B962653A5280 -int _PAUSE_MENU_GET_UNIQUE_ID_OF_MOUSE_HOVERED_SLOT(); -``` - -If mouse is hovering on a slot, it returns uniqueid of that slot, else it returns -1. - -## Return value - From d87de2b2ad18fc693d796184e3b3956414a2cd3a Mon Sep 17 00:00:00 2001 From: Freddy <33939455+freedy69@users.noreply.github.com> Date: Sat, 18 Nov 2023 00:29:50 +0400 Subject: [PATCH 2/4] Update DisableFrontendThisFrame.md --- HUD/DisableFrontendThisFrame.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/HUD/DisableFrontendThisFrame.md b/HUD/DisableFrontendThisFrame.md index 45394ae91..1b27ca77e 100644 --- a/HUD/DisableFrontendThisFrame.md +++ b/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. From 6ed220959735686b09f9496d2df89c5e5084e8af Mon Sep 17 00:00:00 2001 From: Freddy <33939455+freedy69@users.noreply.github.com> Date: Sat, 18 Nov 2023 13:59:48 +0400 Subject: [PATCH 3/4] Change AvarianKnight's suggestions --- HUD/GetMenuLayoutChangedEventDetails.md | 14 +++++--------- HUD/GetMenuTriggerEventDetails.md | 3 ++- HUD/GetMouseEvent.md | 3 ++- HUD/GetPauseMenuPosition.md | 2 +- HUD/GetPauseMenuState.md | 6 ++---- HUD/HasMenuLayoutChangedEventOccurred.md | 5 ++--- HUD/HasMenuTriggerEventOccurred.md | 5 ++--- HUD/IsMouseRolledOverInstructionalButtons.md | 5 ++--- HUD/PauseMenuGetMouseHoverIndex.md | 3 +-- HUD/PauseMenuGetMouseHoverUniqueId.md | 4 +--- 10 files changed, 20 insertions(+), 30 deletions(-) diff --git a/HUD/GetMenuLayoutChangedEventDetails.md b/HUD/GetMenuLayoutChangedEventDetails.md index b598afda8..e94b47daf 100644 --- a/HUD/GetMenuLayoutChangedEventDetails.md +++ b/HUD/GetMenuLayoutChangedEventDetails.md @@ -9,12 +9,8 @@ aliases: ["0x7E17BE53E1AAABAF", "_GET_PAUSE_MENU_SELECTION_DATA"] void GET_MENU_LAYOUT_CHANGED_EVENT_DETAILS(int* oldMenuState, int* currentMenuState, int* selectedItemUniqueId); ``` -Returns details of the current layout changed event. Also see the HasMenuLayoutChangedEventOccurred native. - -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 -menu state values can be viewed here (or PauseMenuLUT.as in scaleform files): https://pastebin.com/ZiMpN3mN +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 @@ -32,7 +28,7 @@ currentMenuState = -1 selectedItemUniqueId updates as normal ## Parameters -* **oldMenuState**: -* **currentMenuState**: -* **selectedItemUniqueId**: +* **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 diff --git a/HUD/GetMenuTriggerEventDetails.md b/HUD/GetMenuTriggerEventDetails.md index 8c1e5e6c1..cf0a509f8 100644 --- a/HUD/GetMenuTriggerEventDetails.md +++ b/HUD/GetMenuTriggerEventDetails.md @@ -9,7 +9,8 @@ aliases: ["0x36C1451A88A09630", "_GET_PAUSE_MENU_SELECTION"] void GET_MENU_TRIGGER_EVENT_DETAILS(cs_type(AnyPtr) int* lastItemMenuId, cs_type(AnyPtr) int* selectedItemUniqueId); ``` -Also see HasMenuTriggerEventOccurred native. +Returns details of the currently occurred trigger event. +See [`HAS_MENU_TRIGGER_EVENT_OCCURRED`](#_0xF284AC67940C6812). ## Parameters * **lastItemMenuId**: diff --git a/HUD/GetMouseEvent.md b/HUD/GetMouseEvent.md index 3192595ca..a57ef25b9 100644 --- a/HUD/GetMouseEvent.md +++ b/HUD/GetMouseEvent.md @@ -9,7 +9,8 @@ aliases: ["0x632B2940C67F4EA9", "_GET_SCALEFORM_MOVIE_CURSOR_SELECTION"] BOOL GET_MOUSE_EVENT(int scaleformHandle, cs_type(Any*) bool* received, cs_type(Any*) int* selectionType, cs_type(Any*) int* context, int* slotIndex); ``` -Gets current mouse event details, triggered by a scaleform. +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; diff --git a/HUD/GetPauseMenuPosition.md b/HUD/GetPauseMenuPosition.md index 97089fe92..f88dd7762 100644 --- a/HUD/GetPauseMenuPosition.md +++ b/HUD/GetPauseMenuPosition.md @@ -6,7 +6,7 @@ aliases: ['0x5BFF36D6ED83E0AE', "_GET_PAUSE_MENU_CURSOR_POSITION"] ```c // 0x5BFF36D6ED83E0AE -Vector3 GET_PAUSE_MENU_POSITION(); +cs_type(Vector3) Vector2 GET_PAUSE_MENU_POSITION(); ``` diff --git a/HUD/GetPauseMenuState.md b/HUD/GetPauseMenuState.md index 60d947d3b..afd4900bd 100644 --- a/HUD/GetPauseMenuState.md +++ b/HUD/GetPauseMenuState.md @@ -8,13 +8,11 @@ ns: HUD int GET_PAUSE_MENU_STATE(); ``` -Return values: +## 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 - -## Return value +35 - Rockstar editor is active \ No newline at end of file diff --git a/HUD/HasMenuLayoutChangedEventOccurred.md b/HUD/HasMenuLayoutChangedEventOccurred.md index 96e9c3c9a..2a5557942 100644 --- a/HUD/HasMenuLayoutChangedEventOccurred.md +++ b/HUD/HasMenuLayoutChangedEventOccurred.md @@ -9,7 +9,6 @@ aliases: ["0x2E22FEFA0100275E"] BOOL HAS_MENU_LAYOUT_CHANGED_EVENT_OCCURRED(); ``` -Returns true per frame when pause menu is navigated. -Note: This can only be used by one script at a time. - ## Return value +Returns true per frame when pause menu is navigated. +Note: This can only be used by one script at a time. \ No newline at end of file diff --git a/HUD/HasMenuTriggerEventOccurred.md b/HUD/HasMenuTriggerEventOccurred.md index 0e677aaf8..292adbd75 100644 --- a/HUD/HasMenuTriggerEventOccurred.md +++ b/HUD/HasMenuTriggerEventOccurred.md @@ -9,7 +9,6 @@ aliases: ["0xF284AC67940C6812"] cs_type(Any) BOOL HAS_MENU_TRIGGER_EVENT_OCCURRED(); ``` -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. - ## 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. \ No newline at end of file diff --git a/HUD/IsMouseRolledOverInstructionalButtons.md b/HUD/IsMouseRolledOverInstructionalButtons.md index 52dc8a6b4..f6d43e71e 100644 --- a/HUD/IsMouseRolledOverInstructionalButtons.md +++ b/HUD/IsMouseRolledOverInstructionalButtons.md @@ -9,7 +9,6 @@ aliases: ["0x3D9ACB1EB139E702", "_IS_MOUSE_CURSOR_ABOVE_INSTRUCTIONAL_BUTTONS"] cs_type(Any) BOOL IS_MOUSE_ROLLED_OVER_INSTRUCTIONAL_BUTTONS(); ``` -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. - ## 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. \ No newline at end of file diff --git a/HUD/PauseMenuGetMouseHoverIndex.md b/HUD/PauseMenuGetMouseHoverIndex.md index daf20c4f4..58e5e2684 100644 --- a/HUD/PauseMenuGetMouseHoverIndex.md +++ b/HUD/PauseMenuGetMouseHoverIndex.md @@ -9,6 +9,5 @@ aliases: ["0x359AF31A4B52F5ED", "_PAUSE_MENU_GET_INDEX_OF_MOUSE_HOVERED_SLOT"] int PAUSE_MENU_GET_MOUSE_HOVER_INDEX(); ``` -If mouse is hovering on a slot, it returns the slot's index, else it returns -1. - ## Return value +If mouse is hovering on a slot, it returns the slot's index, else it returns -1. \ No newline at end of file diff --git a/HUD/PauseMenuGetMouseHoverUniqueId.md b/HUD/PauseMenuGetMouseHoverUniqueId.md index 4b8cbe1a7..5f5c8a22d 100644 --- a/HUD/PauseMenuGetMouseHoverUniqueId.md +++ b/HUD/PauseMenuGetMouseHoverUniqueId.md @@ -9,7 +9,5 @@ aliases: ["0x13C4B962653A5280", "_PAUSE_MENU_GET_UNIQUE_ID_OF_MOUSE_HOVERED_SLOT int PAUSE_MENU_GET_MOUSE_HOVER_UNIQUE_ID(); ``` -If mouse is hovering on a slot, it returns uniqueid of that slot, else it returns -1. - ## Return value - +If mouse is hovering on a slot, it returns uniqueid of that slot, else it returns -1. From c1e35c289906fcfd1c2c8ff70c400c69ed95b098 Mon Sep 17 00:00:00 2001 From: Freddy <33939455+freedy69@users.noreply.github.com> Date: Tue, 21 Nov 2023 17:30:56 +0400 Subject: [PATCH 4/4] Update return value in GetPauseMenuPosition --- HUD/GetPauseMenuPosition.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/HUD/GetPauseMenuPosition.md b/HUD/GetPauseMenuPosition.md index f88dd7762..7df911549 100644 --- a/HUD/GetPauseMenuPosition.md +++ b/HUD/GetPauseMenuPosition.md @@ -6,10 +6,10 @@ aliases: ['0x5BFF36D6ED83E0AE', "_GET_PAUSE_MENU_CURSOR_POSITION"] ```c // 0x5BFF36D6ED83E0AE -cs_type(Vector3) Vector2 GET_PAUSE_MENU_POSITION(); +Vector3 GET_PAUSE_MENU_POSITION(); ``` ## Return value -Z is always 0. +This is used as a vector2, so Z is always 0. Returns starting position coordinates of the Pause Menu's body component.